lib/CodeGen/ScheduleDAGInstrs.h

   1 //==- ScheduleDAGInstrs.h - MachineInstr Scheduling --------------*- 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 ScheduleDAGInstrs class, which implements
  11 // scheduling for a MachineInstr-based dependency graph.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef SCHEDULEDAGINSTRS_H
  16 #define SCHEDULEDAGINSTRS_H
  17
  18 #include "llvm/ADT/SmallSet.h"
  19 #include "llvm/CodeGen/MachineDominators.h"
  20 #include "llvm/CodeGen/MachineLoopInfo.h"
  21 #include "llvm/CodeGen/ScheduleDAG.h"
  22 #include "llvm/Support/Compiler.h"
  23 #include "llvm/Target/TargetRegisterInfo.h"
  24 #include <map>
  25
  26 namespace llvm {
  27   class MachineLoopInfo;
  28   class MachineDominatorTree;
  29
  30   /// LoopDependencies - This class analyzes loop-oriented register
  31   /// dependencies, which are used to guide scheduling decisions.
  32   /// For example, loop induction variable increments should be
  33   /// scheduled as soon as possible after the variable's last use.
  34   ///
  35   class VISIBILITY_HIDDEN LoopDependencies {
  36     const MachineLoopInfo &MLI;
  37     const MachineDominatorTree &MDT;
  38
  39   public:
  40     typedef std::map<unsigned, std::pair<const MachineOperand *, unsigned> >
  41       LoopDeps;
  42     LoopDeps Deps;
  43
  44     LoopDependencies(const MachineLoopInfo &mli,
  45                      const MachineDominatorTree &mdt) :
  46       MLI(mli), MDT(mdt) {}
  47
  48     /// VisitLoop - Clear out any previous state and analyze the given loop.
  49     ///
  50     void VisitLoop(const MachineLoop *Loop) {
  51       Deps.clear();
  52       MachineBasicBlock *Header = Loop->getHeader();
  53       SmallSet<unsigned, 8> LoopLiveIns;
  54       for (MachineBasicBlock::livein_iterator LI = Header->livein_begin(),
  55            LE = Header->livein_end(); LI != LE; ++LI)
  56         LoopLiveIns.insert(*LI);
  57
  58       const MachineDomTreeNode *Node = MDT.getNode(Header);
  59       const MachineBasicBlock *MBB = Node->getBlock();
  60       assert(Loop->contains(MBB) &&
  61              "Loop does not contain header!");
  62       VisitRegion(Node, MBB, Loop, LoopLiveIns);
  63     }
  64
  65   private:
  66     void VisitRegion(const MachineDomTreeNode *Node,
  67                      const MachineBasicBlock *MBB,
  68                      const MachineLoop *Loop,
  69                      const SmallSet<unsigned, 8> &LoopLiveIns) {
  70       unsigned Count = 0;
  71       for (MachineBasicBlock::const_iterator I = MBB->begin(), E = MBB->end();
  72            I != E; ++I, ++Count) {
  73         const MachineInstr *MI = I;
  74         for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
  75           const MachineOperand &MO = MI->getOperand(i);
  76           if (!MO.isReg() || !MO.isUse())
  77             continue;
  78           unsigned MOReg = MO.getReg();
  79           if (LoopLiveIns.count(MOReg))
  80             Deps.insert(std::make_pair(MOReg, std::make_pair(&MO, Count)));
  81         }
  82       }
  83
  84       const std::vector<MachineDomTreeNode*> &Children = Node->getChildren();
  85       for (std::vector<MachineDomTreeNode*>::const_iterator I =
  86            Children.begin(), E = Children.end(); I != E; ++I) {
  87         const MachineDomTreeNode *ChildNode = *I;
  88         MachineBasicBlock *ChildBlock = ChildNode->getBlock();
  89         if (Loop->contains(ChildBlock))
  90           VisitRegion(ChildNode, ChildBlock, Loop, LoopLiveIns);
  91       }
  92     }
  93   };
  94
  95   /// ScheduleDAGInstrs - A ScheduleDAG subclass for scheduling lists of
  96   /// MachineInstrs.
  97   class VISIBILITY_HIDDEN ScheduleDAGInstrs : public ScheduleDAG {
  98     const MachineLoopInfo &MLI;
  99     const MachineDominatorTree &MDT;
 100
 101     /// Defs, Uses - Remember where defs and uses of each physical register
 102     /// are as we iterate upward through the instructions. This is allocated
 103     /// here instead of inside BuildSchedGraph to avoid the need for it to be
 104     /// initialized and destructed for each block.
 105     std::vector<SUnit *> Defs[TargetRegisterInfo::FirstVirtualRegister];
 106     std::vector<SUnit *> Uses[TargetRegisterInfo::FirstVirtualRegister];
 107
 108     /// PendingLoads - Remember where unknown loads are after the most recent
 109     /// unknown store, as we iterate. As with Defs and Uses, this is here
 110     /// to minimize construction/destruction.
 111     std::vector<SUnit *> PendingLoads;
 112
 113     /// LoopRegs - Track which registers are used for loop-carried dependencies.
 114     ///
 115     LoopDependencies LoopRegs;
 116
 117     /// LoopLiveInRegs - Track which regs are live into a loop, to help guide
 118     /// back-edge-aware scheduling.
 119     ///
 120     SmallSet<unsigned, 8> LoopLiveInRegs;
 121
 122   public:
 123     MachineBasicBlock *BB;                // Current basic block
 124     MachineBasicBlock::iterator Begin;    // The beginning of the range to
 125                                           // be scheduled. The range extends
 126                                           // to InsertPos.
 127     unsigned InsertPosIndex;              // The index in BB of InsertPos.
 128
 129     explicit ScheduleDAGInstrs(MachineFunction &mf,
 130                                const MachineLoopInfo &mli,
 131                                const MachineDominatorTree &mdt);
 132
 133     virtual ~ScheduleDAGInstrs() {}
 134
 135     /// NewSUnit - Creates a new SUnit and return a ptr to it.
 136     ///
 137     SUnit *NewSUnit(MachineInstr *MI) {
 138 #ifndef NDEBUG
 139       const SUnit *Addr = SUnits.empty() ? 0 : &SUnits[0];
 140 #endif
 141       SUnits.push_back(SUnit(MI, (unsigned)SUnits.size()));
 142       assert((Addr == 0 || Addr == &SUnits[0]) &&
 143              "SUnits std::vector reallocated on the fly!");
 144       SUnits.back().OrigNode = &SUnits.back();
 145       return &SUnits.back();
 146     }
 147
 148     /// Run - perform scheduling.
 149     ///
 150     void Run(MachineBasicBlock *bb,
 151              MachineBasicBlock::iterator begin,
 152              MachineBasicBlock::iterator end,
 153              unsigned endindex);
 154
 155     /// BuildSchedGraph - Build SUnits from the MachineBasicBlock that we are
 156     /// input.
 157     virtual void BuildSchedGraph();
 158
 159     /// ComputeLatency - Compute node latency.
 160     ///
 161     virtual void ComputeLatency(SUnit *SU);
 162
 163     virtual MachineBasicBlock *EmitSchedule();
 164
 165     /// StartBlock - Prepare to perform scheduling in the given block.
 166     ///
 167     virtual void StartBlock(MachineBasicBlock *BB);
 168
 169     /// Schedule - Order nodes according to selected style, filling
 170     /// in the Sequence member.
 171     ///
 172     virtual void Schedule() = 0;
 173
 174     /// FinishBlock - Clean up after scheduling in the given block.
 175     ///
 176     virtual void FinishBlock();
 177
 178     virtual void dumpNode(const SUnit *SU) const;
 179
 180     virtual std::string getGraphNodeLabel(const SUnit *SU) const;
 181   };
 182 }
 183
 184 #endif