lib/CodeGen/SelectionDAG/ScheduleDAGList.cpp

   1 //===---- ScheduleDAGList.cpp - Implement a list scheduler for isel DAG ---===//
   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 implements a top-down list scheduler, using standard algorithms.
  11 // The basic approach uses a priority queue of available nodes to schedule.
  12 // One at a time, nodes are taken from the priority queue (thus in priority
  13 // order), checked for legality to schedule, and emitted if legal.
  14 //
  15 // Nodes may not be legal to schedule either due to structural hazards (e.g.
  16 // pipeline or resource constraints) or because an input to the instruction has
  17 // not completed execution.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #define DEBUG_TYPE "pre-RA-sched"
  22 #include "llvm/CodeGen/ScheduleDAG.h"
  23 #include "llvm/CodeGen/SchedulerRegistry.h"
  24 #include "llvm/CodeGen/SelectionDAGISel.h"
  25 #include "llvm/Target/TargetRegisterInfo.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/Target/TargetInstrInfo.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/Support/Compiler.h"
  31 #include "llvm/ADT/PriorityQueue.h"
  32 #include "llvm/ADT/Statistic.h"
  33 #include "LatencyPriorityQueue.h"
  34 #include <climits>
  35 using namespace llvm;
  36
  37 STATISTIC(NumNoops , "Number of noops inserted");
  38 STATISTIC(NumStalls, "Number of pipeline stalls");
  39
  40 static RegisterScheduler
  41   tdListDAGScheduler("list-td", "Top-down list scheduler",
  42                      createTDListDAGScheduler);
  43
  44 namespace {
  45 //===----------------------------------------------------------------------===//
  46 /// ScheduleDAGList - The actual list scheduler implementation.  This supports
  47 /// top-down scheduling.
  48 ///
  49 class VISIBILITY_HIDDEN ScheduleDAGList : public ScheduleDAG {
  50 private:
  51   /// AvailableQueue - The priority queue to use for the available SUnits.
  52   ///
  53   SchedulingPriorityQueue *AvailableQueue;
  54
  55   /// PendingQueue - This contains all of the instructions whose operands have
  56   /// been issued, but their results are not ready yet (due to the latency of
  57   /// the operation).  Once the operands becomes available, the instruction is
  58   /// added to the AvailableQueue.
  59   std::vector<SUnit*> PendingQueue;
  60
  61   /// HazardRec - The hazard recognizer to use.
  62   HazardRecognizer *HazardRec;
  63
  64 public:
  65   ScheduleDAGList(SelectionDAG *dag, MachineBasicBlock *bb,
  66                   const TargetMachine &tm,
  67                   SchedulingPriorityQueue *availqueue,
  68                   HazardRecognizer *HR)
  69     : ScheduleDAG(dag, bb, tm),
  70       AvailableQueue(availqueue), HazardRec(HR) {
  71     }
  72
  73   ~ScheduleDAGList() {
  74     delete HazardRec;
  75     delete AvailableQueue;
  76   }
  77
  78   void Schedule();
  79
  80 private:
  81   void ReleaseSucc(SUnit *SuccSU, bool isChain);
  82   void ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle);
  83   void ListScheduleTopDown();
  84 };
  85 }  // end anonymous namespace
  86
  87 HazardRecognizer::~HazardRecognizer() {}
  88
  89
  90 /// Schedule - Schedule the DAG using list scheduling.
  91 void ScheduleDAGList::Schedule() {
  92   DOUT << "********** List Scheduling **********\n";
  93
  94   // Build scheduling units.
  95   BuildSchedUnits();
  96
  97   AvailableQueue->initNodes(SUnits);
  98
  99   ListScheduleTopDown();
 100
 101   AvailableQueue->releaseState();
 102 }
 103
 104 //===----------------------------------------------------------------------===//
 105 //  Top-Down Scheduling
 106 //===----------------------------------------------------------------------===//
 107
 108 /// ReleaseSucc - Decrement the NumPredsLeft count of a successor. Add it to
 109 /// the PendingQueue if the count reaches zero.
 110 void ScheduleDAGList::ReleaseSucc(SUnit *SuccSU, bool isChain) {
 111   SuccSU->NumPredsLeft--;
 112
 113   assert(SuccSU->NumPredsLeft >= 0 &&
 114          "List scheduling internal error");
 115
 116   if (SuccSU->NumPredsLeft == 0) {
 117     // Compute how many cycles it will be before this actually becomes
 118     // available.  This is the max of the start time of all predecessors plus
 119     // their latencies.
 120     unsigned AvailableCycle = 0;
 121     for (SUnit::pred_iterator I = SuccSU->Preds.begin(),
 122          E = SuccSU->Preds.end(); I != E; ++I) {
 123       // If this is a token edge, we don't need to wait for the latency of the
 124       // preceeding instruction (e.g. a long-latency load) unless there is also
 125       // some other data dependence.
 126       SUnit &Pred = *I->Dep;
 127       unsigned PredDoneCycle = Pred.Cycle;
 128       if (!I->isCtrl)
 129         PredDoneCycle += Pred.Latency;
 130       else if (Pred.Latency)
 131         PredDoneCycle += 1;
 132
 133       AvailableCycle = std::max(AvailableCycle, PredDoneCycle);
 134     }
 135
 136     assert(SuccSU->CycleBound == 0 && "CycleBound already assigned!");
 137     SuccSU->CycleBound = AvailableCycle;
 138     PendingQueue.push_back(SuccSU);
 139   }
 140 }
 141
 142 /// ScheduleNodeTopDown - Add the node to the schedule. Decrement the pending
 143 /// count of its successors. If a successor pending count is zero, add it to
 144 /// the Available queue.
 145 void ScheduleDAGList::ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle) {
 146   DOUT << "*** Scheduling [" << CurCycle << "]: ";
 147   DEBUG(SU->dump(DAG));
 148
 149   Sequence.push_back(SU);
 150   SU->Cycle = CurCycle;
 151
 152   // Top down: release successors.
 153   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
 154        I != E; ++I)
 155     ReleaseSucc(I->Dep, I->isCtrl);
 156 }
 157
 158 /// ListScheduleTopDown - The main loop of list scheduling for top-down
 159 /// schedulers.
 160 void ScheduleDAGList::ListScheduleTopDown() {
 161   unsigned CurCycle = 0;
 162
 163   // All leaves to Available queue.
 164   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 165     // It is available if it has no predecessors.
 166     if (SUnits[i].Preds.empty()) {
 167       AvailableQueue->push(&SUnits[i]);
 168       SUnits[i].isAvailable = true;
 169     }
 170   }
 171
 172   // While Available queue is not empty, grab the node with the highest
 173   // priority. If it is not ready put it back.  Schedule the node.
 174   std::vector<SUnit*> NotReady;
 175   Sequence.reserve(SUnits.size());
 176   while (!AvailableQueue->empty() || !PendingQueue.empty()) {
 177     // Check to see if any of the pending instructions are ready to issue.  If
 178     // so, add them to the available queue.
 179     for (unsigned i = 0, e = PendingQueue.size(); i != e; ++i) {
 180       if (PendingQueue[i]->CycleBound == CurCycle) {
 181         AvailableQueue->push(PendingQueue[i]);
 182         PendingQueue[i]->isAvailable = true;
 183         PendingQueue[i] = PendingQueue.back();
 184         PendingQueue.pop_back();
 185         --i; --e;
 186       } else {
 187         assert(PendingQueue[i]->CycleBound > CurCycle && "Negative latency?");
 188       }
 189     }
 190
 191     // If there are no instructions available, don't try to issue anything, and
 192     // don't advance the hazard recognizer.
 193     if (AvailableQueue->empty()) {
 194       ++CurCycle;
 195       continue;
 196     }
 197
 198     SUnit *FoundSUnit = 0;
 199     SDNode *FoundNode = 0;
 200
 201     bool HasNoopHazards = false;
 202     while (!AvailableQueue->empty()) {
 203       SUnit *CurSUnit = AvailableQueue->pop();
 204
 205       // Get the node represented by this SUnit.
 206       FoundNode = CurSUnit->getNode();
 207
 208       // If this is a pseudo op, like copyfromreg, look to see if there is a
 209       // real target node flagged to it.  If so, use the target node.
 210       while (!FoundNode->isMachineOpcode()) {
 211         SDNode *N = FoundNode->getFlaggedNode();
 212         if (!N) break;
 213         FoundNode = N;
 214       }
 215
 216       HazardRecognizer::HazardType HT = HazardRec->getHazardType(FoundNode);
 217       if (HT == HazardRecognizer::NoHazard) {
 218         FoundSUnit = CurSUnit;
 219         break;
 220       }
 221
 222       // Remember if this is a noop hazard.
 223       HasNoopHazards |= HT == HazardRecognizer::NoopHazard;
 224
 225       NotReady.push_back(CurSUnit);
 226     }
 227
 228     // Add the nodes that aren't ready back onto the available list.
 229     if (!NotReady.empty()) {
 230       AvailableQueue->push_all(NotReady);
 231       NotReady.clear();
 232     }
 233
 234     // If we found a node to schedule, do it now.
 235     if (FoundSUnit) {
 236       ScheduleNodeTopDown(FoundSUnit, CurCycle);
 237       HazardRec->EmitInstruction(FoundNode);
 238       FoundSUnit->isScheduled = true;
 239       AvailableQueue->ScheduledNode(FoundSUnit);
 240
 241       // If this is a pseudo-op node, we don't want to increment the current
 242       // cycle.
 243       if (FoundSUnit->Latency)  // Don't increment CurCycle for pseudo-ops!
 244         ++CurCycle;
 245     } else if (!HasNoopHazards) {
 246       // Otherwise, we have a pipeline stall, but no other problem, just advance
 247       // the current cycle and try again.
 248       DOUT << "*** Advancing cycle, no work to do\n";
 249       HazardRec->AdvanceCycle();
 250       ++NumStalls;
 251       ++CurCycle;
 252     } else {
 253       // Otherwise, we have no instructions to issue and we have instructions
 254       // that will fault if we don't do this right.  This is the case for
 255       // processors without pipeline interlocks and other cases.
 256       DOUT << "*** Emitting noop\n";
 257       HazardRec->EmitNoop();
 258       Sequence.push_back(0);   // NULL SUnit* -> noop
 259       ++NumNoops;
 260       ++CurCycle;
 261     }
 262   }
 263
 264 #ifndef NDEBUG
 265   // Verify that all SUnits were scheduled.
 266   bool AnyNotSched = false;
 267   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 268     if (SUnits[i].NumPredsLeft != 0) {
 269       if (!AnyNotSched)
 270         cerr << "*** List scheduling failed! ***\n";
 271       SUnits[i].dump(DAG);
 272       cerr << "has not been scheduled!\n";
 273       AnyNotSched = true;
 274     }
 275   }
 276   assert(!AnyNotSched);
 277 #endif
 278 }
 279
 280 //===----------------------------------------------------------------------===//
 281 //                         Public Constructor Functions
 282 //===----------------------------------------------------------------------===//
 283
 284 /// createTDListDAGScheduler - This creates a top-down list scheduler with a
 285 /// new hazard recognizer. This scheduler takes ownership of the hazard
 286 /// recognizer and deletes it when done.
 287 ScheduleDAG* llvm::createTDListDAGScheduler(SelectionDAGISel *IS,
 288                                             SelectionDAG *DAG,
 289                                             const TargetMachine *TM,
 290                                             MachineBasicBlock *BB, bool Fast) {
 291   return new ScheduleDAGList(DAG, BB, *TM,
 292                              new LatencyPriorityQueue(),
 293                              IS->CreateTargetHazardRecognizer());
 294 }