lib/CodeGen/VirtRegMap.h

   1 //===-- llvm/CodeGen/VirtRegMap.h - Virtual Register Map -*- C++ -*--------===//
   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 file implements a virtual register map. This maps virtual registers to
  11 // physical registers and virtual registers to stack slots. It is created and
  12 // updated by a register allocator and then used by a machine code rewriter that
  13 // adds spill code and rewrites virtual into physical register references.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_CODEGEN_VIRTREGMAP_H
  18 #define LLVM_CODEGEN_VIRTREGMAP_H
  19
  20 #include "llvm/Target/TargetRegisterInfo.h"
  21 #include "llvm/ADT/DenseMap.h"
  22 #include "llvm/ADT/IndexedMap.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/Support/Streams.h"
  25 #include <map>
  26
  27 namespace llvm {
  28   class MachineInstr;
  29   class MachineFunction;
  30   class TargetInstrInfo;
  31
  32   class VirtRegMap {
  33   public:
  34     enum {
  35       NO_PHYS_REG = 0,
  36       NO_STACK_SLOT = (1L << 30)-1,
  37       MAX_STACK_SLOT = (1L << 18)-1
  38     };
  39
  40     enum ModRef { isRef = 1, isMod = 2, isModRef = 3 };
  41     typedef std::multimap<MachineInstr*,
  42                           std::pair<unsigned, ModRef> > MI2VirtMapTy;
  43
  44   private:
  45     const TargetInstrInfo &TII;
  46
  47     MachineFunction &MF;
  48     /// Virt2PhysMap - This is a virtual to physical register
  49     /// mapping. Each virtual register is required to have an entry in
  50     /// it; even spilled virtual registers (the register mapped to a
  51     /// spilled register is the temporary used to load it from the
  52     /// stack).
  53     IndexedMap<unsigned, VirtReg2IndexFunctor> Virt2PhysMap;
  54
  55     /// Virt2StackSlotMap - This is virtual register to stack slot
  56     /// mapping. Each spilled virtual register has an entry in it
  57     /// which corresponds to the stack slot this register is spilled
  58     /// at.
  59     IndexedMap<int, VirtReg2IndexFunctor> Virt2StackSlotMap;
  60
  61     /// Virt2StackSlotMap - This is virtual register to rematerialization id
  62     /// mapping. Each spilled virtual register that should be remat'd has an
  63     /// entry in it which corresponds to the remat id.
  64     IndexedMap<int, VirtReg2IndexFunctor> Virt2ReMatIdMap;
  65
  66     /// Virt2SplitMap - This is virtual register to splitted virtual register
  67     /// mapping.
  68     IndexedMap<unsigned, VirtReg2IndexFunctor> Virt2SplitMap;
  69
  70     /// Virt2SplitKillMap - This is splitted virtual register to its last use
  71     /// (kill) index mapping.
  72     IndexedMap<unsigned> Virt2SplitKillMap;
  73
  74     /// ReMatMap - This is virtual register to re-materialized instruction
  75     /// mapping. Each virtual register whose definition is going to be
  76     /// re-materialized has an entry in it.
  77     IndexedMap<MachineInstr*, VirtReg2IndexFunctor> ReMatMap;
  78
  79     /// MI2VirtMap - This is MachineInstr to virtual register
  80     /// mapping. In the case of memory spill code being folded into
  81     /// instructions, we need to know which virtual register was
  82     /// read/written by this instruction.
  83     MI2VirtMapTy MI2VirtMap;
  84
  85     /// SpillPt2VirtMap - This records the virtual registers which should
  86     /// be spilled right after the MachineInstr due to live interval
  87     /// splitting.
  88     std::map<MachineInstr*, std::vector<std::pair<unsigned,bool> > >
  89     SpillPt2VirtMap;
  90
  91     /// RestorePt2VirtMap - This records the virtual registers which should
  92     /// be restored right before the MachineInstr due to live interval
  93     /// splitting.
  94     std::map<MachineInstr*, std::vector<unsigned> > RestorePt2VirtMap;
  95
  96     /// EmergencySpillMap - This records the physical registers that should
  97     /// be spilled / restored around the MachineInstr since the register
  98     /// allocator has run out of registers.
  99     std::map<MachineInstr*, std::vector<unsigned> > EmergencySpillMap;
 100
 101     /// EmergencySpillSlots - This records emergency spill slots used to
 102     /// spill physical registers when the register allocator runs out of
 103     /// registers. Ideally only one stack slot is used per function per
 104     /// register class.
 105     std::map<const TargetRegisterClass*, int> EmergencySpillSlots;
 106
 107     /// ReMatId - Instead of assigning a stack slot to a to be rematerialized
 108     /// virtual register, an unique id is being assigned. This keeps track of
 109     /// the highest id used so far. Note, this starts at (1<<18) to avoid
 110     /// conflicts with stack slot numbers.
 111     int ReMatId;
 112
 113     /// LowSpillSlot, HighSpillSlot - Lowest and highest spill slot indexes.
 114     int LowSpillSlot, HighSpillSlot;
 115
 116     /// SpillSlotToUsesMap - Records uses for each register spill slot.
 117     SmallVector<SmallPtrSet<MachineInstr*, 4>, 8> SpillSlotToUsesMap;
 118
 119     VirtRegMap(const VirtRegMap&);     // DO NOT IMPLEMENT
 120     void operator=(const VirtRegMap&); // DO NOT IMPLEMENT
 121
 122   public:
 123     explicit VirtRegMap(MachineFunction &mf);
 124
 125     void grow();
 126
 127     /// @brief returns true if the specified virtual register is
 128     /// mapped to a physical register
 129     bool hasPhys(unsigned virtReg) const {
 130       return getPhys(virtReg) != NO_PHYS_REG;
 131     }
 132
 133     /// @brief returns the physical register mapped to the specified
 134     /// virtual register
 135     unsigned getPhys(unsigned virtReg) const {
 136       assert(TargetRegisterInfo::isVirtualRegister(virtReg));
 137       return Virt2PhysMap[virtReg];
 138     }
 139
 140     /// @brief creates a mapping for the specified virtual register to
 141     /// the specified physical register
 142     void assignVirt2Phys(unsigned virtReg, unsigned physReg) {
 143       assert(TargetRegisterInfo::isVirtualRegister(virtReg) &&
 144              TargetRegisterInfo::isPhysicalRegister(physReg));
 145       assert(Virt2PhysMap[virtReg] == NO_PHYS_REG &&
 146              "attempt to assign physical register to already mapped "
 147              "virtual register");
 148       Virt2PhysMap[virtReg] = physReg;
 149     }
 150
 151     /// @brief clears the specified virtual register's, physical
 152     /// register mapping
 153     void clearVirt(unsigned virtReg) {
 154       assert(TargetRegisterInfo::isVirtualRegister(virtReg));
 155       assert(Virt2PhysMap[virtReg] != NO_PHYS_REG &&
 156              "attempt to clear a not assigned virtual register");
 157       Virt2PhysMap[virtReg] = NO_PHYS_REG;
 158     }
 159
 160     /// @brief clears all virtual to physical register mappings
 161     void clearAllVirt() {
 162       Virt2PhysMap.clear();
 163       grow();
 164     }
 165
 166     /// @brief records virtReg is a split live interval from SReg.
 167     void setIsSplitFromReg(unsigned virtReg, unsigned SReg) {
 168       Virt2SplitMap[virtReg] = SReg;
 169     }
 170
 171     /// @brief returns the live interval virtReg is split from.
 172     unsigned getPreSplitReg(unsigned virtReg) {
 173       return Virt2SplitMap[virtReg];
 174     }
 175
 176     /// @brief returns true is the specified virtual register is not
 177     /// mapped to a stack slot or rematerialized.
 178     bool isAssignedReg(unsigned virtReg) const {
 179       if (getStackSlot(virtReg) == NO_STACK_SLOT &&
 180           getReMatId(virtReg) == NO_STACK_SLOT)
 181         return true;
 182       // Split register can be assigned a physical register as well as a
 183       // stack slot or remat id.
 184       return (Virt2SplitMap[virtReg] && Virt2PhysMap[virtReg] != NO_PHYS_REG);
 185     }
 186
 187     /// @brief returns the stack slot mapped to the specified virtual
 188     /// register
 189     int getStackSlot(unsigned virtReg) const {
 190       assert(TargetRegisterInfo::isVirtualRegister(virtReg));
 191       return Virt2StackSlotMap[virtReg];
 192     }
 193
 194     /// @brief returns the rematerialization id mapped to the specified virtual
 195     /// register
 196     int getReMatId(unsigned virtReg) const {
 197       assert(TargetRegisterInfo::isVirtualRegister(virtReg));
 198       return Virt2ReMatIdMap[virtReg];
 199     }
 200
 201     /// @brief create a mapping for the specifed virtual register to
 202     /// the next available stack slot
 203     int assignVirt2StackSlot(unsigned virtReg);
 204     /// @brief create a mapping for the specified virtual register to
 205     /// the specified stack slot
 206     void assignVirt2StackSlot(unsigned virtReg, int frameIndex);
 207
 208     /// @brief assign an unique re-materialization id to the specified
 209     /// virtual register.
 210     int assignVirtReMatId(unsigned virtReg);
 211     /// @brief assign an unique re-materialization id to the specified
 212     /// virtual register.
 213     void assignVirtReMatId(unsigned virtReg, int id);
 214
 215     /// @brief returns true if the specified virtual register is being
 216     /// re-materialized.
 217     bool isReMaterialized(unsigned virtReg) const {
 218       return ReMatMap[virtReg] != NULL;
 219     }
 220
 221     /// @brief returns the original machine instruction being re-issued
 222     /// to re-materialize the specified virtual register.
 223     MachineInstr *getReMaterializedMI(unsigned virtReg) const {
 224       return ReMatMap[virtReg];
 225     }
 226
 227     /// @brief records the specified virtual register will be
 228     /// re-materialized and the original instruction which will be re-issed
 229     /// for this purpose.  If parameter all is true, then all uses of the
 230     /// registers are rematerialized and it's safe to delete the definition.
 231     void setVirtIsReMaterialized(unsigned virtReg, MachineInstr *def) {
 232       ReMatMap[virtReg] = def;
 233     }
 234
 235     /// @brief record the last use (kill) of a split virtual register.
 236     void addKillPoint(unsigned virtReg, unsigned index) {
 237       Virt2SplitKillMap[virtReg] = index;
 238     }
 239
 240     unsigned getKillPoint(unsigned virtReg) const {
 241       return Virt2SplitKillMap[virtReg];
 242     }
 243
 244     /// @brief remove the last use (kill) of a split virtual register.
 245     void removeKillPoint(unsigned virtReg) {
 246       Virt2SplitKillMap[virtReg] = 0;
 247     }
 248
 249     /// @brief returns true if the specified MachineInstr is a spill point.
 250     bool isSpillPt(MachineInstr *Pt) const {
 251       return SpillPt2VirtMap.find(Pt) != SpillPt2VirtMap.end();
 252     }
 253
 254     /// @brief returns the virtual registers that should be spilled due to
 255     /// splitting right after the specified MachineInstr.
 256     std::vector<std::pair<unsigned,bool> > &getSpillPtSpills(MachineInstr *Pt) {
 257       return SpillPt2VirtMap[Pt];
 258     }
 259
 260     /// @brief records the specified MachineInstr as a spill point for virtReg.
 261     void addSpillPoint(unsigned virtReg, bool isKill, MachineInstr *Pt) {
 262       if (SpillPt2VirtMap.find(Pt) != SpillPt2VirtMap.end())
 263         SpillPt2VirtMap[Pt].push_back(std::make_pair(virtReg, isKill));
 264       else {
 265         std::vector<std::pair<unsigned,bool> > Virts;
 266         Virts.push_back(std::make_pair(virtReg, isKill));
 267         SpillPt2VirtMap.insert(std::make_pair(Pt, Virts));
 268       }
 269     }
 270
 271     void transferSpillPts(MachineInstr *Old, MachineInstr *New) {
 272       std::map<MachineInstr*,std::vector<std::pair<unsigned,bool> > >::iterator
 273         I = SpillPt2VirtMap.find(Old);
 274       if (I == SpillPt2VirtMap.end())
 275         return;
 276       while (!I->second.empty()) {
 277         unsigned virtReg = I->second.back().first;
 278         bool isKill = I->second.back().second;
 279         I->second.pop_back();
 280         addSpillPoint(virtReg, isKill, New);
 281       }
 282       SpillPt2VirtMap.erase(I);
 283     }
 284
 285     /// @brief returns true if the specified MachineInstr is a restore point.
 286     bool isRestorePt(MachineInstr *Pt) const {
 287       return RestorePt2VirtMap.find(Pt) != RestorePt2VirtMap.end();
 288     }
 289
 290     /// @brief returns the virtual registers that should be restoreed due to
 291     /// splitting right after the specified MachineInstr.
 292     std::vector<unsigned> &getRestorePtRestores(MachineInstr *Pt) {
 293       return RestorePt2VirtMap[Pt];
 294     }
 295
 296     /// @brief records the specified MachineInstr as a restore point for virtReg.
 297     void addRestorePoint(unsigned virtReg, MachineInstr *Pt) {
 298       if (RestorePt2VirtMap.find(Pt) != RestorePt2VirtMap.end())
 299         RestorePt2VirtMap[Pt].push_back(virtReg);
 300       else {
 301         std::vector<unsigned> Virts;
 302         Virts.push_back(virtReg);
 303         RestorePt2VirtMap.insert(std::make_pair(Pt, Virts));
 304       }
 305     }
 306
 307     /// @brief - transfer restore point information from one instruction to
 308     /// another.
 309     void transferRestorePts(MachineInstr *Old, MachineInstr *New) {
 310       std::map<MachineInstr*,std::vector<unsigned> >::iterator I =
 311         RestorePt2VirtMap.find(Old);
 312       if (I == RestorePt2VirtMap.end())
 313         return;
 314       while (!I->second.empty()) {
 315         unsigned virtReg = I->second.back();
 316         I->second.pop_back();
 317         addRestorePoint(virtReg, New);
 318       }
 319       RestorePt2VirtMap.erase(I);
 320     }
 321
 322     /// @brief records that the specified physical register must be spilled
 323     /// around the specified machine instr.
 324     void addEmergencySpill(unsigned PhysReg, MachineInstr *MI) {
 325       if (EmergencySpillMap.find(MI) != EmergencySpillMap.end())
 326         EmergencySpillMap[MI].push_back(PhysReg);
 327       else {
 328         std::vector<unsigned> PhysRegs;
 329         PhysRegs.push_back(PhysReg);
 330         EmergencySpillMap.insert(std::make_pair(MI, PhysRegs));
 331       }
 332     }
 333
 334     /// @brief returns true if one or more physical registers must be spilled
 335     /// around the specified instruction.
 336     bool hasEmergencySpills(MachineInstr *MI) const {
 337       return EmergencySpillMap.find(MI) != EmergencySpillMap.end();
 338     }
 339
 340     /// @brief returns the physical registers to be spilled and restored around
 341     /// the instruction.
 342     std::vector<unsigned> &getEmergencySpills(MachineInstr *MI) {
 343       return EmergencySpillMap[MI];
 344     }
 345
 346     /// @brief return or get a emergency spill slot for the register class.
 347     int getEmergencySpillSlot(const TargetRegisterClass *RC);
 348
 349     /// @brief Return lowest spill slot index.
 350     int getLowSpillSlot() const {
 351       return LowSpillSlot;
 352     }
 353
 354     /// @brief Return highest spill slot index.
 355     int getHighSpillSlot() const {
 356       return HighSpillSlot;
 357     }
 358
 359     /// @brief Records a spill slot use.
 360     void addSpillSlotUse(int FrameIndex, MachineInstr *MI);
 361
 362     /// @brief Returns true if spill slot has been used.
 363     bool isSpillSlotUsed(int FrameIndex) const {
 364       assert(FrameIndex >= 0 && "Spill slot index should not be negative!");
 365       return !SpillSlotToUsesMap[FrameIndex-LowSpillSlot].empty();
 366     }
 367
 368     /// @brief Updates information about the specified virtual register's value
 369     /// folded into newMI machine instruction.
 370     void virtFolded(unsigned VirtReg, MachineInstr *OldMI, MachineInstr *NewMI,
 371                     ModRef MRInfo);
 372
 373     /// @brief Updates information about the specified virtual register's value
 374     /// folded into the specified machine instruction.
 375     void virtFolded(unsigned VirtReg, MachineInstr *MI, ModRef MRInfo);
 376
 377     /// @brief returns the virtual registers' values folded in memory
 378     /// operands of this instruction
 379     std::pair<MI2VirtMapTy::const_iterator, MI2VirtMapTy::const_iterator>
 380     getFoldedVirts(MachineInstr* MI) const {
 381       return MI2VirtMap.equal_range(MI);
 382     }
 383
 384     /// RemoveMachineInstrFromMaps - MI is being erased, remove it from the
 385     /// the folded instruction map and spill point map.
 386     void RemoveMachineInstrFromMaps(MachineInstr *MI);
 387
 388     void print(std::ostream &OS) const;
 389     void print(std::ostream *OS) const { if (OS) print(*OS); }
 390     void dump() const;
 391   };
 392
 393   inline std::ostream *operator<<(std::ostream *OS, const VirtRegMap &VRM) {
 394     VRM.print(OS);
 395     return OS;
 396   }
 397   inline std::ostream &operator<<(std::ostream &OS, const VirtRegMap &VRM) {
 398     VRM.print(OS);
 399     return OS;
 400   }
 401
 402   /// Spiller interface: Implementations of this interface assign spilled
 403   /// virtual registers to stack slots, rewriting the code.
 404   struct Spiller {
 405     virtual ~Spiller();
 406     virtual bool runOnMachineFunction(MachineFunction &MF,
 407                                       VirtRegMap &VRM) = 0;
 408   };
 409
 410   /// createSpiller - Create an return a spiller object, as specified on the
 411   /// command line.
 412   Spiller* createSpiller();
 413
 414 } // End llvm namespace
 415
 416 #endif