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 bottom-up and top-down list schedulers, using standard
  11 // algorithms.  The basic approach uses a priority queue of available nodes to
  12 // schedule.  One at a time, nodes are taken from the priority queue (thus in
  13 // priority 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/ScheduleDAG.h"
  23 #include "llvm/CodeGen/SSARegMap.h"
  24 #include "llvm/Target/MRegisterInfo.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Target/TargetInstrInfo.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/ADT/Statistic.h"
  29 #include <climits>
  30 #include <iostream>
  31 #include <queue>
  32 #include <set>
  33 #include <vector>
  34 #include "llvm/Support/CommandLine.h"
  35 using namespace llvm;
  36
  37 namespace {
  38   cl::opt<bool> SchedVertically("sched-vertically", cl::Hidden);
  39   cl::opt<bool> SchedLowerDefNUse("sched-lower-defnuse", cl::Hidden);
  40 }
  41
  42 namespace {
  43   Statistic<> NumNoops ("scheduler", "Number of noops inserted");
  44   Statistic<> NumStalls("scheduler", "Number of pipeline stalls");
  45
  46   /// SUnit - Scheduling unit. It's an wrapper around either a single SDNode or
  47   /// a group of nodes flagged together.
  48   struct SUnit {
  49     SDNode *Node;                       // Representative node.
  50     std::vector<SDNode*> FlaggedNodes;  // All nodes flagged to Node.
  51
  52     // Preds/Succs - The SUnits before/after us in the graph.  The boolean value
  53     // is true if the edge is a token chain edge, false if it is a value edge.
  54     std::set<std::pair<SUnit*,bool> > Preds;  // All sunit predecessors.
  55     std::set<std::pair<SUnit*,bool> > Succs;  // All sunit successors.
  56
  57     short NumPredsLeft;                 // # of preds not scheduled.
  58     short NumSuccsLeft;                 // # of succs not scheduled.
  59     short NumChainPredsLeft;            // # of chain preds not scheduled.
  60     short NumChainSuccsLeft;            // # of chain succs not scheduled.
  61     bool isTwoAddress     : 1;          // Is a two-address instruction.
  62     bool isDefNUseOperand : 1;          // Is a def&use operand.
  63     bool isPending        : 1;          // True once pending.
  64     bool isAvailable      : 1;          // True once available.
  65     bool isScheduled      : 1;          // True once scheduled.
  66     unsigned short Latency;             // Node latency.
  67     unsigned CycleBound;                // Upper/lower cycle to be scheduled at.
  68     unsigned Cycle;                     // Once scheduled, the cycle of the op.
  69     unsigned NodeNum;                   // Entry # of node in the node vector.
  70
  71     SUnit(SDNode *node, unsigned nodenum)
  72       : Node(node), NumPredsLeft(0), NumSuccsLeft(0),
  73         NumChainPredsLeft(0), NumChainSuccsLeft(0),
  74         isTwoAddress(false), isDefNUseOperand(false),
  75         isPending(false), isAvailable(false), isScheduled(false),
  76         Latency(0), CycleBound(0), Cycle(0), NodeNum(nodenum) {}
  77
  78     void dump(const SelectionDAG *G) const;
  79     void dumpAll(const SelectionDAG *G) const;
  80   };
  81 }
  82
  83 void SUnit::dump(const SelectionDAG *G) const {
  84   std::cerr << "SU(" << NodeNum << "): ";
  85   Node->dump(G);
  86   std::cerr << "\n";
  87   if (FlaggedNodes.size() != 0) {
  88     for (unsigned i = 0, e = FlaggedNodes.size(); i != e; i++) {
  89       std::cerr << "    ";
  90       FlaggedNodes[i]->dump(G);
  91       std::cerr << "\n";
  92     }
  93   }
  94 }
  95
  96 void SUnit::dumpAll(const SelectionDAG *G) const {
  97   dump(G);
  98
  99   std::cerr << "  # preds left       : " << NumPredsLeft << "\n";
 100   std::cerr << "  # succs left       : " << NumSuccsLeft << "\n";
 101   std::cerr << "  # chain preds left : " << NumChainPredsLeft << "\n";
 102   std::cerr << "  # chain succs left : " << NumChainSuccsLeft << "\n";
 103   std::cerr << "  Latency            : " << Latency << "\n";
 104
 105   if (Preds.size() != 0) {
 106     std::cerr << "  Predecessors:\n";
 107     for (std::set<std::pair<SUnit*,bool> >::const_iterator I = Preds.begin(),
 108            E = Preds.end(); I != E; ++I) {
 109       if (I->second)
 110         std::cerr << "   ch  ";
 111       else
 112         std::cerr << "   val ";
 113       I->first->dump(G);
 114     }
 115   }
 116   if (Succs.size() != 0) {
 117     std::cerr << "  Successors:\n";
 118     for (std::set<std::pair<SUnit*, bool> >::const_iterator I = Succs.begin(),
 119            E = Succs.end(); I != E; ++I) {
 120       if (I->second)
 121         std::cerr << "   ch  ";
 122       else
 123         std::cerr << "   val ";
 124       I->first->dump(G);
 125     }
 126   }
 127   std::cerr << "\n";
 128 }
 129
 130 //===----------------------------------------------------------------------===//
 131 /// SchedulingPriorityQueue - This interface is used to plug different
 132 /// priorities computation algorithms into the list scheduler. It implements the
 133 /// interface of a standard priority queue, where nodes are inserted in
 134 /// arbitrary order and returned in priority order.  The computation of the
 135 /// priority and the representation of the queue are totally up to the
 136 /// implementation to decide.
 137 ///
 138 namespace {
 139 class SchedulingPriorityQueue {
 140 public:
 141   virtual ~SchedulingPriorityQueue() {}
 142
 143   virtual void initNodes(const std::vector<SUnit> &SUnits) = 0;
 144   virtual void releaseState() = 0;
 145
 146   virtual bool empty() const = 0;
 147   virtual void push(SUnit *U) = 0;
 148
 149   virtual void push_all(const std::vector<SUnit *> &Nodes) = 0;
 150   virtual SUnit *pop() = 0;
 151
 152   virtual void RemoveFromPriorityQueue(SUnit *SU) = 0;
 153
 154   /// ScheduledNode - As each node is scheduled, this method is invoked.  This
 155   /// allows the priority function to adjust the priority of node that have
 156   /// already been emitted.
 157   virtual void ScheduledNode(SUnit *Node) {}
 158 };
 159 }
 160
 161
 162
 163 namespace {
 164 //===----------------------------------------------------------------------===//
 165 /// ScheduleDAGList - The actual list scheduler implementation.  This supports
 166 /// both top-down and bottom-up scheduling.
 167 ///
 168 class ScheduleDAGList : public ScheduleDAG {
 169 private:
 170   // SDNode to SUnit mapping (many to one).
 171   std::map<SDNode*, SUnit*> SUnitMap;
 172
 173   // The schedule.  Null SUnit*'s represent noop instructions.
 174   std::vector<SUnit*> Sequence;
 175
 176   // The scheduling units.
 177   std::vector<SUnit> SUnits;
 178
 179   /// isBottomUp - This is true if the scheduling problem is bottom-up, false if
 180   /// it is top-down.
 181   bool isBottomUp;
 182
 183   /// AvailableQueue - The priority queue to use for the available SUnits.
 184   ///
 185   SchedulingPriorityQueue *AvailableQueue;
 186
 187   /// PendingQueue - This contains all of the instructions whose operands have
 188   /// been issued, but their results are not ready yet (due to the latency of
 189   /// the operation).  Once the operands becomes available, the instruction is
 190   /// added to the AvailableQueue.  This keeps track of each SUnit and the
 191   /// number of cycles left to execute before the operation is available.
 192   std::vector<std::pair<unsigned, SUnit*> > PendingQueue;
 193
 194   /// HazardRec - The hazard recognizer to use.
 195   HazardRecognizer *HazardRec;
 196
 197   /// OpenNodes - Nodes with open live ranges, i.e. predecessors or successors
 198   /// of scheduled nodes which are not themselves scheduled.
 199   std::map<const TargetRegisterClass*, std::set<SUnit*> > OpenNodes;
 200
 201   /// RegPressureLimits - Keep track of upper limit of register pressure for
 202   /// each register class that allows the scheduler to go into vertical mode.
 203   std::map<const TargetRegisterClass*, unsigned> RegPressureLimits;
 204
 205 public:
 206   ScheduleDAGList(SelectionDAG &dag, MachineBasicBlock *bb,
 207                   const TargetMachine &tm, bool isbottomup,
 208                   SchedulingPriorityQueue *availqueue,
 209                   HazardRecognizer *HR)
 210     : ScheduleDAG(dag, bb, tm), isBottomUp(isbottomup),
 211       AvailableQueue(availqueue), HazardRec(HR) {
 212     }
 213
 214   ~ScheduleDAGList() {
 215     delete HazardRec;
 216     delete AvailableQueue;
 217   }
 218
 219   void Schedule();
 220
 221   void dumpSchedule() const;
 222
 223 private:
 224   SUnit *NewSUnit(SDNode *N);
 225   void ReleasePred(SUnit *PredSU, bool isChain, unsigned CurCycle);
 226   void ReleaseSucc(SUnit *SuccSU, bool isChain);
 227   void ScheduleNodeBottomUp(SUnit *SU, unsigned& CurCycle, bool Veritical=true);
 228   void ScheduleVertically(SUnit *SU, unsigned& CurCycle);
 229   void ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle);
 230   void ListScheduleTopDown();
 231   void ListScheduleBottomUp();
 232   void BuildSchedUnits();
 233   void EmitSchedule();
 234 };
 235 }  // end anonymous namespace
 236
 237 HazardRecognizer::~HazardRecognizer() {}
 238
 239
 240 /// NewSUnit - Creates a new SUnit and return a ptr to it.
 241 SUnit *ScheduleDAGList::NewSUnit(SDNode *N) {
 242   SUnits.push_back(SUnit(N, SUnits.size()));
 243   return &SUnits.back();
 244 }
 245
 246 /// BuildSchedUnits - Build SUnits from the selection dag that we are input.
 247 /// This SUnit graph is similar to the SelectionDAG, but represents flagged
 248 /// together nodes with a single SUnit.
 249 void ScheduleDAGList::BuildSchedUnits() {
 250   // Reserve entries in the vector for each of the SUnits we are creating.  This
 251   // ensure that reallocation of the vector won't happen, so SUnit*'s won't get
 252   // invalidated.
 253   SUnits.reserve(std::distance(DAG.allnodes_begin(), DAG.allnodes_end()));
 254
 255   const InstrItineraryData &InstrItins = TM.getInstrItineraryData();
 256
 257   for (SelectionDAG::allnodes_iterator NI = DAG.allnodes_begin(),
 258        E = DAG.allnodes_end(); NI != E; ++NI) {
 259     if (isPassiveNode(NI))  // Leaf node, e.g. a TargetImmediate.
 260       continue;
 261
 262     // If this node has already been processed, stop now.
 263     if (SUnitMap[NI]) continue;
 264
 265     SUnit *NodeSUnit = NewSUnit(NI);
 266
 267     // See if anything is flagged to this node, if so, add them to flagged
 268     // nodes.  Nodes can have at most one flag input and one flag output.  Flags
 269     // are required the be the last operand and result of a node.
 270
 271     // Scan up, adding flagged preds to FlaggedNodes.
 272     SDNode *N = NI;
 273     while (N->getNumOperands() &&
 274            N->getOperand(N->getNumOperands()-1).getValueType() == MVT::Flag) {
 275       N = N->getOperand(N->getNumOperands()-1).Val;
 276       NodeSUnit->FlaggedNodes.push_back(N);
 277       SUnitMap[N] = NodeSUnit;
 278     }
 279
 280     // Scan down, adding this node and any flagged succs to FlaggedNodes if they
 281     // have a user of the flag operand.
 282     N = NI;
 283     while (N->getValueType(N->getNumValues()-1) == MVT::Flag) {
 284       SDOperand FlagVal(N, N->getNumValues()-1);
 285
 286       // There are either zero or one users of the Flag result.
 287       bool HasFlagUse = false;
 288       for (SDNode::use_iterator UI = N->use_begin(), E = N->use_end();
 289            UI != E; ++UI)
 290         if (FlagVal.isOperand(*UI)) {
 291           HasFlagUse = true;
 292           NodeSUnit->FlaggedNodes.push_back(N);
 293           SUnitMap[N] = NodeSUnit;
 294           N = *UI;
 295           break;
 296         }
 297           if (!HasFlagUse) break;
 298     }
 299
 300     // Now all flagged nodes are in FlaggedNodes and N is the bottom-most node.
 301     // Update the SUnit
 302     NodeSUnit->Node = N;
 303     SUnitMap[N] = NodeSUnit;
 304
 305     // Compute the latency for the node.  We use the sum of the latencies for
 306     // all nodes flagged together into this SUnit.
 307     if (InstrItins.isEmpty()) {
 308       // No latency information.
 309       NodeSUnit->Latency = 1;
 310     } else {
 311       NodeSUnit->Latency = 0;
 312       if (N->isTargetOpcode()) {
 313         unsigned SchedClass = TII->getSchedClass(N->getTargetOpcode());
 314         InstrStage *S = InstrItins.begin(SchedClass);
 315         InstrStage *E = InstrItins.end(SchedClass);
 316         for (; S != E; ++S)
 317           NodeSUnit->Latency += S->Cycles;
 318       }
 319       for (unsigned i = 0, e = NodeSUnit->FlaggedNodes.size(); i != e; ++i) {
 320         SDNode *FNode = NodeSUnit->FlaggedNodes[i];
 321         if (FNode->isTargetOpcode()) {
 322           unsigned SchedClass = TII->getSchedClass(FNode->getTargetOpcode());
 323           InstrStage *S = InstrItins.begin(SchedClass);
 324           InstrStage *E = InstrItins.end(SchedClass);
 325           for (; S != E; ++S)
 326             NodeSUnit->Latency += S->Cycles;
 327         }
 328       }
 329     }
 330   }
 331
 332   // Pass 2: add the preds, succs, etc.
 333   for (unsigned su = 0, e = SUnits.size(); su != e; ++su) {
 334     SUnit *SU = &SUnits[su];
 335     SDNode *MainNode = SU->Node;
 336
 337     if (MainNode->isTargetOpcode()) {
 338       unsigned Opc = MainNode->getTargetOpcode();
 339       if (TII->isTwoAddrInstr(Opc)) {
 340         SU->isTwoAddress = true;
 341         SDNode *OpN = MainNode->getOperand(0).Val;
 342         SUnit *OpSU = SUnitMap[OpN];
 343         if (OpSU)
 344           OpSU->isDefNUseOperand = true;
 345       }
 346     }
 347
 348     // Find all predecessors and successors of the group.
 349     // Temporarily add N to make code simpler.
 350     SU->FlaggedNodes.push_back(MainNode);
 351
 352     for (unsigned n = 0, e = SU->FlaggedNodes.size(); n != e; ++n) {
 353       SDNode *N = SU->FlaggedNodes[n];
 354
 355       for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 356         SDNode *OpN = N->getOperand(i).Val;
 357         if (isPassiveNode(OpN)) continue;   // Not scheduled.
 358         SUnit *OpSU = SUnitMap[OpN];
 359         assert(OpSU && "Node has no SUnit!");
 360         if (OpSU == SU) continue;           // In the same group.
 361
 362         MVT::ValueType OpVT = N->getOperand(i).getValueType();
 363         assert(OpVT != MVT::Flag && "Flagged nodes should be in same sunit!");
 364         bool isChain = OpVT == MVT::Other;
 365
 366         if (SU->Preds.insert(std::make_pair(OpSU, isChain)).second) {
 367           if (!isChain) {
 368             SU->NumPredsLeft++;
 369           } else {
 370             SU->NumChainPredsLeft++;
 371           }
 372         }
 373         if (OpSU->Succs.insert(std::make_pair(SU, isChain)).second) {
 374           if (!isChain) {
 375             OpSU->NumSuccsLeft++;
 376           } else {
 377             OpSU->NumChainSuccsLeft++;
 378           }
 379         }
 380       }
 381     }
 382
 383     // Remove MainNode from FlaggedNodes again.
 384     SU->FlaggedNodes.pop_back();
 385   }
 386
 387   DEBUG(for (unsigned su = 0, e = SUnits.size(); su != e; ++su)
 388         SUnits[su].dumpAll(&DAG));
 389   return;
 390 }
 391
 392 /// EmitSchedule - Emit the machine code in scheduled order.
 393 void ScheduleDAGList::EmitSchedule() {
 394   std::map<SDNode*, unsigned> VRBaseMap;
 395   for (unsigned i = 0, e = Sequence.size(); i != e; i++) {
 396     if (SUnit *SU = Sequence[i]) {
 397       for (unsigned j = 0, ee = SU->FlaggedNodes.size(); j != ee; j++)
 398         EmitNode(SU->FlaggedNodes[j], VRBaseMap);
 399       EmitNode(SU->Node, VRBaseMap);
 400     } else {
 401       // Null SUnit* is a noop.
 402       EmitNoop();
 403     }
 404   }
 405 }
 406
 407 /// dump - dump the schedule.
 408 void ScheduleDAGList::dumpSchedule() const {
 409   for (unsigned i = 0, e = Sequence.size(); i != e; i++) {
 410     if (SUnit *SU = Sequence[i])
 411       SU->dump(&DAG);
 412     else
 413       std::cerr << "**** NOOP ****\n";
 414   }
 415 }
 416
 417 /// Schedule - Schedule the DAG using list scheduling.
 418 void ScheduleDAGList::Schedule() {
 419   DEBUG(std::cerr << "********** List Scheduling **********\n");
 420
 421   // Build scheduling units.
 422   BuildSchedUnits();
 423
 424   AvailableQueue->initNodes(SUnits);
 425
 426   // Execute the actual scheduling loop Top-Down or Bottom-Up as appropriate.
 427   if (isBottomUp)
 428     ListScheduleBottomUp();
 429   else
 430     ListScheduleTopDown();
 431
 432   AvailableQueue->releaseState();
 433
 434   DEBUG(std::cerr << "*** Final schedule ***\n");
 435   DEBUG(dumpSchedule());
 436   DEBUG(std::cerr << "\n");
 437
 438   // Emit in scheduled order
 439   EmitSchedule();
 440 }
 441
 442 //===----------------------------------------------------------------------===//
 443 //  Bottom-Up Scheduling
 444 //===----------------------------------------------------------------------===//
 445
 446 static const TargetRegisterClass *getRegClass(SUnit *SU,
 447                                               const TargetInstrInfo *TII,
 448                                               const MRegisterInfo *MRI,
 449                                               SSARegMap *RegMap) {
 450   if (SU->Node->isTargetOpcode()) {
 451     unsigned Opc = SU->Node->getTargetOpcode();
 452     const TargetInstrDescriptor &II = TII->get(Opc);
 453     return II.OpInfo->RegClass;
 454   } else {
 455     assert(SU->Node->getOpcode() == ISD::CopyFromReg);
 456     unsigned SrcReg = cast<RegisterSDNode>(SU->Node->getOperand(1))->getReg();
 457     if (MRegisterInfo::isVirtualRegister(SrcReg))
 458       return RegMap->getRegClass(SrcReg);
 459     else {
 460       for (MRegisterInfo::regclass_iterator I = MRI->regclass_begin(),
 461              E = MRI->regclass_end(); I != E; ++I)
 462         if ((*I)->hasType(SU->Node->getValueType(0)) &&
 463             (*I)->contains(SrcReg))
 464           return *I;
 465       assert(false && "Couldn't find register class for reg copy!");
 466     }
 467     return NULL;
 468   }
 469 }
 470
 471 static unsigned getNumResults(SUnit *SU) {
 472   unsigned NumResults = 0;
 473   for (unsigned i = 0, e = SU->Node->getNumValues(); i != e; ++i) {
 474     MVT::ValueType VT = SU->Node->getValueType(i);
 475     if (VT != MVT::Other && VT != MVT::Flag)
 476       NumResults++;
 477   }
 478   return NumResults;
 479 }
 480
 481 /// ReleasePred - Decrement the NumSuccsLeft count of a predecessor. Add it to
 482 /// the Available queue is the count reaches zero. Also update its cycle bound.
 483 void ScheduleDAGList::ReleasePred(SUnit *PredSU, bool isChain,
 484                                   unsigned CurCycle) {
 485   // FIXME: the distance between two nodes is not always == the predecessor's
 486   // latency. For example, the reader can very well read the register written
 487   // by the predecessor later than the issue cycle. It also depends on the
 488   // interrupt model (drain vs. freeze).
 489   PredSU->CycleBound = std::max(PredSU->CycleBound, CurCycle + PredSU->Latency);
 490
 491   if (!isChain)
 492     PredSU->NumSuccsLeft--;
 493   else
 494     PredSU->NumChainSuccsLeft--;
 495
 496 #ifndef NDEBUG
 497   if (PredSU->NumSuccsLeft < 0 || PredSU->NumChainSuccsLeft < 0) {
 498     std::cerr << "*** List scheduling failed! ***\n";
 499     PredSU->dump(&DAG);
 500     std::cerr << " has been released too many times!\n";
 501     assert(0);
 502   }
 503 #endif
 504
 505   if ((PredSU->NumSuccsLeft + PredSU->NumChainSuccsLeft) == 0) {
 506     // EntryToken has to go last!  Special case it here.
 507     if (PredSU->Node->getOpcode() != ISD::EntryToken) {
 508       PredSU->isAvailable = true;
 509       AvailableQueue->push(PredSU);
 510     }
 511   }
 512
 513   if (getNumResults(PredSU) > 0) {
 514     const TargetRegisterClass *RegClass = getRegClass(PredSU, TII, MRI, RegMap);
 515     OpenNodes[RegClass].insert(PredSU);
 516   }
 517 }
 518
 519 /// SharesOperandWithTwoAddr - Check if there is a unscheduled two-address node
 520 /// with which SU shares an operand. If so, returns the node.
 521 static SUnit *SharesOperandWithTwoAddr(SUnit *SU) {
 522   assert(!SU->isTwoAddress && "Node cannot be two-address op");
 523   for (std::set<std::pair<SUnit*, bool> >::iterator I = SU->Preds.begin(),
 524          E = SU->Preds.end(); I != E; ++I) {
 525     if (I->second) continue;
 526     SUnit *PredSU = I->first;
 527     for (std::set<std::pair<SUnit*, bool> >::iterator II =
 528            PredSU->Succs.begin(), EE = PredSU->Succs.end(); II != EE; ++II) {
 529       if (II->second) continue;
 530       SUnit *SSU = II->first;
 531       if (SSU->isTwoAddress && !SSU->isScheduled) {
 532         return SSU;
 533       }
 534     }
 535   }
 536   return NULL;
 537 }
 538
 539 static bool isFloater(const SUnit *SU) {
 540   unsigned Opc = SU->Node->getOpcode();
 541   return (Opc != ISD::CopyFromReg && SU->NumPredsLeft == 0);
 542 }
 543
 544 static bool isSimpleFloaterUse(const SUnit *SU) {
 545   unsigned NumOps = 0;
 546   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Preds.begin(),
 547          E = SU->Preds.end(); I != E; ++I) {
 548     if (I->second) continue;
 549     if (++NumOps > 1)
 550       return false;
 551     if (!isFloater(I->first))
 552       return false;
 553   }
 554   return true;
 555 }
 556
 557 /// ScheduleVertically - Schedule vertically. That is, follow up the D&U chain
 558 /// (of two-address code) and schedule floaters aggressively.
 559 void ScheduleDAGList::ScheduleVertically(SUnit *SU, unsigned& CurCycle) {
 560   // Try scheduling Def&Use operand if register pressure is low.
 561   const TargetRegisterClass *RegClass = getRegClass(SU, TII, MRI, RegMap);
 562   unsigned Pressure = OpenNodes[RegClass].size();
 563   unsigned Limit = RegPressureLimits[RegClass];
 564
 565   // See if we can schedule any predecessor that takes no registers.
 566   for (std::set<std::pair<SUnit*, bool> >::iterator I = SU->Preds.begin(),
 567          E = SU->Preds.end(); I != E; ++I) {
 568     if (I->second) continue;
 569
 570     SUnit *PredSU = I->first;
 571     if (!PredSU->isAvailable || PredSU->isScheduled)
 572       continue;
 573
 574     if (isFloater(PredSU)) {
 575       DEBUG(std::cerr<<"*** Scheduling floater\n");
 576       AvailableQueue->RemoveFromPriorityQueue(PredSU);
 577       ScheduleNodeBottomUp(PredSU, CurCycle, false);
 578     }
 579   }
 580
 581   SUnit *DUSU = NULL;
 582   if (SU->isTwoAddress && Pressure < Limit) {
 583     DUSU = SUnitMap[SU->Node->getOperand(0).Val];
 584     if (!DUSU->isAvailable || DUSU->isScheduled)
 585       DUSU = NULL;
 586     else if (!DUSU->isTwoAddress) {
 587       SUnit *SSU = SharesOperandWithTwoAddr(DUSU);
 588       if (SSU && SSU->isAvailable) {
 589         AvailableQueue->RemoveFromPriorityQueue(SSU);
 590         ScheduleNodeBottomUp(SSU, CurCycle, false);
 591         Pressure = OpenNodes[RegClass].size();
 592         if (Pressure >= Limit)
 593           DUSU = NULL;
 594       }
 595     }
 596   }
 597
 598   if (DUSU) {
 599     DEBUG(std::cerr<<"*** Low register pressure: scheduling D&U operand\n");
 600     AvailableQueue->RemoveFromPriorityQueue(DUSU);
 601     ScheduleNodeBottomUp(DUSU, CurCycle, false);
 602     Pressure = OpenNodes[RegClass].size();
 603     ScheduleVertically(DUSU, CurCycle);
 604   }
 605 }
 606
 607 /// ScheduleNodeBottomUp - Add the node to the schedule. Decrement the pending
 608 /// count of its predecessors. If a predecessor pending count is zero, add it to
 609 /// the Available queue.
 610 void ScheduleDAGList::ScheduleNodeBottomUp(SUnit *SU, unsigned& CurCycle,
 611                                            bool Vertical) {
 612   DEBUG(std::cerr << "*** Scheduling [" << CurCycle << "]: ");
 613   DEBUG(SU->dump(&DAG));
 614   SU->Cycle = CurCycle;
 615
 616   AvailableQueue->ScheduledNode(SU);
 617   Sequence.push_back(SU);
 618
 619   // Bottom up: release predecessors
 620   for (std::set<std::pair<SUnit*, bool> >::iterator I = SU->Preds.begin(),
 621          E = SU->Preds.end(); I != E; ++I)
 622     ReleasePred(I->first, I->second, CurCycle);
 623   SU->isScheduled = true;
 624   CurCycle++;
 625
 626   if (getNumResults(SU) != 0) {
 627     const TargetRegisterClass *RegClass = getRegClass(SU, TII, MRI, RegMap);
 628     OpenNodes[RegClass].erase(SU);
 629
 630     if (SchedVertically && Vertical)
 631       ScheduleVertically(SU, CurCycle);
 632   }
 633 }
 634
 635 /// isReady - True if node's lower cycle bound is less or equal to the current
 636 /// scheduling cycle. Always true if all nodes have uniform latency 1.
 637 static inline bool isReady(SUnit *SU, unsigned CurCycle) {
 638   return SU->CycleBound <= CurCycle;
 639 }
 640
 641 /// ListScheduleBottomUp - The main loop of list scheduling for bottom-up
 642 /// schedulers.
 643 void ScheduleDAGList::ListScheduleBottomUp() {
 644   // Determine rough register pressure limit.
 645   for (MRegisterInfo::regclass_iterator RCI = MRI->regclass_begin(),
 646          E = MRI->regclass_end(); RCI != E; ++RCI) {
 647     const TargetRegisterClass *RC = *RCI;
 648     unsigned Limit = RC->getNumRegs();
 649     Limit = (Limit > 2) ? Limit - 2 : 0;
 650     std::map<const TargetRegisterClass*, unsigned>::iterator RPI =
 651       RegPressureLimits.find(RC);
 652     if (RPI == RegPressureLimits.end())
 653       RegPressureLimits[RC] = Limit;
 654     else {
 655       unsigned &OldLimit = RegPressureLimits[RC];
 656       if (Limit < OldLimit)
 657         OldLimit = Limit;
 658     }
 659   }
 660
 661   unsigned CurCycle = 0;
 662   // Add root to Available queue.
 663   AvailableQueue->push(SUnitMap[DAG.getRoot().Val]);
 664
 665   // While Available queue is not empty, grab the node with the highest
 666   // priority. If it is not ready put it back. Schedule the node.
 667   std::vector<SUnit*> NotReady;
 668   SUnit *CurNode = NULL;
 669   while (!AvailableQueue->empty()) {
 670     SUnit *CurNode = AvailableQueue->pop();
 671     while (!isReady(CurNode, CurCycle)) {
 672       NotReady.push_back(CurNode);
 673       CurNode = AvailableQueue->pop();
 674     }
 675
 676     // Add the nodes that aren't ready back onto the available list.
 677     AvailableQueue->push_all(NotReady);
 678     NotReady.clear();
 679
 680     ScheduleNodeBottomUp(CurNode, CurCycle);
 681   }
 682
 683   // Add entry node last
 684   if (DAG.getEntryNode().Val != DAG.getRoot().Val) {
 685     SUnit *Entry = SUnitMap[DAG.getEntryNode().Val];
 686     Sequence.push_back(Entry);
 687   }
 688
 689   // Reverse the order if it is bottom up.
 690   std::reverse(Sequence.begin(), Sequence.end());
 691
 692
 693 #ifndef NDEBUG
 694   // Verify that all SUnits were scheduled.
 695   bool AnyNotSched = false;
 696   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 697     if (SUnits[i].NumSuccsLeft != 0 || SUnits[i].NumChainSuccsLeft != 0) {
 698       if (!AnyNotSched)
 699         std::cerr << "*** List scheduling failed! ***\n";
 700       SUnits[i].dump(&DAG);
 701       std::cerr << "has not been scheduled!\n";
 702       AnyNotSched = true;
 703     }
 704   }
 705   assert(!AnyNotSched);
 706 #endif
 707 }
 708
 709 //===----------------------------------------------------------------------===//
 710 //  Top-Down Scheduling
 711 //===----------------------------------------------------------------------===//
 712
 713 /// ReleaseSucc - Decrement the NumPredsLeft count of a successor. Add it to
 714 /// the PendingQueue if the count reaches zero.
 715 void ScheduleDAGList::ReleaseSucc(SUnit *SuccSU, bool isChain) {
 716   if (!isChain)
 717     SuccSU->NumPredsLeft--;
 718   else
 719     SuccSU->NumChainPredsLeft--;
 720
 721   assert(SuccSU->NumPredsLeft >= 0 && SuccSU->NumChainPredsLeft >= 0 &&
 722          "List scheduling internal error");
 723
 724   if ((SuccSU->NumPredsLeft + SuccSU->NumChainPredsLeft) == 0) {
 725     // Compute how many cycles it will be before this actually becomes
 726     // available.  This is the max of the start time of all predecessors plus
 727     // their latencies.
 728     unsigned AvailableCycle = 0;
 729     for (std::set<std::pair<SUnit*, bool> >::iterator I = SuccSU->Preds.begin(),
 730          E = SuccSU->Preds.end(); I != E; ++I) {
 731       // If this is a token edge, we don't need to wait for the latency of the
 732       // preceeding instruction (e.g. a long-latency load) unless there is also
 733       // some other data dependence.
 734       unsigned PredDoneCycle = I->first->Cycle;
 735       if (!I->second)
 736         PredDoneCycle += I->first->Latency;
 737       else if (I->first->Latency)
 738         PredDoneCycle += 1;
 739
 740       AvailableCycle = std::max(AvailableCycle, PredDoneCycle);
 741     }
 742
 743     PendingQueue.push_back(std::make_pair(AvailableCycle, SuccSU));
 744   }
 745 }
 746
 747 /// ScheduleNodeTopDown - Add the node to the schedule. Decrement the pending
 748 /// count of its successors. If a successor pending count is zero, add it to
 749 /// the Available queue.
 750 void ScheduleDAGList::ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle) {
 751   DEBUG(std::cerr << "*** Scheduling [" << CurCycle << "]: ");
 752   DEBUG(SU->dump(&DAG));
 753
 754   Sequence.push_back(SU);
 755   SU->Cycle = CurCycle;
 756
 757   // Bottom up: release successors.
 758   for (std::set<std::pair<SUnit*, bool> >::iterator I = SU->Succs.begin(),
 759        E = SU->Succs.end(); I != E; ++I)
 760     ReleaseSucc(I->first, I->second);
 761 }
 762
 763 /// ListScheduleTopDown - The main loop of list scheduling for top-down
 764 /// schedulers.
 765 void ScheduleDAGList::ListScheduleTopDown() {
 766   unsigned CurCycle = 0;
 767   SUnit *Entry = SUnitMap[DAG.getEntryNode().Val];
 768
 769   // All leaves to Available queue.
 770   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 771     // It is available if it has no predecessors.
 772     if (SUnits[i].Preds.size() == 0 && &SUnits[i] != Entry) {
 773       AvailableQueue->push(&SUnits[i]);
 774       SUnits[i].isAvailable = SUnits[i].isPending = true;
 775     }
 776   }
 777
 778   // Emit the entry node first.
 779   ScheduleNodeTopDown(Entry, CurCycle);
 780   HazardRec->EmitInstruction(Entry->Node);
 781
 782   // While Available queue is not empty, grab the node with the highest
 783   // priority. If it is not ready put it back.  Schedule the node.
 784   std::vector<SUnit*> NotReady;
 785   while (!AvailableQueue->empty() || !PendingQueue.empty()) {
 786     // Check to see if any of the pending instructions are ready to issue.  If
 787     // so, add them to the available queue.
 788     for (unsigned i = 0, e = PendingQueue.size(); i != e; ++i) {
 789       if (PendingQueue[i].first == CurCycle) {
 790         AvailableQueue->push(PendingQueue[i].second);
 791         PendingQueue[i].second->isAvailable = true;
 792         PendingQueue[i] = PendingQueue.back();
 793         PendingQueue.pop_back();
 794         --i; --e;
 795       } else {
 796         assert(PendingQueue[i].first > CurCycle && "Negative latency?");
 797       }
 798     }
 799
 800     // If there are no instructions available, don't try to issue anything, and
 801     // don't advance the hazard recognizer.
 802     if (AvailableQueue->empty()) {
 803       ++CurCycle;
 804       continue;
 805     }
 806
 807     SUnit *FoundSUnit = 0;
 808     SDNode *FoundNode = 0;
 809
 810     bool HasNoopHazards = false;
 811     while (!AvailableQueue->empty()) {
 812       SUnit *CurSUnit = AvailableQueue->pop();
 813
 814       // Get the node represented by this SUnit.
 815       FoundNode = CurSUnit->Node;
 816
 817       // If this is a pseudo op, like copyfromreg, look to see if there is a
 818       // real target node flagged to it.  If so, use the target node.
 819       for (unsigned i = 0, e = CurSUnit->FlaggedNodes.size();
 820            FoundNode->getOpcode() < ISD::BUILTIN_OP_END && i != e; ++i)
 821         FoundNode = CurSUnit->FlaggedNodes[i];
 822
 823       HazardRecognizer::HazardType HT = HazardRec->getHazardType(FoundNode);
 824       if (HT == HazardRecognizer::NoHazard) {
 825         FoundSUnit = CurSUnit;
 826         break;
 827       }
 828
 829       // Remember if this is a noop hazard.
 830       HasNoopHazards |= HT == HazardRecognizer::NoopHazard;
 831
 832       NotReady.push_back(CurSUnit);
 833     }
 834
 835     // Add the nodes that aren't ready back onto the available list.
 836     if (!NotReady.empty()) {
 837       AvailableQueue->push_all(NotReady);
 838       NotReady.clear();
 839     }
 840
 841     // If we found a node to schedule, do it now.
 842     if (FoundSUnit) {
 843       ScheduleNodeTopDown(FoundSUnit, CurCycle);
 844       HazardRec->EmitInstruction(FoundNode);
 845       FoundSUnit->isScheduled = true;
 846       AvailableQueue->ScheduledNode(FoundSUnit);
 847
 848       // If this is a pseudo-op node, we don't want to increment the current
 849       // cycle.
 850       if (FoundSUnit->Latency)  // Don't increment CurCycle for pseudo-ops!
 851         ++CurCycle;
 852     } else if (!HasNoopHazards) {
 853       // Otherwise, we have a pipeline stall, but no other problem, just advance
 854       // the current cycle and try again.
 855       DEBUG(std::cerr << "*** Advancing cycle, no work to do\n");
 856       HazardRec->AdvanceCycle();
 857       ++NumStalls;
 858       ++CurCycle;
 859     } else {
 860       // Otherwise, we have no instructions to issue and we have instructions
 861       // that will fault if we don't do this right.  This is the case for
 862       // processors without pipeline interlocks and other cases.
 863       DEBUG(std::cerr << "*** Emitting noop\n");
 864       HazardRec->EmitNoop();
 865       Sequence.push_back(0);   // NULL SUnit* -> noop
 866       ++NumNoops;
 867       ++CurCycle;
 868     }
 869   }
 870
 871 #ifndef NDEBUG
 872   // Verify that all SUnits were scheduled.
 873   bool AnyNotSched = false;
 874   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
 875     if (SUnits[i].NumPredsLeft != 0 || SUnits[i].NumChainPredsLeft != 0) {
 876       if (!AnyNotSched)
 877         std::cerr << "*** List scheduling failed! ***\n";
 878       SUnits[i].dump(&DAG);
 879       std::cerr << "has not been scheduled!\n";
 880       AnyNotSched = true;
 881     }
 882   }
 883   assert(!AnyNotSched);
 884 #endif
 885 }
 886
 887 //===----------------------------------------------------------------------===//
 888 //                RegReductionPriorityQueue Implementation
 889 //===----------------------------------------------------------------------===//
 890 //
 891 // This is a SchedulingPriorityQueue that schedules using Sethi Ullman numbers
 892 // to reduce register pressure.
 893 //
 894 namespace {
 895   class RegReductionPriorityQueue;
 896
 897   /// Sorting functions for the Available queue.
 898   struct ls_rr_sort : public std::binary_function<SUnit*, SUnit*, bool> {
 899     RegReductionPriorityQueue *SPQ;
 900     ls_rr_sort(RegReductionPriorityQueue *spq) : SPQ(spq) {}
 901     ls_rr_sort(const ls_rr_sort &RHS) : SPQ(RHS.SPQ) {}
 902
 903     bool operator()(const SUnit* left, const SUnit* right) const;
 904   };
 905 }  // end anonymous namespace
 906
 907 namespace {
 908   class RegReductionPriorityQueue : public SchedulingPriorityQueue {
 909     // SUnits - The SUnits for the current graph.
 910     const std::vector<SUnit> *SUnits;
 911
 912     // SethiUllmanNumbers - The SethiUllman number for each node.
 913     std::vector<int> SethiUllmanNumbers;
 914
 915     std::priority_queue<SUnit*, std::vector<SUnit*>, ls_rr_sort> Queue;
 916   public:
 917     RegReductionPriorityQueue() :
 918     Queue(ls_rr_sort(this)) {}
 919
 920     void initNodes(const std::vector<SUnit> &sunits) {
 921       SUnits = &sunits;
 922       // Add pseudo dependency edges for two-address nodes.
 923       if (SchedLowerDefNUse)
 924         AddPseudoTwoAddrDeps();
 925       // Calculate node priorities.
 926       CalculatePriorities();
 927     }
 928     void releaseState() {
 929       SUnits = 0;
 930       SethiUllmanNumbers.clear();
 931     }
 932
 933     int getSethiUllmanNumber(unsigned NodeNum) const {
 934       assert(NodeNum < SethiUllmanNumbers.size());
 935       return SethiUllmanNumbers[NodeNum];
 936     }
 937
 938     bool empty() const { return Queue.empty(); }
 939
 940     void push(SUnit *U) {
 941       Queue.push(U);
 942     }
 943     void push_all(const std::vector<SUnit *> &Nodes) {
 944       for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
 945         Queue.push(Nodes[i]);
 946     }
 947
 948     SUnit *pop() {
 949       SUnit *V = Queue.top();
 950       Queue.pop();
 951       return V;
 952     }
 953
 954     /// RemoveFromPriorityQueue - This is a really inefficient way to remove a
 955     /// node from a priority queue.  We should roll our own heap to make this
 956     /// better or something.
 957     void RemoveFromPriorityQueue(SUnit *SU) {
 958       std::vector<SUnit*> Temp;
 959
 960       assert(!Queue.empty() && "Not in queue!");
 961       while (Queue.top() != SU) {
 962         Temp.push_back(Queue.top());
 963         Queue.pop();
 964         assert(!Queue.empty() && "Not in queue!");
 965       }
 966
 967       // Remove the node from the PQ.
 968       Queue.pop();
 969
 970       // Add all the other nodes back.
 971       for (unsigned i = 0, e = Temp.size(); i != e; ++i)
 972         Queue.push(Temp[i]);
 973     }
 974
 975   private:
 976     void AddPseudoTwoAddrDeps();
 977     void CalculatePriorities();
 978     int CalcNodePriority(const SUnit *SU);
 979   };
 980 }
 981
 982 bool ls_rr_sort::operator()(const SUnit *left, const SUnit *right) const {
 983   unsigned LeftNum  = left->NodeNum;
 984   unsigned RightNum = right->NodeNum;
 985   bool LIsTarget = left->Node->isTargetOpcode();
 986   bool RIsTarget = right->Node->isTargetOpcode();
 987   int LPriority = SPQ->getSethiUllmanNumber(LeftNum);
 988   int RPriority = SPQ->getSethiUllmanNumber(RightNum);
 989   bool LIsFloater = LIsTarget && (LPriority == 1 || LPriority == 0);
 990   bool RIsFloater = RIsTarget && (RPriority == 1 || RPriority == 0);
 991   int LBonus = 0;
 992   int RBonus = 0;
 993
 994   // Schedule floaters (e.g. load from some constant address) and those nodes
 995   // with a single predecessor each first. They maintain / reduce register
 996   // pressure.
 997   if (LIsFloater)
 998     LBonus += 2;
 999   if (RIsFloater)
1000     RBonus += 2;
1001
1002   if (!SchedLowerDefNUse) {
1003     // Special tie breaker: if two nodes share a operand, the one that use it
1004     // as a def&use operand is preferred.
1005     if (LIsTarget && RIsTarget) {
1006       if (left->isTwoAddress && !right->isTwoAddress) {
1007         SDNode *DUNode = left->Node->getOperand(0).Val;
1008         if (DUNode->isOperand(right->Node))
1009           LBonus += 2;
1010       }
1011       if (!left->isTwoAddress && right->isTwoAddress) {
1012         SDNode *DUNode = right->Node->getOperand(0).Val;
1013         if (DUNode->isOperand(left->Node))
1014           RBonus += 2;
1015       }
1016     }
1017   }
1018
1019   if (LPriority+LBonus < RPriority+RBonus)
1020     return true;
1021   else if (LPriority+LBonus == RPriority+RBonus)
1022     if (left->NumPredsLeft > right->NumPredsLeft)
1023       return true;
1024     else if (left->NumPredsLeft+LBonus == right->NumPredsLeft+RBonus)
1025       if (left->CycleBound > right->CycleBound)
1026         return true;
1027   return false;
1028 }
1029
1030 static inline bool isCopyFromLiveIn(const SUnit *SU) {
1031   SDNode *N = SU->Node;
1032   return N->getOpcode() == ISD::CopyFromReg &&
1033     N->getOperand(N->getNumOperands()-1).getValueType() != MVT::Flag;
1034 }
1035
1036 // FIXME: This is probably too slow!
1037 static void isReachable(SUnit *SU, SUnit *TargetSU,
1038                         std::set<SUnit *> &Visited, bool &Reached) {
1039   if (Reached) return;
1040   if (SU == TargetSU) {
1041     Reached = true;
1042     return;
1043   }
1044   if (!Visited.insert(SU).second) return;
1045
1046   for (std::set<std::pair<SUnit*, bool> >::iterator I = SU->Preds.begin(),
1047          E = SU->Preds.end(); I != E; ++I)
1048     isReachable(I->first, TargetSU, Visited, Reached);
1049 }
1050
1051 static bool isReachable(SUnit *SU, SUnit *TargetSU) {
1052   std::set<SUnit *> Visited;
1053   bool Reached = false;
1054   isReachable(SU, TargetSU, Visited, Reached);
1055   return Reached;
1056 }
1057
1058 static SUnit *getDefUsePredecessor(SUnit *SU) {
1059   SDNode *DU = SU->Node->getOperand(0).Val;
1060   for (std::set<std::pair<SUnit*, bool> >::iterator
1061          I = SU->Preds.begin(), E = SU->Preds.end(); I != E; ++I) {
1062     if (I->second) continue;  // ignore chain preds
1063     SUnit *PredSU = I->first;
1064     if (PredSU->Node == DU)
1065       return PredSU;
1066   }
1067
1068   // Must be flagged.
1069   return NULL;
1070 }
1071
1072 static bool canClobber(SUnit *SU, SUnit *Op) {
1073   if (SU->isTwoAddress)
1074     return Op == getDefUsePredecessor(SU);
1075   return false;
1076 }
1077
1078 /// AddPseudoTwoAddrDeps - If two nodes share an operand and one of them uses
1079 /// it as a def&use operand. Add a pseudo control edge from it to the other
1080 /// node (if it won't create a cycle) so the two-address one will be scheduled
1081 /// first (lower in the schedule).
1082 void RegReductionPriorityQueue::AddPseudoTwoAddrDeps() {
1083   for (unsigned i = 0, e = SUnits->size(); i != e; ++i) {
1084     SUnit *SU = (SUnit *)&((*SUnits)[i]);
1085     SDNode *Node = SU->Node;
1086     if (!Node->isTargetOpcode())
1087       continue;
1088
1089     if (SU->isTwoAddress) {
1090       unsigned Depth = SU->Node->getNodeDepth();
1091       SUnit *DUSU = getDefUsePredecessor(SU);
1092       if (!DUSU) continue;
1093
1094       for (std::set<std::pair<SUnit*, bool> >::iterator I = DUSU->Succs.begin(),
1095              E = DUSU->Succs.end(); I != E; ++I) {
1096         SUnit *SuccSU = I->first;
1097         if (SuccSU != SU && !canClobber(SuccSU, DUSU)) {
1098           if (SuccSU->Node->getNodeDepth() <= Depth+2 &&
1099               !isReachable(SuccSU, SU)) {
1100             DEBUG(std::cerr << "Adding an edge from SU # " << SU->NodeNum
1101                   << " to SU #" << SuccSU->NodeNum << "\n");
1102             if (SU->Preds.insert(std::make_pair(SuccSU, true)).second)
1103               SU->NumChainPredsLeft++;
1104             if (SuccSU->Succs.insert(std::make_pair(SU, true)).second)
1105               SuccSU->NumChainSuccsLeft++;
1106           }
1107         }
1108       }
1109     }
1110   }
1111 }
1112
1113 /// CalcNodePriority - Priority is the Sethi Ullman number.
1114 /// Smaller number is the higher priority.
1115 int RegReductionPriorityQueue::CalcNodePriority(const SUnit *SU) {
1116   int &SethiUllmanNumber = SethiUllmanNumbers[SU->NodeNum];
1117   if (SethiUllmanNumber != 0)
1118     return SethiUllmanNumber;
1119
1120   unsigned Opc = SU->Node->getOpcode();
1121   if (Opc == ISD::TokenFactor || Opc == ISD::CopyToReg)
1122     SethiUllmanNumber = INT_MAX - 10;
1123   else if (SU->NumSuccsLeft == 0)
1124     // If SU does not have a use, i.e. it doesn't produce a value that would
1125     // be consumed (e.g. store), then it terminates a chain of computation.
1126     // Give it a small SethiUllman number so it will be scheduled right before its
1127     // predecessors that it doesn't lengthen their live ranges.
1128     SethiUllmanNumber = INT_MIN + 10;
1129   else if (SU->NumPredsLeft == 0 &&
1130            (Opc != ISD::CopyFromReg || isCopyFromLiveIn(SU)))
1131     SethiUllmanNumber = 1;
1132   else {
1133     int Extra = 0;
1134     for (std::set<std::pair<SUnit*, bool> >::const_iterator
1135          I = SU->Preds.begin(), E = SU->Preds.end(); I != E; ++I) {
1136       if (I->second) continue;  // ignore chain preds
1137       SUnit *PredSU = I->first;
1138       int PredSethiUllman = CalcNodePriority(PredSU);
1139       if (PredSethiUllman > SethiUllmanNumber) {
1140         SethiUllmanNumber = PredSethiUllman;
1141         Extra = 0;
1142       } else if (PredSethiUllman == SethiUllmanNumber && !I->second)
1143         Extra++;
1144     }
1145
1146     SethiUllmanNumber += Extra;
1147   }
1148
1149   return SethiUllmanNumber;
1150 }
1151
1152 /// CalculatePriorities - Calculate priorities of all scheduling units.
1153 void RegReductionPriorityQueue::CalculatePriorities() {
1154   SethiUllmanNumbers.assign(SUnits->size(), 0);
1155
1156   for (unsigned i = 0, e = SUnits->size(); i != e; ++i)
1157     CalcNodePriority(&(*SUnits)[i]);
1158 }
1159
1160 //===----------------------------------------------------------------------===//
1161 //                    LatencyPriorityQueue Implementation
1162 //===----------------------------------------------------------------------===//
1163 //
1164 // This is a SchedulingPriorityQueue that schedules using latency information to
1165 // reduce the length of the critical path through the basic block.
1166 //
1167 namespace {
1168   class LatencyPriorityQueue;
1169
1170   /// Sorting functions for the Available queue.
1171   struct latency_sort : public std::binary_function<SUnit*, SUnit*, bool> {
1172     LatencyPriorityQueue *PQ;
1173     latency_sort(LatencyPriorityQueue *pq) : PQ(pq) {}
1174     latency_sort(const latency_sort &RHS) : PQ(RHS.PQ) {}
1175
1176     bool operator()(const SUnit* left, const SUnit* right) const;
1177   };
1178 }  // end anonymous namespace
1179
1180 namespace {
1181   class LatencyPriorityQueue : public SchedulingPriorityQueue {
1182     // SUnits - The SUnits for the current graph.
1183     const std::vector<SUnit> *SUnits;
1184
1185     // Latencies - The latency (max of latency from this node to the bb exit)
1186     // for each node.
1187     std::vector<int> Latencies;
1188
1189     /// NumNodesSolelyBlocking - This vector contains, for every node in the
1190     /// Queue, the number of nodes that the node is the sole unscheduled
1191     /// predecessor for.  This is used as a tie-breaker heuristic for better
1192     /// mobility.
1193     std::vector<unsigned> NumNodesSolelyBlocking;
1194
1195     std::priority_queue<SUnit*, std::vector<SUnit*>, latency_sort> Queue;
1196 public:
1197     LatencyPriorityQueue() : Queue(latency_sort(this)) {
1198     }
1199
1200     void initNodes(const std::vector<SUnit> &sunits) {
1201       SUnits = &sunits;
1202       // Calculate node priorities.
1203       CalculatePriorities();
1204     }
1205     void releaseState() {
1206       SUnits = 0;
1207       Latencies.clear();
1208     }
1209
1210     unsigned getLatency(unsigned NodeNum) const {
1211       assert(NodeNum < Latencies.size());
1212       return Latencies[NodeNum];
1213     }
1214
1215     unsigned getNumSolelyBlockNodes(unsigned NodeNum) const {
1216       assert(NodeNum < NumNodesSolelyBlocking.size());
1217       return NumNodesSolelyBlocking[NodeNum];
1218     }
1219
1220     bool empty() const { return Queue.empty(); }
1221
1222     virtual void push(SUnit *U) {
1223       push_impl(U);
1224     }
1225     void push_impl(SUnit *U);
1226
1227     void push_all(const std::vector<SUnit *> &Nodes) {
1228       for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
1229         push_impl(Nodes[i]);
1230     }
1231
1232     SUnit *pop() {
1233       SUnit *V = Queue.top();
1234       Queue.pop();
1235       return V;
1236     }
1237
1238     /// RemoveFromPriorityQueue - This is a really inefficient way to remove a
1239     /// node from a priority queue.  We should roll our own heap to make this
1240     /// better or something.
1241     void RemoveFromPriorityQueue(SUnit *SU) {
1242       std::vector<SUnit*> Temp;
1243
1244       assert(!Queue.empty() && "Not in queue!");
1245       while (Queue.top() != SU) {
1246         Temp.push_back(Queue.top());
1247         Queue.pop();
1248         assert(!Queue.empty() && "Not in queue!");
1249       }
1250
1251       // Remove the node from the PQ.
1252       Queue.pop();
1253
1254       // Add all the other nodes back.
1255       for (unsigned i = 0, e = Temp.size(); i != e; ++i)
1256         Queue.push(Temp[i]);
1257     }
1258
1259     // ScheduledNode - As nodes are scheduled, we look to see if there are any
1260     // successor nodes that have a single unscheduled predecessor.  If so, that
1261     // single predecessor has a higher priority, since scheduling it will make
1262     // the node available.
1263     void ScheduledNode(SUnit *Node);
1264
1265 private:
1266     void CalculatePriorities();
1267     int CalcLatency(const SUnit &SU);
1268     void AdjustPriorityOfUnscheduledPreds(SUnit *SU);
1269   };
1270 }
1271
1272 bool latency_sort::operator()(const SUnit *LHS, const SUnit *RHS) const {
1273   unsigned LHSNum = LHS->NodeNum;
1274   unsigned RHSNum = RHS->NodeNum;
1275
1276   // The most important heuristic is scheduling the critical path.
1277   unsigned LHSLatency = PQ->getLatency(LHSNum);
1278   unsigned RHSLatency = PQ->getLatency(RHSNum);
1279   if (LHSLatency < RHSLatency) return true;
1280   if (LHSLatency > RHSLatency) return false;
1281
1282   // After that, if two nodes have identical latencies, look to see if one will
1283   // unblock more other nodes than the other.
1284   unsigned LHSBlocked = PQ->getNumSolelyBlockNodes(LHSNum);
1285   unsigned RHSBlocked = PQ->getNumSolelyBlockNodes(RHSNum);
1286   if (LHSBlocked < RHSBlocked) return true;
1287   if (LHSBlocked > RHSBlocked) return false;
1288
1289   // Finally, just to provide a stable ordering, use the node number as a
1290   // deciding factor.
1291   return LHSNum < RHSNum;
1292 }
1293
1294
1295 /// CalcNodePriority - Calculate the maximal path from the node to the exit.
1296 ///
1297 int LatencyPriorityQueue::CalcLatency(const SUnit &SU) {
1298   int &Latency = Latencies[SU.NodeNum];
1299   if (Latency != -1)
1300     return Latency;
1301
1302   int MaxSuccLatency = 0;
1303   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU.Succs.begin(),
1304        E = SU.Succs.end(); I != E; ++I)
1305     MaxSuccLatency = std::max(MaxSuccLatency, CalcLatency(*I->first));
1306
1307   return Latency = MaxSuccLatency + SU.Latency;
1308 }
1309
1310 /// CalculatePriorities - Calculate priorities of all scheduling units.
1311 void LatencyPriorityQueue::CalculatePriorities() {
1312   Latencies.assign(SUnits->size(), -1);
1313   NumNodesSolelyBlocking.assign(SUnits->size(), 0);
1314
1315   for (unsigned i = 0, e = SUnits->size(); i != e; ++i)
1316     CalcLatency((*SUnits)[i]);
1317 }
1318
1319 /// getSingleUnscheduledPred - If there is exactly one unscheduled predecessor
1320 /// of SU, return it, otherwise return null.
1321 static SUnit *getSingleUnscheduledPred(SUnit *SU) {
1322   SUnit *OnlyAvailablePred = 0;
1323   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Preds.begin(),
1324        E = SU->Preds.end(); I != E; ++I)
1325     if (!I->first->isScheduled) {
1326       // We found an available, but not scheduled, predecessor.  If it's the
1327       // only one we have found, keep track of it... otherwise give up.
1328       if (OnlyAvailablePred && OnlyAvailablePred != I->first)
1329         return 0;
1330       OnlyAvailablePred = I->first;
1331     }
1332
1333   return OnlyAvailablePred;
1334 }
1335
1336 void LatencyPriorityQueue::push_impl(SUnit *SU) {
1337   // Look at all of the successors of this node.  Count the number of nodes that
1338   // this node is the sole unscheduled node for.
1339   unsigned NumNodesBlocking = 0;
1340   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Succs.begin(),
1341        E = SU->Succs.end(); I != E; ++I)
1342     if (getSingleUnscheduledPred(I->first) == SU)
1343       ++NumNodesBlocking;
1344   NumNodesSolelyBlocking[SU->NodeNum] = NumNodesBlocking;
1345
1346   Queue.push(SU);
1347 }
1348
1349
1350 // ScheduledNode - As nodes are scheduled, we look to see if there are any
1351 // successor nodes that have a single unscheduled predecessor.  If so, that
1352 // single predecessor has a higher priority, since scheduling it will make
1353 // the node available.
1354 void LatencyPriorityQueue::ScheduledNode(SUnit *SU) {
1355   for (std::set<std::pair<SUnit*, bool> >::const_iterator I = SU->Succs.begin(),
1356        E = SU->Succs.end(); I != E; ++I)
1357     AdjustPriorityOfUnscheduledPreds(I->first);
1358 }
1359
1360 /// AdjustPriorityOfUnscheduledPreds - One of the predecessors of SU was just
1361 /// scheduled.  If SU is not itself available, then there is at least one
1362 /// predecessor node that has not been scheduled yet.  If SU has exactly ONE
1363 /// unscheduled predecessor, we want to increase its priority: it getting
1364 /// scheduled will make this node available, so it is better than some other
1365 /// node of the same priority that will not make a node available.
1366 void LatencyPriorityQueue::AdjustPriorityOfUnscheduledPreds(SUnit *SU) {
1367   if (SU->isPending) return;  // All preds scheduled.
1368
1369   SUnit *OnlyAvailablePred = getSingleUnscheduledPred(SU);
1370   if (OnlyAvailablePred == 0 || !OnlyAvailablePred->isAvailable) return;
1371
1372   // Okay, we found a single predecessor that is available, but not scheduled.
1373   // Since it is available, it must be in the priority queue.  First remove it.
1374   RemoveFromPriorityQueue(OnlyAvailablePred);
1375
1376   // Reinsert the node into the priority queue, which recomputes its
1377   // NumNodesSolelyBlocking value.
1378   push(OnlyAvailablePred);
1379 }
1380
1381
1382 //===----------------------------------------------------------------------===//
1383 //                         Public Constructor Functions
1384 //===----------------------------------------------------------------------===//
1385
1386 llvm::ScheduleDAG* llvm::createBURRListDAGScheduler(SelectionDAG &DAG,
1387                                                     MachineBasicBlock *BB) {
1388   return new ScheduleDAGList(DAG, BB, DAG.getTarget(), true,
1389                              new RegReductionPriorityQueue(),
1390                              new HazardRecognizer());
1391 }
1392
1393 /// createTDListDAGScheduler - This creates a top-down list scheduler with the
1394 /// specified hazard recognizer.
1395 ScheduleDAG* llvm::createTDListDAGScheduler(SelectionDAG &DAG,
1396                                             MachineBasicBlock *BB,
1397                                             HazardRecognizer *HR) {
1398   return new ScheduleDAGList(DAG, BB, DAG.getTarget(), false,
1399                              new LatencyPriorityQueue(),
1400                              HR);
1401 }