llvm/lib/CodeGen/InstrSched/SchedGraph.h
Chris Lattner e5a61ccdc5 Hrm, another necesary one :(
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@7347 91177308-0d34-0410-b5e6-96231b3b80d8
2003-07-26 23:22:19 +00:00

509 lines
17 KiB
C++

//===-- SchedGraph.h - Scheduling Graph --------------------------*- C++ -*--=//
//
// Purpose:
// Scheduling graph based on SSA graph plus extra dependence edges
// capturing dependences due to machine resources (machine registers,
// CC registers, and any others).
//
// Strategy:
// This graph tries to leverage the SSA graph as much as possible,
// but captures the extra dependences through a common interface.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CODEGEN_SCHEDGRAPH_H
#define LLVM_CODEGEN_SCHEDGRAPH_H
#include "llvm/CodeGen/MachineInstr.h"
#include "Support/GraphTraits.h"
#include "Support/hash_map"
class Value;
class Instruction;
class TerminatorInst;
class BasicBlock;
class Function;
class TargetMachine;
class SchedGraphEdge;
class SchedGraphNode;
class SchedGraph;
class RegToRefVecMap;
class ValueToDefVecMap;
class RefVec;
class MachineInstr;
class MachineBasicBlock;
/******************** Exported Data Types and Constants ********************/
typedef int ResourceId;
const ResourceId InvalidRID = -1;
const ResourceId MachineCCRegsRID = -2; // use +ve numbers for actual regs
const ResourceId MachineIntRegsRID = -3; // use +ve numbers for actual regs
const ResourceId MachineFPRegsRID = -4; // use +ve numbers for actual regs
//*********************** Public Class Declarations ************************/
class SchedGraphEdge {
SchedGraphEdge(const SchedGraphEdge &); // DO NOT IMPLEMENT
void operator=(const SchedGraphEdge &); // DO NOT IMPLEMENT
public:
enum SchedGraphEdgeDepType {
CtrlDep, MemoryDep, ValueDep, MachineRegister, MachineResource
};
enum DataDepOrderType {
TrueDep = 0x1, AntiDep=0x2, OutputDep=0x4, NonDataDep=0x8
};
private:
SchedGraphNode* src;
SchedGraphNode* sink;
SchedGraphEdgeDepType depType;
unsigned int depOrderType;
int minDelay; // cached latency (assumes fixed target arch)
union {
const Value* val;
int machineRegNum;
ResourceId resourceId;
};
public:
// For all constructors, if minDelay is unspecified, minDelay is
// set to _src->getLatency().
// constructor for CtrlDep or MemoryDep edges, selected by 3rd argument
/*ctor*/ SchedGraphEdge(SchedGraphNode* _src,
SchedGraphNode* _sink,
SchedGraphEdgeDepType _depType,
unsigned int _depOrderType,
int _minDelay = -1);
// constructor for explicit value dependence (may be true/anti/output)
/*ctor*/ SchedGraphEdge(SchedGraphNode* _src,
SchedGraphNode* _sink,
const Value* _val,
unsigned int _depOrderType,
int _minDelay = -1);
// constructor for machine register dependence
/*ctor*/ SchedGraphEdge(SchedGraphNode* _src,
SchedGraphNode* _sink,
unsigned int _regNum,
unsigned int _depOrderType,
int _minDelay = -1);
// constructor for any other machine resource dependences.
// DataDepOrderType is always NonDataDep. It it not an argument to
// avoid overloading ambiguity with previous constructor.
/*ctor*/ SchedGraphEdge(SchedGraphNode* _src,
SchedGraphNode* _sink,
ResourceId _resourceId,
int _minDelay = -1);
/*dtor*/ ~SchedGraphEdge();
SchedGraphNode* getSrc () const { return src; }
SchedGraphNode* getSink () const { return sink; }
int getMinDelay () const { return minDelay; }
SchedGraphEdgeDepType getDepType () const { return depType; }
const Value* getValue () const {
assert(depType == ValueDep); return val;
}
int getMachineReg () const {
assert(depType == MachineRegister); return machineRegNum;
}
int getResourceId () const {
assert(depType == MachineResource); return resourceId;
}
public:
//
// Debugging support
//
friend std::ostream& operator<<(std::ostream& os, const SchedGraphEdge& edge);
void dump (int indent=0) const;
private:
// disable default ctor
/*ctor*/ SchedGraphEdge(); // DO NOT IMPLEMENT
};
class SchedGraphNode {
unsigned nodeId;
MachineBasicBlock *MBB;
const MachineInstr* minstr;
std::vector<SchedGraphEdge*> inEdges;
std::vector<SchedGraphEdge*> outEdges;
int origIndexInBB; // original position of machine instr in BB
int latency;
SchedGraphNode(const SchedGraphNode &); // DO NOT IMPLEMENT
void operator=(const SchedGraphNode &); // DO NOT IMPLEMENT
public:
typedef std::vector<SchedGraphEdge*>:: iterator iterator;
typedef std::vector<SchedGraphEdge*>::const_iterator const_iterator;
typedef std::vector<SchedGraphEdge*>:: reverse_iterator reverse_iterator;
typedef std::vector<SchedGraphEdge*>::const_reverse_iterator const_reverse_iterator;
public:
//
// Accessor methods
//
unsigned getNodeId () const { return nodeId; }
const MachineInstr* getMachineInstr () const { return minstr; }
const MachineOpCode getOpCode () const { return minstr->getOpCode(); }
int getLatency () const { return latency; }
unsigned getNumInEdges () const { return inEdges.size(); }
unsigned getNumOutEdges () const { return outEdges.size(); }
bool isDummyNode () const { return (minstr == NULL); }
MachineBasicBlock &getMachineBasicBlock() const { return *MBB; }
int getOrigIndexInBB() const { return origIndexInBB; }
//
// Iterators
//
iterator beginInEdges () { return inEdges.begin(); }
iterator endInEdges () { return inEdges.end(); }
iterator beginOutEdges () { return outEdges.begin(); }
iterator endOutEdges () { return outEdges.end(); }
const_iterator beginInEdges () const { return inEdges.begin(); }
const_iterator endInEdges () const { return inEdges.end(); }
const_iterator beginOutEdges () const { return outEdges.begin(); }
const_iterator endOutEdges () const { return outEdges.end(); }
public:
//
// Debugging support
//
friend std::ostream& operator<<(std::ostream& os, const SchedGraphNode& node);
void dump (int indent=0) const;
private:
friend class SchedGraph; // give access for ctor and dtor
friend class SchedGraphEdge; // give access for adding edges
void addInEdge (SchedGraphEdge* edge);
void addOutEdge (SchedGraphEdge* edge);
void removeInEdge (const SchedGraphEdge* edge);
void removeOutEdge (const SchedGraphEdge* edge);
// disable default constructor and provide a ctor for single-block graphs
/*ctor*/ SchedGraphNode(); // DO NOT IMPLEMENT
/*ctor*/ SchedGraphNode (unsigned nodeId,
MachineBasicBlock *mbb,
int indexInBB,
const TargetMachine& Target);
/*dtor*/ ~SchedGraphNode ();
};
class SchedGraph : private hash_map<const MachineInstr*, SchedGraphNode*> {
MachineBasicBlock &MBB; // basic blocks for this graph
SchedGraphNode* graphRoot; // the root and leaf are not inserted
SchedGraphNode* graphLeaf; // in the hash_map (see getNumNodes())
typedef hash_map<const MachineInstr*, SchedGraphNode*> map_base;
SchedGraph(const SchedGraph &); // DO NOT IMPLEMENT
void operator=(const SchedGraph &); // DO NOT IMPLEMENT
public:
using map_base::iterator;
using map_base::const_iterator;
public:
//
// Accessor methods
//
MachineBasicBlock &getBasicBlock() const { return MBB; }
unsigned getNumNodes() const { return size()+2; }
SchedGraphNode* getRoot() const { return graphRoot; }
SchedGraphNode* getLeaf() const { return graphLeaf; }
SchedGraphNode* getGraphNodeForInstr(const MachineInstr* minstr) const {
const_iterator onePair = this->find(minstr);
return (onePair != this->end())? (*onePair).second : NULL;
}
//
// Delete nodes or edges from the graph.
//
void eraseNode (SchedGraphNode* node);
void eraseIncomingEdges (SchedGraphNode* node,
bool addDummyEdges = true);
void eraseOutgoingEdges (SchedGraphNode* node,
bool addDummyEdges = true);
void eraseIncidentEdges (SchedGraphNode* node,
bool addDummyEdges = true);
//
// Unordered iterators.
// Return values is pair<const MachineIntr*,SchedGraphNode*>.
//
using map_base::begin;
using map_base::end;
//
// Ordered iterators.
// Return values is pair<const MachineIntr*,SchedGraphNode*>.
//
// void postord_init();
// postorder_iterator postord_begin();
// postorder_iterator postord_end();
// const_postorder_iterator postord_begin() const;
// const_postorder_iterator postord_end() const;
//
// Debugging support
//
void dump () const;
private:
friend class SchedGraphSet; // give access to ctor
// disable default constructor and provide a ctor for single-block graphs
/*ctor*/ SchedGraph (MachineBasicBlock &bb,
const TargetMachine& target);
/*dtor*/ ~SchedGraph ();
inline void noteGraphNodeForInstr (const MachineInstr* minstr,
SchedGraphNode* node)
{
assert((*this)[minstr] == NULL);
(*this)[minstr] = node;
}
//
// Graph builder
//
void buildGraph (const TargetMachine& target);
void buildNodesForBB (const TargetMachine& target,
MachineBasicBlock &MBB,
std::vector<SchedGraphNode*>& memNV,
std::vector<SchedGraphNode*>& callNV,
RegToRefVecMap& regToRefVecMap,
ValueToDefVecMap& valueToDefVecMap);
void findDefUseInfoAtInstr (const TargetMachine& target,
SchedGraphNode* node,
std::vector<SchedGraphNode*>& memNV,
std::vector<SchedGraphNode*>& callNV,
RegToRefVecMap& regToRefVecMap,
ValueToDefVecMap& valueToDefVecMap);
void addEdgesForInstruction(const MachineInstr& minstr,
const ValueToDefVecMap& valueToDefVecMap,
const TargetMachine& target);
void addCDEdges (const TerminatorInst* term,
const TargetMachine& target);
void addMemEdges (const std::vector<SchedGraphNode*>& memNV,
const TargetMachine& target);
void addCallDepEdges (const std::vector<SchedGraphNode*>& callNV,
const TargetMachine& target);
void addMachineRegEdges (RegToRefVecMap& regToRefVecMap,
const TargetMachine& target);
void addEdgesForValue (SchedGraphNode* refNode,
const RefVec& defVec,
const Value* defValue,
bool refNodeIsDef,
bool refNodeIsDefAndUse,
const TargetMachine& target);
void addDummyEdges ();
};
class SchedGraphSet : private std::vector<SchedGraph*> {
private:
const Function* method;
SchedGraphSet(const SchedGraphSet&); // DO NOT IMPLEMENT
void operator=(const SchedGraphSet&); // DO NOT IMPLEMENT
public:
typedef std::vector<SchedGraph*> baseVector;
using baseVector::iterator;
using baseVector::const_iterator;
public:
SchedGraphSet(const Function *F, const TargetMachine &TM);
~SchedGraphSet();
// Iterators
using baseVector::begin;
using baseVector::end;
// Debugging support
void dump() const;
private:
inline void addGraph(SchedGraph* graph) {
assert(graph != NULL);
this->push_back(graph);
}
// Graph builder
void buildGraphsForMethod(const Function *F, const TargetMachine &TM);
};
//********************** Sched Graph Iterators *****************************/
// Ok to make it a template because it shd get instantiated at most twice:
// for <SchedGraphNode, SchedGraphNode::iterator> and
// for <const SchedGraphNode, SchedGraphNode::const_iterator>.
//
template <class _NodeType, class _EdgeType, class _EdgeIter>
class SGPredIterator: public bidirectional_iterator<_NodeType, ptrdiff_t> {
protected:
_EdgeIter oi;
public:
typedef SGPredIterator<_NodeType, _EdgeType, _EdgeIter> _Self;
inline SGPredIterator(_EdgeIter startEdge) : oi(startEdge) {}
inline bool operator==(const _Self& x) const { return oi == x.oi; }
inline bool operator!=(const _Self& x) const { return !operator==(x); }
// operator*() differs for pred or succ iterator
inline _NodeType* operator*() const { return (*oi)->getSrc(); }
inline _NodeType* operator->() const { return operator*(); }
inline _EdgeType* getEdge() const { return *(oi); }
inline _Self &operator++() { ++oi; return *this; } // Preincrement
inline _Self operator++(int) { // Postincrement
_Self tmp(*this); ++*this; return tmp;
}
inline _Self &operator--() { --oi; return *this; } // Predecrement
inline _Self operator--(int) { // Postdecrement
_Self tmp = *this; --*this; return tmp;
}
};
template <class _NodeType, class _EdgeType, class _EdgeIter>
class SGSuccIterator : public bidirectional_iterator<_NodeType, ptrdiff_t> {
protected:
_EdgeIter oi;
public:
typedef SGSuccIterator<_NodeType, _EdgeType, _EdgeIter> _Self;
inline SGSuccIterator(_EdgeIter startEdge) : oi(startEdge) {}
inline bool operator==(const _Self& x) const { return oi == x.oi; }
inline bool operator!=(const _Self& x) const { return !operator==(x); }
inline _NodeType* operator*() const { return (*oi)->getSink(); }
inline _NodeType* operator->() const { return operator*(); }
inline _EdgeType* getEdge() const { return *(oi); }
inline _Self &operator++() { ++oi; return *this; } // Preincrement
inline _Self operator++(int) { // Postincrement
_Self tmp(*this); ++*this; return tmp;
}
inline _Self &operator--() { --oi; return *this; } // Predecrement
inline _Self operator--(int) { // Postdecrement
_Self tmp = *this; --*this; return tmp;
}
};
//
// sg_pred_iterator
// sg_pred_const_iterator
//
typedef SGPredIterator<SchedGraphNode, SchedGraphEdge, SchedGraphNode::iterator>
sg_pred_iterator;
typedef SGPredIterator<const SchedGraphNode, const SchedGraphEdge,SchedGraphNode::const_iterator>
sg_pred_const_iterator;
inline sg_pred_iterator pred_begin( SchedGraphNode *N) {
return sg_pred_iterator(N->beginInEdges());
}
inline sg_pred_iterator pred_end( SchedGraphNode *N) {
return sg_pred_iterator(N->endInEdges());
}
inline sg_pred_const_iterator pred_begin(const SchedGraphNode *N) {
return sg_pred_const_iterator(N->beginInEdges());
}
inline sg_pred_const_iterator pred_end( const SchedGraphNode *N) {
return sg_pred_const_iterator(N->endInEdges());
}
//
// sg_succ_iterator
// sg_succ_const_iterator
//
typedef SGSuccIterator<SchedGraphNode, SchedGraphEdge, SchedGraphNode::iterator>
sg_succ_iterator;
typedef SGSuccIterator<const SchedGraphNode, const SchedGraphEdge,SchedGraphNode::const_iterator>
sg_succ_const_iterator;
inline sg_succ_iterator succ_begin( SchedGraphNode *N) {
return sg_succ_iterator(N->beginOutEdges());
}
inline sg_succ_iterator succ_end( SchedGraphNode *N) {
return sg_succ_iterator(N->endOutEdges());
}
inline sg_succ_const_iterator succ_begin(const SchedGraphNode *N) {
return sg_succ_const_iterator(N->beginOutEdges());
}
inline sg_succ_const_iterator succ_end( const SchedGraphNode *N) {
return sg_succ_const_iterator(N->endOutEdges());
}
// Provide specializations of GraphTraits to be able to use graph iterators on
// the scheduling graph!
//
template <> struct GraphTraits<SchedGraph*> {
typedef SchedGraphNode NodeType;
typedef sg_succ_iterator ChildIteratorType;
static inline NodeType *getEntryNode(SchedGraph *SG) { return SG->getRoot(); }
static inline ChildIteratorType child_begin(NodeType *N) {
return succ_begin(N);
}
static inline ChildIteratorType child_end(NodeType *N) {
return succ_end(N);
}
};
template <> struct GraphTraits<const SchedGraph*> {
typedef const SchedGraphNode NodeType;
typedef sg_succ_const_iterator ChildIteratorType;
static inline NodeType *getEntryNode(const SchedGraph *SG) {
return SG->getRoot();
}
static inline ChildIteratorType child_begin(NodeType *N) {
return succ_begin(N);
}
static inline ChildIteratorType child_end(NodeType *N) {
return succ_end(N);
}
};
std::ostream &operator<<(std::ostream& os, const SchedGraphEdge& edge);
std::ostream &operator<<(std::ostream &os, const SchedGraphNode& node);
#endif