Machine Model: Add MicroOpBufferSize and resource BufferSize.
[oota-llvm.git] / lib / Target / Hexagon / HexagonMachineScheduler.cpp
1 //===- HexagonMachineScheduler.cpp - MI Scheduler for Hexagon -------------===//
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 // MachineScheduler schedules machine instructions after phi elimination. It
11 // preserves LiveIntervals so it can be invoked before register allocation.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #define DEBUG_TYPE "misched"
16
17 #include "HexagonMachineScheduler.h"
18 #include "llvm/CodeGen/MachineLoopInfo.h"
19 #include "llvm/IR/Function.h"
20
21 using namespace llvm;
22
23 /// Platform specific modifications to DAG.
24 void VLIWMachineScheduler::postprocessDAG() {
25   SUnit* LastSequentialCall = NULL;
26   // Currently we only catch the situation when compare gets scheduled
27   // before preceding call.
28   for (unsigned su = 0, e = SUnits.size(); su != e; ++su) {
29     // Remember the call.
30     if (SUnits[su].getInstr()->isCall())
31       LastSequentialCall = &(SUnits[su]);
32     // Look for a compare that defines a predicate.
33     else if (SUnits[su].getInstr()->isCompare() && LastSequentialCall)
34       SUnits[su].addPred(SDep(LastSequentialCall, SDep::Barrier));
35   }
36 }
37
38 /// Check if scheduling of this SU is possible
39 /// in the current packet.
40 /// It is _not_ precise (statefull), it is more like
41 /// another heuristic. Many corner cases are figured
42 /// empirically.
43 bool VLIWResourceModel::isResourceAvailable(SUnit *SU) {
44   if (!SU || !SU->getInstr())
45     return false;
46
47   // First see if the pipeline could receive this instruction
48   // in the current cycle.
49   switch (SU->getInstr()->getOpcode()) {
50   default:
51     if (!ResourcesModel->canReserveResources(SU->getInstr()))
52       return false;
53   case TargetOpcode::EXTRACT_SUBREG:
54   case TargetOpcode::INSERT_SUBREG:
55   case TargetOpcode::SUBREG_TO_REG:
56   case TargetOpcode::REG_SEQUENCE:
57   case TargetOpcode::IMPLICIT_DEF:
58   case TargetOpcode::COPY:
59   case TargetOpcode::INLINEASM:
60     break;
61   }
62
63   // Now see if there are no other dependencies to instructions already
64   // in the packet.
65   for (unsigned i = 0, e = Packet.size(); i != e; ++i) {
66     if (Packet[i]->Succs.size() == 0)
67       continue;
68     for (SUnit::const_succ_iterator I = Packet[i]->Succs.begin(),
69          E = Packet[i]->Succs.end(); I != E; ++I) {
70       // Since we do not add pseudos to packets, might as well
71       // ignore order dependencies.
72       if (I->isCtrl())
73         continue;
74
75       if (I->getSUnit() == SU)
76         return false;
77     }
78   }
79   return true;
80 }
81
82 /// Keep track of available resources.
83 bool VLIWResourceModel::reserveResources(SUnit *SU) {
84   bool startNewCycle = false;
85   // Artificially reset state.
86   if (!SU) {
87     ResourcesModel->clearResources();
88     Packet.clear();
89     TotalPackets++;
90     return false;
91   }
92   // If this SU does not fit in the packet
93   // start a new one.
94   if (!isResourceAvailable(SU)) {
95     ResourcesModel->clearResources();
96     Packet.clear();
97     TotalPackets++;
98     startNewCycle = true;
99   }
100
101   switch (SU->getInstr()->getOpcode()) {
102   default:
103     ResourcesModel->reserveResources(SU->getInstr());
104     break;
105   case TargetOpcode::EXTRACT_SUBREG:
106   case TargetOpcode::INSERT_SUBREG:
107   case TargetOpcode::SUBREG_TO_REG:
108   case TargetOpcode::REG_SEQUENCE:
109   case TargetOpcode::IMPLICIT_DEF:
110   case TargetOpcode::KILL:
111   case TargetOpcode::PROLOG_LABEL:
112   case TargetOpcode::EH_LABEL:
113   case TargetOpcode::COPY:
114   case TargetOpcode::INLINEASM:
115     break;
116   }
117   Packet.push_back(SU);
118
119 #ifndef NDEBUG
120   DEBUG(dbgs() << "Packet[" << TotalPackets << "]:\n");
121   for (unsigned i = 0, e = Packet.size(); i != e; ++i) {
122     DEBUG(dbgs() << "\t[" << i << "] SU(");
123     DEBUG(dbgs() << Packet[i]->NodeNum << ")\t");
124     DEBUG(Packet[i]->getInstr()->dump());
125   }
126 #endif
127
128   // If packet is now full, reset the state so in the next cycle
129   // we start fresh.
130   if (Packet.size() >= SchedModel->getIssueWidth()) {
131     ResourcesModel->clearResources();
132     Packet.clear();
133     TotalPackets++;
134     startNewCycle = true;
135   }
136
137   return startNewCycle;
138 }
139
140 /// schedule - Called back from MachineScheduler::runOnMachineFunction
141 /// after setting up the current scheduling region. [RegionBegin, RegionEnd)
142 /// only includes instructions that have DAG nodes, not scheduling boundaries.
143 void VLIWMachineScheduler::schedule() {
144   DEBUG(dbgs()
145         << "********** MI Converging Scheduling VLIW BB#" << BB->getNumber()
146         << " " << BB->getName()
147         << " in_func " << BB->getParent()->getFunction()->getName()
148         << " at loop depth "  << MLI.getLoopDepth(BB)
149         << " \n");
150
151   buildDAGWithRegPressure();
152
153   // Postprocess the DAG to add platform specific artificial dependencies.
154   postprocessDAG();
155
156   SmallVector<SUnit*, 8> TopRoots, BotRoots;
157   findRootsAndBiasEdges(TopRoots, BotRoots);
158
159   // Initialize the strategy before modifying the DAG.
160   SchedImpl->initialize(this);
161
162   // To view Height/Depth correctly, they should be accessed at least once.
163   //
164   // FIXME: SUnit::dumpAll always recompute depth and height now. The max
165   // depth/height could be computed directly from the roots and leaves.
166   DEBUG(unsigned maxH = 0;
167         for (unsigned su = 0, e = SUnits.size(); su != e; ++su)
168           if (SUnits[su].getHeight() > maxH)
169             maxH = SUnits[su].getHeight();
170         dbgs() << "Max Height " << maxH << "\n";);
171   DEBUG(unsigned maxD = 0;
172         for (unsigned su = 0, e = SUnits.size(); su != e; ++su)
173           if (SUnits[su].getDepth() > maxD)
174             maxD = SUnits[su].getDepth();
175         dbgs() << "Max Depth " << maxD << "\n";);
176   DEBUG(for (unsigned su = 0, e = SUnits.size(); su != e; ++su)
177           SUnits[su].dumpAll(this));
178
179   initQueues(TopRoots, BotRoots);
180
181   bool IsTopNode = false;
182   while (SUnit *SU = SchedImpl->pickNode(IsTopNode)) {
183     if (!checkSchedLimit())
184       break;
185
186     scheduleMI(SU, IsTopNode);
187
188     updateQueues(SU, IsTopNode);
189   }
190   assert(CurrentTop == CurrentBottom && "Nonempty unscheduled zone.");
191
192   placeDebugValues();
193 }
194
195 void ConvergingVLIWScheduler::initialize(ScheduleDAGMI *dag) {
196   DAG = static_cast<VLIWMachineScheduler*>(dag);
197   SchedModel = DAG->getSchedModel();
198
199   Top.init(DAG, SchedModel);
200   Bot.init(DAG, SchedModel);
201
202   // Initialize the HazardRecognizers. If itineraries don't exist, are empty, or
203   // are disabled, then these HazardRecs will be disabled.
204   const InstrItineraryData *Itin = DAG->getSchedModel()->getInstrItineraries();
205   const TargetMachine &TM = DAG->MF.getTarget();
206   delete Top.HazardRec;
207   delete Bot.HazardRec;
208   Top.HazardRec = TM.getInstrInfo()->CreateTargetMIHazardRecognizer(Itin, DAG);
209   Bot.HazardRec = TM.getInstrInfo()->CreateTargetMIHazardRecognizer(Itin, DAG);
210
211   Top.ResourceModel = new VLIWResourceModel(TM, DAG->getSchedModel());
212   Bot.ResourceModel = new VLIWResourceModel(TM, DAG->getSchedModel());
213
214   assert((!llvm::ForceTopDown || !llvm::ForceBottomUp) &&
215          "-misched-topdown incompatible with -misched-bottomup");
216 }
217
218 void ConvergingVLIWScheduler::releaseTopNode(SUnit *SU) {
219   if (SU->isScheduled)
220     return;
221
222   for (SUnit::succ_iterator I = SU->Preds.begin(), E = SU->Preds.end();
223        I != E; ++I) {
224     unsigned PredReadyCycle = I->getSUnit()->TopReadyCycle;
225     unsigned MinLatency = I->getLatency();
226 #ifndef NDEBUG
227     Top.MaxMinLatency = std::max(MinLatency, Top.MaxMinLatency);
228 #endif
229     if (SU->TopReadyCycle < PredReadyCycle + MinLatency)
230       SU->TopReadyCycle = PredReadyCycle + MinLatency;
231   }
232   Top.releaseNode(SU, SU->TopReadyCycle);
233 }
234
235 void ConvergingVLIWScheduler::releaseBottomNode(SUnit *SU) {
236   if (SU->isScheduled)
237     return;
238
239   assert(SU->getInstr() && "Scheduled SUnit must have instr");
240
241   for (SUnit::succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
242        I != E; ++I) {
243     unsigned SuccReadyCycle = I->getSUnit()->BotReadyCycle;
244     unsigned MinLatency = I->getLatency();
245 #ifndef NDEBUG
246     Bot.MaxMinLatency = std::max(MinLatency, Bot.MaxMinLatency);
247 #endif
248     if (SU->BotReadyCycle < SuccReadyCycle + MinLatency)
249       SU->BotReadyCycle = SuccReadyCycle + MinLatency;
250   }
251   Bot.releaseNode(SU, SU->BotReadyCycle);
252 }
253
254 /// Does this SU have a hazard within the current instruction group.
255 ///
256 /// The scheduler supports two modes of hazard recognition. The first is the
257 /// ScheduleHazardRecognizer API. It is a fully general hazard recognizer that
258 /// supports highly complicated in-order reservation tables
259 /// (ScoreboardHazardRecognizer) and arbitrary target-specific logic.
260 ///
261 /// The second is a streamlined mechanism that checks for hazards based on
262 /// simple counters that the scheduler itself maintains. It explicitly checks
263 /// for instruction dispatch limitations, including the number of micro-ops that
264 /// can dispatch per cycle.
265 ///
266 /// TODO: Also check whether the SU must start a new group.
267 bool ConvergingVLIWScheduler::SchedBoundary::checkHazard(SUnit *SU) {
268   if (HazardRec->isEnabled())
269     return HazardRec->getHazardType(SU) != ScheduleHazardRecognizer::NoHazard;
270
271   unsigned uops = SchedModel->getNumMicroOps(SU->getInstr());
272   if (IssueCount + uops > SchedModel->getIssueWidth())
273     return true;
274
275   return false;
276 }
277
278 void ConvergingVLIWScheduler::SchedBoundary::releaseNode(SUnit *SU,
279                                                      unsigned ReadyCycle) {
280   if (ReadyCycle < MinReadyCycle)
281     MinReadyCycle = ReadyCycle;
282
283   // Check for interlocks first. For the purpose of other heuristics, an
284   // instruction that cannot issue appears as if it's not in the ReadyQueue.
285   if (ReadyCycle > CurrCycle || checkHazard(SU))
286
287     Pending.push(SU);
288   else
289     Available.push(SU);
290 }
291
292 /// Move the boundary of scheduled code by one cycle.
293 void ConvergingVLIWScheduler::SchedBoundary::bumpCycle() {
294   unsigned Width = SchedModel->getIssueWidth();
295   IssueCount = (IssueCount <= Width) ? 0 : IssueCount - Width;
296
297   assert(MinReadyCycle < UINT_MAX && "MinReadyCycle uninitialized");
298   unsigned NextCycle = std::max(CurrCycle + 1, MinReadyCycle);
299
300   if (!HazardRec->isEnabled()) {
301     // Bypass HazardRec virtual calls.
302     CurrCycle = NextCycle;
303   } else {
304     // Bypass getHazardType calls in case of long latency.
305     for (; CurrCycle != NextCycle; ++CurrCycle) {
306       if (isTop())
307         HazardRec->AdvanceCycle();
308       else
309         HazardRec->RecedeCycle();
310     }
311   }
312   CheckPending = true;
313
314   DEBUG(dbgs() << "*** " << Available.getName() << " cycle "
315         << CurrCycle << '\n');
316 }
317
318 /// Move the boundary of scheduled code by one SUnit.
319 void ConvergingVLIWScheduler::SchedBoundary::bumpNode(SUnit *SU) {
320   bool startNewCycle = false;
321
322   // Update the reservation table.
323   if (HazardRec->isEnabled()) {
324     if (!isTop() && SU->isCall) {
325       // Calls are scheduled with their preceding instructions. For bottom-up
326       // scheduling, clear the pipeline state before emitting.
327       HazardRec->Reset();
328     }
329     HazardRec->EmitInstruction(SU);
330   }
331
332   // Update DFA model.
333   startNewCycle = ResourceModel->reserveResources(SU);
334
335   // Check the instruction group dispatch limit.
336   // TODO: Check if this SU must end a dispatch group.
337   IssueCount += SchedModel->getNumMicroOps(SU->getInstr());
338   if (startNewCycle) {
339     DEBUG(dbgs() << "*** Max instrs at cycle " << CurrCycle << '\n');
340     bumpCycle();
341   }
342   else
343     DEBUG(dbgs() << "*** IssueCount " << IssueCount
344           << " at cycle " << CurrCycle << '\n');
345 }
346
347 /// Release pending ready nodes in to the available queue. This makes them
348 /// visible to heuristics.
349 void ConvergingVLIWScheduler::SchedBoundary::releasePending() {
350   // If the available queue is empty, it is safe to reset MinReadyCycle.
351   if (Available.empty())
352     MinReadyCycle = UINT_MAX;
353
354   // Check to see if any of the pending instructions are ready to issue.  If
355   // so, add them to the available queue.
356   for (unsigned i = 0, e = Pending.size(); i != e; ++i) {
357     SUnit *SU = *(Pending.begin()+i);
358     unsigned ReadyCycle = isTop() ? SU->TopReadyCycle : SU->BotReadyCycle;
359
360     if (ReadyCycle < MinReadyCycle)
361       MinReadyCycle = ReadyCycle;
362
363     if (ReadyCycle > CurrCycle)
364       continue;
365
366     if (checkHazard(SU))
367       continue;
368
369     Available.push(SU);
370     Pending.remove(Pending.begin()+i);
371     --i; --e;
372   }
373   CheckPending = false;
374 }
375
376 /// Remove SU from the ready set for this boundary.
377 void ConvergingVLIWScheduler::SchedBoundary::removeReady(SUnit *SU) {
378   if (Available.isInQueue(SU))
379     Available.remove(Available.find(SU));
380   else {
381     assert(Pending.isInQueue(SU) && "bad ready count");
382     Pending.remove(Pending.find(SU));
383   }
384 }
385
386 /// If this queue only has one ready candidate, return it. As a side effect,
387 /// advance the cycle until at least one node is ready. If multiple instructions
388 /// are ready, return NULL.
389 SUnit *ConvergingVLIWScheduler::SchedBoundary::pickOnlyChoice() {
390   if (CheckPending)
391     releasePending();
392
393   for (unsigned i = 0; Available.empty(); ++i) {
394     assert(i <= (HazardRec->getMaxLookAhead() + MaxMinLatency) &&
395            "permanent hazard"); (void)i;
396     ResourceModel->reserveResources(0);
397     bumpCycle();
398     releasePending();
399   }
400   if (Available.size() == 1)
401     return *Available.begin();
402   return NULL;
403 }
404
405 #ifndef NDEBUG
406 void ConvergingVLIWScheduler::traceCandidate(const char *Label,
407                                              const ReadyQueue &Q,
408                                              SUnit *SU, PressureElement P) {
409   dbgs() << Label << " " << Q.getName() << " ";
410   if (P.isValid())
411     dbgs() << DAG->TRI->getRegPressureSetName(P.PSetID) << ":" << P.UnitIncrease
412            << " ";
413   else
414     dbgs() << "     ";
415   SU->dump(DAG);
416 }
417 #endif
418
419 /// getSingleUnscheduledPred - If there is exactly one unscheduled predecessor
420 /// of SU, return it, otherwise return null.
421 static SUnit *getSingleUnscheduledPred(SUnit *SU) {
422   SUnit *OnlyAvailablePred = 0;
423   for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
424        I != E; ++I) {
425     SUnit &Pred = *I->getSUnit();
426     if (!Pred.isScheduled) {
427       // We found an available, but not scheduled, predecessor.  If it's the
428       // only one we have found, keep track of it... otherwise give up.
429       if (OnlyAvailablePred && OnlyAvailablePred != &Pred)
430         return 0;
431       OnlyAvailablePred = &Pred;
432     }
433   }
434   return OnlyAvailablePred;
435 }
436
437 /// getSingleUnscheduledSucc - If there is exactly one unscheduled successor
438 /// of SU, return it, otherwise return null.
439 static SUnit *getSingleUnscheduledSucc(SUnit *SU) {
440   SUnit *OnlyAvailableSucc = 0;
441   for (SUnit::const_succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
442        I != E; ++I) {
443     SUnit &Succ = *I->getSUnit();
444     if (!Succ.isScheduled) {
445       // We found an available, but not scheduled, successor.  If it's the
446       // only one we have found, keep track of it... otherwise give up.
447       if (OnlyAvailableSucc && OnlyAvailableSucc != &Succ)
448         return 0;
449       OnlyAvailableSucc = &Succ;
450     }
451   }
452   return OnlyAvailableSucc;
453 }
454
455 // Constants used to denote relative importance of
456 // heuristic components for cost computation.
457 static const unsigned PriorityOne = 200;
458 static const unsigned PriorityTwo = 100;
459 static const unsigned PriorityThree = 50;
460 static const unsigned PriorityFour = 20;
461 static const unsigned ScaleTwo = 10;
462 static const unsigned FactorOne = 2;
463
464 /// Single point to compute overall scheduling cost.
465 /// TODO: More heuristics will be used soon.
466 int ConvergingVLIWScheduler::SchedulingCost(ReadyQueue &Q, SUnit *SU,
467                                             SchedCandidate &Candidate,
468                                             RegPressureDelta &Delta,
469                                             bool verbose) {
470   // Initial trivial priority.
471   int ResCount = 1;
472
473   // Do not waste time on a node that is already scheduled.
474   if (!SU || SU->isScheduled)
475     return ResCount;
476
477   // Forced priority is high.
478   if (SU->isScheduleHigh)
479     ResCount += PriorityOne;
480
481   // Critical path first.
482   if (Q.getID() == TopQID) {
483     ResCount += (SU->getHeight() * ScaleTwo);
484
485     // If resources are available for it, multiply the
486     // chance of scheduling.
487     if (Top.ResourceModel->isResourceAvailable(SU))
488       ResCount <<= FactorOne;
489   } else {
490     ResCount += (SU->getDepth() * ScaleTwo);
491
492     // If resources are available for it, multiply the
493     // chance of scheduling.
494     if (Bot.ResourceModel->isResourceAvailable(SU))
495       ResCount <<= FactorOne;
496   }
497
498   unsigned NumNodesBlocking = 0;
499   if (Q.getID() == TopQID) {
500     // How many SUs does it block from scheduling?
501     // Look at all of the successors of this node.
502     // Count the number of nodes that
503     // this node is the sole unscheduled node for.
504     for (SUnit::const_succ_iterator I = SU->Succs.begin(), E = SU->Succs.end();
505          I != E; ++I)
506       if (getSingleUnscheduledPred(I->getSUnit()) == SU)
507         ++NumNodesBlocking;
508   } else {
509     // How many unscheduled predecessors block this node?
510     for (SUnit::const_pred_iterator I = SU->Preds.begin(), E = SU->Preds.end();
511          I != E; ++I)
512       if (getSingleUnscheduledSucc(I->getSUnit()) == SU)
513         ++NumNodesBlocking;
514   }
515   ResCount += (NumNodesBlocking * ScaleTwo);
516
517   // Factor in reg pressure as a heuristic.
518   ResCount -= (Delta.Excess.UnitIncrease*PriorityThree);
519   ResCount -= (Delta.CriticalMax.UnitIncrease*PriorityThree);
520
521   DEBUG(if (verbose) dbgs() << " Total(" << ResCount << ")");
522
523   return ResCount;
524 }
525
526 /// Pick the best candidate from the top queue.
527 ///
528 /// TODO: getMaxPressureDelta results can be mostly cached for each SUnit during
529 /// DAG building. To adjust for the current scheduling location we need to
530 /// maintain the number of vreg uses remaining to be top-scheduled.
531 ConvergingVLIWScheduler::CandResult ConvergingVLIWScheduler::
532 pickNodeFromQueue(ReadyQueue &Q, const RegPressureTracker &RPTracker,
533                   SchedCandidate &Candidate) {
534   DEBUG(Q.dump());
535
536   // getMaxPressureDelta temporarily modifies the tracker.
537   RegPressureTracker &TempTracker = const_cast<RegPressureTracker&>(RPTracker);
538
539   // BestSU remains NULL if no top candidates beat the best existing candidate.
540   CandResult FoundCandidate = NoCand;
541   for (ReadyQueue::iterator I = Q.begin(), E = Q.end(); I != E; ++I) {
542     RegPressureDelta RPDelta;
543     TempTracker.getMaxPressureDelta((*I)->getInstr(), RPDelta,
544                                     DAG->getRegionCriticalPSets(),
545                                     DAG->getRegPressure().MaxSetPressure);
546
547     int CurrentCost = SchedulingCost(Q, *I, Candidate, RPDelta, false);
548
549     // Initialize the candidate if needed.
550     if (!Candidate.SU) {
551       Candidate.SU = *I;
552       Candidate.RPDelta = RPDelta;
553       Candidate.SCost = CurrentCost;
554       FoundCandidate = NodeOrder;
555       continue;
556     }
557
558     // Best cost.
559     if (CurrentCost > Candidate.SCost) {
560       DEBUG(traceCandidate("CCAND", Q, *I));
561       Candidate.SU = *I;
562       Candidate.RPDelta = RPDelta;
563       Candidate.SCost = CurrentCost;
564       FoundCandidate = BestCost;
565       continue;
566     }
567
568     // Fall through to original instruction order.
569     // Only consider node order if Candidate was chosen from this Q.
570     if (FoundCandidate == NoCand)
571       continue;
572   }
573   return FoundCandidate;
574 }
575
576 /// Pick the best candidate node from either the top or bottom queue.
577 SUnit *ConvergingVLIWScheduler::pickNodeBidrectional(bool &IsTopNode) {
578   // Schedule as far as possible in the direction of no choice. This is most
579   // efficient, but also provides the best heuristics for CriticalPSets.
580   if (SUnit *SU = Bot.pickOnlyChoice()) {
581     IsTopNode = false;
582     return SU;
583   }
584   if (SUnit *SU = Top.pickOnlyChoice()) {
585     IsTopNode = true;
586     return SU;
587   }
588   SchedCandidate BotCand;
589   // Prefer bottom scheduling when heuristics are silent.
590   CandResult BotResult = pickNodeFromQueue(Bot.Available,
591                                            DAG->getBotRPTracker(), BotCand);
592   assert(BotResult != NoCand && "failed to find the first candidate");
593
594   // If either Q has a single candidate that provides the least increase in
595   // Excess pressure, we can immediately schedule from that Q.
596   //
597   // RegionCriticalPSets summarizes the pressure within the scheduled region and
598   // affects picking from either Q. If scheduling in one direction must
599   // increase pressure for one of the excess PSets, then schedule in that
600   // direction first to provide more freedom in the other direction.
601   if (BotResult == SingleExcess || BotResult == SingleCritical) {
602     IsTopNode = false;
603     return BotCand.SU;
604   }
605   // Check if the top Q has a better candidate.
606   SchedCandidate TopCand;
607   CandResult TopResult = pickNodeFromQueue(Top.Available,
608                                            DAG->getTopRPTracker(), TopCand);
609   assert(TopResult != NoCand && "failed to find the first candidate");
610
611   if (TopResult == SingleExcess || TopResult == SingleCritical) {
612     IsTopNode = true;
613     return TopCand.SU;
614   }
615   // If either Q has a single candidate that minimizes pressure above the
616   // original region's pressure pick it.
617   if (BotResult == SingleMax) {
618     IsTopNode = false;
619     return BotCand.SU;
620   }
621   if (TopResult == SingleMax) {
622     IsTopNode = true;
623     return TopCand.SU;
624   }
625   if (TopCand.SCost > BotCand.SCost) {
626     IsTopNode = true;
627     return TopCand.SU;
628   }
629   // Otherwise prefer the bottom candidate in node order.
630   IsTopNode = false;
631   return BotCand.SU;
632 }
633
634 /// Pick the best node to balance the schedule. Implements MachineSchedStrategy.
635 SUnit *ConvergingVLIWScheduler::pickNode(bool &IsTopNode) {
636   if (DAG->top() == DAG->bottom()) {
637     assert(Top.Available.empty() && Top.Pending.empty() &&
638            Bot.Available.empty() && Bot.Pending.empty() && "ReadyQ garbage");
639     return NULL;
640   }
641   SUnit *SU;
642   if (llvm::ForceTopDown) {
643     SU = Top.pickOnlyChoice();
644     if (!SU) {
645       SchedCandidate TopCand;
646       CandResult TopResult =
647         pickNodeFromQueue(Top.Available, DAG->getTopRPTracker(), TopCand);
648       assert(TopResult != NoCand && "failed to find the first candidate");
649       (void)TopResult;
650       SU = TopCand.SU;
651     }
652     IsTopNode = true;
653   } else if (llvm::ForceBottomUp) {
654     SU = Bot.pickOnlyChoice();
655     if (!SU) {
656       SchedCandidate BotCand;
657       CandResult BotResult =
658         pickNodeFromQueue(Bot.Available, DAG->getBotRPTracker(), BotCand);
659       assert(BotResult != NoCand && "failed to find the first candidate");
660       (void)BotResult;
661       SU = BotCand.SU;
662     }
663     IsTopNode = false;
664   } else {
665     SU = pickNodeBidrectional(IsTopNode);
666   }
667   if (SU->isTopReady())
668     Top.removeReady(SU);
669   if (SU->isBottomReady())
670     Bot.removeReady(SU);
671
672   DEBUG(dbgs() << "*** " << (IsTopNode ? "Top" : "Bottom")
673         << " Scheduling Instruction in cycle "
674         << (IsTopNode ? Top.CurrCycle : Bot.CurrCycle) << '\n';
675         SU->dump(DAG));
676   return SU;
677 }
678
679 /// Update the scheduler's state after scheduling a node. This is the same node
680 /// that was just returned by pickNode(). However, VLIWMachineScheduler needs
681 /// to update it's state based on the current cycle before MachineSchedStrategy
682 /// does.
683 void ConvergingVLIWScheduler::schedNode(SUnit *SU, bool IsTopNode) {
684   if (IsTopNode) {
685     SU->TopReadyCycle = Top.CurrCycle;
686     Top.bumpNode(SU);
687   } else {
688     SU->BotReadyCycle = Bot.CurrCycle;
689     Bot.bumpNode(SU);
690   }
691 }