1 //===------- llvm/CodeGen/ScheduleDAG.h - Common Base Class------*- 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 implements the ScheduleDAG class, which is used as the common
11 // base class for instruction schedulers.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CODEGEN_SCHEDULEDAG_H
16 #define LLVM_CODEGEN_SCHEDULEDAG_H
18 #include "llvm/CodeGen/MachineBasicBlock.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/BitVector.h"
21 #include "llvm/ADT/GraphTraits.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/PointerIntPair.h"
27 class MachineConstantPool;
28 class MachineFunction;
29 class MachineModuleInfo;
30 class MachineRegisterInfo;
32 class TargetRegisterInfo;
36 class TargetInstrInfo;
37 class TargetInstrDesc;
40 class TargetRegisterClass;
41 template<class Graph> class GraphWriter;
43 /// SDep - Scheduling dependency. This represents one direction of an
44 /// edge in the scheduling DAG.
47 /// Kind - These are the different kinds of scheduling dependencies.
49 Data, ///< Regular data dependence (aka true-dependence).
50 Anti, ///< A register anti-dependedence (aka WAR).
51 Output, ///< A register output-dependence (aka WAW).
52 Order ///< Any other ordering dependency.
56 /// Dep - A pointer to the depending/depended-on SUnit, and an enum
57 /// indicating the kind of the dependency.
58 PointerIntPair<SUnit *, 2, Kind> Dep;
60 /// Contents - A union discriminated by the dependence kind.
62 /// Reg - For Data, Anti, and Output dependencies, the associated
63 /// register. For Data dependencies that don't currently have a register
64 /// assigned, this is set to zero.
67 /// Order - Additional information about Order dependencies.
69 /// isNormalMemory - True if both sides of the dependence
70 /// access memory in non-volatile and fully modeled ways.
71 bool isNormalMemory : 1;
73 /// isMustAlias - True if both sides of the dependence are known to
74 /// access the same memory.
77 /// isArtificial - True if this is an artificial dependency, meaning
78 /// it is not necessary for program correctness, and may be safely
79 /// deleted if necessary.
80 bool isArtificial : 1;
84 /// Latency - The time associated with this edge. Often this is just
85 /// the value of the Latency field of the predecessor, however advanced
86 /// models may provide additional information about specific edges.
90 /// SDep - Construct a null SDep. This is only for use by container
91 /// classes which require default constructors. SUnits may not
92 /// have null SDep edges.
93 SDep() : Dep(0, Data) {}
95 /// SDep - Construct an SDep with the specified values.
96 SDep(SUnit *S, Kind kind, unsigned latency = 1, unsigned Reg = 0,
97 bool isNormalMemory = false, bool isMustAlias = false,
98 bool isArtificial = false)
99 : Dep(S, kind), Contents(), Latency(latency) {
104 "SDep::Anti and SDep::Output must use a non-zero Reg!");
107 assert(!isMustAlias && "isMustAlias only applies with SDep::Order!");
108 assert(!isArtificial && "isArtificial only applies with SDep::Order!");
112 assert(Reg == 0 && "Reg given for non-register dependence!");
113 Contents.Order.isNormalMemory = isNormalMemory;
114 Contents.Order.isMustAlias = isMustAlias;
115 Contents.Order.isArtificial = isArtificial;
120 bool operator==(const SDep &Other) const {
121 if (Dep != Other.Dep || Latency != Other.Latency) return false;
122 switch (Dep.getInt()) {
126 return Contents.Reg == Other.Contents.Reg;
128 return Contents.Order.isNormalMemory ==
129 Other.Contents.Order.isNormalMemory &&
130 Contents.Order.isMustAlias == Other.Contents.Order.isMustAlias &&
131 Contents.Order.isArtificial == Other.Contents.Order.isArtificial;
133 assert(0 && "Invalid dependency kind!");
137 bool operator!=(const SDep &Other) const {
138 return !operator==(Other);
141 /// getLatency - Return the latency value for this edge, which roughly
142 /// means the minimum number of cycles that must elapse between the
143 /// predecessor and the successor, given that they have this edge
145 unsigned getLatency() const {
149 //// getSUnit - Return the SUnit to which this edge points.
150 SUnit *getSUnit() const {
151 return Dep.getPointer();
154 //// setSUnit - Assign the SUnit to which this edge points.
155 void setSUnit(SUnit *SU) {
159 /// getKind - Return an enum value representing the kind of the dependence.
160 Kind getKind() const {
164 /// isCtrl - Shorthand for getKind() != SDep::Data.
165 bool isCtrl() const {
166 return getKind() != Data;
169 /// isNormalMemory - Test if this is an Order dependence between two
170 /// memory accesses where both sides of the dependence access memory
171 /// in non-volatile and fully modeled ways.
172 bool isNormalMemory() const {
173 return getKind() == Order && Contents.Order.isNormalMemory;
176 /// isMustAlias - Test if this is an Order dependence that is marked
177 /// as "must alias", meaning that the SUnits at either end of the edge
178 /// have a memory dependence on a known memory location.
179 bool isMustAlias() const {
180 return getKind() == Order && Contents.Order.isMustAlias;
183 /// isArtificial - Test if this is an Order dependence that is marked
184 /// as "artificial", meaning it isn't necessary for correctness.
185 bool isArtificial() const {
186 return getKind() == Order && Contents.Order.isArtificial;
189 /// isAssignedRegDep - Test if this is a Data dependence that is
190 /// associated with a register.
191 bool isAssignedRegDep() const {
192 return getKind() == Data && Contents.Reg != 0;
195 /// getReg - Return the register associated with this edge. This is
196 /// only valid on Data, Anti, and Output edges. On Data edges, this
197 /// value may be zero, meaning there is no associated register.
198 unsigned getReg() const {
199 assert((getKind() == Data || getKind() == Anti || getKind() == Output) &&
200 "getReg called on non-register dependence edge!");
204 /// setReg - Assign the associated register for this edge. This is
205 /// only valid on Data, Anti, and Output edges. On Anti and Output
206 /// edges, this value must not be zero. On Data edges, the value may
207 /// be zero, which would mean that no specific register is associated
209 void setReg(unsigned Reg) {
210 assert((getKind() == Data || getKind() == Anti || getKind() == Output) &&
211 "setReg called on non-register dependence edge!");
212 assert((getKind() != Anti || Reg != 0) &&
213 "SDep::Anti edge cannot use the zero register!");
214 assert((getKind() != Output || Reg != 0) &&
215 "SDep::Output edge cannot use the zero register!");
220 /// SUnit - Scheduling unit. This is a node in the scheduling DAG.
223 SDNode *Node; // Representative node.
224 MachineInstr *Instr; // Alternatively, a MachineInstr.
226 SUnit *OrigNode; // If not this, the node from which
227 // this node was cloned.
229 // Preds/Succs - The SUnits before/after us in the graph. The boolean value
230 // is true if the edge is a token chain edge, false if it is a value edge.
231 SmallVector<SDep, 4> Preds; // All sunit predecessors.
232 SmallVector<SDep, 4> Succs; // All sunit successors.
234 typedef SmallVector<SDep, 4>::iterator pred_iterator;
235 typedef SmallVector<SDep, 4>::iterator succ_iterator;
236 typedef SmallVector<SDep, 4>::const_iterator const_pred_iterator;
237 typedef SmallVector<SDep, 4>::const_iterator const_succ_iterator;
239 unsigned NodeNum; // Entry # of node in the node vector.
240 unsigned NodeQueueId; // Queue id of node.
241 unsigned short Latency; // Node latency.
242 short NumPreds; // # of SDep::Data preds.
243 short NumSuccs; // # of SDep::Data sucss.
244 short NumPredsLeft; // # of preds not scheduled.
245 short NumSuccsLeft; // # of succs not scheduled.
246 bool isTwoAddress : 1; // Is a two-address instruction.
247 bool isCommutable : 1; // Is a commutable instruction.
248 bool hasPhysRegDefs : 1; // Has physreg defs that are being used.
249 bool isPending : 1; // True once pending.
250 bool isAvailable : 1; // True once available.
251 bool isScheduled : 1; // True once scheduled.
252 bool isScheduleHigh : 1; // True if preferable to schedule high.
253 bool isCloned : 1; // True if this node has been cloned.
255 bool isDepthCurrent : 1; // True if Depth is current.
256 bool isHeightCurrent : 1; // True if Height is current.
257 unsigned Depth; // Node depth.
258 unsigned Height; // Node height.
260 const TargetRegisterClass *CopyDstRC; // Is a special copy node if not null.
261 const TargetRegisterClass *CopySrcRC;
263 /// SUnit - Construct an SUnit for pre-regalloc scheduling to represent
264 /// an SDNode and any nodes flagged to it.
265 SUnit(SDNode *node, unsigned nodenum)
266 : Node(node), Instr(0), OrigNode(0), NodeNum(nodenum), NodeQueueId(0),
267 Latency(0), NumPreds(0), NumSuccs(0), NumPredsLeft(0), NumSuccsLeft(0),
268 isTwoAddress(false), isCommutable(false), hasPhysRegDefs(false),
269 isPending(false), isAvailable(false), isScheduled(false),
270 isScheduleHigh(false), isCloned(false),
271 isDepthCurrent(false), isHeightCurrent(false), Depth(0), Height(0),
272 CopyDstRC(NULL), CopySrcRC(NULL) {}
274 /// SUnit - Construct an SUnit for post-regalloc scheduling to represent
276 SUnit(MachineInstr *instr, unsigned nodenum)
277 : Node(0), Instr(instr), OrigNode(0), NodeNum(nodenum), NodeQueueId(0),
278 Latency(0), NumPreds(0), NumSuccs(0), NumPredsLeft(0), NumSuccsLeft(0),
279 isTwoAddress(false), isCommutable(false), hasPhysRegDefs(false),
280 isPending(false), isAvailable(false), isScheduled(false),
281 isScheduleHigh(false), isCloned(false),
282 isDepthCurrent(false), isHeightCurrent(false), Depth(0), Height(0),
283 CopyDstRC(NULL), CopySrcRC(NULL) {}
285 /// SUnit - Construct a placeholder SUnit.
287 : Node(0), Instr(0), OrigNode(0), NodeNum(~0u), NodeQueueId(0),
288 Latency(0), NumPreds(0), NumSuccs(0), NumPredsLeft(0), NumSuccsLeft(0),
289 isTwoAddress(false), isCommutable(false), hasPhysRegDefs(false),
290 isPending(false), isAvailable(false), isScheduled(false),
291 isScheduleHigh(false), isCloned(false),
292 isDepthCurrent(false), isHeightCurrent(false), Depth(0), Height(0),
293 CopyDstRC(NULL), CopySrcRC(NULL) {}
295 /// setNode - Assign the representative SDNode for this SUnit.
296 /// This may be used during pre-regalloc scheduling.
297 void setNode(SDNode *N) {
298 assert(!Instr && "Setting SDNode of SUnit with MachineInstr!");
302 /// getNode - Return the representative SDNode for this SUnit.
303 /// This may be used during pre-regalloc scheduling.
304 SDNode *getNode() const {
305 assert(!Instr && "Reading SDNode of SUnit with MachineInstr!");
309 /// setInstr - Assign the instruction for the SUnit.
310 /// This may be used during post-regalloc scheduling.
311 void setInstr(MachineInstr *MI) {
312 assert(!Node && "Setting MachineInstr of SUnit with SDNode!");
316 /// getInstr - Return the representative MachineInstr for this SUnit.
317 /// This may be used during post-regalloc scheduling.
318 MachineInstr *getInstr() const {
319 assert(!Node && "Reading MachineInstr of SUnit with SDNode!");
323 /// addPred - This adds the specified edge as a pred of the current node if
324 /// not already. It also adds the current node as a successor of the
326 void addPred(const SDep &D);
328 /// removePred - This removes the specified edge as a pred of the current
329 /// node if it exists. It also removes the current node as a successor of
330 /// the specified node.
331 void removePred(const SDep &D);
333 /// getDepth - Return the depth of this node, which is the length of the
334 /// maximum path up to any node with has no predecessors.
335 unsigned getDepth() const {
336 if (!isDepthCurrent) const_cast<SUnit *>(this)->ComputeDepth();
340 /// getHeight - Return the height of this node, which is the length of the
341 /// maximum path down to any node with has no successors.
342 unsigned getHeight() const {
343 if (!isHeightCurrent) const_cast<SUnit *>(this)->ComputeHeight();
347 /// setDepthToAtLeast - If NewDepth is greater than this node's depth
348 /// value, set it to be the new depth value. This also recursively
349 /// marks successor nodes dirty.
350 void setDepthToAtLeast(unsigned NewDepth);
352 /// setDepthToAtLeast - If NewDepth is greater than this node's depth
353 /// value, set it to be the new height value. This also recursively
354 /// marks predecessor nodes dirty.
355 void setHeightToAtLeast(unsigned NewHeight);
357 /// setDepthDirty - Set a flag in this node to indicate that its
358 /// stored Depth value will require recomputation the next time
359 /// getDepth() is called.
360 void setDepthDirty();
362 /// setHeightDirty - Set a flag in this node to indicate that its
363 /// stored Height value will require recomputation the next time
364 /// getHeight() is called.
365 void setHeightDirty();
367 /// isPred - Test if node N is a predecessor of this node.
368 bool isPred(SUnit *N) {
369 for (unsigned i = 0, e = (unsigned)Preds.size(); i != e; ++i)
370 if (Preds[i].getSUnit() == N)
375 /// isSucc - Test if node N is a successor of this node.
376 bool isSucc(SUnit *N) {
377 for (unsigned i = 0, e = (unsigned)Succs.size(); i != e; ++i)
378 if (Succs[i].getSUnit() == N)
383 void dump(const ScheduleDAG *G) const;
384 void dumpAll(const ScheduleDAG *G) const;
385 void print(raw_ostream &O, const ScheduleDAG *G) const;
389 void ComputeHeight();
392 //===--------------------------------------------------------------------===//
393 /// SchedulingPriorityQueue - This interface is used to plug different
394 /// priorities computation algorithms into the list scheduler. It implements
395 /// the interface of a standard priority queue, where nodes are inserted in
396 /// arbitrary order and returned in priority order. The computation of the
397 /// priority and the representation of the queue are totally up to the
398 /// implementation to decide.
400 class SchedulingPriorityQueue {
402 virtual ~SchedulingPriorityQueue() {}
404 virtual void initNodes(std::vector<SUnit> &SUnits) = 0;
405 virtual void addNode(const SUnit *SU) = 0;
406 virtual void updateNode(const SUnit *SU) = 0;
407 virtual void releaseState() = 0;
409 virtual unsigned size() const = 0;
410 virtual bool empty() const = 0;
411 virtual void push(SUnit *U) = 0;
413 virtual void push_all(const std::vector<SUnit *> &Nodes) = 0;
414 virtual SUnit *pop() = 0;
416 virtual void remove(SUnit *SU) = 0;
418 /// ScheduledNode - As each node is scheduled, this method is invoked. This
419 /// allows the priority function to adjust the priority of related
420 /// unscheduled nodes, for example.
422 virtual void ScheduledNode(SUnit *) {}
424 virtual void UnscheduledNode(SUnit *) {}
429 SelectionDAG *DAG; // DAG of the current basic block
430 MachineBasicBlock *BB; // Current basic block
431 MachineBasicBlock::iterator Begin; // The beginning of the range to be scheduled.
432 MachineBasicBlock::iterator End; // The end of the range to be scheduled.
433 const TargetMachine &TM; // Target processor
434 const TargetInstrInfo *TII; // Target instruction information
435 const TargetRegisterInfo *TRI; // Target processor register info
436 const TargetLowering *TLI; // Target lowering info
437 MachineFunction &MF; // Machine function
438 MachineRegisterInfo &MRI; // Virtual/real register map
439 MachineConstantPool *ConstPool; // Target constant pool
440 std::vector<SUnit*> Sequence; // The schedule. Null SUnit*'s
441 // represent noop instructions.
442 std::vector<SUnit> SUnits; // The scheduling units.
443 SUnit EntrySU; // Special node for the region entry.
444 SUnit ExitSU; // Special node for the region exit.
446 explicit ScheduleDAG(MachineFunction &mf);
448 virtual ~ScheduleDAG();
450 /// viewGraph - Pop up a GraphViz/gv window with the ScheduleDAG rendered
455 /// Run - perform scheduling.
457 void Run(SelectionDAG *DAG, MachineBasicBlock *MBB,
458 MachineBasicBlock::iterator Begin,
459 MachineBasicBlock::iterator End);
461 /// EmitSchedule - Insert MachineInstrs into the MachineBasicBlock
462 /// according to the order specified in Sequence.
464 virtual MachineBasicBlock *EmitSchedule() = 0;
466 void dumpSchedule() const;
468 virtual void dumpNode(const SUnit *SU) const = 0;
470 /// getGraphNodeLabel - Return a label for an SUnit node in a visualization
471 /// of the ScheduleDAG.
472 virtual std::string getGraphNodeLabel(const SUnit *SU) const = 0;
474 /// addCustomGraphFeatures - Add custom features for a visualization of
476 virtual void addCustomGraphFeatures(GraphWriter<ScheduleDAG*> &) const {}
479 /// VerifySchedule - Verify that all SUnits were scheduled and that
480 /// their state is consistent.
481 void VerifySchedule(bool isBottomUp);
485 /// BuildSchedGraph - Build SUnits and set up their Preds and Succs
486 /// to form the scheduling dependency graph.
488 virtual void BuildSchedGraph() = 0;
490 /// ComputeLatency - Compute node latency.
492 virtual void ComputeLatency(SUnit *SU) = 0;
494 /// Schedule - Order nodes according to selected style, filling
495 /// in the Sequence member.
497 virtual void Schedule() = 0;
499 /// ForceUnitLatencies - Return true if all scheduling edges should be given a
500 /// latency value of one. The default is to return false; schedulers may
501 /// override this as needed.
502 virtual bool ForceUnitLatencies() const { return false; }
504 /// EmitNoop - Emit a noop instruction.
508 void AddMemOperand(MachineInstr *MI, const MachineMemOperand &MO);
510 void EmitPhysRegCopy(SUnit *SU, DenseMap<SUnit*, unsigned> &VRBaseMap);
513 /// EmitLiveInCopy - Emit a copy for a live in physical register. If the
514 /// physical register has only a single copy use, then coalesced the copy
516 void EmitLiveInCopy(MachineBasicBlock *MBB,
517 MachineBasicBlock::iterator &InsertPos,
518 unsigned VirtReg, unsigned PhysReg,
519 const TargetRegisterClass *RC,
520 DenseMap<MachineInstr*, unsigned> &CopyRegMap);
522 /// EmitLiveInCopies - If this is the first basic block in the function,
523 /// and if it has live ins that need to be copied into vregs, emit the
524 /// copies into the top of the block.
525 void EmitLiveInCopies(MachineBasicBlock *MBB);
528 class SUnitIterator : public forward_iterator<SUnit, ptrdiff_t> {
532 SUnitIterator(SUnit *N, unsigned Op) : Node(N), Operand(Op) {}
534 bool operator==(const SUnitIterator& x) const {
535 return Operand == x.Operand;
537 bool operator!=(const SUnitIterator& x) const { return !operator==(x); }
539 const SUnitIterator &operator=(const SUnitIterator &I) {
540 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
545 pointer operator*() const {
546 return Node->Preds[Operand].getSUnit();
548 pointer operator->() const { return operator*(); }
550 SUnitIterator& operator++() { // Preincrement
554 SUnitIterator operator++(int) { // Postincrement
555 SUnitIterator tmp = *this; ++*this; return tmp;
558 static SUnitIterator begin(SUnit *N) { return SUnitIterator(N, 0); }
559 static SUnitIterator end (SUnit *N) {
560 return SUnitIterator(N, (unsigned)N->Preds.size());
563 unsigned getOperand() const { return Operand; }
564 const SUnit *getNode() const { return Node; }
565 /// isCtrlDep - Test if this is not an SDep::Data dependence.
566 bool isCtrlDep() const {
567 return getSDep().isCtrl();
569 bool isArtificialDep() const {
570 return getSDep().isArtificial();
572 const SDep &getSDep() const {
573 return Node->Preds[Operand];
577 template <> struct GraphTraits<SUnit*> {
578 typedef SUnit NodeType;
579 typedef SUnitIterator ChildIteratorType;
580 static inline NodeType *getEntryNode(SUnit *N) { return N; }
581 static inline ChildIteratorType child_begin(NodeType *N) {
582 return SUnitIterator::begin(N);
584 static inline ChildIteratorType child_end(NodeType *N) {
585 return SUnitIterator::end(N);
589 template <> struct GraphTraits<ScheduleDAG*> : public GraphTraits<SUnit*> {
590 typedef std::vector<SUnit>::iterator nodes_iterator;
591 static nodes_iterator nodes_begin(ScheduleDAG *G) {
592 return G->SUnits.begin();
594 static nodes_iterator nodes_end(ScheduleDAG *G) {
595 return G->SUnits.end();
599 /// ScheduleDAGTopologicalSort is a class that computes a topological
600 /// ordering for SUnits and provides methods for dynamically updating
601 /// the ordering as new edges are added.
603 /// This allows a very fast implementation of IsReachable, for example.
605 class ScheduleDAGTopologicalSort {
606 /// SUnits - A reference to the ScheduleDAG's SUnits.
607 std::vector<SUnit> &SUnits;
609 /// Index2Node - Maps topological index to the node number.
610 std::vector<int> Index2Node;
611 /// Node2Index - Maps the node number to its topological index.
612 std::vector<int> Node2Index;
613 /// Visited - a set of nodes visited during a DFS traversal.
616 /// DFS - make a DFS traversal and mark all nodes affected by the
617 /// edge insertion. These nodes will later get new topological indexes
618 /// by means of the Shift method.
619 void DFS(const SUnit *SU, int UpperBound, bool& HasLoop);
621 /// Shift - reassign topological indexes for the nodes in the DAG
622 /// to preserve the topological ordering.
623 void Shift(BitVector& Visited, int LowerBound, int UpperBound);
625 /// Allocate - assign the topological index to the node n.
626 void Allocate(int n, int index);
629 explicit ScheduleDAGTopologicalSort(std::vector<SUnit> &SUnits);
631 /// InitDAGTopologicalSorting - create the initial topological
632 /// ordering from the DAG to be scheduled.
633 void InitDAGTopologicalSorting();
635 /// IsReachable - Checks if SU is reachable from TargetSU.
636 bool IsReachable(const SUnit *SU, const SUnit *TargetSU);
638 /// WillCreateCycle - Returns true if adding an edge from SU to TargetSU
639 /// will create a cycle.
640 bool WillCreateCycle(SUnit *SU, SUnit *TargetSU);
642 /// AddPred - Updates the topological ordering to accomodate an edge
643 /// to be added from SUnit X to SUnit Y.
644 void AddPred(SUnit *Y, SUnit *X);
646 /// RemovePred - Updates the topological ordering to accomodate an
647 /// an edge to be removed from the specified node N from the predecessors
648 /// of the current node M.
649 void RemovePred(SUnit *M, SUnit *N);
651 typedef std::vector<int>::iterator iterator;
652 typedef std::vector<int>::const_iterator const_iterator;
653 iterator begin() { return Index2Node.begin(); }
654 const_iterator begin() const { return Index2Node.begin(); }
655 iterator end() { return Index2Node.end(); }
656 const_iterator end() const { return Index2Node.end(); }
658 typedef std::vector<int>::reverse_iterator reverse_iterator;
659 typedef std::vector<int>::const_reverse_iterator const_reverse_iterator;
660 reverse_iterator rbegin() { return Index2Node.rbegin(); }
661 const_reverse_iterator rbegin() const { return Index2Node.rbegin(); }
662 reverse_iterator rend() { return Index2Node.rend(); }
663 const_reverse_iterator rend() const { return Index2Node.rend(); }