lib/CodeGen/SelectionDAG/FunctionLoweringInfo.cpp

   1 //===-- FunctionLoweringInfo.cpp ------------------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This implements routines for translating functions from LLVM IR into
  11 // Machine IR.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/CodeGen/FunctionLoweringInfo.h"
  16 #include "llvm/ADT/PostOrderIterator.h"
  17 #include "llvm/CodeGen/Analysis.h"
  18 #include "llvm/CodeGen/MachineFrameInfo.h"
  19 #include "llvm/CodeGen/MachineFunction.h"
  20 #include "llvm/CodeGen/MachineInstrBuilder.h"
  21 #include "llvm/CodeGen/MachineModuleInfo.h"
  22 #include "llvm/CodeGen/MachineRegisterInfo.h"
  23 #include "llvm/IR/DataLayout.h"
  24 #include "llvm/IR/DebugInfo.h"
  25 #include "llvm/IR/DerivedTypes.h"
  26 #include "llvm/IR/Function.h"
  27 #include "llvm/IR/Instructions.h"
  28 #include "llvm/IR/IntrinsicInst.h"
  29 #include "llvm/IR/LLVMContext.h"
  30 #include "llvm/IR/Module.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/ErrorHandling.h"
  33 #include "llvm/Support/MathExtras.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include "llvm/Target/TargetFrameLowering.h"
  36 #include "llvm/Target/TargetInstrInfo.h"
  37 #include "llvm/Target/TargetLowering.h"
  38 #include "llvm/Target/TargetOptions.h"
  39 #include "llvm/Target/TargetRegisterInfo.h"
  40 #include "llvm/Target/TargetSubtargetInfo.h"
  41 #include <algorithm>
  42 using namespace llvm;
  43
  44 #define DEBUG_TYPE "function-lowering-info"
  45
  46 /// isUsedOutsideOfDefiningBlock - Return true if this instruction is used by
  47 /// PHI nodes or outside of the basic block that defines it, or used by a
  48 /// switch or atomic instruction, which may expand to multiple basic blocks.
  49 static bool isUsedOutsideOfDefiningBlock(const Instruction *I) {
  50   if (I->use_empty()) return false;
  51   if (isa<PHINode>(I)) return true;
  52   const BasicBlock *BB = I->getParent();
  53   for (const User *U : I->users())
  54     if (cast<Instruction>(U)->getParent() != BB || isa<PHINode>(U))
  55       return true;
  56
  57   return false;
  58 }
  59
  60 static ISD::NodeType getPreferredExtendForValue(const Value *V) {
  61   // For the users of the source value being used for compare instruction, if
  62   // the number of signed predicate is greater than unsigned predicate, we
  63   // prefer to use SIGN_EXTEND.
  64   //
  65   // With this optimization, we would be able to reduce some redundant sign or
  66   // zero extension instruction, and eventually more machine CSE opportunities
  67   // can be exposed.
  68   ISD::NodeType ExtendKind = ISD::ANY_EXTEND;
  69   unsigned NumOfSigned = 0, NumOfUnsigned = 0;
  70   for (const User *U : V->users()) {
  71     if (const auto *CI = dyn_cast<CmpInst>(U)) {
  72       NumOfSigned += CI->isSigned();
  73       NumOfUnsigned += CI->isUnsigned();
  74     }
  75   }
  76   if (NumOfSigned > NumOfUnsigned)
  77     ExtendKind = ISD::SIGN_EXTEND;
  78
  79   return ExtendKind;
  80 }
  81
  82 void FunctionLoweringInfo::set(const Function &fn, MachineFunction &mf,
  83                                SelectionDAG *DAG) {
  84   Fn = &fn;
  85   MF = &mf;
  86   TLI = MF->getSubtarget().getTargetLowering();
  87   RegInfo = &MF->getRegInfo();
  88
  89   // Check whether the function can return without sret-demotion.
  90   SmallVector<ISD::OutputArg, 4> Outs;
  91   GetReturnInfo(Fn->getReturnType(), Fn->getAttributes(), Outs, *TLI);
  92   CanLowerReturn = TLI->CanLowerReturn(Fn->getCallingConv(), *MF,
  93                                        Fn->isVarArg(), Outs, Fn->getContext());
  94
  95   // Initialize the mapping of values to registers.  This is only set up for
  96   // instruction values that are used outside of the block that defines
  97   // them.
  98   Function::const_iterator BB = Fn->begin(), EB = Fn->end();
  99   for (; BB != EB; ++BB)
 100     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
 101          I != E; ++I) {
 102       if (const AllocaInst *AI = dyn_cast<AllocaInst>(I)) {
 103         // Static allocas can be folded into the initial stack frame adjustment.
 104         if (AI->isStaticAlloca()) {
 105           const ConstantInt *CUI = cast<ConstantInt>(AI->getArraySize());
 106           Type *Ty = AI->getAllocatedType();
 107           uint64_t TySize = TLI->getDataLayout()->getTypeAllocSize(Ty);
 108           unsigned Align =
 109               std::max((unsigned)TLI->getDataLayout()->getPrefTypeAlignment(Ty),
 110                        AI->getAlignment());
 111
 112           TySize *= CUI->getZExtValue();   // Get total allocated size.
 113           if (TySize == 0) TySize = 1; // Don't create zero-sized stack objects.
 114
 115           StaticAllocaMap[AI] =
 116             MF->getFrameInfo()->CreateStackObject(TySize, Align, false, AI);
 117
 118         } else {
 119           unsigned Align = std::max(
 120               (unsigned)TLI->getDataLayout()->getPrefTypeAlignment(
 121                 AI->getAllocatedType()),
 122               AI->getAlignment());
 123           unsigned StackAlign =
 124               MF->getSubtarget().getFrameLowering()->getStackAlignment();
 125           if (Align <= StackAlign)
 126             Align = 0;
 127           // Inform the Frame Information that we have variable-sized objects.
 128           MF->getFrameInfo()->CreateVariableSizedObject(Align ? Align : 1, AI);
 129         }
 130       }
 131
 132       // Look for inline asm that clobbers the SP register.
 133       if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
 134         ImmutableCallSite CS(I);
 135         if (isa<InlineAsm>(CS.getCalledValue())) {
 136           unsigned SP = TLI->getStackPointerRegisterToSaveRestore();
 137           const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
 138           std::vector<TargetLowering::AsmOperandInfo> Ops =
 139               TLI->ParseConstraints(TRI, CS);
 140           for (size_t I = 0, E = Ops.size(); I != E; ++I) {
 141             TargetLowering::AsmOperandInfo &Op = Ops[I];
 142             if (Op.Type == InlineAsm::isClobber) {
 143               // Clobbers don't have SDValue operands, hence SDValue().
 144               TLI->ComputeConstraintToUse(Op, SDValue(), DAG);
 145               std::pair<unsigned, const TargetRegisterClass *> PhysReg =
 146                   TLI->getRegForInlineAsmConstraint(TRI, Op.ConstraintCode,
 147                                                     Op.ConstraintVT);
 148               if (PhysReg.first == SP)
 149                 MF->getFrameInfo()->setHasInlineAsmWithSPAdjust(true);
 150             }
 151           }
 152         }
 153       }
 154
 155       // Look for calls to the @llvm.va_start intrinsic. We can omit some
 156       // prologue boilerplate for variadic functions that don't examine their
 157       // arguments.
 158       if (const auto *II = dyn_cast<IntrinsicInst>(I)) {
 159         if (II->getIntrinsicID() == Intrinsic::vastart)
 160           MF->getFrameInfo()->setHasVAStart(true);
 161       }
 162
 163       // If we have a musttail call in a variadic funciton, we need to ensure we
 164       // forward implicit register parameters.
 165       if (const auto *CI = dyn_cast<CallInst>(I)) {
 166         if (CI->isMustTailCall() && Fn->isVarArg())
 167           MF->getFrameInfo()->setHasMustTailInVarArgFunc(true);
 168       }
 169
 170       // Mark values used outside their block as exported, by allocating
 171       // a virtual register for them.
 172       if (isUsedOutsideOfDefiningBlock(I))
 173         if (!isa<AllocaInst>(I) ||
 174             !StaticAllocaMap.count(cast<AllocaInst>(I)))
 175           InitializeRegForValue(I);
 176
 177       // Collect llvm.dbg.declare information. This is done now instead of
 178       // during the initial isel pass through the IR so that it is done
 179       // in a predictable order.
 180       if (const DbgDeclareInst *DI = dyn_cast<DbgDeclareInst>(I)) {
 181         MachineModuleInfo &MMI = MF->getMMI();
 182         DIVariable DIVar(DI->getVariable());
 183         assert((!DIVar || DIVar.isVariable()) &&
 184           "Variable in DbgDeclareInst should be either null or a DIVariable.");
 185         if (MMI.hasDebugInfo() &&
 186             DIVar &&
 187             !DI->getDebugLoc().isUnknown()) {
 188           // Don't handle byval struct arguments or VLAs, for example.
 189           // Non-byval arguments are handled here (they refer to the stack
 190           // temporary alloca at this point).
 191           const Value *Address = DI->getAddress();
 192           if (Address) {
 193             if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Address))
 194               Address = BCI->getOperand(0);
 195             if (const AllocaInst *AI = dyn_cast<AllocaInst>(Address)) {
 196               DenseMap<const AllocaInst *, int>::iterator SI =
 197                 StaticAllocaMap.find(AI);
 198               if (SI != StaticAllocaMap.end()) { // Check for VLAs.
 199                 int FI = SI->second;
 200                 MMI.setVariableDbgInfo(DI->getVariable(), DI->getExpression(),
 201                                        FI, DI->getDebugLoc());
 202               }
 203             }
 204           }
 205         }
 206       }
 207
 208       // Decide the preferred extend type for a value.
 209       PreferredExtendType[I] = getPreferredExtendForValue(I);
 210     }
 211
 212   // Create an initial MachineBasicBlock for each LLVM BasicBlock in F.  This
 213   // also creates the initial PHI MachineInstrs, though none of the input
 214   // operands are populated.
 215   for (BB = Fn->begin(); BB != EB; ++BB) {
 216     MachineBasicBlock *MBB = mf.CreateMachineBasicBlock(BB);
 217     MBBMap[BB] = MBB;
 218     MF->push_back(MBB);
 219
 220     // Transfer the address-taken flag. This is necessary because there could
 221     // be multiple MachineBasicBlocks corresponding to one BasicBlock, and only
 222     // the first one should be marked.
 223     if (BB->hasAddressTaken())
 224       MBB->setHasAddressTaken();
 225
 226     // Create Machine PHI nodes for LLVM PHI nodes, lowering them as
 227     // appropriate.
 228     for (BasicBlock::const_iterator I = BB->begin();
 229          const PHINode *PN = dyn_cast<PHINode>(I); ++I) {
 230       if (PN->use_empty()) continue;
 231
 232       // Skip empty types
 233       if (PN->getType()->isEmptyTy())
 234         continue;
 235
 236       DebugLoc DL = PN->getDebugLoc();
 237       unsigned PHIReg = ValueMap[PN];
 238       assert(PHIReg && "PHI node does not have an assigned virtual register!");
 239
 240       SmallVector<EVT, 4> ValueVTs;
 241       ComputeValueVTs(*TLI, PN->getType(), ValueVTs);
 242       for (unsigned vti = 0, vte = ValueVTs.size(); vti != vte; ++vti) {
 243         EVT VT = ValueVTs[vti];
 244         unsigned NumRegisters = TLI->getNumRegisters(Fn->getContext(), VT);
 245         const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
 246         for (unsigned i = 0; i != NumRegisters; ++i)
 247           BuildMI(MBB, DL, TII->get(TargetOpcode::PHI), PHIReg + i);
 248         PHIReg += NumRegisters;
 249       }
 250     }
 251   }
 252
 253   // Mark landing pad blocks.
 254   for (BB = Fn->begin(); BB != EB; ++BB)
 255     if (const InvokeInst *Invoke = dyn_cast<InvokeInst>(BB->getTerminator()))
 256       MBBMap[Invoke->getSuccessor(1)]->setIsLandingPad();
 257 }
 258
 259 /// clear - Clear out all the function-specific state. This returns this
 260 /// FunctionLoweringInfo to an empty state, ready to be used for a
 261 /// different function.
 262 void FunctionLoweringInfo::clear() {
 263   assert(CatchInfoFound.size() == CatchInfoLost.size() &&
 264          "Not all catch info was assigned to a landing pad!");
 265
 266   MBBMap.clear();
 267   ValueMap.clear();
 268   StaticAllocaMap.clear();
 269 #ifndef NDEBUG
 270   CatchInfoLost.clear();
 271   CatchInfoFound.clear();
 272 #endif
 273   LiveOutRegInfo.clear();
 274   VisitedBBs.clear();
 275   ArgDbgValues.clear();
 276   ByValArgFrameIndexMap.clear();
 277   RegFixups.clear();
 278   StatepointStackSlots.clear();
 279   PreferredExtendType.clear();
 280 }
 281
 282 /// CreateReg - Allocate a single virtual register for the given type.
 283 unsigned FunctionLoweringInfo::CreateReg(MVT VT) {
 284   return RegInfo->createVirtualRegister(
 285       MF->getSubtarget().getTargetLowering()->getRegClassFor(VT));
 286 }
 287
 288 /// CreateRegs - Allocate the appropriate number of virtual registers of
 289 /// the correctly promoted or expanded types.  Assign these registers
 290 /// consecutive vreg numbers and return the first assigned number.
 291 ///
 292 /// In the case that the given value has struct or array type, this function
 293 /// will assign registers for each member or element.
 294 ///
 295 unsigned FunctionLoweringInfo::CreateRegs(Type *Ty) {
 296   const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
 297
 298   SmallVector<EVT, 4> ValueVTs;
 299   ComputeValueVTs(*TLI, Ty, ValueVTs);
 300
 301   unsigned FirstReg = 0;
 302   for (unsigned Value = 0, e = ValueVTs.size(); Value != e; ++Value) {
 303     EVT ValueVT = ValueVTs[Value];
 304     MVT RegisterVT = TLI->getRegisterType(Ty->getContext(), ValueVT);
 305
 306     unsigned NumRegs = TLI->getNumRegisters(Ty->getContext(), ValueVT);
 307     for (unsigned i = 0; i != NumRegs; ++i) {
 308       unsigned R = CreateReg(RegisterVT);
 309       if (!FirstReg) FirstReg = R;
 310     }
 311   }
 312   return FirstReg;
 313 }
 314
 315 /// GetLiveOutRegInfo - Gets LiveOutInfo for a register, returning NULL if the
 316 /// register is a PHI destination and the PHI's LiveOutInfo is not valid. If
 317 /// the register's LiveOutInfo is for a smaller bit width, it is extended to
 318 /// the larger bit width by zero extension. The bit width must be no smaller
 319 /// than the LiveOutInfo's existing bit width.
 320 const FunctionLoweringInfo::LiveOutInfo *
 321 FunctionLoweringInfo::GetLiveOutRegInfo(unsigned Reg, unsigned BitWidth) {
 322   if (!LiveOutRegInfo.inBounds(Reg))
 323     return nullptr;
 324
 325   LiveOutInfo *LOI = &LiveOutRegInfo[Reg];
 326   if (!LOI->IsValid)
 327     return nullptr;
 328
 329   if (BitWidth > LOI->KnownZero.getBitWidth()) {
 330     LOI->NumSignBits = 1;
 331     LOI->KnownZero = LOI->KnownZero.zextOrTrunc(BitWidth);
 332     LOI->KnownOne = LOI->KnownOne.zextOrTrunc(BitWidth);
 333   }
 334
 335   return LOI;
 336 }
 337
 338 /// ComputePHILiveOutRegInfo - Compute LiveOutInfo for a PHI's destination
 339 /// register based on the LiveOutInfo of its operands.
 340 void FunctionLoweringInfo::ComputePHILiveOutRegInfo(const PHINode *PN) {
 341   Type *Ty = PN->getType();
 342   if (!Ty->isIntegerTy() || Ty->isVectorTy())
 343     return;
 344
 345   SmallVector<EVT, 1> ValueVTs;
 346   ComputeValueVTs(*TLI, Ty, ValueVTs);
 347   assert(ValueVTs.size() == 1 &&
 348          "PHIs with non-vector integer types should have a single VT.");
 349   EVT IntVT = ValueVTs[0];
 350
 351   if (TLI->getNumRegisters(PN->getContext(), IntVT) != 1)
 352     return;
 353   IntVT = TLI->getTypeToTransformTo(PN->getContext(), IntVT);
 354   unsigned BitWidth = IntVT.getSizeInBits();
 355
 356   unsigned DestReg = ValueMap[PN];
 357   if (!TargetRegisterInfo::isVirtualRegister(DestReg))
 358     return;
 359   LiveOutRegInfo.grow(DestReg);
 360   LiveOutInfo &DestLOI = LiveOutRegInfo[DestReg];
 361
 362   Value *V = PN->getIncomingValue(0);
 363   if (isa<UndefValue>(V) || isa<ConstantExpr>(V)) {
 364     DestLOI.NumSignBits = 1;
 365     APInt Zero(BitWidth, 0);
 366     DestLOI.KnownZero = Zero;
 367     DestLOI.KnownOne = Zero;
 368     return;
 369   }
 370
 371   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 372     APInt Val = CI->getValue().zextOrTrunc(BitWidth);
 373     DestLOI.NumSignBits = Val.getNumSignBits();
 374     DestLOI.KnownZero = ~Val;
 375     DestLOI.KnownOne = Val;
 376   } else {
 377     assert(ValueMap.count(V) && "V should have been placed in ValueMap when its"
 378                                 "CopyToReg node was created.");
 379     unsigned SrcReg = ValueMap[V];
 380     if (!TargetRegisterInfo::isVirtualRegister(SrcReg)) {
 381       DestLOI.IsValid = false;
 382       return;
 383     }
 384     const LiveOutInfo *SrcLOI = GetLiveOutRegInfo(SrcReg, BitWidth);
 385     if (!SrcLOI) {
 386       DestLOI.IsValid = false;
 387       return;
 388     }
 389     DestLOI = *SrcLOI;
 390   }
 391
 392   assert(DestLOI.KnownZero.getBitWidth() == BitWidth &&
 393          DestLOI.KnownOne.getBitWidth() == BitWidth &&
 394          "Masks should have the same bit width as the type.");
 395
 396   for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i) {
 397     Value *V = PN->getIncomingValue(i);
 398     if (isa<UndefValue>(V) || isa<ConstantExpr>(V)) {
 399       DestLOI.NumSignBits = 1;
 400       APInt Zero(BitWidth, 0);
 401       DestLOI.KnownZero = Zero;
 402       DestLOI.KnownOne = Zero;
 403       return;
 404     }
 405
 406     if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 407       APInt Val = CI->getValue().zextOrTrunc(BitWidth);
 408       DestLOI.NumSignBits = std::min(DestLOI.NumSignBits, Val.getNumSignBits());
 409       DestLOI.KnownZero &= ~Val;
 410       DestLOI.KnownOne &= Val;
 411       continue;
 412     }
 413
 414     assert(ValueMap.count(V) && "V should have been placed in ValueMap when "
 415                                 "its CopyToReg node was created.");
 416     unsigned SrcReg = ValueMap[V];
 417     if (!TargetRegisterInfo::isVirtualRegister(SrcReg)) {
 418       DestLOI.IsValid = false;
 419       return;
 420     }
 421     const LiveOutInfo *SrcLOI = GetLiveOutRegInfo(SrcReg, BitWidth);
 422     if (!SrcLOI) {
 423       DestLOI.IsValid = false;
 424       return;
 425     }
 426     DestLOI.NumSignBits = std::min(DestLOI.NumSignBits, SrcLOI->NumSignBits);
 427     DestLOI.KnownZero &= SrcLOI->KnownZero;
 428     DestLOI.KnownOne &= SrcLOI->KnownOne;
 429   }
 430 }
 431
 432 /// setArgumentFrameIndex - Record frame index for the byval
 433 /// argument. This overrides previous frame index entry for this argument,
 434 /// if any.
 435 void FunctionLoweringInfo::setArgumentFrameIndex(const Argument *A,
 436                                                  int FI) {
 437   ByValArgFrameIndexMap[A] = FI;
 438 }
 439
 440 /// getArgumentFrameIndex - Get frame index for the byval argument.
 441 /// If the argument does not have any assigned frame index then 0 is
 442 /// returned.
 443 int FunctionLoweringInfo::getArgumentFrameIndex(const Argument *A) {
 444   DenseMap<const Argument *, int>::iterator I =
 445     ByValArgFrameIndexMap.find(A);
 446   if (I != ByValArgFrameIndexMap.end())
 447     return I->second;
 448   DEBUG(dbgs() << "Argument does not have assigned frame index!\n");
 449   return 0;
 450 }
 451
 452 /// ComputeUsesVAFloatArgument - Determine if any floating-point values are
 453 /// being passed to this variadic function, and set the MachineModuleInfo's
 454 /// usesVAFloatArgument flag if so. This flag is used to emit an undefined
 455 /// reference to _fltused on Windows, which will link in MSVCRT's
 456 /// floating-point support.
 457 void llvm::ComputeUsesVAFloatArgument(const CallInst &I,
 458                                       MachineModuleInfo *MMI)
 459 {
 460   FunctionType *FT = cast<FunctionType>(
 461     I.getCalledValue()->getType()->getContainedType(0));
 462   if (FT->isVarArg() && !MMI->usesVAFloatArgument()) {
 463     for (unsigned i = 0, e = I.getNumArgOperands(); i != e; ++i) {
 464       Type* T = I.getArgOperand(i)->getType();
 465       for (po_iterator<Type*> i = po_begin(T), e = po_end(T);
 466            i != e; ++i) {
 467         if (i->isFloatingPointTy()) {
 468           MMI->setUsesVAFloatArgument(true);
 469           return;
 470         }
 471       }
 472     }
 473   }
 474 }
 475
 476 /// AddLandingPadInfo - Extract the exception handling information from the
 477 /// landingpad instruction and add them to the specified machine module info.
 478 void llvm::AddLandingPadInfo(const LandingPadInst &I, MachineModuleInfo &MMI,
 479                              MachineBasicBlock *MBB) {
 480   MMI.addPersonality(MBB,
 481                      cast<Function>(I.getPersonalityFn()->stripPointerCasts()));
 482
 483   if (I.isCleanup())
 484     MMI.addCleanup(MBB);
 485
 486   // FIXME: New EH - Add the clauses in reverse order. This isn't 100% correct,
 487   //        but we need to do it this way because of how the DWARF EH emitter
 488   //        processes the clauses.
 489   for (unsigned i = I.getNumClauses(); i != 0; --i) {
 490     Value *Val = I.getClause(i - 1);
 491     if (I.isCatch(i - 1)) {
 492       MMI.addCatchTypeInfo(MBB,
 493                            dyn_cast<GlobalValue>(Val->stripPointerCasts()));
 494     } else {
 495       // Add filters in a list.
 496       Constant *CVal = cast<Constant>(Val);
 497       SmallVector<const GlobalValue*, 4> FilterList;
 498       for (User::op_iterator
 499              II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II)
 500         FilterList.push_back(cast<GlobalValue>((*II)->stripPointerCasts()));
 501
 502       MMI.addFilterTypeInfo(MBB, FilterList);
 503     }
 504   }
 505 }