lib/CodeGen/LiveRangeEdit.h

   1 //===---- LiveRangeEdit.h - Basic tools for split and spill -----*- 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 // The LiveRangeEdit class represents changes done to a virtual register when it
  11 // is spilled or split.
  12 //
  13 // The parent register is never changed. Instead, a number of new virtual
  14 // registers are created and added to the newRegs vector.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_CODEGEN_LIVERANGEEDIT_H
  19 #define LLVM_CODEGEN_LIVERANGEEDIT_H
  20
  21 #include "llvm/CodeGen/LiveInterval.h"
  22 #include "llvm/ADT/SmallPtrSet.h"
  23
  24 namespace llvm {
  25
  26 class AliasAnalysis;
  27 class LiveIntervals;
  28 class MachineLoopInfo;
  29 class MachineRegisterInfo;
  30 class VirtRegMap;
  31
  32 class LiveRangeEdit {
  33 public:
  34   /// Callback methods for LiveRangeEdit owners.
  35   struct Delegate {
  36     /// Called immediately before erasing a dead machine instruction.
  37     virtual void LRE_WillEraseInstruction(MachineInstr *MI) {}
  38
  39     /// Called when a virtual register is no longer used. Return false to defer
  40     /// its deletion from LiveIntervals.
  41     virtual bool LRE_CanEraseVirtReg(unsigned) { return true; }
  42
  43     /// Called before shrinking the live range of a virtual register.
  44     virtual void LRE_WillShrinkVirtReg(unsigned) {}
  45
  46     /// Called after cloning a virtual register.
  47     /// This is used for new registers representing connected components of Old.
  48     virtual void LRE_DidCloneVirtReg(unsigned New, unsigned Old) {}
  49
  50     virtual ~Delegate() {}
  51   };
  52
  53 private:
  54   LiveInterval &parent_;
  55   SmallVectorImpl<LiveInterval*> &newRegs_;
  56   Delegate *const delegate_;
  57   const SmallVectorImpl<LiveInterval*> *uselessRegs_;
  58
  59   /// firstNew_ - Index of the first register added to newRegs_.
  60   const unsigned firstNew_;
  61
  62   /// scannedRemattable_ - true when remattable values have been identified.
  63   bool scannedRemattable_;
  64
  65   /// remattable_ - Values defined by remattable instructions as identified by
  66   /// tii.isTriviallyReMaterializable().
  67   SmallPtrSet<const VNInfo*,4> remattable_;
  68
  69   /// rematted_ - Values that were actually rematted, and so need to have their
  70   /// live range trimmed or entirely removed.
  71   SmallPtrSet<const VNInfo*,4> rematted_;
  72
  73   /// scanRemattable - Identify the parent_ values that may rematerialize.
  74   void scanRemattable(LiveIntervals &lis,
  75                       const TargetInstrInfo &tii,
  76                       AliasAnalysis *aa);
  77
  78   /// allUsesAvailableAt - Return true if all registers used by OrigMI at
  79   /// OrigIdx are also available with the same value at UseIdx.
  80   bool allUsesAvailableAt(const MachineInstr *OrigMI, SlotIndex OrigIdx,
  81                           SlotIndex UseIdx, LiveIntervals &lis);
  82
  83 public:
  84   /// Create a LiveRangeEdit for breaking down parent into smaller pieces.
  85   /// @param parent The register being spilled or split.
  86   /// @param newRegs List to receive any new registers created. This needn't be
  87   ///                empty initially, any existing registers are ignored.
  88   /// @param uselessRegs List of registers that can't be used when
  89   ///        rematerializing values because they are about to be removed.
  90   LiveRangeEdit(LiveInterval &parent,
  91                 SmallVectorImpl<LiveInterval*> &newRegs,
  92                 Delegate *delegate = 0,
  93                 const SmallVectorImpl<LiveInterval*> *uselessRegs = 0)
  94     : parent_(parent), newRegs_(newRegs),
  95       delegate_(delegate),
  96       uselessRegs_(uselessRegs),
  97       firstNew_(newRegs.size()),
  98       scannedRemattable_(false) {}
  99
 100   LiveInterval &getParent() const { return parent_; }
 101   unsigned getReg() const { return parent_.reg; }
 102
 103   /// Iterator for accessing the new registers added by this edit.
 104   typedef SmallVectorImpl<LiveInterval*>::const_iterator iterator;
 105   iterator begin() const { return newRegs_.begin()+firstNew_; }
 106   iterator end() const { return newRegs_.end(); }
 107   unsigned size() const { return newRegs_.size()-firstNew_; }
 108   bool empty() const { return size() == 0; }
 109   LiveInterval *get(unsigned idx) const { return newRegs_[idx+firstNew_]; }
 110
 111   /// FIXME: Temporary accessors until we can get rid of
 112   /// LiveIntervals::AddIntervalsForSpills
 113   SmallVectorImpl<LiveInterval*> *getNewVRegs() { return &newRegs_; }
 114   const SmallVectorImpl<LiveInterval*> *getUselessVRegs() {
 115     return uselessRegs_;
 116   }
 117
 118   /// createFrom - Create a new virtual register based on OldReg.
 119   LiveInterval &createFrom(unsigned OldReg, LiveIntervals&, VirtRegMap&);
 120
 121   /// create - Create a new register with the same class and original slot as
 122   /// parent.
 123   LiveInterval &create(LiveIntervals &LIS, VirtRegMap &VRM) {
 124     return createFrom(getReg(), LIS, VRM);
 125   }
 126
 127   /// anyRematerializable - Return true if any parent values may be
 128   /// rematerializable.
 129   /// This function must be called before any rematerialization is attempted.
 130   bool anyRematerializable(LiveIntervals&, const TargetInstrInfo&,
 131                            AliasAnalysis*);
 132
 133   /// checkRematerializable - Manually add VNI to the list of rematerializable
 134   /// values if DefMI may be rematerializable.
 135   void checkRematerializable(VNInfo *VNI, const MachineInstr *DefMI,
 136                              const TargetInstrInfo&, AliasAnalysis*);
 137
 138   /// Remat - Information needed to rematerialize at a specific location.
 139   struct Remat {
 140     VNInfo *ParentVNI;      // parent_'s value at the remat location.
 141     MachineInstr *OrigMI;   // Instruction defining ParentVNI.
 142     explicit Remat(VNInfo *ParentVNI) : ParentVNI(ParentVNI), OrigMI(0) {}
 143   };
 144
 145   /// canRematerializeAt - Determine if ParentVNI can be rematerialized at
 146   /// UseIdx. It is assumed that parent_.getVNINfoAt(UseIdx) == ParentVNI.
 147   /// When cheapAsAMove is set, only cheap remats are allowed.
 148   bool canRematerializeAt(Remat &RM,
 149                           SlotIndex UseIdx,
 150                           bool cheapAsAMove,
 151                           LiveIntervals &lis);
 152
 153   /// rematerializeAt - Rematerialize RM.ParentVNI into DestReg by inserting an
 154   /// instruction into MBB before MI. The new instruction is mapped, but
 155   /// liveness is not updated.
 156   /// Return the SlotIndex of the new instruction.
 157   SlotIndex rematerializeAt(MachineBasicBlock &MBB,
 158                             MachineBasicBlock::iterator MI,
 159                             unsigned DestReg,
 160                             const Remat &RM,
 161                             LiveIntervals&,
 162                             const TargetInstrInfo&,
 163                             const TargetRegisterInfo&);
 164
 165   /// markRematerialized - explicitly mark a value as rematerialized after doing
 166   /// it manually.
 167   void markRematerialized(const VNInfo *ParentVNI) {
 168     rematted_.insert(ParentVNI);
 169   }
 170
 171   /// didRematerialize - Return true if ParentVNI was rematerialized anywhere.
 172   bool didRematerialize(const VNInfo *ParentVNI) const {
 173     return rematted_.count(ParentVNI);
 174   }
 175
 176   /// eraseVirtReg - Notify the delegate that Reg is no longer in use, and try
 177   /// to erase it from LIS.
 178   void eraseVirtReg(unsigned Reg, LiveIntervals &LIS);
 179
 180   /// eliminateDeadDefs - Try to delete machine instructions that are now dead
 181   /// (allDefsAreDead returns true). This may cause live intervals to be trimmed
 182   /// and further dead efs to be eliminated.
 183   void eliminateDeadDefs(SmallVectorImpl<MachineInstr*> &Dead,
 184                          LiveIntervals&, VirtRegMap&,
 185                          const TargetInstrInfo&);
 186
 187   /// calculateRegClassAndHint - Recompute register class and hint for each new
 188   /// register.
 189   void calculateRegClassAndHint(MachineFunction&, LiveIntervals&,
 190                                 const MachineLoopInfo&);
 191 };
 192
 193 }
 194
 195 #endif