1 //===- CodeGenDAGPatterns.cpp - Read DAG patterns from .td file -----------===//
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 CodeGenDAGPatterns class, which is used to read and
11 // represent the patterns present in a .td file for instructions.
13 //===----------------------------------------------------------------------===//
15 #include "CodeGenDAGPatterns.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/TableGen/Error.h"
22 #include "llvm/TableGen/Record.h"
28 #define DEBUG_TYPE "dag-patterns"
30 //===----------------------------------------------------------------------===//
31 // EEVT::TypeSet Implementation
32 //===----------------------------------------------------------------------===//
34 static inline bool isInteger(MVT::SimpleValueType VT) {
35 return MVT(VT).isInteger();
37 static inline bool isFloatingPoint(MVT::SimpleValueType VT) {
38 return MVT(VT).isFloatingPoint();
40 static inline bool isVector(MVT::SimpleValueType VT) {
41 return MVT(VT).isVector();
43 static inline bool isScalar(MVT::SimpleValueType VT) {
44 return !MVT(VT).isVector();
47 EEVT::TypeSet::TypeSet(MVT::SimpleValueType VT, TreePattern &TP) {
50 else if (VT == MVT::fAny)
51 EnforceFloatingPoint(TP);
52 else if (VT == MVT::vAny)
55 assert((VT < MVT::LAST_VALUETYPE || VT == MVT::iPTR ||
56 VT == MVT::iPTRAny) && "Not a concrete type!");
57 TypeVec.push_back(VT);
62 EEVT::TypeSet::TypeSet(ArrayRef<MVT::SimpleValueType> VTList) {
63 assert(!VTList.empty() && "empty list?");
64 TypeVec.append(VTList.begin(), VTList.end());
67 assert(VTList[0] != MVT::iAny && VTList[0] != MVT::vAny &&
68 VTList[0] != MVT::fAny);
70 // Verify no duplicates.
71 array_pod_sort(TypeVec.begin(), TypeVec.end());
72 assert(std::unique(TypeVec.begin(), TypeVec.end()) == TypeVec.end());
75 /// FillWithPossibleTypes - Set to all legal types and return true, only valid
76 /// on completely unknown type sets.
77 bool EEVT::TypeSet::FillWithPossibleTypes(TreePattern &TP,
78 bool (*Pred)(MVT::SimpleValueType),
79 const char *PredicateName) {
80 assert(isCompletelyUnknown());
81 ArrayRef<MVT::SimpleValueType> LegalTypes =
82 TP.getDAGPatterns().getTargetInfo().getLegalValueTypes();
87 for (unsigned i = 0, e = LegalTypes.size(); i != e; ++i)
88 if (!Pred || Pred(LegalTypes[i]))
89 TypeVec.push_back(LegalTypes[i]);
91 // If we have nothing that matches the predicate, bail out.
92 if (TypeVec.empty()) {
93 TP.error("Type inference contradiction found, no " +
94 std::string(PredicateName) + " types found");
97 // No need to sort with one element.
98 if (TypeVec.size() == 1) return true;
100 // Remove duplicates.
101 array_pod_sort(TypeVec.begin(), TypeVec.end());
102 TypeVec.erase(std::unique(TypeVec.begin(), TypeVec.end()), TypeVec.end());
107 /// hasIntegerTypes - Return true if this TypeSet contains iAny or an
108 /// integer value type.
109 bool EEVT::TypeSet::hasIntegerTypes() const {
110 for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
111 if (isInteger(TypeVec[i]))
116 /// hasFloatingPointTypes - Return true if this TypeSet contains an fAny or
117 /// a floating point value type.
118 bool EEVT::TypeSet::hasFloatingPointTypes() const {
119 for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
120 if (isFloatingPoint(TypeVec[i]))
125 /// hasScalarTypes - Return true if this TypeSet contains a scalar value type.
126 bool EEVT::TypeSet::hasScalarTypes() const {
127 for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
128 if (isScalar(TypeVec[i]))
133 /// hasVectorTypes - Return true if this TypeSet contains a vAny or a vector
135 bool EEVT::TypeSet::hasVectorTypes() const {
136 for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
137 if (isVector(TypeVec[i]))
143 std::string EEVT::TypeSet::getName() const {
144 if (TypeVec.empty()) return "<empty>";
148 for (unsigned i = 0, e = TypeVec.size(); i != e; ++i) {
149 std::string VTName = llvm::getEnumName(TypeVec[i]);
150 // Strip off MVT:: prefix if present.
151 if (VTName.substr(0,5) == "MVT::")
152 VTName = VTName.substr(5);
153 if (i) Result += ':';
157 if (TypeVec.size() == 1)
159 return "{" + Result + "}";
162 /// MergeInTypeInfo - This merges in type information from the specified
163 /// argument. If 'this' changes, it returns true. If the two types are
164 /// contradictory (e.g. merge f32 into i32) then this flags an error.
165 bool EEVT::TypeSet::MergeInTypeInfo(const EEVT::TypeSet &InVT, TreePattern &TP){
166 if (InVT.isCompletelyUnknown() || *this == InVT || TP.hasError())
169 if (isCompletelyUnknown()) {
174 assert(TypeVec.size() >= 1 && InVT.TypeVec.size() >= 1 && "No unknowns");
176 // Handle the abstract cases, seeing if we can resolve them better.
177 switch (TypeVec[0]) {
181 if (InVT.hasIntegerTypes()) {
182 EEVT::TypeSet InCopy(InVT);
183 InCopy.EnforceInteger(TP);
184 InCopy.EnforceScalar(TP);
186 if (InCopy.isConcrete()) {
187 // If the RHS has one integer type, upgrade iPTR to i32.
188 TypeVec[0] = InVT.TypeVec[0];
192 // If the input has multiple scalar integers, this doesn't add any info.
193 if (!InCopy.isCompletelyUnknown())
199 // If the input constraint is iAny/iPTR and this is an integer type list,
200 // remove non-integer types from the list.
201 if ((InVT.TypeVec[0] == MVT::iPTR || InVT.TypeVec[0] == MVT::iPTRAny) &&
203 bool MadeChange = EnforceInteger(TP);
205 // If we're merging in iPTR/iPTRAny and the node currently has a list of
206 // multiple different integer types, replace them with a single iPTR.
207 if ((InVT.TypeVec[0] == MVT::iPTR || InVT.TypeVec[0] == MVT::iPTRAny) &&
208 TypeVec.size() != 1) {
210 TypeVec[0] = InVT.TypeVec[0];
217 // If this is a type list and the RHS is a typelist as well, eliminate entries
218 // from this list that aren't in the other one.
219 bool MadeChange = false;
220 TypeSet InputSet(*this);
222 for (unsigned i = 0; i != TypeVec.size(); ++i) {
224 for (unsigned j = 0, e = InVT.TypeVec.size(); j != e; ++j)
225 if (TypeVec[i] == InVT.TypeVec[j]) {
230 if (InInVT) continue;
231 TypeVec.erase(TypeVec.begin()+i--);
235 // If we removed all of our types, we have a type contradiction.
236 if (!TypeVec.empty())
239 // FIXME: Really want an SMLoc here!
240 TP.error("Type inference contradiction found, merging '" +
241 InVT.getName() + "' into '" + InputSet.getName() + "'");
245 /// EnforceInteger - Remove all non-integer types from this set.
246 bool EEVT::TypeSet::EnforceInteger(TreePattern &TP) {
249 // If we know nothing, then get the full set.
251 return FillWithPossibleTypes(TP, isInteger, "integer");
252 if (!hasFloatingPointTypes())
255 TypeSet InputSet(*this);
257 // Filter out all the fp types.
258 for (unsigned i = 0; i != TypeVec.size(); ++i)
259 if (!isInteger(TypeVec[i]))
260 TypeVec.erase(TypeVec.begin()+i--);
262 if (TypeVec.empty()) {
263 TP.error("Type inference contradiction found, '" +
264 InputSet.getName() + "' needs to be integer");
270 /// EnforceFloatingPoint - Remove all integer types from this set.
271 bool EEVT::TypeSet::EnforceFloatingPoint(TreePattern &TP) {
274 // If we know nothing, then get the full set.
276 return FillWithPossibleTypes(TP, isFloatingPoint, "floating point");
278 if (!hasIntegerTypes())
281 TypeSet InputSet(*this);
283 // Filter out all the fp types.
284 for (unsigned i = 0; i != TypeVec.size(); ++i)
285 if (!isFloatingPoint(TypeVec[i]))
286 TypeVec.erase(TypeVec.begin()+i--);
288 if (TypeVec.empty()) {
289 TP.error("Type inference contradiction found, '" +
290 InputSet.getName() + "' needs to be floating point");
296 /// EnforceScalar - Remove all vector types from this.
297 bool EEVT::TypeSet::EnforceScalar(TreePattern &TP) {
301 // If we know nothing, then get the full set.
303 return FillWithPossibleTypes(TP, isScalar, "scalar");
305 if (!hasVectorTypes())
308 TypeSet InputSet(*this);
310 // Filter out all the vector types.
311 for (unsigned i = 0; i != TypeVec.size(); ++i)
312 if (!isScalar(TypeVec[i]))
313 TypeVec.erase(TypeVec.begin()+i--);
315 if (TypeVec.empty()) {
316 TP.error("Type inference contradiction found, '" +
317 InputSet.getName() + "' needs to be scalar");
323 /// EnforceVector - Remove all vector types from this.
324 bool EEVT::TypeSet::EnforceVector(TreePattern &TP) {
328 // If we know nothing, then get the full set.
330 return FillWithPossibleTypes(TP, isVector, "vector");
332 TypeSet InputSet(*this);
333 bool MadeChange = false;
335 // Filter out all the scalar types.
336 for (unsigned i = 0; i != TypeVec.size(); ++i)
337 if (!isVector(TypeVec[i])) {
338 TypeVec.erase(TypeVec.begin()+i--);
342 if (TypeVec.empty()) {
343 TP.error("Type inference contradiction found, '" +
344 InputSet.getName() + "' needs to be a vector");
352 /// EnforceSmallerThan - 'this' must be a smaller VT than Other. For vectors
353 /// this shoud be based on the element type. Update this and other based on
354 /// this information.
355 bool EEVT::TypeSet::EnforceSmallerThan(EEVT::TypeSet &Other, TreePattern &TP) {
359 // Both operands must be integer or FP, but we don't care which.
360 bool MadeChange = false;
362 if (isCompletelyUnknown())
363 MadeChange = FillWithPossibleTypes(TP);
365 if (Other.isCompletelyUnknown())
366 MadeChange = Other.FillWithPossibleTypes(TP);
368 // If one side is known to be integer or known to be FP but the other side has
369 // no information, get at least the type integrality info in there.
370 if (!hasFloatingPointTypes())
371 MadeChange |= Other.EnforceInteger(TP);
372 else if (!hasIntegerTypes())
373 MadeChange |= Other.EnforceFloatingPoint(TP);
374 if (!Other.hasFloatingPointTypes())
375 MadeChange |= EnforceInteger(TP);
376 else if (!Other.hasIntegerTypes())
377 MadeChange |= EnforceFloatingPoint(TP);
379 assert(!isCompletelyUnknown() && !Other.isCompletelyUnknown() &&
380 "Should have a type list now");
382 // If one contains vectors but the other doesn't pull vectors out.
383 if (!hasVectorTypes())
384 MadeChange |= Other.EnforceScalar(TP);
385 else if (!hasScalarTypes())
386 MadeChange |= Other.EnforceVector(TP);
387 if (!Other.hasVectorTypes())
388 MadeChange |= EnforceScalar(TP);
389 else if (!Other.hasScalarTypes())
390 MadeChange |= EnforceVector(TP);
392 // For vectors we need to ensure that smaller size doesn't produce larger
393 // vector and vice versa.
394 if (isConcrete() && isVector(getConcrete())) {
395 MVT IVT = getConcrete();
396 unsigned Size = IVT.getSizeInBits();
398 // Only keep types that have at least as many bits.
399 TypeSet InputSet(Other);
401 for (unsigned i = 0; i != Other.TypeVec.size(); ++i) {
402 assert(isVector(Other.TypeVec[i]) && "EnforceVector didn't work");
403 if (MVT(Other.TypeVec[i]).getSizeInBits() < Size) {
404 Other.TypeVec.erase(Other.TypeVec.begin()+i--);
409 if (Other.TypeVec.empty()) { // FIXME: Really want an SMLoc here!
410 TP.error("Type inference contradiction found, forcing '" +
411 InputSet.getName() + "' to have at least as many bits as " +
415 } else if (Other.isConcrete() && isVector(Other.getConcrete())) {
416 MVT IVT = Other.getConcrete();
417 unsigned Size = IVT.getSizeInBits();
419 // Only keep types with the same or fewer total bits
420 TypeSet InputSet(*this);
422 for (unsigned i = 0; i != TypeVec.size(); ++i) {
423 assert(isVector(TypeVec[i]) && "EnforceVector didn't work");
424 if (MVT(TypeVec[i]).getSizeInBits() > Size) {
425 TypeVec.erase(TypeVec.begin()+i--);
430 if (TypeVec.empty()) { // FIXME: Really want an SMLoc here!
431 TP.error("Type inference contradiction found, forcing '" +
432 InputSet.getName() + "' to have the same or fewer bits than " +
433 Other.getName() + "'");
438 // This code does not currently handle nodes which have multiple types,
439 // where some types are integer, and some are fp. Assert that this is not
441 assert(!(hasIntegerTypes() && hasFloatingPointTypes()) &&
442 !(Other.hasIntegerTypes() && Other.hasFloatingPointTypes()) &&
443 "SDTCisOpSmallerThanOp does not handle mixed int/fp types!");
448 // Okay, find the smallest scalar type from the other set and remove
449 // anything the same or smaller from the current set.
450 TypeSet InputSet(Other);
451 MVT::SimpleValueType Smallest = TypeVec[0];
452 for (unsigned i = 0; i != Other.TypeVec.size(); ++i) {
453 if (Other.TypeVec[i] <= Smallest) {
454 Other.TypeVec.erase(Other.TypeVec.begin()+i--);
459 if (Other.TypeVec.empty()) {
460 TP.error("Type inference contradiction found, '" + InputSet.getName() +
461 "' has nothing larger than '" + getName() +"'!");
465 // Okay, find the largest scalar type from the other set and remove
466 // anything the same or larger from the current set.
467 InputSet = TypeSet(*this);
468 MVT::SimpleValueType Largest = Other.TypeVec[Other.TypeVec.size()-1];
469 for (unsigned i = 0; i != TypeVec.size(); ++i) {
470 if (TypeVec[i] >= Largest) {
471 TypeVec.erase(TypeVec.begin()+i--);
476 if (TypeVec.empty()) {
477 TP.error("Type inference contradiction found, '" + InputSet.getName() +
478 "' has nothing smaller than '" + Other.getName() +"'!");
485 /// EnforceVectorEltTypeIs - 'this' is now constrainted to be a vector type
486 /// whose element is specified by VTOperand.
487 bool EEVT::TypeSet::EnforceVectorEltTypeIs(EEVT::TypeSet &VTOperand,
492 // "This" must be a vector and "VTOperand" must be a scalar.
493 bool MadeChange = false;
494 MadeChange |= EnforceVector(TP);
495 MadeChange |= VTOperand.EnforceScalar(TP);
497 // If we know the vector type, it forces the scalar to agree.
499 MVT IVT = getConcrete();
500 IVT = IVT.getVectorElementType();
502 VTOperand.MergeInTypeInfo(IVT.SimpleTy, TP);
505 // If the scalar type is known, filter out vector types whose element types
507 if (!VTOperand.isConcrete())
510 MVT::SimpleValueType VT = VTOperand.getConcrete();
512 TypeSet InputSet(*this);
514 // Filter out all the types which don't have the right element type.
515 for (unsigned i = 0; i != TypeVec.size(); ++i) {
516 assert(isVector(TypeVec[i]) && "EnforceVector didn't work");
517 if (MVT(TypeVec[i]).getVectorElementType().SimpleTy != VT) {
518 TypeVec.erase(TypeVec.begin()+i--);
523 if (TypeVec.empty()) { // FIXME: Really want an SMLoc here!
524 TP.error("Type inference contradiction found, forcing '" +
525 InputSet.getName() + "' to have a vector element");
531 /// EnforceVectorSubVectorTypeIs - 'this' is now constrainted to be a
532 /// vector type specified by VTOperand.
533 bool EEVT::TypeSet::EnforceVectorSubVectorTypeIs(EEVT::TypeSet &VTOperand,
538 // "This" must be a vector and "VTOperand" must be a vector.
539 bool MadeChange = false;
540 MadeChange |= EnforceVector(TP);
541 MadeChange |= VTOperand.EnforceVector(TP);
543 // If one side is known to be integer or known to be FP but the other side has
544 // no information, get at least the type integrality info in there.
545 if (!hasFloatingPointTypes())
546 MadeChange |= VTOperand.EnforceInteger(TP);
547 else if (!hasIntegerTypes())
548 MadeChange |= VTOperand.EnforceFloatingPoint(TP);
549 if (!VTOperand.hasFloatingPointTypes())
550 MadeChange |= EnforceInteger(TP);
551 else if (!VTOperand.hasIntegerTypes())
552 MadeChange |= EnforceFloatingPoint(TP);
554 assert(!isCompletelyUnknown() && !VTOperand.isCompletelyUnknown() &&
555 "Should have a type list now");
557 // If we know the vector type, it forces the scalar types to agree.
558 // Also force one vector to have more elements than the other.
560 MVT IVT = getConcrete();
561 unsigned NumElems = IVT.getVectorNumElements();
562 IVT = IVT.getVectorElementType();
564 EEVT::TypeSet EltTypeSet(IVT.SimpleTy, TP);
565 MadeChange |= VTOperand.EnforceVectorEltTypeIs(EltTypeSet, TP);
567 // Only keep types that have less elements than VTOperand.
568 TypeSet InputSet(VTOperand);
570 for (unsigned i = 0; i != VTOperand.TypeVec.size(); ++i) {
571 assert(isVector(VTOperand.TypeVec[i]) && "EnforceVector didn't work");
572 if (MVT(VTOperand.TypeVec[i]).getVectorNumElements() >= NumElems) {
573 VTOperand.TypeVec.erase(VTOperand.TypeVec.begin()+i--);
577 if (VTOperand.TypeVec.empty()) { // FIXME: Really want an SMLoc here!
578 TP.error("Type inference contradiction found, forcing '" +
579 InputSet.getName() + "' to have less vector elements than '" +
583 } else if (VTOperand.isConcrete()) {
584 MVT IVT = VTOperand.getConcrete();
585 unsigned NumElems = IVT.getVectorNumElements();
586 IVT = IVT.getVectorElementType();
588 EEVT::TypeSet EltTypeSet(IVT.SimpleTy, TP);
589 MadeChange |= EnforceVectorEltTypeIs(EltTypeSet, TP);
591 // Only keep types that have more elements than 'this'.
592 TypeSet InputSet(*this);
594 for (unsigned i = 0; i != TypeVec.size(); ++i) {
595 assert(isVector(TypeVec[i]) && "EnforceVector didn't work");
596 if (MVT(TypeVec[i]).getVectorNumElements() <= NumElems) {
597 TypeVec.erase(TypeVec.begin()+i--);
601 if (TypeVec.empty()) { // FIXME: Really want an SMLoc here!
602 TP.error("Type inference contradiction found, forcing '" +
603 InputSet.getName() + "' to have more vector elements than '" +
604 VTOperand.getName() + "'");
612 //===----------------------------------------------------------------------===//
613 // Helpers for working with extended types.
615 /// Dependent variable map for CodeGenDAGPattern variant generation
616 typedef std::map<std::string, int> DepVarMap;
618 /// Const iterator shorthand for DepVarMap
619 typedef DepVarMap::const_iterator DepVarMap_citer;
621 static void FindDepVarsOf(TreePatternNode *N, DepVarMap &DepMap) {
623 if (isa<DefInit>(N->getLeafValue()))
624 DepMap[N->getName()]++;
626 for (size_t i = 0, e = N->getNumChildren(); i != e; ++i)
627 FindDepVarsOf(N->getChild(i), DepMap);
631 /// Find dependent variables within child patterns
632 static void FindDepVars(TreePatternNode *N, MultipleUseVarSet &DepVars) {
634 FindDepVarsOf(N, depcounts);
635 for (DepVarMap_citer i = depcounts.begin(); i != depcounts.end(); ++i) {
636 if (i->second > 1) // std::pair<std::string, int>
637 DepVars.insert(i->first);
642 /// Dump the dependent variable set:
643 static void DumpDepVars(MultipleUseVarSet &DepVars) {
644 if (DepVars.empty()) {
645 DEBUG(errs() << "<empty set>");
647 DEBUG(errs() << "[ ");
648 for (MultipleUseVarSet::const_iterator i = DepVars.begin(),
649 e = DepVars.end(); i != e; ++i) {
650 DEBUG(errs() << (*i) << " ");
652 DEBUG(errs() << "]");
658 //===----------------------------------------------------------------------===//
659 // TreePredicateFn Implementation
660 //===----------------------------------------------------------------------===//
662 /// TreePredicateFn constructor. Here 'N' is a subclass of PatFrag.
663 TreePredicateFn::TreePredicateFn(TreePattern *N) : PatFragRec(N) {
664 assert((getPredCode().empty() || getImmCode().empty()) &&
665 ".td file corrupt: can't have a node predicate *and* an imm predicate");
668 std::string TreePredicateFn::getPredCode() const {
669 return PatFragRec->getRecord()->getValueAsString("PredicateCode");
672 std::string TreePredicateFn::getImmCode() const {
673 return PatFragRec->getRecord()->getValueAsString("ImmediateCode");
677 /// isAlwaysTrue - Return true if this is a noop predicate.
678 bool TreePredicateFn::isAlwaysTrue() const {
679 return getPredCode().empty() && getImmCode().empty();
682 /// Return the name to use in the generated code to reference this, this is
683 /// "Predicate_foo" if from a pattern fragment "foo".
684 std::string TreePredicateFn::getFnName() const {
685 return "Predicate_" + PatFragRec->getRecord()->getName();
688 /// getCodeToRunOnSDNode - Return the code for the function body that
689 /// evaluates this predicate. The argument is expected to be in "Node",
690 /// not N. This handles casting and conversion to a concrete node type as
692 std::string TreePredicateFn::getCodeToRunOnSDNode() const {
693 // Handle immediate predicates first.
694 std::string ImmCode = getImmCode();
695 if (!ImmCode.empty()) {
697 " int64_t Imm = cast<ConstantSDNode>(Node)->getSExtValue();\n";
698 return Result + ImmCode;
701 // Handle arbitrary node predicates.
702 assert(!getPredCode().empty() && "Don't have any predicate code!");
703 std::string ClassName;
704 if (PatFragRec->getOnlyTree()->isLeaf())
705 ClassName = "SDNode";
707 Record *Op = PatFragRec->getOnlyTree()->getOperator();
708 ClassName = PatFragRec->getDAGPatterns().getSDNodeInfo(Op).getSDClassName();
711 if (ClassName == "SDNode")
712 Result = " SDNode *N = Node;\n";
714 Result = " " + ClassName + "*N = cast<" + ClassName + ">(Node);\n";
716 return Result + getPredCode();
719 //===----------------------------------------------------------------------===//
720 // PatternToMatch implementation
724 /// getPatternSize - Return the 'size' of this pattern. We want to match large
725 /// patterns before small ones. This is used to determine the size of a
727 static unsigned getPatternSize(const TreePatternNode *P,
728 const CodeGenDAGPatterns &CGP) {
729 unsigned Size = 3; // The node itself.
730 // If the root node is a ConstantSDNode, increases its size.
731 // e.g. (set R32:$dst, 0).
732 if (P->isLeaf() && isa<IntInit>(P->getLeafValue()))
735 // FIXME: This is a hack to statically increase the priority of patterns
736 // which maps a sub-dag to a complex pattern. e.g. favors LEA over ADD.
737 // Later we can allow complexity / cost for each pattern to be (optionally)
738 // specified. To get best possible pattern match we'll need to dynamically
739 // calculate the complexity of all patterns a dag can potentially map to.
740 const ComplexPattern *AM = P->getComplexPatternInfo(CGP);
742 Size += AM->getNumOperands() * 3;
744 // If this node has some predicate function that must match, it adds to the
745 // complexity of this node.
746 if (!P->getPredicateFns().empty())
749 // Count children in the count if they are also nodes.
750 for (unsigned i = 0, e = P->getNumChildren(); i != e; ++i) {
751 TreePatternNode *Child = P->getChild(i);
752 if (!Child->isLeaf() && Child->getNumTypes() &&
753 Child->getType(0) != MVT::Other)
754 Size += getPatternSize(Child, CGP);
755 else if (Child->isLeaf()) {
756 if (isa<IntInit>(Child->getLeafValue()))
757 Size += 5; // Matches a ConstantSDNode (+3) and a specific value (+2).
758 else if (Child->getComplexPatternInfo(CGP))
759 Size += getPatternSize(Child, CGP);
760 else if (!Child->getPredicateFns().empty())
768 /// Compute the complexity metric for the input pattern. This roughly
769 /// corresponds to the number of nodes that are covered.
770 unsigned PatternToMatch::
771 getPatternComplexity(const CodeGenDAGPatterns &CGP) const {
772 return getPatternSize(getSrcPattern(), CGP) + getAddedComplexity();
776 /// getPredicateCheck - Return a single string containing all of this
777 /// pattern's predicates concatenated with "&&" operators.
779 std::string PatternToMatch::getPredicateCheck() const {
780 std::string PredicateCheck;
781 for (unsigned i = 0, e = Predicates->getSize(); i != e; ++i) {
782 if (DefInit *Pred = dyn_cast<DefInit>(Predicates->getElement(i))) {
783 Record *Def = Pred->getDef();
784 if (!Def->isSubClassOf("Predicate")) {
788 llvm_unreachable("Unknown predicate type!");
790 if (!PredicateCheck.empty())
791 PredicateCheck += " && ";
792 PredicateCheck += "(" + Def->getValueAsString("CondString") + ")";
796 return PredicateCheck;
799 //===----------------------------------------------------------------------===//
800 // SDTypeConstraint implementation
803 SDTypeConstraint::SDTypeConstraint(Record *R) {
804 OperandNo = R->getValueAsInt("OperandNum");
806 if (R->isSubClassOf("SDTCisVT")) {
807 ConstraintType = SDTCisVT;
808 x.SDTCisVT_Info.VT = getValueType(R->getValueAsDef("VT"));
809 if (x.SDTCisVT_Info.VT == MVT::isVoid)
810 PrintFatalError(R->getLoc(), "Cannot use 'Void' as type to SDTCisVT");
812 } else if (R->isSubClassOf("SDTCisPtrTy")) {
813 ConstraintType = SDTCisPtrTy;
814 } else if (R->isSubClassOf("SDTCisInt")) {
815 ConstraintType = SDTCisInt;
816 } else if (R->isSubClassOf("SDTCisFP")) {
817 ConstraintType = SDTCisFP;
818 } else if (R->isSubClassOf("SDTCisVec")) {
819 ConstraintType = SDTCisVec;
820 } else if (R->isSubClassOf("SDTCisSameAs")) {
821 ConstraintType = SDTCisSameAs;
822 x.SDTCisSameAs_Info.OtherOperandNum = R->getValueAsInt("OtherOperandNum");
823 } else if (R->isSubClassOf("SDTCisVTSmallerThanOp")) {
824 ConstraintType = SDTCisVTSmallerThanOp;
825 x.SDTCisVTSmallerThanOp_Info.OtherOperandNum =
826 R->getValueAsInt("OtherOperandNum");
827 } else if (R->isSubClassOf("SDTCisOpSmallerThanOp")) {
828 ConstraintType = SDTCisOpSmallerThanOp;
829 x.SDTCisOpSmallerThanOp_Info.BigOperandNum =
830 R->getValueAsInt("BigOperandNum");
831 } else if (R->isSubClassOf("SDTCisEltOfVec")) {
832 ConstraintType = SDTCisEltOfVec;
833 x.SDTCisEltOfVec_Info.OtherOperandNum = R->getValueAsInt("OtherOpNum");
834 } else if (R->isSubClassOf("SDTCisSubVecOfVec")) {
835 ConstraintType = SDTCisSubVecOfVec;
836 x.SDTCisSubVecOfVec_Info.OtherOperandNum =
837 R->getValueAsInt("OtherOpNum");
839 errs() << "Unrecognized SDTypeConstraint '" << R->getName() << "'!\n";
844 /// getOperandNum - Return the node corresponding to operand #OpNo in tree
845 /// N, and the result number in ResNo.
846 static TreePatternNode *getOperandNum(unsigned OpNo, TreePatternNode *N,
847 const SDNodeInfo &NodeInfo,
849 unsigned NumResults = NodeInfo.getNumResults();
850 if (OpNo < NumResults) {
857 if (OpNo >= N->getNumChildren()) {
858 errs() << "Invalid operand number in type constraint "
859 << (OpNo+NumResults) << " ";
865 return N->getChild(OpNo);
868 /// ApplyTypeConstraint - Given a node in a pattern, apply this type
869 /// constraint to the nodes operands. This returns true if it makes a
870 /// change, false otherwise. If a type contradiction is found, flag an error.
871 bool SDTypeConstraint::ApplyTypeConstraint(TreePatternNode *N,
872 const SDNodeInfo &NodeInfo,
873 TreePattern &TP) const {
877 unsigned ResNo = 0; // The result number being referenced.
878 TreePatternNode *NodeToApply = getOperandNum(OperandNo, N, NodeInfo, ResNo);
880 switch (ConstraintType) {
882 // Operand must be a particular type.
883 return NodeToApply->UpdateNodeType(ResNo, x.SDTCisVT_Info.VT, TP);
885 // Operand must be same as target pointer type.
886 return NodeToApply->UpdateNodeType(ResNo, MVT::iPTR, TP);
888 // Require it to be one of the legal integer VTs.
889 return NodeToApply->getExtType(ResNo).EnforceInteger(TP);
891 // Require it to be one of the legal fp VTs.
892 return NodeToApply->getExtType(ResNo).EnforceFloatingPoint(TP);
894 // Require it to be one of the legal vector VTs.
895 return NodeToApply->getExtType(ResNo).EnforceVector(TP);
898 TreePatternNode *OtherNode =
899 getOperandNum(x.SDTCisSameAs_Info.OtherOperandNum, N, NodeInfo, OResNo);
900 return NodeToApply->UpdateNodeType(OResNo, OtherNode->getExtType(ResNo),TP)|
901 OtherNode->UpdateNodeType(ResNo,NodeToApply->getExtType(OResNo),TP);
903 case SDTCisVTSmallerThanOp: {
904 // The NodeToApply must be a leaf node that is a VT. OtherOperandNum must
905 // have an integer type that is smaller than the VT.
906 if (!NodeToApply->isLeaf() ||
907 !isa<DefInit>(NodeToApply->getLeafValue()) ||
908 !static_cast<DefInit*>(NodeToApply->getLeafValue())->getDef()
909 ->isSubClassOf("ValueType")) {
910 TP.error(N->getOperator()->getName() + " expects a VT operand!");
913 MVT::SimpleValueType VT =
914 getValueType(static_cast<DefInit*>(NodeToApply->getLeafValue())->getDef());
916 EEVT::TypeSet TypeListTmp(VT, TP);
919 TreePatternNode *OtherNode =
920 getOperandNum(x.SDTCisVTSmallerThanOp_Info.OtherOperandNum, N, NodeInfo,
923 return TypeListTmp.EnforceSmallerThan(OtherNode->getExtType(OResNo), TP);
925 case SDTCisOpSmallerThanOp: {
927 TreePatternNode *BigOperand =
928 getOperandNum(x.SDTCisOpSmallerThanOp_Info.BigOperandNum, N, NodeInfo,
930 return NodeToApply->getExtType(ResNo).
931 EnforceSmallerThan(BigOperand->getExtType(BResNo), TP);
933 case SDTCisEltOfVec: {
935 TreePatternNode *VecOperand =
936 getOperandNum(x.SDTCisEltOfVec_Info.OtherOperandNum, N, NodeInfo,
939 // Filter vector types out of VecOperand that don't have the right element
941 return VecOperand->getExtType(VResNo).
942 EnforceVectorEltTypeIs(NodeToApply->getExtType(ResNo), TP);
944 case SDTCisSubVecOfVec: {
946 TreePatternNode *BigVecOperand =
947 getOperandNum(x.SDTCisSubVecOfVec_Info.OtherOperandNum, N, NodeInfo,
950 // Filter vector types out of BigVecOperand that don't have the
951 // right subvector type.
952 return BigVecOperand->getExtType(VResNo).
953 EnforceVectorSubVectorTypeIs(NodeToApply->getExtType(ResNo), TP);
956 llvm_unreachable("Invalid ConstraintType!");
959 // Update the node type to match an instruction operand or result as specified
960 // in the ins or outs lists on the instruction definition. Return true if the
961 // type was actually changed.
962 bool TreePatternNode::UpdateNodeTypeFromInst(unsigned ResNo,
965 // The 'unknown' operand indicates that types should be inferred from the
967 if (Operand->isSubClassOf("unknown_class"))
970 // The Operand class specifies a type directly.
971 if (Operand->isSubClassOf("Operand"))
972 return UpdateNodeType(ResNo, getValueType(Operand->getValueAsDef("Type")),
975 // PointerLikeRegClass has a type that is determined at runtime.
976 if (Operand->isSubClassOf("PointerLikeRegClass"))
977 return UpdateNodeType(ResNo, MVT::iPTR, TP);
979 // Both RegisterClass and RegisterOperand operands derive their types from a
980 // register class def.
981 Record *RC = nullptr;
982 if (Operand->isSubClassOf("RegisterClass"))
984 else if (Operand->isSubClassOf("RegisterOperand"))
985 RC = Operand->getValueAsDef("RegClass");
987 assert(RC && "Unknown operand type");
988 CodeGenTarget &Tgt = TP.getDAGPatterns().getTargetInfo();
989 return UpdateNodeType(ResNo, Tgt.getRegisterClass(RC).getValueTypes(), TP);
993 //===----------------------------------------------------------------------===//
994 // SDNodeInfo implementation
996 SDNodeInfo::SDNodeInfo(Record *R) : Def(R) {
997 EnumName = R->getValueAsString("Opcode");
998 SDClassName = R->getValueAsString("SDClass");
999 Record *TypeProfile = R->getValueAsDef("TypeProfile");
1000 NumResults = TypeProfile->getValueAsInt("NumResults");
1001 NumOperands = TypeProfile->getValueAsInt("NumOperands");
1003 // Parse the properties.
1005 std::vector<Record*> PropList = R->getValueAsListOfDefs("Properties");
1006 for (unsigned i = 0, e = PropList.size(); i != e; ++i) {
1007 if (PropList[i]->getName() == "SDNPCommutative") {
1008 Properties |= 1 << SDNPCommutative;
1009 } else if (PropList[i]->getName() == "SDNPAssociative") {
1010 Properties |= 1 << SDNPAssociative;
1011 } else if (PropList[i]->getName() == "SDNPHasChain") {
1012 Properties |= 1 << SDNPHasChain;
1013 } else if (PropList[i]->getName() == "SDNPOutGlue") {
1014 Properties |= 1 << SDNPOutGlue;
1015 } else if (PropList[i]->getName() == "SDNPInGlue") {
1016 Properties |= 1 << SDNPInGlue;
1017 } else if (PropList[i]->getName() == "SDNPOptInGlue") {
1018 Properties |= 1 << SDNPOptInGlue;
1019 } else if (PropList[i]->getName() == "SDNPMayStore") {
1020 Properties |= 1 << SDNPMayStore;
1021 } else if (PropList[i]->getName() == "SDNPMayLoad") {
1022 Properties |= 1 << SDNPMayLoad;
1023 } else if (PropList[i]->getName() == "SDNPSideEffect") {
1024 Properties |= 1 << SDNPSideEffect;
1025 } else if (PropList[i]->getName() == "SDNPMemOperand") {
1026 Properties |= 1 << SDNPMemOperand;
1027 } else if (PropList[i]->getName() == "SDNPVariadic") {
1028 Properties |= 1 << SDNPVariadic;
1030 errs() << "Unknown SD Node property '" << PropList[i]->getName()
1031 << "' on node '" << R->getName() << "'!\n";
1037 // Parse the type constraints.
1038 std::vector<Record*> ConstraintList =
1039 TypeProfile->getValueAsListOfDefs("Constraints");
1040 TypeConstraints.assign(ConstraintList.begin(), ConstraintList.end());
1043 /// getKnownType - If the type constraints on this node imply a fixed type
1044 /// (e.g. all stores return void, etc), then return it as an
1045 /// MVT::SimpleValueType. Otherwise, return EEVT::Other.
1046 MVT::SimpleValueType SDNodeInfo::getKnownType(unsigned ResNo) const {
1047 unsigned NumResults = getNumResults();
1048 assert(NumResults <= 1 &&
1049 "We only work with nodes with zero or one result so far!");
1050 assert(ResNo == 0 && "Only handles single result nodes so far");
1052 for (unsigned i = 0, e = TypeConstraints.size(); i != e; ++i) {
1053 // Make sure that this applies to the correct node result.
1054 if (TypeConstraints[i].OperandNo >= NumResults) // FIXME: need value #
1057 switch (TypeConstraints[i].ConstraintType) {
1059 case SDTypeConstraint::SDTCisVT:
1060 return TypeConstraints[i].x.SDTCisVT_Info.VT;
1061 case SDTypeConstraint::SDTCisPtrTy:
1068 //===----------------------------------------------------------------------===//
1069 // TreePatternNode implementation
1072 TreePatternNode::~TreePatternNode() {
1073 #if 0 // FIXME: implement refcounted tree nodes!
1074 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1079 static unsigned GetNumNodeResults(Record *Operator, CodeGenDAGPatterns &CDP) {
1080 if (Operator->getName() == "set" ||
1081 Operator->getName() == "implicit")
1082 return 0; // All return nothing.
1084 if (Operator->isSubClassOf("Intrinsic"))
1085 return CDP.getIntrinsic(Operator).IS.RetVTs.size();
1087 if (Operator->isSubClassOf("SDNode"))
1088 return CDP.getSDNodeInfo(Operator).getNumResults();
1090 if (Operator->isSubClassOf("PatFrag")) {
1091 // If we've already parsed this pattern fragment, get it. Otherwise, handle
1092 // the forward reference case where one pattern fragment references another
1093 // before it is processed.
1094 if (TreePattern *PFRec = CDP.getPatternFragmentIfRead(Operator))
1095 return PFRec->getOnlyTree()->getNumTypes();
1097 // Get the result tree.
1098 DagInit *Tree = Operator->getValueAsDag("Fragment");
1099 Record *Op = nullptr;
1101 if (DefInit *DI = dyn_cast<DefInit>(Tree->getOperator()))
1103 assert(Op && "Invalid Fragment");
1104 return GetNumNodeResults(Op, CDP);
1107 if (Operator->isSubClassOf("Instruction")) {
1108 CodeGenInstruction &InstInfo = CDP.getTargetInfo().getInstruction(Operator);
1110 // FIXME: Should allow access to all the results here.
1111 unsigned NumDefsToAdd = InstInfo.Operands.NumDefs ? 1 : 0;
1113 // Add on one implicit def if it has a resolvable type.
1114 if (InstInfo.HasOneImplicitDefWithKnownVT(CDP.getTargetInfo()) !=MVT::Other)
1116 return NumDefsToAdd;
1119 if (Operator->isSubClassOf("SDNodeXForm"))
1120 return 1; // FIXME: Generalize SDNodeXForm
1122 if (Operator->isSubClassOf("ValueType"))
1123 return 1; // A type-cast of one result.
1126 errs() << "Unhandled node in GetNumNodeResults\n";
1130 void TreePatternNode::print(raw_ostream &OS) const {
1132 OS << *getLeafValue();
1134 OS << '(' << getOperator()->getName();
1136 for (unsigned i = 0, e = Types.size(); i != e; ++i)
1137 OS << ':' << getExtType(i).getName();
1140 if (getNumChildren() != 0) {
1142 getChild(0)->print(OS);
1143 for (unsigned i = 1, e = getNumChildren(); i != e; ++i) {
1145 getChild(i)->print(OS);
1151 for (unsigned i = 0, e = PredicateFns.size(); i != e; ++i)
1152 OS << "<<P:" << PredicateFns[i].getFnName() << ">>";
1154 OS << "<<X:" << TransformFn->getName() << ">>";
1155 if (!getName().empty())
1156 OS << ":$" << getName();
1159 void TreePatternNode::dump() const {
1163 /// isIsomorphicTo - Return true if this node is recursively
1164 /// isomorphic to the specified node. For this comparison, the node's
1165 /// entire state is considered. The assigned name is ignored, since
1166 /// nodes with differing names are considered isomorphic. However, if
1167 /// the assigned name is present in the dependent variable set, then
1168 /// the assigned name is considered significant and the node is
1169 /// isomorphic if the names match.
1170 bool TreePatternNode::isIsomorphicTo(const TreePatternNode *N,
1171 const MultipleUseVarSet &DepVars) const {
1172 if (N == this) return true;
1173 if (N->isLeaf() != isLeaf() || getExtTypes() != N->getExtTypes() ||
1174 getPredicateFns() != N->getPredicateFns() ||
1175 getTransformFn() != N->getTransformFn())
1179 if (DefInit *DI = dyn_cast<DefInit>(getLeafValue())) {
1180 if (DefInit *NDI = dyn_cast<DefInit>(N->getLeafValue())) {
1181 return ((DI->getDef() == NDI->getDef())
1182 && (DepVars.find(getName()) == DepVars.end()
1183 || getName() == N->getName()));
1186 return getLeafValue() == N->getLeafValue();
1189 if (N->getOperator() != getOperator() ||
1190 N->getNumChildren() != getNumChildren()) return false;
1191 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1192 if (!getChild(i)->isIsomorphicTo(N->getChild(i), DepVars))
1197 /// clone - Make a copy of this tree and all of its children.
1199 TreePatternNode *TreePatternNode::clone() const {
1200 TreePatternNode *New;
1202 New = new TreePatternNode(getLeafValue(), getNumTypes());
1204 std::vector<TreePatternNode*> CChildren;
1205 CChildren.reserve(Children.size());
1206 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1207 CChildren.push_back(getChild(i)->clone());
1208 New = new TreePatternNode(getOperator(), CChildren, getNumTypes());
1210 New->setName(getName());
1212 New->setPredicateFns(getPredicateFns());
1213 New->setTransformFn(getTransformFn());
1217 /// RemoveAllTypes - Recursively strip all the types of this tree.
1218 void TreePatternNode::RemoveAllTypes() {
1219 for (unsigned i = 0, e = Types.size(); i != e; ++i)
1220 Types[i] = EEVT::TypeSet(); // Reset to unknown type.
1221 if (isLeaf()) return;
1222 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1223 getChild(i)->RemoveAllTypes();
1227 /// SubstituteFormalArguments - Replace the formal arguments in this tree
1228 /// with actual values specified by ArgMap.
1229 void TreePatternNode::
1230 SubstituteFormalArguments(std::map<std::string, TreePatternNode*> &ArgMap) {
1231 if (isLeaf()) return;
1233 for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
1234 TreePatternNode *Child = getChild(i);
1235 if (Child->isLeaf()) {
1236 Init *Val = Child->getLeafValue();
1237 // Note that, when substituting into an output pattern, Val might be an
1239 if (isa<UnsetInit>(Val) || (isa<DefInit>(Val) &&
1240 cast<DefInit>(Val)->getDef()->getName() == "node")) {
1241 // We found a use of a formal argument, replace it with its value.
1242 TreePatternNode *NewChild = ArgMap[Child->getName()];
1243 assert(NewChild && "Couldn't find formal argument!");
1244 assert((Child->getPredicateFns().empty() ||
1245 NewChild->getPredicateFns() == Child->getPredicateFns()) &&
1246 "Non-empty child predicate clobbered!");
1247 setChild(i, NewChild);
1250 getChild(i)->SubstituteFormalArguments(ArgMap);
1256 /// InlinePatternFragments - If this pattern refers to any pattern
1257 /// fragments, inline them into place, giving us a pattern without any
1258 /// PatFrag references.
1259 TreePatternNode *TreePatternNode::InlinePatternFragments(TreePattern &TP) {
1264 return this; // nothing to do.
1265 Record *Op = getOperator();
1267 if (!Op->isSubClassOf("PatFrag")) {
1268 // Just recursively inline children nodes.
1269 for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
1270 TreePatternNode *Child = getChild(i);
1271 TreePatternNode *NewChild = Child->InlinePatternFragments(TP);
1273 assert((Child->getPredicateFns().empty() ||
1274 NewChild->getPredicateFns() == Child->getPredicateFns()) &&
1275 "Non-empty child predicate clobbered!");
1277 setChild(i, NewChild);
1282 // Otherwise, we found a reference to a fragment. First, look up its
1283 // TreePattern record.
1284 TreePattern *Frag = TP.getDAGPatterns().getPatternFragment(Op);
1286 // Verify that we are passing the right number of operands.
1287 if (Frag->getNumArgs() != Children.size()) {
1288 TP.error("'" + Op->getName() + "' fragment requires " +
1289 utostr(Frag->getNumArgs()) + " operands!");
1293 TreePatternNode *FragTree = Frag->getOnlyTree()->clone();
1295 TreePredicateFn PredFn(Frag);
1296 if (!PredFn.isAlwaysTrue())
1297 FragTree->addPredicateFn(PredFn);
1299 // Resolve formal arguments to their actual value.
1300 if (Frag->getNumArgs()) {
1301 // Compute the map of formal to actual arguments.
1302 std::map<std::string, TreePatternNode*> ArgMap;
1303 for (unsigned i = 0, e = Frag->getNumArgs(); i != e; ++i)
1304 ArgMap[Frag->getArgName(i)] = getChild(i)->InlinePatternFragments(TP);
1306 FragTree->SubstituteFormalArguments(ArgMap);
1309 FragTree->setName(getName());
1310 for (unsigned i = 0, e = Types.size(); i != e; ++i)
1311 FragTree->UpdateNodeType(i, getExtType(i), TP);
1313 // Transfer in the old predicates.
1314 for (unsigned i = 0, e = getPredicateFns().size(); i != e; ++i)
1315 FragTree->addPredicateFn(getPredicateFns()[i]);
1317 // Get a new copy of this fragment to stitch into here.
1318 //delete this; // FIXME: implement refcounting!
1320 // The fragment we inlined could have recursive inlining that is needed. See
1321 // if there are any pattern fragments in it and inline them as needed.
1322 return FragTree->InlinePatternFragments(TP);
1325 /// getImplicitType - Check to see if the specified record has an implicit
1326 /// type which should be applied to it. This will infer the type of register
1327 /// references from the register file information, for example.
1329 /// When Unnamed is set, return the type of a DAG operand with no name, such as
1330 /// the F8RC register class argument in:
1332 /// (COPY_TO_REGCLASS GPR:$src, F8RC)
1334 /// When Unnamed is false, return the type of a named DAG operand such as the
1335 /// GPR:$src operand above.
1337 static EEVT::TypeSet getImplicitType(Record *R, unsigned ResNo,
1341 // Check to see if this is a register operand.
1342 if (R->isSubClassOf("RegisterOperand")) {
1343 assert(ResNo == 0 && "Regoperand ref only has one result!");
1345 return EEVT::TypeSet(); // Unknown.
1346 Record *RegClass = R->getValueAsDef("RegClass");
1347 const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
1348 return EEVT::TypeSet(T.getRegisterClass(RegClass).getValueTypes());
1351 // Check to see if this is a register or a register class.
1352 if (R->isSubClassOf("RegisterClass")) {
1353 assert(ResNo == 0 && "Regclass ref only has one result!");
1354 // An unnamed register class represents itself as an i32 immediate, for
1355 // example on a COPY_TO_REGCLASS instruction.
1357 return EEVT::TypeSet(MVT::i32, TP);
1359 // In a named operand, the register class provides the possible set of
1362 return EEVT::TypeSet(); // Unknown.
1363 const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
1364 return EEVT::TypeSet(T.getRegisterClass(R).getValueTypes());
1367 if (R->isSubClassOf("PatFrag")) {
1368 assert(ResNo == 0 && "FIXME: PatFrag with multiple results?");
1369 // Pattern fragment types will be resolved when they are inlined.
1370 return EEVT::TypeSet(); // Unknown.
1373 if (R->isSubClassOf("Register")) {
1374 assert(ResNo == 0 && "Registers only produce one result!");
1376 return EEVT::TypeSet(); // Unknown.
1377 const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
1378 return EEVT::TypeSet(T.getRegisterVTs(R));
1381 if (R->isSubClassOf("SubRegIndex")) {
1382 assert(ResNo == 0 && "SubRegisterIndices only produce one result!");
1383 return EEVT::TypeSet();
1386 if (R->isSubClassOf("ValueType")) {
1387 assert(ResNo == 0 && "This node only has one result!");
1388 // An unnamed VTSDNode represents itself as an MVT::Other immediate.
1390 // (sext_inreg GPR:$src, i16)
1393 return EEVT::TypeSet(MVT::Other, TP);
1394 // With a name, the ValueType simply provides the type of the named
1397 // (sext_inreg i32:$src, i16)
1400 return EEVT::TypeSet(); // Unknown.
1401 return EEVT::TypeSet(getValueType(R), TP);
1404 if (R->isSubClassOf("CondCode")) {
1405 assert(ResNo == 0 && "This node only has one result!");
1406 // Using a CondCodeSDNode.
1407 return EEVT::TypeSet(MVT::Other, TP);
1410 if (R->isSubClassOf("ComplexPattern")) {
1411 assert(ResNo == 0 && "FIXME: ComplexPattern with multiple results?");
1413 return EEVT::TypeSet(); // Unknown.
1414 return EEVT::TypeSet(TP.getDAGPatterns().getComplexPattern(R).getValueType(),
1417 if (R->isSubClassOf("PointerLikeRegClass")) {
1418 assert(ResNo == 0 && "Regclass can only have one result!");
1419 return EEVT::TypeSet(MVT::iPTR, TP);
1422 if (R->getName() == "node" || R->getName() == "srcvalue" ||
1423 R->getName() == "zero_reg") {
1425 return EEVT::TypeSet(); // Unknown.
1428 TP.error("Unknown node flavor used in pattern: " + R->getName());
1429 return EEVT::TypeSet(MVT::Other, TP);
1433 /// getIntrinsicInfo - If this node corresponds to an intrinsic, return the
1434 /// CodeGenIntrinsic information for it, otherwise return a null pointer.
1435 const CodeGenIntrinsic *TreePatternNode::
1436 getIntrinsicInfo(const CodeGenDAGPatterns &CDP) const {
1437 if (getOperator() != CDP.get_intrinsic_void_sdnode() &&
1438 getOperator() != CDP.get_intrinsic_w_chain_sdnode() &&
1439 getOperator() != CDP.get_intrinsic_wo_chain_sdnode())
1442 unsigned IID = cast<IntInit>(getChild(0)->getLeafValue())->getValue();
1443 return &CDP.getIntrinsicInfo(IID);
1446 /// getComplexPatternInfo - If this node corresponds to a ComplexPattern,
1447 /// return the ComplexPattern information, otherwise return null.
1448 const ComplexPattern *
1449 TreePatternNode::getComplexPatternInfo(const CodeGenDAGPatterns &CGP) const {
1450 if (!isLeaf()) return nullptr;
1452 DefInit *DI = dyn_cast<DefInit>(getLeafValue());
1453 if (DI && DI->getDef()->isSubClassOf("ComplexPattern"))
1454 return &CGP.getComplexPattern(DI->getDef());
1458 /// NodeHasProperty - Return true if this node has the specified property.
1459 bool TreePatternNode::NodeHasProperty(SDNP Property,
1460 const CodeGenDAGPatterns &CGP) const {
1462 if (const ComplexPattern *CP = getComplexPatternInfo(CGP))
1463 return CP->hasProperty(Property);
1467 Record *Operator = getOperator();
1468 if (!Operator->isSubClassOf("SDNode")) return false;
1470 return CGP.getSDNodeInfo(Operator).hasProperty(Property);
1476 /// TreeHasProperty - Return true if any node in this tree has the specified
1478 bool TreePatternNode::TreeHasProperty(SDNP Property,
1479 const CodeGenDAGPatterns &CGP) const {
1480 if (NodeHasProperty(Property, CGP))
1482 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1483 if (getChild(i)->TreeHasProperty(Property, CGP))
1488 /// isCommutativeIntrinsic - Return true if the node corresponds to a
1489 /// commutative intrinsic.
1491 TreePatternNode::isCommutativeIntrinsic(const CodeGenDAGPatterns &CDP) const {
1492 if (const CodeGenIntrinsic *Int = getIntrinsicInfo(CDP))
1493 return Int->isCommutative;
1498 /// ApplyTypeConstraints - Apply all of the type constraints relevant to
1499 /// this node and its children in the tree. This returns true if it makes a
1500 /// change, false otherwise. If a type contradiction is found, flag an error.
1501 bool TreePatternNode::ApplyTypeConstraints(TreePattern &TP, bool NotRegisters) {
1505 CodeGenDAGPatterns &CDP = TP.getDAGPatterns();
1507 if (DefInit *DI = dyn_cast<DefInit>(getLeafValue())) {
1508 // If it's a regclass or something else known, include the type.
1509 bool MadeChange = false;
1510 for (unsigned i = 0, e = Types.size(); i != e; ++i)
1511 MadeChange |= UpdateNodeType(i, getImplicitType(DI->getDef(), i,
1513 !hasName(), TP), TP);
1517 if (IntInit *II = dyn_cast<IntInit>(getLeafValue())) {
1518 assert(Types.size() == 1 && "Invalid IntInit");
1520 // Int inits are always integers. :)
1521 bool MadeChange = Types[0].EnforceInteger(TP);
1523 if (!Types[0].isConcrete())
1526 MVT::SimpleValueType VT = getType(0);
1527 if (VT == MVT::iPTR || VT == MVT::iPTRAny)
1530 unsigned Size = MVT(VT).getSizeInBits();
1531 // Make sure that the value is representable for this type.
1532 if (Size >= 32) return MadeChange;
1534 // Check that the value doesn't use more bits than we have. It must either
1535 // be a sign- or zero-extended equivalent of the original.
1536 int64_t SignBitAndAbove = II->getValue() >> (Size - 1);
1537 if (SignBitAndAbove == -1 || SignBitAndAbove == 0 || SignBitAndAbove == 1)
1540 TP.error("Integer value '" + itostr(II->getValue()) +
1541 "' is out of range for type '" + getEnumName(getType(0)) + "'!");
1547 // special handling for set, which isn't really an SDNode.
1548 if (getOperator()->getName() == "set") {
1549 assert(getNumTypes() == 0 && "Set doesn't produce a value");
1550 assert(getNumChildren() >= 2 && "Missing RHS of a set?");
1551 unsigned NC = getNumChildren();
1553 TreePatternNode *SetVal = getChild(NC-1);
1554 bool MadeChange = SetVal->ApplyTypeConstraints(TP, NotRegisters);
1556 for (unsigned i = 0; i < NC-1; ++i) {
1557 TreePatternNode *Child = getChild(i);
1558 MadeChange |= Child->ApplyTypeConstraints(TP, NotRegisters);
1560 // Types of operands must match.
1561 MadeChange |= Child->UpdateNodeType(0, SetVal->getExtType(i), TP);
1562 MadeChange |= SetVal->UpdateNodeType(i, Child->getExtType(0), TP);
1567 if (getOperator()->getName() == "implicit") {
1568 assert(getNumTypes() == 0 && "Node doesn't produce a value");
1570 bool MadeChange = false;
1571 for (unsigned i = 0; i < getNumChildren(); ++i)
1572 MadeChange = getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
1576 if (const CodeGenIntrinsic *Int = getIntrinsicInfo(CDP)) {
1577 bool MadeChange = false;
1579 // Apply the result type to the node.
1580 unsigned NumRetVTs = Int->IS.RetVTs.size();
1581 unsigned NumParamVTs = Int->IS.ParamVTs.size();
1583 for (unsigned i = 0, e = NumRetVTs; i != e; ++i)
1584 MadeChange |= UpdateNodeType(i, Int->IS.RetVTs[i], TP);
1586 if (getNumChildren() != NumParamVTs + 1) {
1587 TP.error("Intrinsic '" + Int->Name + "' expects " +
1588 utostr(NumParamVTs) + " operands, not " +
1589 utostr(getNumChildren() - 1) + " operands!");
1593 // Apply type info to the intrinsic ID.
1594 MadeChange |= getChild(0)->UpdateNodeType(0, MVT::iPTR, TP);
1596 for (unsigned i = 0, e = getNumChildren()-1; i != e; ++i) {
1597 MadeChange |= getChild(i+1)->ApplyTypeConstraints(TP, NotRegisters);
1599 MVT::SimpleValueType OpVT = Int->IS.ParamVTs[i];
1600 assert(getChild(i+1)->getNumTypes() == 1 && "Unhandled case");
1601 MadeChange |= getChild(i+1)->UpdateNodeType(0, OpVT, TP);
1606 if (getOperator()->isSubClassOf("SDNode")) {
1607 const SDNodeInfo &NI = CDP.getSDNodeInfo(getOperator());
1609 // Check that the number of operands is sane. Negative operands -> varargs.
1610 if (NI.getNumOperands() >= 0 &&
1611 getNumChildren() != (unsigned)NI.getNumOperands()) {
1612 TP.error(getOperator()->getName() + " node requires exactly " +
1613 itostr(NI.getNumOperands()) + " operands!");
1617 bool MadeChange = NI.ApplyTypeConstraints(this, TP);
1618 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1619 MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
1623 if (getOperator()->isSubClassOf("Instruction")) {
1624 const DAGInstruction &Inst = CDP.getInstruction(getOperator());
1625 CodeGenInstruction &InstInfo =
1626 CDP.getTargetInfo().getInstruction(getOperator());
1628 bool MadeChange = false;
1630 // Apply the result types to the node, these come from the things in the
1631 // (outs) list of the instruction.
1632 // FIXME: Cap at one result so far.
1633 unsigned NumResultsToAdd = InstInfo.Operands.NumDefs ? 1 : 0;
1634 for (unsigned ResNo = 0; ResNo != NumResultsToAdd; ++ResNo)
1635 MadeChange |= UpdateNodeTypeFromInst(ResNo, Inst.getResult(ResNo), TP);
1637 // If the instruction has implicit defs, we apply the first one as a result.
1638 // FIXME: This sucks, it should apply all implicit defs.
1639 if (!InstInfo.ImplicitDefs.empty()) {
1640 unsigned ResNo = NumResultsToAdd;
1642 // FIXME: Generalize to multiple possible types and multiple possible
1644 MVT::SimpleValueType VT =
1645 InstInfo.HasOneImplicitDefWithKnownVT(CDP.getTargetInfo());
1647 if (VT != MVT::Other)
1648 MadeChange |= UpdateNodeType(ResNo, VT, TP);
1651 // If this is an INSERT_SUBREG, constrain the source and destination VTs to
1653 if (getOperator()->getName() == "INSERT_SUBREG") {
1654 assert(getChild(0)->getNumTypes() == 1 && "FIXME: Unhandled");
1655 MadeChange |= UpdateNodeType(0, getChild(0)->getExtType(0), TP);
1656 MadeChange |= getChild(0)->UpdateNodeType(0, getExtType(0), TP);
1659 unsigned ChildNo = 0;
1660 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i) {
1661 Record *OperandNode = Inst.getOperand(i);
1663 // If the instruction expects a predicate or optional def operand, we
1664 // codegen this by setting the operand to it's default value if it has a
1665 // non-empty DefaultOps field.
1666 if (OperandNode->isSubClassOf("OperandWithDefaultOps") &&
1667 !CDP.getDefaultOperand(OperandNode).DefaultOps.empty())
1670 // Verify that we didn't run out of provided operands.
1671 if (ChildNo >= getNumChildren()) {
1672 TP.error("Instruction '" + getOperator()->getName() +
1673 "' expects more operands than were provided.");
1677 TreePatternNode *Child = getChild(ChildNo++);
1678 unsigned ChildResNo = 0; // Instructions always use res #0 of their op.
1680 // If the operand has sub-operands, they may be provided by distinct
1681 // child patterns, so attempt to match each sub-operand separately.
1682 if (OperandNode->isSubClassOf("Operand")) {
1683 DagInit *MIOpInfo = OperandNode->getValueAsDag("MIOperandInfo");
1684 if (unsigned NumArgs = MIOpInfo->getNumArgs()) {
1685 // But don't do that if the whole operand is being provided by
1686 // a single ComplexPattern.
1687 const ComplexPattern *AM = Child->getComplexPatternInfo(CDP);
1688 if (!AM || AM->getNumOperands() < NumArgs) {
1689 // Match first sub-operand against the child we already have.
1690 Record *SubRec = cast<DefInit>(MIOpInfo->getArg(0))->getDef();
1692 Child->UpdateNodeTypeFromInst(ChildResNo, SubRec, TP);
1694 // And the remaining sub-operands against subsequent children.
1695 for (unsigned Arg = 1; Arg < NumArgs; ++Arg) {
1696 if (ChildNo >= getNumChildren()) {
1697 TP.error("Instruction '" + getOperator()->getName() +
1698 "' expects more operands than were provided.");
1701 Child = getChild(ChildNo++);
1703 SubRec = cast<DefInit>(MIOpInfo->getArg(Arg))->getDef();
1705 Child->UpdateNodeTypeFromInst(ChildResNo, SubRec, TP);
1712 // If we didn't match by pieces above, attempt to match the whole
1714 MadeChange |= Child->UpdateNodeTypeFromInst(ChildResNo, OperandNode, TP);
1717 if (ChildNo != getNumChildren()) {
1718 TP.error("Instruction '" + getOperator()->getName() +
1719 "' was provided too many operands!");
1723 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1724 MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
1728 assert(getOperator()->isSubClassOf("SDNodeXForm") && "Unknown node type!");
1730 // Node transforms always take one operand.
1731 if (getNumChildren() != 1) {
1732 TP.error("Node transform '" + getOperator()->getName() +
1733 "' requires one operand!");
1737 bool MadeChange = getChild(0)->ApplyTypeConstraints(TP, NotRegisters);
1740 // If either the output or input of the xform does not have exact
1741 // type info. We assume they must be the same. Otherwise, it is perfectly
1742 // legal to transform from one type to a completely different type.
1744 if (!hasTypeSet() || !getChild(0)->hasTypeSet()) {
1745 bool MadeChange = UpdateNodeType(getChild(0)->getExtType(), TP);
1746 MadeChange |= getChild(0)->UpdateNodeType(getExtType(), TP);
1753 /// OnlyOnRHSOfCommutative - Return true if this value is only allowed on the
1754 /// RHS of a commutative operation, not the on LHS.
1755 static bool OnlyOnRHSOfCommutative(TreePatternNode *N) {
1756 if (!N->isLeaf() && N->getOperator()->getName() == "imm")
1758 if (N->isLeaf() && isa<IntInit>(N->getLeafValue()))
1764 /// canPatternMatch - If it is impossible for this pattern to match on this
1765 /// target, fill in Reason and return false. Otherwise, return true. This is
1766 /// used as a sanity check for .td files (to prevent people from writing stuff
1767 /// that can never possibly work), and to prevent the pattern permuter from
1768 /// generating stuff that is useless.
1769 bool TreePatternNode::canPatternMatch(std::string &Reason,
1770 const CodeGenDAGPatterns &CDP) {
1771 if (isLeaf()) return true;
1773 for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1774 if (!getChild(i)->canPatternMatch(Reason, CDP))
1777 // If this is an intrinsic, handle cases that would make it not match. For
1778 // example, if an operand is required to be an immediate.
1779 if (getOperator()->isSubClassOf("Intrinsic")) {
1784 // If this node is a commutative operator, check that the LHS isn't an
1786 const SDNodeInfo &NodeInfo = CDP.getSDNodeInfo(getOperator());
1787 bool isCommIntrinsic = isCommutativeIntrinsic(CDP);
1788 if (NodeInfo.hasProperty(SDNPCommutative) || isCommIntrinsic) {
1789 // Scan all of the operands of the node and make sure that only the last one
1790 // is a constant node, unless the RHS also is.
1791 if (!OnlyOnRHSOfCommutative(getChild(getNumChildren()-1))) {
1792 bool Skip = isCommIntrinsic ? 1 : 0; // First operand is intrinsic id.
1793 for (unsigned i = Skip, e = getNumChildren()-1; i != e; ++i)
1794 if (OnlyOnRHSOfCommutative(getChild(i))) {
1795 Reason="Immediate value must be on the RHS of commutative operators!";
1804 //===----------------------------------------------------------------------===//
1805 // TreePattern implementation
1808 TreePattern::TreePattern(Record *TheRec, ListInit *RawPat, bool isInput,
1809 CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp),
1810 isInputPattern(isInput), HasError(false) {
1811 for (unsigned i = 0, e = RawPat->getSize(); i != e; ++i)
1812 Trees.push_back(ParseTreePattern(RawPat->getElement(i), ""));
1815 TreePattern::TreePattern(Record *TheRec, DagInit *Pat, bool isInput,
1816 CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp),
1817 isInputPattern(isInput), HasError(false) {
1818 Trees.push_back(ParseTreePattern(Pat, ""));
1821 TreePattern::TreePattern(Record *TheRec, TreePatternNode *Pat, bool isInput,
1822 CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp),
1823 isInputPattern(isInput), HasError(false) {
1824 Trees.push_back(Pat);
1827 void TreePattern::error(const std::string &Msg) {
1831 PrintError(TheRecord->getLoc(), "In " + TheRecord->getName() + ": " + Msg);
1835 void TreePattern::ComputeNamedNodes() {
1836 for (unsigned i = 0, e = Trees.size(); i != e; ++i)
1837 ComputeNamedNodes(Trees[i]);
1840 void TreePattern::ComputeNamedNodes(TreePatternNode *N) {
1841 if (!N->getName().empty())
1842 NamedNodes[N->getName()].push_back(N);
1844 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
1845 ComputeNamedNodes(N->getChild(i));
1849 TreePatternNode *TreePattern::ParseTreePattern(Init *TheInit, StringRef OpName){
1850 if (DefInit *DI = dyn_cast<DefInit>(TheInit)) {
1851 Record *R = DI->getDef();
1853 // Direct reference to a leaf DagNode or PatFrag? Turn it into a
1854 // TreePatternNode of its own. For example:
1855 /// (foo GPR, imm) -> (foo GPR, (imm))
1856 if (R->isSubClassOf("SDNode") || R->isSubClassOf("PatFrag"))
1857 return ParseTreePattern(
1858 DagInit::get(DI, "",
1859 std::vector<std::pair<Init*, std::string> >()),
1863 TreePatternNode *Res = new TreePatternNode(DI, 1);
1864 if (R->getName() == "node" && !OpName.empty()) {
1866 error("'node' argument requires a name to match with operand list");
1867 Args.push_back(OpName);
1870 Res->setName(OpName);
1874 // ?:$name or just $name.
1875 if (TheInit == UnsetInit::get()) {
1877 error("'?' argument requires a name to match with operand list");
1878 TreePatternNode *Res = new TreePatternNode(TheInit, 1);
1879 Args.push_back(OpName);
1880 Res->setName(OpName);
1884 if (IntInit *II = dyn_cast<IntInit>(TheInit)) {
1885 if (!OpName.empty())
1886 error("Constant int argument should not have a name!");
1887 return new TreePatternNode(II, 1);
1890 if (BitsInit *BI = dyn_cast<BitsInit>(TheInit)) {
1891 // Turn this into an IntInit.
1892 Init *II = BI->convertInitializerTo(IntRecTy::get());
1893 if (!II || !isa<IntInit>(II))
1894 error("Bits value must be constants!");
1895 return ParseTreePattern(II, OpName);
1898 DagInit *Dag = dyn_cast<DagInit>(TheInit);
1901 error("Pattern has unexpected init kind!");
1903 DefInit *OpDef = dyn_cast<DefInit>(Dag->getOperator());
1904 if (!OpDef) error("Pattern has unexpected operator type!");
1905 Record *Operator = OpDef->getDef();
1907 if (Operator->isSubClassOf("ValueType")) {
1908 // If the operator is a ValueType, then this must be "type cast" of a leaf
1910 if (Dag->getNumArgs() != 1)
1911 error("Type cast only takes one operand!");
1913 TreePatternNode *New = ParseTreePattern(Dag->getArg(0), Dag->getArgName(0));
1915 // Apply the type cast.
1916 assert(New->getNumTypes() == 1 && "FIXME: Unhandled");
1917 New->UpdateNodeType(0, getValueType(Operator), *this);
1919 if (!OpName.empty())
1920 error("ValueType cast should not have a name!");
1924 // Verify that this is something that makes sense for an operator.
1925 if (!Operator->isSubClassOf("PatFrag") &&
1926 !Operator->isSubClassOf("SDNode") &&
1927 !Operator->isSubClassOf("Instruction") &&
1928 !Operator->isSubClassOf("SDNodeXForm") &&
1929 !Operator->isSubClassOf("Intrinsic") &&
1930 Operator->getName() != "set" &&
1931 Operator->getName() != "implicit")
1932 error("Unrecognized node '" + Operator->getName() + "'!");
1934 // Check to see if this is something that is illegal in an input pattern.
1935 if (isInputPattern) {
1936 if (Operator->isSubClassOf("Instruction") ||
1937 Operator->isSubClassOf("SDNodeXForm"))
1938 error("Cannot use '" + Operator->getName() + "' in an input pattern!");
1940 if (Operator->isSubClassOf("Intrinsic"))
1941 error("Cannot use '" + Operator->getName() + "' in an output pattern!");
1943 if (Operator->isSubClassOf("SDNode") &&
1944 Operator->getName() != "imm" &&
1945 Operator->getName() != "fpimm" &&
1946 Operator->getName() != "tglobaltlsaddr" &&
1947 Operator->getName() != "tconstpool" &&
1948 Operator->getName() != "tjumptable" &&
1949 Operator->getName() != "tframeindex" &&
1950 Operator->getName() != "texternalsym" &&
1951 Operator->getName() != "tblockaddress" &&
1952 Operator->getName() != "tglobaladdr" &&
1953 Operator->getName() != "bb" &&
1954 Operator->getName() != "vt")
1955 error("Cannot use '" + Operator->getName() + "' in an output pattern!");
1958 std::vector<TreePatternNode*> Children;
1960 // Parse all the operands.
1961 for (unsigned i = 0, e = Dag->getNumArgs(); i != e; ++i)
1962 Children.push_back(ParseTreePattern(Dag->getArg(i), Dag->getArgName(i)));
1964 // If the operator is an intrinsic, then this is just syntactic sugar for for
1965 // (intrinsic_* <number>, ..children..). Pick the right intrinsic node, and
1966 // convert the intrinsic name to a number.
1967 if (Operator->isSubClassOf("Intrinsic")) {
1968 const CodeGenIntrinsic &Int = getDAGPatterns().getIntrinsic(Operator);
1969 unsigned IID = getDAGPatterns().getIntrinsicID(Operator)+1;
1971 // If this intrinsic returns void, it must have side-effects and thus a
1973 if (Int.IS.RetVTs.empty())
1974 Operator = getDAGPatterns().get_intrinsic_void_sdnode();
1975 else if (Int.ModRef != CodeGenIntrinsic::NoMem)
1976 // Has side-effects, requires chain.
1977 Operator = getDAGPatterns().get_intrinsic_w_chain_sdnode();
1978 else // Otherwise, no chain.
1979 Operator = getDAGPatterns().get_intrinsic_wo_chain_sdnode();
1981 TreePatternNode *IIDNode = new TreePatternNode(IntInit::get(IID), 1);
1982 Children.insert(Children.begin(), IIDNode);
1985 unsigned NumResults = GetNumNodeResults(Operator, CDP);
1986 TreePatternNode *Result = new TreePatternNode(Operator, Children, NumResults);
1987 Result->setName(OpName);
1989 if (!Dag->getName().empty()) {
1990 assert(Result->getName().empty());
1991 Result->setName(Dag->getName());
1996 /// SimplifyTree - See if we can simplify this tree to eliminate something that
1997 /// will never match in favor of something obvious that will. This is here
1998 /// strictly as a convenience to target authors because it allows them to write
1999 /// more type generic things and have useless type casts fold away.
2001 /// This returns true if any change is made.
2002 static bool SimplifyTree(TreePatternNode *&N) {
2006 // If we have a bitconvert with a resolved type and if the source and
2007 // destination types are the same, then the bitconvert is useless, remove it.
2008 if (N->getOperator()->getName() == "bitconvert" &&
2009 N->getExtType(0).isConcrete() &&
2010 N->getExtType(0) == N->getChild(0)->getExtType(0) &&
2011 N->getName().empty()) {
2017 // Walk all children.
2018 bool MadeChange = false;
2019 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i) {
2020 TreePatternNode *Child = N->getChild(i);
2021 MadeChange |= SimplifyTree(Child);
2022 N->setChild(i, Child);
2029 /// InferAllTypes - Infer/propagate as many types throughout the expression
2030 /// patterns as possible. Return true if all types are inferred, false
2031 /// otherwise. Flags an error if a type contradiction is found.
2033 InferAllTypes(const StringMap<SmallVector<TreePatternNode*,1> > *InNamedTypes) {
2034 if (NamedNodes.empty())
2035 ComputeNamedNodes();
2037 bool MadeChange = true;
2038 while (MadeChange) {
2040 for (unsigned i = 0, e = Trees.size(); i != e; ++i) {
2041 MadeChange |= Trees[i]->ApplyTypeConstraints(*this, false);
2042 MadeChange |= SimplifyTree(Trees[i]);
2045 // If there are constraints on our named nodes, apply them.
2046 for (StringMap<SmallVector<TreePatternNode*,1> >::iterator
2047 I = NamedNodes.begin(), E = NamedNodes.end(); I != E; ++I) {
2048 SmallVectorImpl<TreePatternNode*> &Nodes = I->second;
2050 // If we have input named node types, propagate their types to the named
2053 // FIXME: Should be error?
2054 assert(InNamedTypes->count(I->getKey()) &&
2055 "Named node in output pattern but not input pattern?");
2057 const SmallVectorImpl<TreePatternNode*> &InNodes =
2058 InNamedTypes->find(I->getKey())->second;
2060 // The input types should be fully resolved by now.
2061 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2062 // If this node is a register class, and it is the root of the pattern
2063 // then we're mapping something onto an input register. We allow
2064 // changing the type of the input register in this case. This allows
2065 // us to match things like:
2066 // def : Pat<(v1i64 (bitconvert(v2i32 DPR:$src))), (v1i64 DPR:$src)>;
2067 if (Nodes[i] == Trees[0] && Nodes[i]->isLeaf()) {
2068 DefInit *DI = dyn_cast<DefInit>(Nodes[i]->getLeafValue());
2069 if (DI && (DI->getDef()->isSubClassOf("RegisterClass") ||
2070 DI->getDef()->isSubClassOf("RegisterOperand")))
2074 assert(Nodes[i]->getNumTypes() == 1 &&
2075 InNodes[0]->getNumTypes() == 1 &&
2076 "FIXME: cannot name multiple result nodes yet");
2077 MadeChange |= Nodes[i]->UpdateNodeType(0, InNodes[0]->getExtType(0),
2082 // If there are multiple nodes with the same name, they must all have the
2084 if (I->second.size() > 1) {
2085 for (unsigned i = 0, e = Nodes.size()-1; i != e; ++i) {
2086 TreePatternNode *N1 = Nodes[i], *N2 = Nodes[i+1];
2087 assert(N1->getNumTypes() == 1 && N2->getNumTypes() == 1 &&
2088 "FIXME: cannot name multiple result nodes yet");
2090 MadeChange |= N1->UpdateNodeType(0, N2->getExtType(0), *this);
2091 MadeChange |= N2->UpdateNodeType(0, N1->getExtType(0), *this);
2097 bool HasUnresolvedTypes = false;
2098 for (unsigned i = 0, e = Trees.size(); i != e; ++i)
2099 HasUnresolvedTypes |= Trees[i]->ContainsUnresolvedType();
2100 return !HasUnresolvedTypes;
2103 void TreePattern::print(raw_ostream &OS) const {
2104 OS << getRecord()->getName();
2105 if (!Args.empty()) {
2106 OS << "(" << Args[0];
2107 for (unsigned i = 1, e = Args.size(); i != e; ++i)
2108 OS << ", " << Args[i];
2113 if (Trees.size() > 1)
2115 for (unsigned i = 0, e = Trees.size(); i != e; ++i) {
2117 Trees[i]->print(OS);
2121 if (Trees.size() > 1)
2125 void TreePattern::dump() const { print(errs()); }
2127 //===----------------------------------------------------------------------===//
2128 // CodeGenDAGPatterns implementation
2131 CodeGenDAGPatterns::CodeGenDAGPatterns(RecordKeeper &R) :
2132 Records(R), Target(R) {
2134 Intrinsics = LoadIntrinsics(Records, false);
2135 TgtIntrinsics = LoadIntrinsics(Records, true);
2137 ParseNodeTransforms();
2138 ParseComplexPatterns();
2139 ParsePatternFragments();
2140 ParseDefaultOperands();
2141 ParseInstructions();
2142 ParsePatternFragments(/*OutFrags*/true);
2145 // Generate variants. For example, commutative patterns can match
2146 // multiple ways. Add them to PatternsToMatch as well.
2149 // Infer instruction flags. For example, we can detect loads,
2150 // stores, and side effects in many cases by examining an
2151 // instruction's pattern.
2152 InferInstructionFlags();
2154 // Verify that instruction flags match the patterns.
2155 VerifyInstructionFlags();
2158 CodeGenDAGPatterns::~CodeGenDAGPatterns() {
2159 for (pf_iterator I = PatternFragments.begin(),
2160 E = PatternFragments.end(); I != E; ++I)
2165 Record *CodeGenDAGPatterns::getSDNodeNamed(const std::string &Name) const {
2166 Record *N = Records.getDef(Name);
2167 if (!N || !N->isSubClassOf("SDNode")) {
2168 errs() << "Error getting SDNode '" << Name << "'!\n";
2174 // Parse all of the SDNode definitions for the target, populating SDNodes.
2175 void CodeGenDAGPatterns::ParseNodeInfo() {
2176 std::vector<Record*> Nodes = Records.getAllDerivedDefinitions("SDNode");
2177 while (!Nodes.empty()) {
2178 SDNodes.insert(std::make_pair(Nodes.back(), Nodes.back()));
2182 // Get the builtin intrinsic nodes.
2183 intrinsic_void_sdnode = getSDNodeNamed("intrinsic_void");
2184 intrinsic_w_chain_sdnode = getSDNodeNamed("intrinsic_w_chain");
2185 intrinsic_wo_chain_sdnode = getSDNodeNamed("intrinsic_wo_chain");
2188 /// ParseNodeTransforms - Parse all SDNodeXForm instances into the SDNodeXForms
2189 /// map, and emit them to the file as functions.
2190 void CodeGenDAGPatterns::ParseNodeTransforms() {
2191 std::vector<Record*> Xforms = Records.getAllDerivedDefinitions("SDNodeXForm");
2192 while (!Xforms.empty()) {
2193 Record *XFormNode = Xforms.back();
2194 Record *SDNode = XFormNode->getValueAsDef("Opcode");
2195 std::string Code = XFormNode->getValueAsString("XFormFunction");
2196 SDNodeXForms.insert(std::make_pair(XFormNode, NodeXForm(SDNode, Code)));
2202 void CodeGenDAGPatterns::ParseComplexPatterns() {
2203 std::vector<Record*> AMs = Records.getAllDerivedDefinitions("ComplexPattern");
2204 while (!AMs.empty()) {
2205 ComplexPatterns.insert(std::make_pair(AMs.back(), AMs.back()));
2211 /// ParsePatternFragments - Parse all of the PatFrag definitions in the .td
2212 /// file, building up the PatternFragments map. After we've collected them all,
2213 /// inline fragments together as necessary, so that there are no references left
2214 /// inside a pattern fragment to a pattern fragment.
2216 void CodeGenDAGPatterns::ParsePatternFragments(bool OutFrags) {
2217 std::vector<Record*> Fragments = Records.getAllDerivedDefinitions("PatFrag");
2219 // First step, parse all of the fragments.
2220 for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
2221 if (OutFrags != Fragments[i]->isSubClassOf("OutPatFrag"))
2224 DagInit *Tree = Fragments[i]->getValueAsDag("Fragment");
2226 new TreePattern(Fragments[i], Tree,
2227 !Fragments[i]->isSubClassOf("OutPatFrag"), *this);
2228 PatternFragments[Fragments[i]] = P;
2230 // Validate the argument list, converting it to set, to discard duplicates.
2231 std::vector<std::string> &Args = P->getArgList();
2232 std::set<std::string> OperandsSet(Args.begin(), Args.end());
2234 if (OperandsSet.count(""))
2235 P->error("Cannot have unnamed 'node' values in pattern fragment!");
2237 // Parse the operands list.
2238 DagInit *OpsList = Fragments[i]->getValueAsDag("Operands");
2239 DefInit *OpsOp = dyn_cast<DefInit>(OpsList->getOperator());
2240 // Special cases: ops == outs == ins. Different names are used to
2241 // improve readability.
2243 (OpsOp->getDef()->getName() != "ops" &&
2244 OpsOp->getDef()->getName() != "outs" &&
2245 OpsOp->getDef()->getName() != "ins"))
2246 P->error("Operands list should start with '(ops ... '!");
2248 // Copy over the arguments.
2250 for (unsigned j = 0, e = OpsList->getNumArgs(); j != e; ++j) {
2251 if (!isa<DefInit>(OpsList->getArg(j)) ||
2252 cast<DefInit>(OpsList->getArg(j))->getDef()->getName() != "node")
2253 P->error("Operands list should all be 'node' values.");
2254 if (OpsList->getArgName(j).empty())
2255 P->error("Operands list should have names for each operand!");
2256 if (!OperandsSet.count(OpsList->getArgName(j)))
2257 P->error("'" + OpsList->getArgName(j) +
2258 "' does not occur in pattern or was multiply specified!");
2259 OperandsSet.erase(OpsList->getArgName(j));
2260 Args.push_back(OpsList->getArgName(j));
2263 if (!OperandsSet.empty())
2264 P->error("Operands list does not contain an entry for operand '" +
2265 *OperandsSet.begin() + "'!");
2267 // If there is a code init for this fragment, keep track of the fact that
2268 // this fragment uses it.
2269 TreePredicateFn PredFn(P);
2270 if (!PredFn.isAlwaysTrue())
2271 P->getOnlyTree()->addPredicateFn(PredFn);
2273 // If there is a node transformation corresponding to this, keep track of
2275 Record *Transform = Fragments[i]->getValueAsDef("OperandTransform");
2276 if (!getSDNodeTransform(Transform).second.empty()) // not noop xform?
2277 P->getOnlyTree()->setTransformFn(Transform);
2280 // Now that we've parsed all of the tree fragments, do a closure on them so
2281 // that there are not references to PatFrags left inside of them.
2282 for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
2283 if (OutFrags != Fragments[i]->isSubClassOf("OutPatFrag"))
2286 TreePattern *ThePat = PatternFragments[Fragments[i]];
2287 ThePat->InlinePatternFragments();
2289 // Infer as many types as possible. Don't worry about it if we don't infer
2290 // all of them, some may depend on the inputs of the pattern.
2291 ThePat->InferAllTypes();
2292 ThePat->resetError();
2294 // If debugging, print out the pattern fragment result.
2295 DEBUG(ThePat->dump());
2299 void CodeGenDAGPatterns::ParseDefaultOperands() {
2300 std::vector<Record*> DefaultOps;
2301 DefaultOps = Records.getAllDerivedDefinitions("OperandWithDefaultOps");
2303 // Find some SDNode.
2304 assert(!SDNodes.empty() && "No SDNodes parsed?");
2305 Init *SomeSDNode = DefInit::get(SDNodes.begin()->first);
2307 for (unsigned i = 0, e = DefaultOps.size(); i != e; ++i) {
2308 DagInit *DefaultInfo = DefaultOps[i]->getValueAsDag("DefaultOps");
2310 // Clone the DefaultInfo dag node, changing the operator from 'ops' to
2311 // SomeSDnode so that we can parse this.
2312 std::vector<std::pair<Init*, std::string> > Ops;
2313 for (unsigned op = 0, e = DefaultInfo->getNumArgs(); op != e; ++op)
2314 Ops.push_back(std::make_pair(DefaultInfo->getArg(op),
2315 DefaultInfo->getArgName(op)));
2316 DagInit *DI = DagInit::get(SomeSDNode, "", Ops);
2318 // Create a TreePattern to parse this.
2319 TreePattern P(DefaultOps[i], DI, false, *this);
2320 assert(P.getNumTrees() == 1 && "This ctor can only produce one tree!");
2322 // Copy the operands over into a DAGDefaultOperand.
2323 DAGDefaultOperand DefaultOpInfo;
2325 TreePatternNode *T = P.getTree(0);
2326 for (unsigned op = 0, e = T->getNumChildren(); op != e; ++op) {
2327 TreePatternNode *TPN = T->getChild(op);
2328 while (TPN->ApplyTypeConstraints(P, false))
2329 /* Resolve all types */;
2331 if (TPN->ContainsUnresolvedType()) {
2332 PrintFatalError("Value #" + Twine(i) + " of OperandWithDefaultOps '" +
2333 DefaultOps[i]->getName() +
2334 "' doesn't have a concrete type!");
2336 DefaultOpInfo.DefaultOps.push_back(TPN);
2339 // Insert it into the DefaultOperands map so we can find it later.
2340 DefaultOperands[DefaultOps[i]] = DefaultOpInfo;
2344 /// HandleUse - Given "Pat" a leaf in the pattern, check to see if it is an
2345 /// instruction input. Return true if this is a real use.
2346 static bool HandleUse(TreePattern *I, TreePatternNode *Pat,
2347 std::map<std::string, TreePatternNode*> &InstInputs) {
2348 // No name -> not interesting.
2349 if (Pat->getName().empty()) {
2350 if (Pat->isLeaf()) {
2351 DefInit *DI = dyn_cast<DefInit>(Pat->getLeafValue());
2352 if (DI && (DI->getDef()->isSubClassOf("RegisterClass") ||
2353 DI->getDef()->isSubClassOf("RegisterOperand")))
2354 I->error("Input " + DI->getDef()->getName() + " must be named!");
2360 if (Pat->isLeaf()) {
2361 DefInit *DI = dyn_cast<DefInit>(Pat->getLeafValue());
2362 if (!DI) I->error("Input $" + Pat->getName() + " must be an identifier!");
2365 Rec = Pat->getOperator();
2368 // SRCVALUE nodes are ignored.
2369 if (Rec->getName() == "srcvalue")
2372 TreePatternNode *&Slot = InstInputs[Pat->getName()];
2378 if (Slot->isLeaf()) {
2379 SlotRec = cast<DefInit>(Slot->getLeafValue())->getDef();
2381 assert(Slot->getNumChildren() == 0 && "can't be a use with children!");
2382 SlotRec = Slot->getOperator();
2385 // Ensure that the inputs agree if we've already seen this input.
2387 I->error("All $" + Pat->getName() + " inputs must agree with each other");
2388 if (Slot->getExtTypes() != Pat->getExtTypes())
2389 I->error("All $" + Pat->getName() + " inputs must agree with each other");
2393 /// FindPatternInputsAndOutputs - Scan the specified TreePatternNode (which is
2394 /// part of "I", the instruction), computing the set of inputs and outputs of
2395 /// the pattern. Report errors if we see anything naughty.
2396 void CodeGenDAGPatterns::
2397 FindPatternInputsAndOutputs(TreePattern *I, TreePatternNode *Pat,
2398 std::map<std::string, TreePatternNode*> &InstInputs,
2399 std::map<std::string, TreePatternNode*>&InstResults,
2400 std::vector<Record*> &InstImpResults) {
2401 if (Pat->isLeaf()) {
2402 bool isUse = HandleUse(I, Pat, InstInputs);
2403 if (!isUse && Pat->getTransformFn())
2404 I->error("Cannot specify a transform function for a non-input value!");
2408 if (Pat->getOperator()->getName() == "implicit") {
2409 for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
2410 TreePatternNode *Dest = Pat->getChild(i);
2411 if (!Dest->isLeaf())
2412 I->error("implicitly defined value should be a register!");
2414 DefInit *Val = dyn_cast<DefInit>(Dest->getLeafValue());
2415 if (!Val || !Val->getDef()->isSubClassOf("Register"))
2416 I->error("implicitly defined value should be a register!");
2417 InstImpResults.push_back(Val->getDef());
2422 if (Pat->getOperator()->getName() != "set") {
2423 // If this is not a set, verify that the children nodes are not void typed,
2425 for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
2426 if (Pat->getChild(i)->getNumTypes() == 0)
2427 I->error("Cannot have void nodes inside of patterns!");
2428 FindPatternInputsAndOutputs(I, Pat->getChild(i), InstInputs, InstResults,
2432 // If this is a non-leaf node with no children, treat it basically as if
2433 // it were a leaf. This handles nodes like (imm).
2434 bool isUse = HandleUse(I, Pat, InstInputs);
2436 if (!isUse && Pat->getTransformFn())
2437 I->error("Cannot specify a transform function for a non-input value!");
2441 // Otherwise, this is a set, validate and collect instruction results.
2442 if (Pat->getNumChildren() == 0)
2443 I->error("set requires operands!");
2445 if (Pat->getTransformFn())
2446 I->error("Cannot specify a transform function on a set node!");
2448 // Check the set destinations.
2449 unsigned NumDests = Pat->getNumChildren()-1;
2450 for (unsigned i = 0; i != NumDests; ++i) {
2451 TreePatternNode *Dest = Pat->getChild(i);
2452 if (!Dest->isLeaf())
2453 I->error("set destination should be a register!");
2455 DefInit *Val = dyn_cast<DefInit>(Dest->getLeafValue());
2457 I->error("set destination should be a register!");
2459 if (Val->getDef()->isSubClassOf("RegisterClass") ||
2460 Val->getDef()->isSubClassOf("ValueType") ||
2461 Val->getDef()->isSubClassOf("RegisterOperand") ||
2462 Val->getDef()->isSubClassOf("PointerLikeRegClass")) {
2463 if (Dest->getName().empty())
2464 I->error("set destination must have a name!");
2465 if (InstResults.count(Dest->getName()))
2466 I->error("cannot set '" + Dest->getName() +"' multiple times");
2467 InstResults[Dest->getName()] = Dest;
2468 } else if (Val->getDef()->isSubClassOf("Register")) {
2469 InstImpResults.push_back(Val->getDef());
2471 I->error("set destination should be a register!");
2475 // Verify and collect info from the computation.
2476 FindPatternInputsAndOutputs(I, Pat->getChild(NumDests),
2477 InstInputs, InstResults, InstImpResults);
2480 //===----------------------------------------------------------------------===//
2481 // Instruction Analysis
2482 //===----------------------------------------------------------------------===//
2484 class InstAnalyzer {
2485 const CodeGenDAGPatterns &CDP;
2487 bool hasSideEffects;
2493 InstAnalyzer(const CodeGenDAGPatterns &cdp)
2494 : CDP(cdp), hasSideEffects(false), mayStore(false), mayLoad(false),
2495 isBitcast(false), isVariadic(false) {}
2497 void Analyze(const TreePattern *Pat) {
2498 // Assume only the first tree is the pattern. The others are clobber nodes.
2499 AnalyzeNode(Pat->getTree(0));
2502 void Analyze(const PatternToMatch *Pat) {
2503 AnalyzeNode(Pat->getSrcPattern());
2507 bool IsNodeBitcast(const TreePatternNode *N) const {
2508 if (hasSideEffects || mayLoad || mayStore || isVariadic)
2511 if (N->getNumChildren() != 2)
2514 const TreePatternNode *N0 = N->getChild(0);
2515 if (!N0->isLeaf() || !isa<DefInit>(N0->getLeafValue()))
2518 const TreePatternNode *N1 = N->getChild(1);
2521 if (N1->getNumChildren() != 1 || !N1->getChild(0)->isLeaf())
2524 const SDNodeInfo &OpInfo = CDP.getSDNodeInfo(N1->getOperator());
2525 if (OpInfo.getNumResults() != 1 || OpInfo.getNumOperands() != 1)
2527 return OpInfo.getEnumName() == "ISD::BITCAST";
2531 void AnalyzeNode(const TreePatternNode *N) {
2533 if (DefInit *DI = dyn_cast<DefInit>(N->getLeafValue())) {
2534 Record *LeafRec = DI->getDef();
2535 // Handle ComplexPattern leaves.
2536 if (LeafRec->isSubClassOf("ComplexPattern")) {
2537 const ComplexPattern &CP = CDP.getComplexPattern(LeafRec);
2538 if (CP.hasProperty(SDNPMayStore)) mayStore = true;
2539 if (CP.hasProperty(SDNPMayLoad)) mayLoad = true;
2540 if (CP.hasProperty(SDNPSideEffect)) hasSideEffects = true;
2546 // Analyze children.
2547 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
2548 AnalyzeNode(N->getChild(i));
2550 // Ignore set nodes, which are not SDNodes.
2551 if (N->getOperator()->getName() == "set") {
2552 isBitcast = IsNodeBitcast(N);
2556 // Get information about the SDNode for the operator.
2557 const SDNodeInfo &OpInfo = CDP.getSDNodeInfo(N->getOperator());
2559 // Notice properties of the node.
2560 if (OpInfo.hasProperty(SDNPMayStore)) mayStore = true;
2561 if (OpInfo.hasProperty(SDNPMayLoad)) mayLoad = true;
2562 if (OpInfo.hasProperty(SDNPSideEffect)) hasSideEffects = true;
2563 if (OpInfo.hasProperty(SDNPVariadic)) isVariadic = true;
2565 if (const CodeGenIntrinsic *IntInfo = N->getIntrinsicInfo(CDP)) {
2566 // If this is an intrinsic, analyze it.
2567 if (IntInfo->ModRef >= CodeGenIntrinsic::ReadArgMem)
2568 mayLoad = true;// These may load memory.
2570 if (IntInfo->ModRef >= CodeGenIntrinsic::ReadWriteArgMem)
2571 mayStore = true;// Intrinsics that can write to memory are 'mayStore'.
2573 if (IntInfo->ModRef >= CodeGenIntrinsic::ReadWriteMem)
2574 // WriteMem intrinsics can have other strange effects.
2575 hasSideEffects = true;
2581 static bool InferFromPattern(CodeGenInstruction &InstInfo,
2582 const InstAnalyzer &PatInfo,
2586 // Remember where InstInfo got its flags.
2587 if (InstInfo.hasUndefFlags())
2588 InstInfo.InferredFrom = PatDef;
2590 // Check explicitly set flags for consistency.
2591 if (InstInfo.hasSideEffects != PatInfo.hasSideEffects &&
2592 !InstInfo.hasSideEffects_Unset) {
2593 // Allow explicitly setting hasSideEffects = 1 on instructions, even when
2594 // the pattern has no side effects. That could be useful for div/rem
2595 // instructions that may trap.
2596 if (!InstInfo.hasSideEffects) {
2598 PrintError(PatDef->getLoc(), "Pattern doesn't match hasSideEffects = " +
2599 Twine(InstInfo.hasSideEffects));
2603 if (InstInfo.mayStore != PatInfo.mayStore && !InstInfo.mayStore_Unset) {
2605 PrintError(PatDef->getLoc(), "Pattern doesn't match mayStore = " +
2606 Twine(InstInfo.mayStore));
2609 if (InstInfo.mayLoad != PatInfo.mayLoad && !InstInfo.mayLoad_Unset) {
2610 // Allow explicitly setting mayLoad = 1, even when the pattern has no loads.
2611 // Some targets translate imediates to loads.
2612 if (!InstInfo.mayLoad) {
2614 PrintError(PatDef->getLoc(), "Pattern doesn't match mayLoad = " +
2615 Twine(InstInfo.mayLoad));
2619 // Transfer inferred flags.
2620 InstInfo.hasSideEffects |= PatInfo.hasSideEffects;
2621 InstInfo.mayStore |= PatInfo.mayStore;
2622 InstInfo.mayLoad |= PatInfo.mayLoad;
2624 // These flags are silently added without any verification.
2625 InstInfo.isBitcast |= PatInfo.isBitcast;
2627 // Don't infer isVariadic. This flag means something different on SDNodes and
2628 // instructions. For example, a CALL SDNode is variadic because it has the
2629 // call arguments as operands, but a CALL instruction is not variadic - it
2630 // has argument registers as implicit, not explicit uses.
2635 /// hasNullFragReference - Return true if the DAG has any reference to the
2636 /// null_frag operator.
2637 static bool hasNullFragReference(DagInit *DI) {
2638 DefInit *OpDef = dyn_cast<DefInit>(DI->getOperator());
2639 if (!OpDef) return false;
2640 Record *Operator = OpDef->getDef();
2642 // If this is the null fragment, return true.
2643 if (Operator->getName() == "null_frag") return true;
2644 // If any of the arguments reference the null fragment, return true.
2645 for (unsigned i = 0, e = DI->getNumArgs(); i != e; ++i) {
2646 DagInit *Arg = dyn_cast<DagInit>(DI->getArg(i));
2647 if (Arg && hasNullFragReference(Arg))
2654 /// hasNullFragReference - Return true if any DAG in the list references
2655 /// the null_frag operator.
2656 static bool hasNullFragReference(ListInit *LI) {
2657 for (unsigned i = 0, e = LI->getSize(); i != e; ++i) {
2658 DagInit *DI = dyn_cast<DagInit>(LI->getElement(i));
2659 assert(DI && "non-dag in an instruction Pattern list?!");
2660 if (hasNullFragReference(DI))
2666 /// Get all the instructions in a tree.
2668 getInstructionsInTree(TreePatternNode *Tree, SmallVectorImpl<Record*> &Instrs) {
2671 if (Tree->getOperator()->isSubClassOf("Instruction"))
2672 Instrs.push_back(Tree->getOperator());
2673 for (unsigned i = 0, e = Tree->getNumChildren(); i != e; ++i)
2674 getInstructionsInTree(Tree->getChild(i), Instrs);
2677 /// Check the class of a pattern leaf node against the instruction operand it
2679 static bool checkOperandClass(CGIOperandList::OperandInfo &OI,
2684 // Allow direct value types to be used in instruction set patterns.
2685 // The type will be checked later.
2686 if (Leaf->isSubClassOf("ValueType"))
2689 // Patterns can also be ComplexPattern instances.
2690 if (Leaf->isSubClassOf("ComplexPattern"))
2696 const DAGInstruction &CodeGenDAGPatterns::parseInstructionPattern(
2697 CodeGenInstruction &CGI, ListInit *Pat, DAGInstMap &DAGInsts) {
2699 assert(!DAGInsts.count(CGI.TheDef) && "Instruction already parsed!");
2701 // Parse the instruction.
2702 TreePattern *I = new TreePattern(CGI.TheDef, Pat, true, *this);
2703 // Inline pattern fragments into it.
2704 I->InlinePatternFragments();
2706 // Infer as many types as possible. If we cannot infer all of them, we can
2707 // never do anything with this instruction pattern: report it to the user.
2708 if (!I->InferAllTypes())
2709 I->error("Could not infer all types in pattern!");
2711 // InstInputs - Keep track of all of the inputs of the instruction, along
2712 // with the record they are declared as.
2713 std::map<std::string, TreePatternNode*> InstInputs;
2715 // InstResults - Keep track of all the virtual registers that are 'set'
2716 // in the instruction, including what reg class they are.
2717 std::map<std::string, TreePatternNode*> InstResults;
2719 std::vector<Record*> InstImpResults;
2721 // Verify that the top-level forms in the instruction are of void type, and
2722 // fill in the InstResults map.
2723 for (unsigned j = 0, e = I->getNumTrees(); j != e; ++j) {
2724 TreePatternNode *Pat = I->getTree(j);
2725 if (Pat->getNumTypes() != 0)
2726 I->error("Top-level forms in instruction pattern should have"
2729 // Find inputs and outputs, and verify the structure of the uses/defs.
2730 FindPatternInputsAndOutputs(I, Pat, InstInputs, InstResults,
2734 // Now that we have inputs and outputs of the pattern, inspect the operands
2735 // list for the instruction. This determines the order that operands are
2736 // added to the machine instruction the node corresponds to.
2737 unsigned NumResults = InstResults.size();
2739 // Parse the operands list from the (ops) list, validating it.
2740 assert(I->getArgList().empty() && "Args list should still be empty here!");
2742 // Check that all of the results occur first in the list.
2743 std::vector<Record*> Results;
2744 TreePatternNode *Res0Node = nullptr;
2745 for (unsigned i = 0; i != NumResults; ++i) {
2746 if (i == CGI.Operands.size())
2747 I->error("'" + InstResults.begin()->first +
2748 "' set but does not appear in operand list!");
2749 const std::string &OpName = CGI.Operands[i].Name;
2751 // Check that it exists in InstResults.
2752 TreePatternNode *RNode = InstResults[OpName];
2754 I->error("Operand $" + OpName + " does not exist in operand list!");
2758 Record *R = cast<DefInit>(RNode->getLeafValue())->getDef();
2760 I->error("Operand $" + OpName + " should be a set destination: all "
2761 "outputs must occur before inputs in operand list!");
2763 if (!checkOperandClass(CGI.Operands[i], R))
2764 I->error("Operand $" + OpName + " class mismatch!");
2766 // Remember the return type.
2767 Results.push_back(CGI.Operands[i].Rec);
2769 // Okay, this one checks out.
2770 InstResults.erase(OpName);
2773 // Loop over the inputs next. Make a copy of InstInputs so we can destroy
2774 // the copy while we're checking the inputs.
2775 std::map<std::string, TreePatternNode*> InstInputsCheck(InstInputs);
2777 std::vector<TreePatternNode*> ResultNodeOperands;
2778 std::vector<Record*> Operands;
2779 for (unsigned i = NumResults, e = CGI.Operands.size(); i != e; ++i) {
2780 CGIOperandList::OperandInfo &Op = CGI.Operands[i];
2781 const std::string &OpName = Op.Name;
2783 I->error("Operand #" + utostr(i) + " in operands list has no name!");
2785 if (!InstInputsCheck.count(OpName)) {
2786 // If this is an operand with a DefaultOps set filled in, we can ignore
2787 // this. When we codegen it, we will do so as always executed.
2788 if (Op.Rec->isSubClassOf("OperandWithDefaultOps")) {
2789 // Does it have a non-empty DefaultOps field? If so, ignore this
2791 if (!getDefaultOperand(Op.Rec).DefaultOps.empty())
2794 I->error("Operand $" + OpName +
2795 " does not appear in the instruction pattern");
2797 TreePatternNode *InVal = InstInputsCheck[OpName];
2798 InstInputsCheck.erase(OpName); // It occurred, remove from map.
2800 if (InVal->isLeaf() && isa<DefInit>(InVal->getLeafValue())) {
2801 Record *InRec = static_cast<DefInit*>(InVal->getLeafValue())->getDef();
2802 if (!checkOperandClass(Op, InRec))
2803 I->error("Operand $" + OpName + "'s register class disagrees"
2804 " between the operand and pattern");
2806 Operands.push_back(Op.Rec);
2808 // Construct the result for the dest-pattern operand list.
2809 TreePatternNode *OpNode = InVal->clone();
2811 // No predicate is useful on the result.
2812 OpNode->clearPredicateFns();
2814 // Promote the xform function to be an explicit node if set.
2815 if (Record *Xform = OpNode->getTransformFn()) {
2816 OpNode->setTransformFn(nullptr);
2817 std::vector<TreePatternNode*> Children;
2818 Children.push_back(OpNode);
2819 OpNode = new TreePatternNode(Xform, Children, OpNode->getNumTypes());
2822 ResultNodeOperands.push_back(OpNode);
2825 if (!InstInputsCheck.empty())
2826 I->error("Input operand $" + InstInputsCheck.begin()->first +
2827 " occurs in pattern but not in operands list!");
2829 TreePatternNode *ResultPattern =
2830 new TreePatternNode(I->getRecord(), ResultNodeOperands,
2831 GetNumNodeResults(I->getRecord(), *this));
2832 // Copy fully inferred output node type to instruction result pattern.
2833 for (unsigned i = 0; i != NumResults; ++i)
2834 ResultPattern->setType(i, Res0Node->getExtType(i));
2836 // Create and insert the instruction.
2837 // FIXME: InstImpResults should not be part of DAGInstruction.
2838 DAGInstruction TheInst(I, Results, Operands, InstImpResults);
2839 DAGInsts.insert(std::make_pair(I->getRecord(), TheInst));
2841 // Use a temporary tree pattern to infer all types and make sure that the
2842 // constructed result is correct. This depends on the instruction already
2843 // being inserted into the DAGInsts map.
2844 TreePattern Temp(I->getRecord(), ResultPattern, false, *this);
2845 Temp.InferAllTypes(&I->getNamedNodesMap());
2847 DAGInstruction &TheInsertedInst = DAGInsts.find(I->getRecord())->second;
2848 TheInsertedInst.setResultPattern(Temp.getOnlyTree());
2850 return TheInsertedInst;
2853 /// ParseInstructions - Parse all of the instructions, inlining and resolving
2854 /// any fragments involved. This populates the Instructions list with fully
2855 /// resolved instructions.
2856 void CodeGenDAGPatterns::ParseInstructions() {
2857 std::vector<Record*> Instrs = Records.getAllDerivedDefinitions("Instruction");
2859 for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
2860 ListInit *LI = nullptr;
2862 if (isa<ListInit>(Instrs[i]->getValueInit("Pattern")))
2863 LI = Instrs[i]->getValueAsListInit("Pattern");
2865 // If there is no pattern, only collect minimal information about the
2866 // instruction for its operand list. We have to assume that there is one
2867 // result, as we have no detailed info. A pattern which references the
2868 // null_frag operator is as-if no pattern were specified. Normally this
2869 // is from a multiclass expansion w/ a SDPatternOperator passed in as
2871 if (!LI || LI->getSize() == 0 || hasNullFragReference(LI)) {
2872 std::vector<Record*> Results;
2873 std::vector<Record*> Operands;
2875 CodeGenInstruction &InstInfo = Target.getInstruction(Instrs[i]);
2877 if (InstInfo.Operands.size() != 0) {
2878 if (InstInfo.Operands.NumDefs == 0) {
2879 // These produce no results
2880 for (unsigned j = 0, e = InstInfo.Operands.size(); j < e; ++j)
2881 Operands.push_back(InstInfo.Operands[j].Rec);
2883 // Assume the first operand is the result.
2884 Results.push_back(InstInfo.Operands[0].Rec);
2886 // The rest are inputs.
2887 for (unsigned j = 1, e = InstInfo.Operands.size(); j < e; ++j)
2888 Operands.push_back(InstInfo.Operands[j].Rec);
2892 // Create and insert the instruction.
2893 std::vector<Record*> ImpResults;
2894 Instructions.insert(std::make_pair(Instrs[i],
2895 DAGInstruction(nullptr, Results, Operands, ImpResults)));
2896 continue; // no pattern.
2899 CodeGenInstruction &CGI = Target.getInstruction(Instrs[i]);
2900 const DAGInstruction &DI = parseInstructionPattern(CGI, LI, Instructions);
2903 DEBUG(DI.getPattern()->dump());
2906 // If we can, convert the instructions to be patterns that are matched!
2907 for (std::map<Record*, DAGInstruction, LessRecordByID>::iterator II =
2908 Instructions.begin(),
2909 E = Instructions.end(); II != E; ++II) {
2910 DAGInstruction &TheInst = II->second;
2911 TreePattern *I = TheInst.getPattern();
2912 if (!I) continue; // No pattern.
2914 // FIXME: Assume only the first tree is the pattern. The others are clobber
2916 TreePatternNode *Pattern = I->getTree(0);
2917 TreePatternNode *SrcPattern;
2918 if (Pattern->getOperator()->getName() == "set") {
2919 SrcPattern = Pattern->getChild(Pattern->getNumChildren()-1)->clone();
2921 // Not a set (store or something?)
2922 SrcPattern = Pattern;
2925 Record *Instr = II->first;
2926 AddPatternToMatch(I,
2927 PatternToMatch(Instr,
2928 Instr->getValueAsListInit("Predicates"),
2930 TheInst.getResultPattern(),
2931 TheInst.getImpResults(),
2932 Instr->getValueAsInt("AddedComplexity"),
2938 typedef std::pair<const TreePatternNode*, unsigned> NameRecord;
2940 static void FindNames(const TreePatternNode *P,
2941 std::map<std::string, NameRecord> &Names,
2942 TreePattern *PatternTop) {
2943 if (!P->getName().empty()) {
2944 NameRecord &Rec = Names[P->getName()];
2945 // If this is the first instance of the name, remember the node.
2946 if (Rec.second++ == 0)
2948 else if (Rec.first->getExtTypes() != P->getExtTypes())
2949 PatternTop->error("repetition of value: $" + P->getName() +
2950 " where different uses have different types!");
2954 for (unsigned i = 0, e = P->getNumChildren(); i != e; ++i)
2955 FindNames(P->getChild(i), Names, PatternTop);
2959 void CodeGenDAGPatterns::AddPatternToMatch(TreePattern *Pattern,
2960 const PatternToMatch &PTM) {
2961 // Do some sanity checking on the pattern we're about to match.
2963 if (!PTM.getSrcPattern()->canPatternMatch(Reason, *this)) {
2964 PrintWarning(Pattern->getRecord()->getLoc(),
2965 Twine("Pattern can never match: ") + Reason);
2969 // If the source pattern's root is a complex pattern, that complex pattern
2970 // must specify the nodes it can potentially match.
2971 if (const ComplexPattern *CP =
2972 PTM.getSrcPattern()->getComplexPatternInfo(*this))
2973 if (CP->getRootNodes().empty())
2974 Pattern->error("ComplexPattern at root must specify list of opcodes it"
2978 // Find all of the named values in the input and output, ensure they have the
2980 std::map<std::string, NameRecord> SrcNames, DstNames;
2981 FindNames(PTM.getSrcPattern(), SrcNames, Pattern);
2982 FindNames(PTM.getDstPattern(), DstNames, Pattern);
2984 // Scan all of the named values in the destination pattern, rejecting them if
2985 // they don't exist in the input pattern.
2986 for (std::map<std::string, NameRecord>::iterator
2987 I = DstNames.begin(), E = DstNames.end(); I != E; ++I) {
2988 if (SrcNames[I->first].first == nullptr)
2989 Pattern->error("Pattern has input without matching name in output: $" +
2993 // Scan all of the named values in the source pattern, rejecting them if the
2994 // name isn't used in the dest, and isn't used to tie two values together.
2995 for (std::map<std::string, NameRecord>::iterator
2996 I = SrcNames.begin(), E = SrcNames.end(); I != E; ++I)
2997 if (DstNames[I->first].first == nullptr && SrcNames[I->first].second == 1)
2998 Pattern->error("Pattern has dead named input: $" + I->first);
3000 PatternsToMatch.push_back(PTM);
3005 void CodeGenDAGPatterns::InferInstructionFlags() {
3006 const std::vector<const CodeGenInstruction*> &Instructions =
3007 Target.getInstructionsByEnumValue();
3009 // First try to infer flags from the primary instruction pattern, if any.
3010 SmallVector<CodeGenInstruction*, 8> Revisit;
3011 unsigned Errors = 0;
3012 for (unsigned i = 0, e = Instructions.size(); i != e; ++i) {
3013 CodeGenInstruction &InstInfo =
3014 const_cast<CodeGenInstruction &>(*Instructions[i]);
3016 // Treat neverHasSideEffects = 1 as the equivalent of hasSideEffects = 0.
3017 // This flag is obsolete and will be removed.
3018 if (InstInfo.neverHasSideEffects) {
3019 assert(!InstInfo.hasSideEffects);
3020 InstInfo.hasSideEffects_Unset = false;
3023 // Get the primary instruction pattern.
3024 const TreePattern *Pattern = getInstruction(InstInfo.TheDef).getPattern();
3026 if (InstInfo.hasUndefFlags())
3027 Revisit.push_back(&InstInfo);
3030 InstAnalyzer PatInfo(*this);
3031 PatInfo.Analyze(Pattern);
3032 Errors += InferFromPattern(InstInfo, PatInfo, InstInfo.TheDef);
3035 // Second, look for single-instruction patterns defined outside the
3037 for (ptm_iterator I = ptm_begin(), E = ptm_end(); I != E; ++I) {
3038 const PatternToMatch &PTM = *I;
3040 // We can only infer from single-instruction patterns, otherwise we won't
3041 // know which instruction should get the flags.
3042 SmallVector<Record*, 8> PatInstrs;
3043 getInstructionsInTree(PTM.getDstPattern(), PatInstrs);
3044 if (PatInstrs.size() != 1)
3047 // Get the single instruction.
3048 CodeGenInstruction &InstInfo = Target.getInstruction(PatInstrs.front());
3050 // Only infer properties from the first pattern. We'll verify the others.
3051 if (InstInfo.InferredFrom)
3054 InstAnalyzer PatInfo(*this);
3055 PatInfo.Analyze(&PTM);
3056 Errors += InferFromPattern(InstInfo, PatInfo, PTM.getSrcRecord());
3060 PrintFatalError("pattern conflicts");
3062 // Revisit instructions with undefined flags and no pattern.
3063 if (Target.guessInstructionProperties()) {
3064 for (unsigned i = 0, e = Revisit.size(); i != e; ++i) {
3065 CodeGenInstruction &InstInfo = *Revisit[i];
3066 if (InstInfo.InferredFrom)
3068 // The mayLoad and mayStore flags default to false.
3069 // Conservatively assume hasSideEffects if it wasn't explicit.
3070 if (InstInfo.hasSideEffects_Unset)
3071 InstInfo.hasSideEffects = true;
3076 // Complain about any flags that are still undefined.
3077 for (unsigned i = 0, e = Revisit.size(); i != e; ++i) {
3078 CodeGenInstruction &InstInfo = *Revisit[i];
3079 if (InstInfo.InferredFrom)
3081 if (InstInfo.hasSideEffects_Unset)
3082 PrintError(InstInfo.TheDef->getLoc(),
3083 "Can't infer hasSideEffects from patterns");
3084 if (InstInfo.mayStore_Unset)
3085 PrintError(InstInfo.TheDef->getLoc(),
3086 "Can't infer mayStore from patterns");
3087 if (InstInfo.mayLoad_Unset)
3088 PrintError(InstInfo.TheDef->getLoc(),
3089 "Can't infer mayLoad from patterns");
3094 /// Verify instruction flags against pattern node properties.
3095 void CodeGenDAGPatterns::VerifyInstructionFlags() {
3096 unsigned Errors = 0;
3097 for (ptm_iterator I = ptm_begin(), E = ptm_end(); I != E; ++I) {
3098 const PatternToMatch &PTM = *I;
3099 SmallVector<Record*, 8> Instrs;
3100 getInstructionsInTree(PTM.getDstPattern(), Instrs);
3104 // Count the number of instructions with each flag set.
3105 unsigned NumSideEffects = 0;
3106 unsigned NumStores = 0;
3107 unsigned NumLoads = 0;
3108 for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
3109 const CodeGenInstruction &InstInfo = Target.getInstruction(Instrs[i]);
3110 NumSideEffects += InstInfo.hasSideEffects;
3111 NumStores += InstInfo.mayStore;
3112 NumLoads += InstInfo.mayLoad;
3115 // Analyze the source pattern.
3116 InstAnalyzer PatInfo(*this);
3117 PatInfo.Analyze(&PTM);
3119 // Collect error messages.
3120 SmallVector<std::string, 4> Msgs;
3122 // Check for missing flags in the output.
3123 // Permit extra flags for now at least.
3124 if (PatInfo.hasSideEffects && !NumSideEffects)
3125 Msgs.push_back("pattern has side effects, but hasSideEffects isn't set");
3127 // Don't verify store flags on instructions with side effects. At least for
3128 // intrinsics, side effects implies mayStore.
3129 if (!PatInfo.hasSideEffects && PatInfo.mayStore && !NumStores)
3130 Msgs.push_back("pattern may store, but mayStore isn't set");
3132 // Similarly, mayStore implies mayLoad on intrinsics.
3133 if (!PatInfo.mayStore && PatInfo.mayLoad && !NumLoads)
3134 Msgs.push_back("pattern may load, but mayLoad isn't set");
3136 // Print error messages.
3141 for (unsigned i = 0, e = Msgs.size(); i != e; ++i)
3142 PrintError(PTM.getSrcRecord()->getLoc(), Twine(Msgs[i]) + " on the " +
3143 (Instrs.size() == 1 ?
3144 "instruction" : "output instructions"));
3145 // Provide the location of the relevant instruction definitions.
3146 for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
3147 if (Instrs[i] != PTM.getSrcRecord())
3148 PrintError(Instrs[i]->getLoc(), "defined here");
3149 const CodeGenInstruction &InstInfo = Target.getInstruction(Instrs[i]);
3150 if (InstInfo.InferredFrom &&
3151 InstInfo.InferredFrom != InstInfo.TheDef &&
3152 InstInfo.InferredFrom != PTM.getSrcRecord())
3153 PrintError(InstInfo.InferredFrom->getLoc(), "inferred from patttern");
3157 PrintFatalError("Errors in DAG patterns");
3160 /// Given a pattern result with an unresolved type, see if we can find one
3161 /// instruction with an unresolved result type. Force this result type to an
3162 /// arbitrary element if it's possible types to converge results.
3163 static bool ForceArbitraryInstResultType(TreePatternNode *N, TreePattern &TP) {
3167 // Analyze children.
3168 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
3169 if (ForceArbitraryInstResultType(N->getChild(i), TP))
3172 if (!N->getOperator()->isSubClassOf("Instruction"))
3175 // If this type is already concrete or completely unknown we can't do
3177 for (unsigned i = 0, e = N->getNumTypes(); i != e; ++i) {
3178 if (N->getExtType(i).isCompletelyUnknown() || N->getExtType(i).isConcrete())
3181 // Otherwise, force its type to the first possibility (an arbitrary choice).
3182 if (N->getExtType(i).MergeInTypeInfo(N->getExtType(i).getTypeList()[0], TP))
3189 void CodeGenDAGPatterns::ParsePatterns() {
3190 std::vector<Record*> Patterns = Records.getAllDerivedDefinitions("Pattern");
3192 for (unsigned i = 0, e = Patterns.size(); i != e; ++i) {
3193 Record *CurPattern = Patterns[i];
3194 DagInit *Tree = CurPattern->getValueAsDag("PatternToMatch");
3196 // If the pattern references the null_frag, there's nothing to do.
3197 if (hasNullFragReference(Tree))
3200 TreePattern *Pattern = new TreePattern(CurPattern, Tree, true, *this);
3202 // Inline pattern fragments into it.
3203 Pattern->InlinePatternFragments();
3205 ListInit *LI = CurPattern->getValueAsListInit("ResultInstrs");
3206 if (LI->getSize() == 0) continue; // no pattern.
3208 // Parse the instruction.
3209 TreePattern *Result = new TreePattern(CurPattern, LI, false, *this);
3211 // Inline pattern fragments into it.
3212 Result->InlinePatternFragments();
3214 if (Result->getNumTrees() != 1)
3215 Result->error("Cannot handle instructions producing instructions "
3216 "with temporaries yet!");
3218 bool IterateInference;
3219 bool InferredAllPatternTypes, InferredAllResultTypes;
3221 // Infer as many types as possible. If we cannot infer all of them, we
3222 // can never do anything with this pattern: report it to the user.
3223 InferredAllPatternTypes =
3224 Pattern->InferAllTypes(&Pattern->getNamedNodesMap());
3226 // Infer as many types as possible. If we cannot infer all of them, we
3227 // can never do anything with this pattern: report it to the user.
3228 InferredAllResultTypes =
3229 Result->InferAllTypes(&Pattern->getNamedNodesMap());
3231 IterateInference = false;
3233 // Apply the type of the result to the source pattern. This helps us
3234 // resolve cases where the input type is known to be a pointer type (which
3235 // is considered resolved), but the result knows it needs to be 32- or
3236 // 64-bits. Infer the other way for good measure.
3237 for (unsigned i = 0, e = std::min(Result->getTree(0)->getNumTypes(),
3238 Pattern->getTree(0)->getNumTypes());
3240 IterateInference = Pattern->getTree(0)->
3241 UpdateNodeType(i, Result->getTree(0)->getExtType(i), *Result);
3242 IterateInference |= Result->getTree(0)->
3243 UpdateNodeType(i, Pattern->getTree(0)->getExtType(i), *Result);
3246 // If our iteration has converged and the input pattern's types are fully
3247 // resolved but the result pattern is not fully resolved, we may have a
3248 // situation where we have two instructions in the result pattern and
3249 // the instructions require a common register class, but don't care about
3250 // what actual MVT is used. This is actually a bug in our modelling:
3251 // output patterns should have register classes, not MVTs.
3253 // In any case, to handle this, we just go through and disambiguate some
3254 // arbitrary types to the result pattern's nodes.
3255 if (!IterateInference && InferredAllPatternTypes &&
3256 !InferredAllResultTypes)
3257 IterateInference = ForceArbitraryInstResultType(Result->getTree(0),
3259 } while (IterateInference);
3261 // Verify that we inferred enough types that we can do something with the
3262 // pattern and result. If these fire the user has to add type casts.
3263 if (!InferredAllPatternTypes)
3264 Pattern->error("Could not infer all types in pattern!");
3265 if (!InferredAllResultTypes) {
3267 Result->error("Could not infer all types in pattern result!");
3270 // Validate that the input pattern is correct.
3271 std::map<std::string, TreePatternNode*> InstInputs;
3272 std::map<std::string, TreePatternNode*> InstResults;
3273 std::vector<Record*> InstImpResults;
3274 for (unsigned j = 0, ee = Pattern->getNumTrees(); j != ee; ++j)
3275 FindPatternInputsAndOutputs(Pattern, Pattern->getTree(j),
3276 InstInputs, InstResults,
3279 // Promote the xform function to be an explicit node if set.
3280 TreePatternNode *DstPattern = Result->getOnlyTree();
3281 std::vector<TreePatternNode*> ResultNodeOperands;
3282 for (unsigned ii = 0, ee = DstPattern->getNumChildren(); ii != ee; ++ii) {
3283 TreePatternNode *OpNode = DstPattern->getChild(ii);
3284 if (Record *Xform = OpNode->getTransformFn()) {
3285 OpNode->setTransformFn(nullptr);
3286 std::vector<TreePatternNode*> Children;
3287 Children.push_back(OpNode);
3288 OpNode = new TreePatternNode(Xform, Children, OpNode->getNumTypes());
3290 ResultNodeOperands.push_back(OpNode);
3292 DstPattern = Result->getOnlyTree();
3293 if (!DstPattern->isLeaf())
3294 DstPattern = new TreePatternNode(DstPattern->getOperator(),
3296 DstPattern->getNumTypes());
3298 for (unsigned i = 0, e = Result->getOnlyTree()->getNumTypes(); i != e; ++i)
3299 DstPattern->setType(i, Result->getOnlyTree()->getExtType(i));
3301 TreePattern Temp(Result->getRecord(), DstPattern, false, *this);
3302 Temp.InferAllTypes();
3305 AddPatternToMatch(Pattern,
3306 PatternToMatch(CurPattern,
3307 CurPattern->getValueAsListInit("Predicates"),
3308 Pattern->getTree(0),
3309 Temp.getOnlyTree(), InstImpResults,
3310 CurPattern->getValueAsInt("AddedComplexity"),
3311 CurPattern->getID()));
3315 /// CombineChildVariants - Given a bunch of permutations of each child of the
3316 /// 'operator' node, put them together in all possible ways.
3317 static void CombineChildVariants(TreePatternNode *Orig,
3318 const std::vector<std::vector<TreePatternNode*> > &ChildVariants,
3319 std::vector<TreePatternNode*> &OutVariants,
3320 CodeGenDAGPatterns &CDP,
3321 const MultipleUseVarSet &DepVars) {
3322 // Make sure that each operand has at least one variant to choose from.
3323 for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
3324 if (ChildVariants[i].empty())
3327 // The end result is an all-pairs construction of the resultant pattern.
3328 std::vector<unsigned> Idxs;
3329 Idxs.resize(ChildVariants.size());
3333 DEBUG(if (!Idxs.empty()) {
3334 errs() << Orig->getOperator()->getName() << ": Idxs = [ ";
3335 for (unsigned i = 0; i < Idxs.size(); ++i) {
3336 errs() << Idxs[i] << " ";
3341 // Create the variant and add it to the output list.
3342 std::vector<TreePatternNode*> NewChildren;
3343 for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
3344 NewChildren.push_back(ChildVariants[i][Idxs[i]]);
3345 TreePatternNode *R = new TreePatternNode(Orig->getOperator(), NewChildren,
3346 Orig->getNumTypes());
3348 // Copy over properties.
3349 R->setName(Orig->getName());
3350 R->setPredicateFns(Orig->getPredicateFns());
3351 R->setTransformFn(Orig->getTransformFn());
3352 for (unsigned i = 0, e = Orig->getNumTypes(); i != e; ++i)
3353 R->setType(i, Orig->getExtType(i));
3355 // If this pattern cannot match, do not include it as a variant.
3356 std::string ErrString;
3357 if (!R->canPatternMatch(ErrString, CDP)) {
3360 bool AlreadyExists = false;
3362 // Scan to see if this pattern has already been emitted. We can get
3363 // duplication due to things like commuting:
3364 // (and GPRC:$a, GPRC:$b) -> (and GPRC:$b, GPRC:$a)
3365 // which are the same pattern. Ignore the dups.
3366 for (unsigned i = 0, e = OutVariants.size(); i != e; ++i)
3367 if (R->isIsomorphicTo(OutVariants[i], DepVars)) {
3368 AlreadyExists = true;
3375 OutVariants.push_back(R);
3378 // Increment indices to the next permutation by incrementing the
3379 // indicies from last index backward, e.g., generate the sequence
3380 // [0, 0], [0, 1], [1, 0], [1, 1].
3382 for (IdxsIdx = Idxs.size() - 1; IdxsIdx >= 0; --IdxsIdx) {
3383 if (++Idxs[IdxsIdx] == ChildVariants[IdxsIdx].size())
3388 NotDone = (IdxsIdx >= 0);
3392 /// CombineChildVariants - A helper function for binary operators.
3394 static void CombineChildVariants(TreePatternNode *Orig,
3395 const std::vector<TreePatternNode*> &LHS,
3396 const std::vector<TreePatternNode*> &RHS,
3397 std::vector<TreePatternNode*> &OutVariants,
3398 CodeGenDAGPatterns &CDP,
3399 const MultipleUseVarSet &DepVars) {
3400 std::vector<std::vector<TreePatternNode*> > ChildVariants;
3401 ChildVariants.push_back(LHS);
3402 ChildVariants.push_back(RHS);
3403 CombineChildVariants(Orig, ChildVariants, OutVariants, CDP, DepVars);
3407 static void GatherChildrenOfAssociativeOpcode(TreePatternNode *N,
3408 std::vector<TreePatternNode *> &Children) {
3409 assert(N->getNumChildren()==2 &&"Associative but doesn't have 2 children!");
3410 Record *Operator = N->getOperator();
3412 // Only permit raw nodes.
3413 if (!N->getName().empty() || !N->getPredicateFns().empty() ||
3414 N->getTransformFn()) {
3415 Children.push_back(N);
3419 if (N->getChild(0)->isLeaf() || N->getChild(0)->getOperator() != Operator)
3420 Children.push_back(N->getChild(0));
3422 GatherChildrenOfAssociativeOpcode(N->getChild(0), Children);
3424 if (N->getChild(1)->isLeaf() || N->getChild(1)->getOperator() != Operator)
3425 Children.push_back(N->getChild(1));
3427 GatherChildrenOfAssociativeOpcode(N->getChild(1), Children);
3430 /// GenerateVariantsOf - Given a pattern N, generate all permutations we can of
3431 /// the (potentially recursive) pattern by using algebraic laws.
3433 static void GenerateVariantsOf(TreePatternNode *N,
3434 std::vector<TreePatternNode*> &OutVariants,
3435 CodeGenDAGPatterns &CDP,
3436 const MultipleUseVarSet &DepVars) {
3437 // We cannot permute leaves.
3439 OutVariants.push_back(N);
3443 // Look up interesting info about the node.
3444 const SDNodeInfo &NodeInfo = CDP.getSDNodeInfo(N->getOperator());
3446 // If this node is associative, re-associate.
3447 if (NodeInfo.hasProperty(SDNPAssociative)) {
3448 // Re-associate by pulling together all of the linked operators
3449 std::vector<TreePatternNode*> MaximalChildren;
3450 GatherChildrenOfAssociativeOpcode(N, MaximalChildren);
3452 // Only handle child sizes of 3. Otherwise we'll end up trying too many
3454 if (MaximalChildren.size() == 3) {
3455 // Find the variants of all of our maximal children.
3456 std::vector<TreePatternNode*> AVariants, BVariants, CVariants;
3457 GenerateVariantsOf(MaximalChildren[0], AVariants, CDP, DepVars);
3458 GenerateVariantsOf(MaximalChildren[1], BVariants, CDP, DepVars);
3459 GenerateVariantsOf(MaximalChildren[2], CVariants, CDP, DepVars);
3461 // There are only two ways we can permute the tree:
3462 // (A op B) op C and A op (B op C)
3463 // Within these forms, we can also permute A/B/C.
3465 // Generate legal pair permutations of A/B/C.
3466 std::vector<TreePatternNode*> ABVariants;
3467 std::vector<TreePatternNode*> BAVariants;
3468 std::vector<TreePatternNode*> ACVariants;
3469 std::vector<TreePatternNode*> CAVariants;
3470 std::vector<TreePatternNode*> BCVariants;
3471 std::vector<TreePatternNode*> CBVariants;
3472 CombineChildVariants(N, AVariants, BVariants, ABVariants, CDP, DepVars);
3473 CombineChildVariants(N, BVariants, AVariants, BAVariants, CDP, DepVars);
3474 CombineChildVariants(N, AVariants, CVariants, ACVariants, CDP, DepVars);
3475 CombineChildVariants(N, CVariants, AVariants, CAVariants, CDP, DepVars);
3476 CombineChildVariants(N, BVariants, CVariants, BCVariants, CDP, DepVars);
3477 CombineChildVariants(N, CVariants, BVariants, CBVariants, CDP, DepVars);
3479 // Combine those into the result: (x op x) op x
3480 CombineChildVariants(N, ABVariants, CVariants, OutVariants, CDP, DepVars);
3481 CombineChildVariants(N, BAVariants, CVariants, OutVariants, CDP, DepVars);
3482 CombineChildVariants(N, ACVariants, BVariants, OutVariants, CDP, DepVars);
3483 CombineChildVariants(N, CAVariants, BVariants, OutVariants, CDP, DepVars);
3484 CombineChildVariants(N, BCVariants, AVariants, OutVariants, CDP, DepVars);
3485 CombineChildVariants(N, CBVariants, AVariants, OutVariants, CDP, DepVars);
3487 // Combine those into the result: x op (x op x)
3488 CombineChildVariants(N, CVariants, ABVariants, OutVariants, CDP, DepVars);
3489 CombineChildVariants(N, CVariants, BAVariants, OutVariants, CDP, DepVars);
3490 CombineChildVariants(N, BVariants, ACVariants, OutVariants, CDP, DepVars);
3491 CombineChildVariants(N, BVariants, CAVariants, OutVariants, CDP, DepVars);
3492 CombineChildVariants(N, AVariants, BCVariants, OutVariants, CDP, DepVars);
3493 CombineChildVariants(N, AVariants, CBVariants, OutVariants, CDP, DepVars);
3498 // Compute permutations of all children.
3499 std::vector<std::vector<TreePatternNode*> > ChildVariants;
3500 ChildVariants.resize(N->getNumChildren());
3501 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
3502 GenerateVariantsOf(N->getChild(i), ChildVariants[i], CDP, DepVars);
3504 // Build all permutations based on how the children were formed.
3505 CombineChildVariants(N, ChildVariants, OutVariants, CDP, DepVars);
3507 // If this node is commutative, consider the commuted order.
3508 bool isCommIntrinsic = N->isCommutativeIntrinsic(CDP);
3509 if (NodeInfo.hasProperty(SDNPCommutative) || isCommIntrinsic) {
3510 assert((N->getNumChildren()==2 || isCommIntrinsic) &&
3511 "Commutative but doesn't have 2 children!");
3512 // Don't count children which are actually register references.
3514 for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i) {
3515 TreePatternNode *Child = N->getChild(i);
3516 if (Child->isLeaf())
3517 if (DefInit *DI = dyn_cast<DefInit>(Child->getLeafValue())) {
3518 Record *RR = DI->getDef();
3519 if (RR->isSubClassOf("Register"))
3524 // Consider the commuted order.
3525 if (isCommIntrinsic) {
3526 // Commutative intrinsic. First operand is the intrinsic id, 2nd and 3rd
3527 // operands are the commutative operands, and there might be more operands
3530 "Commutative intrinsic should have at least 3 childrean!");
3531 std::vector<std::vector<TreePatternNode*> > Variants;
3532 Variants.push_back(ChildVariants[0]); // Intrinsic id.
3533 Variants.push_back(ChildVariants[2]);
3534 Variants.push_back(ChildVariants[1]);
3535 for (unsigned i = 3; i != NC; ++i)
3536 Variants.push_back(ChildVariants[i]);
3537 CombineChildVariants(N, Variants, OutVariants, CDP, DepVars);
3539 CombineChildVariants(N, ChildVariants[1], ChildVariants[0],
3540 OutVariants, CDP, DepVars);
3545 // GenerateVariants - Generate variants. For example, commutative patterns can
3546 // match multiple ways. Add them to PatternsToMatch as well.
3547 void CodeGenDAGPatterns::GenerateVariants() {
3548 DEBUG(errs() << "Generating instruction variants.\n");
3550 // Loop over all of the patterns we've collected, checking to see if we can
3551 // generate variants of the instruction, through the exploitation of
3552 // identities. This permits the target to provide aggressive matching without
3553 // the .td file having to contain tons of variants of instructions.
3555 // Note that this loop adds new patterns to the PatternsToMatch list, but we
3556 // intentionally do not reconsider these. Any variants of added patterns have
3557 // already been added.
3559 for (unsigned i = 0, e = PatternsToMatch.size(); i != e; ++i) {
3560 MultipleUseVarSet DepVars;
3561 std::vector<TreePatternNode*> Variants;
3562 FindDepVars(PatternsToMatch[i].getSrcPattern(), DepVars);
3563 DEBUG(errs() << "Dependent/multiply used variables: ");
3564 DEBUG(DumpDepVars(DepVars));
3565 DEBUG(errs() << "\n");
3566 GenerateVariantsOf(PatternsToMatch[i].getSrcPattern(), Variants, *this,
3569 assert(!Variants.empty() && "Must create at least original variant!");
3570 Variants.erase(Variants.begin()); // Remove the original pattern.
3572 if (Variants.empty()) // No variants for this pattern.
3575 DEBUG(errs() << "FOUND VARIANTS OF: ";
3576 PatternsToMatch[i].getSrcPattern()->dump();
3579 for (unsigned v = 0, e = Variants.size(); v != e; ++v) {
3580 TreePatternNode *Variant = Variants[v];
3582 DEBUG(errs() << " VAR#" << v << ": ";
3586 // Scan to see if an instruction or explicit pattern already matches this.
3587 bool AlreadyExists = false;
3588 for (unsigned p = 0, e = PatternsToMatch.size(); p != e; ++p) {
3589 // Skip if the top level predicates do not match.
3590 if (PatternsToMatch[i].getPredicates() !=
3591 PatternsToMatch[p].getPredicates())
3593 // Check to see if this variant already exists.
3594 if (Variant->isIsomorphicTo(PatternsToMatch[p].getSrcPattern(),
3596 DEBUG(errs() << " *** ALREADY EXISTS, ignoring variant.\n");
3597 AlreadyExists = true;
3601 // If we already have it, ignore the variant.
3602 if (AlreadyExists) continue;
3604 // Otherwise, add it to the list of patterns we have.
3606 push_back(PatternToMatch(PatternsToMatch[i].getSrcRecord(),
3607 PatternsToMatch[i].getPredicates(),
3608 Variant, PatternsToMatch[i].getDstPattern(),
3609 PatternsToMatch[i].getDstRegs(),
3610 PatternsToMatch[i].getAddedComplexity(),
3611 Record::getNewUID()));
3614 DEBUG(errs() << "\n");