1 //==- MachineScheduler.h - MachineInstr Scheduling Pass ----------*- C++ -*-==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file provides a MachineSchedRegistry for registering alternative machine
11 // schedulers. A Target may provide an alternative scheduler implementation by
12 // implementing the following boilerplate:
14 // static ScheduleDAGInstrs *createCustomMachineSched(MachineSchedContext *C) {
15 // return new CustomMachineScheduler(C);
17 // static MachineSchedRegistry
18 // SchedCustomRegistry("custom", "Run my target's custom scheduler",
19 // createCustomMachineSched);
21 // Inside <Target>PassConfig:
22 // enablePass(&MachineSchedulerID);
23 // MachineSchedRegistry::setDefault(createCustomMachineSched);
25 //===----------------------------------------------------------------------===//
27 #ifndef MACHINESCHEDULER_H
28 #define MACHINESCHEDULER_H
30 #include "llvm/CodeGen/MachinePassRegistry.h"
31 #include "llvm/CodeGen/RegisterPressure.h"
32 #include "llvm/CodeGen/ScheduleDAGInstrs.h"
33 #include "llvm/Target/TargetInstrInfo.h"
37 extern cl::opt<bool> ForceTopDown;
38 extern cl::opt<bool> ForceBottomUp;
42 class MachineDominatorTree;
43 class MachineLoopInfo;
44 class RegisterClassInfo;
45 class ScheduleDAGInstrs;
47 /// MachineSchedContext provides enough context from the MachineScheduler pass
48 /// for the target to instantiate a scheduler.
49 struct MachineSchedContext {
51 const MachineLoopInfo *MLI;
52 const MachineDominatorTree *MDT;
53 const TargetPassConfig *PassConfig;
57 RegisterClassInfo *RegClassInfo;
59 MachineSchedContext();
60 virtual ~MachineSchedContext();
63 /// MachineSchedRegistry provides a selection of available machine instruction
65 class MachineSchedRegistry : public MachinePassRegistryNode {
67 typedef ScheduleDAGInstrs *(*ScheduleDAGCtor)(MachineSchedContext *);
69 // RegisterPassParser requires a (misnamed) FunctionPassCtor type.
70 typedef ScheduleDAGCtor FunctionPassCtor;
72 static MachinePassRegistry Registry;
74 MachineSchedRegistry(const char *N, const char *D, ScheduleDAGCtor C)
75 : MachinePassRegistryNode(N, D, (MachinePassCtor)C) {
78 ~MachineSchedRegistry() { Registry.Remove(this); }
82 MachineSchedRegistry *getNext() const {
83 return (MachineSchedRegistry *)MachinePassRegistryNode::getNext();
85 static MachineSchedRegistry *getList() {
86 return (MachineSchedRegistry *)Registry.getList();
88 static ScheduleDAGCtor getDefault() {
89 return (ScheduleDAGCtor)Registry.getDefault();
91 static void setDefault(ScheduleDAGCtor C) {
92 Registry.setDefault((MachinePassCtor)C);
94 static void setDefault(StringRef Name) {
95 Registry.setDefault(Name);
97 static void setListener(MachinePassRegistryListener *L) {
98 Registry.setListener(L);
104 /// MachineSchedStrategy - Interface to the scheduling algorithm used by
106 class MachineSchedStrategy {
108 virtual ~MachineSchedStrategy() {}
110 /// Initialize the strategy after building the DAG for a new region.
111 virtual void initialize(ScheduleDAGMI *DAG) = 0;
113 /// Notify this strategy that all roots have been released (including those
114 /// that depend on EntrySU or ExitSU).
115 virtual void registerRoots() {}
117 /// Pick the next node to schedule, or return NULL. Set IsTopNode to true to
118 /// schedule the node at the top of the unscheduled region. Otherwise it will
119 /// be scheduled at the bottom.
120 virtual SUnit *pickNode(bool &IsTopNode) = 0;
122 /// Notify MachineSchedStrategy that ScheduleDAGMI has scheduled an
123 /// instruction and updated scheduled/remaining flags in the DAG nodes.
124 virtual void schedNode(SUnit *SU, bool IsTopNode) = 0;
126 /// When all predecessor dependencies have been resolved, free this node for
127 /// top-down scheduling.
128 virtual void releaseTopNode(SUnit *SU) = 0;
129 /// When all successor dependencies have been resolved, free this node for
130 /// bottom-up scheduling.
131 virtual void releaseBottomNode(SUnit *SU) = 0;
134 /// ReadyQueue encapsulates vector of "ready" SUnits with basic convenience
135 /// methods for pushing and removing nodes. ReadyQueue's are uniquely identified
136 /// by an ID. SUnit::NodeQueueId is a mask of the ReadyQueues the SUnit is in.
138 /// This is a convenience class that may be used by implementations of
139 /// MachineSchedStrategy.
143 std::vector<SUnit*> Queue;
146 ReadyQueue(unsigned id, const Twine &name): ID(id), Name(name.str()) {}
148 unsigned getID() const { return ID; }
150 StringRef getName() const { return Name; }
152 // SU is in this queue if it's NodeQueueID is a superset of this ID.
153 bool isInQueue(SUnit *SU) const { return (SU->NodeQueueId & ID); }
155 bool empty() const { return Queue.empty(); }
157 void clear() { Queue.clear(); }
159 unsigned size() const { return Queue.size(); }
161 typedef std::vector<SUnit*>::iterator iterator;
163 iterator begin() { return Queue.begin(); }
165 iterator end() { return Queue.end(); }
167 iterator find(SUnit *SU) {
168 return std::find(Queue.begin(), Queue.end(), SU);
171 void push(SUnit *SU) {
173 SU->NodeQueueId |= ID;
176 iterator remove(iterator I) {
177 (*I)->NodeQueueId &= ~ID;
179 unsigned idx = I - Queue.begin();
181 return Queue.begin() + idx;
184 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
189 /// Mutate the DAG as a postpass after normal DAG building.
190 class ScheduleDAGMutation {
192 virtual ~ScheduleDAGMutation() {}
194 virtual void apply(ScheduleDAGMI *DAG) = 0;
197 /// ScheduleDAGMI is an implementation of ScheduleDAGInstrs that schedules
198 /// machine instructions while updating LiveIntervals and tracking regpressure.
199 class ScheduleDAGMI : public ScheduleDAGInstrs {
202 RegisterClassInfo *RegClassInfo;
203 MachineSchedStrategy *SchedImpl;
205 /// Topo - A topological ordering for SUnits which permits fast IsReachable
206 /// and similar queries.
207 ScheduleDAGTopologicalSort Topo;
209 /// Ordered list of DAG postprocessing steps.
210 std::vector<ScheduleDAGMutation*> Mutations;
212 MachineBasicBlock::iterator LiveRegionEnd;
214 /// Register pressure in this region computed by buildSchedGraph.
215 IntervalPressure RegPressure;
216 RegPressureTracker RPTracker;
218 /// List of pressure sets that exceed the target's pressure limit before
219 /// scheduling, listed in increasing set ID order. Each pressure set is paired
220 /// with its max pressure in the currently scheduled regions.
221 std::vector<PressureElement> RegionCriticalPSets;
223 /// The top of the unscheduled zone.
224 MachineBasicBlock::iterator CurrentTop;
225 IntervalPressure TopPressure;
226 RegPressureTracker TopRPTracker;
228 /// The bottom of the unscheduled zone.
229 MachineBasicBlock::iterator CurrentBottom;
230 IntervalPressure BotPressure;
231 RegPressureTracker BotRPTracker;
233 /// Record the next node in a scheduled cluster.
234 const SUnit *NextClusterPred;
235 const SUnit *NextClusterSucc;
238 /// The number of instructions scheduled so far. Used to cut off the
239 /// scheduler at the point determined by misched-cutoff.
240 unsigned NumInstrsScheduled;
244 ScheduleDAGMI(MachineSchedContext *C, MachineSchedStrategy *S):
245 ScheduleDAGInstrs(*C->MF, *C->MLI, *C->MDT, /*IsPostRA=*/false, C->LIS),
246 AA(C->AA), RegClassInfo(C->RegClassInfo), SchedImpl(S),
247 Topo(SUnits, &ExitSU), RPTracker(RegPressure), CurrentTop(),
248 TopRPTracker(TopPressure), CurrentBottom(), BotRPTracker(BotPressure),
249 NextClusterPred(NULL), NextClusterSucc(NULL) {
251 NumInstrsScheduled = 0;
255 virtual ~ScheduleDAGMI() {
256 DeleteContainerPointers(Mutations);
260 /// Add a postprocessing step to the DAG builder.
261 /// Mutations are applied in the order that they are added after normal DAG
262 /// building and before MachineSchedStrategy initialization.
264 /// ScheduleDAGMI takes ownership of the Mutation object.
265 void addMutation(ScheduleDAGMutation *Mutation) {
266 Mutations.push_back(Mutation);
269 /// \brief Add a DAG edge to the given SU with the given predecessor
272 /// \returns true if the edge may be added without creating a cycle OR if an
273 /// equivalent edge already existed (false indicates failure).
274 bool addEdge(SUnit *SuccSU, const SDep &PredDep);
276 MachineBasicBlock::iterator top() const { return CurrentTop; }
277 MachineBasicBlock::iterator bottom() const { return CurrentBottom; }
279 /// Implement the ScheduleDAGInstrs interface for handling the next scheduling
280 /// region. This covers all instructions in a block, while schedule() may only
282 void enterRegion(MachineBasicBlock *bb,
283 MachineBasicBlock::iterator begin,
284 MachineBasicBlock::iterator end,
288 /// Implement ScheduleDAGInstrs interface for scheduling a sequence of
289 /// reorderable instructions.
290 virtual void schedule();
292 /// Get current register pressure for the top scheduled instructions.
293 const IntervalPressure &getTopPressure() const { return TopPressure; }
294 const RegPressureTracker &getTopRPTracker() const { return TopRPTracker; }
296 /// Get current register pressure for the bottom scheduled instructions.
297 const IntervalPressure &getBotPressure() const { return BotPressure; }
298 const RegPressureTracker &getBotRPTracker() const { return BotRPTracker; }
300 /// Get register pressure for the entire scheduling region before scheduling.
301 const IntervalPressure &getRegPressure() const { return RegPressure; }
303 const std::vector<PressureElement> &getRegionCriticalPSets() const {
304 return RegionCriticalPSets;
307 const SUnit *getNextClusterPred() const { return NextClusterPred; }
309 const SUnit *getNextClusterSucc() const { return NextClusterSucc; }
312 // Top-Level entry points for the schedule() driver...
314 /// Call ScheduleDAGInstrs::buildSchedGraph with register pressure tracking
315 /// enabled. This sets up three trackers. RPTracker will cover the entire DAG
316 /// region, TopTracker and BottomTracker will be initialized to the top and
317 /// bottom of the DAG region without covereing any unscheduled instruction.
318 void buildDAGWithRegPressure();
320 /// Apply each ScheduleDAGMutation step in order. This allows different
321 /// instances of ScheduleDAGMI to perform custom DAG postprocessing.
322 void postprocessDAG();
324 /// Identify DAG roots and setup scheduler queues.
327 /// Move an instruction and update register pressure.
328 void scheduleMI(SUnit *SU, bool IsTopNode);
330 /// Update scheduler DAG and queues after scheduling an instruction.
331 void updateQueues(SUnit *SU, bool IsTopNode);
333 /// Reinsert debug_values recorded in ScheduleDAGInstrs::DbgValues.
334 void placeDebugValues();
336 /// \brief dump the scheduled Sequence.
337 void dumpSchedule() const;
341 void initRegPressure();
343 void updateScheduledPressure(std::vector<unsigned> NewMaxPressure);
345 void moveInstruction(MachineInstr *MI, MachineBasicBlock::iterator InsertPos);
346 bool checkSchedLimit();
350 void releaseSucc(SUnit *SU, SDep *SuccEdge);
351 void releaseSuccessors(SUnit *SU);
352 void releasePred(SUnit *SU, SDep *PredEdge);
353 void releasePredecessors(SUnit *SU);