lib/CodeGen/AggressiveAntiDepBreaker.h

   1 //=- llvm/CodeGen/AggressiveAntiDepBreaker.h - Anti-Dep Support -*- 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 the AggressiveAntiDepBreaker class, which
  11 // implements register anti-dependence breaking during post-RA
  12 // scheduling. It attempts to break all anti-dependencies within a
  13 // block.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_CODEGEN_AGGRESSIVEANTIDEPBREAKER_H
  18 #define LLVM_CODEGEN_AGGRESSIVEANTIDEPBREAKER_H
  19
  20 #include "AntiDepBreaker.h"
  21 #include "llvm/CodeGen/MachineBasicBlock.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/CodeGen/MachineFunction.h"
  24 #include "llvm/CodeGen/MachineRegisterInfo.h"
  25 #include "llvm/CodeGen/ScheduleDAG.h"
  26 #include "llvm/Target/TargetSubtarget.h"
  27 #include "llvm/ADT/BitVector.h"
  28 #include "llvm/ADT/SmallSet.h"
  29 #include <map>
  30 #include <vector>
  31
  32 namespace llvm {
  33   class TargetRegisterInfo;
  34
  35   /// Class AggressiveAntiDepState
  36   /// Contains all the state necessary for anti-dep breaking.
  37   class AggressiveAntiDepState {
  38   public:
  39     /// RegisterReference - Information about a register reference
  40     /// within a liverange
  41     typedef struct {
  42       /// Operand - The registers operand
  43       MachineOperand *Operand;
  44       /// RC - The register class
  45       const TargetRegisterClass *RC;
  46     } RegisterReference;
  47
  48   private:
  49     /// NumTargetRegs - Number of non-virtual target registers
  50     /// (i.e. TRI->getNumRegs()).
  51     const unsigned NumTargetRegs;
  52
  53     /// GroupNodes - Implements a disjoint-union data structure to
  54     /// form register groups. A node is represented by an index into
  55     /// the vector. A node can "point to" itself to indicate that it
  56     /// is the parent of a group, or point to another node to indicate
  57     /// that it is a member of the same group as that node.
  58     std::vector<unsigned> GroupNodes;
  59
  60     /// GroupNodeIndices - For each register, the index of the GroupNode
  61     /// currently representing the group that the register belongs to.
  62     /// Register 0 is always represented by the 0 group, a group
  63     /// composed of registers that are not eligible for anti-aliasing.
  64     std::vector<unsigned> GroupNodeIndices;
  65
  66     /// RegRefs - Map registers to all their references within a live range.
  67     std::multimap<unsigned, RegisterReference> RegRefs;
  68
  69     /// KillIndices - The index of the most recent kill (proceding bottom-up),
  70     /// or ~0u if the register is not live.
  71     std::vector<unsigned> KillIndices;
  72
  73     /// DefIndices - The index of the most recent complete def (proceding bottom
  74     /// up), or ~0u if the register is live.
  75     std::vector<unsigned> DefIndices;
  76
  77   public:
  78     AggressiveAntiDepState(const unsigned TargetRegs, MachineBasicBlock *BB);
  79
  80     /// GetKillIndices - Return the kill indices.
  81     std::vector<unsigned> &GetKillIndices() { return KillIndices; }
  82
  83     /// GetDefIndices - Return the define indices.
  84     std::vector<unsigned> &GetDefIndices() { return DefIndices; }
  85
  86     /// GetRegRefs - Return the RegRefs map.
  87     std::multimap<unsigned, RegisterReference>& GetRegRefs() { return RegRefs; }
  88
  89     // GetGroup - Get the group for a register. The returned value is
  90     // the index of the GroupNode representing the group.
  91     unsigned GetGroup(unsigned Reg);
  92
  93     // GetGroupRegs - Return a vector of the registers belonging to a
  94     // group. If RegRefs is non-NULL then only included referenced registers.
  95     void GetGroupRegs(
  96        unsigned Group,
  97        std::vector<unsigned> &Regs,
  98        std::multimap<unsigned,
  99          AggressiveAntiDepState::RegisterReference> *RegRefs);
 100
 101     // UnionGroups - Union Reg1's and Reg2's groups to form a new
 102     // group. Return the index of the GroupNode representing the
 103     // group.
 104     unsigned UnionGroups(unsigned Reg1, unsigned Reg2);
 105
 106     // LeaveGroup - Remove a register from its current group and place
 107     // it alone in its own group. Return the index of the GroupNode
 108     // representing the registers new group.
 109     unsigned LeaveGroup(unsigned Reg);
 110
 111     /// IsLive - Return true if Reg is live
 112     bool IsLive(unsigned Reg);
 113   };
 114
 115
 116   /// Class AggressiveAntiDepBreaker
 117   class AggressiveAntiDepBreaker : public AntiDepBreaker {
 118     MachineFunction& MF;
 119     MachineRegisterInfo &MRI;
 120     const TargetInstrInfo *TII;
 121     const TargetRegisterInfo *TRI;
 122
 123     /// AllocatableSet - The set of allocatable registers.
 124     /// We'll be ignoring anti-dependencies on non-allocatable registers,
 125     /// because they may not be safe to break.
 126     const BitVector AllocatableSet;
 127
 128     /// CriticalPathSet - The set of registers that should only be
 129     /// renamed if they are on the critical path.
 130     BitVector CriticalPathSet;
 131
 132     /// State - The state used to identify and rename anti-dependence
 133     /// registers.
 134     AggressiveAntiDepState *State;
 135
 136   public:
 137     AggressiveAntiDepBreaker(MachineFunction& MFi,
 138                              TargetSubtarget::RegClassVector& CriticalPathRCs);
 139     ~AggressiveAntiDepBreaker();
 140
 141     /// Start - Initialize anti-dep breaking for a new basic block.
 142     void StartBlock(MachineBasicBlock *BB);
 143
 144     /// BreakAntiDependencies - Identifiy anti-dependencies along the critical
 145     /// path
 146     /// of the ScheduleDAG and break them by renaming registers.
 147     ///
 148     unsigned BreakAntiDependencies(const std::vector<SUnit>& SUnits,
 149                                    MachineBasicBlock::iterator Begin,
 150                                    MachineBasicBlock::iterator End,
 151                                    unsigned InsertPosIndex);
 152
 153     /// Observe - Update liveness information to account for the current
 154     /// instruction, which will not be scheduled.
 155     ///
 156     void Observe(MachineInstr *MI, unsigned Count, unsigned InsertPosIndex);
 157
 158     /// Finish - Finish anti-dep breaking for a basic block.
 159     void FinishBlock();
 160
 161   private:
 162     typedef std::map<const TargetRegisterClass *,
 163                      TargetRegisterClass::const_iterator> RenameOrderType;
 164
 165     /// IsImplicitDefUse - Return true if MO represents a register
 166     /// that is both implicitly used and defined in MI
 167     bool IsImplicitDefUse(MachineInstr *MI, MachineOperand& MO);
 168
 169     /// GetPassthruRegs - If MI implicitly def/uses a register, then
 170     /// return that register and all subregisters.
 171     void GetPassthruRegs(MachineInstr *MI, std::set<unsigned>& PassthruRegs);
 172
 173     void HandleLastUse(unsigned Reg, unsigned KillIdx, const char *tag,
 174                        const char *header =NULL, const char *footer =NULL);
 175
 176     void PrescanInstruction(MachineInstr *MI, unsigned Count,
 177                             std::set<unsigned>& PassthruRegs);
 178     void ScanInstruction(MachineInstr *MI, unsigned Count);
 179     BitVector GetRenameRegisters(unsigned Reg);
 180     bool FindSuitableFreeRegisters(unsigned AntiDepGroupIndex,
 181                                    RenameOrderType& RenameOrder,
 182                                    std::map<unsigned, unsigned> &RenameMap);
 183   };
 184 }
 185
 186 #endif