lib/CodeGen/SelectionDAG/ScheduleDAGRRList.cpp

   1 //===----- ScheduleDAGRRList.cpp - Reg pressure reduction list scheduler --===//
   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 bottom-up and top-down register pressure reduction list
  11 // schedulers, using standard algorithms.  The basic approach uses a priority
  12 // queue of available nodes to schedule.  One at a time, nodes are taken from
  13 // the priority queue (thus in priority order), checked for legality to
  14 // schedule, and emitted if legal.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #define DEBUG_TYPE "pre-RA-sched"
  19 #include "llvm/CodeGen/ScheduleDAG.h"
  20 #include "llvm/CodeGen/SchedulerRegistry.h"
  21 #include "llvm/Target/TargetRegisterInfo.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include "llvm/Target/TargetInstrInfo.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/Compiler.h"
  27 #include "llvm/ADT/BitVector.h"
  28 #include "llvm/ADT/PriorityQueue.h"
  29 #include "llvm/ADT/SmallPtrSet.h"
  30 #include "llvm/ADT/SmallSet.h"
  31 #include "llvm/ADT/Statistic.h"
  32 #include "llvm/ADT/STLExtras.h"
  33 #include <climits>
  34 #include "llvm/Support/CommandLine.h"
  35 using namespace llvm;
  36
  37 STATISTIC(NumBacktracks, "Number of times scheduler backtracked");
  38 STATISTIC(NumUnfolds,    "Number of nodes unfolded");
  39 STATISTIC(NumDups,       "Number of duplicated nodes");
  40 STATISTIC(NumCCCopies,   "Number of cross class copies");
  41
  42 static RegisterScheduler
  43   burrListDAGScheduler("list-burr",
  44                        "Bottom-up register reduction list scheduling",
  45                        createBURRListDAGScheduler);
  46 static RegisterScheduler
  47   tdrListrDAGScheduler("list-tdrr",
  48                        "Top-down register reduction list scheduling",
  49                        createTDRRListDAGScheduler);
  50
  51 namespace {
  52 //===----------------------------------------------------------------------===//
  53 /// ScheduleDAGRRList - The actual register reduction list scheduler
  54 /// implementation.  This supports both top-down and bottom-up scheduling.
  55 ///
  56 class VISIBILITY_HIDDEN ScheduleDAGRRList : public ScheduleDAG {
  57 private:
  58   /// isBottomUp - This is true if the scheduling problem is bottom-up, false if
  59   /// it is top-down.
  60   bool isBottomUp;
  61
  62   /// Fast - True if we are performing fast scheduling.
  63   ///
  64   bool Fast;
  65
  66   /// AvailableQueue - The priority queue to use for the available SUnits.
  67   SchedulingPriorityQueue *AvailableQueue;
  68
  69   /// LiveRegDefs - A set of physical registers and their definition
  70   /// that are "live". These nodes must be scheduled before any other nodes that
  71   /// modifies the registers can be scheduled.
  72   unsigned NumLiveRegs;
  73   std::vector<SUnit*> LiveRegDefs;
  74   std::vector<unsigned> LiveRegCycles;
  75
  76 public:
  77   ScheduleDAGRRList(SelectionDAG &dag, MachineBasicBlock *bb,
  78                     const TargetMachine &tm, bool isbottomup, bool f,
  79                     SchedulingPriorityQueue *availqueue)
  80     : ScheduleDAG(dag, bb, tm), isBottomUp(isbottomup), Fast(f),
  81       AvailableQueue(availqueue) {
  82     }
  83
  84   ~ScheduleDAGRRList() {
  85     delete AvailableQueue;
  86   }
  87
  88   void Schedule();
  89
  90   /// IsReachable - Checks if SU is reachable from TargetSU.
  91   bool IsReachable(const SUnit *SU, const SUnit *TargetSU);
  92
  93   /// willCreateCycle - Returns true if adding an edge from SU to TargetSU will
  94   /// create a cycle.
  95   bool WillCreateCycle(SUnit *SU, SUnit *TargetSU);
  96
  97   /// AddPred - This adds the specified node X as a predecessor of
  98   /// the current node Y if not already.
  99   /// This returns true if this is a new predecessor.
 100   /// Updates the topological ordering if required.
 101   bool AddPred(SUnit *Y, SUnit *X, bool isCtrl, bool isSpecial,
 102                unsigned PhyReg = 0, int Cost = 1);
 103
 104   /// RemovePred - This removes the specified node N from the predecessors of
 105   /// the current node M. Updates the topological ordering if required.
 106   bool RemovePred(SUnit *M, SUnit *N, bool isCtrl, bool isSpecial);
 107
 108 private:
 109   void ReleasePred(SUnit*, bool, unsigned);
 110   void ReleaseSucc(SUnit*, bool isChain, unsigned);
 111   void CapturePred(SUnit*, SUnit*, bool);
 112   void ScheduleNodeBottomUp(SUnit*, unsigned);
 113   void ScheduleNodeTopDown(SUnit*, unsigned);
 114   void UnscheduleNodeBottomUp(SUnit*);
 115   void BacktrackBottomUp(SUnit*, unsigned, unsigned&);
 116   SUnit *CopyAndMoveSuccessors(SUnit*);
 117   void InsertCCCopiesAndMoveSuccs(SUnit*, unsigned,
 118                                   const TargetRegisterClass*,
 119                                   const TargetRegisterClass*,
 120                                   SmallVector<SUnit*, 2>&);
 121   bool DelayForLiveRegsBottomUp(SUnit*, SmallVector<unsigned, 4>&);
 122   void ListScheduleTopDown();
 123   void ListScheduleBottomUp();
 124   void CommuteNodesToReducePressure();
 125
 126
 127   /// CreateNewSUnit - Creates a new SUnit and returns a pointer to it.
 128   /// Updates the topological ordering if required.
 129   SUnit *CreateNewSUnit(SDNode *N) {
 130     SUnit *NewNode = NewSUnit(N);
 131     // Update the topological ordering.
 132     if (NewNode->NodeNum >= Node2Index.size())
 133       InitDAGTopologicalSorting();
 134     return NewNode;
 135   }
 136
 137   /// CreateClone - Creates a new SUnit from an existing one.
 138   /// Updates the topological ordering if required.
 139   SUnit *CreateClone(SUnit *N) {
 140     SUnit *NewNode = Clone(N);
 141     // Update the topological ordering.
 142     if (NewNode->NodeNum >= Node2Index.size())
 143       InitDAGTopologicalSorting();
 144     return NewNode;
 145   }
 146
 147   /// Functions for preserving the topological ordering
 148   /// even after dynamic insertions of new edges.
 149   /// This allows a very fast implementation of IsReachable.
 150
 151   /// InitDAGTopologicalSorting - create the initial topological
 152   /// ordering from the DAG to be scheduled.
 153   void InitDAGTopologicalSorting();
 154
 155   /// DFS - make a DFS traversal and mark all nodes affected by the
 156   /// edge insertion. These nodes will later get new topological indexes
 157   /// by means of the Shift method.
 158   void DFS(const SUnit *SU, int UpperBound, bool& HasLoop);
 159
 160   /// Shift - reassign topological indexes for the nodes in the DAG
 161   /// to preserve the topological ordering.
 162   void Shift(BitVector& Visited, int LowerBound, int UpperBound);
 163
 164   /// Allocate - assign the topological index to the node n.
 165   void Allocate(int n, int index);
 166
 167   /// Index2Node - Maps topological index to the node number.
 168   std::vector<int> Index2Node;
 169   /// Node2Index - Maps the node number to its topological index.
 170   std::vector<int> Node2Index;
 171   /// Visited - a set of nodes visited during a DFS traversal.
 172   BitVector Visited;
 173 };
 174 }  // end anonymous namespace
 175
 176
 177 /// Schedule - Schedule the DAG using list scheduling.
 178 void ScheduleDAGRRList::Schedule() {
 179   DOUT << "********** List Scheduling **********\n";
 180
 181   NumLiveRegs = 0;
 182   LiveRegDefs.resize(TRI->getNumRegs(), NULL);
 183   LiveRegCycles.resize(TRI->getNumRegs(), 0);
 184
 185   // Build scheduling units.
 186   BuildSchedUnits();
 187
 188   DEBUG(for (unsigned su = 0, e = SUnits.size(); su != e; ++su)
 189           SUnits[su].dumpAll(&DAG));
 190   if (!Fast) {
 191     CalculateDepths();
 192     CalculateHeights();
 193   }
 194   InitDAGTopologicalSorting();
 195
 196   AvailableQueue->initNodes(SUnits);
 197
 198   // Execute the actual scheduling loop Top-Down or Bottom-Up as appropriate.
 199   if (isBottomUp)
 200     ListScheduleBottomUp();
 201   else
 202     ListScheduleTopDown();
 203
 204   AvailableQueue->releaseState();
 205
 206   if (!Fast)
 207     CommuteNodesToReducePressure();
 208 }
 209
 210 /// CommuteNodesToReducePressure - If a node is two-address and commutable, and
 211 /// it is not the last use of its first operand, add it to the CommuteSet if
 212 /// possible. It will be commuted when it is translated to a MI.
 213 void ScheduleDAGRRList::CommuteNodesToReducePressure() {
 214   SmallPtrSet<SUnit*, 4> OperandSeen;
 215   for (unsigned i = Sequence.size(); i != 0; ) {
 216     --i;
 217     SUnit *SU = Sequence[i];
 218     if (!SU || !SU->Node) continue;
 219     if (SU->isCommutable) {
 220       unsigned Opc = SU->Node->getMachineOpcode();
 221       const TargetInstrDesc &TID = TII->get(Opc);
 222       unsigned NumRes = TID.getNumDefs();
 223       unsigned NumOps = TID.getNumOperands() - NumRes;
 224       for (unsigned j = 0; j != NumOps; ++j) {
 225         if (TID.getOperandConstraint(j+NumRes, TOI::TIED_TO) == -1)
 226           continue;
 227
 228         SDNode *OpN = SU->Node->getOperand(j).getNode();
 229         SUnit *OpSU = isPassiveNode(OpN) ? NULL : &SUnits[OpN->getNodeId()];
 230         if (OpSU && OperandSeen.count(OpSU) == 1) {
 231           // Ok, so SU is not the last use of OpSU, but SU is two-address so
 232           // it will clobber OpSU. Try to commute SU if no other source operands
 233           // are live below.
 234           bool DoCommute = true;
 235           for (unsigned k = 0; k < NumOps; ++k) {
 236             if (k != j) {
 237               OpN = SU->Node->getOperand(k).getNode();
 238               OpSU = isPassiveNode(OpN) ? NULL : &SUnits[OpN->getNodeId()];
 239               if (OpSU && OperandSeen.count(OpSU) == 1) {
 240                 DoCommute = false;
 241                 break;
 242               }
 243             }
 244           }
 245           if (DoCommute)
 246             CommuteSet.insert(SU->Node);
 247         }
 248
 249         // Only look at the first use&def node for now.
 250         break;
 251       }
 252     }
 253
 254     for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 255          I != E; ++I) {
 256       if (!I->isCtrl)
 257         OperandSeen.insert(I->Dep->OrigNode);
 258     }
 259   }
 260 }
 261
 262 //===----------------------------------------------------------------------===//
 263 //  Bottom-Up Scheduling
 264 //===----------------------------------------------------------------------===//
 265
 266 /// ReleasePred - Decrement the NumSuccsLeft count of a predecessor. Add it to
 267 /// the AvailableQueue if the count reaches zero. Also update its cycle bound.
 268 void ScheduleDAGRRList::ReleasePred(SUnit *PredSU, bool isChain,
 269                                     unsigned CurCycle) {
 270   // FIXME: the distance between two nodes is not always == the predecessor's
 271   // latency. For example, the reader can very well read the register written
 272   // by the predecessor later than the issue cycle. It also depends on the
 273   // interrupt model (drain vs. freeze).
 274   PredSU->CycleBound = std::max(PredSU->CycleBound, CurCycle + PredSU->Latency);
 275
 276   --PredSU->NumSuccsLeft;
 277
 278 #ifndef NDEBUG
 279   if (PredSU->NumSuccsLeft < 0) {
 280     cerr << "*** List scheduling failed! ***\n";
 281     PredSU->dump(&DAG);
 282     cerr << " has been released too many times!\n";
 283     assert(0);
 284   }
 285 #endif
 286
 287   if (PredSU->NumSuccsLeft == 0) {
 288     PredSU->isAvailable = true;
 289     AvailableQueue->push(PredSU);
 290   }
 291 }
 292
 293 /// ScheduleNodeBottomUp - Add the node to the schedule. Decrement the pending
 294 /// count of its predecessors. If a predecessor pending count is zero, add it to
 295 /// the Available queue.
 296 void ScheduleDAGRRList::ScheduleNodeBottomUp(SUnit *SU, unsigned CurCycle) {
 297   DOUT << "*** Scheduling [" << CurCycle << "]: ";
 298   DEBUG(SU->dump(&DAG));
 299   SU->Cycle = CurCycle;
 300
 301   AvailableQueue->ScheduledNode(SU);
 302
 303   // Bottom up: release predecessors
 304   for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 305        I != E; ++I) {
 306     ReleasePred(I->Dep, I->isCtrl, CurCycle);
 307     if (I->Cost < 0)  {
 308       // This is a physical register dependency and it's impossible or
 309       // expensive to copy the register. Make sure nothing that can
 310       // clobber the register is scheduled between the predecessor and
 311       // this node.
 312       if (!LiveRegDefs[I->Reg]) {
 313         ++NumLiveRegs;
 314         LiveRegDefs[I->Reg] = I->Dep;
 315         LiveRegCycles[I->Reg] = CurCycle;
 316       }
 317     }
 318   }
 319
 320   // Release all the implicit physical register defs that are live.
 321   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
 322        I != E; ++I) {
 323     if (I->Cost < 0)  {
 324       if (LiveRegCycles[I->Reg] == I->Dep->Cycle) {
 325         assert(NumLiveRegs > 0 && "NumLiveRegs is already zero!");
 326         assert(LiveRegDefs[I->Reg] == SU &&
 327                "Physical register dependency violated?");
 328         --NumLiveRegs;
 329         LiveRegDefs[I->Reg] = NULL;
 330         LiveRegCycles[I->Reg] = 0;
 331       }
 332     }
 333   }
 334
 335   SU->isScheduled = true;
 336 }
 337
 338 /// CapturePred - This does the opposite of ReleasePred. Since SU is being
 339 /// unscheduled, incrcease the succ left count of its predecessors. Remove
 340 /// them from AvailableQueue if necessary.
 341 void ScheduleDAGRRList::CapturePred(SUnit *PredSU, SUnit *SU, bool isChain) {
 342   unsigned CycleBound = 0;
 343   for (SUnit::succ_iterator I = PredSU->Succs.begin(), E = PredSU->Succs.end();
 344        I != E; ++I) {
 345     if (I->Dep == SU)
 346       continue;
 347     CycleBound = std::max(CycleBound,
 348                           I->Dep->Cycle + PredSU->Latency);
 349   }
 350
 351   if (PredSU->isAvailable) {
 352     PredSU->isAvailable = false;
 353     if (!PredSU->isPending)
 354       AvailableQueue->remove(PredSU);
 355   }
 356
 357   PredSU->CycleBound = CycleBound;
 358   ++PredSU->NumSuccsLeft;
 359 }
 360
 361 /// UnscheduleNodeBottomUp - Remove the node from the schedule, update its and
 362 /// its predecessor states to reflect the change.
 363 void ScheduleDAGRRList::UnscheduleNodeBottomUp(SUnit *SU) {
 364   DOUT << "*** Unscheduling [" << SU->Cycle << "]: ";
 365   DEBUG(SU->dump(&DAG));
 366
 367   AvailableQueue->UnscheduledNode(SU);
 368
 369   for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 370        I != E; ++I) {
 371     CapturePred(I->Dep, SU, I->isCtrl);
 372     if (I->Cost < 0 && SU->Cycle == LiveRegCycles[I->Reg])  {
 373       assert(NumLiveRegs > 0 && "NumLiveRegs is already zero!");
 374       assert(LiveRegDefs[I->Reg] == I->Dep &&
 375              "Physical register dependency violated?");
 376       --NumLiveRegs;
 377       LiveRegDefs[I->Reg] = NULL;
 378       LiveRegCycles[I->Reg] = 0;
 379     }
 380   }
 381
 382   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
 383        I != E; ++I) {
 384     if (I->Cost < 0)  {
 385       if (!LiveRegDefs[I->Reg]) {
 386         LiveRegDefs[I->Reg] = SU;
 387         ++NumLiveRegs;
 388       }
 389       if (I->Dep->Cycle < LiveRegCycles[I->Reg])
 390         LiveRegCycles[I->Reg] = I->Dep->Cycle;
 391     }
 392   }
 393
 394   SU->Cycle = 0;
 395   SU->isScheduled = false;
 396   SU->isAvailable = true;
 397   AvailableQueue->push(SU);
 398 }
 399
 400 /// IsReachable - Checks if SU is reachable from TargetSU.
 401 bool ScheduleDAGRRList::IsReachable(const SUnit *SU, const SUnit *TargetSU) {
 402   // If insertion of the edge SU->TargetSU would create a cycle
 403   // then there is a path from TargetSU to SU.
 404   int UpperBound, LowerBound;
 405   LowerBound = Node2Index[TargetSU->NodeNum];
 406   UpperBound = Node2Index[SU->NodeNum];
 407   bool HasLoop = false;
 408   // Is Ord(TargetSU) < Ord(SU) ?
 409   if (LowerBound < UpperBound) {
 410     Visited.reset();
 411     // There may be a path from TargetSU to SU. Check for it.
 412     DFS(TargetSU, UpperBound, HasLoop);
 413   }
 414   return HasLoop;
 415 }
 416
 417 /// Allocate - assign the topological index to the node n.
 418 inline void ScheduleDAGRRList::Allocate(int n, int index) {
 419   Node2Index[n] = index;
 420   Index2Node[index] = n;
 421 }
 422
 423 /// InitDAGTopologicalSorting - create the initial topological
 424 /// ordering from the DAG to be scheduled.
 425
 426 /// The idea of the algorithm is taken from
 427 /// "Online algorithms for managing the topological order of
 428 /// a directed acyclic graph" by David J. Pearce and Paul H.J. Kelly
 429 /// This is the MNR algorithm, which was first introduced by
 430 /// A. Marchetti-Spaccamela, U. Nanni and H. Rohnert in
 431 /// "Maintaining a topological order under edge insertions".
 432 ///
 433 /// Short description of the algorithm:
 434 ///
 435 /// Topological ordering, ord, of a DAG maps each node to a topological
 436 /// index so that for all edges X->Y it is the case that ord(X) < ord(Y).
 437 ///
 438 /// This means that if there is a path from the node X to the node Z,
 439 /// then ord(X) < ord(Z).
 440 ///
 441 /// This property can be used to check for reachability of nodes:
 442 /// if Z is reachable from X, then an insertion of the edge Z->X would
 443 /// create a cycle.
 444 ///
 445 /// The algorithm first computes a topological ordering for the DAG by
 446 /// initializing the Index2Node and Node2Index arrays and then tries to keep
 447 /// the ordering up-to-date after edge insertions by reordering the DAG.
 448 ///
 449 /// On insertion of the edge X->Y, the algorithm first marks by calling DFS
 450 /// the nodes reachable from Y, and then shifts them using Shift to lie
 451 /// immediately after X in Index2Node.
 452 void ScheduleDAGRRList::InitDAGTopologicalSorting() {
 453   unsigned DAGSize = SUnits.size();
 454   std::vector<SUnit*> WorkList;
 455   WorkList.reserve(DAGSize);
 456
 457   Index2Node.resize(DAGSize);
 458   Node2Index.resize(DAGSize);
 459
 460   // Initialize the data structures.
 461   for (unsigned i = 0, e = DAGSize; i != e; ++i) {
 462     SUnit *SU = &SUnits[i];
 463     int NodeNum = SU->NodeNum;
 464     unsigned Degree = SU->Succs.size();
 465     // Temporarily use the Node2Index array as scratch space for degree counts.
 466     Node2Index[NodeNum] = Degree;
 467
 468     // Is it a node without dependencies?
 469     if (Degree == 0) {
 470         assert(SU->Succs.empty() && "SUnit should have no successors");
 471         // Collect leaf nodes.
 472         WorkList.push_back(SU);
 473     }
 474   }
 475
 476   int Id = DAGSize;
 477   while (!WorkList.empty()) {
 478     SUnit *SU = WorkList.back();
 479     WorkList.pop_back();
 480     Allocate(SU->NodeNum, --Id);
 481     for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 482          I != E; ++I) {
 483       SUnit *SU = I->Dep;
 484       if (!--Node2Index[SU->NodeNum])
 485         // If all dependencies of the node are processed already,
 486         // then the node can be computed now.
 487         WorkList.push_back(SU);
 488     }
 489   }
 490
 491   Visited.resize(DAGSize);
 492
 493 #ifndef NDEBUG
 494   // Check correctness of the ordering
 495   for (unsigned i = 0, e = DAGSize; i != e; ++i) {
 496     SUnit *SU = &SUnits[i];
 497     for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 498          I != E; ++I) {
 499        assert(Node2Index[SU->NodeNum] > Node2Index[I->Dep->NodeNum] &&
 500        "Wrong topological sorting");
 501     }
 502   }
 503 #endif
 504 }
 505
 506 /// AddPred - adds an edge from SUnit X to SUnit Y.
 507 /// Updates the topological ordering if required.
 508 bool ScheduleDAGRRList::AddPred(SUnit *Y, SUnit *X, bool isCtrl, bool isSpecial,
 509                  unsigned PhyReg, int Cost) {
 510   int UpperBound, LowerBound;
 511   LowerBound = Node2Index[Y->NodeNum];
 512   UpperBound = Node2Index[X->NodeNum];
 513   bool HasLoop = false;
 514   // Is Ord(X) < Ord(Y) ?
 515   if (LowerBound < UpperBound) {
 516     // Update the topological order.
 517     Visited.reset();
 518     DFS(Y, UpperBound, HasLoop);
 519     assert(!HasLoop && "Inserted edge creates a loop!");
 520     // Recompute topological indexes.
 521     Shift(Visited, LowerBound, UpperBound);
 522   }
 523   // Now really insert the edge.
 524   return Y->addPred(X, isCtrl, isSpecial, PhyReg, Cost);
 525 }
 526
 527 /// RemovePred - This removes the specified node N from the predecessors of
 528 /// the current node M. Updates the topological ordering if required.
 529 bool ScheduleDAGRRList::RemovePred(SUnit *M, SUnit *N,
 530                                    bool isCtrl, bool isSpecial) {
 531   // InitDAGTopologicalSorting();
 532   return M->removePred(N, isCtrl, isSpecial);
 533 }
 534
 535 /// DFS - Make a DFS traversal to mark all nodes reachable from SU and mark
 536 /// all nodes affected by the edge insertion. These nodes will later get new
 537 /// topological indexes by means of the Shift method.
 538 void ScheduleDAGRRList::DFS(const SUnit *SU, int UpperBound, bool& HasLoop) {
 539   std::vector<const SUnit*> WorkList;
 540   WorkList.reserve(SUnits.size());
 541
 542   WorkList.push_back(SU);
 543   while (!WorkList.empty()) {
 544     SU = WorkList.back();
 545     WorkList.pop_back();
 546     Visited.set(SU->NodeNum);
 547     for (int I = SU->Succs.size()-1; I >= 0; --I) {
 548       int s = SU->Succs[I].Dep->NodeNum;
 549       if (Node2Index[s] == UpperBound) {
 550         HasLoop = true;
 551         return;
 552       }
 553       // Visit successors if not already and in affected region.
 554       if (!Visited.test(s) && Node2Index[s] < UpperBound) {
 555         WorkList.push_back(SU->Succs[I].Dep);
 556       }
 557     }
 558   }
 559 }
 560
 561 /// Shift - Renumber the nodes so that the topological ordering is
 562 /// preserved.
 563 void ScheduleDAGRRList::Shift(BitVector& Visited, int LowerBound,
 564                               int UpperBound) {
 565   std::vector<int> L;
 566   int shift = 0;
 567   int i;
 568
 569   for (i = LowerBound; i <= UpperBound; ++i) {
 570     // w is node at topological index i.
 571     int w = Index2Node[i];
 572     if (Visited.test(w)) {
 573       // Unmark.
 574       Visited.reset(w);
 575       L.push_back(w);
 576       shift = shift + 1;
 577     } else {
 578       Allocate(w, i - shift);
 579     }
 580   }
 581
 582   for (unsigned j = 0; j < L.size(); ++j) {
 583     Allocate(L[j], i - shift);
 584     i = i + 1;
 585   }
 586 }
 587
 588
 589 /// WillCreateCycle - Returns true if adding an edge from SU to TargetSU will
 590 /// create a cycle.
 591 bool ScheduleDAGRRList::WillCreateCycle(SUnit *SU, SUnit *TargetSU) {
 592   if (IsReachable(TargetSU, SU))
 593     return true;
 594   for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 595        I != E; ++I)
 596     if (I->Cost < 0 && IsReachable(TargetSU, I->Dep))
 597       return true;
 598   return false;
 599 }
 600
 601 /// BacktrackBottomUp - Backtrack scheduling to a previous cycle specified in
 602 /// BTCycle in order to schedule a specific node. Returns the last unscheduled
 603 /// SUnit. Also returns if a successor is unscheduled in the process.
 604 void ScheduleDAGRRList::BacktrackBottomUp(SUnit *SU, unsigned BtCycle,
 605                                           unsigned &CurCycle) {
 606   SUnit *OldSU = NULL;
 607   while (CurCycle > BtCycle) {
 608     OldSU = Sequence.back();
 609     Sequence.pop_back();
 610     if (SU->isSucc(OldSU))
 611       // Don't try to remove SU from AvailableQueue.
 612       SU->isAvailable = false;
 613     UnscheduleNodeBottomUp(OldSU);
 614     --CurCycle;
 615   }
 616
 617
 618   if (SU->isSucc(OldSU)) {
 619     assert(false && "Something is wrong!");
 620     abort();
 621   }
 622
 623   ++NumBacktracks;
 624 }
 625
 626 /// CopyAndMoveSuccessors - Clone the specified node and move its scheduled
 627 /// successors to the newly created node.
 628 SUnit *ScheduleDAGRRList::CopyAndMoveSuccessors(SUnit *SU) {
 629   if (SU->FlaggedNodes.size())
 630     return NULL;
 631
 632   SDNode *N = SU->Node;
 633   if (!N)
 634     return NULL;
 635
 636   SUnit *NewSU;
 637   bool TryUnfold = false;
 638   for (unsigned i = 0, e = N->getNumValues(); i != e; ++i) {
 639     MVT VT = N->getValueType(i);
 640     if (VT == MVT::Flag)
 641       return NULL;
 642     else if (VT == MVT::Other)
 643       TryUnfold = true;
 644   }
 645   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 646     const SDValue &Op = N->getOperand(i);
 647     MVT VT = Op.getNode()->getValueType(Op.getResNo());
 648     if (VT == MVT::Flag)
 649       return NULL;
 650   }
 651
 652   if (TryUnfold) {
 653     SmallVector<SDNode*, 2> NewNodes;
 654     if (!TII->unfoldMemoryOperand(DAG, N, NewNodes))
 655       return NULL;
 656
 657     DOUT << "Unfolding SU # " << SU->NodeNum << "\n";
 658     assert(NewNodes.size() == 2 && "Expected a load folding node!");
 659
 660     N = NewNodes[1];
 661     SDNode *LoadNode = NewNodes[0];
 662     unsigned NumVals = N->getNumValues();
 663     unsigned OldNumVals = SU->Node->getNumValues();
 664     for (unsigned i = 0; i != NumVals; ++i)
 665       DAG.ReplaceAllUsesOfValueWith(SDValue(SU->Node, i), SDValue(N, i));
 666     DAG.ReplaceAllUsesOfValueWith(SDValue(SU->Node, OldNumVals-1),
 667                                   SDValue(LoadNode, 1));
 668
 669     SUnit *NewSU = CreateNewSUnit(N);
 670     assert(N->getNodeId() == -1 && "Node already inserted!");
 671     N->setNodeId(NewSU->NodeNum);
 672
 673     const TargetInstrDesc &TID = TII->get(N->getMachineOpcode());
 674     for (unsigned i = 0; i != TID.getNumOperands(); ++i) {
 675       if (TID.getOperandConstraint(i, TOI::TIED_TO) != -1) {
 676         NewSU->isTwoAddress = true;
 677         break;
 678       }
 679     }
 680     if (TID.isCommutable())
 681       NewSU->isCommutable = true;
 682     // FIXME: Calculate height / depth and propagate the changes?
 683     NewSU->Depth = SU->Depth;
 684     NewSU->Height = SU->Height;
 685     ComputeLatency(NewSU);
 686
 687     // LoadNode may already exist. This can happen when there is another
 688     // load from the same location and producing the same type of value
 689     // but it has different alignment or volatileness.
 690     bool isNewLoad = true;
 691     SUnit *LoadSU;
 692     if (LoadNode->getNodeId() != -1) {
 693       LoadSU = &SUnits[LoadNode->getNodeId()];
 694       isNewLoad = false;
 695     } else {
 696       LoadSU = CreateNewSUnit(LoadNode);
 697       LoadNode->setNodeId(LoadSU->NodeNum);
 698
 699       LoadSU->Depth = SU->Depth;
 700       LoadSU->Height = SU->Height;
 701       ComputeLatency(LoadSU);
 702     }
 703
 704     SUnit *ChainPred = NULL;
 705     SmallVector<SDep, 4> ChainSuccs;
 706     SmallVector<SDep, 4> LoadPreds;
 707     SmallVector<SDep, 4> NodePreds;
 708     SmallVector<SDep, 4> NodeSuccs;
 709     for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 710          I != E; ++I) {
 711       if (I->isCtrl)
 712         ChainPred = I->Dep;
 713       else if (I->Dep->Node && I->Dep->Node->isOperandOf(LoadNode))
 714         LoadPreds.push_back(SDep(I->Dep, I->Reg, I->Cost, false, false));
 715       else
 716         NodePreds.push_back(SDep(I->Dep, I->Reg, I->Cost, false, false));
 717     }
 718     for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
 719          I != E; ++I) {
 720       if (I->isCtrl)
 721         ChainSuccs.push_back(SDep(I->Dep, I->Reg, I->Cost,
 722                                   I->isCtrl, I->isSpecial));
 723       else
 724         NodeSuccs.push_back(SDep(I->Dep, I->Reg, I->Cost,
 725                                  I->isCtrl, I->isSpecial));
 726     }
 727
 728     if (ChainPred) {
 729       RemovePred(SU, ChainPred, true, false);
 730       if (isNewLoad)
 731         AddPred(LoadSU, ChainPred, true, false);
 732     }
 733     for (unsigned i = 0, e = LoadPreds.size(); i != e; ++i) {
 734       SDep *Pred = &LoadPreds[i];
 735       RemovePred(SU, Pred->Dep, Pred->isCtrl, Pred->isSpecial);
 736       if (isNewLoad) {
 737         AddPred(LoadSU, Pred->Dep, Pred->isCtrl, Pred->isSpecial,
 738                 Pred->Reg, Pred->Cost);
 739       }
 740     }
 741     for (unsigned i = 0, e = NodePreds.size(); i != e; ++i) {
 742       SDep *Pred = &NodePreds[i];
 743       RemovePred(SU, Pred->Dep, Pred->isCtrl, Pred->isSpecial);
 744       AddPred(NewSU, Pred->Dep, Pred->isCtrl, Pred->isSpecial,
 745               Pred->Reg, Pred->Cost);
 746     }
 747     for (unsigned i = 0, e = NodeSuccs.size(); i != e; ++i) {
 748       SDep *Succ = &NodeSuccs[i];
 749       RemovePred(Succ->Dep, SU, Succ->isCtrl, Succ->isSpecial);
 750       AddPred(Succ->Dep, NewSU, Succ->isCtrl, Succ->isSpecial,
 751               Succ->Reg, Succ->Cost);
 752     }
 753     for (unsigned i = 0, e = ChainSuccs.size(); i != e; ++i) {
 754       SDep *Succ = &ChainSuccs[i];
 755       RemovePred(Succ->Dep, SU, Succ->isCtrl, Succ->isSpecial);
 756       if (isNewLoad) {
 757         AddPred(Succ->Dep, LoadSU, Succ->isCtrl, Succ->isSpecial,
 758                 Succ->Reg, Succ->Cost);
 759       }
 760     }
 761     if (isNewLoad) {
 762       AddPred(NewSU, LoadSU, false, false);
 763     }
 764
 765     if (isNewLoad)
 766       AvailableQueue->addNode(LoadSU);
 767     AvailableQueue->addNode(NewSU);
 768
 769     ++NumUnfolds;
 770
 771     if (NewSU->NumSuccsLeft == 0) {
 772       NewSU->isAvailable = true;
 773       return NewSU;
 774     }
 775     SU = NewSU;
 776   }
 777
 778   DOUT << "Duplicating SU # " << SU->NodeNum << "\n";
 779   NewSU = CreateClone(SU);
 780
 781   // New SUnit has the exact same predecessors.
 782   for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 783        I != E; ++I)
 784     if (!I->isSpecial) {
 785       AddPred(NewSU, I->Dep, I->isCtrl, false, I->Reg, I->Cost);
 786       NewSU->Depth = std::max(NewSU->Depth, I->Dep->Depth+1);
 787     }
 788
 789   // Only copy scheduled successors. Cut them from old node's successor
 790   // list and move them over.
 791   SmallVector<std::pair<SUnit*, bool>, 4> DelDeps;
 792   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
 793        I != E; ++I) {
 794     if (I->isSpecial)
 795       continue;
 796     if (I->Dep->isScheduled) {
 797       NewSU->Height = std::max(NewSU->Height, I->Dep->Height+1);
 798       AddPred(I->Dep, NewSU, I->isCtrl, false, I->Reg, I->Cost);
 799       DelDeps.push_back(std::make_pair(I->Dep, I->isCtrl));
 800     }
 801   }
 802   for (unsigned i = 0, e = DelDeps.size(); i != e; ++i) {
 803     SUnit *Succ = DelDeps[i].first;
 804     bool isCtrl = DelDeps[i].second;
 805     RemovePred(Succ, SU, isCtrl, false);
 806   }
 807
 808   AvailableQueue->updateNode(SU);
 809   AvailableQueue->addNode(NewSU);
 810
 811   ++NumDups;
 812   return NewSU;
 813 }
 814
 815 /// InsertCCCopiesAndMoveSuccs - Insert expensive cross register class copies
 816 /// and move all scheduled successors of the given SUnit to the last copy.
 817 void ScheduleDAGRRList::InsertCCCopiesAndMoveSuccs(SUnit *SU, unsigned Reg,
 818                                               const TargetRegisterClass *DestRC,
 819                                               const TargetRegisterClass *SrcRC,
 820                                                SmallVector<SUnit*, 2> &Copies) {
 821   SUnit *CopyFromSU = CreateNewSUnit(NULL);
 822   CopyFromSU->CopySrcRC = SrcRC;
 823   CopyFromSU->CopyDstRC = DestRC;
 824   CopyFromSU->Depth = SU->Depth;
 825   CopyFromSU->Height = SU->Height;
 826
 827   SUnit *CopyToSU = CreateNewSUnit(NULL);
 828   CopyToSU->CopySrcRC = DestRC;
 829   CopyToSU->CopyDstRC = SrcRC;
 830
 831   // Only copy scheduled successors. Cut them from old node's successor
 832   // list and move them over.
 833   SmallVector<std::pair<SUnit*, bool>, 4> DelDeps;
 834   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
 835        I != E; ++I) {
 836     if (I->isSpecial)
 837       continue;
 838     if (I->Dep->isScheduled) {
 839       CopyToSU->Height = std::max(CopyToSU->Height, I->Dep->Height+1);
 840       AddPred(I->Dep, CopyToSU, I->isCtrl, false, I->Reg, I->Cost);
 841       DelDeps.push_back(std::make_pair(I->Dep, I->isCtrl));
 842     }
 843   }
 844   for (unsigned i = 0, e = DelDeps.size(); i != e; ++i) {
 845     SUnit *Succ = DelDeps[i].first;
 846     bool isCtrl = DelDeps[i].second;
 847     RemovePred(Succ, SU, isCtrl, false);
 848   }
 849
 850   AddPred(CopyFromSU, SU, false, false, Reg, -1);
 851   AddPred(CopyToSU, CopyFromSU, false, false, Reg, 1);
 852
 853   AvailableQueue->updateNode(SU);
 854   AvailableQueue->addNode(CopyFromSU);
 855   AvailableQueue->addNode(CopyToSU);
 856   Copies.push_back(CopyFromSU);
 857   Copies.push_back(CopyToSU);
 858
 859   ++NumCCCopies;
 860 }
 861
 862 /// getPhysicalRegisterVT - Returns the ValueType of the physical register
 863 /// definition of the specified node.
 864 /// FIXME: Move to SelectionDAG?
 865 static MVT getPhysicalRegisterVT(SDNode *N, unsigned Reg,
 866                                  const TargetInstrInfo *TII) {
 867   const TargetInstrDesc &TID = TII->get(N->getMachineOpcode());
 868   assert(TID.ImplicitDefs && "Physical reg def must be in implicit def list!");
 869   unsigned NumRes = TID.getNumDefs();
 870   for (const unsigned *ImpDef = TID.getImplicitDefs(); *ImpDef; ++ImpDef) {
 871     if (Reg == *ImpDef)
 872       break;
 873     ++NumRes;
 874   }
 875   return N->getValueType(NumRes);
 876 }
 877
 878 /// DelayForLiveRegsBottomUp - Returns true if it is necessary to delay
 879 /// scheduling of the given node to satisfy live physical register dependencies.
 880 /// If the specific node is the last one that's available to schedule, do
 881 /// whatever is necessary (i.e. backtracking or cloning) to make it possible.
 882 bool ScheduleDAGRRList::DelayForLiveRegsBottomUp(SUnit *SU,
 883                                                  SmallVector<unsigned, 4> &LRegs){
 884   if (NumLiveRegs == 0)
 885     return false;
 886
 887   SmallSet<unsigned, 4> RegAdded;
 888   // If this node would clobber any "live" register, then it's not ready.
 889   for (SUnit::pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
 890        I != E; ++I) {
 891     if (I->Cost < 0)  {
 892       unsigned Reg = I->Reg;
 893       if (LiveRegDefs[Reg] && LiveRegDefs[Reg] != I->Dep) {
 894         if (RegAdded.insert(Reg))
 895           LRegs.push_back(Reg);
 896       }
 897       for (const unsigned *Alias = TRI->getAliasSet(Reg);
 898            *Alias; ++Alias)
 899         if (LiveRegDefs[*Alias] && LiveRegDefs[*Alias] != I->Dep) {
 900           if (RegAdded.insert(*Alias))
 901             LRegs.push_back(*Alias);
 902         }
 903     }
 904   }
 905
 906   for (unsigned i = 0, e = SU->FlaggedNodes.size()+1; i != e; ++i) {
 907     SDNode *Node = (i == 0) ? SU->Node : SU->FlaggedNodes[i-1];
 908     if (!Node || !Node->isMachineOpcode())
 909       continue;
 910     const TargetInstrDesc &TID = TII->get(Node->getMachineOpcode());
 911     if (!TID.ImplicitDefs)
 912       continue;
 913     for (const unsigned *Reg = TID.ImplicitDefs; *Reg; ++Reg) {
 914       if (LiveRegDefs[*Reg] && LiveRegDefs[*Reg] != SU) {
 915         if (RegAdded.insert(*Reg))
 916           LRegs.push_back(*Reg);
 917       }
 918       for (const unsigned *Alias = TRI->getAliasSet(*Reg);
 919            *Alias; ++Alias)
 920         if (LiveRegDefs[*Alias] && LiveRegDefs[*Alias] != SU) {
 921           if (RegAdded.insert(*Alias))
 922             LRegs.push_back(*Alias);
 923         }
 924     }
 925   }
 926   return !LRegs.empty();
 927 }
 928
 929
 930 /// ListScheduleBottomUp - The main loop of list scheduling for bottom-up
 931 /// schedulers.
 932 void ScheduleDAGRRList::ListScheduleBottomUp() {
 933   unsigned CurCycle = 0;
 934   // Add root to Available queue.
 935   if (!SUnits.empty()) {
 936     SUnit *RootSU = &SUnits[DAG.getRoot().getNode()->getNodeId()];
 937     assert(RootSU->Succs.empty() && "Graph root shouldn't have successors!");
 938     RootSU->isAvailable = true;
 939     AvailableQueue->push(RootSU);
 940   }
 941
 942   // While Available queue is not empty, grab the node with the highest
 943   // priority. If it is not ready put it back.  Schedule the node.
 944   SmallVector<SUnit*, 4> NotReady;
 945   DenseMap<SUnit*, SmallVector<unsigned, 4> > LRegsMap;
 946   Sequence.reserve(SUnits.size());
 947   while (!AvailableQueue->empty()) {
 948     bool Delayed = false;
 949     LRegsMap.clear();
 950     SUnit *CurSU = AvailableQueue->pop();
 951     while (CurSU) {
 952       if (CurSU->CycleBound <= CurCycle) {
 953         SmallVector<unsigned, 4> LRegs;
 954         if (!DelayForLiveRegsBottomUp(CurSU, LRegs))
 955           break;
 956         Delayed = true;
 957         LRegsMap.insert(std::make_pair(CurSU, LRegs));
 958       }
 959
 960       CurSU->isPending = true;  // This SU is not in AvailableQueue right now.
 961       NotReady.push_back(CurSU);
 962       CurSU = AvailableQueue->pop();
 963     }
 964
 965     // All candidates are delayed due to live physical reg dependencies.
 966     // Try backtracking, code duplication, or inserting cross class copies
 967     // to resolve it.
 968     if (Delayed && !CurSU) {
 969       for (unsigned i = 0, e = NotReady.size(); i != e; ++i) {
 970         SUnit *TrySU = NotReady[i];
 971         SmallVector<unsigned, 4> &LRegs = LRegsMap[TrySU];
 972
 973         // Try unscheduling up to the point where it's safe to schedule
 974         // this node.
 975         unsigned LiveCycle = CurCycle;
 976         for (unsigned j = 0, ee = LRegs.size(); j != ee; ++j) {
 977           unsigned Reg = LRegs[j];
 978           unsigned LCycle = LiveRegCycles[Reg];
 979           LiveCycle = std::min(LiveCycle, LCycle);
 980         }
 981         SUnit *OldSU = Sequence[LiveCycle];
 982         if (!WillCreateCycle(TrySU, OldSU))  {
 983           BacktrackBottomUp(TrySU, LiveCycle, CurCycle);
 984           // Force the current node to be scheduled before the node that
 985           // requires the physical reg dep.
 986           if (OldSU->isAvailable) {
 987             OldSU->isAvailable = false;
 988             AvailableQueue->remove(OldSU);
 989           }
 990           AddPred(TrySU, OldSU, true, true);
 991           // If one or more successors has been unscheduled, then the current
 992           // node is no longer avaialable. Schedule a successor that's now
 993           // available instead.
 994           if (!TrySU->isAvailable)
 995             CurSU = AvailableQueue->pop();
 996           else {
 997             CurSU = TrySU;
 998             TrySU->isPending = false;
 999             NotReady.erase(NotReady.begin()+i);
1000           }
1001           break;
1002         }
1003       }
1004
1005       if (!CurSU) {
1006         // Can't backtrack. Try duplicating the nodes that produces these
1007         // "expensive to copy" values to break the dependency. In case even
1008         // that doesn't work, insert cross class copies.
1009         SUnit *TrySU = NotReady[0];
1010         SmallVector<unsigned, 4> &LRegs = LRegsMap[TrySU];
1011         assert(LRegs.size() == 1 && "Can't handle this yet!");
1012         unsigned Reg = LRegs[0];
1013         SUnit *LRDef = LiveRegDefs[Reg];
1014         SUnit *NewDef = CopyAndMoveSuccessors(LRDef);
1015         if (!NewDef) {
1016           // Issue expensive cross register class copies.
1017           MVT VT = getPhysicalRegisterVT(LRDef->Node, Reg, TII);
1018           const TargetRegisterClass *RC =
1019             TRI->getPhysicalRegisterRegClass(Reg, VT);
1020           const TargetRegisterClass *DestRC = TRI->getCrossCopyRegClass(RC);
1021           if (!DestRC) {
1022             assert(false && "Don't know how to copy this physical register!");
1023             abort();
1024           }
1025           SmallVector<SUnit*, 2> Copies;
1026           InsertCCCopiesAndMoveSuccs(LRDef, Reg, DestRC, RC, Copies);
1027           DOUT << "Adding an edge from SU # " << TrySU->NodeNum
1028                << " to SU #" << Copies.front()->NodeNum << "\n";
1029           AddPred(TrySU, Copies.front(), true, true);
1030           NewDef = Copies.back();
1031         }
1032
1033         DOUT << "Adding an edge from SU # " << NewDef->NodeNum
1034              << " to SU #" << TrySU->NodeNum << "\n";
1035         LiveRegDefs[Reg] = NewDef;
1036         AddPred(NewDef, TrySU, true, true);
1037         TrySU->isAvailable = false;
1038         CurSU = NewDef;
1039       }
1040
1041       if (!CurSU) {
1042         assert(false && "Unable to resolve live physical register dependencies!");
1043         abort();
1044       }
1045     }
1046
1047     // Add the nodes that aren't ready back onto the available list.
1048     for (unsigned i = 0, e = NotReady.size(); i != e; ++i) {
1049       NotReady[i]->isPending = false;
1050       // May no longer be available due to backtracking.
1051       if (NotReady[i]->isAvailable)
1052         AvailableQueue->push(NotReady[i]);
1053     }
1054     NotReady.clear();
1055
1056     if (!CurSU)
1057       Sequence.push_back(0);
1058     else {
1059       ScheduleNodeBottomUp(CurSU, CurCycle);
1060       Sequence.push_back(CurSU);
1061     }
1062     ++CurCycle;
1063   }
1064
1065   // Reverse the order if it is bottom up.
1066   std::reverse(Sequence.begin(), Sequence.end());
1067
1068
1069 #ifndef NDEBUG
1070   // Verify that all SUnits were scheduled.
1071   bool AnyNotSched = false;
1072   unsigned DeadNodes = 0;
1073   unsigned Noops = 0;
1074   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
1075     if (!SUnits[i].isScheduled) {
1076       if (SUnits[i].NumPreds == 0 && SUnits[i].NumSuccs == 0) {
1077         ++DeadNodes;
1078         continue;
1079       }
1080       if (!AnyNotSched)
1081         cerr << "*** List scheduling failed! ***\n";
1082       SUnits[i].dump(&DAG);
1083       cerr << "has not been scheduled!\n";
1084       AnyNotSched = true;
1085     }
1086     if (SUnits[i].NumSuccsLeft != 0) {
1087       if (!AnyNotSched)
1088         cerr << "*** List scheduling failed! ***\n";
1089       SUnits[i].dump(&DAG);
1090       cerr << "has successors left!\n";
1091       AnyNotSched = true;
1092     }
1093   }
1094   for (unsigned i = 0, e = Sequence.size(); i != e; ++i)
1095     if (!Sequence[i])
1096       ++Noops;
1097   assert(!AnyNotSched);
1098   assert(Sequence.size() + DeadNodes - Noops == SUnits.size() &&
1099          "The number of nodes scheduled doesn't match the expected number!");
1100 #endif
1101 }
1102
1103 //===----------------------------------------------------------------------===//
1104 //  Top-Down Scheduling
1105 //===----------------------------------------------------------------------===//
1106
1107 /// ReleaseSucc - Decrement the NumPredsLeft count of a successor. Add it to
1108 /// the AvailableQueue if the count reaches zero. Also update its cycle bound.
1109 void ScheduleDAGRRList::ReleaseSucc(SUnit *SuccSU, bool isChain,
1110                                     unsigned CurCycle) {
1111   // FIXME: the distance between two nodes is not always == the predecessor's
1112   // latency. For example, the reader can very well read the register written
1113   // by the predecessor later than the issue cycle. It also depends on the
1114   // interrupt model (drain vs. freeze).
1115   SuccSU->CycleBound = std::max(SuccSU->CycleBound, CurCycle + SuccSU->Latency);
1116
1117   --SuccSU->NumPredsLeft;
1118
1119 #ifndef NDEBUG
1120   if (SuccSU->NumPredsLeft < 0) {
1121     cerr << "*** List scheduling failed! ***\n";
1122     SuccSU->dump(&DAG);
1123     cerr << " has been released too many times!\n";
1124     assert(0);
1125   }
1126 #endif
1127
1128   if (SuccSU->NumPredsLeft == 0) {
1129     SuccSU->isAvailable = true;
1130     AvailableQueue->push(SuccSU);
1131   }
1132 }
1133
1134
1135 /// ScheduleNodeTopDown - Add the node to the schedule. Decrement the pending
1136 /// count of its successors. If a successor pending count is zero, add it to
1137 /// the Available queue.
1138 void ScheduleDAGRRList::ScheduleNodeTopDown(SUnit *SU, unsigned CurCycle) {
1139   DOUT << "*** Scheduling [" << CurCycle << "]: ";
1140   DEBUG(SU->dump(&DAG));
1141   SU->Cycle = CurCycle;
1142
1143   AvailableQueue->ScheduledNode(SU);
1144
1145   // Top down: release successors
1146   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
1147        I != E; ++I)
1148     ReleaseSucc(I->Dep, I->isCtrl, CurCycle);
1149   SU->isScheduled = true;
1150 }
1151
1152 /// ListScheduleTopDown - The main loop of list scheduling for top-down
1153 /// schedulers.
1154 void ScheduleDAGRRList::ListScheduleTopDown() {
1155   unsigned CurCycle = 0;
1156
1157   // All leaves to Available queue.
1158   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
1159     // It is available if it has no predecessors.
1160     if (SUnits[i].Preds.empty()) {
1161       AvailableQueue->push(&SUnits[i]);
1162       SUnits[i].isAvailable = true;
1163     }
1164   }
1165
1166   // While Available queue is not empty, grab the node with the highest
1167   // priority. If it is not ready put it back.  Schedule the node.
1168   std::vector<SUnit*> NotReady;
1169   Sequence.reserve(SUnits.size());
1170   while (!AvailableQueue->empty()) {
1171     SUnit *CurSU = AvailableQueue->pop();
1172     while (CurSU && CurSU->CycleBound > CurCycle) {
1173       NotReady.push_back(CurSU);
1174       CurSU = AvailableQueue->pop();
1175     }
1176
1177     // Add the nodes that aren't ready back onto the available list.
1178     AvailableQueue->push_all(NotReady);
1179     NotReady.clear();
1180
1181     if (!CurSU)
1182       Sequence.push_back(0);
1183     else {
1184       ScheduleNodeTopDown(CurSU, CurCycle);
1185       Sequence.push_back(CurSU);
1186     }
1187     ++CurCycle;
1188   }
1189
1190
1191 #ifndef NDEBUG
1192   // Verify that all SUnits were scheduled.
1193   bool AnyNotSched = false;
1194   unsigned DeadNodes = 0;
1195   unsigned Noops = 0;
1196   for (unsigned i = 0, e = SUnits.size(); i != e; ++i) {
1197     if (!SUnits[i].isScheduled) {
1198       if (SUnits[i].NumPreds == 0 && SUnits[i].NumSuccs == 0) {
1199         ++DeadNodes;
1200         continue;
1201       }
1202       if (!AnyNotSched)
1203         cerr << "*** List scheduling failed! ***\n";
1204       SUnits[i].dump(&DAG);
1205       cerr << "has not been scheduled!\n";
1206       AnyNotSched = true;
1207     }
1208     if (SUnits[i].NumPredsLeft != 0) {
1209       if (!AnyNotSched)
1210         cerr << "*** List scheduling failed! ***\n";
1211       SUnits[i].dump(&DAG);
1212       cerr << "has predecessors left!\n";
1213       AnyNotSched = true;
1214     }
1215   }
1216   for (unsigned i = 0, e = Sequence.size(); i != e; ++i)
1217     if (!Sequence[i])
1218       ++Noops;
1219   assert(!AnyNotSched);
1220   assert(Sequence.size() + DeadNodes - Noops == SUnits.size() &&
1221          "The number of nodes scheduled doesn't match the expected number!");
1222 #endif
1223 }
1224
1225
1226
1227 //===----------------------------------------------------------------------===//
1228 //                RegReductionPriorityQueue Implementation
1229 //===----------------------------------------------------------------------===//
1230 //
1231 // This is a SchedulingPriorityQueue that schedules using Sethi Ullman numbers
1232 // to reduce register pressure.
1233 //
1234 namespace {
1235   template<class SF>
1236   class RegReductionPriorityQueue;
1237
1238   /// Sorting functions for the Available queue.
1239   struct bu_ls_rr_sort : public std::binary_function<SUnit*, SUnit*, bool> {
1240     RegReductionPriorityQueue<bu_ls_rr_sort> *SPQ;
1241     bu_ls_rr_sort(RegReductionPriorityQueue<bu_ls_rr_sort> *spq) : SPQ(spq) {}
1242     bu_ls_rr_sort(const bu_ls_rr_sort &RHS) : SPQ(RHS.SPQ) {}
1243
1244     bool operator()(const SUnit* left, const SUnit* right) const;
1245   };
1246
1247   struct bu_ls_rr_fast_sort : public std::binary_function<SUnit*, SUnit*, bool>{
1248     RegReductionPriorityQueue<bu_ls_rr_fast_sort> *SPQ;
1249     bu_ls_rr_fast_sort(RegReductionPriorityQueue<bu_ls_rr_fast_sort> *spq)
1250       : SPQ(spq) {}
1251     bu_ls_rr_fast_sort(const bu_ls_rr_fast_sort &RHS) : SPQ(RHS.SPQ) {}
1252
1253     bool operator()(const SUnit* left, const SUnit* right) const;
1254   };
1255
1256   struct td_ls_rr_sort : public std::binary_function<SUnit*, SUnit*, bool> {
1257     RegReductionPriorityQueue<td_ls_rr_sort> *SPQ;
1258     td_ls_rr_sort(RegReductionPriorityQueue<td_ls_rr_sort> *spq) : SPQ(spq) {}
1259     td_ls_rr_sort(const td_ls_rr_sort &RHS) : SPQ(RHS.SPQ) {}
1260
1261     bool operator()(const SUnit* left, const SUnit* right) const;
1262   };
1263 }  // end anonymous namespace
1264
1265 static inline bool isCopyFromLiveIn(const SUnit *SU) {
1266   SDNode *N = SU->Node;
1267   return N && N->getOpcode() == ISD::CopyFromReg &&
1268     N->getOperand(N->getNumOperands()-1).getValueType() != MVT::Flag;
1269 }
1270
1271 /// CalcNodeBUSethiUllmanNumber - Compute Sethi Ullman number for bottom up
1272 /// scheduling. Smaller number is the higher priority.
1273 static unsigned
1274 CalcNodeBUSethiUllmanNumber(const SUnit *SU, std::vector<unsigned> &SUNumbers) {
1275   unsigned &SethiUllmanNumber = SUNumbers[SU->NodeNum];
1276   if (SethiUllmanNumber != 0)
1277     return SethiUllmanNumber;
1278
1279   unsigned Extra = 0;
1280   for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
1281        I != E; ++I) {
1282     if (I->isCtrl) continue;  // ignore chain preds
1283     SUnit *PredSU = I->Dep;
1284     unsigned PredSethiUllman = CalcNodeBUSethiUllmanNumber(PredSU, SUNumbers);
1285     if (PredSethiUllman > SethiUllmanNumber) {
1286       SethiUllmanNumber = PredSethiUllman;
1287       Extra = 0;
1288     } else if (PredSethiUllman == SethiUllmanNumber && !I->isCtrl)
1289       ++Extra;
1290   }
1291
1292   SethiUllmanNumber += Extra;
1293
1294   if (SethiUllmanNumber == 0)
1295     SethiUllmanNumber = 1;
1296
1297   return SethiUllmanNumber;
1298 }
1299
1300 /// CalcNodeTDSethiUllmanNumber - Compute Sethi Ullman number for top down
1301 /// scheduling. Smaller number is the higher priority.
1302 static unsigned
1303 CalcNodeTDSethiUllmanNumber(const SUnit *SU, std::vector<unsigned> &SUNumbers) {
1304   unsigned &SethiUllmanNumber = SUNumbers[SU->NodeNum];
1305   if (SethiUllmanNumber != 0)
1306     return SethiUllmanNumber;
1307
1308   unsigned Opc = SU->Node ? SU->Node->getOpcode() : 0;
1309   if (Opc == ISD::TokenFactor || Opc == ISD::CopyToReg)
1310     SethiUllmanNumber = 0xffff;
1311   else if (SU->NumSuccsLeft == 0)
1312     // If SU does not have a use, i.e. it doesn't produce a value that would
1313     // be consumed (e.g. store), then it terminates a chain of computation.
1314     // Give it a small SethiUllman number so it will be scheduled right before
1315     // its predecessors that it doesn't lengthen their live ranges.
1316     SethiUllmanNumber = 0;
1317   else if (SU->NumPredsLeft == 0 &&
1318            (Opc != ISD::CopyFromReg || isCopyFromLiveIn(SU)))
1319     SethiUllmanNumber = 0xffff;
1320   else {
1321     int Extra = 0;
1322     for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
1323          I != E; ++I) {
1324       if (I->isCtrl) continue;  // ignore chain preds
1325       SUnit *PredSU = I->Dep;
1326       unsigned PredSethiUllman = CalcNodeTDSethiUllmanNumber(PredSU, SUNumbers);
1327       if (PredSethiUllman > SethiUllmanNumber) {
1328         SethiUllmanNumber = PredSethiUllman;
1329         Extra = 0;
1330       } else if (PredSethiUllman == SethiUllmanNumber && !I->isCtrl)
1331         ++Extra;
1332     }
1333
1334     SethiUllmanNumber += Extra;
1335   }
1336
1337   return SethiUllmanNumber;
1338 }
1339
1340
1341 namespace {
1342   template<class SF>
1343   class VISIBILITY_HIDDEN RegReductionPriorityQueue
1344    : public SchedulingPriorityQueue {
1345     PriorityQueue<SUnit*, std::vector<SUnit*>, SF> Queue;
1346     unsigned currentQueueId;
1347
1348   public:
1349     RegReductionPriorityQueue() :
1350     Queue(SF(this)), currentQueueId(0) {}
1351
1352     virtual void initNodes(std::vector<SUnit> &sunits) {}
1353
1354     virtual void addNode(const SUnit *SU) {}
1355
1356     virtual void updateNode(const SUnit *SU) {}
1357
1358     virtual void releaseState() {}
1359
1360     virtual unsigned getNodePriority(const SUnit *SU) const {
1361       return 0;
1362     }
1363
1364     unsigned size() const { return Queue.size(); }
1365
1366     bool empty() const { return Queue.empty(); }
1367
1368     void push(SUnit *U) {
1369       assert(!U->NodeQueueId && "Node in the queue already");
1370       U->NodeQueueId = ++currentQueueId;
1371       Queue.push(U);
1372     }
1373
1374     void push_all(const std::vector<SUnit *> &Nodes) {
1375       for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
1376         push(Nodes[i]);
1377     }
1378
1379     SUnit *pop() {
1380       if (empty()) return NULL;
1381       SUnit *V = Queue.top();
1382       Queue.pop();
1383       V->NodeQueueId = 0;
1384       return V;
1385     }
1386
1387     void remove(SUnit *SU) {
1388       assert(!Queue.empty() && "Queue is empty!");
1389       assert(SU->NodeQueueId != 0 && "Not in queue!");
1390       Queue.erase_one(SU);
1391       SU->NodeQueueId = 0;
1392     }
1393   };
1394
1395   class VISIBILITY_HIDDEN BURegReductionPriorityQueue
1396    : public RegReductionPriorityQueue<bu_ls_rr_sort> {
1397     // SUnits - The SUnits for the current graph.
1398     std::vector<SUnit> *SUnits;
1399
1400     // SethiUllmanNumbers - The SethiUllman number for each node.
1401     std::vector<unsigned> SethiUllmanNumbers;
1402
1403     const TargetInstrInfo *TII;
1404     const TargetRegisterInfo *TRI;
1405     ScheduleDAGRRList *scheduleDAG;
1406
1407   public:
1408     explicit BURegReductionPriorityQueue(const TargetInstrInfo *tii,
1409                                          const TargetRegisterInfo *tri)
1410       : TII(tii), TRI(tri), scheduleDAG(NULL) {}
1411
1412     void initNodes(std::vector<SUnit> &sunits) {
1413       SUnits = &sunits;
1414       // Add pseudo dependency edges for two-address nodes.
1415       AddPseudoTwoAddrDeps();
1416       // Calculate node priorities.
1417       CalculateSethiUllmanNumbers();
1418     }
1419
1420     void addNode(const SUnit *SU) {
1421       unsigned SUSize = SethiUllmanNumbers.size();
1422       if (SUnits->size() > SUSize)
1423         SethiUllmanNumbers.resize(SUSize*2, 0);
1424       CalcNodeBUSethiUllmanNumber(SU, SethiUllmanNumbers);
1425     }
1426
1427     void updateNode(const SUnit *SU) {
1428       SethiUllmanNumbers[SU->NodeNum] = 0;
1429       CalcNodeBUSethiUllmanNumber(SU, SethiUllmanNumbers);
1430     }
1431
1432     void releaseState() {
1433       SUnits = 0;
1434       SethiUllmanNumbers.clear();
1435     }
1436
1437     unsigned getNodePriority(const SUnit *SU) const {
1438       assert(SU->NodeNum < SethiUllmanNumbers.size());
1439       unsigned Opc = SU->Node ? SU->Node->getOpcode() : 0;
1440       if (Opc == ISD::CopyFromReg && !isCopyFromLiveIn(SU))
1441         // CopyFromReg should be close to its def because it restricts
1442         // allocation choices. But if it is a livein then perhaps we want it
1443         // closer to its uses so it can be coalesced.
1444         return 0xffff;
1445       else if (Opc == ISD::TokenFactor || Opc == ISD::CopyToReg)
1446         // CopyToReg should be close to its uses to facilitate coalescing and
1447         // avoid spilling.
1448         return 0;
1449       else if (Opc == TargetInstrInfo::EXTRACT_SUBREG ||
1450                Opc == TargetInstrInfo::INSERT_SUBREG)
1451         // EXTRACT_SUBREG / INSERT_SUBREG should be close to its use to
1452         // facilitate coalescing.
1453         return 0;
1454       else if (SU->NumSuccs == 0)
1455         // If SU does not have a use, i.e. it doesn't produce a value that would
1456         // be consumed (e.g. store), then it terminates a chain of computation.
1457         // Give it a large SethiUllman number so it will be scheduled right
1458         // before its predecessors that it doesn't lengthen their live ranges.
1459         return 0xffff;
1460       else if (SU->NumPreds == 0)
1461         // If SU does not have a def, schedule it close to its uses because it
1462         // does not lengthen any live ranges.
1463         return 0;
1464       else
1465         return SethiUllmanNumbers[SU->NodeNum];
1466     }
1467
1468     void setScheduleDAG(ScheduleDAGRRList *scheduleDag) {
1469       scheduleDAG = scheduleDag;
1470     }
1471
1472   private:
1473     bool canClobber(const SUnit *SU, const SUnit *Op);
1474     void AddPseudoTwoAddrDeps();
1475     void CalculateSethiUllmanNumbers();
1476   };
1477
1478
1479   class VISIBILITY_HIDDEN BURegReductionFastPriorityQueue
1480    : public RegReductionPriorityQueue<bu_ls_rr_fast_sort> {
1481     // SUnits - The SUnits for the current graph.
1482     const std::vector<SUnit> *SUnits;
1483
1484     // SethiUllmanNumbers - The SethiUllman number for each node.
1485     std::vector<unsigned> SethiUllmanNumbers;
1486   public:
1487     explicit BURegReductionFastPriorityQueue() {}
1488
1489     void initNodes(std::vector<SUnit> &sunits) {
1490       SUnits = &sunits;
1491       // Calculate node priorities.
1492       CalculateSethiUllmanNumbers();
1493     }
1494
1495     void addNode(const SUnit *SU) {
1496       unsigned SUSize = SethiUllmanNumbers.size();
1497       if (SUnits->size() > SUSize)
1498         SethiUllmanNumbers.resize(SUSize*2, 0);
1499       CalcNodeBUSethiUllmanNumber(SU, SethiUllmanNumbers);
1500     }
1501
1502     void updateNode(const SUnit *SU) {
1503       SethiUllmanNumbers[SU->NodeNum] = 0;
1504       CalcNodeBUSethiUllmanNumber(SU, SethiUllmanNumbers);
1505     }
1506
1507     void releaseState() {
1508       SUnits = 0;
1509       SethiUllmanNumbers.clear();
1510     }
1511
1512     unsigned getNodePriority(const SUnit *SU) const {
1513       return SethiUllmanNumbers[SU->NodeNum];
1514     }
1515
1516   private:
1517     void CalculateSethiUllmanNumbers();
1518   };
1519
1520
1521   class VISIBILITY_HIDDEN TDRegReductionPriorityQueue
1522    : public RegReductionPriorityQueue<td_ls_rr_sort> {
1523     // SUnits - The SUnits for the current graph.
1524     const std::vector<SUnit> *SUnits;
1525
1526     // SethiUllmanNumbers - The SethiUllman number for each node.
1527     std::vector<unsigned> SethiUllmanNumbers;
1528
1529   public:
1530     TDRegReductionPriorityQueue() {}
1531
1532     void initNodes(std::vector<SUnit> &sunits) {
1533       SUnits = &sunits;
1534       // Calculate node priorities.
1535       CalculateSethiUllmanNumbers();
1536     }
1537
1538     void addNode(const SUnit *SU) {
1539       unsigned SUSize = SethiUllmanNumbers.size();
1540       if (SUnits->size() > SUSize)
1541         SethiUllmanNumbers.resize(SUSize*2, 0);
1542       CalcNodeTDSethiUllmanNumber(SU, SethiUllmanNumbers);
1543     }
1544
1545     void updateNode(const SUnit *SU) {
1546       SethiUllmanNumbers[SU->NodeNum] = 0;
1547       CalcNodeTDSethiUllmanNumber(SU, SethiUllmanNumbers);
1548     }
1549
1550     void releaseState() {
1551       SUnits = 0;
1552       SethiUllmanNumbers.clear();
1553     }
1554
1555     unsigned getNodePriority(const SUnit *SU) const {
1556       assert(SU->NodeNum < SethiUllmanNumbers.size());
1557       return SethiUllmanNumbers[SU->NodeNum];
1558     }
1559
1560   private:
1561     void CalculateSethiUllmanNumbers();
1562   };
1563 }
1564
1565 /// closestSucc - Returns the scheduled cycle of the successor which is
1566 /// closet to the current cycle.
1567 static unsigned closestSucc(const SUnit *SU) {
1568   unsigned MaxCycle = 0;
1569   for (SUnit::const_succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
1570        I != E; ++I) {
1571     unsigned Cycle = I->Dep->Cycle;
1572     // If there are bunch of CopyToRegs stacked up, they should be considered
1573     // to be at the same position.
1574     if (I->Dep->Node && I->Dep->Node->getOpcode() == ISD::CopyToReg)
1575       Cycle = closestSucc(I->Dep)+1;
1576     if (Cycle > MaxCycle)
1577       MaxCycle = Cycle;
1578   }
1579   return MaxCycle;
1580 }
1581
1582 /// calcMaxScratches - Returns an cost estimate of the worse case requirement
1583 /// for scratch registers. Live-in operands and live-out results don't count
1584 /// since they are "fixed".
1585 static unsigned calcMaxScratches(const SUnit *SU) {
1586   unsigned Scratches = 0;
1587   for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
1588        I != E; ++I) {
1589     if (I->isCtrl) continue;  // ignore chain preds
1590     if (!I->Dep->Node || I->Dep->Node->getOpcode() != ISD::CopyFromReg)
1591       Scratches++;
1592   }
1593   for (SUnit::const_succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
1594        I != E; ++I) {
1595     if (I->isCtrl) continue;  // ignore chain succs
1596     if (!I->Dep->Node || I->Dep->Node->getOpcode() != ISD::CopyToReg)
1597       Scratches += 10;
1598   }
1599   return Scratches;
1600 }
1601
1602 // Bottom up
1603 bool bu_ls_rr_sort::operator()(const SUnit *left, const SUnit *right) const {
1604   unsigned LPriority = SPQ->getNodePriority(left);
1605   unsigned RPriority = SPQ->getNodePriority(right);
1606   if (LPriority != RPriority)
1607     return LPriority > RPriority;
1608
1609   // Try schedule def + use closer when Sethi-Ullman numbers are the same.
1610   // e.g.
1611   // t1 = op t2, c1
1612   // t3 = op t4, c2
1613   //
1614   // and the following instructions are both ready.
1615   // t2 = op c3
1616   // t4 = op c4
1617   //
1618   // Then schedule t2 = op first.
1619   // i.e.
1620   // t4 = op c4
1621   // t2 = op c3
1622   // t1 = op t2, c1
1623   // t3 = op t4, c2
1624   //
1625   // This creates more short live intervals.
1626   unsigned LDist = closestSucc(left);
1627   unsigned RDist = closestSucc(right);
1628   if (LDist != RDist)
1629     return LDist < RDist;
1630
1631   // Intuitively, it's good to push down instructions whose results are
1632   // liveout so their long live ranges won't conflict with other values
1633   // which are needed inside the BB. Further prioritize liveout instructions
1634   // by the number of operands which are calculated within the BB.
1635   unsigned LScratch = calcMaxScratches(left);
1636   unsigned RScratch = calcMaxScratches(right);
1637   if (LScratch != RScratch)
1638     return LScratch > RScratch;
1639
1640   if (left->Height != right->Height)
1641     return left->Height > right->Height;
1642
1643   if (left->Depth != right->Depth)
1644     return left->Depth < right->Depth;
1645
1646   if (left->CycleBound != right->CycleBound)
1647     return left->CycleBound > right->CycleBound;
1648
1649   assert(left->NodeQueueId && right->NodeQueueId &&
1650          "NodeQueueId cannot be zero");
1651   return (left->NodeQueueId > right->NodeQueueId);
1652 }
1653
1654 bool
1655 bu_ls_rr_fast_sort::operator()(const SUnit *left, const SUnit *right) const {
1656   unsigned LPriority = SPQ->getNodePriority(left);
1657   unsigned RPriority = SPQ->getNodePriority(right);
1658   if (LPriority != RPriority)
1659     return LPriority > RPriority;
1660   assert(left->NodeQueueId && right->NodeQueueId &&
1661          "NodeQueueId cannot be zero");
1662   return (left->NodeQueueId > right->NodeQueueId);
1663 }
1664
1665 bool
1666 BURegReductionPriorityQueue::canClobber(const SUnit *SU, const SUnit *Op) {
1667   if (SU->isTwoAddress) {
1668     unsigned Opc = SU->Node->getMachineOpcode();
1669     const TargetInstrDesc &TID = TII->get(Opc);
1670     unsigned NumRes = TID.getNumDefs();
1671     unsigned NumOps = TID.getNumOperands() - NumRes;
1672     for (unsigned i = 0; i != NumOps; ++i) {
1673       if (TID.getOperandConstraint(i+NumRes, TOI::TIED_TO) != -1) {
1674         SDNode *DU = SU->Node->getOperand(i).getNode();
1675         if (DU->getNodeId() != -1 &&
1676             Op->OrigNode == &(*SUnits)[DU->getNodeId()])
1677           return true;
1678       }
1679     }
1680   }
1681   return false;
1682 }
1683
1684
1685 /// hasCopyToRegUse - Return true if SU has a value successor that is a
1686 /// CopyToReg node.
1687 static bool hasCopyToRegUse(const SUnit *SU) {
1688   for (SUnit::const_succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
1689        I != E; ++I) {
1690     if (I->isCtrl) continue;
1691     const SUnit *SuccSU = I->Dep;
1692     if (SuccSU->Node && SuccSU->Node->getOpcode() == ISD::CopyToReg)
1693       return true;
1694   }
1695   return false;
1696 }
1697
1698 /// canClobberPhysRegDefs - True if SU would clobber one of SuccSU's
1699 /// physical register defs.
1700 static bool canClobberPhysRegDefs(const SUnit *SuccSU, const SUnit *SU,
1701                                   const TargetInstrInfo *TII,
1702                                   const TargetRegisterInfo *TRI) {
1703   SDNode *N = SuccSU->Node;
1704   unsigned NumDefs = TII->get(N->getMachineOpcode()).getNumDefs();
1705   const unsigned *ImpDefs = TII->get(N->getMachineOpcode()).getImplicitDefs();
1706   assert(ImpDefs && "Caller should check hasPhysRegDefs");
1707   const unsigned *SUImpDefs =
1708     TII->get(SU->Node->getMachineOpcode()).getImplicitDefs();
1709   if (!SUImpDefs)
1710     return false;
1711   for (unsigned i = NumDefs, e = N->getNumValues(); i != e; ++i) {
1712     MVT VT = N->getValueType(i);
1713     if (VT == MVT::Flag || VT == MVT::Other)
1714       continue;
1715     if (!N->hasAnyUseOfValue(i))
1716       continue;
1717     unsigned Reg = ImpDefs[i - NumDefs];
1718     for (;*SUImpDefs; ++SUImpDefs) {
1719       unsigned SUReg = *SUImpDefs;
1720       if (TRI->regsOverlap(Reg, SUReg))
1721         return true;
1722     }
1723   }
1724   return false;
1725 }
1726
1727 /// AddPseudoTwoAddrDeps - If two nodes share an operand and one of them uses
1728 /// it as a def&use operand. Add a pseudo control edge from it to the other
1729 /// node (if it won't create a cycle) so the two-address one will be scheduled
1730 /// first (lower in the schedule). If both nodes are two-address, favor the
1731 /// one that has a CopyToReg use (more likely to be a loop induction update).
1732 /// If both are two-address, but one is commutable while the other is not
1733 /// commutable, favor the one that's not commutable.
1734 void BURegReductionPriorityQueue::AddPseudoTwoAddrDeps() {
1735   for (unsigned i = 0, e = SUnits->size(); i != e; ++i) {
1736     SUnit *SU = &(*SUnits)[i];
1737     if (!SU->isTwoAddress)
1738       continue;
1739
1740     SDNode *Node = SU->Node;
1741     if (!Node || !Node->isMachineOpcode() || SU->FlaggedNodes.size() > 0)
1742       continue;
1743
1744     unsigned Opc = Node->getMachineOpcode();
1745     const TargetInstrDesc &TID = TII->get(Opc);
1746     unsigned NumRes = TID.getNumDefs();
1747     unsigned NumOps = TID.getNumOperands() - NumRes;
1748     for (unsigned j = 0; j != NumOps; ++j) {
1749       if (TID.getOperandConstraint(j+NumRes, TOI::TIED_TO) != -1) {
1750         SDNode *DU = SU->Node->getOperand(j).getNode();
1751         if (DU->getNodeId() == -1)
1752           continue;
1753         const SUnit *DUSU = &(*SUnits)[DU->getNodeId()];
1754         if (!DUSU) continue;
1755         for (SUnit::const_succ_iterator I = DUSU->Succs.begin(),
1756              E = DUSU->Succs.end(); I != E; ++I) {
1757           if (I->isCtrl) continue;
1758           SUnit *SuccSU = I->Dep;
1759           if (SuccSU == SU)
1760             continue;
1761           // Be conservative. Ignore if nodes aren't at roughly the same
1762           // depth and height.
1763           if (SuccSU->Height < SU->Height && (SU->Height - SuccSU->Height) > 1)
1764             continue;
1765           if (!SuccSU->Node || !SuccSU->Node->isMachineOpcode())
1766             continue;
1767           // Don't constrain nodes with physical register defs if the
1768           // predecessor can clobber them.
1769           if (SuccSU->hasPhysRegDefs) {
1770             if (canClobberPhysRegDefs(SuccSU, SU, TII, TRI))
1771               continue;
1772           }
1773           // Don't constraint extract_subreg / insert_subreg these may be
1774           // coalesced away. We don't them close to their uses.
1775           unsigned SuccOpc = SuccSU->Node->getMachineOpcode();
1776           if (SuccOpc == TargetInstrInfo::EXTRACT_SUBREG ||
1777               SuccOpc == TargetInstrInfo::INSERT_SUBREG)
1778             continue;
1779           if ((!canClobber(SuccSU, DUSU) ||
1780                (hasCopyToRegUse(SU) && !hasCopyToRegUse(SuccSU)) ||
1781                (!SU->isCommutable && SuccSU->isCommutable)) &&
1782               !scheduleDAG->IsReachable(SuccSU, SU)) {
1783             DOUT << "Adding an edge from SU # " << SU->NodeNum
1784                  << " to SU #" << SuccSU->NodeNum << "\n";
1785             scheduleDAG->AddPred(SU, SuccSU, true, true);
1786           }
1787         }
1788       }
1789     }
1790   }
1791 }
1792
1793 /// CalculateSethiUllmanNumbers - Calculate Sethi-Ullman numbers of all
1794 /// scheduling units.
1795 void BURegReductionPriorityQueue::CalculateSethiUllmanNumbers() {
1796   SethiUllmanNumbers.assign(SUnits->size(), 0);
1797
1798   for (unsigned i = 0, e = SUnits->size(); i != e; ++i)
1799     CalcNodeBUSethiUllmanNumber(&(*SUnits)[i], SethiUllmanNumbers);
1800 }
1801 void BURegReductionFastPriorityQueue::CalculateSethiUllmanNumbers() {
1802   SethiUllmanNumbers.assign(SUnits->size(), 0);
1803
1804   for (unsigned i = 0, e = SUnits->size(); i != e; ++i)
1805     CalcNodeBUSethiUllmanNumber(&(*SUnits)[i], SethiUllmanNumbers);
1806 }
1807
1808 /// LimitedSumOfUnscheduledPredsOfSuccs - Compute the sum of the unscheduled
1809 /// predecessors of the successors of the SUnit SU. Stop when the provided
1810 /// limit is exceeded.
1811 static unsigned LimitedSumOfUnscheduledPredsOfSuccs(const SUnit *SU,
1812                                                     unsigned Limit) {
1813   unsigned Sum = 0;
1814   for (SUnit::const_succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
1815        I != E; ++I) {
1816     const SUnit *SuccSU = I->Dep;
1817     for (SUnit::const_pred_iterator II = SuccSU->Preds.begin(),
1818          EE = SuccSU->Preds.end(); II != EE; ++II) {
1819       SUnit *PredSU = II->Dep;
1820       if (!PredSU->isScheduled)
1821         if (++Sum > Limit)
1822           return Sum;
1823     }
1824   }
1825   return Sum;
1826 }
1827
1828
1829 // Top down
1830 bool td_ls_rr_sort::operator()(const SUnit *left, const SUnit *right) const {
1831   unsigned LPriority = SPQ->getNodePriority(left);
1832   unsigned RPriority = SPQ->getNodePriority(right);
1833   bool LIsTarget = left->Node && left->Node->isMachineOpcode();
1834   bool RIsTarget = right->Node && right->Node->isMachineOpcode();
1835   bool LIsFloater = LIsTarget && left->NumPreds == 0;
1836   bool RIsFloater = RIsTarget && right->NumPreds == 0;
1837   unsigned LBonus = (LimitedSumOfUnscheduledPredsOfSuccs(left,1) == 1) ? 2 : 0;
1838   unsigned RBonus = (LimitedSumOfUnscheduledPredsOfSuccs(right,1) == 1) ? 2 : 0;
1839
1840   if (left->NumSuccs == 0 && right->NumSuccs != 0)
1841     return false;
1842   else if (left->NumSuccs != 0 && right->NumSuccs == 0)
1843     return true;
1844
1845   if (LIsFloater)
1846     LBonus -= 2;
1847   if (RIsFloater)
1848     RBonus -= 2;
1849   if (left->NumSuccs == 1)
1850     LBonus += 2;
1851   if (right->NumSuccs == 1)
1852     RBonus += 2;
1853
1854   if (LPriority+LBonus != RPriority+RBonus)
1855     return LPriority+LBonus < RPriority+RBonus;
1856
1857   if (left->Depth != right->Depth)
1858     return left->Depth < right->Depth;
1859
1860   if (left->NumSuccsLeft != right->NumSuccsLeft)
1861     return left->NumSuccsLeft > right->NumSuccsLeft;
1862
1863   if (left->CycleBound != right->CycleBound)
1864     return left->CycleBound > right->CycleBound;
1865
1866   assert(left->NodeQueueId && right->NodeQueueId &&
1867          "NodeQueueId cannot be zero");
1868   return (left->NodeQueueId > right->NodeQueueId);
1869 }
1870
1871 /// CalculateSethiUllmanNumbers - Calculate Sethi-Ullman numbers of all
1872 /// scheduling units.
1873 void TDRegReductionPriorityQueue::CalculateSethiUllmanNumbers() {
1874   SethiUllmanNumbers.assign(SUnits->size(), 0);
1875
1876   for (unsigned i = 0, e = SUnits->size(); i != e; ++i)
1877     CalcNodeTDSethiUllmanNumber(&(*SUnits)[i], SethiUllmanNumbers);
1878 }
1879
1880 //===----------------------------------------------------------------------===//
1881 //                         Public Constructor Functions
1882 //===----------------------------------------------------------------------===//
1883
1884 llvm::ScheduleDAG* llvm::createBURRListDAGScheduler(SelectionDAGISel *IS,
1885                                                     SelectionDAG *DAG,
1886                                                     MachineBasicBlock *BB,
1887                                                     bool Fast) {
1888   if (Fast)
1889     return new ScheduleDAGRRList(*DAG, BB, DAG->getTarget(), true, true,
1890                                  new BURegReductionFastPriorityQueue());
1891
1892   const TargetInstrInfo *TII = DAG->getTarget().getInstrInfo();
1893   const TargetRegisterInfo *TRI = DAG->getTarget().getRegisterInfo();
1894
1895   BURegReductionPriorityQueue *PQ = new BURegReductionPriorityQueue(TII, TRI);
1896
1897   ScheduleDAGRRList *SD =
1898     new ScheduleDAGRRList(*DAG, BB, DAG->getTarget(),true,false, PQ);
1899   PQ->setScheduleDAG(SD);
1900   return SD;
1901 }
1902
1903 llvm::ScheduleDAG* llvm::createTDRRListDAGScheduler(SelectionDAGISel *IS,
1904                                                     SelectionDAG *DAG,
1905                                                     MachineBasicBlock *BB,
1906                                                     bool Fast) {
1907   return new ScheduleDAGRRList(*DAG, BB, DAG->getTarget(), false, Fast,
1908                                new TDRegReductionPriorityQueue());
1909 }