contrib/llvm-project/llvm/lib/CodeGen/PrologEpilogInserter.cpp

   1 //===- PrologEpilogInserter.cpp - Insert Prolog/Epilog code in function ---===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This pass is responsible for finalizing the functions frame layout, saving
  10 // callee saved registers, and for emitting prolog & epilog code for the
  11 // function.
  12 //
  13 // This pass must be run after register allocation.  After this pass is
  14 // executed, it is illegal to construct MO_FrameIndex operands.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/BitVector.h"
  20 #include "llvm/ADT/DepthFirstIterator.h"
  21 #include "llvm/ADT/STLExtras.h"
  22 #include "llvm/ADT/SetVector.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/ADT/SmallSet.h"
  25 #include "llvm/ADT/SmallVector.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/Analysis/OptimizationRemarkEmitter.h"
  28 #include "llvm/CodeGen/MachineBasicBlock.h"
  29 #include "llvm/CodeGen/MachineDominators.h"
  30 #include "llvm/CodeGen/MachineFrameInfo.h"
  31 #include "llvm/CodeGen/MachineFunction.h"
  32 #include "llvm/CodeGen/MachineFunctionPass.h"
  33 #include "llvm/CodeGen/MachineInstr.h"
  34 #include "llvm/CodeGen/MachineInstrBuilder.h"
  35 #include "llvm/CodeGen/MachineLoopInfo.h"
  36 #include "llvm/CodeGen/MachineModuleInfo.h"
  37 #include "llvm/CodeGen/MachineOperand.h"
  38 #include "llvm/CodeGen/MachineOptimizationRemarkEmitter.h"
  39 #include "llvm/CodeGen/MachineRegisterInfo.h"
  40 #include "llvm/CodeGen/RegisterScavenging.h"
  41 #include "llvm/CodeGen/TargetFrameLowering.h"
  42 #include "llvm/CodeGen/TargetInstrInfo.h"
  43 #include "llvm/CodeGen/TargetOpcodes.h"
  44 #include "llvm/CodeGen/TargetRegisterInfo.h"
  45 #include "llvm/CodeGen/TargetSubtargetInfo.h"
  46 #include "llvm/CodeGen/WinEHFuncInfo.h"
  47 #include "llvm/IR/Attributes.h"
  48 #include "llvm/IR/CallingConv.h"
  49 #include "llvm/IR/DebugInfoMetadata.h"
  50 #include "llvm/IR/DiagnosticInfo.h"
  51 #include "llvm/IR/Function.h"
  52 #include "llvm/IR/InlineAsm.h"
  53 #include "llvm/IR/LLVMContext.h"
  54 #include "llvm/MC/MCRegisterInfo.h"
  55 #include "llvm/Pass.h"
  56 #include "llvm/Support/CodeGen.h"
  57 #include "llvm/Support/CommandLine.h"
  58 #include "llvm/Support/Debug.h"
  59 #include "llvm/Support/ErrorHandling.h"
  60 #include "llvm/Support/MathExtras.h"
  61 #include "llvm/Support/raw_ostream.h"
  62 #include "llvm/Target/TargetMachine.h"
  63 #include "llvm/Target/TargetOptions.h"
  64 #include <algorithm>
  65 #include <cassert>
  66 #include <cstdint>
  67 #include <functional>
  68 #include <limits>
  69 #include <utility>
  70 #include <vector>
  71
  72 using namespace llvm;
  73
  74 #define DEBUG_TYPE "prologepilog"
  75
  76 using MBBVector = SmallVector<MachineBasicBlock *, 4>;
  77
  78 STATISTIC(NumLeafFuncWithSpills, "Number of leaf functions with CSRs");
  79 STATISTIC(NumFuncSeen, "Number of functions seen in PEI");
  80
  81
  82 namespace {
  83
  84 class PEI : public MachineFunctionPass {
  85 public:
  86   static char ID;
  87
  88   PEI() : MachineFunctionPass(ID) {
  89     initializePEIPass(*PassRegistry::getPassRegistry());
  90   }
  91
  92   void getAnalysisUsage(AnalysisUsage &AU) const override;
  93
  94   /// runOnMachineFunction - Insert prolog/epilog code and replace abstract
  95   /// frame indexes with appropriate references.
  96   bool runOnMachineFunction(MachineFunction &MF) override;
  97
  98 private:
  99   RegScavenger *RS;
 100
 101   // MinCSFrameIndex, MaxCSFrameIndex - Keeps the range of callee saved
 102   // stack frame indexes.
 103   unsigned MinCSFrameIndex = std::numeric_limits<unsigned>::max();
 104   unsigned MaxCSFrameIndex = 0;
 105
 106   // Save and Restore blocks of the current function. Typically there is a
 107   // single save block, unless Windows EH funclets are involved.
 108   MBBVector SaveBlocks;
 109   MBBVector RestoreBlocks;
 110
 111   // Flag to control whether to use the register scavenger to resolve
 112   // frame index materialization registers. Set according to
 113   // TRI->requiresFrameIndexScavenging() for the current function.
 114   bool FrameIndexVirtualScavenging;
 115
 116   // Flag to control whether the scavenger should be passed even though
 117   // FrameIndexVirtualScavenging is used.
 118   bool FrameIndexEliminationScavenging;
 119
 120   // Emit remarks.
 121   MachineOptimizationRemarkEmitter *ORE = nullptr;
 122
 123   void calculateCallFrameInfo(MachineFunction &MF);
 124   void calculateSaveRestoreBlocks(MachineFunction &MF);
 125   void spillCalleeSavedRegs(MachineFunction &MF);
 126
 127   void calculateFrameObjectOffsets(MachineFunction &MF);
 128   void replaceFrameIndices(MachineFunction &MF);
 129   void replaceFrameIndices(MachineBasicBlock *BB, MachineFunction &MF,
 130                            int &SPAdj);
 131   void insertPrologEpilogCode(MachineFunction &MF);
 132 };
 133
 134 } // end anonymous namespace
 135
 136 char PEI::ID = 0;
 137
 138 char &llvm::PrologEpilogCodeInserterID = PEI::ID;
 139
 140 static cl::opt<unsigned>
 141 WarnStackSize("warn-stack-size", cl::Hidden, cl::init((unsigned)-1),
 142               cl::desc("Warn for stack size bigger than the given"
 143                        " number"));
 144
 145 INITIALIZE_PASS_BEGIN(PEI, DEBUG_TYPE, "Prologue/Epilogue Insertion", false,
 146                       false)
 147 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
 148 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
 149 INITIALIZE_PASS_DEPENDENCY(MachineOptimizationRemarkEmitterPass)
 150 INITIALIZE_PASS_END(PEI, DEBUG_TYPE,
 151                     "Prologue/Epilogue Insertion & Frame Finalization", false,
 152                     false)
 153
 154 MachineFunctionPass *llvm::createPrologEpilogInserterPass() {
 155   return new PEI();
 156 }
 157
 158 STATISTIC(NumBytesStackSpace,
 159           "Number of bytes used for stack in all functions");
 160
 161 void PEI::getAnalysisUsage(AnalysisUsage &AU) const {
 162   AU.setPreservesCFG();
 163   AU.addPreserved<MachineLoopInfo>();
 164   AU.addPreserved<MachineDominatorTree>();
 165   AU.addRequired<MachineOptimizationRemarkEmitterPass>();
 166   MachineFunctionPass::getAnalysisUsage(AU);
 167 }
 168
 169 /// StackObjSet - A set of stack object indexes
 170 using StackObjSet = SmallSetVector<int, 8>;
 171
 172 using SavedDbgValuesMap =
 173     SmallDenseMap<MachineBasicBlock *, SmallVector<MachineInstr *, 4>, 4>;
 174
 175 /// Stash DBG_VALUEs that describe parameters and which are placed at the start
 176 /// of the block. Later on, after the prologue code has been emitted, the
 177 /// stashed DBG_VALUEs will be reinserted at the start of the block.
 178 static void stashEntryDbgValues(MachineBasicBlock &MBB,
 179                                 SavedDbgValuesMap &EntryDbgValues) {
 180   SmallVector<const MachineInstr *, 4> FrameIndexValues;
 181
 182   for (auto &MI : MBB) {
 183     if (!MI.isDebugInstr())
 184       break;
 185     if (!MI.isDebugValue() || !MI.getDebugVariable()->isParameter())
 186       continue;
 187     if (MI.getOperand(0).isFI()) {
 188       // We can only emit valid locations for frame indices after the frame
 189       // setup, so do not stash away them.
 190       FrameIndexValues.push_back(&MI);
 191       continue;
 192     }
 193     const DILocalVariable *Var = MI.getDebugVariable();
 194     const DIExpression *Expr = MI.getDebugExpression();
 195     auto Overlaps = [Var, Expr](const MachineInstr *DV) {
 196       return Var == DV->getDebugVariable() &&
 197              Expr->fragmentsOverlap(DV->getDebugExpression());
 198     };
 199     // See if the debug value overlaps with any preceding debug value that will
 200     // not be stashed. If that is the case, then we can't stash this value, as
 201     // we would then reorder the values at reinsertion.
 202     if (llvm::none_of(FrameIndexValues, Overlaps))
 203       EntryDbgValues[&MBB].push_back(&MI);
 204   }
 205
 206   // Remove stashed debug values from the block.
 207   if (EntryDbgValues.count(&MBB))
 208     for (auto *MI : EntryDbgValues[&MBB])
 209       MI->removeFromParent();
 210 }
 211
 212 /// runOnMachineFunction - Insert prolog/epilog code and replace abstract
 213 /// frame indexes with appropriate references.
 214 bool PEI::runOnMachineFunction(MachineFunction &MF) {
 215   NumFuncSeen++;
 216   const Function &F = MF.getFunction();
 217   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 218   const TargetFrameLowering *TFI = MF.getSubtarget().getFrameLowering();
 219
 220   RS = TRI->requiresRegisterScavenging(MF) ? new RegScavenger() : nullptr;
 221   FrameIndexVirtualScavenging = TRI->requiresFrameIndexScavenging(MF);
 222   ORE = &getAnalysis<MachineOptimizationRemarkEmitterPass>().getORE();
 223
 224   // Calculate the MaxCallFrameSize and AdjustsStack variables for the
 225   // function's frame information. Also eliminates call frame pseudo
 226   // instructions.
 227   calculateCallFrameInfo(MF);
 228
 229   // Determine placement of CSR spill/restore code and prolog/epilog code:
 230   // place all spills in the entry block, all restores in return blocks.
 231   calculateSaveRestoreBlocks(MF);
 232
 233   // Stash away DBG_VALUEs that should not be moved by insertion of prolog code.
 234   SavedDbgValuesMap EntryDbgValues;
 235   for (MachineBasicBlock *SaveBlock : SaveBlocks)
 236     stashEntryDbgValues(*SaveBlock, EntryDbgValues);
 237
 238   // Handle CSR spilling and restoring, for targets that need it.
 239   if (MF.getTarget().usesPhysRegsForPEI())
 240     spillCalleeSavedRegs(MF);
 241
 242   // Allow the target machine to make final modifications to the function
 243   // before the frame layout is finalized.
 244   TFI->processFunctionBeforeFrameFinalized(MF, RS);
 245
 246   // Calculate actual frame offsets for all abstract stack objects...
 247   calculateFrameObjectOffsets(MF);
 248
 249   // Add prolog and epilog code to the function.  This function is required
 250   // to align the stack frame as necessary for any stack variables or
 251   // called functions.  Because of this, calculateCalleeSavedRegisters()
 252   // must be called before this function in order to set the AdjustsStack
 253   // and MaxCallFrameSize variables.
 254   if (!F.hasFnAttribute(Attribute::Naked))
 255     insertPrologEpilogCode(MF);
 256
 257   // Reinsert stashed debug values at the start of the entry blocks.
 258   for (auto &I : EntryDbgValues)
 259     I.first->insert(I.first->begin(), I.second.begin(), I.second.end());
 260
 261   // Replace all MO_FrameIndex operands with physical register references
 262   // and actual offsets.
 263   //
 264   replaceFrameIndices(MF);
 265
 266   // If register scavenging is needed, as we've enabled doing it as a
 267   // post-pass, scavenge the virtual registers that frame index elimination
 268   // inserted.
 269   if (TRI->requiresRegisterScavenging(MF) && FrameIndexVirtualScavenging)
 270     scavengeFrameVirtualRegs(MF, *RS);
 271
 272   // Warn on stack size when we exceeds the given limit.
 273   MachineFrameInfo &MFI = MF.getFrameInfo();
 274   uint64_t StackSize = MFI.getStackSize();
 275   if (WarnStackSize.getNumOccurrences() > 0 && WarnStackSize < StackSize) {
 276     DiagnosticInfoStackSize DiagStackSize(F, StackSize);
 277     F.getContext().diagnose(DiagStackSize);
 278   }
 279   ORE->emit([&]() {
 280     return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "StackSize",
 281                                              MF.getFunction().getSubprogram(),
 282                                              &MF.front())
 283            << ore::NV("NumStackBytes", StackSize) << " stack bytes in function";
 284   });
 285
 286   delete RS;
 287   SaveBlocks.clear();
 288   RestoreBlocks.clear();
 289   MFI.setSavePoint(nullptr);
 290   MFI.setRestorePoint(nullptr);
 291   return true;
 292 }
 293
 294 /// Calculate the MaxCallFrameSize and AdjustsStack
 295 /// variables for the function's frame information and eliminate call frame
 296 /// pseudo instructions.
 297 void PEI::calculateCallFrameInfo(MachineFunction &MF) {
 298   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
 299   const TargetFrameLowering *TFI = MF.getSubtarget().getFrameLowering();
 300   MachineFrameInfo &MFI = MF.getFrameInfo();
 301
 302   unsigned MaxCallFrameSize = 0;
 303   bool AdjustsStack = MFI.adjustsStack();
 304
 305   // Get the function call frame set-up and tear-down instruction opcode
 306   unsigned FrameSetupOpcode = TII.getCallFrameSetupOpcode();
 307   unsigned FrameDestroyOpcode = TII.getCallFrameDestroyOpcode();
 308
 309   // Early exit for targets which have no call frame setup/destroy pseudo
 310   // instructions.
 311   if (FrameSetupOpcode == ~0u && FrameDestroyOpcode == ~0u)
 312     return;
 313
 314   std::vector<MachineBasicBlock::iterator> FrameSDOps;
 315   for (MachineFunction::iterator BB = MF.begin(), E = MF.end(); BB != E; ++BB)
 316     for (MachineBasicBlock::iterator I = BB->begin(); I != BB->end(); ++I)
 317       if (TII.isFrameInstr(*I)) {
 318         unsigned Size = TII.getFrameSize(*I);
 319         if (Size > MaxCallFrameSize) MaxCallFrameSize = Size;
 320         AdjustsStack = true;
 321         FrameSDOps.push_back(I);
 322       } else if (I->isInlineAsm()) {
 323         // Some inline asm's need a stack frame, as indicated by operand 1.
 324         unsigned ExtraInfo = I->getOperand(InlineAsm::MIOp_ExtraInfo).getImm();
 325         if (ExtraInfo & InlineAsm::Extra_IsAlignStack)
 326           AdjustsStack = true;
 327       }
 328
 329   assert(!MFI.isMaxCallFrameSizeComputed() ||
 330          (MFI.getMaxCallFrameSize() == MaxCallFrameSize &&
 331           MFI.adjustsStack() == AdjustsStack));
 332   MFI.setAdjustsStack(AdjustsStack);
 333   MFI.setMaxCallFrameSize(MaxCallFrameSize);
 334
 335   for (std::vector<MachineBasicBlock::iterator>::iterator
 336          i = FrameSDOps.begin(), e = FrameSDOps.end(); i != e; ++i) {
 337     MachineBasicBlock::iterator I = *i;
 338
 339     // If call frames are not being included as part of the stack frame, and
 340     // the target doesn't indicate otherwise, remove the call frame pseudos
 341     // here. The sub/add sp instruction pairs are still inserted, but we don't
 342     // need to track the SP adjustment for frame index elimination.
 343     if (TFI->canSimplifyCallFramePseudos(MF))
 344       TFI->eliminateCallFramePseudoInstr(MF, *I->getParent(), I);
 345   }
 346 }
 347
 348 /// Compute the sets of entry and return blocks for saving and restoring
 349 /// callee-saved registers, and placing prolog and epilog code.
 350 void PEI::calculateSaveRestoreBlocks(MachineFunction &MF) {
 351   const MachineFrameInfo &MFI = MF.getFrameInfo();
 352
 353   // Even when we do not change any CSR, we still want to insert the
 354   // prologue and epilogue of the function.
 355   // So set the save points for those.
 356
 357   // Use the points found by shrink-wrapping, if any.
 358   if (MFI.getSavePoint()) {
 359     SaveBlocks.push_back(MFI.getSavePoint());
 360     assert(MFI.getRestorePoint() && "Both restore and save must be set");
 361     MachineBasicBlock *RestoreBlock = MFI.getRestorePoint();
 362     // If RestoreBlock does not have any successor and is not a return block
 363     // then the end point is unreachable and we do not need to insert any
 364     // epilogue.
 365     if (!RestoreBlock->succ_empty() || RestoreBlock->isReturnBlock())
 366       RestoreBlocks.push_back(RestoreBlock);
 367     return;
 368   }
 369
 370   // Save refs to entry and return blocks.
 371   SaveBlocks.push_back(&MF.front());
 372   for (MachineBasicBlock &MBB : MF) {
 373     if (MBB.isEHFuncletEntry())
 374       SaveBlocks.push_back(&MBB);
 375     if (MBB.isReturnBlock())
 376       RestoreBlocks.push_back(&MBB);
 377   }
 378 }
 379
 380 static void assignCalleeSavedSpillSlots(MachineFunction &F,
 381                                         const BitVector &SavedRegs,
 382                                         unsigned &MinCSFrameIndex,
 383                                         unsigned &MaxCSFrameIndex) {
 384   if (SavedRegs.empty())
 385     return;
 386
 387   const TargetRegisterInfo *RegInfo = F.getSubtarget().getRegisterInfo();
 388   const MCPhysReg *CSRegs = F.getRegInfo().getCalleeSavedRegs();
 389
 390   std::vector<CalleeSavedInfo> CSI;
 391   for (unsigned i = 0; CSRegs[i]; ++i) {
 392     unsigned Reg = CSRegs[i];
 393     if (SavedRegs.test(Reg))
 394       CSI.push_back(CalleeSavedInfo(Reg));
 395   }
 396
 397   const TargetFrameLowering *TFI = F.getSubtarget().getFrameLowering();
 398   MachineFrameInfo &MFI = F.getFrameInfo();
 399   if (!TFI->assignCalleeSavedSpillSlots(F, RegInfo, CSI)) {
 400     // If target doesn't implement this, use generic code.
 401
 402     if (CSI.empty())
 403       return; // Early exit if no callee saved registers are modified!
 404
 405     unsigned NumFixedSpillSlots;
 406     const TargetFrameLowering::SpillSlot *FixedSpillSlots =
 407         TFI->getCalleeSavedSpillSlots(NumFixedSpillSlots);
 408
 409     // Now that we know which registers need to be saved and restored, allocate
 410     // stack slots for them.
 411     for (auto &CS : CSI) {
 412       // If the target has spilled this register to another register, we don't
 413       // need to allocate a stack slot.
 414       if (CS.isSpilledToReg())
 415         continue;
 416
 417       unsigned Reg = CS.getReg();
 418       const TargetRegisterClass *RC = RegInfo->getMinimalPhysRegClass(Reg);
 419
 420       int FrameIdx;
 421       if (RegInfo->hasReservedSpillSlot(F, Reg, FrameIdx)) {
 422         CS.setFrameIdx(FrameIdx);
 423         continue;
 424       }
 425
 426       // Check to see if this physreg must be spilled to a particular stack slot
 427       // on this target.
 428       const TargetFrameLowering::SpillSlot *FixedSlot = FixedSpillSlots;
 429       while (FixedSlot != FixedSpillSlots + NumFixedSpillSlots &&
 430              FixedSlot->Reg != Reg)
 431         ++FixedSlot;
 432
 433       unsigned Size = RegInfo->getSpillSize(*RC);
 434       if (FixedSlot == FixedSpillSlots + NumFixedSpillSlots) {
 435         // Nope, just spill it anywhere convenient.
 436         unsigned Align = RegInfo->getSpillAlignment(*RC);
 437         unsigned StackAlign = TFI->getStackAlignment();
 438
 439         // We may not be able to satisfy the desired alignment specification of
 440         // the TargetRegisterClass if the stack alignment is smaller. Use the
 441         // min.
 442         Align = std::min(Align, StackAlign);
 443         FrameIdx = MFI.CreateStackObject(Size, Align, true);
 444         if ((unsigned)FrameIdx < MinCSFrameIndex) MinCSFrameIndex = FrameIdx;
 445         if ((unsigned)FrameIdx > MaxCSFrameIndex) MaxCSFrameIndex = FrameIdx;
 446       } else {
 447         // Spill it to the stack where we must.
 448         FrameIdx = MFI.CreateFixedSpillStackObject(Size, FixedSlot->Offset);
 449       }
 450
 451       CS.setFrameIdx(FrameIdx);
 452     }
 453   }
 454
 455   MFI.setCalleeSavedInfo(CSI);
 456 }
 457
 458 /// Helper function to update the liveness information for the callee-saved
 459 /// registers.
 460 static void updateLiveness(MachineFunction &MF) {
 461   MachineFrameInfo &MFI = MF.getFrameInfo();
 462   // Visited will contain all the basic blocks that are in the region
 463   // where the callee saved registers are alive:
 464   // - Anything that is not Save or Restore -> LiveThrough.
 465   // - Save -> LiveIn.
 466   // - Restore -> LiveOut.
 467   // The live-out is not attached to the block, so no need to keep
 468   // Restore in this set.
 469   SmallPtrSet<MachineBasicBlock *, 8> Visited;
 470   SmallVector<MachineBasicBlock *, 8> WorkList;
 471   MachineBasicBlock *Entry = &MF.front();
 472   MachineBasicBlock *Save = MFI.getSavePoint();
 473
 474   if (!Save)
 475     Save = Entry;
 476
 477   if (Entry != Save) {
 478     WorkList.push_back(Entry);
 479     Visited.insert(Entry);
 480   }
 481   Visited.insert(Save);
 482
 483   MachineBasicBlock *Restore = MFI.getRestorePoint();
 484   if (Restore)
 485     // By construction Restore cannot be visited, otherwise it
 486     // means there exists a path to Restore that does not go
 487     // through Save.
 488     WorkList.push_back(Restore);
 489
 490   while (!WorkList.empty()) {
 491     const MachineBasicBlock *CurBB = WorkList.pop_back_val();
 492     // By construction, the region that is after the save point is
 493     // dominated by the Save and post-dominated by the Restore.
 494     if (CurBB == Save && Save != Restore)
 495       continue;
 496     // Enqueue all the successors not already visited.
 497     // Those are by construction either before Save or after Restore.
 498     for (MachineBasicBlock *SuccBB : CurBB->successors())
 499       if (Visited.insert(SuccBB).second)
 500         WorkList.push_back(SuccBB);
 501   }
 502
 503   const std::vector<CalleeSavedInfo> &CSI = MFI.getCalleeSavedInfo();
 504
 505   MachineRegisterInfo &MRI = MF.getRegInfo();
 506   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
 507     for (MachineBasicBlock *MBB : Visited) {
 508       MCPhysReg Reg = CSI[i].getReg();
 509       // Add the callee-saved register as live-in.
 510       // It's killed at the spill.
 511       if (!MRI.isReserved(Reg) && !MBB->isLiveIn(Reg))
 512         MBB->addLiveIn(Reg);
 513     }
 514     // If callee-saved register is spilled to another register rather than
 515     // spilling to stack, the destination register has to be marked as live for
 516     // each MBB between the prologue and epilogue so that it is not clobbered
 517     // before it is reloaded in the epilogue. The Visited set contains all
 518     // blocks outside of the region delimited by prologue/epilogue.
 519     if (CSI[i].isSpilledToReg()) {
 520       for (MachineBasicBlock &MBB : MF) {
 521         if (Visited.count(&MBB))
 522           continue;
 523         MCPhysReg DstReg = CSI[i].getDstReg();
 524         if (!MBB.isLiveIn(DstReg))
 525           MBB.addLiveIn(DstReg);
 526       }
 527     }
 528   }
 529
 530 }
 531
 532 /// Insert restore code for the callee-saved registers used in the function.
 533 static void insertCSRSaves(MachineBasicBlock &SaveBlock,
 534                            ArrayRef<CalleeSavedInfo> CSI) {
 535   MachineFunction &MF = *SaveBlock.getParent();
 536   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
 537   const TargetFrameLowering *TFI = MF.getSubtarget().getFrameLowering();
 538   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 539
 540   MachineBasicBlock::iterator I = SaveBlock.begin();
 541   if (!TFI->spillCalleeSavedRegisters(SaveBlock, I, CSI, TRI)) {
 542     for (const CalleeSavedInfo &CS : CSI) {
 543       // Insert the spill to the stack frame.
 544       unsigned Reg = CS.getReg();
 545
 546       if (CS.isSpilledToReg()) {
 547         BuildMI(SaveBlock, I, DebugLoc(),
 548                 TII.get(TargetOpcode::COPY), CS.getDstReg())
 549           .addReg(Reg, getKillRegState(true));
 550       } else {
 551         const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
 552         TII.storeRegToStackSlot(SaveBlock, I, Reg, true, CS.getFrameIdx(), RC,
 553                                 TRI);
 554       }
 555     }
 556   }
 557 }
 558
 559 /// Insert restore code for the callee-saved registers used in the function.
 560 static void insertCSRRestores(MachineBasicBlock &RestoreBlock,
 561                               std::vector<CalleeSavedInfo> &CSI) {
 562   MachineFunction &MF = *RestoreBlock.getParent();
 563   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
 564   const TargetFrameLowering *TFI = MF.getSubtarget().getFrameLowering();
 565   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 566
 567   // Restore all registers immediately before the return and any
 568   // terminators that precede it.
 569   MachineBasicBlock::iterator I = RestoreBlock.getFirstTerminator();
 570
 571   if (!TFI->restoreCalleeSavedRegisters(RestoreBlock, I, CSI, TRI)) {
 572     for (const CalleeSavedInfo &CI : reverse(CSI)) {
 573       unsigned Reg = CI.getReg();
 574       if (CI.isSpilledToReg()) {
 575         BuildMI(RestoreBlock, I, DebugLoc(), TII.get(TargetOpcode::COPY), Reg)
 576           .addReg(CI.getDstReg(), getKillRegState(true));
 577       } else {
 578         const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
 579         TII.loadRegFromStackSlot(RestoreBlock, I, Reg, CI.getFrameIdx(), RC, TRI);
 580         assert(I != RestoreBlock.begin() &&
 581                "loadRegFromStackSlot didn't insert any code!");
 582         // Insert in reverse order.  loadRegFromStackSlot can insert
 583         // multiple instructions.
 584       }
 585     }
 586   }
 587 }
 588
 589 void PEI::spillCalleeSavedRegs(MachineFunction &MF) {
 590   // We can't list this requirement in getRequiredProperties because some
 591   // targets (WebAssembly) use virtual registers past this point, and the pass
 592   // pipeline is set up without giving the passes a chance to look at the
 593   // TargetMachine.
 594   // FIXME: Find a way to express this in getRequiredProperties.
 595   assert(MF.getProperties().hasProperty(
 596       MachineFunctionProperties::Property::NoVRegs));
 597
 598   const Function &F = MF.getFunction();
 599   const TargetFrameLowering *TFI = MF.getSubtarget().getFrameLowering();
 600   MachineFrameInfo &MFI = MF.getFrameInfo();
 601   MinCSFrameIndex = std::numeric_limits<unsigned>::max();
 602   MaxCSFrameIndex = 0;
 603
 604   // Determine which of the registers in the callee save list should be saved.
 605   BitVector SavedRegs;
 606   TFI->determineCalleeSaves(MF, SavedRegs, RS);
 607
 608   // Assign stack slots for any callee-saved registers that must be spilled.
 609   assignCalleeSavedSpillSlots(MF, SavedRegs, MinCSFrameIndex, MaxCSFrameIndex);
 610
 611   // Add the code to save and restore the callee saved registers.
 612   if (!F.hasFnAttribute(Attribute::Naked)) {
 613     MFI.setCalleeSavedInfoValid(true);
 614
 615     std::vector<CalleeSavedInfo> &CSI = MFI.getCalleeSavedInfo();
 616     if (!CSI.empty()) {
 617       if (!MFI.hasCalls())
 618         NumLeafFuncWithSpills++;
 619
 620       for (MachineBasicBlock *SaveBlock : SaveBlocks) {
 621         insertCSRSaves(*SaveBlock, CSI);
 622         // Update the live-in information of all the blocks up to the save
 623         // point.
 624         updateLiveness(MF);
 625       }
 626       for (MachineBasicBlock *RestoreBlock : RestoreBlocks)
 627         insertCSRRestores(*RestoreBlock, CSI);
 628     }
 629   }
 630 }
 631
 632 /// AdjustStackOffset - Helper function used to adjust the stack frame offset.
 633 static inline void
 634 AdjustStackOffset(MachineFrameInfo &MFI, int FrameIdx,
 635                   bool StackGrowsDown, int64_t &Offset,
 636                   unsigned &MaxAlign, unsigned Skew) {
 637   // If the stack grows down, add the object size to find the lowest address.
 638   if (StackGrowsDown)
 639     Offset += MFI.getObjectSize(FrameIdx);
 640
 641   unsigned Align = MFI.getObjectAlignment(FrameIdx);
 642
 643   // If the alignment of this object is greater than that of the stack, then
 644   // increase the stack alignment to match.
 645   MaxAlign = std::max(MaxAlign, Align);
 646
 647   // Adjust to alignment boundary.
 648   Offset = alignTo(Offset, Align, Skew);
 649
 650   if (StackGrowsDown) {
 651     LLVM_DEBUG(dbgs() << "alloc FI(" << FrameIdx << ") at SP[" << -Offset
 652                       << "]\n");
 653     MFI.setObjectOffset(FrameIdx, -Offset); // Set the computed offset
 654   } else {
 655     LLVM_DEBUG(dbgs() << "alloc FI(" << FrameIdx << ") at SP[" << Offset
 656                       << "]\n");
 657     MFI.setObjectOffset(FrameIdx, Offset);
 658     Offset += MFI.getObjectSize(FrameIdx);
 659   }
 660 }
 661
 662 /// Compute which bytes of fixed and callee-save stack area are unused and keep
 663 /// track of them in StackBytesFree.
 664 static inline void
 665 computeFreeStackSlots(MachineFrameInfo &MFI, bool StackGrowsDown,
 666                       unsigned MinCSFrameIndex, unsigned MaxCSFrameIndex,
 667                       int64_t FixedCSEnd, BitVector &StackBytesFree) {
 668   // Avoid undefined int64_t -> int conversion below in extreme case.
 669   if (FixedCSEnd > std::numeric_limits<int>::max())
 670     return;
 671
 672   StackBytesFree.resize(FixedCSEnd, true);
 673
 674   SmallVector<int, 16> AllocatedFrameSlots;
 675   // Add fixed objects.
 676   for (int i = MFI.getObjectIndexBegin(); i != 0; ++i)
 677     // StackSlot scavenging is only implemented for the default stack.
 678     if (MFI.getStackID(i) == TargetStackID::Default)
 679       AllocatedFrameSlots.push_back(i);
 680   // Add callee-save objects.
 681   for (int i = MinCSFrameIndex; i <= (int)MaxCSFrameIndex; ++i)
 682     if (MFI.getStackID(i) == TargetStackID::Default)
 683       AllocatedFrameSlots.push_back(i);
 684
 685   for (int i : AllocatedFrameSlots) {
 686     // These are converted from int64_t, but they should always fit in int
 687     // because of the FixedCSEnd check above.
 688     int ObjOffset = MFI.getObjectOffset(i);
 689     int ObjSize = MFI.getObjectSize(i);
 690     int ObjStart, ObjEnd;
 691     if (StackGrowsDown) {
 692       // ObjOffset is negative when StackGrowsDown is true.
 693       ObjStart = -ObjOffset - ObjSize;
 694       ObjEnd = -ObjOffset;
 695     } else {
 696       ObjStart = ObjOffset;
 697       ObjEnd = ObjOffset + ObjSize;
 698     }
 699     // Ignore fixed holes that are in the previous stack frame.
 700     if (ObjEnd > 0)
 701       StackBytesFree.reset(ObjStart, ObjEnd);
 702   }
 703 }
 704
 705 /// Assign frame object to an unused portion of the stack in the fixed stack
 706 /// object range.  Return true if the allocation was successful.
 707 static inline bool scavengeStackSlot(MachineFrameInfo &MFI, int FrameIdx,
 708                                      bool StackGrowsDown, unsigned MaxAlign,
 709                                      BitVector &StackBytesFree) {
 710   if (MFI.isVariableSizedObjectIndex(FrameIdx))
 711     return false;
 712
 713   if (StackBytesFree.none()) {
 714     // clear it to speed up later scavengeStackSlot calls to
 715     // StackBytesFree.none()
 716     StackBytesFree.clear();
 717     return false;
 718   }
 719
 720   unsigned ObjAlign = MFI.getObjectAlignment(FrameIdx);
 721   if (ObjAlign > MaxAlign)
 722     return false;
 723
 724   int64_t ObjSize = MFI.getObjectSize(FrameIdx);
 725   int FreeStart;
 726   for (FreeStart = StackBytesFree.find_first(); FreeStart != -1;
 727        FreeStart = StackBytesFree.find_next(FreeStart)) {
 728
 729     // Check that free space has suitable alignment.
 730     unsigned ObjStart = StackGrowsDown ? FreeStart + ObjSize : FreeStart;
 731     if (alignTo(ObjStart, ObjAlign) != ObjStart)
 732       continue;
 733
 734     if (FreeStart + ObjSize > StackBytesFree.size())
 735       return false;
 736
 737     bool AllBytesFree = true;
 738     for (unsigned Byte = 0; Byte < ObjSize; ++Byte)
 739       if (!StackBytesFree.test(FreeStart + Byte)) {
 740         AllBytesFree = false;
 741         break;
 742       }
 743     if (AllBytesFree)
 744       break;
 745   }
 746
 747   if (FreeStart == -1)
 748     return false;
 749
 750   if (StackGrowsDown) {
 751     int ObjStart = -(FreeStart + ObjSize);
 752     LLVM_DEBUG(dbgs() << "alloc FI(" << FrameIdx << ") scavenged at SP["
 753                       << ObjStart << "]\n");
 754     MFI.setObjectOffset(FrameIdx, ObjStart);
 755   } else {
 756     LLVM_DEBUG(dbgs() << "alloc FI(" << FrameIdx << ") scavenged at SP["
 757                       << FreeStart << "]\n");
 758     MFI.setObjectOffset(FrameIdx, FreeStart);
 759   }
 760
 761   StackBytesFree.reset(FreeStart, FreeStart + ObjSize);
 762   return true;
 763 }
 764
 765 /// AssignProtectedObjSet - Helper function to assign large stack objects (i.e.,
 766 /// those required to be close to the Stack Protector) to stack offsets.
 767 static void
 768 AssignProtectedObjSet(const StackObjSet &UnassignedObjs,
 769                       SmallSet<int, 16> &ProtectedObjs,
 770                       MachineFrameInfo &MFI, bool StackGrowsDown,
 771                       int64_t &Offset, unsigned &MaxAlign, unsigned Skew) {
 772
 773   for (StackObjSet::const_iterator I = UnassignedObjs.begin(),
 774         E = UnassignedObjs.end(); I != E; ++I) {
 775     int i = *I;
 776     AdjustStackOffset(MFI, i, StackGrowsDown, Offset, MaxAlign, Skew);
 777     ProtectedObjs.insert(i);
 778   }
 779 }
 780
 781 /// calculateFrameObjectOffsets - Calculate actual frame offsets for all of the
 782 /// abstract stack objects.
 783 void PEI::calculateFrameObjectOffsets(MachineFunction &MF) {
 784   const TargetFrameLowering &TFI = *MF.getSubtarget().getFrameLowering();
 785
 786   bool StackGrowsDown =
 787     TFI.getStackGrowthDirection() == TargetFrameLowering::StackGrowsDown;
 788
 789   // Loop over all of the stack objects, assigning sequential addresses...
 790   MachineFrameInfo &MFI = MF.getFrameInfo();
 791
 792   // Start at the beginning of the local area.
 793   // The Offset is the distance from the stack top in the direction
 794   // of stack growth -- so it's always nonnegative.
 795   int LocalAreaOffset = TFI.getOffsetOfLocalArea();
 796   if (StackGrowsDown)
 797     LocalAreaOffset = -LocalAreaOffset;
 798   assert(LocalAreaOffset >= 0
 799          && "Local area offset should be in direction of stack growth");
 800   int64_t Offset = LocalAreaOffset;
 801
 802   // Skew to be applied to alignment.
 803   unsigned Skew = TFI.getStackAlignmentSkew(MF);
 804
 805 #ifdef EXPENSIVE_CHECKS
 806   for (unsigned i = 0, e = MFI.getObjectIndexEnd(); i != e; ++i)
 807     if (!MFI.isDeadObjectIndex(i) &&
 808         MFI.getStackID(i) == TargetStackID::Default)
 809       assert(MFI.getObjectAlignment(i) <= MFI.getMaxAlignment() &&
 810              "MaxAlignment is invalid");
 811 #endif
 812
 813   // If there are fixed sized objects that are preallocated in the local area,
 814   // non-fixed objects can't be allocated right at the start of local area.
 815   // Adjust 'Offset' to point to the end of last fixed sized preallocated
 816   // object.
 817   for (int i = MFI.getObjectIndexBegin(); i != 0; ++i) {
 818     if (MFI.getStackID(i) !=
 819         TargetStackID::Default) // Only allocate objects on the default stack.
 820       continue;
 821
 822     int64_t FixedOff;
 823     if (StackGrowsDown) {
 824       // The maximum distance from the stack pointer is at lower address of
 825       // the object -- which is given by offset. For down growing stack
 826       // the offset is negative, so we negate the offset to get the distance.
 827       FixedOff = -MFI.getObjectOffset(i);
 828     } else {
 829       // The maximum distance from the start pointer is at the upper
 830       // address of the object.
 831       FixedOff = MFI.getObjectOffset(i) + MFI.getObjectSize(i);
 832     }
 833     if (FixedOff > Offset) Offset = FixedOff;
 834   }
 835
 836   // First assign frame offsets to stack objects that are used to spill
 837   // callee saved registers.
 838   if (StackGrowsDown) {
 839     for (unsigned i = MinCSFrameIndex; i <= MaxCSFrameIndex; ++i) {
 840       if (MFI.getStackID(i) !=
 841           TargetStackID::Default) // Only allocate objects on the default stack.
 842         continue;
 843
 844       // If the stack grows down, we need to add the size to find the lowest
 845       // address of the object.
 846       Offset += MFI.getObjectSize(i);
 847
 848       unsigned Align = MFI.getObjectAlignment(i);
 849       // Adjust to alignment boundary
 850       Offset = alignTo(Offset, Align, Skew);
 851
 852       LLVM_DEBUG(dbgs() << "alloc FI(" << i << ") at SP[" << -Offset << "]\n");
 853       MFI.setObjectOffset(i, -Offset);        // Set the computed offset
 854     }
 855   } else if (MaxCSFrameIndex >= MinCSFrameIndex) {
 856     // Be careful about underflow in comparisons agains MinCSFrameIndex.
 857     for (unsigned i = MaxCSFrameIndex; i != MinCSFrameIndex - 1; --i) {
 858       if (MFI.getStackID(i) !=
 859           TargetStackID::Default) // Only allocate objects on the default stack.
 860         continue;
 861
 862       if (MFI.isDeadObjectIndex(i))
 863         continue;
 864
 865       unsigned Align = MFI.getObjectAlignment(i);
 866       // Adjust to alignment boundary
 867       Offset = alignTo(Offset, Align, Skew);
 868
 869       LLVM_DEBUG(dbgs() << "alloc FI(" << i << ") at SP[" << Offset << "]\n");
 870       MFI.setObjectOffset(i, Offset);
 871       Offset += MFI.getObjectSize(i);
 872     }
 873   }
 874
 875   // FixedCSEnd is the stack offset to the end of the fixed and callee-save
 876   // stack area.
 877   int64_t FixedCSEnd = Offset;
 878   unsigned MaxAlign = MFI.getMaxAlignment();
 879
 880   // Make sure the special register scavenging spill slot is closest to the
 881   // incoming stack pointer if a frame pointer is required and is closer
 882   // to the incoming rather than the final stack pointer.
 883   const TargetRegisterInfo *RegInfo = MF.getSubtarget().getRegisterInfo();
 884   bool EarlyScavengingSlots = (TFI.hasFP(MF) &&
 885                                TFI.isFPCloseToIncomingSP() &&
 886                                RegInfo->useFPForScavengingIndex(MF) &&
 887                                !RegInfo->needsStackRealignment(MF));
 888   if (RS && EarlyScavengingSlots) {
 889     SmallVector<int, 2> SFIs;
 890     RS->getScavengingFrameIndices(SFIs);
 891     for (SmallVectorImpl<int>::iterator I = SFIs.begin(),
 892            IE = SFIs.end(); I != IE; ++I)
 893       AdjustStackOffset(MFI, *I, StackGrowsDown, Offset, MaxAlign, Skew);
 894   }
 895
 896   // FIXME: Once this is working, then enable flag will change to a target
 897   // check for whether the frame is large enough to want to use virtual
 898   // frame index registers. Functions which don't want/need this optimization
 899   // will continue to use the existing code path.
 900   if (MFI.getUseLocalStackAllocationBlock()) {
 901     unsigned Align = MFI.getLocalFrameMaxAlign();
 902
 903     // Adjust to alignment boundary.
 904     Offset = alignTo(Offset, Align, Skew);
 905
 906     LLVM_DEBUG(dbgs() << "Local frame base offset: " << Offset << "\n");
 907
 908     // Resolve offsets for objects in the local block.
 909     for (unsigned i = 0, e = MFI.getLocalFrameObjectCount(); i != e; ++i) {
 910       std::pair<int, int64_t> Entry = MFI.getLocalFrameObjectMap(i);
 911       int64_t FIOffset = (StackGrowsDown ? -Offset : Offset) + Entry.second;
 912       LLVM_DEBUG(dbgs() << "alloc FI(" << Entry.first << ") at SP[" << FIOffset
 913                         << "]\n");
 914       MFI.setObjectOffset(Entry.first, FIOffset);
 915     }
 916     // Allocate the local block
 917     Offset += MFI.getLocalFrameSize();
 918
 919     MaxAlign = std::max(Align, MaxAlign);
 920   }
 921
 922   // Retrieve the Exception Handler registration node.
 923   int EHRegNodeFrameIndex = std::numeric_limits<int>::max();
 924   if (const WinEHFuncInfo *FuncInfo = MF.getWinEHFuncInfo())
 925     EHRegNodeFrameIndex = FuncInfo->EHRegNodeFrameIndex;
 926
 927   // Make sure that the stack protector comes before the local variables on the
 928   // stack.
 929   SmallSet<int, 16> ProtectedObjs;
 930   if (MFI.hasStackProtectorIndex()) {
 931     int StackProtectorFI = MFI.getStackProtectorIndex();
 932     StackObjSet LargeArrayObjs;
 933     StackObjSet SmallArrayObjs;
 934     StackObjSet AddrOfObjs;
 935
 936     // If we need a stack protector, we need to make sure that
 937     // LocalStackSlotPass didn't already allocate a slot for it.
 938     // If we are told to use the LocalStackAllocationBlock, the stack protector
 939     // is expected to be already pre-allocated.
 940     if (!MFI.getUseLocalStackAllocationBlock())
 941       AdjustStackOffset(MFI, StackProtectorFI, StackGrowsDown, Offset, MaxAlign,
 942                         Skew);
 943     else if (!MFI.isObjectPreAllocated(MFI.getStackProtectorIndex()))
 944       llvm_unreachable(
 945           "Stack protector not pre-allocated by LocalStackSlotPass.");
 946
 947     // Assign large stack objects first.
 948     for (unsigned i = 0, e = MFI.getObjectIndexEnd(); i != e; ++i) {
 949       if (MFI.isObjectPreAllocated(i) && MFI.getUseLocalStackAllocationBlock())
 950         continue;
 951       if (i >= MinCSFrameIndex && i <= MaxCSFrameIndex)
 952         continue;
 953       if (RS && RS->isScavengingFrameIndex((int)i))
 954         continue;
 955       if (MFI.isDeadObjectIndex(i))
 956         continue;
 957       if (StackProtectorFI == (int)i || EHRegNodeFrameIndex == (int)i)
 958         continue;
 959       if (MFI.getStackID(i) !=
 960           TargetStackID::Default) // Only allocate objects on the default stack.
 961         continue;
 962
 963       switch (MFI.getObjectSSPLayout(i)) {
 964       case MachineFrameInfo::SSPLK_None:
 965         continue;
 966       case MachineFrameInfo::SSPLK_SmallArray:
 967         SmallArrayObjs.insert(i);
 968         continue;
 969       case MachineFrameInfo::SSPLK_AddrOf:
 970         AddrOfObjs.insert(i);
 971         continue;
 972       case MachineFrameInfo::SSPLK_LargeArray:
 973         LargeArrayObjs.insert(i);
 974         continue;
 975       }
 976       llvm_unreachable("Unexpected SSPLayoutKind.");
 977     }
 978
 979     // We expect **all** the protected stack objects to be pre-allocated by
 980     // LocalStackSlotPass. If it turns out that PEI still has to allocate some
 981     // of them, we may end up messing up the expected order of the objects.
 982     if (MFI.getUseLocalStackAllocationBlock() &&
 983         !(LargeArrayObjs.empty() && SmallArrayObjs.empty() &&
 984           AddrOfObjs.empty()))
 985       llvm_unreachable("Found protected stack objects not pre-allocated by "
 986                        "LocalStackSlotPass.");
 987
 988     AssignProtectedObjSet(LargeArrayObjs, ProtectedObjs, MFI, StackGrowsDown,
 989                           Offset, MaxAlign, Skew);
 990     AssignProtectedObjSet(SmallArrayObjs, ProtectedObjs, MFI, StackGrowsDown,
 991                           Offset, MaxAlign, Skew);
 992     AssignProtectedObjSet(AddrOfObjs, ProtectedObjs, MFI, StackGrowsDown,
 993                           Offset, MaxAlign, Skew);
 994   }
 995
 996   SmallVector<int, 8> ObjectsToAllocate;
 997
 998   // Then prepare to assign frame offsets to stack objects that are not used to
 999   // spill callee saved registers.
1000   for (unsigned i = 0, e = MFI.getObjectIndexEnd(); i != e; ++i) {
1001     if (MFI.isObjectPreAllocated(i) && MFI.getUseLocalStackAllocationBlock())
1002       continue;
1003     if (i >= MinCSFrameIndex && i <= MaxCSFrameIndex)
1004       continue;
1005     if (RS && RS->isScavengingFrameIndex((int)i))
1006       continue;
1007     if (MFI.isDeadObjectIndex(i))
1008       continue;
1009     if (MFI.getStackProtectorIndex() == (int)i || EHRegNodeFrameIndex == (int)i)
1010       continue;
1011     if (ProtectedObjs.count(i))
1012       continue;
1013     if (MFI.getStackID(i) !=
1014         TargetStackID::Default) // Only allocate objects on the default stack.
1015       continue;
1016
1017     // Add the objects that we need to allocate to our working set.
1018     ObjectsToAllocate.push_back(i);
1019   }
1020
1021   // Allocate the EH registration node first if one is present.
1022   if (EHRegNodeFrameIndex != std::numeric_limits<int>::max())
1023     AdjustStackOffset(MFI, EHRegNodeFrameIndex, StackGrowsDown, Offset,
1024                       MaxAlign, Skew);
1025
1026   // Give the targets a chance to order the objects the way they like it.
1027   if (MF.getTarget().getOptLevel() != CodeGenOpt::None &&
1028       MF.getTarget().Options.StackSymbolOrdering)
1029     TFI.orderFrameObjects(MF, ObjectsToAllocate);
1030
1031   // Keep track of which bytes in the fixed and callee-save range are used so we
1032   // can use the holes when allocating later stack objects.  Only do this if
1033   // stack protector isn't being used and the target requests it and we're
1034   // optimizing.
1035   BitVector StackBytesFree;
1036   if (!ObjectsToAllocate.empty() &&
1037       MF.getTarget().getOptLevel() != CodeGenOpt::None &&
1038       MFI.getStackProtectorIndex() < 0 && TFI.enableStackSlotScavenging(MF))
1039     computeFreeStackSlots(MFI, StackGrowsDown, MinCSFrameIndex, MaxCSFrameIndex,
1040                           FixedCSEnd, StackBytesFree);
1041
1042   // Now walk the objects and actually assign base offsets to them.
1043   for (auto &Object : ObjectsToAllocate)
1044     if (!scavengeStackSlot(MFI, Object, StackGrowsDown, MaxAlign,
1045                            StackBytesFree))
1046       AdjustStackOffset(MFI, Object, StackGrowsDown, Offset, MaxAlign, Skew);
1047
1048   // Make sure the special register scavenging spill slot is closest to the
1049   // stack pointer.
1050   if (RS && !EarlyScavengingSlots) {
1051     SmallVector<int, 2> SFIs;
1052     RS->getScavengingFrameIndices(SFIs);
1053     for (SmallVectorImpl<int>::iterator I = SFIs.begin(),
1054            IE = SFIs.end(); I != IE; ++I)
1055       AdjustStackOffset(MFI, *I, StackGrowsDown, Offset, MaxAlign, Skew);
1056   }
1057
1058   if (!TFI.targetHandlesStackFrameRounding()) {
1059     // If we have reserved argument space for call sites in the function
1060     // immediately on entry to the current function, count it as part of the
1061     // overall stack size.
1062     if (MFI.adjustsStack() && TFI.hasReservedCallFrame(MF))
1063       Offset += MFI.getMaxCallFrameSize();
1064
1065     // Round up the size to a multiple of the alignment.  If the function has
1066     // any calls or alloca's, align to the target's StackAlignment value to
1067     // ensure that the callee's frame or the alloca data is suitably aligned;
1068     // otherwise, for leaf functions, align to the TransientStackAlignment
1069     // value.
1070     unsigned StackAlign;
1071     if (MFI.adjustsStack() || MFI.hasVarSizedObjects() ||
1072         (RegInfo->needsStackRealignment(MF) && MFI.getObjectIndexEnd() != 0))
1073       StackAlign = TFI.getStackAlignment();
1074     else
1075       StackAlign = TFI.getTransientStackAlignment();
1076
1077     // If the frame pointer is eliminated, all frame offsets will be relative to
1078     // SP not FP. Align to MaxAlign so this works.
1079     StackAlign = std::max(StackAlign, MaxAlign);
1080     Offset = alignTo(Offset, StackAlign, Skew);
1081   }
1082
1083   // Update frame info to pretend that this is part of the stack...
1084   int64_t StackSize = Offset - LocalAreaOffset;
1085   MFI.setStackSize(StackSize);
1086   NumBytesStackSpace += StackSize;
1087 }
1088
1089 /// insertPrologEpilogCode - Scan the function for modified callee saved
1090 /// registers, insert spill code for these callee saved registers, then add
1091 /// prolog and epilog code to the function.
1092 void PEI::insertPrologEpilogCode(MachineFunction &MF) {
1093   const TargetFrameLowering &TFI = *MF.getSubtarget().getFrameLowering();
1094
1095   // Add prologue to the function...
1096   for (MachineBasicBlock *SaveBlock : SaveBlocks)
1097     TFI.emitPrologue(MF, *SaveBlock);
1098
1099   // Add epilogue to restore the callee-save registers in each exiting block.
1100   for (MachineBasicBlock *RestoreBlock : RestoreBlocks)
1101     TFI.emitEpilogue(MF, *RestoreBlock);
1102
1103   for (MachineBasicBlock *SaveBlock : SaveBlocks)
1104     TFI.inlineStackProbe(MF, *SaveBlock);
1105
1106   // Emit additional code that is required to support segmented stacks, if
1107   // we've been asked for it.  This, when linked with a runtime with support
1108   // for segmented stacks (libgcc is one), will result in allocating stack
1109   // space in small chunks instead of one large contiguous block.
1110   if (MF.shouldSplitStack()) {
1111     for (MachineBasicBlock *SaveBlock : SaveBlocks)
1112       TFI.adjustForSegmentedStacks(MF, *SaveBlock);
1113     // Record that there are split-stack functions, so we will emit a
1114     // special section to tell the linker.
1115     MF.getMMI().setHasSplitStack(true);
1116   } else
1117     MF.getMMI().setHasNosplitStack(true);
1118
1119   // Emit additional code that is required to explicitly handle the stack in
1120   // HiPE native code (if needed) when loaded in the Erlang/OTP runtime. The
1121   // approach is rather similar to that of Segmented Stacks, but it uses a
1122   // different conditional check and another BIF for allocating more stack
1123   // space.
1124   if (MF.getFunction().getCallingConv() == CallingConv::HiPE)
1125     for (MachineBasicBlock *SaveBlock : SaveBlocks)
1126       TFI.adjustForHiPEPrologue(MF, *SaveBlock);
1127 }
1128
1129 /// replaceFrameIndices - Replace all MO_FrameIndex operands with physical
1130 /// register references and actual offsets.
1131 void PEI::replaceFrameIndices(MachineFunction &MF) {
1132   const auto &ST = MF.getSubtarget();
1133   const TargetFrameLowering &TFI = *ST.getFrameLowering();
1134   if (!TFI.needsFrameIndexResolution(MF))
1135     return;
1136
1137   const TargetRegisterInfo *TRI = ST.getRegisterInfo();
1138
1139   // Allow the target to determine this after knowing the frame size.
1140   FrameIndexEliminationScavenging = (RS && !FrameIndexVirtualScavenging) ||
1141     TRI->requiresFrameIndexReplacementScavenging(MF);
1142
1143   // Store SPAdj at exit of a basic block.
1144   SmallVector<int, 8> SPState;
1145   SPState.resize(MF.getNumBlockIDs());
1146   df_iterator_default_set<MachineBasicBlock*> Reachable;
1147
1148   // Iterate over the reachable blocks in DFS order.
1149   for (auto DFI = df_ext_begin(&MF, Reachable), DFE = df_ext_end(&MF, Reachable);
1150        DFI != DFE; ++DFI) {
1151     int SPAdj = 0;
1152     // Check the exit state of the DFS stack predecessor.
1153     if (DFI.getPathLength() >= 2) {
1154       MachineBasicBlock *StackPred = DFI.getPath(DFI.getPathLength() - 2);
1155       assert(Reachable.count(StackPred) &&
1156              "DFS stack predecessor is already visited.\n");
1157       SPAdj = SPState[StackPred->getNumber()];
1158     }
1159     MachineBasicBlock *BB = *DFI;
1160     replaceFrameIndices(BB, MF, SPAdj);
1161     SPState[BB->getNumber()] = SPAdj;
1162   }
1163
1164   // Handle the unreachable blocks.
1165   for (auto &BB : MF) {
1166     if (Reachable.count(&BB))
1167       // Already handled in DFS traversal.
1168       continue;
1169     int SPAdj = 0;
1170     replaceFrameIndices(&BB, MF, SPAdj);
1171   }
1172 }
1173
1174 void PEI::replaceFrameIndices(MachineBasicBlock *BB, MachineFunction &MF,
1175                               int &SPAdj) {
1176   assert(MF.getSubtarget().getRegisterInfo() &&
1177          "getRegisterInfo() must be implemented!");
1178   const TargetInstrInfo &TII = *MF.getSubtarget().getInstrInfo();
1179   const TargetRegisterInfo &TRI = *MF.getSubtarget().getRegisterInfo();
1180   const TargetFrameLowering *TFI = MF.getSubtarget().getFrameLowering();
1181
1182   if (RS && FrameIndexEliminationScavenging)
1183     RS->enterBasicBlock(*BB);
1184
1185   bool InsideCallSequence = false;
1186
1187   for (MachineBasicBlock::iterator I = BB->begin(); I != BB->end(); ) {
1188     if (TII.isFrameInstr(*I)) {
1189       InsideCallSequence = TII.isFrameSetup(*I);
1190       SPAdj += TII.getSPAdjust(*I);
1191       I = TFI->eliminateCallFramePseudoInstr(MF, *BB, I);
1192       continue;
1193     }
1194
1195     MachineInstr &MI = *I;
1196     bool DoIncr = true;
1197     bool DidFinishLoop = true;
1198     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1199       if (!MI.getOperand(i).isFI())
1200         continue;
1201
1202       // Frame indices in debug values are encoded in a target independent
1203       // way with simply the frame index and offset rather than any
1204       // target-specific addressing mode.
1205       if (MI.isDebugValue()) {
1206         assert(i == 0 && "Frame indices can only appear as the first "
1207                          "operand of a DBG_VALUE machine instruction");
1208         unsigned Reg;
1209         unsigned FrameIdx = MI.getOperand(0).getIndex();
1210         unsigned Size = MF.getFrameInfo().getObjectSize(FrameIdx);
1211
1212         int64_t Offset =
1213             TFI->getFrameIndexReference(MF, FrameIdx, Reg);
1214         MI.getOperand(0).ChangeToRegister(Reg, false /*isDef*/);
1215         MI.getOperand(0).setIsDebug();
1216
1217         const DIExpression *DIExpr = MI.getDebugExpression();
1218
1219         // If we have a direct DBG_VALUE, and its location expression isn't
1220         // currently complex, then adding an offset will morph it into a
1221         // complex location that is interpreted as being a memory address.
1222         // This changes a pointer-valued variable to dereference that pointer,
1223         // which is incorrect. Fix by adding DW_OP_stack_value.
1224         unsigned PrependFlags = DIExpression::ApplyOffset;
1225         if (!MI.isIndirectDebugValue() && !DIExpr->isComplex())
1226           PrependFlags |= DIExpression::StackValue;
1227
1228         // If we have DBG_VALUE that is indirect and has a Implicit location
1229         // expression need to insert a deref before prepending a Memory
1230         // location expression. Also after doing this we change the DBG_VALUE
1231         // to be direct.
1232         if (MI.isIndirectDebugValue() && DIExpr->isImplicit()) {
1233           SmallVector<uint64_t, 2> Ops = {dwarf::DW_OP_deref_size, Size};
1234           bool WithStackValue = true;
1235           DIExpr = DIExpression::prependOpcodes(DIExpr, Ops, WithStackValue);
1236           // Make the DBG_VALUE direct.
1237           MI.getOperand(1).ChangeToRegister(0, false);
1238         }
1239         DIExpr = DIExpression::prepend(DIExpr, PrependFlags, Offset);
1240         MI.getOperand(3).setMetadata(DIExpr);
1241         continue;
1242       }
1243
1244       // TODO: This code should be commoned with the code for
1245       // PATCHPOINT. There's no good reason for the difference in
1246       // implementation other than historical accident.  The only
1247       // remaining difference is the unconditional use of the stack
1248       // pointer as the base register.
1249       if (MI.getOpcode() == TargetOpcode::STATEPOINT) {
1250         assert((!MI.isDebugValue() || i == 0) &&
1251                "Frame indicies can only appear as the first operand of a "
1252                "DBG_VALUE machine instruction");
1253         unsigned Reg;
1254         MachineOperand &Offset = MI.getOperand(i + 1);
1255         int refOffset = TFI->getFrameIndexReferencePreferSP(
1256             MF, MI.getOperand(i).getIndex(), Reg, /*IgnoreSPUpdates*/ false);
1257         Offset.setImm(Offset.getImm() + refOffset + SPAdj);
1258         MI.getOperand(i).ChangeToRegister(Reg, false /*isDef*/);
1259         continue;
1260       }
1261
1262       // Some instructions (e.g. inline asm instructions) can have
1263       // multiple frame indices and/or cause eliminateFrameIndex
1264       // to insert more than one instruction. We need the register
1265       // scavenger to go through all of these instructions so that
1266       // it can update its register information. We keep the
1267       // iterator at the point before insertion so that we can
1268       // revisit them in full.
1269       bool AtBeginning = (I == BB->begin());
1270       if (!AtBeginning) --I;
1271
1272       // If this instruction has a FrameIndex operand, we need to
1273       // use that target machine register info object to eliminate
1274       // it.
1275       TRI.eliminateFrameIndex(MI, SPAdj, i,
1276                               FrameIndexEliminationScavenging ?  RS : nullptr);
1277
1278       // Reset the iterator if we were at the beginning of the BB.
1279       if (AtBeginning) {
1280         I = BB->begin();
1281         DoIncr = false;
1282       }
1283
1284       DidFinishLoop = false;
1285       break;
1286     }
1287
1288     // If we are looking at a call sequence, we need to keep track of
1289     // the SP adjustment made by each instruction in the sequence.
1290     // This includes both the frame setup/destroy pseudos (handled above),
1291     // as well as other instructions that have side effects w.r.t the SP.
1292     // Note that this must come after eliminateFrameIndex, because
1293     // if I itself referred to a frame index, we shouldn't count its own
1294     // adjustment.
1295     if (DidFinishLoop && InsideCallSequence)
1296       SPAdj += TII.getSPAdjust(MI);
1297
1298     if (DoIncr && I != BB->end()) ++I;
1299
1300     // Update register states.
1301     if (RS && FrameIndexEliminationScavenging && DidFinishLoop)
1302       RS->forward(MI);
1303   }
1304 }