bb45cb2a296d33797ed0e4a2a7fd3d0e3a7bbfa2
[oota-llvm.git] / utils / TableGen / CodeGenDAGPatterns.cpp
1 //===- CodeGenDAGPatterns.cpp - Read DAG patterns from .td file -----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the CodeGenDAGPatterns class, which is used to read and
11 // represent the patterns present in a .td file for instructions.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "CodeGenDAGPatterns.h"
16 #include "Error.h"
17 #include "Record.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Support/Debug.h"
21 #include <set>
22 #include <algorithm>
23 using namespace llvm;
24
25 //===----------------------------------------------------------------------===//
26 //  EEVT::TypeSet Implementation
27 //===----------------------------------------------------------------------===//
28
29 static inline bool isInteger(MVT::SimpleValueType VT) {
30   return EVT(VT).isInteger();
31 }
32 static inline bool isFloatingPoint(MVT::SimpleValueType VT) {
33   return EVT(VT).isFloatingPoint();
34 }
35 static inline bool isVector(MVT::SimpleValueType VT) {
36   return EVT(VT).isVector();
37 }
38 static inline bool isScalar(MVT::SimpleValueType VT) {
39   return !EVT(VT).isVector();
40 }
41
42 EEVT::TypeSet::TypeSet(MVT::SimpleValueType VT, TreePattern &TP) {
43   if (VT == MVT::iAny)
44     EnforceInteger(TP);
45   else if (VT == MVT::fAny)
46     EnforceFloatingPoint(TP);
47   else if (VT == MVT::vAny)
48     EnforceVector(TP);
49   else {
50     assert((VT < MVT::LAST_VALUETYPE || VT == MVT::iPTR ||
51             VT == MVT::iPTRAny) && "Not a concrete type!");
52     TypeVec.push_back(VT);
53   }
54 }
55
56
57 EEVT::TypeSet::TypeSet(const std::vector<MVT::SimpleValueType> &VTList) {
58   assert(!VTList.empty() && "empty list?");
59   TypeVec.append(VTList.begin(), VTList.end());
60
61   if (!VTList.empty())
62     assert(VTList[0] != MVT::iAny && VTList[0] != MVT::vAny &&
63            VTList[0] != MVT::fAny);
64
65   // Verify no duplicates.
66   array_pod_sort(TypeVec.begin(), TypeVec.end());
67   assert(std::unique(TypeVec.begin(), TypeVec.end()) == TypeVec.end());
68 }
69
70 /// FillWithPossibleTypes - Set to all legal types and return true, only valid
71 /// on completely unknown type sets.
72 bool EEVT::TypeSet::FillWithPossibleTypes(TreePattern &TP,
73                                           bool (*Pred)(MVT::SimpleValueType),
74                                           const char *PredicateName) {
75   assert(isCompletelyUnknown());
76   const std::vector<MVT::SimpleValueType> &LegalTypes =
77     TP.getDAGPatterns().getTargetInfo().getLegalValueTypes();
78
79   for (unsigned i = 0, e = LegalTypes.size(); i != e; ++i)
80     if (Pred == 0 || Pred(LegalTypes[i]))
81       TypeVec.push_back(LegalTypes[i]);
82
83   // If we have nothing that matches the predicate, bail out.
84   if (TypeVec.empty())
85     TP.error("Type inference contradiction found, no " +
86              std::string(PredicateName) + " types found");
87   // No need to sort with one element.
88   if (TypeVec.size() == 1) return true;
89
90   // Remove duplicates.
91   array_pod_sort(TypeVec.begin(), TypeVec.end());
92   TypeVec.erase(std::unique(TypeVec.begin(), TypeVec.end()), TypeVec.end());
93
94   return true;
95 }
96
97 /// hasIntegerTypes - Return true if this TypeSet contains iAny or an
98 /// integer value type.
99 bool EEVT::TypeSet::hasIntegerTypes() const {
100   for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
101     if (isInteger(TypeVec[i]))
102       return true;
103   return false;
104 }
105
106 /// hasFloatingPointTypes - Return true if this TypeSet contains an fAny or
107 /// a floating point value type.
108 bool EEVT::TypeSet::hasFloatingPointTypes() const {
109   for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
110     if (isFloatingPoint(TypeVec[i]))
111       return true;
112   return false;
113 }
114
115 /// hasVectorTypes - Return true if this TypeSet contains a vAny or a vector
116 /// value type.
117 bool EEVT::TypeSet::hasVectorTypes() const {
118   for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
119     if (isVector(TypeVec[i]))
120       return true;
121   return false;
122 }
123
124
125 std::string EEVT::TypeSet::getName() const {
126   if (TypeVec.empty()) return "<empty>";
127
128   std::string Result;
129
130   for (unsigned i = 0, e = TypeVec.size(); i != e; ++i) {
131     std::string VTName = llvm::getEnumName(TypeVec[i]);
132     // Strip off MVT:: prefix if present.
133     if (VTName.substr(0,5) == "MVT::")
134       VTName = VTName.substr(5);
135     if (i) Result += ':';
136     Result += VTName;
137   }
138
139   if (TypeVec.size() == 1)
140     return Result;
141   return "{" + Result + "}";
142 }
143
144 /// MergeInTypeInfo - This merges in type information from the specified
145 /// argument.  If 'this' changes, it returns true.  If the two types are
146 /// contradictory (e.g. merge f32 into i32) then this throws an exception.
147 bool EEVT::TypeSet::MergeInTypeInfo(const EEVT::TypeSet &InVT, TreePattern &TP){
148   if (InVT.isCompletelyUnknown() || *this == InVT)
149     return false;
150
151   if (isCompletelyUnknown()) {
152     *this = InVT;
153     return true;
154   }
155
156   assert(TypeVec.size() >= 1 && InVT.TypeVec.size() >= 1 && "No unknowns");
157
158   // Handle the abstract cases, seeing if we can resolve them better.
159   switch (TypeVec[0]) {
160   default: break;
161   case MVT::iPTR:
162   case MVT::iPTRAny:
163     if (InVT.hasIntegerTypes()) {
164       EEVT::TypeSet InCopy(InVT);
165       InCopy.EnforceInteger(TP);
166       InCopy.EnforceScalar(TP);
167
168       if (InCopy.isConcrete()) {
169         // If the RHS has one integer type, upgrade iPTR to i32.
170         TypeVec[0] = InVT.TypeVec[0];
171         return true;
172       }
173
174       // If the input has multiple scalar integers, this doesn't add any info.
175       if (!InCopy.isCompletelyUnknown())
176         return false;
177     }
178     break;
179   }
180
181   // If the input constraint is iAny/iPTR and this is an integer type list,
182   // remove non-integer types from the list.
183   if ((InVT.TypeVec[0] == MVT::iPTR || InVT.TypeVec[0] == MVT::iPTRAny) &&
184       hasIntegerTypes()) {
185     bool MadeChange = EnforceInteger(TP);
186
187     // If we're merging in iPTR/iPTRAny and the node currently has a list of
188     // multiple different integer types, replace them with a single iPTR.
189     if ((InVT.TypeVec[0] == MVT::iPTR || InVT.TypeVec[0] == MVT::iPTRAny) &&
190         TypeVec.size() != 1) {
191       TypeVec.resize(1);
192       TypeVec[0] = InVT.TypeVec[0];
193       MadeChange = true;
194     }
195
196     return MadeChange;
197   }
198
199   // If this is a type list and the RHS is a typelist as well, eliminate entries
200   // from this list that aren't in the other one.
201   bool MadeChange = false;
202   TypeSet InputSet(*this);
203
204   for (unsigned i = 0; i != TypeVec.size(); ++i) {
205     bool InInVT = false;
206     for (unsigned j = 0, e = InVT.TypeVec.size(); j != e; ++j)
207       if (TypeVec[i] == InVT.TypeVec[j]) {
208         InInVT = true;
209         break;
210       }
211
212     if (InInVT) continue;
213     TypeVec.erase(TypeVec.begin()+i--);
214     MadeChange = true;
215   }
216
217   // If we removed all of our types, we have a type contradiction.
218   if (!TypeVec.empty())
219     return MadeChange;
220
221   // FIXME: Really want an SMLoc here!
222   TP.error("Type inference contradiction found, merging '" +
223            InVT.getName() + "' into '" + InputSet.getName() + "'");
224   return true; // unreachable
225 }
226
227 /// EnforceInteger - Remove all non-integer types from this set.
228 bool EEVT::TypeSet::EnforceInteger(TreePattern &TP) {
229   // If we know nothing, then get the full set.
230   if (TypeVec.empty())
231     return FillWithPossibleTypes(TP, isInteger, "integer");
232   if (!hasFloatingPointTypes())
233     return false;
234
235   TypeSet InputSet(*this);
236
237   // Filter out all the fp types.
238   for (unsigned i = 0; i != TypeVec.size(); ++i)
239     if (!isInteger(TypeVec[i]))
240       TypeVec.erase(TypeVec.begin()+i--);
241
242   if (TypeVec.empty())
243     TP.error("Type inference contradiction found, '" +
244              InputSet.getName() + "' needs to be integer");
245   return true;
246 }
247
248 /// EnforceFloatingPoint - Remove all integer types from this set.
249 bool EEVT::TypeSet::EnforceFloatingPoint(TreePattern &TP) {
250   // If we know nothing, then get the full set.
251   if (TypeVec.empty())
252     return FillWithPossibleTypes(TP, isFloatingPoint, "floating point");
253
254   if (!hasIntegerTypes())
255     return false;
256
257   TypeSet InputSet(*this);
258
259   // Filter out all the fp types.
260   for (unsigned i = 0; i != TypeVec.size(); ++i)
261     if (!isFloatingPoint(TypeVec[i]))
262       TypeVec.erase(TypeVec.begin()+i--);
263
264   if (TypeVec.empty())
265     TP.error("Type inference contradiction found, '" +
266              InputSet.getName() + "' needs to be floating point");
267   return true;
268 }
269
270 /// EnforceScalar - Remove all vector types from this.
271 bool EEVT::TypeSet::EnforceScalar(TreePattern &TP) {
272   // If we know nothing, then get the full set.
273   if (TypeVec.empty())
274     return FillWithPossibleTypes(TP, isScalar, "scalar");
275
276   if (!hasVectorTypes())
277     return false;
278
279   TypeSet InputSet(*this);
280
281   // Filter out all the vector types.
282   for (unsigned i = 0; i != TypeVec.size(); ++i)
283     if (!isScalar(TypeVec[i]))
284       TypeVec.erase(TypeVec.begin()+i--);
285
286   if (TypeVec.empty())
287     TP.error("Type inference contradiction found, '" +
288              InputSet.getName() + "' needs to be scalar");
289   return true;
290 }
291
292 /// EnforceVector - Remove all vector types from this.
293 bool EEVT::TypeSet::EnforceVector(TreePattern &TP) {
294   // If we know nothing, then get the full set.
295   if (TypeVec.empty())
296     return FillWithPossibleTypes(TP, isVector, "vector");
297
298   TypeSet InputSet(*this);
299   bool MadeChange = false;
300
301   // Filter out all the scalar types.
302   for (unsigned i = 0; i != TypeVec.size(); ++i)
303     if (!isVector(TypeVec[i])) {
304       TypeVec.erase(TypeVec.begin()+i--);
305       MadeChange = true;
306     }
307
308   if (TypeVec.empty())
309     TP.error("Type inference contradiction found, '" +
310              InputSet.getName() + "' needs to be a vector");
311   return MadeChange;
312 }
313
314
315
316 /// EnforceSmallerThan - 'this' must be a smaller VT than Other.  Update
317 /// this an other based on this information.
318 bool EEVT::TypeSet::EnforceSmallerThan(EEVT::TypeSet &Other, TreePattern &TP) {
319   // Both operands must be integer or FP, but we don't care which.
320   bool MadeChange = false;
321
322   if (isCompletelyUnknown())
323     MadeChange = FillWithPossibleTypes(TP);
324
325   if (Other.isCompletelyUnknown())
326     MadeChange = Other.FillWithPossibleTypes(TP);
327
328   // If one side is known to be integer or known to be FP but the other side has
329   // no information, get at least the type integrality info in there.
330   if (!hasFloatingPointTypes())
331     MadeChange |= Other.EnforceInteger(TP);
332   else if (!hasIntegerTypes())
333     MadeChange |= Other.EnforceFloatingPoint(TP);
334   if (!Other.hasFloatingPointTypes())
335     MadeChange |= EnforceInteger(TP);
336   else if (!Other.hasIntegerTypes())
337     MadeChange |= EnforceFloatingPoint(TP);
338
339   assert(!isCompletelyUnknown() && !Other.isCompletelyUnknown() &&
340          "Should have a type list now");
341
342   // If one contains vectors but the other doesn't pull vectors out.
343   if (!hasVectorTypes())
344     MadeChange |= Other.EnforceScalar(TP);
345   if (!hasVectorTypes())
346     MadeChange |= EnforceScalar(TP);
347
348   if (TypeVec.size() == 1 && Other.TypeVec.size() == 1) {
349     // If we are down to concrete types, this code does not currently
350     // handle nodes which have multiple types, where some types are
351     // integer, and some are fp.  Assert that this is not the case.
352     assert(!(hasIntegerTypes() && hasFloatingPointTypes()) &&
353            !(Other.hasIntegerTypes() && Other.hasFloatingPointTypes()) &&
354            "SDTCisOpSmallerThanOp does not handle mixed int/fp types!");
355
356     // Otherwise, if these are both vector types, either this vector
357     // must have a larger bitsize than the other, or this element type
358     // must be larger than the other.
359     EVT Type(TypeVec[0]);
360     EVT OtherType(Other.TypeVec[0]);
361
362     if (hasVectorTypes() && Other.hasVectorTypes()) {
363       if (Type.getSizeInBits() >= OtherType.getSizeInBits())
364         if (Type.getVectorElementType().getSizeInBits()
365             >= OtherType.getVectorElementType().getSizeInBits())
366           TP.error("Type inference contradiction found, '" +
367                    getName() + "' element type not smaller than '" +
368                    Other.getName() +"'!");
369     }
370     else
371       // For scalar types, the bitsize of this type must be larger
372       // than that of the other.
373       if (Type.getSizeInBits() >= OtherType.getSizeInBits())
374         TP.error("Type inference contradiction found, '" +
375                  getName() + "' is not smaller than '" +
376                  Other.getName() +"'!");
377
378   }
379   
380
381   // Handle int and fp as disjoint sets.  This won't work for patterns
382   // that have mixed fp/int types but those are likely rare and would
383   // not have been accepted by this code previously.
384
385   // Okay, find the smallest type from the current set and remove it from the
386   // largest set.
387   MVT::SimpleValueType SmallestInt = MVT::LAST_VALUETYPE;
388   for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
389     if (isInteger(TypeVec[i])) {
390       SmallestInt = TypeVec[i];
391       break;
392     }
393   for (unsigned i = 1, e = TypeVec.size(); i != e; ++i)
394     if (isInteger(TypeVec[i]) && TypeVec[i] < SmallestInt)
395       SmallestInt = TypeVec[i];
396
397   MVT::SimpleValueType SmallestFP = MVT::LAST_VALUETYPE;
398   for (unsigned i = 0, e = TypeVec.size(); i != e; ++i)
399     if (isFloatingPoint(TypeVec[i])) {
400       SmallestFP = TypeVec[i];
401       break;
402     }
403   for (unsigned i = 1, e = TypeVec.size(); i != e; ++i)
404     if (isFloatingPoint(TypeVec[i]) && TypeVec[i] < SmallestFP)
405       SmallestFP = TypeVec[i];
406
407   int OtherIntSize = 0;
408   int OtherFPSize = 0;
409   for (SmallVector<MVT::SimpleValueType, 2>::iterator TVI =
410          Other.TypeVec.begin();
411        TVI != Other.TypeVec.end();
412        /* NULL */) {
413     if (isInteger(*TVI)) {
414       ++OtherIntSize;
415       if (*TVI == SmallestInt) {
416         TVI = Other.TypeVec.erase(TVI);
417         --OtherIntSize;
418         MadeChange = true;
419         continue;
420       }
421     }
422     else if (isFloatingPoint(*TVI)) {
423       ++OtherFPSize;
424       if (*TVI == SmallestFP) {
425         TVI = Other.TypeVec.erase(TVI);
426         --OtherFPSize;
427         MadeChange = true;
428         continue;
429       }
430     }
431     ++TVI;
432   }
433
434   // If this is the only type in the large set, the constraint can never be
435   // satisfied.
436   if ((Other.hasIntegerTypes() && OtherIntSize == 0)
437       || (Other.hasFloatingPointTypes() && OtherFPSize == 0))
438     TP.error("Type inference contradiction found, '" +
439              Other.getName() + "' has nothing larger than '" + getName() +"'!");
440
441   // Okay, find the largest type in the Other set and remove it from the
442   // current set.
443   MVT::SimpleValueType LargestInt = MVT::Other;
444   for (unsigned i = 0, e = Other.TypeVec.size(); i != e; ++i)
445     if (isInteger(Other.TypeVec[i])) {
446       LargestInt = Other.TypeVec[i];
447       break;
448     }
449   for (unsigned i = 1, e = Other.TypeVec.size(); i != e; ++i)
450     if (isInteger(Other.TypeVec[i]) && Other.TypeVec[i] > LargestInt)
451       LargestInt = Other.TypeVec[i];
452
453   MVT::SimpleValueType LargestFP = MVT::Other;
454   for (unsigned i = 0, e = Other.TypeVec.size(); i != e; ++i)
455     if (isFloatingPoint(Other.TypeVec[i])) {
456       LargestFP = Other.TypeVec[i];
457       break;
458     }
459   for (unsigned i = 1, e = Other.TypeVec.size(); i != e; ++i)
460     if (isFloatingPoint(Other.TypeVec[i]) && Other.TypeVec[i] > LargestFP)
461       LargestFP = Other.TypeVec[i];
462
463   int IntSize = 0;
464   int FPSize = 0;
465   for (SmallVector<MVT::SimpleValueType, 2>::iterator TVI =
466          TypeVec.begin();
467        TVI != TypeVec.end();
468        /* NULL */) {
469     if (isInteger(*TVI)) {
470       ++IntSize;
471       if (*TVI == LargestInt) {
472         TVI = TypeVec.erase(TVI);
473         --IntSize;
474         MadeChange = true;
475         continue;
476       }
477     }
478     else if (isFloatingPoint(*TVI)) {
479       ++FPSize;
480       if (*TVI == LargestFP) {
481         TVI = TypeVec.erase(TVI);
482         --FPSize;
483         MadeChange = true;
484         continue;
485       }
486     }
487     ++TVI;
488   }
489
490   // If this is the only type in the small set, the constraint can never be
491   // satisfied.
492   if ((hasIntegerTypes() && IntSize == 0)
493       || (hasFloatingPointTypes() && FPSize == 0))
494     TP.error("Type inference contradiction found, '" +
495              getName() + "' has nothing smaller than '" + Other.getName()+"'!");
496
497   return MadeChange;
498 }
499
500 /// EnforceVectorEltTypeIs - 'this' is now constrainted to be a vector type
501 /// whose element is specified by VTOperand.
502 bool EEVT::TypeSet::EnforceVectorEltTypeIs(EEVT::TypeSet &VTOperand,
503                                            TreePattern &TP) {
504   // "This" must be a vector and "VTOperand" must be a scalar.
505   bool MadeChange = false;
506   MadeChange |= EnforceVector(TP);
507   MadeChange |= VTOperand.EnforceScalar(TP);
508
509   // If we know the vector type, it forces the scalar to agree.
510   if (isConcrete()) {
511     EVT IVT = getConcrete();
512     IVT = IVT.getVectorElementType();
513     return MadeChange |
514       VTOperand.MergeInTypeInfo(IVT.getSimpleVT().SimpleTy, TP);
515   }
516
517   // If the scalar type is known, filter out vector types whose element types
518   // disagree.
519   if (!VTOperand.isConcrete())
520     return MadeChange;
521
522   MVT::SimpleValueType VT = VTOperand.getConcrete();
523
524   TypeSet InputSet(*this);
525
526   // Filter out all the types which don't have the right element type.
527   for (unsigned i = 0; i != TypeVec.size(); ++i) {
528     assert(isVector(TypeVec[i]) && "EnforceVector didn't work");
529     if (EVT(TypeVec[i]).getVectorElementType().getSimpleVT().SimpleTy != VT) {
530       TypeVec.erase(TypeVec.begin()+i--);
531       MadeChange = true;
532     }
533   }
534
535   if (TypeVec.empty())  // FIXME: Really want an SMLoc here!
536     TP.error("Type inference contradiction found, forcing '" +
537              InputSet.getName() + "' to have a vector element");
538   return MadeChange;
539 }
540
541 /// EnforceVectorSubVectorTypeIs - 'this' is now constrainted to be a
542 /// vector type specified by VTOperand.
543 bool EEVT::TypeSet::EnforceVectorSubVectorTypeIs(EEVT::TypeSet &VTOperand,
544                                                  TreePattern &TP) {
545   // "This" must be a vector and "VTOperand" must be a vector.
546   bool MadeChange = false;
547   MadeChange |= EnforceVector(TP);
548   MadeChange |= VTOperand.EnforceVector(TP);
549
550   // "This" must be larger than "VTOperand."
551   MadeChange |= VTOperand.EnforceSmallerThan(*this, TP);
552
553   // If we know the vector type, it forces the scalar types to agree.
554   if (isConcrete()) {
555     EVT IVT = getConcrete();
556     IVT = IVT.getVectorElementType();
557
558     EEVT::TypeSet EltTypeSet(IVT.getSimpleVT().SimpleTy, TP);
559     MadeChange |= VTOperand.EnforceVectorEltTypeIs(EltTypeSet, TP);
560   } else if (VTOperand.isConcrete()) {
561     EVT IVT = VTOperand.getConcrete();
562     IVT = IVT.getVectorElementType();
563
564     EEVT::TypeSet EltTypeSet(IVT.getSimpleVT().SimpleTy, TP);
565     MadeChange |= EnforceVectorEltTypeIs(EltTypeSet, TP);
566   }
567
568   return MadeChange;
569 }
570
571 //===----------------------------------------------------------------------===//
572 // Helpers for working with extended types.
573
574 bool RecordPtrCmp::operator()(const Record *LHS, const Record *RHS) const {
575   return LHS->getID() < RHS->getID();
576 }
577
578 /// Dependent variable map for CodeGenDAGPattern variant generation
579 typedef std::map<std::string, int> DepVarMap;
580
581 /// Const iterator shorthand for DepVarMap
582 typedef DepVarMap::const_iterator DepVarMap_citer;
583
584 static void FindDepVarsOf(TreePatternNode *N, DepVarMap &DepMap) {
585   if (N->isLeaf()) {
586     if (dynamic_cast<const DefInit*>(N->getLeafValue()) != NULL)
587       DepMap[N->getName()]++;
588   } else {
589     for (size_t i = 0, e = N->getNumChildren(); i != e; ++i)
590       FindDepVarsOf(N->getChild(i), DepMap);
591   }
592 }
593   
594 /// Find dependent variables within child patterns
595 static void FindDepVars(TreePatternNode *N, MultipleUseVarSet &DepVars) {
596   DepVarMap depcounts;
597   FindDepVarsOf(N, depcounts);
598   for (DepVarMap_citer i = depcounts.begin(); i != depcounts.end(); ++i) {
599     if (i->second > 1)            // std::pair<std::string, int>
600       DepVars.insert(i->first);
601   }
602 }
603
604 #ifndef NDEBUG
605 /// Dump the dependent variable set:
606 static void DumpDepVars(MultipleUseVarSet &DepVars) {
607   if (DepVars.empty()) {
608     DEBUG(errs() << "<empty set>");
609   } else {
610     DEBUG(errs() << "[ ");
611     for (MultipleUseVarSet::const_iterator i = DepVars.begin(),
612          e = DepVars.end(); i != e; ++i) {
613       DEBUG(errs() << (*i) << " ");
614     }
615     DEBUG(errs() << "]");
616   }
617 }
618 #endif
619
620
621 //===----------------------------------------------------------------------===//
622 // TreePredicateFn Implementation
623 //===----------------------------------------------------------------------===//
624
625 /// TreePredicateFn constructor.  Here 'N' is a subclass of PatFrag.
626 TreePredicateFn::TreePredicateFn(TreePattern *N) : PatFragRec(N) {
627   assert((getPredCode().empty() || getImmCode().empty()) &&
628         ".td file corrupt: can't have a node predicate *and* an imm predicate");
629 }
630
631 std::string TreePredicateFn::getPredCode() const {
632   return PatFragRec->getRecord()->getValueAsCode("PredicateCode");
633 }
634
635 std::string TreePredicateFn::getImmCode() const {
636   return PatFragRec->getRecord()->getValueAsCode("ImmediateCode");
637 }
638
639
640 /// isAlwaysTrue - Return true if this is a noop predicate.
641 bool TreePredicateFn::isAlwaysTrue() const {
642   return getPredCode().empty() && getImmCode().empty();
643 }
644
645 /// Return the name to use in the generated code to reference this, this is
646 /// "Predicate_foo" if from a pattern fragment "foo".
647 std::string TreePredicateFn::getFnName() const {
648   return "Predicate_" + PatFragRec->getRecord()->getName();
649 }
650
651 /// getCodeToRunOnSDNode - Return the code for the function body that
652 /// evaluates this predicate.  The argument is expected to be in "Node",
653 /// not N.  This handles casting and conversion to a concrete node type as
654 /// appropriate.
655 std::string TreePredicateFn::getCodeToRunOnSDNode() const {
656   // Handle immediate predicates first.
657   std::string ImmCode = getImmCode();
658   if (!ImmCode.empty()) {
659     std::string Result =
660       "    int64_t Imm = cast<ConstantSDNode>(Node)->getSExtValue();\n";
661     return Result + ImmCode;
662   }
663   
664   // Handle arbitrary node predicates.
665   assert(!getPredCode().empty() && "Don't have any predicate code!");
666   std::string ClassName;
667   if (PatFragRec->getOnlyTree()->isLeaf())
668     ClassName = "SDNode";
669   else {
670     Record *Op = PatFragRec->getOnlyTree()->getOperator();
671     ClassName = PatFragRec->getDAGPatterns().getSDNodeInfo(Op).getSDClassName();
672   }
673   std::string Result;
674   if (ClassName == "SDNode")
675     Result = "    SDNode *N = Node;\n";
676   else
677     Result = "    " + ClassName + "*N = cast<" + ClassName + ">(Node);\n";
678   
679   return Result + getPredCode();
680 }
681
682 //===----------------------------------------------------------------------===//
683 // PatternToMatch implementation
684 //
685
686
687 /// getPatternSize - Return the 'size' of this pattern.  We want to match large
688 /// patterns before small ones.  This is used to determine the size of a
689 /// pattern.
690 static unsigned getPatternSize(const TreePatternNode *P,
691                                const CodeGenDAGPatterns &CGP) {
692   unsigned Size = 3;  // The node itself.
693   // If the root node is a ConstantSDNode, increases its size.
694   // e.g. (set R32:$dst, 0).
695   if (P->isLeaf() && dynamic_cast<const IntInit*>(P->getLeafValue()))
696     Size += 2;
697
698   // FIXME: This is a hack to statically increase the priority of patterns
699   // which maps a sub-dag to a complex pattern. e.g. favors LEA over ADD.
700   // Later we can allow complexity / cost for each pattern to be (optionally)
701   // specified. To get best possible pattern match we'll need to dynamically
702   // calculate the complexity of all patterns a dag can potentially map to.
703   const ComplexPattern *AM = P->getComplexPatternInfo(CGP);
704   if (AM)
705     Size += AM->getNumOperands() * 3;
706
707   // If this node has some predicate function that must match, it adds to the
708   // complexity of this node.
709   if (!P->getPredicateFns().empty())
710     ++Size;
711
712   // Count children in the count if they are also nodes.
713   for (unsigned i = 0, e = P->getNumChildren(); i != e; ++i) {
714     TreePatternNode *Child = P->getChild(i);
715     if (!Child->isLeaf() && Child->getNumTypes() &&
716         Child->getType(0) != MVT::Other)
717       Size += getPatternSize(Child, CGP);
718     else if (Child->isLeaf()) {
719       if (dynamic_cast<const IntInit*>(Child->getLeafValue()))
720         Size += 5;  // Matches a ConstantSDNode (+3) and a specific value (+2).
721       else if (Child->getComplexPatternInfo(CGP))
722         Size += getPatternSize(Child, CGP);
723       else if (!Child->getPredicateFns().empty())
724         ++Size;
725     }
726   }
727
728   return Size;
729 }
730
731 /// Compute the complexity metric for the input pattern.  This roughly
732 /// corresponds to the number of nodes that are covered.
733 unsigned PatternToMatch::
734 getPatternComplexity(const CodeGenDAGPatterns &CGP) const {
735   return getPatternSize(getSrcPattern(), CGP) + getAddedComplexity();
736 }
737
738
739 /// getPredicateCheck - Return a single string containing all of this
740 /// pattern's predicates concatenated with "&&" operators.
741 ///
742 std::string PatternToMatch::getPredicateCheck() const {
743   std::string PredicateCheck;
744   for (unsigned i = 0, e = Predicates->getSize(); i != e; ++i) {
745     if (const DefInit *Pred =
746         dynamic_cast<const DefInit*>(Predicates->getElement(i))) {
747       Record *Def = Pred->getDef();
748       if (!Def->isSubClassOf("Predicate")) {
749 #ifndef NDEBUG
750         Def->dump();
751 #endif
752         assert(0 && "Unknown predicate type!");
753       }
754       if (!PredicateCheck.empty())
755         PredicateCheck += " && ";
756       PredicateCheck += "(" + Def->getValueAsString("CondString") + ")";
757     }
758   }
759
760   return PredicateCheck;
761 }
762
763 //===----------------------------------------------------------------------===//
764 // SDTypeConstraint implementation
765 //
766
767 SDTypeConstraint::SDTypeConstraint(Record *R) {
768   OperandNo = R->getValueAsInt("OperandNum");
769
770   if (R->isSubClassOf("SDTCisVT")) {
771     ConstraintType = SDTCisVT;
772     x.SDTCisVT_Info.VT = getValueType(R->getValueAsDef("VT"));
773     if (x.SDTCisVT_Info.VT == MVT::isVoid)
774       throw TGError(R->getLoc(), "Cannot use 'Void' as type to SDTCisVT");
775
776   } else if (R->isSubClassOf("SDTCisPtrTy")) {
777     ConstraintType = SDTCisPtrTy;
778   } else if (R->isSubClassOf("SDTCisInt")) {
779     ConstraintType = SDTCisInt;
780   } else if (R->isSubClassOf("SDTCisFP")) {
781     ConstraintType = SDTCisFP;
782   } else if (R->isSubClassOf("SDTCisVec")) {
783     ConstraintType = SDTCisVec;
784   } else if (R->isSubClassOf("SDTCisSameAs")) {
785     ConstraintType = SDTCisSameAs;
786     x.SDTCisSameAs_Info.OtherOperandNum = R->getValueAsInt("OtherOperandNum");
787   } else if (R->isSubClassOf("SDTCisVTSmallerThanOp")) {
788     ConstraintType = SDTCisVTSmallerThanOp;
789     x.SDTCisVTSmallerThanOp_Info.OtherOperandNum =
790       R->getValueAsInt("OtherOperandNum");
791   } else if (R->isSubClassOf("SDTCisOpSmallerThanOp")) {
792     ConstraintType = SDTCisOpSmallerThanOp;
793     x.SDTCisOpSmallerThanOp_Info.BigOperandNum =
794       R->getValueAsInt("BigOperandNum");
795   } else if (R->isSubClassOf("SDTCisEltOfVec")) {
796     ConstraintType = SDTCisEltOfVec;
797     x.SDTCisEltOfVec_Info.OtherOperandNum = R->getValueAsInt("OtherOpNum");
798   } else if (R->isSubClassOf("SDTCisSubVecOfVec")) {
799     ConstraintType = SDTCisSubVecOfVec;
800     x.SDTCisSubVecOfVec_Info.OtherOperandNum =
801       R->getValueAsInt("OtherOpNum");
802   } else {
803     errs() << "Unrecognized SDTypeConstraint '" << R->getName() << "'!\n";
804     exit(1);
805   }
806 }
807
808 /// getOperandNum - Return the node corresponding to operand #OpNo in tree
809 /// N, and the result number in ResNo.
810 static TreePatternNode *getOperandNum(unsigned OpNo, TreePatternNode *N,
811                                       const SDNodeInfo &NodeInfo,
812                                       unsigned &ResNo) {
813   unsigned NumResults = NodeInfo.getNumResults();
814   if (OpNo < NumResults) {
815     ResNo = OpNo;
816     return N;
817   }
818
819   OpNo -= NumResults;
820
821   if (OpNo >= N->getNumChildren()) {
822     errs() << "Invalid operand number in type constraint "
823            << (OpNo+NumResults) << " ";
824     N->dump();
825     errs() << '\n';
826     exit(1);
827   }
828
829   return N->getChild(OpNo);
830 }
831
832 /// ApplyTypeConstraint - Given a node in a pattern, apply this type
833 /// constraint to the nodes operands.  This returns true if it makes a
834 /// change, false otherwise.  If a type contradiction is found, throw an
835 /// exception.
836 bool SDTypeConstraint::ApplyTypeConstraint(TreePatternNode *N,
837                                            const SDNodeInfo &NodeInfo,
838                                            TreePattern &TP) const {
839   unsigned ResNo = 0; // The result number being referenced.
840   TreePatternNode *NodeToApply = getOperandNum(OperandNo, N, NodeInfo, ResNo);
841
842   switch (ConstraintType) {
843   default: assert(0 && "Unknown constraint type!");
844   case SDTCisVT:
845     // Operand must be a particular type.
846     return NodeToApply->UpdateNodeType(ResNo, x.SDTCisVT_Info.VT, TP);
847   case SDTCisPtrTy:
848     // Operand must be same as target pointer type.
849     return NodeToApply->UpdateNodeType(ResNo, MVT::iPTR, TP);
850   case SDTCisInt:
851     // Require it to be one of the legal integer VTs.
852     return NodeToApply->getExtType(ResNo).EnforceInteger(TP);
853   case SDTCisFP:
854     // Require it to be one of the legal fp VTs.
855     return NodeToApply->getExtType(ResNo).EnforceFloatingPoint(TP);
856   case SDTCisVec:
857     // Require it to be one of the legal vector VTs.
858     return NodeToApply->getExtType(ResNo).EnforceVector(TP);
859   case SDTCisSameAs: {
860     unsigned OResNo = 0;
861     TreePatternNode *OtherNode =
862       getOperandNum(x.SDTCisSameAs_Info.OtherOperandNum, N, NodeInfo, OResNo);
863     return NodeToApply->UpdateNodeType(OResNo, OtherNode->getExtType(ResNo),TP)|
864            OtherNode->UpdateNodeType(ResNo,NodeToApply->getExtType(OResNo),TP);
865   }
866   case SDTCisVTSmallerThanOp: {
867     // The NodeToApply must be a leaf node that is a VT.  OtherOperandNum must
868     // have an integer type that is smaller than the VT.
869     if (!NodeToApply->isLeaf() ||
870         !dynamic_cast<const DefInit*>(NodeToApply->getLeafValue()) ||
871         !static_cast<const DefInit*>(NodeToApply->getLeafValue())->getDef()
872                ->isSubClassOf("ValueType"))
873       TP.error(N->getOperator()->getName() + " expects a VT operand!");
874     MVT::SimpleValueType VT =
875       getValueType(static_cast<const DefInit*>(NodeToApply->getLeafValue())
876                    ->getDef());
877
878     EEVT::TypeSet TypeListTmp(VT, TP);
879
880     unsigned OResNo = 0;
881     TreePatternNode *OtherNode =
882       getOperandNum(x.SDTCisVTSmallerThanOp_Info.OtherOperandNum, N, NodeInfo,
883                     OResNo);
884
885     return TypeListTmp.EnforceSmallerThan(OtherNode->getExtType(OResNo), TP);
886   }
887   case SDTCisOpSmallerThanOp: {
888     unsigned BResNo = 0;
889     TreePatternNode *BigOperand =
890       getOperandNum(x.SDTCisOpSmallerThanOp_Info.BigOperandNum, N, NodeInfo,
891                     BResNo);
892     return NodeToApply->getExtType(ResNo).
893                   EnforceSmallerThan(BigOperand->getExtType(BResNo), TP);
894   }
895   case SDTCisEltOfVec: {
896     unsigned VResNo = 0;
897     TreePatternNode *VecOperand =
898       getOperandNum(x.SDTCisEltOfVec_Info.OtherOperandNum, N, NodeInfo,
899                     VResNo);
900
901     // Filter vector types out of VecOperand that don't have the right element
902     // type.
903     return VecOperand->getExtType(VResNo).
904       EnforceVectorEltTypeIs(NodeToApply->getExtType(ResNo), TP);
905   }
906   case SDTCisSubVecOfVec: {
907     unsigned VResNo = 0;
908     TreePatternNode *BigVecOperand =
909       getOperandNum(x.SDTCisSubVecOfVec_Info.OtherOperandNum, N, NodeInfo,
910                     VResNo);
911
912     // Filter vector types out of BigVecOperand that don't have the
913     // right subvector type.
914     return BigVecOperand->getExtType(VResNo).
915       EnforceVectorSubVectorTypeIs(NodeToApply->getExtType(ResNo), TP);
916   }
917   }
918   return false;
919 }
920
921 //===----------------------------------------------------------------------===//
922 // SDNodeInfo implementation
923 //
924 SDNodeInfo::SDNodeInfo(Record *R) : Def(R) {
925   EnumName    = R->getValueAsString("Opcode");
926   SDClassName = R->getValueAsString("SDClass");
927   Record *TypeProfile = R->getValueAsDef("TypeProfile");
928   NumResults = TypeProfile->getValueAsInt("NumResults");
929   NumOperands = TypeProfile->getValueAsInt("NumOperands");
930
931   // Parse the properties.
932   Properties = 0;
933   std::vector<Record*> PropList = R->getValueAsListOfDefs("Properties");
934   for (unsigned i = 0, e = PropList.size(); i != e; ++i) {
935     if (PropList[i]->getName() == "SDNPCommutative") {
936       Properties |= 1 << SDNPCommutative;
937     } else if (PropList[i]->getName() == "SDNPAssociative") {
938       Properties |= 1 << SDNPAssociative;
939     } else if (PropList[i]->getName() == "SDNPHasChain") {
940       Properties |= 1 << SDNPHasChain;
941     } else if (PropList[i]->getName() == "SDNPOutGlue") {
942       Properties |= 1 << SDNPOutGlue;
943     } else if (PropList[i]->getName() == "SDNPInGlue") {
944       Properties |= 1 << SDNPInGlue;
945     } else if (PropList[i]->getName() == "SDNPOptInGlue") {
946       Properties |= 1 << SDNPOptInGlue;
947     } else if (PropList[i]->getName() == "SDNPMayStore") {
948       Properties |= 1 << SDNPMayStore;
949     } else if (PropList[i]->getName() == "SDNPMayLoad") {
950       Properties |= 1 << SDNPMayLoad;
951     } else if (PropList[i]->getName() == "SDNPSideEffect") {
952       Properties |= 1 << SDNPSideEffect;
953     } else if (PropList[i]->getName() == "SDNPMemOperand") {
954       Properties |= 1 << SDNPMemOperand;
955     } else if (PropList[i]->getName() == "SDNPVariadic") {
956       Properties |= 1 << SDNPVariadic;
957     } else {
958       errs() << "Unknown SD Node property '" << PropList[i]->getName()
959              << "' on node '" << R->getName() << "'!\n";
960       exit(1);
961     }
962   }
963
964
965   // Parse the type constraints.
966   std::vector<Record*> ConstraintList =
967     TypeProfile->getValueAsListOfDefs("Constraints");
968   TypeConstraints.assign(ConstraintList.begin(), ConstraintList.end());
969 }
970
971 /// getKnownType - If the type constraints on this node imply a fixed type
972 /// (e.g. all stores return void, etc), then return it as an
973 /// MVT::SimpleValueType.  Otherwise, return EEVT::Other.
974 MVT::SimpleValueType SDNodeInfo::getKnownType(unsigned ResNo) const {
975   unsigned NumResults = getNumResults();
976   assert(NumResults <= 1 &&
977          "We only work with nodes with zero or one result so far!");
978   assert(ResNo == 0 && "Only handles single result nodes so far");
979
980   for (unsigned i = 0, e = TypeConstraints.size(); i != e; ++i) {
981     // Make sure that this applies to the correct node result.
982     if (TypeConstraints[i].OperandNo >= NumResults)  // FIXME: need value #
983       continue;
984
985     switch (TypeConstraints[i].ConstraintType) {
986     default: break;
987     case SDTypeConstraint::SDTCisVT:
988       return TypeConstraints[i].x.SDTCisVT_Info.VT;
989     case SDTypeConstraint::SDTCisPtrTy:
990       return MVT::iPTR;
991     }
992   }
993   return MVT::Other;
994 }
995
996 //===----------------------------------------------------------------------===//
997 // TreePatternNode implementation
998 //
999
1000 TreePatternNode::~TreePatternNode() {
1001 #if 0 // FIXME: implement refcounted tree nodes!
1002   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1003     delete getChild(i);
1004 #endif
1005 }
1006
1007 static unsigned GetNumNodeResults(Record *Operator, CodeGenDAGPatterns &CDP) {
1008   if (Operator->getName() == "set" ||
1009       Operator->getName() == "implicit")
1010     return 0;  // All return nothing.
1011
1012   if (Operator->isSubClassOf("Intrinsic"))
1013     return CDP.getIntrinsic(Operator).IS.RetVTs.size();
1014
1015   if (Operator->isSubClassOf("SDNode"))
1016     return CDP.getSDNodeInfo(Operator).getNumResults();
1017
1018   if (Operator->isSubClassOf("PatFrag")) {
1019     // If we've already parsed this pattern fragment, get it.  Otherwise, handle
1020     // the forward reference case where one pattern fragment references another
1021     // before it is processed.
1022     if (TreePattern *PFRec = CDP.getPatternFragmentIfRead(Operator))
1023       return PFRec->getOnlyTree()->getNumTypes();
1024
1025     // Get the result tree.
1026     const DagInit *Tree = Operator->getValueAsDag("Fragment");
1027     Record *Op = 0;
1028     if (Tree && dynamic_cast<const DefInit*>(Tree->getOperator()))
1029       Op = dynamic_cast<const DefInit*>(Tree->getOperator())->getDef();
1030     assert(Op && "Invalid Fragment");
1031     return GetNumNodeResults(Op, CDP);
1032   }
1033
1034   if (Operator->isSubClassOf("Instruction")) {
1035     CodeGenInstruction &InstInfo = CDP.getTargetInfo().getInstruction(Operator);
1036
1037     // FIXME: Should allow access to all the results here.
1038     unsigned NumDefsToAdd = InstInfo.Operands.NumDefs ? 1 : 0;
1039
1040     // Add on one implicit def if it has a resolvable type.
1041     if (InstInfo.HasOneImplicitDefWithKnownVT(CDP.getTargetInfo()) !=MVT::Other)
1042       ++NumDefsToAdd;
1043     return NumDefsToAdd;
1044   }
1045
1046   if (Operator->isSubClassOf("SDNodeXForm"))
1047     return 1;  // FIXME: Generalize SDNodeXForm
1048
1049   Operator->dump();
1050   errs() << "Unhandled node in GetNumNodeResults\n";
1051   exit(1);
1052 }
1053
1054 void TreePatternNode::print(raw_ostream &OS) const {
1055   if (isLeaf())
1056     OS << *getLeafValue();
1057   else
1058     OS << '(' << getOperator()->getName();
1059
1060   for (unsigned i = 0, e = Types.size(); i != e; ++i)
1061     OS << ':' << getExtType(i).getName();
1062
1063   if (!isLeaf()) {
1064     if (getNumChildren() != 0) {
1065       OS << " ";
1066       getChild(0)->print(OS);
1067       for (unsigned i = 1, e = getNumChildren(); i != e; ++i) {
1068         OS << ", ";
1069         getChild(i)->print(OS);
1070       }
1071     }
1072     OS << ")";
1073   }
1074
1075   for (unsigned i = 0, e = PredicateFns.size(); i != e; ++i)
1076     OS << "<<P:" << PredicateFns[i].getFnName() << ">>";
1077   if (TransformFn)
1078     OS << "<<X:" << TransformFn->getName() << ">>";
1079   if (!getName().empty())
1080     OS << ":$" << getName();
1081
1082 }
1083 void TreePatternNode::dump() const {
1084   print(errs());
1085 }
1086
1087 /// isIsomorphicTo - Return true if this node is recursively
1088 /// isomorphic to the specified node.  For this comparison, the node's
1089 /// entire state is considered. The assigned name is ignored, since
1090 /// nodes with differing names are considered isomorphic. However, if
1091 /// the assigned name is present in the dependent variable set, then
1092 /// the assigned name is considered significant and the node is
1093 /// isomorphic if the names match.
1094 bool TreePatternNode::isIsomorphicTo(const TreePatternNode *N,
1095                                      const MultipleUseVarSet &DepVars) const {
1096   if (N == this) return true;
1097   if (N->isLeaf() != isLeaf() || getExtTypes() != N->getExtTypes() ||
1098       getPredicateFns() != N->getPredicateFns() ||
1099       getTransformFn() != N->getTransformFn())
1100     return false;
1101
1102   if (isLeaf()) {
1103     if (const DefInit *DI = dynamic_cast<const DefInit*>(getLeafValue())) {
1104       if (const DefInit *NDI = dynamic_cast<const DefInit*>(N->getLeafValue())) {
1105         return ((DI->getDef() == NDI->getDef())
1106                 && (DepVars.find(getName()) == DepVars.end()
1107                     || getName() == N->getName()));
1108       }
1109     }
1110     return getLeafValue() == N->getLeafValue();
1111   }
1112
1113   if (N->getOperator() != getOperator() ||
1114       N->getNumChildren() != getNumChildren()) return false;
1115   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1116     if (!getChild(i)->isIsomorphicTo(N->getChild(i), DepVars))
1117       return false;
1118   return true;
1119 }
1120
1121 /// clone - Make a copy of this tree and all of its children.
1122 ///
1123 TreePatternNode *TreePatternNode::clone() const {
1124   TreePatternNode *New;
1125   if (isLeaf()) {
1126     New = new TreePatternNode(getLeafValue(), getNumTypes());
1127   } else {
1128     std::vector<TreePatternNode*> CChildren;
1129     CChildren.reserve(Children.size());
1130     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1131       CChildren.push_back(getChild(i)->clone());
1132     New = new TreePatternNode(getOperator(), CChildren, getNumTypes());
1133   }
1134   New->setName(getName());
1135   New->Types = Types;
1136   New->setPredicateFns(getPredicateFns());
1137   New->setTransformFn(getTransformFn());
1138   return New;
1139 }
1140
1141 /// RemoveAllTypes - Recursively strip all the types of this tree.
1142 void TreePatternNode::RemoveAllTypes() {
1143   for (unsigned i = 0, e = Types.size(); i != e; ++i)
1144     Types[i] = EEVT::TypeSet();  // Reset to unknown type.
1145   if (isLeaf()) return;
1146   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1147     getChild(i)->RemoveAllTypes();
1148 }
1149
1150
1151 /// SubstituteFormalArguments - Replace the formal arguments in this tree
1152 /// with actual values specified by ArgMap.
1153 void TreePatternNode::
1154 SubstituteFormalArguments(std::map<std::string, TreePatternNode*> &ArgMap) {
1155   if (isLeaf()) return;
1156
1157   for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
1158     TreePatternNode *Child = getChild(i);
1159     if (Child->isLeaf()) {
1160       const Init *Val = Child->getLeafValue();
1161       if (dynamic_cast<const DefInit*>(Val) &&
1162           static_cast<const DefInit*>(Val)->getDef()->getName() == "node") {
1163         // We found a use of a formal argument, replace it with its value.
1164         TreePatternNode *NewChild = ArgMap[Child->getName()];
1165         assert(NewChild && "Couldn't find formal argument!");
1166         assert((Child->getPredicateFns().empty() ||
1167                 NewChild->getPredicateFns() == Child->getPredicateFns()) &&
1168                "Non-empty child predicate clobbered!");
1169         setChild(i, NewChild);
1170       }
1171     } else {
1172       getChild(i)->SubstituteFormalArguments(ArgMap);
1173     }
1174   }
1175 }
1176
1177
1178 /// InlinePatternFragments - If this pattern refers to any pattern
1179 /// fragments, inline them into place, giving us a pattern without any
1180 /// PatFrag references.
1181 TreePatternNode *TreePatternNode::InlinePatternFragments(TreePattern &TP) {
1182   if (isLeaf()) return this;  // nothing to do.
1183   Record *Op = getOperator();
1184
1185   if (!Op->isSubClassOf("PatFrag")) {
1186     // Just recursively inline children nodes.
1187     for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
1188       TreePatternNode *Child = getChild(i);
1189       TreePatternNode *NewChild = Child->InlinePatternFragments(TP);
1190
1191       assert((Child->getPredicateFns().empty() ||
1192               NewChild->getPredicateFns() == Child->getPredicateFns()) &&
1193              "Non-empty child predicate clobbered!");
1194
1195       setChild(i, NewChild);
1196     }
1197     return this;
1198   }
1199
1200   // Otherwise, we found a reference to a fragment.  First, look up its
1201   // TreePattern record.
1202   TreePattern *Frag = TP.getDAGPatterns().getPatternFragment(Op);
1203
1204   // Verify that we are passing the right number of operands.
1205   if (Frag->getNumArgs() != Children.size())
1206     TP.error("'" + Op->getName() + "' fragment requires " +
1207              utostr(Frag->getNumArgs()) + " operands!");
1208
1209   TreePatternNode *FragTree = Frag->getOnlyTree()->clone();
1210
1211   TreePredicateFn PredFn(Frag);
1212   if (!PredFn.isAlwaysTrue())
1213     FragTree->addPredicateFn(PredFn);
1214
1215   // Resolve formal arguments to their actual value.
1216   if (Frag->getNumArgs()) {
1217     // Compute the map of formal to actual arguments.
1218     std::map<std::string, TreePatternNode*> ArgMap;
1219     for (unsigned i = 0, e = Frag->getNumArgs(); i != e; ++i)
1220       ArgMap[Frag->getArgName(i)] = getChild(i)->InlinePatternFragments(TP);
1221
1222     FragTree->SubstituteFormalArguments(ArgMap);
1223   }
1224
1225   FragTree->setName(getName());
1226   for (unsigned i = 0, e = Types.size(); i != e; ++i)
1227     FragTree->UpdateNodeType(i, getExtType(i), TP);
1228
1229   // Transfer in the old predicates.
1230   for (unsigned i = 0, e = getPredicateFns().size(); i != e; ++i)
1231     FragTree->addPredicateFn(getPredicateFns()[i]);
1232
1233   // Get a new copy of this fragment to stitch into here.
1234   //delete this;    // FIXME: implement refcounting!
1235
1236   // The fragment we inlined could have recursive inlining that is needed.  See
1237   // if there are any pattern fragments in it and inline them as needed.
1238   return FragTree->InlinePatternFragments(TP);
1239 }
1240
1241 /// getImplicitType - Check to see if the specified record has an implicit
1242 /// type which should be applied to it.  This will infer the type of register
1243 /// references from the register file information, for example.
1244 ///
1245 static EEVT::TypeSet getImplicitType(Record *R, unsigned ResNo,
1246                                      bool NotRegisters, TreePattern &TP) {
1247   // Check to see if this is a register operand.
1248   if (R->isSubClassOf("RegisterOperand")) {
1249     assert(ResNo == 0 && "Regoperand ref only has one result!");
1250     if (NotRegisters)
1251       return EEVT::TypeSet(); // Unknown.
1252     Record *RegClass = R->getValueAsDef("RegClass");
1253     const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
1254     return EEVT::TypeSet(T.getRegisterClass(RegClass).getValueTypes());
1255   }
1256
1257   // Check to see if this is a register or a register class.
1258   if (R->isSubClassOf("RegisterClass")) {
1259     assert(ResNo == 0 && "Regclass ref only has one result!");
1260     if (NotRegisters)
1261       return EEVT::TypeSet(); // Unknown.
1262     const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
1263     return EEVT::TypeSet(T.getRegisterClass(R).getValueTypes());
1264   }
1265
1266   if (R->isSubClassOf("PatFrag")) {
1267     assert(ResNo == 0 && "FIXME: PatFrag with multiple results?");
1268     // Pattern fragment types will be resolved when they are inlined.
1269     return EEVT::TypeSet(); // Unknown.
1270   }
1271
1272   if (R->isSubClassOf("Register")) {
1273     assert(ResNo == 0 && "Registers only produce one result!");
1274     if (NotRegisters)
1275       return EEVT::TypeSet(); // Unknown.
1276     const CodeGenTarget &T = TP.getDAGPatterns().getTargetInfo();
1277     return EEVT::TypeSet(T.getRegisterVTs(R));
1278   }
1279
1280   if (R->isSubClassOf("SubRegIndex")) {
1281     assert(ResNo == 0 && "SubRegisterIndices only produce one result!");
1282     return EEVT::TypeSet();
1283   }
1284
1285   if (R->isSubClassOf("ValueType") || R->isSubClassOf("CondCode")) {
1286     assert(ResNo == 0 && "This node only has one result!");
1287     // Using a VTSDNode or CondCodeSDNode.
1288     return EEVT::TypeSet(MVT::Other, TP);
1289   }
1290
1291   if (R->isSubClassOf("ComplexPattern")) {
1292     assert(ResNo == 0 && "FIXME: ComplexPattern with multiple results?");
1293     if (NotRegisters)
1294       return EEVT::TypeSet(); // Unknown.
1295    return EEVT::TypeSet(TP.getDAGPatterns().getComplexPattern(R).getValueType(),
1296                          TP);
1297   }
1298   if (R->isSubClassOf("PointerLikeRegClass")) {
1299     assert(ResNo == 0 && "Regclass can only have one result!");
1300     return EEVT::TypeSet(MVT::iPTR, TP);
1301   }
1302
1303   if (R->getName() == "node" || R->getName() == "srcvalue" ||
1304       R->getName() == "zero_reg") {
1305     // Placeholder.
1306     return EEVT::TypeSet(); // Unknown.
1307   }
1308
1309   TP.error("Unknown node flavor used in pattern: " + R->getName());
1310   return EEVT::TypeSet(MVT::Other, TP);
1311 }
1312
1313
1314 /// getIntrinsicInfo - If this node corresponds to an intrinsic, return the
1315 /// CodeGenIntrinsic information for it, otherwise return a null pointer.
1316 const CodeGenIntrinsic *TreePatternNode::
1317 getIntrinsicInfo(const CodeGenDAGPatterns &CDP) const {
1318   if (getOperator() != CDP.get_intrinsic_void_sdnode() &&
1319       getOperator() != CDP.get_intrinsic_w_chain_sdnode() &&
1320       getOperator() != CDP.get_intrinsic_wo_chain_sdnode())
1321     return 0;
1322
1323   unsigned IID =
1324     dynamic_cast<const IntInit*>(getChild(0)->getLeafValue())->getValue();
1325   return &CDP.getIntrinsicInfo(IID);
1326 }
1327
1328 /// getComplexPatternInfo - If this node corresponds to a ComplexPattern,
1329 /// return the ComplexPattern information, otherwise return null.
1330 const ComplexPattern *
1331 TreePatternNode::getComplexPatternInfo(const CodeGenDAGPatterns &CGP) const {
1332   if (!isLeaf()) return 0;
1333
1334   const DefInit *DI = dynamic_cast<const DefInit*>(getLeafValue());
1335   if (DI && DI->getDef()->isSubClassOf("ComplexPattern"))
1336     return &CGP.getComplexPattern(DI->getDef());
1337   return 0;
1338 }
1339
1340 /// NodeHasProperty - Return true if this node has the specified property.
1341 bool TreePatternNode::NodeHasProperty(SDNP Property,
1342                                       const CodeGenDAGPatterns &CGP) const {
1343   if (isLeaf()) {
1344     if (const ComplexPattern *CP = getComplexPatternInfo(CGP))
1345       return CP->hasProperty(Property);
1346     return false;
1347   }
1348
1349   Record *Operator = getOperator();
1350   if (!Operator->isSubClassOf("SDNode")) return false;
1351
1352   return CGP.getSDNodeInfo(Operator).hasProperty(Property);
1353 }
1354
1355
1356
1357
1358 /// TreeHasProperty - Return true if any node in this tree has the specified
1359 /// property.
1360 bool TreePatternNode::TreeHasProperty(SDNP Property,
1361                                       const CodeGenDAGPatterns &CGP) const {
1362   if (NodeHasProperty(Property, CGP))
1363     return true;
1364   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1365     if (getChild(i)->TreeHasProperty(Property, CGP))
1366       return true;
1367   return false;
1368 }
1369
1370 /// isCommutativeIntrinsic - Return true if the node corresponds to a
1371 /// commutative intrinsic.
1372 bool
1373 TreePatternNode::isCommutativeIntrinsic(const CodeGenDAGPatterns &CDP) const {
1374   if (const CodeGenIntrinsic *Int = getIntrinsicInfo(CDP))
1375     return Int->isCommutative;
1376   return false;
1377 }
1378
1379
1380 /// ApplyTypeConstraints - Apply all of the type constraints relevant to
1381 /// this node and its children in the tree.  This returns true if it makes a
1382 /// change, false otherwise.  If a type contradiction is found, throw an
1383 /// exception.
1384 bool TreePatternNode::ApplyTypeConstraints(TreePattern &TP, bool NotRegisters) {
1385   CodeGenDAGPatterns &CDP = TP.getDAGPatterns();
1386   if (isLeaf()) {
1387     if (const DefInit *DI = dynamic_cast<const DefInit*>(getLeafValue())) {
1388       // If it's a regclass or something else known, include the type.
1389       bool MadeChange = false;
1390       for (unsigned i = 0, e = Types.size(); i != e; ++i)
1391         MadeChange |= UpdateNodeType(i, getImplicitType(DI->getDef(), i,
1392                                                         NotRegisters, TP), TP);
1393       return MadeChange;
1394     }
1395
1396     if (const IntInit *II = dynamic_cast<const IntInit*>(getLeafValue())) {
1397       assert(Types.size() == 1 && "Invalid IntInit");
1398
1399       // Int inits are always integers. :)
1400       bool MadeChange = Types[0].EnforceInteger(TP);
1401
1402       if (!Types[0].isConcrete())
1403         return MadeChange;
1404
1405       MVT::SimpleValueType VT = getType(0);
1406       if (VT == MVT::iPTR || VT == MVT::iPTRAny)
1407         return MadeChange;
1408
1409       unsigned Size = EVT(VT).getSizeInBits();
1410       // Make sure that the value is representable for this type.
1411       if (Size >= 32) return MadeChange;
1412
1413       int Val = (II->getValue() << (32-Size)) >> (32-Size);
1414       if (Val == II->getValue()) return MadeChange;
1415
1416       // If sign-extended doesn't fit, does it fit as unsigned?
1417       unsigned ValueMask;
1418       unsigned UnsignedVal;
1419       ValueMask = unsigned(~uint32_t(0UL) >> (32-Size));
1420       UnsignedVal = unsigned(II->getValue());
1421
1422       if ((ValueMask & UnsignedVal) == UnsignedVal)
1423         return MadeChange;
1424
1425       TP.error("Integer value '" + itostr(II->getValue())+
1426                "' is out of range for type '" + getEnumName(getType(0)) + "'!");
1427       return MadeChange;
1428     }
1429     return false;
1430   }
1431
1432   // special handling for set, which isn't really an SDNode.
1433   if (getOperator()->getName() == "set") {
1434     assert(getNumTypes() == 0 && "Set doesn't produce a value");
1435     assert(getNumChildren() >= 2 && "Missing RHS of a set?");
1436     unsigned NC = getNumChildren();
1437
1438     TreePatternNode *SetVal = getChild(NC-1);
1439     bool MadeChange = SetVal->ApplyTypeConstraints(TP, NotRegisters);
1440
1441     for (unsigned i = 0; i < NC-1; ++i) {
1442       TreePatternNode *Child = getChild(i);
1443       MadeChange |= Child->ApplyTypeConstraints(TP, NotRegisters);
1444
1445       // Types of operands must match.
1446       MadeChange |= Child->UpdateNodeType(0, SetVal->getExtType(i), TP);
1447       MadeChange |= SetVal->UpdateNodeType(i, Child->getExtType(0), TP);
1448     }
1449     return MadeChange;
1450   }
1451
1452   if (getOperator()->getName() == "implicit") {
1453     assert(getNumTypes() == 0 && "Node doesn't produce a value");
1454
1455     bool MadeChange = false;
1456     for (unsigned i = 0; i < getNumChildren(); ++i)
1457       MadeChange = getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
1458     return MadeChange;
1459   }
1460
1461   if (getOperator()->getName() == "COPY_TO_REGCLASS") {
1462     bool MadeChange = false;
1463     MadeChange |= getChild(0)->ApplyTypeConstraints(TP, NotRegisters);
1464     MadeChange |= getChild(1)->ApplyTypeConstraints(TP, NotRegisters);
1465
1466     assert(getChild(0)->getNumTypes() == 1 &&
1467            getChild(1)->getNumTypes() == 1 && "Unhandled case");
1468
1469     // child #1 of COPY_TO_REGCLASS should be a register class.  We don't care
1470     // what type it gets, so if it didn't get a concrete type just give it the
1471     // first viable type from the reg class.
1472     if (!getChild(1)->hasTypeSet(0) &&
1473         !getChild(1)->getExtType(0).isCompletelyUnknown()) {
1474       MVT::SimpleValueType RCVT = getChild(1)->getExtType(0).getTypeList()[0];
1475       MadeChange |= getChild(1)->UpdateNodeType(0, RCVT, TP);
1476     }
1477     return MadeChange;
1478   }
1479
1480   if (const CodeGenIntrinsic *Int = getIntrinsicInfo(CDP)) {
1481     bool MadeChange = false;
1482
1483     // Apply the result type to the node.
1484     unsigned NumRetVTs = Int->IS.RetVTs.size();
1485     unsigned NumParamVTs = Int->IS.ParamVTs.size();
1486
1487     for (unsigned i = 0, e = NumRetVTs; i != e; ++i)
1488       MadeChange |= UpdateNodeType(i, Int->IS.RetVTs[i], TP);
1489
1490     if (getNumChildren() != NumParamVTs + 1)
1491       TP.error("Intrinsic '" + Int->Name + "' expects " +
1492                utostr(NumParamVTs) + " operands, not " +
1493                utostr(getNumChildren() - 1) + " operands!");
1494
1495     // Apply type info to the intrinsic ID.
1496     MadeChange |= getChild(0)->UpdateNodeType(0, MVT::iPTR, TP);
1497
1498     for (unsigned i = 0, e = getNumChildren()-1; i != e; ++i) {
1499       MadeChange |= getChild(i+1)->ApplyTypeConstraints(TP, NotRegisters);
1500
1501       MVT::SimpleValueType OpVT = Int->IS.ParamVTs[i];
1502       assert(getChild(i+1)->getNumTypes() == 1 && "Unhandled case");
1503       MadeChange |= getChild(i+1)->UpdateNodeType(0, OpVT, TP);
1504     }
1505     return MadeChange;
1506   }
1507
1508   if (getOperator()->isSubClassOf("SDNode")) {
1509     const SDNodeInfo &NI = CDP.getSDNodeInfo(getOperator());
1510
1511     // Check that the number of operands is sane.  Negative operands -> varargs.
1512     if (NI.getNumOperands() >= 0 &&
1513         getNumChildren() != (unsigned)NI.getNumOperands())
1514       TP.error(getOperator()->getName() + " node requires exactly " +
1515                itostr(NI.getNumOperands()) + " operands!");
1516
1517     bool MadeChange = NI.ApplyTypeConstraints(this, TP);
1518     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1519       MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
1520     return MadeChange;
1521   }
1522
1523   if (getOperator()->isSubClassOf("Instruction")) {
1524     const DAGInstruction &Inst = CDP.getInstruction(getOperator());
1525     CodeGenInstruction &InstInfo =
1526       CDP.getTargetInfo().getInstruction(getOperator());
1527
1528     bool MadeChange = false;
1529
1530     // Apply the result types to the node, these come from the things in the
1531     // (outs) list of the instruction.
1532     // FIXME: Cap at one result so far.
1533     unsigned NumResultsToAdd = InstInfo.Operands.NumDefs ? 1 : 0;
1534     for (unsigned ResNo = 0; ResNo != NumResultsToAdd; ++ResNo) {
1535       Record *ResultNode = Inst.getResult(ResNo);
1536
1537       if (ResultNode->isSubClassOf("PointerLikeRegClass")) {
1538         MadeChange |= UpdateNodeType(ResNo, MVT::iPTR, TP);
1539       } else if (ResultNode->isSubClassOf("RegisterOperand")) {
1540         Record *RegClass = ResultNode->getValueAsDef("RegClass");
1541         const CodeGenRegisterClass &RC =
1542           CDP.getTargetInfo().getRegisterClass(RegClass);
1543         MadeChange |= UpdateNodeType(ResNo, RC.getValueTypes(), TP);
1544       } else if (ResultNode->getName() == "unknown") {
1545         // Nothing to do.
1546       } else {
1547         assert(ResultNode->isSubClassOf("RegisterClass") &&
1548                "Operands should be register classes!");
1549         const CodeGenRegisterClass &RC =
1550           CDP.getTargetInfo().getRegisterClass(ResultNode);
1551         MadeChange |= UpdateNodeType(ResNo, RC.getValueTypes(), TP);
1552       }
1553     }
1554
1555     // If the instruction has implicit defs, we apply the first one as a result.
1556     // FIXME: This sucks, it should apply all implicit defs.
1557     if (!InstInfo.ImplicitDefs.empty()) {
1558       unsigned ResNo = NumResultsToAdd;
1559
1560       // FIXME: Generalize to multiple possible types and multiple possible
1561       // ImplicitDefs.
1562       MVT::SimpleValueType VT =
1563         InstInfo.HasOneImplicitDefWithKnownVT(CDP.getTargetInfo());
1564
1565       if (VT != MVT::Other)
1566         MadeChange |= UpdateNodeType(ResNo, VT, TP);
1567     }
1568
1569     // If this is an INSERT_SUBREG, constrain the source and destination VTs to
1570     // be the same.
1571     if (getOperator()->getName() == "INSERT_SUBREG") {
1572       assert(getChild(0)->getNumTypes() == 1 && "FIXME: Unhandled");
1573       MadeChange |= UpdateNodeType(0, getChild(0)->getExtType(0), TP);
1574       MadeChange |= getChild(0)->UpdateNodeType(0, getExtType(0), TP);
1575     }
1576
1577     unsigned ChildNo = 0;
1578     for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i) {
1579       Record *OperandNode = Inst.getOperand(i);
1580
1581       // If the instruction expects a predicate or optional def operand, we
1582       // codegen this by setting the operand to it's default value if it has a
1583       // non-empty DefaultOps field.
1584       if ((OperandNode->isSubClassOf("PredicateOperand") ||
1585            OperandNode->isSubClassOf("OptionalDefOperand")) &&
1586           !CDP.getDefaultOperand(OperandNode).DefaultOps.empty())
1587         continue;
1588
1589       // Verify that we didn't run out of provided operands.
1590       if (ChildNo >= getNumChildren())
1591         TP.error("Instruction '" + getOperator()->getName() +
1592                  "' expects more operands than were provided.");
1593
1594       MVT::SimpleValueType VT;
1595       TreePatternNode *Child = getChild(ChildNo++);
1596       unsigned ChildResNo = 0;  // Instructions always use res #0 of their op.
1597
1598       if (OperandNode->isSubClassOf("RegisterClass")) {
1599         const CodeGenRegisterClass &RC =
1600           CDP.getTargetInfo().getRegisterClass(OperandNode);
1601         MadeChange |= Child->UpdateNodeType(ChildResNo, RC.getValueTypes(), TP);
1602       } else if (OperandNode->isSubClassOf("RegisterOperand")) {
1603         Record *RegClass = OperandNode->getValueAsDef("RegClass");
1604         const CodeGenRegisterClass &RC =
1605           CDP.getTargetInfo().getRegisterClass(RegClass);
1606         MadeChange |= Child->UpdateNodeType(ChildResNo, RC.getValueTypes(), TP);
1607       } else if (OperandNode->isSubClassOf("Operand")) {
1608         VT = getValueType(OperandNode->getValueAsDef("Type"));
1609         MadeChange |= Child->UpdateNodeType(ChildResNo, VT, TP);
1610       } else if (OperandNode->isSubClassOf("PointerLikeRegClass")) {
1611         MadeChange |= Child->UpdateNodeType(ChildResNo, MVT::iPTR, TP);
1612       } else if (OperandNode->getName() == "unknown") {
1613         // Nothing to do.
1614       } else {
1615         assert(0 && "Unknown operand type!");
1616         abort();
1617       }
1618       MadeChange |= Child->ApplyTypeConstraints(TP, NotRegisters);
1619     }
1620
1621     if (ChildNo != getNumChildren())
1622       TP.error("Instruction '" + getOperator()->getName() +
1623                "' was provided too many operands!");
1624
1625     return MadeChange;
1626   }
1627
1628   assert(getOperator()->isSubClassOf("SDNodeXForm") && "Unknown node type!");
1629
1630   // Node transforms always take one operand.
1631   if (getNumChildren() != 1)
1632     TP.error("Node transform '" + getOperator()->getName() +
1633              "' requires one operand!");
1634
1635   bool MadeChange = getChild(0)->ApplyTypeConstraints(TP, NotRegisters);
1636
1637
1638   // If either the output or input of the xform does not have exact
1639   // type info. We assume they must be the same. Otherwise, it is perfectly
1640   // legal to transform from one type to a completely different type.
1641 #if 0
1642   if (!hasTypeSet() || !getChild(0)->hasTypeSet()) {
1643     bool MadeChange = UpdateNodeType(getChild(0)->getExtType(), TP);
1644     MadeChange |= getChild(0)->UpdateNodeType(getExtType(), TP);
1645     return MadeChange;
1646   }
1647 #endif
1648   return MadeChange;
1649 }
1650
1651 /// OnlyOnRHSOfCommutative - Return true if this value is only allowed on the
1652 /// RHS of a commutative operation, not the on LHS.
1653 static bool OnlyOnRHSOfCommutative(TreePatternNode *N) {
1654   if (!N->isLeaf() && N->getOperator()->getName() == "imm")
1655     return true;
1656   if (N->isLeaf() && dynamic_cast<const IntInit*>(N->getLeafValue()))
1657     return true;
1658   return false;
1659 }
1660
1661
1662 /// canPatternMatch - If it is impossible for this pattern to match on this
1663 /// target, fill in Reason and return false.  Otherwise, return true.  This is
1664 /// used as a sanity check for .td files (to prevent people from writing stuff
1665 /// that can never possibly work), and to prevent the pattern permuter from
1666 /// generating stuff that is useless.
1667 bool TreePatternNode::canPatternMatch(std::string &Reason,
1668                                       const CodeGenDAGPatterns &CDP) {
1669   if (isLeaf()) return true;
1670
1671   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
1672     if (!getChild(i)->canPatternMatch(Reason, CDP))
1673       return false;
1674
1675   // If this is an intrinsic, handle cases that would make it not match.  For
1676   // example, if an operand is required to be an immediate.
1677   if (getOperator()->isSubClassOf("Intrinsic")) {
1678     // TODO:
1679     return true;
1680   }
1681
1682   // If this node is a commutative operator, check that the LHS isn't an
1683   // immediate.
1684   const SDNodeInfo &NodeInfo = CDP.getSDNodeInfo(getOperator());
1685   bool isCommIntrinsic = isCommutativeIntrinsic(CDP);
1686   if (NodeInfo.hasProperty(SDNPCommutative) || isCommIntrinsic) {
1687     // Scan all of the operands of the node and make sure that only the last one
1688     // is a constant node, unless the RHS also is.
1689     if (!OnlyOnRHSOfCommutative(getChild(getNumChildren()-1))) {
1690       bool Skip = isCommIntrinsic ? 1 : 0; // First operand is intrinsic id.
1691       for (unsigned i = Skip, e = getNumChildren()-1; i != e; ++i)
1692         if (OnlyOnRHSOfCommutative(getChild(i))) {
1693           Reason="Immediate value must be on the RHS of commutative operators!";
1694           return false;
1695         }
1696     }
1697   }
1698
1699   return true;
1700 }
1701
1702 //===----------------------------------------------------------------------===//
1703 // TreePattern implementation
1704 //
1705
1706 TreePattern::TreePattern(Record *TheRec, const ListInit *RawPat, bool isInput,
1707                          CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp){
1708   isInputPattern = isInput;
1709   for (unsigned i = 0, e = RawPat->getSize(); i != e; ++i)
1710     Trees.push_back(ParseTreePattern(RawPat->getElement(i), ""));
1711 }
1712
1713 TreePattern::TreePattern(Record *TheRec, const DagInit *Pat, bool isInput,
1714                          CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp){
1715   isInputPattern = isInput;
1716   Trees.push_back(ParseTreePattern(Pat, ""));
1717 }
1718
1719 TreePattern::TreePattern(Record *TheRec, TreePatternNode *Pat, bool isInput,
1720                          CodeGenDAGPatterns &cdp) : TheRecord(TheRec), CDP(cdp){
1721   isInputPattern = isInput;
1722   Trees.push_back(Pat);
1723 }
1724
1725 void TreePattern::error(const std::string &Msg) const {
1726   dump();
1727   throw TGError(TheRecord->getLoc(), "In " + TheRecord->getName() + ": " + Msg);
1728 }
1729
1730 void TreePattern::ComputeNamedNodes() {
1731   for (unsigned i = 0, e = Trees.size(); i != e; ++i)
1732     ComputeNamedNodes(Trees[i]);
1733 }
1734
1735 void TreePattern::ComputeNamedNodes(TreePatternNode *N) {
1736   if (!N->getName().empty())
1737     NamedNodes[N->getName()].push_back(N);
1738
1739   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
1740     ComputeNamedNodes(N->getChild(i));
1741 }
1742
1743
1744 TreePatternNode *TreePattern::ParseTreePattern(const Init *TheInit,
1745                                                StringRef OpName){
1746   if (const DefInit *DI = dynamic_cast<const DefInit*>(TheInit)) {
1747     Record *R = DI->getDef();
1748
1749     // Direct reference to a leaf DagNode or PatFrag?  Turn it into a
1750     // TreePatternNode of its own.  For example:
1751     ///   (foo GPR, imm) -> (foo GPR, (imm))
1752     if (R->isSubClassOf("SDNode") || R->isSubClassOf("PatFrag"))
1753       return ParseTreePattern(DagInit::get(DI, "",
1754                           std::vector<std::pair<const Init*, std::string> >()),
1755                               OpName);
1756
1757     // Input argument?
1758     TreePatternNode *Res = new TreePatternNode(DI, 1);
1759     if (R->getName() == "node" && !OpName.empty()) {
1760       if (OpName.empty())
1761         error("'node' argument requires a name to match with operand list");
1762       Args.push_back(OpName);
1763     }
1764
1765     Res->setName(OpName);
1766     return Res;
1767   }
1768
1769   if (const IntInit *II = dynamic_cast<const IntInit*>(TheInit)) {
1770     if (!OpName.empty())
1771       error("Constant int argument should not have a name!");
1772     return new TreePatternNode(II, 1);
1773   }
1774
1775   if (const BitsInit *BI = dynamic_cast<const BitsInit*>(TheInit)) {
1776     // Turn this into an IntInit.
1777     const Init *II = BI->convertInitializerTo(new IntRecTy());
1778     if (II == 0 || !dynamic_cast<const IntInit*>(II))
1779       error("Bits value must be constants!");
1780     return ParseTreePattern(II, OpName);
1781   }
1782
1783   const DagInit *Dag = dynamic_cast<const DagInit*>(TheInit);
1784   if (!Dag) {
1785     TheInit->dump();
1786     error("Pattern has unexpected init kind!");
1787   }
1788   const DefInit *OpDef = dynamic_cast<const DefInit*>(Dag->getOperator());
1789   if (!OpDef) error("Pattern has unexpected operator type!");
1790   Record *Operator = OpDef->getDef();
1791
1792   if (Operator->isSubClassOf("ValueType")) {
1793     // If the operator is a ValueType, then this must be "type cast" of a leaf
1794     // node.
1795     if (Dag->getNumArgs() != 1)
1796       error("Type cast only takes one operand!");
1797
1798     TreePatternNode *New = ParseTreePattern(Dag->getArg(0), Dag->getArgName(0));
1799
1800     // Apply the type cast.
1801     assert(New->getNumTypes() == 1 && "FIXME: Unhandled");
1802     New->UpdateNodeType(0, getValueType(Operator), *this);
1803
1804     if (!OpName.empty())
1805       error("ValueType cast should not have a name!");
1806     return New;
1807   }
1808
1809   // Verify that this is something that makes sense for an operator.
1810   if (!Operator->isSubClassOf("PatFrag") &&
1811       !Operator->isSubClassOf("SDNode") &&
1812       !Operator->isSubClassOf("Instruction") &&
1813       !Operator->isSubClassOf("SDNodeXForm") &&
1814       !Operator->isSubClassOf("Intrinsic") &&
1815       Operator->getName() != "set" &&
1816       Operator->getName() != "implicit")
1817     error("Unrecognized node '" + Operator->getName() + "'!");
1818
1819   //  Check to see if this is something that is illegal in an input pattern.
1820   if (isInputPattern) {
1821     if (Operator->isSubClassOf("Instruction") ||
1822         Operator->isSubClassOf("SDNodeXForm"))
1823       error("Cannot use '" + Operator->getName() + "' in an input pattern!");
1824   } else {
1825     if (Operator->isSubClassOf("Intrinsic"))
1826       error("Cannot use '" + Operator->getName() + "' in an output pattern!");
1827
1828     if (Operator->isSubClassOf("SDNode") &&
1829         Operator->getName() != "imm" &&
1830         Operator->getName() != "fpimm" &&
1831         Operator->getName() != "tglobaltlsaddr" &&
1832         Operator->getName() != "tconstpool" &&
1833         Operator->getName() != "tjumptable" &&
1834         Operator->getName() != "tframeindex" &&
1835         Operator->getName() != "texternalsym" &&
1836         Operator->getName() != "tblockaddress" &&
1837         Operator->getName() != "tglobaladdr" &&
1838         Operator->getName() != "bb" &&
1839         Operator->getName() != "vt")
1840       error("Cannot use '" + Operator->getName() + "' in an output pattern!");
1841   }
1842
1843   std::vector<TreePatternNode*> Children;
1844
1845   // Parse all the operands.
1846   for (unsigned i = 0, e = Dag->getNumArgs(); i != e; ++i)
1847     Children.push_back(ParseTreePattern(Dag->getArg(i), Dag->getArgName(i)));
1848
1849   // If the operator is an intrinsic, then this is just syntactic sugar for for
1850   // (intrinsic_* <number>, ..children..).  Pick the right intrinsic node, and
1851   // convert the intrinsic name to a number.
1852   if (Operator->isSubClassOf("Intrinsic")) {
1853     const CodeGenIntrinsic &Int = getDAGPatterns().getIntrinsic(Operator);
1854     unsigned IID = getDAGPatterns().getIntrinsicID(Operator)+1;
1855
1856     // If this intrinsic returns void, it must have side-effects and thus a
1857     // chain.
1858     if (Int.IS.RetVTs.empty())
1859       Operator = getDAGPatterns().get_intrinsic_void_sdnode();
1860     else if (Int.ModRef != CodeGenIntrinsic::NoMem)
1861       // Has side-effects, requires chain.
1862       Operator = getDAGPatterns().get_intrinsic_w_chain_sdnode();
1863     else // Otherwise, no chain.
1864       Operator = getDAGPatterns().get_intrinsic_wo_chain_sdnode();
1865
1866     TreePatternNode *IIDNode = new TreePatternNode(IntInit::get(IID), 1);
1867     Children.insert(Children.begin(), IIDNode);
1868   }
1869
1870   unsigned NumResults = GetNumNodeResults(Operator, CDP);
1871   TreePatternNode *Result = new TreePatternNode(Operator, Children, NumResults);
1872   Result->setName(OpName);
1873
1874   if (!Dag->getName().empty()) {
1875     assert(Result->getName().empty());
1876     Result->setName(Dag->getName());
1877   }
1878   return Result;
1879 }
1880
1881 /// SimplifyTree - See if we can simplify this tree to eliminate something that
1882 /// will never match in favor of something obvious that will.  This is here
1883 /// strictly as a convenience to target authors because it allows them to write
1884 /// more type generic things and have useless type casts fold away.
1885 ///
1886 /// This returns true if any change is made.
1887 static bool SimplifyTree(TreePatternNode *&N) {
1888   if (N->isLeaf())
1889     return false;
1890
1891   // If we have a bitconvert with a resolved type and if the source and
1892   // destination types are the same, then the bitconvert is useless, remove it.
1893   if (N->getOperator()->getName() == "bitconvert" &&
1894       N->getExtType(0).isConcrete() &&
1895       N->getExtType(0) == N->getChild(0)->getExtType(0) &&
1896       N->getName().empty()) {
1897     N = N->getChild(0);
1898     SimplifyTree(N);
1899     return true;
1900   }
1901
1902   // Walk all children.
1903   bool MadeChange = false;
1904   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i) {
1905     TreePatternNode *Child = N->getChild(i);
1906     MadeChange |= SimplifyTree(Child);
1907     N->setChild(i, Child);
1908   }
1909   return MadeChange;
1910 }
1911
1912
1913
1914 /// InferAllTypes - Infer/propagate as many types throughout the expression
1915 /// patterns as possible.  Return true if all types are inferred, false
1916 /// otherwise.  Throw an exception if a type contradiction is found.
1917 bool TreePattern::
1918 InferAllTypes(const StringMap<SmallVector<TreePatternNode*,1> > *InNamedTypes) {
1919   if (NamedNodes.empty())
1920     ComputeNamedNodes();
1921
1922   bool MadeChange = true;
1923   while (MadeChange) {
1924     MadeChange = false;
1925     for (unsigned i = 0, e = Trees.size(); i != e; ++i) {
1926       MadeChange |= Trees[i]->ApplyTypeConstraints(*this, false);
1927       MadeChange |= SimplifyTree(Trees[i]);
1928     }
1929
1930     // If there are constraints on our named nodes, apply them.
1931     for (StringMap<SmallVector<TreePatternNode*,1> >::iterator
1932          I = NamedNodes.begin(), E = NamedNodes.end(); I != E; ++I) {
1933       SmallVectorImpl<TreePatternNode*> &Nodes = I->second;
1934
1935       // If we have input named node types, propagate their types to the named
1936       // values here.
1937       if (InNamedTypes) {
1938         // FIXME: Should be error?
1939         assert(InNamedTypes->count(I->getKey()) &&
1940                "Named node in output pattern but not input pattern?");
1941
1942         const SmallVectorImpl<TreePatternNode*> &InNodes =
1943           InNamedTypes->find(I->getKey())->second;
1944
1945         // The input types should be fully resolved by now.
1946         for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
1947           // If this node is a register class, and it is the root of the pattern
1948           // then we're mapping something onto an input register.  We allow
1949           // changing the type of the input register in this case.  This allows
1950           // us to match things like:
1951           //  def : Pat<(v1i64 (bitconvert(v2i32 DPR:$src))), (v1i64 DPR:$src)>;
1952           if (Nodes[i] == Trees[0] && Nodes[i]->isLeaf()) {
1953             const DefInit *DI =
1954               dynamic_cast<const DefInit*>(Nodes[i]->getLeafValue());
1955             if (DI && (DI->getDef()->isSubClassOf("RegisterClass") ||
1956                        DI->getDef()->isSubClassOf("RegisterOperand")))
1957               continue;
1958           }
1959
1960           assert(Nodes[i]->getNumTypes() == 1 &&
1961                  InNodes[0]->getNumTypes() == 1 &&
1962                  "FIXME: cannot name multiple result nodes yet");
1963           MadeChange |= Nodes[i]->UpdateNodeType(0, InNodes[0]->getExtType(0),
1964                                                  *this);
1965         }
1966       }
1967
1968       // If there are multiple nodes with the same name, they must all have the
1969       // same type.
1970       if (I->second.size() > 1) {
1971         for (unsigned i = 0, e = Nodes.size()-1; i != e; ++i) {
1972           TreePatternNode *N1 = Nodes[i], *N2 = Nodes[i+1];
1973           assert(N1->getNumTypes() == 1 && N2->getNumTypes() == 1 &&
1974                  "FIXME: cannot name multiple result nodes yet");
1975
1976           MadeChange |= N1->UpdateNodeType(0, N2->getExtType(0), *this);
1977           MadeChange |= N2->UpdateNodeType(0, N1->getExtType(0), *this);
1978         }
1979       }
1980     }
1981   }
1982
1983   bool HasUnresolvedTypes = false;
1984   for (unsigned i = 0, e = Trees.size(); i != e; ++i)
1985     HasUnresolvedTypes |= Trees[i]->ContainsUnresolvedType();
1986   return !HasUnresolvedTypes;
1987 }
1988
1989 void TreePattern::print(raw_ostream &OS) const {
1990   OS << getRecord()->getName();
1991   if (!Args.empty()) {
1992     OS << "(" << Args[0];
1993     for (unsigned i = 1, e = Args.size(); i != e; ++i)
1994       OS << ", " << Args[i];
1995     OS << ")";
1996   }
1997   OS << ": ";
1998
1999   if (Trees.size() > 1)
2000     OS << "[\n";
2001   for (unsigned i = 0, e = Trees.size(); i != e; ++i) {
2002     OS << "\t";
2003     Trees[i]->print(OS);
2004     OS << "\n";
2005   }
2006
2007   if (Trees.size() > 1)
2008     OS << "]\n";
2009 }
2010
2011 void TreePattern::dump() const { print(errs()); }
2012
2013 //===----------------------------------------------------------------------===//
2014 // CodeGenDAGPatterns implementation
2015 //
2016
2017 CodeGenDAGPatterns::CodeGenDAGPatterns(RecordKeeper &R) :
2018   Records(R), Target(R) {
2019
2020   Intrinsics = LoadIntrinsics(Records, false);
2021   TgtIntrinsics = LoadIntrinsics(Records, true);
2022   ParseNodeInfo();
2023   ParseNodeTransforms();
2024   ParseComplexPatterns();
2025   ParsePatternFragments();
2026   ParseDefaultOperands();
2027   ParseInstructions();
2028   ParsePatterns();
2029
2030   // Generate variants.  For example, commutative patterns can match
2031   // multiple ways.  Add them to PatternsToMatch as well.
2032   GenerateVariants();
2033
2034   // Infer instruction flags.  For example, we can detect loads,
2035   // stores, and side effects in many cases by examining an
2036   // instruction's pattern.
2037   InferInstructionFlags();
2038 }
2039
2040 CodeGenDAGPatterns::~CodeGenDAGPatterns() {
2041   for (pf_iterator I = PatternFragments.begin(),
2042        E = PatternFragments.end(); I != E; ++I)
2043     delete I->second;
2044 }
2045
2046
2047 Record *CodeGenDAGPatterns::getSDNodeNamed(const std::string &Name) const {
2048   Record *N = Records.getDef(Name);
2049   if (!N || !N->isSubClassOf("SDNode")) {
2050     errs() << "Error getting SDNode '" << Name << "'!\n";
2051     exit(1);
2052   }
2053   return N;
2054 }
2055
2056 // Parse all of the SDNode definitions for the target, populating SDNodes.
2057 void CodeGenDAGPatterns::ParseNodeInfo() {
2058   std::vector<Record*> Nodes = Records.getAllDerivedDefinitions("SDNode");
2059   while (!Nodes.empty()) {
2060     SDNodes.insert(std::make_pair(Nodes.back(), Nodes.back()));
2061     Nodes.pop_back();
2062   }
2063
2064   // Get the builtin intrinsic nodes.
2065   intrinsic_void_sdnode     = getSDNodeNamed("intrinsic_void");
2066   intrinsic_w_chain_sdnode  = getSDNodeNamed("intrinsic_w_chain");
2067   intrinsic_wo_chain_sdnode = getSDNodeNamed("intrinsic_wo_chain");
2068 }
2069
2070 /// ParseNodeTransforms - Parse all SDNodeXForm instances into the SDNodeXForms
2071 /// map, and emit them to the file as functions.
2072 void CodeGenDAGPatterns::ParseNodeTransforms() {
2073   std::vector<Record*> Xforms = Records.getAllDerivedDefinitions("SDNodeXForm");
2074   while (!Xforms.empty()) {
2075     Record *XFormNode = Xforms.back();
2076     Record *SDNode = XFormNode->getValueAsDef("Opcode");
2077     std::string Code = XFormNode->getValueAsCode("XFormFunction");
2078     SDNodeXForms.insert(std::make_pair(XFormNode, NodeXForm(SDNode, Code)));
2079
2080     Xforms.pop_back();
2081   }
2082 }
2083
2084 void CodeGenDAGPatterns::ParseComplexPatterns() {
2085   std::vector<Record*> AMs = Records.getAllDerivedDefinitions("ComplexPattern");
2086   while (!AMs.empty()) {
2087     ComplexPatterns.insert(std::make_pair(AMs.back(), AMs.back()));
2088     AMs.pop_back();
2089   }
2090 }
2091
2092
2093 /// ParsePatternFragments - Parse all of the PatFrag definitions in the .td
2094 /// file, building up the PatternFragments map.  After we've collected them all,
2095 /// inline fragments together as necessary, so that there are no references left
2096 /// inside a pattern fragment to a pattern fragment.
2097 ///
2098 void CodeGenDAGPatterns::ParsePatternFragments() {
2099   std::vector<Record*> Fragments = Records.getAllDerivedDefinitions("PatFrag");
2100
2101   // First step, parse all of the fragments.
2102   for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
2103     const DagInit *Tree = Fragments[i]->getValueAsDag("Fragment");
2104     TreePattern *P = new TreePattern(Fragments[i], Tree, true, *this);
2105     PatternFragments[Fragments[i]] = P;
2106
2107     // Validate the argument list, converting it to set, to discard duplicates.
2108     std::vector<std::string> &Args = P->getArgList();
2109     std::set<std::string> OperandsSet(Args.begin(), Args.end());
2110
2111     if (OperandsSet.count(""))
2112       P->error("Cannot have unnamed 'node' values in pattern fragment!");
2113
2114     // Parse the operands list.
2115     const DagInit *OpsList = Fragments[i]->getValueAsDag("Operands");
2116     const DefInit *OpsOp = dynamic_cast<const DefInit*>(OpsList->getOperator());
2117     // Special cases: ops == outs == ins. Different names are used to
2118     // improve readability.
2119     if (!OpsOp ||
2120         (OpsOp->getDef()->getName() != "ops" &&
2121          OpsOp->getDef()->getName() != "outs" &&
2122          OpsOp->getDef()->getName() != "ins"))
2123       P->error("Operands list should start with '(ops ... '!");
2124
2125     // Copy over the arguments.
2126     Args.clear();
2127     for (unsigned j = 0, e = OpsList->getNumArgs(); j != e; ++j) {
2128       if (!dynamic_cast<const DefInit*>(OpsList->getArg(j)) ||
2129           static_cast<const DefInit*>(OpsList->getArg(j))->
2130           getDef()->getName() != "node")
2131         P->error("Operands list should all be 'node' values.");
2132       if (OpsList->getArgName(j).empty())
2133         P->error("Operands list should have names for each operand!");
2134       if (!OperandsSet.count(OpsList->getArgName(j)))
2135         P->error("'" + OpsList->getArgName(j) +
2136                  "' does not occur in pattern or was multiply specified!");
2137       OperandsSet.erase(OpsList->getArgName(j));
2138       Args.push_back(OpsList->getArgName(j));
2139     }
2140
2141     if (!OperandsSet.empty())
2142       P->error("Operands list does not contain an entry for operand '" +
2143                *OperandsSet.begin() + "'!");
2144
2145     // If there is a code init for this fragment, keep track of the fact that
2146     // this fragment uses it.
2147     TreePredicateFn PredFn(P);
2148     if (!PredFn.isAlwaysTrue())
2149       P->getOnlyTree()->addPredicateFn(PredFn);
2150
2151     // If there is a node transformation corresponding to this, keep track of
2152     // it.
2153     Record *Transform = Fragments[i]->getValueAsDef("OperandTransform");
2154     if (!getSDNodeTransform(Transform).second.empty())    // not noop xform?
2155       P->getOnlyTree()->setTransformFn(Transform);
2156   }
2157
2158   // Now that we've parsed all of the tree fragments, do a closure on them so
2159   // that there are not references to PatFrags left inside of them.
2160   for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
2161     TreePattern *ThePat = PatternFragments[Fragments[i]];
2162     ThePat->InlinePatternFragments();
2163
2164     // Infer as many types as possible.  Don't worry about it if we don't infer
2165     // all of them, some may depend on the inputs of the pattern.
2166     try {
2167       ThePat->InferAllTypes();
2168     } catch (...) {
2169       // If this pattern fragment is not supported by this target (no types can
2170       // satisfy its constraints), just ignore it.  If the bogus pattern is
2171       // actually used by instructions, the type consistency error will be
2172       // reported there.
2173     }
2174
2175     // If debugging, print out the pattern fragment result.
2176     DEBUG(ThePat->dump());
2177   }
2178 }
2179
2180 void CodeGenDAGPatterns::ParseDefaultOperands() {
2181   std::vector<Record*> DefaultOps[2];
2182   DefaultOps[0] = Records.getAllDerivedDefinitions("PredicateOperand");
2183   DefaultOps[1] = Records.getAllDerivedDefinitions("OptionalDefOperand");
2184
2185   // Find some SDNode.
2186   assert(!SDNodes.empty() && "No SDNodes parsed?");
2187   const Init *SomeSDNode = DefInit::get(SDNodes.begin()->first);
2188
2189   for (unsigned iter = 0; iter != 2; ++iter) {
2190     for (unsigned i = 0, e = DefaultOps[iter].size(); i != e; ++i) {
2191       const DagInit *DefaultInfo = DefaultOps[iter][i]->getValueAsDag("DefaultOps");
2192
2193       // Clone the DefaultInfo dag node, changing the operator from 'ops' to
2194       // SomeSDnode so that we can parse this.
2195       std::vector<std::pair<const Init*, std::string> > Ops;
2196       for (unsigned op = 0, e = DefaultInfo->getNumArgs(); op != e; ++op)
2197         Ops.push_back(std::make_pair(DefaultInfo->getArg(op),
2198                                      DefaultInfo->getArgName(op)));
2199       const DagInit *DI = DagInit::get(SomeSDNode, "", Ops);
2200
2201       // Create a TreePattern to parse this.
2202       TreePattern P(DefaultOps[iter][i], DI, false, *this);
2203       assert(P.getNumTrees() == 1 && "This ctor can only produce one tree!");
2204
2205       // Copy the operands over into a DAGDefaultOperand.
2206       DAGDefaultOperand DefaultOpInfo;
2207
2208       TreePatternNode *T = P.getTree(0);
2209       for (unsigned op = 0, e = T->getNumChildren(); op != e; ++op) {
2210         TreePatternNode *TPN = T->getChild(op);
2211         while (TPN->ApplyTypeConstraints(P, false))
2212           /* Resolve all types */;
2213
2214         if (TPN->ContainsUnresolvedType()) {
2215           if (iter == 0)
2216             throw "Value #" + utostr(i) + " of PredicateOperand '" +
2217               DefaultOps[iter][i]->getName() +"' doesn't have a concrete type!";
2218           else
2219             throw "Value #" + utostr(i) + " of OptionalDefOperand '" +
2220               DefaultOps[iter][i]->getName() +"' doesn't have a concrete type!";
2221         }
2222         DefaultOpInfo.DefaultOps.push_back(TPN);
2223       }
2224
2225       // Insert it into the DefaultOperands map so we can find it later.
2226       DefaultOperands[DefaultOps[iter][i]] = DefaultOpInfo;
2227     }
2228   }
2229 }
2230
2231 /// HandleUse - Given "Pat" a leaf in the pattern, check to see if it is an
2232 /// instruction input.  Return true if this is a real use.
2233 static bool HandleUse(TreePattern *I, TreePatternNode *Pat,
2234                       std::map<std::string, TreePatternNode*> &InstInputs) {
2235   // No name -> not interesting.
2236   if (Pat->getName().empty()) {
2237     if (Pat->isLeaf()) {
2238       const DefInit *DI = dynamic_cast<const DefInit*>(Pat->getLeafValue());
2239       if (DI && (DI->getDef()->isSubClassOf("RegisterClass") ||
2240                  DI->getDef()->isSubClassOf("RegisterOperand")))
2241         I->error("Input " + DI->getDef()->getName() + " must be named!");
2242     }
2243     return false;
2244   }
2245
2246   Record *Rec;
2247   if (Pat->isLeaf()) {
2248     const DefInit *DI = dynamic_cast<const DefInit*>(Pat->getLeafValue());
2249     if (!DI) I->error("Input $" + Pat->getName() + " must be an identifier!");
2250     Rec = DI->getDef();
2251   } else {
2252     Rec = Pat->getOperator();
2253   }
2254
2255   // SRCVALUE nodes are ignored.
2256   if (Rec->getName() == "srcvalue")
2257     return false;
2258
2259   TreePatternNode *&Slot = InstInputs[Pat->getName()];
2260   if (!Slot) {
2261     Slot = Pat;
2262     return true;
2263   }
2264   Record *SlotRec;
2265   if (Slot->isLeaf()) {
2266     SlotRec = dynamic_cast<const DefInit*>(Slot->getLeafValue())->getDef();
2267   } else {
2268     assert(Slot->getNumChildren() == 0 && "can't be a use with children!");
2269     SlotRec = Slot->getOperator();
2270   }
2271
2272   // Ensure that the inputs agree if we've already seen this input.
2273   if (Rec != SlotRec)
2274     I->error("All $" + Pat->getName() + " inputs must agree with each other");
2275   if (Slot->getExtTypes() != Pat->getExtTypes())
2276     I->error("All $" + Pat->getName() + " inputs must agree with each other");
2277   return true;
2278 }
2279
2280 /// FindPatternInputsAndOutputs - Scan the specified TreePatternNode (which is
2281 /// part of "I", the instruction), computing the set of inputs and outputs of
2282 /// the pattern.  Report errors if we see anything naughty.
2283 void CodeGenDAGPatterns::
2284 FindPatternInputsAndOutputs(TreePattern *I, TreePatternNode *Pat,
2285                             std::map<std::string, TreePatternNode*> &InstInputs,
2286                             std::map<std::string, TreePatternNode*>&InstResults,
2287                             std::vector<Record*> &InstImpResults) {
2288   if (Pat->isLeaf()) {
2289     bool isUse = HandleUse(I, Pat, InstInputs);
2290     if (!isUse && Pat->getTransformFn())
2291       I->error("Cannot specify a transform function for a non-input value!");
2292     return;
2293   }
2294
2295   if (Pat->getOperator()->getName() == "implicit") {
2296     for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
2297       TreePatternNode *Dest = Pat->getChild(i);
2298       if (!Dest->isLeaf())
2299         I->error("implicitly defined value should be a register!");
2300
2301       const DefInit *Val = dynamic_cast<const DefInit*>(Dest->getLeafValue());
2302       if (!Val || !Val->getDef()->isSubClassOf("Register"))
2303         I->error("implicitly defined value should be a register!");
2304       InstImpResults.push_back(Val->getDef());
2305     }
2306     return;
2307   }
2308
2309   if (Pat->getOperator()->getName() != "set") {
2310     // If this is not a set, verify that the children nodes are not void typed,
2311     // and recurse.
2312     for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
2313       if (Pat->getChild(i)->getNumTypes() == 0)
2314         I->error("Cannot have void nodes inside of patterns!");
2315       FindPatternInputsAndOutputs(I, Pat->getChild(i), InstInputs, InstResults,
2316                                   InstImpResults);
2317     }
2318
2319     // If this is a non-leaf node with no children, treat it basically as if
2320     // it were a leaf.  This handles nodes like (imm).
2321     bool isUse = HandleUse(I, Pat, InstInputs);
2322
2323     if (!isUse && Pat->getTransformFn())
2324       I->error("Cannot specify a transform function for a non-input value!");
2325     return;
2326   }
2327
2328   // Otherwise, this is a set, validate and collect instruction results.
2329   if (Pat->getNumChildren() == 0)
2330     I->error("set requires operands!");
2331
2332   if (Pat->getTransformFn())
2333     I->error("Cannot specify a transform function on a set node!");
2334
2335   // Check the set destinations.
2336   unsigned NumDests = Pat->getNumChildren()-1;
2337   for (unsigned i = 0; i != NumDests; ++i) {
2338     TreePatternNode *Dest = Pat->getChild(i);
2339     if (!Dest->isLeaf())
2340       I->error("set destination should be a register!");
2341
2342     const DefInit *Val = dynamic_cast<const DefInit*>(Dest->getLeafValue());
2343     if (!Val)
2344       I->error("set destination should be a register!");
2345
2346     if (Val->getDef()->isSubClassOf("RegisterClass") ||
2347         Val->getDef()->isSubClassOf("RegisterOperand") ||
2348         Val->getDef()->isSubClassOf("PointerLikeRegClass")) {
2349       if (Dest->getName().empty())
2350         I->error("set destination must have a name!");
2351       if (InstResults.count(Dest->getName()))
2352         I->error("cannot set '" + Dest->getName() +"' multiple times");
2353       InstResults[Dest->getName()] = Dest;
2354     } else if (Val->getDef()->isSubClassOf("Register")) {
2355       InstImpResults.push_back(Val->getDef());
2356     } else {
2357       I->error("set destination should be a register!");
2358     }
2359   }
2360
2361   // Verify and collect info from the computation.
2362   FindPatternInputsAndOutputs(I, Pat->getChild(NumDests),
2363                               InstInputs, InstResults, InstImpResults);
2364 }
2365
2366 //===----------------------------------------------------------------------===//
2367 // Instruction Analysis
2368 //===----------------------------------------------------------------------===//
2369
2370 class InstAnalyzer {
2371   const CodeGenDAGPatterns &CDP;
2372   bool &mayStore;
2373   bool &mayLoad;
2374   bool &IsBitcast;
2375   bool &HasSideEffects;
2376   bool &IsVariadic;
2377 public:
2378   InstAnalyzer(const CodeGenDAGPatterns &cdp,
2379                bool &maystore, bool &mayload, bool &isbc, bool &hse, bool &isv)
2380     : CDP(cdp), mayStore(maystore), mayLoad(mayload), IsBitcast(isbc),
2381       HasSideEffects(hse), IsVariadic(isv) {
2382   }
2383
2384   /// Analyze - Analyze the specified instruction, returning true if the
2385   /// instruction had a pattern.
2386   bool Analyze(Record *InstRecord) {
2387     const TreePattern *Pattern = CDP.getInstruction(InstRecord).getPattern();
2388     if (Pattern == 0) {
2389       HasSideEffects = 1;
2390       return false;  // No pattern.
2391     }
2392
2393     // FIXME: Assume only the first tree is the pattern. The others are clobber
2394     // nodes.
2395     AnalyzeNode(Pattern->getTree(0));
2396     return true;
2397   }
2398
2399 private:
2400   bool IsNodeBitcast(const TreePatternNode *N) const {
2401     if (HasSideEffects || mayLoad || mayStore || IsVariadic)
2402       return false;
2403
2404     if (N->getNumChildren() != 2)
2405       return false;
2406
2407     const TreePatternNode *N0 = N->getChild(0);
2408     if (!N0->isLeaf() || !dynamic_cast<const DefInit*>(N0->getLeafValue()))
2409       return false;
2410
2411     const TreePatternNode *N1 = N->getChild(1);
2412     if (N1->isLeaf())
2413       return false;
2414     if (N1->getNumChildren() != 1 || !N1->getChild(0)->isLeaf())
2415       return false;
2416
2417     const SDNodeInfo &OpInfo = CDP.getSDNodeInfo(N1->getOperator());
2418     if (OpInfo.getNumResults() != 1 || OpInfo.getNumOperands() != 1)
2419       return false;
2420     return OpInfo.getEnumName() == "ISD::BITCAST";
2421   }
2422
2423   void AnalyzeNode(const TreePatternNode *N) {
2424     if (N->isLeaf()) {
2425       if (const DefInit *DI = dynamic_cast<const DefInit*>(N->getLeafValue())) {
2426         Record *LeafRec = DI->getDef();
2427         // Handle ComplexPattern leaves.
2428         if (LeafRec->isSubClassOf("ComplexPattern")) {
2429           const ComplexPattern &CP = CDP.getComplexPattern(LeafRec);
2430           if (CP.hasProperty(SDNPMayStore)) mayStore = true;
2431           if (CP.hasProperty(SDNPMayLoad)) mayLoad = true;
2432           if (CP.hasProperty(SDNPSideEffect)) HasSideEffects = true;
2433         }
2434       }
2435       return;
2436     }
2437
2438     // Analyze children.
2439     for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
2440       AnalyzeNode(N->getChild(i));
2441
2442     // Ignore set nodes, which are not SDNodes.
2443     if (N->getOperator()->getName() == "set") {
2444       IsBitcast = IsNodeBitcast(N);
2445       return;
2446     }
2447
2448     // Get information about the SDNode for the operator.
2449     const SDNodeInfo &OpInfo = CDP.getSDNodeInfo(N->getOperator());
2450
2451     // Notice properties of the node.
2452     if (OpInfo.hasProperty(SDNPMayStore)) mayStore = true;
2453     if (OpInfo.hasProperty(SDNPMayLoad)) mayLoad = true;
2454     if (OpInfo.hasProperty(SDNPSideEffect)) HasSideEffects = true;
2455     if (OpInfo.hasProperty(SDNPVariadic)) IsVariadic = true;
2456
2457     if (const CodeGenIntrinsic *IntInfo = N->getIntrinsicInfo(CDP)) {
2458       // If this is an intrinsic, analyze it.
2459       if (IntInfo->ModRef >= CodeGenIntrinsic::ReadArgMem)
2460         mayLoad = true;// These may load memory.
2461
2462       if (IntInfo->ModRef >= CodeGenIntrinsic::ReadWriteArgMem)
2463         mayStore = true;// Intrinsics that can write to memory are 'mayStore'.
2464
2465       if (IntInfo->ModRef >= CodeGenIntrinsic::ReadWriteMem)
2466         // WriteMem intrinsics can have other strange effects.
2467         HasSideEffects = true;
2468     }
2469   }
2470
2471 };
2472
2473 static void InferFromPattern(const CodeGenInstruction &Inst,
2474                              bool &MayStore, bool &MayLoad,
2475                              bool &IsBitcast,
2476                              bool &HasSideEffects, bool &IsVariadic,
2477                              const CodeGenDAGPatterns &CDP) {
2478   MayStore = MayLoad = IsBitcast = HasSideEffects = IsVariadic = false;
2479
2480   bool HadPattern =
2481     InstAnalyzer(CDP, MayStore, MayLoad, IsBitcast, HasSideEffects, IsVariadic)
2482     .Analyze(Inst.TheDef);
2483
2484   // InstAnalyzer only correctly analyzes mayStore/mayLoad so far.
2485   if (Inst.mayStore) {  // If the .td file explicitly sets mayStore, use it.
2486     // If we decided that this is a store from the pattern, then the .td file
2487     // entry is redundant.
2488     if (MayStore)
2489       fprintf(stderr,
2490               "Warning: mayStore flag explicitly set on instruction '%s'"
2491               " but flag already inferred from pattern.\n",
2492               Inst.TheDef->getName().c_str());
2493     MayStore = true;
2494   }
2495
2496   if (Inst.mayLoad) {  // If the .td file explicitly sets mayLoad, use it.
2497     // If we decided that this is a load from the pattern, then the .td file
2498     // entry is redundant.
2499     if (MayLoad)
2500       fprintf(stderr,
2501               "Warning: mayLoad flag explicitly set on instruction '%s'"
2502               " but flag already inferred from pattern.\n",
2503               Inst.TheDef->getName().c_str());
2504     MayLoad = true;
2505   }
2506
2507   if (Inst.neverHasSideEffects) {
2508     if (HadPattern)
2509       fprintf(stderr, "Warning: neverHasSideEffects set on instruction '%s' "
2510               "which already has a pattern\n", Inst.TheDef->getName().c_str());
2511     HasSideEffects = false;
2512   }
2513
2514   if (Inst.hasSideEffects) {
2515     if (HasSideEffects)
2516       fprintf(stderr, "Warning: hasSideEffects set on instruction '%s' "
2517               "which already inferred this.\n", Inst.TheDef->getName().c_str());
2518     HasSideEffects = true;
2519   }
2520
2521   if (Inst.Operands.isVariadic)
2522     IsVariadic = true;  // Can warn if we want.
2523 }
2524
2525 /// ParseInstructions - Parse all of the instructions, inlining and resolving
2526 /// any fragments involved.  This populates the Instructions list with fully
2527 /// resolved instructions.
2528 void CodeGenDAGPatterns::ParseInstructions() {
2529   std::vector<Record*> Instrs = Records.getAllDerivedDefinitions("Instruction");
2530
2531   for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
2532     const ListInit *LI = 0;
2533
2534     if (dynamic_cast<const ListInit*>(Instrs[i]->getValueInit("Pattern")))
2535       LI = Instrs[i]->getValueAsListInit("Pattern");
2536
2537     // If there is no pattern, only collect minimal information about the
2538     // instruction for its operand list.  We have to assume that there is one
2539     // result, as we have no detailed info.
2540     if (!LI || LI->getSize() == 0) {
2541       std::vector<Record*> Results;
2542       std::vector<Record*> Operands;
2543
2544       CodeGenInstruction &InstInfo = Target.getInstruction(Instrs[i]);
2545
2546       if (InstInfo.Operands.size() != 0) {
2547         if (InstInfo.Operands.NumDefs == 0) {
2548           // These produce no results
2549           for (unsigned j = 0, e = InstInfo.Operands.size(); j < e; ++j)
2550             Operands.push_back(InstInfo.Operands[j].Rec);
2551         } else {
2552           // Assume the first operand is the result.
2553           Results.push_back(InstInfo.Operands[0].Rec);
2554
2555           // The rest are inputs.
2556           for (unsigned j = 1, e = InstInfo.Operands.size(); j < e; ++j)
2557             Operands.push_back(InstInfo.Operands[j].Rec);
2558         }
2559       }
2560
2561       // Create and insert the instruction.
2562       std::vector<Record*> ImpResults;
2563       Instructions.insert(std::make_pair(Instrs[i],
2564                           DAGInstruction(0, Results, Operands, ImpResults)));
2565       continue;  // no pattern.
2566     }
2567
2568     // Parse the instruction.
2569     TreePattern *I = new TreePattern(Instrs[i], LI, true, *this);
2570     // Inline pattern fragments into it.
2571     I->InlinePatternFragments();
2572
2573     // Infer as many types as possible.  If we cannot infer all of them, we can
2574     // never do anything with this instruction pattern: report it to the user.
2575     if (!I->InferAllTypes())
2576       I->error("Could not infer all types in pattern!");
2577
2578     // InstInputs - Keep track of all of the inputs of the instruction, along
2579     // with the record they are declared as.
2580     std::map<std::string, TreePatternNode*> InstInputs;
2581
2582     // InstResults - Keep track of all the virtual registers that are 'set'
2583     // in the instruction, including what reg class they are.
2584     std::map<std::string, TreePatternNode*> InstResults;
2585
2586     std::vector<Record*> InstImpResults;
2587
2588     // Verify that the top-level forms in the instruction are of void type, and
2589     // fill in the InstResults map.
2590     for (unsigned j = 0, e = I->getNumTrees(); j != e; ++j) {
2591       TreePatternNode *Pat = I->getTree(j);
2592       if (Pat->getNumTypes() != 0)
2593         I->error("Top-level forms in instruction pattern should have"
2594                  " void types");
2595
2596       // Find inputs and outputs, and verify the structure of the uses/defs.
2597       FindPatternInputsAndOutputs(I, Pat, InstInputs, InstResults,
2598                                   InstImpResults);
2599     }
2600
2601     // Now that we have inputs and outputs of the pattern, inspect the operands
2602     // list for the instruction.  This determines the order that operands are
2603     // added to the machine instruction the node corresponds to.
2604     unsigned NumResults = InstResults.size();
2605
2606     // Parse the operands list from the (ops) list, validating it.
2607     assert(I->getArgList().empty() && "Args list should still be empty here!");
2608     CodeGenInstruction &CGI = Target.getInstruction(Instrs[i]);
2609
2610     // Check that all of the results occur first in the list.
2611     std::vector<Record*> Results;
2612     TreePatternNode *Res0Node = 0;
2613     for (unsigned i = 0; i != NumResults; ++i) {
2614       if (i == CGI.Operands.size())
2615         I->error("'" + InstResults.begin()->first +
2616                  "' set but does not appear in operand list!");
2617       const std::string &OpName = CGI.Operands[i].Name;
2618
2619       // Check that it exists in InstResults.
2620       TreePatternNode *RNode = InstResults[OpName];
2621       if (RNode == 0)
2622         I->error("Operand $" + OpName + " does not exist in operand list!");
2623
2624       if (i == 0)
2625         Res0Node = RNode;
2626       Record *R = dynamic_cast<const DefInit*>(RNode->getLeafValue())->getDef();
2627       if (R == 0)
2628         I->error("Operand $" + OpName + " should be a set destination: all "
2629                  "outputs must occur before inputs in operand list!");
2630
2631       if (CGI.Operands[i].Rec != R)
2632         I->error("Operand $" + OpName + " class mismatch!");
2633
2634       // Remember the return type.
2635       Results.push_back(CGI.Operands[i].Rec);
2636
2637       // Okay, this one checks out.
2638       InstResults.erase(OpName);
2639     }
2640
2641     // Loop over the inputs next.  Make a copy of InstInputs so we can destroy
2642     // the copy while we're checking the inputs.
2643     std::map<std::string, TreePatternNode*> InstInputsCheck(InstInputs);
2644
2645     std::vector<TreePatternNode*> ResultNodeOperands;
2646     std::vector<Record*> Operands;
2647     for (unsigned i = NumResults, e = CGI.Operands.size(); i != e; ++i) {
2648       CGIOperandList::OperandInfo &Op = CGI.Operands[i];
2649       const std::string &OpName = Op.Name;
2650       if (OpName.empty())
2651         I->error("Operand #" + utostr(i) + " in operands list has no name!");
2652
2653       if (!InstInputsCheck.count(OpName)) {
2654         // If this is an predicate operand or optional def operand with an
2655         // DefaultOps set filled in, we can ignore this.  When we codegen it,
2656         // we will do so as always executed.
2657         if (Op.Rec->isSubClassOf("PredicateOperand") ||
2658             Op.Rec->isSubClassOf("OptionalDefOperand")) {
2659           // Does it have a non-empty DefaultOps field?  If so, ignore this
2660           // operand.
2661           if (!getDefaultOperand(Op.Rec).DefaultOps.empty())
2662             continue;
2663         }
2664         I->error("Operand $" + OpName +
2665                  " does not appear in the instruction pattern");
2666       }
2667       TreePatternNode *InVal = InstInputsCheck[OpName];
2668       InstInputsCheck.erase(OpName);   // It occurred, remove from map.
2669
2670       if (InVal->isLeaf() &&
2671           dynamic_cast<const DefInit*>(InVal->getLeafValue())) {
2672         Record *InRec = static_cast<const DefInit*>(InVal->getLeafValue())->getDef();
2673         if (Op.Rec != InRec && !InRec->isSubClassOf("ComplexPattern"))
2674           I->error("Operand $" + OpName + "'s register class disagrees"
2675                    " between the operand and pattern");
2676       }
2677       Operands.push_back(Op.Rec);
2678
2679       // Construct the result for the dest-pattern operand list.
2680       TreePatternNode *OpNode = InVal->clone();
2681
2682       // No predicate is useful on the result.
2683       OpNode->clearPredicateFns();
2684
2685       // Promote the xform function to be an explicit node if set.
2686       if (Record *Xform = OpNode->getTransformFn()) {
2687         OpNode->setTransformFn(0);
2688         std::vector<TreePatternNode*> Children;
2689         Children.push_back(OpNode);
2690         OpNode = new TreePatternNode(Xform, Children, OpNode->getNumTypes());
2691       }
2692
2693       ResultNodeOperands.push_back(OpNode);
2694     }
2695
2696     if (!InstInputsCheck.empty())
2697       I->error("Input operand $" + InstInputsCheck.begin()->first +
2698                " occurs in pattern but not in operands list!");
2699
2700     TreePatternNode *ResultPattern =
2701       new TreePatternNode(I->getRecord(), ResultNodeOperands,
2702                           GetNumNodeResults(I->getRecord(), *this));
2703     // Copy fully inferred output node type to instruction result pattern.
2704     for (unsigned i = 0; i != NumResults; ++i)
2705       ResultPattern->setType(i, Res0Node->getExtType(i));
2706
2707     // Create and insert the instruction.
2708     // FIXME: InstImpResults should not be part of DAGInstruction.
2709     DAGInstruction TheInst(I, Results, Operands, InstImpResults);
2710     Instructions.insert(std::make_pair(I->getRecord(), TheInst));
2711
2712     // Use a temporary tree pattern to infer all types and make sure that the
2713     // constructed result is correct.  This depends on the instruction already
2714     // being inserted into the Instructions map.
2715     TreePattern Temp(I->getRecord(), ResultPattern, false, *this);
2716     Temp.InferAllTypes(&I->getNamedNodesMap());
2717
2718     DAGInstruction &TheInsertedInst = Instructions.find(I->getRecord())->second;
2719     TheInsertedInst.setResultPattern(Temp.getOnlyTree());
2720
2721     DEBUG(I->dump());
2722   }
2723
2724   // If we can, convert the instructions to be patterns that are matched!
2725   for (std::map<Record*, DAGInstruction, RecordPtrCmp>::iterator II =
2726         Instructions.begin(),
2727        E = Instructions.end(); II != E; ++II) {
2728     DAGInstruction &TheInst = II->second;
2729     const TreePattern *I = TheInst.getPattern();
2730     if (I == 0) continue;  // No pattern.
2731
2732     // FIXME: Assume only the first tree is the pattern. The others are clobber
2733     // nodes.
2734     TreePatternNode *Pattern = I->getTree(0);
2735     TreePatternNode *SrcPattern;
2736     if (Pattern->getOperator()->getName() == "set") {
2737       SrcPattern = Pattern->getChild(Pattern->getNumChildren()-1)->clone();
2738     } else{
2739       // Not a set (store or something?)
2740       SrcPattern = Pattern;
2741     }
2742
2743     Record *Instr = II->first;
2744     AddPatternToMatch(I,
2745                       PatternToMatch(Instr,
2746                                      Instr->getValueAsListInit("Predicates"),
2747                                      SrcPattern,
2748                                      TheInst.getResultPattern(),
2749                                      TheInst.getImpResults(),
2750                                      Instr->getValueAsInt("AddedComplexity"),
2751                                      Instr->getID()));
2752   }
2753 }
2754
2755
2756 typedef std::pair<const TreePatternNode*, unsigned> NameRecord;
2757
2758 static void FindNames(const TreePatternNode *P,
2759                       std::map<std::string, NameRecord> &Names,
2760                       const TreePattern *PatternTop) {
2761   if (!P->getName().empty()) {
2762     NameRecord &Rec = Names[P->getName()];
2763     // If this is the first instance of the name, remember the node.
2764     if (Rec.second++ == 0)
2765       Rec.first = P;
2766     else if (Rec.first->getExtTypes() != P->getExtTypes())
2767       PatternTop->error("repetition of value: $" + P->getName() +
2768                         " where different uses have different types!");
2769   }
2770
2771   if (!P->isLeaf()) {
2772     for (unsigned i = 0, e = P->getNumChildren(); i != e; ++i)
2773       FindNames(P->getChild(i), Names, PatternTop);
2774   }
2775 }
2776
2777 void CodeGenDAGPatterns::AddPatternToMatch(const TreePattern *Pattern,
2778                                            const PatternToMatch &PTM) {
2779   // Do some sanity checking on the pattern we're about to match.
2780   std::string Reason;
2781   if (!PTM.getSrcPattern()->canPatternMatch(Reason, *this))
2782     Pattern->error("Pattern can never match: " + Reason);
2783
2784   // If the source pattern's root is a complex pattern, that complex pattern
2785   // must specify the nodes it can potentially match.
2786   if (const ComplexPattern *CP =
2787         PTM.getSrcPattern()->getComplexPatternInfo(*this))
2788     if (CP->getRootNodes().empty())
2789       Pattern->error("ComplexPattern at root must specify list of opcodes it"
2790                      " could match");
2791
2792
2793   // Find all of the named values in the input and output, ensure they have the
2794   // same type.
2795   std::map<std::string, NameRecord> SrcNames, DstNames;
2796   FindNames(PTM.getSrcPattern(), SrcNames, Pattern);
2797   FindNames(PTM.getDstPattern(), DstNames, Pattern);
2798
2799   // Scan all of the named values in the destination pattern, rejecting them if
2800   // they don't exist in the input pattern.
2801   for (std::map<std::string, NameRecord>::iterator
2802        I = DstNames.begin(), E = DstNames.end(); I != E; ++I) {
2803     if (SrcNames[I->first].first == 0)
2804       Pattern->error("Pattern has input without matching name in output: $" +
2805                      I->first);
2806   }
2807
2808   // Scan all of the named values in the source pattern, rejecting them if the
2809   // name isn't used in the dest, and isn't used to tie two values together.
2810   for (std::map<std::string, NameRecord>::iterator
2811        I = SrcNames.begin(), E = SrcNames.end(); I != E; ++I)
2812     if (DstNames[I->first].first == 0 && SrcNames[I->first].second == 1)
2813       Pattern->error("Pattern has dead named input: $" + I->first);
2814
2815   PatternsToMatch.push_back(PTM);
2816 }
2817
2818
2819
2820 void CodeGenDAGPatterns::InferInstructionFlags() {
2821   const std::vector<const CodeGenInstruction*> &Instructions =
2822     Target.getInstructionsByEnumValue();
2823   for (unsigned i = 0, e = Instructions.size(); i != e; ++i) {
2824     CodeGenInstruction &InstInfo =
2825       const_cast<CodeGenInstruction &>(*Instructions[i]);
2826     // Determine properties of the instruction from its pattern.
2827     bool MayStore, MayLoad, IsBitcast, HasSideEffects, IsVariadic;
2828     InferFromPattern(InstInfo, MayStore, MayLoad, IsBitcast,
2829                      HasSideEffects, IsVariadic, *this);
2830     InstInfo.mayStore = MayStore;
2831     InstInfo.mayLoad = MayLoad;
2832     InstInfo.isBitcast = IsBitcast;
2833     InstInfo.hasSideEffects = HasSideEffects;
2834     InstInfo.Operands.isVariadic = IsVariadic;
2835   }
2836 }
2837
2838 /// Given a pattern result with an unresolved type, see if we can find one
2839 /// instruction with an unresolved result type.  Force this result type to an
2840 /// arbitrary element if it's possible types to converge results.
2841 static bool ForceArbitraryInstResultType(TreePatternNode *N, TreePattern &TP) {
2842   if (N->isLeaf())
2843     return false;
2844
2845   // Analyze children.
2846   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
2847     if (ForceArbitraryInstResultType(N->getChild(i), TP))
2848       return true;
2849
2850   if (!N->getOperator()->isSubClassOf("Instruction"))
2851     return false;
2852
2853   // If this type is already concrete or completely unknown we can't do
2854   // anything.
2855   for (unsigned i = 0, e = N->getNumTypes(); i != e; ++i) {
2856     if (N->getExtType(i).isCompletelyUnknown() || N->getExtType(i).isConcrete())
2857       continue;
2858
2859     // Otherwise, force its type to the first possibility (an arbitrary choice).
2860     if (N->getExtType(i).MergeInTypeInfo(N->getExtType(i).getTypeList()[0], TP))
2861       return true;
2862   }
2863
2864   return false;
2865 }
2866
2867 void CodeGenDAGPatterns::ParsePatterns() {
2868   std::vector<Record*> Patterns = Records.getAllDerivedDefinitions("Pattern");
2869
2870   for (unsigned i = 0, e = Patterns.size(); i != e; ++i) {
2871     Record *CurPattern = Patterns[i];
2872     const DagInit *Tree = CurPattern->getValueAsDag("PatternToMatch");
2873     TreePattern *Pattern = new TreePattern(CurPattern, Tree, true, *this);
2874
2875     // Inline pattern fragments into it.
2876     Pattern->InlinePatternFragments();
2877
2878     const ListInit *LI = CurPattern->getValueAsListInit("ResultInstrs");
2879     if (LI->getSize() == 0) continue;  // no pattern.
2880
2881     // Parse the instruction.
2882     TreePattern *Result = new TreePattern(CurPattern, LI, false, *this);
2883
2884     // Inline pattern fragments into it.
2885     Result->InlinePatternFragments();
2886
2887     if (Result->getNumTrees() != 1)
2888       Result->error("Cannot handle instructions producing instructions "
2889                     "with temporaries yet!");
2890
2891     bool IterateInference;
2892     bool InferredAllPatternTypes, InferredAllResultTypes;
2893     do {
2894       // Infer as many types as possible.  If we cannot infer all of them, we
2895       // can never do anything with this pattern: report it to the user.
2896       InferredAllPatternTypes =
2897         Pattern->InferAllTypes(&Pattern->getNamedNodesMap());
2898
2899       // Infer as many types as possible.  If we cannot infer all of them, we
2900       // can never do anything with this pattern: report it to the user.
2901       InferredAllResultTypes =
2902         Result->InferAllTypes(&Pattern->getNamedNodesMap());
2903
2904       IterateInference = false;
2905
2906       // Apply the type of the result to the source pattern.  This helps us
2907       // resolve cases where the input type is known to be a pointer type (which
2908       // is considered resolved), but the result knows it needs to be 32- or
2909       // 64-bits.  Infer the other way for good measure.
2910       for (unsigned i = 0, e = std::min(Result->getTree(0)->getNumTypes(),
2911                                         Pattern->getTree(0)->getNumTypes());
2912            i != e; ++i) {
2913         IterateInference = Pattern->getTree(0)->
2914           UpdateNodeType(i, Result->getTree(0)->getExtType(i), *Result);
2915         IterateInference |= Result->getTree(0)->
2916           UpdateNodeType(i, Pattern->getTree(0)->getExtType(i), *Result);
2917       }
2918
2919       // If our iteration has converged and the input pattern's types are fully
2920       // resolved but the result pattern is not fully resolved, we may have a
2921       // situation where we have two instructions in the result pattern and
2922       // the instructions require a common register class, but don't care about
2923       // what actual MVT is used.  This is actually a bug in our modelling:
2924       // output patterns should have register classes, not MVTs.
2925       //
2926       // In any case, to handle this, we just go through and disambiguate some
2927       // arbitrary types to the result pattern's nodes.
2928       if (!IterateInference && InferredAllPatternTypes &&
2929           !InferredAllResultTypes)
2930         IterateInference = ForceArbitraryInstResultType(Result->getTree(0),
2931                                                         *Result);
2932     } while (IterateInference);
2933
2934     // Verify that we inferred enough types that we can do something with the
2935     // pattern and result.  If these fire the user has to add type casts.
2936     if (!InferredAllPatternTypes)
2937       Pattern->error("Could not infer all types in pattern!");
2938     if (!InferredAllResultTypes) {
2939       Pattern->dump();
2940       Result->error("Could not infer all types in pattern result!");
2941     }
2942
2943     // Validate that the input pattern is correct.
2944     std::map<std::string, TreePatternNode*> InstInputs;
2945     std::map<std::string, TreePatternNode*> InstResults;
2946     std::vector<Record*> InstImpResults;
2947     for (unsigned j = 0, ee = Pattern->getNumTrees(); j != ee; ++j)
2948       FindPatternInputsAndOutputs(Pattern, Pattern->getTree(j),
2949                                   InstInputs, InstResults,
2950                                   InstImpResults);
2951
2952     // Promote the xform function to be an explicit node if set.
2953     TreePatternNode *DstPattern = Result->getOnlyTree();
2954     std::vector<TreePatternNode*> ResultNodeOperands;
2955     for (unsigned ii = 0, ee = DstPattern->getNumChildren(); ii != ee; ++ii) {
2956       TreePatternNode *OpNode = DstPattern->getChild(ii);
2957       if (Record *Xform = OpNode->getTransformFn()) {
2958         OpNode->setTransformFn(0);
2959         std::vector<TreePatternNode*> Children;
2960         Children.push_back(OpNode);
2961         OpNode = new TreePatternNode(Xform, Children, OpNode->getNumTypes());
2962       }
2963       ResultNodeOperands.push_back(OpNode);
2964     }
2965     DstPattern = Result->getOnlyTree();
2966     if (!DstPattern->isLeaf())
2967       DstPattern = new TreePatternNode(DstPattern->getOperator(),
2968                                        ResultNodeOperands,
2969                                        DstPattern->getNumTypes());
2970
2971     for (unsigned i = 0, e = Result->getOnlyTree()->getNumTypes(); i != e; ++i)
2972       DstPattern->setType(i, Result->getOnlyTree()->getExtType(i));
2973
2974     TreePattern Temp(Result->getRecord(), DstPattern, false, *this);
2975     Temp.InferAllTypes();
2976
2977
2978     AddPatternToMatch(Pattern,
2979                     PatternToMatch(CurPattern,
2980                                    CurPattern->getValueAsListInit("Predicates"),
2981                                    Pattern->getTree(0),
2982                                    Temp.getOnlyTree(), InstImpResults,
2983                                    CurPattern->getValueAsInt("AddedComplexity"),
2984                                    CurPattern->getID()));
2985   }
2986 }
2987
2988 /// CombineChildVariants - Given a bunch of permutations of each child of the
2989 /// 'operator' node, put them together in all possible ways.
2990 static void CombineChildVariants(TreePatternNode *Orig,
2991                const std::vector<std::vector<TreePatternNode*> > &ChildVariants,
2992                                  std::vector<TreePatternNode*> &OutVariants,
2993                                  CodeGenDAGPatterns &CDP,
2994                                  const MultipleUseVarSet &DepVars) {
2995   // Make sure that each operand has at least one variant to choose from.
2996   for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
2997     if (ChildVariants[i].empty())
2998       return;
2999
3000   // The end result is an all-pairs construction of the resultant pattern.
3001   std::vector<unsigned> Idxs;
3002   Idxs.resize(ChildVariants.size());
3003   bool NotDone;
3004   do {
3005 #ifndef NDEBUG
3006     DEBUG(if (!Idxs.empty()) {
3007             errs() << Orig->getOperator()->getName() << ": Idxs = [ ";
3008               for (unsigned i = 0; i < Idxs.size(); ++i) {
3009                 errs() << Idxs[i] << " ";
3010             }
3011             errs() << "]\n";
3012           });
3013 #endif
3014     // Create the variant and add it to the output list.
3015     std::vector<TreePatternNode*> NewChildren;
3016     for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
3017       NewChildren.push_back(ChildVariants[i][Idxs[i]]);
3018     TreePatternNode *R = new TreePatternNode(Orig->getOperator(), NewChildren,
3019                                              Orig->getNumTypes());
3020
3021     // Copy over properties.
3022     R->setName(Orig->getName());
3023     R->setPredicateFns(Orig->getPredicateFns());
3024     R->setTransformFn(Orig->getTransformFn());
3025     for (unsigned i = 0, e = Orig->getNumTypes(); i != e; ++i)
3026       R->setType(i, Orig->getExtType(i));
3027
3028     // If this pattern cannot match, do not include it as a variant.
3029     std::string ErrString;
3030     if (!R->canPatternMatch(ErrString, CDP)) {
3031       delete R;
3032     } else {
3033       bool AlreadyExists = false;
3034
3035       // Scan to see if this pattern has already been emitted.  We can get
3036       // duplication due to things like commuting:
3037       //   (and GPRC:$a, GPRC:$b) -> (and GPRC:$b, GPRC:$a)
3038       // which are the same pattern.  Ignore the dups.
3039       for (unsigned i = 0, e = OutVariants.size(); i != e; ++i)
3040         if (R->isIsomorphicTo(OutVariants[i], DepVars)) {
3041           AlreadyExists = true;
3042           break;
3043         }
3044
3045       if (AlreadyExists)
3046         delete R;
3047       else
3048         OutVariants.push_back(R);
3049     }
3050
3051     // Increment indices to the next permutation by incrementing the
3052     // indicies from last index backward, e.g., generate the sequence
3053     // [0, 0], [0, 1], [1, 0], [1, 1].
3054     int IdxsIdx;
3055     for (IdxsIdx = Idxs.size() - 1; IdxsIdx >= 0; --IdxsIdx) {
3056       if (++Idxs[IdxsIdx] == ChildVariants[IdxsIdx].size())
3057         Idxs[IdxsIdx] = 0;
3058       else
3059         break;
3060     }
3061     NotDone = (IdxsIdx >= 0);
3062   } while (NotDone);
3063 }
3064
3065 /// CombineChildVariants - A helper function for binary operators.
3066 ///
3067 static void CombineChildVariants(TreePatternNode *Orig,
3068                                  const std::vector<TreePatternNode*> &LHS,
3069                                  const std::vector<TreePatternNode*> &RHS,
3070                                  std::vector<TreePatternNode*> &OutVariants,
3071                                  CodeGenDAGPatterns &CDP,
3072                                  const MultipleUseVarSet &DepVars) {
3073   std::vector<std::vector<TreePatternNode*> > ChildVariants;
3074   ChildVariants.push_back(LHS);
3075   ChildVariants.push_back(RHS);
3076   CombineChildVariants(Orig, ChildVariants, OutVariants, CDP, DepVars);
3077 }
3078
3079
3080 static void GatherChildrenOfAssociativeOpcode(TreePatternNode *N,
3081                                      std::vector<TreePatternNode *> &Children) {
3082   assert(N->getNumChildren()==2 &&"Associative but doesn't have 2 children!");
3083   Record *Operator = N->getOperator();
3084
3085   // Only permit raw nodes.
3086   if (!N->getName().empty() || !N->getPredicateFns().empty() ||
3087       N->getTransformFn()) {
3088     Children.push_back(N);
3089     return;
3090   }
3091
3092   if (N->getChild(0)->isLeaf() || N->getChild(0)->getOperator() != Operator)
3093     Children.push_back(N->getChild(0));
3094   else
3095     GatherChildrenOfAssociativeOpcode(N->getChild(0), Children);
3096
3097   if (N->getChild(1)->isLeaf() || N->getChild(1)->getOperator() != Operator)
3098     Children.push_back(N->getChild(1));
3099   else
3100     GatherChildrenOfAssociativeOpcode(N->getChild(1), Children);
3101 }
3102
3103 /// GenerateVariantsOf - Given a pattern N, generate all permutations we can of
3104 /// the (potentially recursive) pattern by using algebraic laws.
3105 ///
3106 static void GenerateVariantsOf(TreePatternNode *N,
3107                                std::vector<TreePatternNode*> &OutVariants,
3108                                CodeGenDAGPatterns &CDP,
3109                                const MultipleUseVarSet &DepVars) {
3110   // We cannot permute leaves.
3111   if (N->isLeaf()) {
3112     OutVariants.push_back(N);
3113     return;
3114   }
3115
3116   // Look up interesting info about the node.
3117   const SDNodeInfo &NodeInfo = CDP.getSDNodeInfo(N->getOperator());
3118
3119   // If this node is associative, re-associate.
3120   if (NodeInfo.hasProperty(SDNPAssociative)) {
3121     // Re-associate by pulling together all of the linked operators
3122     std::vector<TreePatternNode*> MaximalChildren;
3123     GatherChildrenOfAssociativeOpcode(N, MaximalChildren);
3124
3125     // Only handle child sizes of 3.  Otherwise we'll end up trying too many
3126     // permutations.
3127     if (MaximalChildren.size() == 3) {
3128       // Find the variants of all of our maximal children.
3129       std::vector<TreePatternNode*> AVariants, BVariants, CVariants;
3130       GenerateVariantsOf(MaximalChildren[0], AVariants, CDP, DepVars);
3131       GenerateVariantsOf(MaximalChildren[1], BVariants, CDP, DepVars);
3132       GenerateVariantsOf(MaximalChildren[2], CVariants, CDP, DepVars);
3133
3134       // There are only two ways we can permute the tree:
3135       //   (A op B) op C    and    A op (B op C)
3136       // Within these forms, we can also permute A/B/C.
3137
3138       // Generate legal pair permutations of A/B/C.
3139       std::vector<TreePatternNode*> ABVariants;
3140       std::vector<TreePatternNode*> BAVariants;
3141       std::vector<TreePatternNode*> ACVariants;
3142       std::vector<TreePatternNode*> CAVariants;
3143       std::vector<TreePatternNode*> BCVariants;
3144       std::vector<TreePatternNode*> CBVariants;
3145       CombineChildVariants(N, AVariants, BVariants, ABVariants, CDP, DepVars);
3146       CombineChildVariants(N, BVariants, AVariants, BAVariants, CDP, DepVars);
3147       CombineChildVariants(N, AVariants, CVariants, ACVariants, CDP, DepVars);
3148       CombineChildVariants(N, CVariants, AVariants, CAVariants, CDP, DepVars);
3149       CombineChildVariants(N, BVariants, CVariants, BCVariants, CDP, DepVars);
3150       CombineChildVariants(N, CVariants, BVariants, CBVariants, CDP, DepVars);
3151
3152       // Combine those into the result: (x op x) op x
3153       CombineChildVariants(N, ABVariants, CVariants, OutVariants, CDP, DepVars);
3154       CombineChildVariants(N, BAVariants, CVariants, OutVariants, CDP, DepVars);
3155       CombineChildVariants(N, ACVariants, BVariants, OutVariants, CDP, DepVars);
3156       CombineChildVariants(N, CAVariants, BVariants, OutVariants, CDP, DepVars);
3157       CombineChildVariants(N, BCVariants, AVariants, OutVariants, CDP, DepVars);
3158       CombineChildVariants(N, CBVariants, AVariants, OutVariants, CDP, DepVars);
3159
3160       // Combine those into the result: x op (x op x)
3161       CombineChildVariants(N, CVariants, ABVariants, OutVariants, CDP, DepVars);
3162       CombineChildVariants(N, CVariants, BAVariants, OutVariants, CDP, DepVars);
3163       CombineChildVariants(N, BVariants, ACVariants, OutVariants, CDP, DepVars);
3164       CombineChildVariants(N, BVariants, CAVariants, OutVariants, CDP, DepVars);
3165       CombineChildVariants(N, AVariants, BCVariants, OutVariants, CDP, DepVars);
3166       CombineChildVariants(N, AVariants, CBVariants, OutVariants, CDP, DepVars);
3167       return;
3168     }
3169   }
3170
3171   // Compute permutations of all children.
3172   std::vector<std::vector<TreePatternNode*> > ChildVariants;
3173   ChildVariants.resize(N->getNumChildren());
3174   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
3175     GenerateVariantsOf(N->getChild(i), ChildVariants[i], CDP, DepVars);
3176
3177   // Build all permutations based on how the children were formed.
3178   CombineChildVariants(N, ChildVariants, OutVariants, CDP, DepVars);
3179
3180   // If this node is commutative, consider the commuted order.
3181   bool isCommIntrinsic = N->isCommutativeIntrinsic(CDP);
3182   if (NodeInfo.hasProperty(SDNPCommutative) || isCommIntrinsic) {
3183     assert((N->getNumChildren()==2 || isCommIntrinsic) &&
3184            "Commutative but doesn't have 2 children!");
3185     // Don't count children which are actually register references.
3186     unsigned NC = 0;
3187     for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i) {
3188       TreePatternNode *Child = N->getChild(i);
3189       if (Child->isLeaf())
3190         if (const DefInit *DI =
3191             dynamic_cast<const DefInit*>(Child->getLeafValue())) {
3192           Record *RR = DI->getDef();
3193           if (RR->isSubClassOf("Register"))
3194             continue;
3195         }
3196       NC++;
3197     }
3198     // Consider the commuted order.
3199     if (isCommIntrinsic) {
3200       // Commutative intrinsic. First operand is the intrinsic id, 2nd and 3rd
3201       // operands are the commutative operands, and there might be more operands
3202       // after those.
3203       assert(NC >= 3 &&
3204              "Commutative intrinsic should have at least 3 childrean!");
3205       std::vector<std::vector<TreePatternNode*> > Variants;
3206       Variants.push_back(ChildVariants[0]); // Intrinsic id.
3207       Variants.push_back(ChildVariants[2]);
3208       Variants.push_back(ChildVariants[1]);
3209       for (unsigned i = 3; i != NC; ++i)
3210         Variants.push_back(ChildVariants[i]);
3211       CombineChildVariants(N, Variants, OutVariants, CDP, DepVars);
3212     } else if (NC == 2)
3213       CombineChildVariants(N, ChildVariants[1], ChildVariants[0],
3214                            OutVariants, CDP, DepVars);
3215   }
3216 }
3217
3218
3219 // GenerateVariants - Generate variants.  For example, commutative patterns can
3220 // match multiple ways.  Add them to PatternsToMatch as well.
3221 void CodeGenDAGPatterns::GenerateVariants() {
3222   DEBUG(errs() << "Generating instruction variants.\n");
3223
3224   // Loop over all of the patterns we've collected, checking to see if we can
3225   // generate variants of the instruction, through the exploitation of
3226   // identities.  This permits the target to provide aggressive matching without
3227   // the .td file having to contain tons of variants of instructions.
3228   //
3229   // Note that this loop adds new patterns to the PatternsToMatch list, but we
3230   // intentionally do not reconsider these.  Any variants of added patterns have
3231   // already been added.
3232   //
3233   for (unsigned i = 0, e = PatternsToMatch.size(); i != e; ++i) {
3234     MultipleUseVarSet             DepVars;
3235     std::vector<TreePatternNode*> Variants;
3236     FindDepVars(PatternsToMatch[i].getSrcPattern(), DepVars);
3237     DEBUG(errs() << "Dependent/multiply used variables: ");
3238     DEBUG(DumpDepVars(DepVars));
3239     DEBUG(errs() << "\n");
3240     GenerateVariantsOf(PatternsToMatch[i].getSrcPattern(), Variants, *this,
3241                        DepVars);
3242
3243     assert(!Variants.empty() && "Must create at least original variant!");
3244     Variants.erase(Variants.begin());  // Remove the original pattern.
3245
3246     if (Variants.empty())  // No variants for this pattern.
3247       continue;
3248
3249     DEBUG(errs() << "FOUND VARIANTS OF: ";
3250           PatternsToMatch[i].getSrcPattern()->dump();
3251           errs() << "\n");
3252
3253     for (unsigned v = 0, e = Variants.size(); v != e; ++v) {
3254       TreePatternNode *Variant = Variants[v];
3255
3256       DEBUG(errs() << "  VAR#" << v <<  ": ";
3257             Variant->dump();
3258             errs() << "\n");
3259
3260       // Scan to see if an instruction or explicit pattern already matches this.
3261       bool AlreadyExists = false;
3262       for (unsigned p = 0, e = PatternsToMatch.size(); p != e; ++p) {
3263         // Skip if the top level predicates do not match.
3264         if (PatternsToMatch[i].getPredicates() !=
3265             PatternsToMatch[p].getPredicates())
3266           continue;
3267         // Check to see if this variant already exists.
3268         if (Variant->isIsomorphicTo(PatternsToMatch[p].getSrcPattern(),
3269                                     DepVars)) {
3270           DEBUG(errs() << "  *** ALREADY EXISTS, ignoring variant.\n");
3271           AlreadyExists = true;
3272           break;
3273         }
3274       }
3275       // If we already have it, ignore the variant.
3276       if (AlreadyExists) continue;
3277
3278       // Otherwise, add it to the list of patterns we have.
3279       PatternsToMatch.
3280         push_back(PatternToMatch(PatternsToMatch[i].getSrcRecord(),
3281                                  PatternsToMatch[i].getPredicates(),
3282                                  Variant, PatternsToMatch[i].getDstPattern(),
3283                                  PatternsToMatch[i].getDstRegs(),
3284                                  PatternsToMatch[i].getAddedComplexity(),
3285                                  Record::getNewUID()));
3286     }
3287
3288     DEBUG(errs() << "\n");
3289   }
3290 }
3291