lib/CodeGen/LocalStackSlotAllocation.cpp

   1 //===- LocalStackSlotAllocation.cpp - Pre-allocate locals to stack slots --===//
   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 pass assigns local frame indices to stack slots relative to one another
  11 // and allocates additional base registers to access them when the target
  12 // estimates they are likely to be out of range of stack pointer and frame
  13 // pointer relative addressing.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/CodeGen/Passes.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/ADT/SetVector.h"
  20 #include "llvm/ADT/SmallSet.h"
  21 #include "llvm/ADT/Statistic.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/CodeGen/MachineFunction.h"
  24 #include "llvm/CodeGen/MachineFunctionPass.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/CodeGen/StackProtector.h"
  27 #include "llvm/IR/Constants.h"
  28 #include "llvm/IR/DerivedTypes.h"
  29 #include "llvm/IR/Instructions.h"
  30 #include "llvm/IR/Intrinsics.h"
  31 #include "llvm/IR/LLVMContext.h"
  32 #include "llvm/IR/Module.h"
  33 #include "llvm/Pass.h"
  34 #include "llvm/Support/Debug.h"
  35 #include "llvm/Support/ErrorHandling.h"
  36 #include "llvm/Support/raw_ostream.h"
  37 #include "llvm/Target/TargetFrameLowering.h"
  38 #include "llvm/Target/TargetRegisterInfo.h"
  39 #include "llvm/Target/TargetSubtargetInfo.h"
  40
  41 using namespace llvm;
  42
  43 #define DEBUG_TYPE "localstackalloc"
  44
  45 STATISTIC(NumAllocations, "Number of frame indices allocated into local block");
  46 STATISTIC(NumBaseRegisters, "Number of virtual frame base registers allocated");
  47 STATISTIC(NumReplacements, "Number of frame indices references replaced");
  48
  49 namespace {
  50   class FrameRef {
  51     MachineBasicBlock::iterator MI; // Instr referencing the frame
  52     int64_t LocalOffset;            // Local offset of the frame idx referenced
  53     int FrameIdx;                   // The frame index
  54   public:
  55     FrameRef(MachineBasicBlock::iterator I, int64_t Offset, int Idx) :
  56       MI(I), LocalOffset(Offset), FrameIdx(Idx) {}
  57     bool operator<(const FrameRef &RHS) const {
  58       return LocalOffset < RHS.LocalOffset;
  59     }
  60     MachineBasicBlock::iterator getMachineInstr() const { return MI; }
  61     int64_t getLocalOffset() const { return LocalOffset; }
  62     int getFrameIndex() const { return FrameIdx; }
  63   };
  64
  65   class LocalStackSlotPass: public MachineFunctionPass {
  66     SmallVector<int64_t,16> LocalOffsets;
  67     /// StackObjSet - A set of stack object indexes
  68     typedef SmallSetVector<int, 8> StackObjSet;
  69
  70     void AdjustStackOffset(MachineFrameInfo *MFI, int FrameIdx, int64_t &Offset,
  71                            bool StackGrowsDown, unsigned &MaxAlign);
  72     void AssignProtectedObjSet(const StackObjSet &UnassignedObjs,
  73                                SmallSet<int, 16> &ProtectedObjs,
  74                                MachineFrameInfo *MFI, bool StackGrowsDown,
  75                                int64_t &Offset, unsigned &MaxAlign);
  76     void calculateFrameObjectOffsets(MachineFunction &Fn);
  77     bool insertFrameReferenceRegisters(MachineFunction &Fn);
  78   public:
  79     static char ID; // Pass identification, replacement for typeid
  80     explicit LocalStackSlotPass() : MachineFunctionPass(ID) {
  81       initializeLocalStackSlotPassPass(*PassRegistry::getPassRegistry());
  82     }
  83     bool runOnMachineFunction(MachineFunction &MF) override;
  84
  85     void getAnalysisUsage(AnalysisUsage &AU) const override {
  86       AU.setPreservesCFG();
  87       AU.addRequired<StackProtector>();
  88       MachineFunctionPass::getAnalysisUsage(AU);
  89     }
  90
  91   private:
  92   };
  93 } // end anonymous namespace
  94
  95 char LocalStackSlotPass::ID = 0;
  96 char &llvm::LocalStackSlotAllocationID = LocalStackSlotPass::ID;
  97 INITIALIZE_PASS_BEGIN(LocalStackSlotPass, "localstackalloc",
  98                       "Local Stack Slot Allocation", false, false)
  99 INITIALIZE_PASS_DEPENDENCY(StackProtector)
 100 INITIALIZE_PASS_END(LocalStackSlotPass, "localstackalloc",
 101                     "Local Stack Slot Allocation", false, false)
 102
 103
 104 bool LocalStackSlotPass::runOnMachineFunction(MachineFunction &MF) {
 105   MachineFrameInfo *MFI = MF.getFrameInfo();
 106   const TargetRegisterInfo *TRI =
 107       MF.getTarget().getSubtargetImpl()->getRegisterInfo();
 108   unsigned LocalObjectCount = MFI->getObjectIndexEnd();
 109
 110   // If the target doesn't want/need this pass, or if there are no locals
 111   // to consider, early exit.
 112   if (!TRI->requiresVirtualBaseRegisters(MF) || LocalObjectCount == 0)
 113     return true;
 114
 115   // Make sure we have enough space to store the local offsets.
 116   LocalOffsets.resize(MFI->getObjectIndexEnd());
 117
 118   // Lay out the local blob.
 119   calculateFrameObjectOffsets(MF);
 120
 121   // Insert virtual base registers to resolve frame index references.
 122   bool UsedBaseRegs = insertFrameReferenceRegisters(MF);
 123
 124   // Tell MFI whether any base registers were allocated. PEI will only
 125   // want to use the local block allocations from this pass if there were any.
 126   // Otherwise, PEI can do a bit better job of getting the alignment right
 127   // without a hole at the start since it knows the alignment of the stack
 128   // at the start of local allocation, and this pass doesn't.
 129   MFI->setUseLocalStackAllocationBlock(UsedBaseRegs);
 130
 131   return true;
 132 }
 133
 134 /// AdjustStackOffset - Helper function used to adjust the stack frame offset.
 135 void LocalStackSlotPass::AdjustStackOffset(MachineFrameInfo *MFI,
 136                                            int FrameIdx, int64_t &Offset,
 137                                            bool StackGrowsDown,
 138                                            unsigned &MaxAlign) {
 139   // If the stack grows down, add the object size to find the lowest address.
 140   if (StackGrowsDown)
 141     Offset += MFI->getObjectSize(FrameIdx);
 142
 143   unsigned Align = MFI->getObjectAlignment(FrameIdx);
 144
 145   // If the alignment of this object is greater than that of the stack, then
 146   // increase the stack alignment to match.
 147   MaxAlign = std::max(MaxAlign, Align);
 148
 149   // Adjust to alignment boundary.
 150   Offset = (Offset + Align - 1) / Align * Align;
 151
 152   int64_t LocalOffset = StackGrowsDown ? -Offset : Offset;
 153   DEBUG(dbgs() << "Allocate FI(" << FrameIdx << ") to local offset "
 154         << LocalOffset << "\n");
 155   // Keep the offset available for base register allocation
 156   LocalOffsets[FrameIdx] = LocalOffset;
 157   // And tell MFI about it for PEI to use later
 158   MFI->mapLocalFrameObject(FrameIdx, LocalOffset);
 159
 160   if (!StackGrowsDown)
 161     Offset += MFI->getObjectSize(FrameIdx);
 162
 163   ++NumAllocations;
 164 }
 165
 166 /// AssignProtectedObjSet - Helper function to assign large stack objects (i.e.,
 167 /// those required to be close to the Stack Protector) to stack offsets.
 168 void LocalStackSlotPass::AssignProtectedObjSet(const StackObjSet &UnassignedObjs,
 169                                            SmallSet<int, 16> &ProtectedObjs,
 170                                            MachineFrameInfo *MFI,
 171                                            bool StackGrowsDown, int64_t &Offset,
 172                                            unsigned &MaxAlign) {
 173
 174   for (StackObjSet::const_iterator I = UnassignedObjs.begin(),
 175         E = UnassignedObjs.end(); I != E; ++I) {
 176     int i = *I;
 177     AdjustStackOffset(MFI, i, Offset, StackGrowsDown, MaxAlign);
 178     ProtectedObjs.insert(i);
 179   }
 180 }
 181
 182 /// calculateFrameObjectOffsets - Calculate actual frame offsets for all of the
 183 /// abstract stack objects.
 184 ///
 185 void LocalStackSlotPass::calculateFrameObjectOffsets(MachineFunction &Fn) {
 186   // Loop over all of the stack objects, assigning sequential addresses...
 187   MachineFrameInfo *MFI = Fn.getFrameInfo();
 188   const TargetFrameLowering &TFI =
 189       *Fn.getTarget().getSubtargetImpl()->getFrameLowering();
 190   bool StackGrowsDown =
 191     TFI.getStackGrowthDirection() == TargetFrameLowering::StackGrowsDown;
 192   int64_t Offset = 0;
 193   unsigned MaxAlign = 0;
 194   StackProtector *SP = &getAnalysis<StackProtector>();
 195
 196   // Make sure that the stack protector comes before the local variables on the
 197   // stack.
 198   SmallSet<int, 16> ProtectedObjs;
 199   if (MFI->getStackProtectorIndex() >= 0) {
 200     StackObjSet LargeArrayObjs;
 201     StackObjSet SmallArrayObjs;
 202     StackObjSet AddrOfObjs;
 203
 204     AdjustStackOffset(MFI, MFI->getStackProtectorIndex(), Offset,
 205                       StackGrowsDown, MaxAlign);
 206
 207     // Assign large stack objects first.
 208     for (unsigned i = 0, e = MFI->getObjectIndexEnd(); i != e; ++i) {
 209       if (MFI->isDeadObjectIndex(i))
 210         continue;
 211       if (MFI->getStackProtectorIndex() == (int)i)
 212         continue;
 213
 214       switch (SP->getSSPLayout(MFI->getObjectAllocation(i))) {
 215       case StackProtector::SSPLK_None:
 216         continue;
 217       case StackProtector::SSPLK_SmallArray:
 218         SmallArrayObjs.insert(i);
 219         continue;
 220       case StackProtector::SSPLK_AddrOf:
 221         AddrOfObjs.insert(i);
 222         continue;
 223       case StackProtector::SSPLK_LargeArray:
 224         LargeArrayObjs.insert(i);
 225         continue;
 226       }
 227       llvm_unreachable("Unexpected SSPLayoutKind.");
 228     }
 229
 230     AssignProtectedObjSet(LargeArrayObjs, ProtectedObjs, MFI, StackGrowsDown,
 231                           Offset, MaxAlign);
 232     AssignProtectedObjSet(SmallArrayObjs, ProtectedObjs, MFI, StackGrowsDown,
 233                           Offset, MaxAlign);
 234     AssignProtectedObjSet(AddrOfObjs, ProtectedObjs, MFI, StackGrowsDown,
 235                           Offset, MaxAlign);
 236   }
 237
 238   // Then assign frame offsets to stack objects that are not used to spill
 239   // callee saved registers.
 240   for (unsigned i = 0, e = MFI->getObjectIndexEnd(); i != e; ++i) {
 241     if (MFI->isDeadObjectIndex(i))
 242       continue;
 243     if (MFI->getStackProtectorIndex() == (int)i)
 244       continue;
 245     if (ProtectedObjs.count(i))
 246       continue;
 247
 248     AdjustStackOffset(MFI, i, Offset, StackGrowsDown, MaxAlign);
 249   }
 250
 251   // Remember how big this blob of stack space is
 252   MFI->setLocalFrameSize(Offset);
 253   MFI->setLocalFrameMaxAlign(MaxAlign);
 254 }
 255
 256 static inline bool
 257 lookupCandidateBaseReg(int64_t BaseOffset,
 258                        int64_t FrameSizeAdjust,
 259                        int64_t LocalFrameOffset,
 260                        const MachineInstr *MI,
 261                        const TargetRegisterInfo *TRI) {
 262   // Check if the relative offset from the where the base register references
 263   // to the target address is in range for the instruction.
 264   int64_t Offset = FrameSizeAdjust + LocalFrameOffset - BaseOffset;
 265   return TRI->isFrameOffsetLegal(MI, Offset);
 266 }
 267
 268 bool LocalStackSlotPass::insertFrameReferenceRegisters(MachineFunction &Fn) {
 269   // Scan the function's instructions looking for frame index references.
 270   // For each, ask the target if it wants a virtual base register for it
 271   // based on what we can tell it about where the local will end up in the
 272   // stack frame. If it wants one, re-use a suitable one we've previously
 273   // allocated, or if there isn't one that fits the bill, allocate a new one
 274   // and ask the target to create a defining instruction for it.
 275   bool UsedBaseReg = false;
 276
 277   MachineFrameInfo *MFI = Fn.getFrameInfo();
 278   const TargetRegisterInfo *TRI =
 279       Fn.getTarget().getSubtargetImpl()->getRegisterInfo();
 280   const TargetFrameLowering &TFI =
 281       *Fn.getTarget().getSubtargetImpl()->getFrameLowering();
 282   bool StackGrowsDown =
 283     TFI.getStackGrowthDirection() == TargetFrameLowering::StackGrowsDown;
 284
 285   // Collect all of the instructions in the block that reference
 286   // a frame index. Also store the frame index referenced to ease later
 287   // lookup. (For any insn that has more than one FI reference, we arbitrarily
 288   // choose the first one).
 289   SmallVector<FrameRef, 64> FrameReferenceInsns;
 290
 291   for (MachineFunction::iterator BB = Fn.begin(), E = Fn.end(); BB != E; ++BB) {
 292     for (MachineBasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
 293       MachineInstr *MI = I;
 294
 295       // Debug value, stackmap and patchpoint instructions can't be out of
 296       // range, so they don't need any updates.
 297       if (MI->isDebugValue() ||
 298           MI->getOpcode() == TargetOpcode::STACKMAP ||
 299           MI->getOpcode() == TargetOpcode::PATCHPOINT)
 300         continue;
 301
 302       // For now, allocate the base register(s) within the basic block
 303       // where they're used, and don't try to keep them around outside
 304       // of that. It may be beneficial to try sharing them more broadly
 305       // than that, but the increased register pressure makes that a
 306       // tricky thing to balance. Investigate if re-materializing these
 307       // becomes an issue.
 308       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 309         // Consider replacing all frame index operands that reference
 310         // an object allocated in the local block.
 311         if (MI->getOperand(i).isFI()) {
 312           // Don't try this with values not in the local block.
 313           if (!MFI->isObjectPreAllocated(MI->getOperand(i).getIndex()))
 314             break;
 315           int Idx = MI->getOperand(i).getIndex();
 316           int64_t LocalOffset = LocalOffsets[Idx];
 317           if (!TRI->needsFrameBaseReg(MI, LocalOffset))
 318             break;
 319           FrameReferenceInsns.
 320             push_back(FrameRef(MI, LocalOffset, Idx));
 321           break;
 322         }
 323       }
 324     }
 325   }
 326
 327   // Sort the frame references by local offset
 328   array_pod_sort(FrameReferenceInsns.begin(), FrameReferenceInsns.end());
 329
 330   MachineBasicBlock *Entry = Fn.begin();
 331
 332   unsigned BaseReg = 0;
 333   int64_t BaseOffset = 0;
 334
 335   // Loop through the frame references and allocate for them as necessary.
 336   for (int ref = 0, e = FrameReferenceInsns.size(); ref < e ; ++ref) {
 337     FrameRef &FR = FrameReferenceInsns[ref];
 338     MachineBasicBlock::iterator I = FR.getMachineInstr();
 339     MachineInstr *MI = I;
 340     int64_t LocalOffset = FR.getLocalOffset();
 341     int FrameIdx = FR.getFrameIndex();
 342     assert(MFI->isObjectPreAllocated(FrameIdx) &&
 343            "Only pre-allocated locals expected!");
 344
 345     DEBUG(dbgs() << "Considering: " << *MI);
 346
 347     unsigned idx = 0;
 348     for (unsigned f = MI->getNumOperands(); idx != f; ++idx) {
 349       if (!MI->getOperand(idx).isFI())
 350         continue;
 351
 352       if (FrameIdx == I->getOperand(idx).getIndex())
 353         break;
 354     }
 355
 356     assert(idx < MI->getNumOperands() && "Cannot find FI operand");
 357
 358     int64_t Offset = 0;
 359     int64_t FrameSizeAdjust = StackGrowsDown ? MFI->getLocalFrameSize() : 0;
 360
 361     DEBUG(dbgs() << "  Replacing FI in: " << *MI);
 362
 363     // If we have a suitable base register available, use it; otherwise
 364     // create a new one. Note that any offset encoded in the
 365     // instruction itself will be taken into account by the target,
 366     // so we don't have to adjust for it here when reusing a base
 367     // register.
 368     if (UsedBaseReg && lookupCandidateBaseReg(BaseOffset, FrameSizeAdjust,
 369                                               LocalOffset, MI, TRI)) {
 370       DEBUG(dbgs() << "  Reusing base register " << BaseReg << "\n");
 371       // We found a register to reuse.
 372       Offset = FrameSizeAdjust + LocalOffset - BaseOffset;
 373     } else {
 374       // No previously defined register was in range, so create a // new one.
 375
 376       int64_t InstrOffset = TRI->getFrameIndexInstrOffset(MI, idx);
 377
 378       int64_t PrevBaseOffset = BaseOffset;
 379       BaseOffset = FrameSizeAdjust + LocalOffset + InstrOffset;
 380
 381       // We'd like to avoid creating single-use virtual base registers.
 382       // Because the FrameRefs are in sorted order, and we've already
 383       // processed all FrameRefs before this one, just check whether or not
 384       // the next FrameRef will be able to reuse this new register. If not,
 385       // then don't bother creating it.
 386       if (ref + 1 >= e ||
 387           !lookupCandidateBaseReg(
 388               BaseOffset, FrameSizeAdjust,
 389               FrameReferenceInsns[ref + 1].getLocalOffset(),
 390               FrameReferenceInsns[ref + 1].getMachineInstr(), TRI)) {
 391         BaseOffset = PrevBaseOffset;
 392         continue;
 393       }
 394
 395       const MachineFunction *MF = MI->getParent()->getParent();
 396       const TargetRegisterClass *RC = TRI->getPointerRegClass(*MF);
 397       BaseReg = Fn.getRegInfo().createVirtualRegister(RC);
 398
 399       DEBUG(dbgs() << "  Materializing base register " << BaseReg <<
 400             " at frame local offset " << LocalOffset + InstrOffset << "\n");
 401
 402       // Tell the target to insert the instruction to initialize
 403       // the base register.
 404       //            MachineBasicBlock::iterator InsertionPt = Entry->begin();
 405       TRI->materializeFrameBaseRegister(Entry, BaseReg, FrameIdx,
 406                                         InstrOffset);
 407
 408       // The base register already includes any offset specified
 409       // by the instruction, so account for that so it doesn't get
 410       // applied twice.
 411       Offset = -InstrOffset;
 412
 413       ++NumBaseRegisters;
 414       UsedBaseReg = true;
 415     }
 416     assert(BaseReg != 0 && "Unable to allocate virtual base register!");
 417
 418     // Modify the instruction to use the new base register rather
 419     // than the frame index operand.
 420     TRI->resolveFrameIndex(*I, BaseReg, Offset);
 421     DEBUG(dbgs() << "Resolved: " << *MI);
 422
 423     ++NumReplacements;
 424   }
 425
 426   return UsedBaseReg;
 427 }