lib/CodeGen/Spiller.cpp

   1 //===-- llvm/CodeGen/Spiller.cpp -  Spiller -------------------------------===//
   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 #include "Spiller.h"
  11 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  12 #include "llvm/CodeGen/LiveRangeEdit.h"
  13 #include "llvm/CodeGen/LiveStackAnalysis.h"
  14 #include "llvm/CodeGen/MachineFrameInfo.h"
  15 #include "llvm/CodeGen/MachineFunction.h"
  16 #include "llvm/CodeGen/MachineInstrBuilder.h"
  17 #include "llvm/CodeGen/MachineLoopInfo.h"
  18 #include "llvm/CodeGen/MachineRegisterInfo.h"
  19 #include "llvm/CodeGen/VirtRegMap.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include "llvm/Target/TargetInstrInfo.h"
  25
  26 using namespace llvm;
  27
  28 #define DEBUG_TYPE "spiller"
  29
  30 namespace {
  31   enum SpillerName { trivial, inline_ };
  32 }
  33
  34 static cl::opt<SpillerName>
  35 spillerOpt("spiller",
  36            cl::desc("Spiller to use: (default: standard)"),
  37            cl::Prefix,
  38            cl::values(clEnumVal(trivial,   "trivial spiller"),
  39                       clEnumValN(inline_,  "inline", "inline spiller"),
  40                       clEnumValEnd),
  41            cl::init(trivial));
  42
  43 // Spiller virtual destructor implementation.
  44 Spiller::~Spiller() {}
  45
  46 namespace {
  47
  48 /// Utility class for spillers.
  49 class SpillerBase : public Spiller {
  50 protected:
  51   MachineFunctionPass *pass;
  52   MachineFunction *mf;
  53   VirtRegMap *vrm;
  54   LiveIntervals *lis;
  55   MachineFrameInfo *mfi;
  56   MachineRegisterInfo *mri;
  57   const TargetInstrInfo *tii;
  58   const TargetRegisterInfo *tri;
  59
  60   /// Construct a spiller base.
  61   SpillerBase(MachineFunctionPass &pass, MachineFunction &mf, VirtRegMap &vrm)
  62     : pass(&pass), mf(&mf), vrm(&vrm)
  63   {
  64     lis = &pass.getAnalysis<LiveIntervals>();
  65     mfi = mf.getFrameInfo();
  66     mri = &mf.getRegInfo();
  67     tii = mf.getSubtarget().getInstrInfo();
  68     tri = mf.getSubtarget().getRegisterInfo();
  69   }
  70
  71   /// Add spill ranges for every use/def of the live interval, inserting loads
  72   /// immediately before each use, and stores after each def. No folding or
  73   /// remat is attempted.
  74   void trivialSpillEverywhere(LiveRangeEdit& LRE) {
  75     LiveInterval* li = &LRE.getParent();
  76
  77     DEBUG(dbgs() << "Spilling everywhere " << *li << "\n");
  78
  79     assert(li->weight != llvm::huge_valf &&
  80            "Attempting to spill already spilled value.");
  81
  82     assert(!TargetRegisterInfo::isStackSlot(li->reg) &&
  83            "Trying to spill a stack slot.");
  84
  85     DEBUG(dbgs() << "Trivial spill everywhere of reg" << li->reg << "\n");
  86
  87     const TargetRegisterClass *trc = mri->getRegClass(li->reg);
  88     unsigned ss = vrm->assignVirt2StackSlot(li->reg);
  89
  90     // Iterate over reg uses/defs.
  91     for (MachineRegisterInfo::reg_instr_iterator
  92          regItr = mri->reg_instr_begin(li->reg);
  93          regItr != mri->reg_instr_end();) {
  94
  95       // Grab the use/def instr.
  96       MachineInstr *mi = &*regItr;
  97
  98       DEBUG(dbgs() << "  Processing " << *mi);
  99
 100       // Step regItr to the next use/def instr.
 101       ++regItr;
 102
 103       // Collect uses & defs for this instr.
 104       SmallVector<unsigned, 2> indices;
 105       bool hasUse = false;
 106       bool hasDef = false;
 107       for (unsigned i = 0; i != mi->getNumOperands(); ++i) {
 108         MachineOperand &op = mi->getOperand(i);
 109         if (!op.isReg() || op.getReg() != li->reg)
 110           continue;
 111         hasUse |= mi->getOperand(i).isUse();
 112         hasDef |= mi->getOperand(i).isDef();
 113         indices.push_back(i);
 114       }
 115
 116       // Create a new virtual register for the load and/or store.
 117       unsigned NewVReg = LRE.create();
 118
 119       // Update the reg operands & kill flags.
 120       for (unsigned i = 0; i < indices.size(); ++i) {
 121         unsigned mopIdx = indices[i];
 122         MachineOperand &mop = mi->getOperand(mopIdx);
 123         mop.setReg(NewVReg);
 124         if (mop.isUse() && !mi->isRegTiedToDefOperand(mopIdx)) {
 125           mop.setIsKill(true);
 126         }
 127       }
 128       assert(hasUse || hasDef);
 129
 130       // Insert reload if necessary.
 131       MachineBasicBlock::iterator miItr(mi);
 132       if (hasUse) {
 133         MachineInstrSpan MIS(miItr);
 134
 135         tii->loadRegFromStackSlot(*mi->getParent(), miItr, NewVReg, ss, trc,
 136                                   tri);
 137         lis->InsertMachineInstrRangeInMaps(MIS.begin(), miItr);
 138       }
 139
 140       // Insert store if necessary.
 141       if (hasDef) {
 142         MachineInstrSpan MIS(miItr);
 143
 144         tii->storeRegToStackSlot(*mi->getParent(), std::next(miItr), NewVReg,
 145                                  true, ss, trc, tri);
 146         lis->InsertMachineInstrRangeInMaps(std::next(miItr), MIS.end());
 147       }
 148     }
 149   }
 150 };
 151
 152 } // end anonymous namespace
 153
 154 namespace {
 155
 156 /// Spills any live range using the spill-everywhere method with no attempt at
 157 /// folding.
 158 class TrivialSpiller : public SpillerBase {
 159 public:
 160
 161   TrivialSpiller(MachineFunctionPass &pass, MachineFunction &mf,
 162                  VirtRegMap &vrm)
 163     : SpillerBase(pass, mf, vrm) {}
 164
 165   void spill(LiveRangeEdit &LRE) override {
 166     // Ignore spillIs - we don't use it.
 167     trivialSpillEverywhere(LRE);
 168   }
 169 };
 170
 171 } // end anonymous namespace
 172
 173 void Spiller::anchor() { }
 174
 175 llvm::Spiller* llvm::createSpiller(MachineFunctionPass &pass,
 176                                    MachineFunction &mf,
 177                                    VirtRegMap &vrm) {
 178   switch (spillerOpt) {
 179   case trivial: return new TrivialSpiller(pass, mf, vrm);
 180   case inline_: return createInlineSpiller(pass, mf, vrm);
 181   }
 182   llvm_unreachable("Invalid spiller optimization");
 183 }