1 //===- CodeGenDAGPatterns.h - Read DAG patterns from .td file ---*- 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 declares the CodeGenDAGPatterns class, which is used to read and
11 // represent the patterns present in a .td file for instructions.
13 //===----------------------------------------------------------------------===//
15 #ifndef CODEGEN_DAGPATTERNS_H
16 #define CODEGEN_DAGPATTERNS_H
22 #include "CodeGenTarget.h"
23 #include "CodeGenIntrinsics.h"
32 class TreePatternNode
;
33 class CodeGenDAGPatterns
;
36 /// EEVT::DAGISelGenValueType - These are some extended forms of
37 /// MVT::SimpleValueType that we use as lattice values during type inference.
38 /// The existing MVT iAny, fAny and vAny types suffice to represent
39 /// arbitrary integer, floating-point, and vector types, so only an unknown
42 enum DAGISelGenValueType
{
43 isUnknown
= MVT::LAST_VALUETYPE
46 /// isExtIntegerInVTs - Return true if the specified extended value type
47 /// vector contains iAny or an integer value type.
48 bool isExtIntegerInVTs(const std::vector
<unsigned char> &EVTs
);
50 /// isExtFloatingPointInVTs - Return true if the specified extended value
51 /// type vector contains fAny or a FP value type.
52 bool isExtFloatingPointInVTs(const std::vector
<unsigned char> &EVTs
);
54 /// isExtVectorinVTs - Return true if the specified extended value type
55 /// vector contains vAny or a vector value type.
56 bool isExtVectorInVTs(const std::vector
<unsigned char> &EVTs
);
59 /// Set type used to track multiply used variables in patterns
60 typedef std::set
<std::string
> MultipleUseVarSet
;
62 /// SDTypeConstraint - This is a discriminated union of constraints,
63 /// corresponding to the SDTypeConstraint tablegen class in Target.td.
64 struct SDTypeConstraint
{
65 SDTypeConstraint(Record
*R
);
67 unsigned OperandNo
; // The operand # this constraint applies to.
69 SDTCisVT
, SDTCisPtrTy
, SDTCisInt
, SDTCisFP
, SDTCisVec
, SDTCisSameAs
,
70 SDTCisVTSmallerThanOp
, SDTCisOpSmallerThanOp
, SDTCisEltOfVec
73 union { // The discriminated union.
78 unsigned OtherOperandNum
;
81 unsigned OtherOperandNum
;
82 } SDTCisVTSmallerThanOp_Info
;
84 unsigned BigOperandNum
;
85 } SDTCisOpSmallerThanOp_Info
;
87 unsigned OtherOperandNum
;
88 } SDTCisEltOfVec_Info
;
91 /// ApplyTypeConstraint - Given a node in a pattern, apply this type
92 /// constraint to the nodes operands. This returns true if it makes a
93 /// change, false otherwise. If a type contradiction is found, throw an
95 bool ApplyTypeConstraint(TreePatternNode
*N
, const SDNodeInfo
&NodeInfo
,
96 TreePattern
&TP
) const;
98 /// getOperandNum - Return the node corresponding to operand #OpNo in tree
99 /// N, which has NumResults results.
100 TreePatternNode
*getOperandNum(unsigned OpNo
, TreePatternNode
*N
,
101 unsigned NumResults
) const;
104 /// SDNodeInfo - One of these records is created for each SDNode instance in
105 /// the target .td file. This represents the various dag nodes we will be
109 std::string EnumName
;
110 std::string SDClassName
;
114 std::vector
<SDTypeConstraint
> TypeConstraints
;
116 SDNodeInfo(Record
*R
); // Parse the specified record.
118 unsigned getNumResults() const { return NumResults
; }
119 int getNumOperands() const { return NumOperands
; }
120 Record
*getRecord() const { return Def
; }
121 const std::string
&getEnumName() const { return EnumName
; }
122 const std::string
&getSDClassName() const { return SDClassName
; }
124 const std::vector
<SDTypeConstraint
> &getTypeConstraints() const {
125 return TypeConstraints
;
128 /// hasProperty - Return true if this node has the specified property.
130 bool hasProperty(enum SDNP Prop
) const { return Properties
& (1 << Prop
); }
132 /// ApplyTypeConstraints - Given a node in a pattern, apply the type
133 /// constraints for this node to the operands of the node. This returns
134 /// true if it makes a change, false otherwise. If a type contradiction is
135 /// found, throw an exception.
136 bool ApplyTypeConstraints(TreePatternNode
*N
, TreePattern
&TP
) const {
137 bool MadeChange
= false;
138 for (unsigned i
= 0, e
= TypeConstraints
.size(); i
!= e
; ++i
)
139 MadeChange
|= TypeConstraints
[i
].ApplyTypeConstraint(N
, *this, TP
);
144 /// FIXME: TreePatternNode's can be shared in some cases (due to dag-shaped
145 /// patterns), and as such should be ref counted. We currently just leak all
146 /// TreePatternNode objects!
147 class TreePatternNode
{
148 /// The inferred type for this node, or EEVT::isUnknown if it hasn't
149 /// been determined yet. This is a std::vector because during inference
150 /// there may be multiple possible types.
151 std::vector
<unsigned char> Types
;
153 /// Operator - The Record for the operator if this is an interior node (not
157 /// Val - The init value (e.g. the "GPRC" record, or "7") for a leaf.
161 /// Name - The name given to this node with the :$foo notation.
165 /// PredicateFns - The predicate functions to execute on this node to check
166 /// for a match. If this list is empty, no predicate is involved.
167 std::vector
<std::string
> PredicateFns
;
169 /// TransformFn - The transformation function to execute on this node before
170 /// it can be substituted into the resulting instruction on a pattern match.
173 std::vector
<TreePatternNode
*> Children
;
175 TreePatternNode(Record
*Op
, const std::vector
<TreePatternNode
*> &Ch
)
176 : Types(), Operator(Op
), Val(0), TransformFn(0),
177 Children(Ch
) { Types
.push_back(EEVT::isUnknown
); }
178 TreePatternNode(Init
*val
) // leaf ctor
179 : Types(), Operator(0), Val(val
), TransformFn(0) {
180 Types
.push_back(EEVT::isUnknown
);
184 const std::string
&getName() const { return Name
; }
185 void setName(const std::string
&N
) { Name
= N
; }
187 bool isLeaf() const { return Val
!= 0; }
188 bool hasTypeSet() const {
189 return (Types
[0] < MVT::LAST_VALUETYPE
) || (Types
[0] == MVT::iPTR
) ||
190 (Types
[0] == MVT::iPTRAny
);
192 bool isTypeCompletelyUnknown() const {
193 return Types
[0] == EEVT::isUnknown
;
195 bool isTypeDynamicallyResolved() const {
196 return (Types
[0] == MVT::iPTR
) || (Types
[0] == MVT::iPTRAny
);
198 MVT::SimpleValueType
getTypeNum(unsigned Num
) const {
199 assert(hasTypeSet() && "Doesn't have a type yet!");
200 assert(Types
.size() > Num
&& "Type num out of range!");
201 return (MVT::SimpleValueType
)Types
[Num
];
203 unsigned char getExtTypeNum(unsigned Num
) const {
204 assert(Types
.size() > Num
&& "Extended type num out of range!");
207 const std::vector
<unsigned char> &getExtTypes() const { return Types
; }
208 void setTypes(const std::vector
<unsigned char> &T
) { Types
= T
; }
209 void removeTypes() { Types
= std::vector
<unsigned char>(1, EEVT::isUnknown
); }
211 Init
*getLeafValue() const { assert(isLeaf()); return Val
; }
212 Record
*getOperator() const { assert(!isLeaf()); return Operator
; }
214 unsigned getNumChildren() const { return Children
.size(); }
215 TreePatternNode
*getChild(unsigned N
) const { return Children
[N
]; }
216 void setChild(unsigned i
, TreePatternNode
*N
) {
220 const std::vector
<std::string
> &getPredicateFns() const { return PredicateFns
; }
221 void clearPredicateFns() { PredicateFns
.clear(); }
222 void setPredicateFns(const std::vector
<std::string
> &Fns
) {
223 assert(PredicateFns
.empty() && "Overwriting non-empty predicate list!");
226 void addPredicateFn(const std::string
&Fn
) {
227 assert(!Fn
.empty() && "Empty predicate string!");
228 if (std::find(PredicateFns
.begin(), PredicateFns
.end(), Fn
) ==
230 PredicateFns
.push_back(Fn
);
233 Record
*getTransformFn() const { return TransformFn
; }
234 void setTransformFn(Record
*Fn
) { TransformFn
= Fn
; }
236 /// getIntrinsicInfo - If this node corresponds to an intrinsic, return the
237 /// CodeGenIntrinsic information for it, otherwise return a null pointer.
238 const CodeGenIntrinsic
*getIntrinsicInfo(const CodeGenDAGPatterns
&CDP
) const;
240 /// isCommutativeIntrinsic - Return true if the node is an intrinsic which is
241 /// marked isCommutative.
242 bool isCommutativeIntrinsic(const CodeGenDAGPatterns
&CDP
) const;
244 void print(raw_ostream
&OS
) const;
247 public: // Higher level manipulation routines.
249 /// clone - Return a new copy of this tree.
251 TreePatternNode
*clone() const;
253 /// isIsomorphicTo - Return true if this node is recursively isomorphic to
254 /// the specified node. For this comparison, all of the state of the node
255 /// is considered, except for the assigned name. Nodes with differing names
256 /// that are otherwise identical are considered isomorphic.
257 bool isIsomorphicTo(const TreePatternNode
*N
,
258 const MultipleUseVarSet
&DepVars
) const;
260 /// SubstituteFormalArguments - Replace the formal arguments in this tree
261 /// with actual values specified by ArgMap.
262 void SubstituteFormalArguments(std::map
<std::string
,
263 TreePatternNode
*> &ArgMap
);
265 /// InlinePatternFragments - If this pattern refers to any pattern
266 /// fragments, inline them into place, giving us a pattern without any
267 /// PatFrag references.
268 TreePatternNode
*InlinePatternFragments(TreePattern
&TP
);
270 /// ApplyTypeConstraints - Apply all of the type constraints relevant to
271 /// this node and its children in the tree. This returns true if it makes a
272 /// change, false otherwise. If a type contradiction is found, throw an
274 bool ApplyTypeConstraints(TreePattern
&TP
, bool NotRegisters
);
276 /// UpdateNodeType - Set the node type of N to VT if VT contains
277 /// information. If N already contains a conflicting type, then throw an
278 /// exception. This returns true if any information was updated.
280 bool UpdateNodeType(const std::vector
<unsigned char> &ExtVTs
,
282 bool UpdateNodeType(unsigned char ExtVT
, TreePattern
&TP
) {
283 std::vector
<unsigned char> ExtVTs(1, ExtVT
);
284 return UpdateNodeType(ExtVTs
, TP
);
287 /// ContainsUnresolvedType - Return true if this tree contains any
288 /// unresolved types.
289 bool ContainsUnresolvedType() const {
290 if (!hasTypeSet() && !isTypeDynamicallyResolved()) return true;
291 for (unsigned i
= 0, e
= getNumChildren(); i
!= e
; ++i
)
292 if (getChild(i
)->ContainsUnresolvedType()) return true;
296 /// canPatternMatch - If it is impossible for this pattern to match on this
297 /// target, fill in Reason and return false. Otherwise, return true.
298 bool canPatternMatch(std::string
&Reason
, const CodeGenDAGPatterns
&CDP
);
302 /// TreePattern - Represent a pattern, used for instructions, pattern
306 /// Trees - The list of pattern trees which corresponds to this pattern.
307 /// Note that PatFrag's only have a single tree.
309 std::vector
<TreePatternNode
*> Trees
;
311 /// TheRecord - The actual TableGen record corresponding to this pattern.
315 /// Args - This is a list of all of the arguments to this pattern (for
316 /// PatFrag patterns), which are the 'node' markers in this pattern.
317 std::vector
<std::string
> Args
;
319 /// CDP - the top-level object coordinating this madness.
321 CodeGenDAGPatterns
&CDP
;
323 /// isInputPattern - True if this is an input pattern, something to match.
324 /// False if this is an output pattern, something to emit.
328 /// TreePattern constructor - Parse the specified DagInits into the
330 TreePattern(Record
*TheRec
, ListInit
*RawPat
, bool isInput
,
331 CodeGenDAGPatterns
&ise
);
332 TreePattern(Record
*TheRec
, DagInit
*Pat
, bool isInput
,
333 CodeGenDAGPatterns
&ise
);
334 TreePattern(Record
*TheRec
, TreePatternNode
*Pat
, bool isInput
,
335 CodeGenDAGPatterns
&ise
);
337 /// getTrees - Return the tree patterns which corresponds to this pattern.
339 const std::vector
<TreePatternNode
*> &getTrees() const { return Trees
; }
340 unsigned getNumTrees() const { return Trees
.size(); }
341 TreePatternNode
*getTree(unsigned i
) const { return Trees
[i
]; }
342 TreePatternNode
*getOnlyTree() const {
343 assert(Trees
.size() == 1 && "Doesn't have exactly one pattern!");
347 /// getRecord - Return the actual TableGen record corresponding to this
350 Record
*getRecord() const { return TheRecord
; }
352 unsigned getNumArgs() const { return Args
.size(); }
353 const std::string
&getArgName(unsigned i
) const {
354 assert(i
< Args
.size() && "Argument reference out of range!");
357 std::vector
<std::string
> &getArgList() { return Args
; }
359 CodeGenDAGPatterns
&getDAGPatterns() const { return CDP
; }
361 /// InlinePatternFragments - If this pattern refers to any pattern
362 /// fragments, inline them into place, giving us a pattern without any
363 /// PatFrag references.
364 void InlinePatternFragments() {
365 for (unsigned i
= 0, e
= Trees
.size(); i
!= e
; ++i
)
366 Trees
[i
] = Trees
[i
]->InlinePatternFragments(*this);
369 /// InferAllTypes - Infer/propagate as many types throughout the expression
370 /// patterns as possible. Return true if all types are inferred, false
371 /// otherwise. Throw an exception if a type contradiction is found.
372 bool InferAllTypes();
374 /// error - Throw an exception, prefixing it with information about this
376 void error(const std::string
&Msg
) const;
378 void print(raw_ostream
&OS
) const;
382 TreePatternNode
*ParseTreePattern(DagInit
*DI
);
385 /// DAGDefaultOperand - One of these is created for each PredicateOperand
386 /// or OptionalDefOperand that has a set ExecuteAlways / DefaultOps field.
387 struct DAGDefaultOperand
{
388 std::vector
<TreePatternNode
*> DefaultOps
;
391 class DAGInstruction
{
392 TreePattern
*Pattern
;
393 std::vector
<Record
*> Results
;
394 std::vector
<Record
*> Operands
;
395 std::vector
<Record
*> ImpResults
;
396 std::vector
<Record
*> ImpOperands
;
397 TreePatternNode
*ResultPattern
;
399 DAGInstruction(TreePattern
*TP
,
400 const std::vector
<Record
*> &results
,
401 const std::vector
<Record
*> &operands
,
402 const std::vector
<Record
*> &impresults
,
403 const std::vector
<Record
*> &impoperands
)
404 : Pattern(TP
), Results(results
), Operands(operands
),
405 ImpResults(impresults
), ImpOperands(impoperands
),
408 const TreePattern
*getPattern() const { return Pattern
; }
409 unsigned getNumResults() const { return Results
.size(); }
410 unsigned getNumOperands() const { return Operands
.size(); }
411 unsigned getNumImpResults() const { return ImpResults
.size(); }
412 unsigned getNumImpOperands() const { return ImpOperands
.size(); }
413 const std::vector
<Record
*>& getImpResults() const { return ImpResults
; }
415 void setResultPattern(TreePatternNode
*R
) { ResultPattern
= R
; }
417 Record
*getResult(unsigned RN
) const {
418 assert(RN
< Results
.size());
422 Record
*getOperand(unsigned ON
) const {
423 assert(ON
< Operands
.size());
427 Record
*getImpResult(unsigned RN
) const {
428 assert(RN
< ImpResults
.size());
429 return ImpResults
[RN
];
432 Record
*getImpOperand(unsigned ON
) const {
433 assert(ON
< ImpOperands
.size());
434 return ImpOperands
[ON
];
437 TreePatternNode
*getResultPattern() const { return ResultPattern
; }
440 /// PatternToMatch - Used by CodeGenDAGPatterns to keep tab of patterns
441 /// processed to produce isel.
442 struct PatternToMatch
{
443 PatternToMatch(ListInit
*preds
,
444 TreePatternNode
*src
, TreePatternNode
*dst
,
445 const std::vector
<Record
*> &dstregs
,
446 unsigned complexity
):
447 Predicates(preds
), SrcPattern(src
), DstPattern(dst
), Dstregs(dstregs
),
448 AddedComplexity(complexity
) {};
450 ListInit
*Predicates
; // Top level predicate conditions to match.
451 TreePatternNode
*SrcPattern
; // Source pattern to match.
452 TreePatternNode
*DstPattern
; // Resulting pattern.
453 std::vector
<Record
*> Dstregs
; // Physical register defs being matched.
454 unsigned AddedComplexity
; // Add to matching pattern complexity.
456 ListInit
*getPredicates() const { return Predicates
; }
457 TreePatternNode
*getSrcPattern() const { return SrcPattern
; }
458 TreePatternNode
*getDstPattern() const { return DstPattern
; }
459 const std::vector
<Record
*> &getDstRegs() const { return Dstregs
; }
460 unsigned getAddedComplexity() const { return AddedComplexity
; }
462 std::string
getPredicateCheck() const;
465 // Deterministic comparison of Record*.
466 struct RecordPtrCmp
{
467 bool operator()(const Record
*LHS
, const Record
*RHS
) const;
470 class CodeGenDAGPatterns
{
471 RecordKeeper
&Records
;
472 CodeGenTarget Target
;
473 std::vector
<CodeGenIntrinsic
> Intrinsics
;
474 std::vector
<CodeGenIntrinsic
> TgtIntrinsics
;
476 std::map
<Record
*, SDNodeInfo
, RecordPtrCmp
> SDNodes
;
477 std::map
<Record
*, std::pair
<Record
*, std::string
>, RecordPtrCmp
> SDNodeXForms
;
478 std::map
<Record
*, ComplexPattern
, RecordPtrCmp
> ComplexPatterns
;
479 std::map
<Record
*, TreePattern
*, RecordPtrCmp
> PatternFragments
;
480 std::map
<Record
*, DAGDefaultOperand
, RecordPtrCmp
> DefaultOperands
;
481 std::map
<Record
*, DAGInstruction
, RecordPtrCmp
> Instructions
;
483 // Specific SDNode definitions:
484 Record
*intrinsic_void_sdnode
;
485 Record
*intrinsic_w_chain_sdnode
, *intrinsic_wo_chain_sdnode
;
487 /// PatternsToMatch - All of the things we are matching on the DAG. The first
488 /// value is the pattern to match, the second pattern is the result to
490 std::vector
<PatternToMatch
> PatternsToMatch
;
492 CodeGenDAGPatterns(RecordKeeper
&R
);
493 ~CodeGenDAGPatterns();
495 CodeGenTarget
&getTargetInfo() { return Target
; }
496 const CodeGenTarget
&getTargetInfo() const { return Target
; }
498 Record
*getSDNodeNamed(const std::string
&Name
) const;
500 const SDNodeInfo
&getSDNodeInfo(Record
*R
) const {
501 assert(SDNodes
.count(R
) && "Unknown node!");
502 return SDNodes
.find(R
)->second
;
505 // Node transformation lookups.
506 typedef std::pair
<Record
*, std::string
> NodeXForm
;
507 const NodeXForm
&getSDNodeTransform(Record
*R
) const {
508 assert(SDNodeXForms
.count(R
) && "Invalid transform!");
509 return SDNodeXForms
.find(R
)->second
;
512 typedef std::map
<Record
*, NodeXForm
, RecordPtrCmp
>::const_iterator
514 nx_iterator
nx_begin() const { return SDNodeXForms
.begin(); }
515 nx_iterator
nx_end() const { return SDNodeXForms
.end(); }
518 const ComplexPattern
&getComplexPattern(Record
*R
) const {
519 assert(ComplexPatterns
.count(R
) && "Unknown addressing mode!");
520 return ComplexPatterns
.find(R
)->second
;
523 const CodeGenIntrinsic
&getIntrinsic(Record
*R
) const {
524 for (unsigned i
= 0, e
= Intrinsics
.size(); i
!= e
; ++i
)
525 if (Intrinsics
[i
].TheDef
== R
) return Intrinsics
[i
];
526 for (unsigned i
= 0, e
= TgtIntrinsics
.size(); i
!= e
; ++i
)
527 if (TgtIntrinsics
[i
].TheDef
== R
) return TgtIntrinsics
[i
];
528 assert(0 && "Unknown intrinsic!");
532 const CodeGenIntrinsic
&getIntrinsicInfo(unsigned IID
) const {
533 if (IID
-1 < Intrinsics
.size())
534 return Intrinsics
[IID
-1];
535 if (IID
-Intrinsics
.size()-1 < TgtIntrinsics
.size())
536 return TgtIntrinsics
[IID
-Intrinsics
.size()-1];
537 assert(0 && "Bad intrinsic ID!");
541 unsigned getIntrinsicID(Record
*R
) const {
542 for (unsigned i
= 0, e
= Intrinsics
.size(); i
!= e
; ++i
)
543 if (Intrinsics
[i
].TheDef
== R
) return i
;
544 for (unsigned i
= 0, e
= TgtIntrinsics
.size(); i
!= e
; ++i
)
545 if (TgtIntrinsics
[i
].TheDef
== R
) return i
+ Intrinsics
.size();
546 assert(0 && "Unknown intrinsic!");
550 const DAGDefaultOperand
&getDefaultOperand(Record
*R
) {
551 assert(DefaultOperands
.count(R
) &&"Isn't an analyzed default operand!");
552 return DefaultOperands
.find(R
)->second
;
555 // Pattern Fragment information.
556 TreePattern
*getPatternFragment(Record
*R
) const {
557 assert(PatternFragments
.count(R
) && "Invalid pattern fragment request!");
558 return PatternFragments
.find(R
)->second
;
560 typedef std::map
<Record
*, TreePattern
*, RecordPtrCmp
>::const_iterator
562 pf_iterator
pf_begin() const { return PatternFragments
.begin(); }
563 pf_iterator
pf_end() const { return PatternFragments
.end(); }
565 // Patterns to match information.
566 typedef std::vector
<PatternToMatch
>::const_iterator ptm_iterator
;
567 ptm_iterator
ptm_begin() const { return PatternsToMatch
.begin(); }
568 ptm_iterator
ptm_end() const { return PatternsToMatch
.end(); }
572 const DAGInstruction
&getInstruction(Record
*R
) const {
573 assert(Instructions
.count(R
) && "Unknown instruction!");
574 return Instructions
.find(R
)->second
;
577 Record
*get_intrinsic_void_sdnode() const {
578 return intrinsic_void_sdnode
;
580 Record
*get_intrinsic_w_chain_sdnode() const {
581 return intrinsic_w_chain_sdnode
;
583 Record
*get_intrinsic_wo_chain_sdnode() const {
584 return intrinsic_wo_chain_sdnode
;
588 void ParseNodeInfo();
589 void ParseNodeTransforms();
590 void ParseComplexPatterns();
591 void ParsePatternFragments();
592 void ParseDefaultOperands();
593 void ParseInstructions();
594 void ParsePatterns();
595 void InferInstructionFlags();
596 void GenerateVariants();
598 void FindPatternInputsAndOutputs(TreePattern
*I
, TreePatternNode
*Pat
,
599 std::map
<std::string
,
600 TreePatternNode
*> &InstInputs
,
601 std::map
<std::string
,
602 TreePatternNode
*> &InstResults
,
603 std::vector
<Record
*> &InstImpInputs
,
604 std::vector
<Record
*> &InstImpResults
);
606 } // end namespace llvm