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 was developed by Evan Cheng and is distributed under the
   6 // University of Illinois Open Source 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 "sched"
  22 #include "llvm/CodeGen/MachinePassRegistry.h"
  23 #include "llvm/CodeGen/ScheduleDAG.h"
  24 #include "llvm/CodeGen/SelectionDAGISel.h"
  25 #include "llvm/CodeGen/SSARegMap.h"
  26 #include "llvm/Target/MRegisterInfo.h"
  27 #include "llvm/Target/TargetData.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Target/TargetInstrInfo.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/Visibility.h"
  32 #include "llvm/ADT/Statistic.h"
  33 #include <climits>
  34 #include <iostream>
  35 #include <queue>
  36 using namespace llvm;
  37
  38 namespace {
  39   static Statistic<> NumNoops ("scheduler", "Number of noops inserted");
  40   static Statistic<> NumStalls("scheduler", "Number of pipeline stalls");
  41 }
  42
  43 static RegisterScheduler
  44   tdListDAGScheduler("list-td", "  Top-down list scheduler",
  45                      createTDListDAGScheduler);
  46
  47 namespace {
  48 //===----------------------------------------------------------------------===//
  49 /// ScheduleDAGList - The actual list scheduler implementation.  This supports
  50 /// top-down scheduling.
  51 ///
  52 class VISIBILITY_HIDDEN ScheduleDAGList : public ScheduleDAG {
  53 private:
  54   /// AvailableQueue - The priority queue to use for the available SUnits.
  55   ///
  56   SchedulingPriorityQueue *AvailableQueue;
  57
  58   /// PendingQueue - This contains all of the instructions whose operands have
  59   /// been issued, but their results are not ready yet (due to the latency of
  60   /// the operation).  Once the operands becomes available, the instruction is
  61   /// added to the AvailableQueue.  This keeps track of each SUnit and the
  62   /// number of cycles left to execute before the operation is available.
  63   std::vector<std::pair<unsigned, SUnit*> > PendingQueue;
  64
  65   /// HazardRec - The hazard recognizer to use.
  66   HazardRecognizer *HazardRec;
  67
  68 public:
  69   ScheduleDAGList(SelectionDAG &dag, MachineBasicBlock *bb,
  70                   const TargetMachine &tm,
  71                   SchedulingPriorityQueue *availqueue,
  72                   HazardRecognizer *HR)
  73     : ScheduleDAG(dag, bb, tm),
  74       AvailableQueue(availqueue), HazardRec(HR) {
  75     }
  76
  77   ~ScheduleDAGList() {
  78     delete HazardRec;
  79     delete AvailableQueue;
  80   }
  81
  82   void Schedule();
  83
  84 private:
  85   void ReleaseSucc(SUnit *SuccSU, bool isChain);
  86   void ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle);
  87   void ListScheduleTopDown();
  88 };
  89 }  // end anonymous namespace
  90
  91 HazardRecognizer::~HazardRecognizer() {}
  92
  93
  94 /// Schedule - Schedule the DAG using list scheduling.
  95 void ScheduleDAGList::Schedule() {
  96   DEBUG(std::cerr << "********** List Scheduling **********\n");
  97
  98   // Build scheduling units.
  99   BuildSchedUnits();
 100
 101   AvailableQueue->initNodes(SUnits);
 102
 103   ListScheduleTopDown();
 104
 105   AvailableQueue->releaseState();
 106
 107   DEBUG(std::cerr << "*** Final schedule ***\n");
 108   DEBUG(dumpSchedule());
 109   DEBUG(std::cerr << "\n");
 110
 111   // Emit in scheduled order
 112   EmitSchedule();
 113 }
 114
 115 //===----------------------------------------------------------------------===//
 116 //  Top-Down Scheduling
 117 //===----------------------------------------------------------------------===//
 118
 119 /// ReleaseSucc - Decrement the NumPredsLeft count of a successor. Add it to
 120 /// the PendingQueue if the count reaches zero.
 121 void ScheduleDAGList::ReleaseSucc(SUnit *SuccSU, bool isChain) {
 122   if (!isChain)
 123     SuccSU->NumPredsLeft--;
 124   else
 125     SuccSU->NumChainPredsLeft--;
 126
 127   assert(SuccSU->NumPredsLeft >= 0 && SuccSU->NumChainPredsLeft >= 0 &&
 128          "List scheduling internal error");
 129
 130   if ((SuccSU->NumPredsLeft + SuccSU->NumChainPredsLeft) == 0) {
 131     // Compute how many cycles it will be before this actually becomes
 132     // available.  This is the max of the start time of all predecessors plus
 133     // their latencies.
 134     unsigned AvailableCycle = 0;
 135     for (std::set<std::pair<SUnit*, bool> >::iterator I = SuccSU->Preds.begin(),
 136          E = SuccSU->Preds.end(); I != E; ++I) {
 137       // If this is a token edge, we don't need to wait for the latency of the
 138       // preceeding instruction (e.g. a long-latency load) unless there is also
 139       // some other data dependence.
 140       unsigned PredDoneCycle = I->first->Cycle;
 141       if (!I->second)
 142         PredDoneCycle += I->first->Latency;
 143       else if (I->first->Latency)
 144         PredDoneCycle += 1;
 145
 146       AvailableCycle = std::max(AvailableCycle, PredDoneCycle);
 147     }
 148
 149     PendingQueue.push_back(std::make_pair(AvailableCycle, SuccSU));
 150   }
 151 }
 152
 153 /// ScheduleNodeTopDown - Add the node to the schedule. Decrement the pending
 154 /// count of its successors. If a successor pending count is zero, add it to
 155 /// the Available queue.
 156 void ScheduleDAGList::ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle) {
 157   DEBUG(std::cerr << "*** Scheduling [" << CurCycle << "]: ");
 158   DEBUG(SU->dump(&DAG));
 159
 160   Sequence.push_back(SU);
 161   SU->Cycle = CurCycle;
 162
 163   // Bottom up: release successors.
 164   for (std::set<std::pair<SUnit*, bool> >::iterator I = SU->Succs.begin(),
 165        E = SU->Succs.end(); I != E; ++I)
 166     ReleaseSucc(I->first, I->second);
 167 }
 168
 169 /// ListScheduleTopDown - The main loop of list scheduling for top-down
 170 /// schedulers.
 171 void ScheduleDAGList::ListScheduleTopDown() {
 172   unsigned CurCycle = 0;
 173   SUnit *Entry = SUnitMap[DAG.getEntryNode().Val];
 174
 175   // All leaves to Available queue.
 176   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 177     // It is available if it has no predecessors.
 178     if (SUnits[i].Preds.size() == 0 && &SUnits[i] != Entry) {
 179       AvailableQueue->push(&SUnits[i]);
 180       SUnits[i].isAvailable = SUnits[i].isPending = true;
 181     }
 182   }
 183
 184   // Emit the entry node first.
 185   ScheduleNodeTopDown(Entry, CurCycle);
 186   HazardRec->EmitInstruction(Entry->Node);
 187
 188   // While Available queue is not empty, grab the node with the highest
 189   // priority. If it is not ready put it back.  Schedule the node.
 190   std::vector<SUnit*> NotReady;
 191   while (!AvailableQueue->empty() || !PendingQueue.empty()) {
 192     // Check to see if any of the pending instructions are ready to issue.  If
 193     // so, add them to the available queue.
 194     for (unsigned i = 0, e = PendingQueue.size(); i != e; ++i) {
 195       if (PendingQueue[i].first == CurCycle) {
 196         AvailableQueue->push(PendingQueue[i].second);
 197         PendingQueue[i].second->isAvailable = true;
 198         PendingQueue[i] = PendingQueue.back();
 199         PendingQueue.pop_back();
 200         --i; --e;
 201       } else {
 202         assert(PendingQueue[i].first > CurCycle && "Negative latency?");
 203       }
 204     }
 205
 206     // If there are no instructions available, don't try to issue anything, and
 207     // don't advance the hazard recognizer.
 208     if (AvailableQueue->empty()) {
 209       ++CurCycle;
 210       continue;
 211     }
 212
 213     SUnit *FoundSUnit = 0;
 214     SDNode *FoundNode = 0;
 215
 216     bool HasNoopHazards = false;
 217     while (!AvailableQueue->empty()) {
 218       SUnit *CurSUnit = AvailableQueue->pop();
 219
 220       // Get the node represented by this SUnit.
 221       FoundNode = CurSUnit->Node;
 222
 223       // If this is a pseudo op, like copyfromreg, look to see if there is a
 224       // real target node flagged to it.  If so, use the target node.
 225       for (unsigned i = 0, e = CurSUnit->FlaggedNodes.size();
 226            FoundNode->getOpcode() < ISD::BUILTIN_OP_END && i != e; ++i)
 227         FoundNode = CurSUnit->FlaggedNodes[i];
 228
 229       HazardRecognizer::HazardType HT = HazardRec->getHazardType(FoundNode);
 230       if (HT == HazardRecognizer::NoHazard) {
 231         FoundSUnit = CurSUnit;
 232         break;
 233       }
 234
 235       // Remember if this is a noop hazard.
 236       HasNoopHazards |= HT == HazardRecognizer::NoopHazard;
 237
 238       NotReady.push_back(CurSUnit);
 239     }
 240
 241     // Add the nodes that aren't ready back onto the available list.
 242     if (!NotReady.empty()) {
 243       AvailableQueue->push_all(NotReady);
 244       NotReady.clear();
 245     }
 246
 247     // If we found a node to schedule, do it now.
 248     if (FoundSUnit) {
 249       ScheduleNodeTopDown(FoundSUnit, CurCycle);
 250       HazardRec->EmitInstruction(FoundNode);
 251       FoundSUnit->isScheduled = true;
 252       AvailableQueue->ScheduledNode(FoundSUnit);
 253
 254       // If this is a pseudo-op node, we don't want to increment the current
 255       // cycle.
 256       if (FoundSUnit->Latency)  // Don't increment CurCycle for pseudo-ops!
 257         ++CurCycle;
 258     } else if (!HasNoopHazards) {
 259       // Otherwise, we have a pipeline stall, but no other problem, just advance
 260       // the current cycle and try again.
 261       DEBUG(std::cerr << "*** Advancing cycle, no work to do\n");
 262       HazardRec->AdvanceCycle();
 263       ++NumStalls;
 264       ++CurCycle;
 265     } else {
 266       // Otherwise, we have no instructions to issue and we have instructions
 267       // that will fault if we don't do this right.  This is the case for
 268       // processors without pipeline interlocks and other cases.
 269       DEBUG(std::cerr << "*** Emitting noop\n");
 270       HazardRec->EmitNoop();
 271       Sequence.push_back(0);   // NULL SUnit* -> noop
 272       ++NumNoops;
 273       ++CurCycle;
 274     }
 275   }
 276
 277 #ifndef NDEBUG
 278   // Verify that all SUnits were scheduled.
 279   bool AnyNotSched = false;
 280   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 281     if (SUnits[i].NumPredsLeft != 0 || SUnits[i].NumChainPredsLeft != 0) {
 282       if (!AnyNotSched)
 283         std::cerr << "*** List scheduling failed! ***\n";
 284       SUnits[i].dump(&DAG);
 285       std::cerr << "has not been scheduled!\n";
 286       AnyNotSched = true;
 287     }
 288   }
 289   assert(!AnyNotSched);
 290 #endif
 291 }
 292
 293 //===----------------------------------------------------------------------===//
 294 //                    LatencyPriorityQueue Implementation
 295 //===----------------------------------------------------------------------===//
 296 //
 297 // This is a SchedulingPriorityQueue that schedules using latency information to
 298 // reduce the length of the critical path through the basic block.
 299 //
 300 namespace {
 301   class LatencyPriorityQueue;
 302
 303   /// Sorting functions for the Available queue.
 304   struct latency_sort : public std::binary_function<SUnit*, SUnit*, bool> {
 305     LatencyPriorityQueue *PQ;
 306     latency_sort(LatencyPriorityQueue *pq) : PQ(pq) {}
 307     latency_sort(const latency_sort &RHS) : PQ(RHS.PQ) {}
 308
 309     bool operator()(const SUnit* left, const SUnit* right) const;
 310   };
 311 }  // end anonymous namespace
 312
 313 namespace {
 314   class LatencyPriorityQueue : public SchedulingPriorityQueue {
 315     // SUnits - The SUnits for the current graph.
 316     const std::vector<SUnit> *SUnits;
 317
 318     // Latencies - The latency (max of latency from this node to the bb exit)
 319     // for each node.
 320     std::vector<int> Latencies;
 321
 322     /// NumNodesSolelyBlocking - This vector contains, for every node in the
 323     /// Queue, the number of nodes that the node is the sole unscheduled
 324     /// predecessor for.  This is used as a tie-breaker heuristic for better
 325     /// mobility.
 326     std::vector<unsigned> NumNodesSolelyBlocking;
 327
 328     std::priority_queue<SUnit*, std::vector<SUnit*>, latency_sort> Queue;
 329 public:
 330     LatencyPriorityQueue() : Queue(latency_sort(this)) {
 331     }
 332
 333     void initNodes(const std::vector<SUnit> &sunits) {
 334       SUnits = &sunits;
 335       // Calculate node priorities.
 336       CalculatePriorities();
 337     }
 338     void releaseState() {
 339       SUnits = 0;
 340       Latencies.clear();
 341     }
 342
 343     unsigned getLatency(unsigned NodeNum) const {
 344       assert(NodeNum < Latencies.size());
 345       return Latencies[NodeNum];
 346     }
 347
 348     unsigned getNumSolelyBlockNodes(unsigned NodeNum) const {
 349       assert(NodeNum < NumNodesSolelyBlocking.size());
 350       return NumNodesSolelyBlocking[NodeNum];
 351     }
 352
 353     bool empty() const { return Queue.empty(); }
 354
 355     virtual void push(SUnit *U) {
 356       push_impl(U);
 357     }
 358     void push_impl(SUnit *U);
 359
 360     void push_all(const std::vector<SUnit *> &Nodes) {
 361       for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
 362         push_impl(Nodes[i]);
 363     }
 364
 365     SUnit *pop() {
 366       if (empty()) return NULL;
 367       SUnit *V = Queue.top();
 368       Queue.pop();
 369       return V;
 370     }
 371
 372     // ScheduledNode - As nodes are scheduled, we look to see if there are any
 373     // successor nodes that have a single unscheduled predecessor.  If so, that
 374     // single predecessor has a higher priority, since scheduling it will make
 375     // the node available.
 376     void ScheduledNode(SUnit *Node);
 377
 378 private:
 379     void CalculatePriorities();
 380     int CalcLatency(const SUnit &SU);
 381     void AdjustPriorityOfUnscheduledPreds(SUnit *SU);
 382
 383     /// RemoveFromPriorityQueue - This is a really inefficient way to remove a
 384     /// node from a priority queue.  We should roll our own heap to make this
 385     /// better or something.
 386     void RemoveFromPriorityQueue(SUnit *SU) {
 387       std::vector<SUnit*> Temp;
 388
 389       assert(!Queue.empty() && "Not in queue!");
 390       while (Queue.top() != SU) {
 391         Temp.push_back(Queue.top());
 392         Queue.pop();
 393         assert(!Queue.empty() && "Not in queue!");
 394       }
 395
 396       // Remove the node from the PQ.
 397       Queue.pop();
 398
 399       // Add all the other nodes back.
 400       for (unsigned i = 0, e = Temp.size(); i != e; ++i)
 401         Queue.push(Temp[i]);
 402     }
 403   };
 404 }
 405
 406 bool latency_sort::operator()(const SUnit *LHS, const SUnit *RHS) const {
 407   unsigned LHSNum = LHS->NodeNum;
 408   unsigned RHSNum = RHS->NodeNum;
 409
 410   // The most important heuristic is scheduling the critical path.
 411   unsigned LHSLatency = PQ->getLatency(LHSNum);
 412   unsigned RHSLatency = PQ->getLatency(RHSNum);
 413   if (LHSLatency < RHSLatency) return true;
 414   if (LHSLatency > RHSLatency) return false;
 415
 416   // After that, if two nodes have identical latencies, look to see if one will
 417   // unblock more other nodes than the other.
 418   unsigned LHSBlocked = PQ->getNumSolelyBlockNodes(LHSNum);
 419   unsigned RHSBlocked = PQ->getNumSolelyBlockNodes(RHSNum);
 420   if (LHSBlocked < RHSBlocked) return true;
 421   if (LHSBlocked > RHSBlocked) return false;
 422
 423   // Finally, just to provide a stable ordering, use the node number as a
 424   // deciding factor.
 425   return LHSNum < RHSNum;
 426 }
 427
 428
 429 /// CalcNodePriority - Calculate the maximal path from the node to the exit.
 430 ///
 431 int LatencyPriorityQueue::CalcLatency(const SUnit &SU) {
 432   int &Latency = Latencies[SU.NodeNum];
 433   if (Latency != -1)
 434     return Latency;
 435
 436   int MaxSuccLatency = 0;
 437   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU.Succs.begin(),
 438        E = SU.Succs.end(); I != E; ++I)
 439     MaxSuccLatency = std::max(MaxSuccLatency, CalcLatency(*I->first));
 440
 441   return Latency = MaxSuccLatency + SU.Latency;
 442 }
 443
 444 /// CalculatePriorities - Calculate priorities of all scheduling units.
 445 void LatencyPriorityQueue::CalculatePriorities() {
 446   Latencies.assign(SUnits->size(), -1);
 447   NumNodesSolelyBlocking.assign(SUnits->size(), 0);
 448
 449   for (unsigned i = 0, e = SUnits->size(); i != e; ++i)
 450     CalcLatency((*SUnits)[i]);
 451 }
 452
 453 /// getSingleUnscheduledPred - If there is exactly one unscheduled predecessor
 454 /// of SU, return it, otherwise return null.
 455 static SUnit *getSingleUnscheduledPred(SUnit *SU) {
 456   SUnit *OnlyAvailablePred = 0;
 457   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Preds.begin(),
 458        E = SU->Preds.end(); I != E; ++I)
 459     if (!I->first->isScheduled) {
 460       // We found an available, but not scheduled, predecessor.  If it's the
 461       // only one we have found, keep track of it... otherwise give up.
 462       if (OnlyAvailablePred && OnlyAvailablePred != I->first)
 463         return 0;
 464       OnlyAvailablePred = I->first;
 465     }
 466
 467   return OnlyAvailablePred;
 468 }
 469
 470 void LatencyPriorityQueue::push_impl(SUnit *SU) {
 471   // Look at all of the successors of this node.  Count the number of nodes that
 472   // this node is the sole unscheduled node for.
 473   unsigned NumNodesBlocking = 0;
 474   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Succs.begin(),
 475        E = SU->Succs.end(); I != E; ++I)
 476     if (getSingleUnscheduledPred(I->first) == SU)
 477       ++NumNodesBlocking;
 478   NumNodesSolelyBlocking[SU->NodeNum] = NumNodesBlocking;
 479
 480   Queue.push(SU);
 481 }
 482
 483
 484 // ScheduledNode - As nodes are scheduled, we look to see if there are any
 485 // successor nodes that have a single unscheduled predecessor.  If so, that
 486 // single predecessor has a higher priority, since scheduling it will make
 487 // the node available.
 488 void LatencyPriorityQueue::ScheduledNode(SUnit *SU) {
 489   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Succs.begin(),
 490        E = SU->Succs.end(); I != E; ++I)
 491     AdjustPriorityOfUnscheduledPreds(I->first);
 492 }
 493
 494 /// AdjustPriorityOfUnscheduledPreds - One of the predecessors of SU was just
 495 /// scheduled.  If SU is not itself available, then there is at least one
 496 /// predecessor node that has not been scheduled yet.  If SU has exactly ONE
 497 /// unscheduled predecessor, we want to increase its priority: it getting
 498 /// scheduled will make this node available, so it is better than some other
 499 /// node of the same priority that will not make a node available.
 500 void LatencyPriorityQueue::AdjustPriorityOfUnscheduledPreds(SUnit *SU) {
 501   if (SU->isPending) return;  // All preds scheduled.
 502
 503   SUnit *OnlyAvailablePred = getSingleUnscheduledPred(SU);
 504   if (OnlyAvailablePred == 0 || !OnlyAvailablePred->isAvailable) return;
 505
 506   // Okay, we found a single predecessor that is available, but not scheduled.
 507   // Since it is available, it must be in the priority queue.  First remove it.
 508   RemoveFromPriorityQueue(OnlyAvailablePred);
 509
 510   // Reinsert the node into the priority queue, which recomputes its
 511   // NumNodesSolelyBlocking value.
 512   push(OnlyAvailablePred);
 513 }
 514
 515
 516 //===----------------------------------------------------------------------===//
 517 //                         Public Constructor Functions
 518 //===----------------------------------------------------------------------===//
 519
 520 /// createTDListDAGScheduler - This creates a top-down list scheduler with a
 521 /// new hazard recognizer. This scheduler takes ownership of the hazard
 522 /// recognizer and deletes it when done.
 523 ScheduleDAG* llvm::createTDListDAGScheduler(SelectionDAGISel *IS,
 524                                             SelectionDAG *DAG,
 525                                             MachineBasicBlock *BB) {
 526   return new ScheduleDAGList(*DAG, BB, DAG->getTarget(),
 527                              new LatencyPriorityQueue(),
 528                              IS->CreateTargetHazardRecognizer());
 529 }