1 //===- DAGISelEmitter.h - Generate an instruction selector ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend emits a DAG instruction selector.
12 //===----------------------------------------------------------------------===//
14 #ifndef DAGISEL_EMITTER_H
15 #define DAGISEL_EMITTER_H
17 #include "TableGenBackend.h"
18 #include "CodeGenTarget.h"
26 class TreePatternNode;
29 /// SDTypeConstraint - This is a discriminated union of constraints,
30 /// corresponding to the SDTypeConstraint tablegen class in Target.td.
31 struct SDTypeConstraint {
32 SDTypeConstraint(Record *R);
34 unsigned OperandNo; // The operand # this constraint applies to.
36 SDTCisVT, SDTCisInt, SDTCisFP, SDTCisSameAs, SDTCisVTSmallerThanOp
39 union { // The discriminated union.
44 unsigned OtherOperandNum;
47 unsigned OtherOperandNum;
48 } SDTCisVTSmallerThanOp_Info;
51 /// ApplyTypeConstraint - Given a node in a pattern, apply this type
52 /// constraint to the nodes operands. This returns true if it makes a
53 /// change, false otherwise. If a type contradiction is found, throw an
55 bool ApplyTypeConstraint(TreePatternNode *N, const SDNodeInfo &NodeInfo,
56 TreePattern &TP) const;
58 /// getOperandNum - Return the node corresponding to operand #OpNo in tree
59 /// N, which has NumResults results.
60 TreePatternNode *getOperandNum(unsigned OpNo, TreePatternNode *N,
61 unsigned NumResults) const;
64 /// SDNodeInfo - One of these records is created for each SDNode instance in
65 /// the target .td file. This represents the various dag nodes we will be
70 std::string SDClassName;
73 std::vector<SDTypeConstraint> TypeConstraints;
75 SDNodeInfo(Record *R); // Parse the specified record.
77 unsigned getNumResults() const { return NumResults; }
78 int getNumOperands() const { return NumOperands; }
79 Record *getRecord() const { return Def; }
80 const std::string &getEnumName() const { return EnumName; }
81 const std::string &getSDClassName() const { return SDClassName; }
83 const std::vector<SDTypeConstraint> &getTypeConstraints() const {
84 return TypeConstraints;
87 /// ApplyTypeConstraints - Given a node in a pattern, apply the type
88 /// constraints for this node to the operands of the node. This returns
89 /// true if it makes a change, false otherwise. If a type contradiction is
90 /// found, throw an exception.
91 bool ApplyTypeConstraints(TreePatternNode *N, TreePattern &TP) const {
92 bool MadeChange = false;
93 for (unsigned i = 0, e = TypeConstraints.size(); i != e; ++i)
94 MadeChange |= TypeConstraints[i].ApplyTypeConstraint(N, *this, TP);
99 /// FIXME: TreePatternNode's can be shared in some cases (due to dag-shaped
100 /// patterns), and as such should be ref counted. We currently just leak all
101 /// TreePatternNode objects!
102 class TreePatternNode {
103 /// The inferred type for this node, or MVT::LAST_VALUETYPE if it hasn't
104 /// been determined yet.
107 /// Operator - The Record for the operator if this is an interior node (not
111 /// Val - The init value (e.g. the "GPRC" record, or "7") for a leaf.
115 /// Name - The name given to this node with the :$foo notation.
119 /// PredicateFn - The predicate function to execute on this node to check
120 /// for a match. If this string is empty, no predicate is involved.
121 std::string PredicateFn;
123 /// TransformFn - The transformation function to execute on this node before
124 /// it can be substituted into the resulting instruction on a pattern match.
125 std::string TransformFn;
127 std::vector<TreePatternNode*> Children;
129 TreePatternNode(Record *Op, const std::vector<TreePatternNode*> &Ch)
130 : Ty(MVT::LAST_VALUETYPE), Operator(Op), Val(0), Children(Ch) {}
131 TreePatternNode(Init *val) // leaf ctor
132 : Ty(MVT::LAST_VALUETYPE), Operator(0), Val(val) {}
135 const std::string &getName() const { return Name; }
136 void setName(const std::string &N) { Name = N; }
138 bool isLeaf() const { return Val != 0; }
139 bool hasTypeSet() const { return Ty != MVT::LAST_VALUETYPE; }
140 MVT::ValueType getType() const { return Ty; }
141 void setType(MVT::ValueType VT) { Ty = VT; }
143 Init *getLeafValue() const { assert(isLeaf()); return Val; }
144 Record *getOperator() const { assert(!isLeaf()); return Operator; }
146 unsigned getNumChildren() const { return Children.size(); }
147 TreePatternNode *getChild(unsigned N) const { return Children[N]; }
148 void setChild(unsigned i, TreePatternNode *N) {
152 const std::string &getPredicateFn() const { return PredicateFn; }
153 void setPredicateFn(const std::string &Fn) { PredicateFn = Fn; }
155 const std::string &getTransformFn() const { return TransformFn; }
156 void setTransformFn(const std::string &Fn) { TransformFn = Fn; }
158 void print(std::ostream &OS) const;
161 public: // Higher level manipulation routines.
163 /// clone - Return a new copy of this tree.
165 TreePatternNode *clone() const;
167 /// SubstituteFormalArguments - Replace the formal arguments in this tree
168 /// with actual values specified by ArgMap.
169 void SubstituteFormalArguments(std::map<std::string,
170 TreePatternNode*> &ArgMap);
172 /// InlinePatternFragments - If this pattern refers to any pattern
173 /// fragments, inline them into place, giving us a pattern without any
174 /// PatFrag references.
175 TreePatternNode *InlinePatternFragments(TreePattern &TP);
177 /// ApplyTypeConstraints - Apply all of the type constraints relevent to
178 /// this node and its children in the tree. This returns true if it makes a
179 /// change, false otherwise. If a type contradiction is found, throw an
181 bool ApplyTypeConstraints(TreePattern &TP);
183 /// UpdateNodeType - Set the node type of N to VT if VT contains
184 /// information. If N already contains a conflicting type, then throw an
185 /// exception. This returns true if any information was updated.
187 bool UpdateNodeType(MVT::ValueType VT, TreePattern &TP);
189 /// ContainsUnresolvedType - Return true if this tree contains any
190 /// unresolved types.
191 bool ContainsUnresolvedType() const {
192 if (Ty == MVT::LAST_VALUETYPE) return true;
193 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
194 if (getChild(i)->ContainsUnresolvedType()) return true;
200 /// TreePattern - Represent a pattern, used for instructions, pattern
204 /// Trees - The list of pattern trees which corresponds to this pattern.
205 /// Note that PatFrag's only have a single tree.
207 std::vector<TreePatternNode*> Trees;
209 /// TheRecord - The actual TableGen record corresponding to this pattern.
213 /// Args - This is a list of all of the arguments to this pattern (for
214 /// PatFrag patterns), which are the 'node' markers in this pattern.
215 std::vector<std::string> Args;
217 /// ISE - the DAG isel emitter coordinating this madness.
222 /// TreePattern constructor - Parse the specified DagInits into the
224 TreePattern(Record *TheRec,
225 const std::vector<DagInit *> &RawPat, DAGISelEmitter &ise);
227 /// getTrees - Return the tree patterns which corresponds to this pattern.
229 const std::vector<TreePatternNode*> &getTrees() const { return Trees; }
230 unsigned getNumTrees() const { return Trees.size(); }
231 TreePatternNode *getTree(unsigned i) const { return Trees[i]; }
232 TreePatternNode *getOnlyTree() const {
233 assert(Trees.size() == 1 && "Doesn't have exactly one pattern!");
237 /// getRecord - Return the actual TableGen record corresponding to this
240 Record *getRecord() const { return TheRecord; }
242 unsigned getNumArgs() const { return Args.size(); }
243 const std::string &getArgName(unsigned i) const {
244 assert(i < Args.size() && "Argument reference out of range!");
247 std::vector<std::string> &getArgList() { return Args; }
249 DAGISelEmitter &getDAGISelEmitter() const { return ISE; }
251 /// InlinePatternFragments - If this pattern refers to any pattern
252 /// fragments, inline them into place, giving us a pattern without any
253 /// PatFrag references.
254 void InlinePatternFragments() {
255 for (unsigned i = 0, e = Trees.size(); i != e; ++i)
256 Trees[i] = Trees[i]->InlinePatternFragments(*this);
259 /// InferAllTypes - Infer/propagate as many types throughout the expression
260 /// patterns as possible. Return true if all types are infered, false
261 /// otherwise. Throw an exception if a type contradiction is found.
262 bool InferAllTypes();
264 /// error - Throw an exception, prefixing it with information about this
266 void error(const std::string &Msg) const;
268 void print(std::ostream &OS) const;
272 MVT::ValueType getIntrinsicType(Record *R) const;
273 TreePatternNode *ParseTreePattern(DagInit *DI);
278 /// InstrSelectorEmitter - The top-level class which coordinates construction
279 /// and emission of the instruction selector.
281 class DAGISelEmitter : public TableGenBackend {
282 RecordKeeper &Records;
283 CodeGenTarget Target;
285 std::map<Record*, SDNodeInfo> SDNodes;
286 std::map<Record*, std::pair<Record*, std::string> > SDNodeXForms;
287 std::map<Record*, TreePattern*> PatternFragments;
288 std::vector<TreePattern*> Instructions;
290 DAGISelEmitter(RecordKeeper &R) : Records(R) {}
292 // run - Output the isel, returning true on failure.
293 void run(std::ostream &OS);
295 const SDNodeInfo &getSDNodeInfo(Record *R) const {
296 assert(SDNodes.count(R) && "Unknown node!");
297 return SDNodes.find(R)->second;
300 TreePattern *getPatternFragment(Record *R) const {
301 assert(PatternFragments.count(R) && "Invalid pattern fragment request!");
302 return PatternFragments.find(R)->second;
306 void ParseNodeInfo();
307 void ParseNodeTransforms(std::ostream &OS);
308 void ParseAndResolvePatternFragments(std::ostream &OS);
309 void ParseAndResolveInstructions();
310 void EmitInstructionSelector(std::ostream &OS);
313 } // End llvm namespace