add support for literal immediates in patterns to match, allowing us to
[oota-llvm.git] / utils / TableGen / DAGISelEmitter.cpp
1 //===- DAGISelEmitter.cpp - Generate an instruction selector --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This tablegen backend emits a DAG instruction selector.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "DAGISelEmitter.h"
15 #include "Record.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/Support/Debug.h"
18 #include <algorithm>
19 #include <set>
20 using namespace llvm;
21
22 //===----------------------------------------------------------------------===//
23 // Helpers for working with extended types.
24
25 /// FilterVTs - Filter a list of VT's according to a predicate.
26 ///
27 template<typename T>
28 static std::vector<MVT::ValueType> 
29 FilterVTs(const std::vector<MVT::ValueType> &InVTs, T Filter) {
30   std::vector<MVT::ValueType> Result;
31   for (unsigned i = 0, e = InVTs.size(); i != e; ++i)
32     if (Filter(InVTs[i]))
33       Result.push_back(InVTs[i]);
34   return Result;
35 }
36
37 /// isExtIntegerVT - Return true if the specified extended value type is
38 /// integer, or isInt.
39 static bool isExtIntegerVT(unsigned char VT) {
40   return VT == MVT::isInt ||
41         (VT < MVT::LAST_VALUETYPE && MVT::isInteger((MVT::ValueType)VT));
42 }
43
44 /// isExtFloatingPointVT - Return true if the specified extended value type is
45 /// floating point, or isFP.
46 static bool isExtFloatingPointVT(unsigned char VT) {
47   return VT == MVT::isFP ||
48         (VT < MVT::LAST_VALUETYPE && MVT::isFloatingPoint((MVT::ValueType)VT));
49 }
50
51 //===----------------------------------------------------------------------===//
52 // SDTypeConstraint implementation
53 //
54
55 SDTypeConstraint::SDTypeConstraint(Record *R) {
56   OperandNo = R->getValueAsInt("OperandNum");
57   
58   if (R->isSubClassOf("SDTCisVT")) {
59     ConstraintType = SDTCisVT;
60     x.SDTCisVT_Info.VT = getValueType(R->getValueAsDef("VT"));
61   } else if (R->isSubClassOf("SDTCisInt")) {
62     ConstraintType = SDTCisInt;
63   } else if (R->isSubClassOf("SDTCisFP")) {
64     ConstraintType = SDTCisFP;
65   } else if (R->isSubClassOf("SDTCisSameAs")) {
66     ConstraintType = SDTCisSameAs;
67     x.SDTCisSameAs_Info.OtherOperandNum = R->getValueAsInt("OtherOperandNum");
68   } else if (R->isSubClassOf("SDTCisVTSmallerThanOp")) {
69     ConstraintType = SDTCisVTSmallerThanOp;
70     x.SDTCisVTSmallerThanOp_Info.OtherOperandNum = 
71       R->getValueAsInt("OtherOperandNum");
72   } else if (R->isSubClassOf("SDTCisOpSmallerThanOp")) {
73     ConstraintType = SDTCisOpSmallerThanOp;
74     x.SDTCisOpSmallerThanOp_Info.BigOperandNum = 
75       R->getValueAsInt("BigOperandNum");
76   } else {
77     std::cerr << "Unrecognized SDTypeConstraint '" << R->getName() << "'!\n";
78     exit(1);
79   }
80 }
81
82 /// getOperandNum - Return the node corresponding to operand #OpNo in tree
83 /// N, which has NumResults results.
84 TreePatternNode *SDTypeConstraint::getOperandNum(unsigned OpNo,
85                                                  TreePatternNode *N,
86                                                  unsigned NumResults) const {
87   assert(NumResults == 1 && "We only work with single result nodes so far!");
88   
89   if (OpNo < NumResults)
90     return N;  // FIXME: need value #
91   else
92     return N->getChild(OpNo-NumResults);
93 }
94
95 /// ApplyTypeConstraint - Given a node in a pattern, apply this type
96 /// constraint to the nodes operands.  This returns true if it makes a
97 /// change, false otherwise.  If a type contradiction is found, throw an
98 /// exception.
99 bool SDTypeConstraint::ApplyTypeConstraint(TreePatternNode *N,
100                                            const SDNodeInfo &NodeInfo,
101                                            TreePattern &TP) const {
102   unsigned NumResults = NodeInfo.getNumResults();
103   assert(NumResults == 1 && "We only work with single result nodes so far!");
104   
105   // Check that the number of operands is sane.
106   if (NodeInfo.getNumOperands() >= 0) {
107     if (N->getNumChildren() != (unsigned)NodeInfo.getNumOperands())
108       TP.error(N->getOperator()->getName() + " node requires exactly " +
109                itostr(NodeInfo.getNumOperands()) + " operands!");
110   }
111
112   const CodeGenTarget &CGT = TP.getDAGISelEmitter().getTargetInfo();
113   
114   TreePatternNode *NodeToApply = getOperandNum(OperandNo, N, NumResults);
115   
116   switch (ConstraintType) {
117   default: assert(0 && "Unknown constraint type!");
118   case SDTCisVT:
119     // Operand must be a particular type.
120     return NodeToApply->UpdateNodeType(x.SDTCisVT_Info.VT, TP);
121   case SDTCisInt: {
122     // If there is only one integer type supported, this must be it.
123     std::vector<MVT::ValueType> IntVTs =
124       FilterVTs(CGT.getLegalValueTypes(), MVT::isInteger);
125
126     // If we found exactly one supported integer type, apply it.
127     if (IntVTs.size() == 1)
128       return NodeToApply->UpdateNodeType(IntVTs[0], TP);
129     return NodeToApply->UpdateNodeType(MVT::isInt, TP);
130   }
131   case SDTCisFP: {
132     // If there is only one FP type supported, this must be it.
133     std::vector<MVT::ValueType> FPVTs =
134       FilterVTs(CGT.getLegalValueTypes(), MVT::isFloatingPoint);
135         
136     // If we found exactly one supported FP type, apply it.
137     if (FPVTs.size() == 1)
138       return NodeToApply->UpdateNodeType(FPVTs[0], TP);
139     return NodeToApply->UpdateNodeType(MVT::isFP, TP);
140   }
141   case SDTCisSameAs: {
142     TreePatternNode *OtherNode =
143       getOperandNum(x.SDTCisSameAs_Info.OtherOperandNum, N, NumResults);
144     return NodeToApply->UpdateNodeType(OtherNode->getExtType(), TP) |
145            OtherNode->UpdateNodeType(NodeToApply->getExtType(), TP);
146   }
147   case SDTCisVTSmallerThanOp: {
148     // The NodeToApply must be a leaf node that is a VT.  OtherOperandNum must
149     // have an integer type that is smaller than the VT.
150     if (!NodeToApply->isLeaf() ||
151         !dynamic_cast<DefInit*>(NodeToApply->getLeafValue()) ||
152         !static_cast<DefInit*>(NodeToApply->getLeafValue())->getDef()
153                ->isSubClassOf("ValueType"))
154       TP.error(N->getOperator()->getName() + " expects a VT operand!");
155     MVT::ValueType VT =
156      getValueType(static_cast<DefInit*>(NodeToApply->getLeafValue())->getDef());
157     if (!MVT::isInteger(VT))
158       TP.error(N->getOperator()->getName() + " VT operand must be integer!");
159     
160     TreePatternNode *OtherNode =
161       getOperandNum(x.SDTCisVTSmallerThanOp_Info.OtherOperandNum, N,NumResults);
162     
163     // It must be integer.
164     bool MadeChange = false;
165     MadeChange |= OtherNode->UpdateNodeType(MVT::isInt, TP);
166     
167     if (OtherNode->hasTypeSet() && OtherNode->getType() <= VT)
168       OtherNode->UpdateNodeType(MVT::Other, TP);  // Throw an error.
169     return false;
170   }
171   case SDTCisOpSmallerThanOp: {
172     TreePatternNode *BigOperand =
173       getOperandNum(x.SDTCisOpSmallerThanOp_Info.BigOperandNum, N, NumResults);
174
175     // Both operands must be integer or FP, but we don't care which.
176     bool MadeChange = false;
177     
178     if (isExtIntegerVT(NodeToApply->getExtType()))
179       MadeChange |= BigOperand->UpdateNodeType(MVT::isInt, TP);
180     else if (isExtFloatingPointVT(NodeToApply->getExtType()))
181       MadeChange |= BigOperand->UpdateNodeType(MVT::isFP, TP);
182     if (isExtIntegerVT(BigOperand->getExtType()))
183       MadeChange |= NodeToApply->UpdateNodeType(MVT::isInt, TP);
184     else if (isExtFloatingPointVT(BigOperand->getExtType()))
185       MadeChange |= NodeToApply->UpdateNodeType(MVT::isFP, TP);
186
187     std::vector<MVT::ValueType> VTs = CGT.getLegalValueTypes();
188     
189     if (isExtIntegerVT(NodeToApply->getExtType())) {
190       VTs = FilterVTs(VTs, MVT::isInteger);
191     } else if (isExtFloatingPointVT(NodeToApply->getExtType())) {
192       VTs = FilterVTs(VTs, MVT::isFloatingPoint);
193     } else {
194       VTs.clear();
195     }
196
197     switch (VTs.size()) {
198     default:         // Too many VT's to pick from.
199     case 0: break;   // No info yet.
200     case 1: 
201       // Only one VT of this flavor.  Cannot ever satisify the constraints.
202       return NodeToApply->UpdateNodeType(MVT::Other, TP);  // throw
203     case 2:
204       // If we have exactly two possible types, the little operand must be the
205       // small one, the big operand should be the big one.  Common with 
206       // float/double for example.
207       assert(VTs[0] < VTs[1] && "Should be sorted!");
208       MadeChange |= NodeToApply->UpdateNodeType(VTs[0], TP);
209       MadeChange |= BigOperand->UpdateNodeType(VTs[1], TP);
210       break;
211     }    
212     return MadeChange;
213   }
214   }  
215   return false;
216 }
217
218
219 //===----------------------------------------------------------------------===//
220 // SDNodeInfo implementation
221 //
222 SDNodeInfo::SDNodeInfo(Record *R) : Def(R) {
223   EnumName    = R->getValueAsString("Opcode");
224   SDClassName = R->getValueAsString("SDClass");
225   Record *TypeProfile = R->getValueAsDef("TypeProfile");
226   NumResults = TypeProfile->getValueAsInt("NumResults");
227   NumOperands = TypeProfile->getValueAsInt("NumOperands");
228   
229   // Parse the properties.
230   Properties = 0;
231   ListInit *LI = R->getValueAsListInit("Properties");
232   for (unsigned i = 0, e = LI->getSize(); i != e; ++i) {
233     DefInit *DI = dynamic_cast<DefInit*>(LI->getElement(i));
234     assert(DI && "Properties list must be list of defs!");
235     if (DI->getDef()->getName() == "SDNPCommutative") {
236       Properties |= 1 << SDNPCommutative;
237     } else if (DI->getDef()->getName() == "SDNPAssociative") {
238       Properties |= 1 << SDNPAssociative;
239     } else {
240       std::cerr << "Unknown SD Node property '" << DI->getDef()->getName()
241                 << "' on node '" << R->getName() << "'!\n";
242       exit(1);
243     }
244   }
245   
246   
247   // Parse the type constraints.
248   ListInit *Constraints = TypeProfile->getValueAsListInit("Constraints");
249   for (unsigned i = 0, e = Constraints->getSize(); i != e; ++i) {
250     assert(dynamic_cast<DefInit*>(Constraints->getElement(i)) &&
251            "Constraints list should contain constraint definitions!");
252     Record *Constraint = 
253       static_cast<DefInit*>(Constraints->getElement(i))->getDef();
254     TypeConstraints.push_back(Constraint);
255   }
256 }
257
258 //===----------------------------------------------------------------------===//
259 // TreePatternNode implementation
260 //
261
262 TreePatternNode::~TreePatternNode() {
263 #if 0 // FIXME: implement refcounted tree nodes!
264   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
265     delete getChild(i);
266 #endif
267 }
268
269 /// UpdateNodeType - Set the node type of N to VT if VT contains
270 /// information.  If N already contains a conflicting type, then throw an
271 /// exception.  This returns true if any information was updated.
272 ///
273 bool TreePatternNode::UpdateNodeType(unsigned char VT, TreePattern &TP) {
274   if (VT == MVT::isUnknown || getExtType() == VT) return false;
275   if (getExtType() == MVT::isUnknown) {
276     setType(VT);
277     return true;
278   }
279   
280   // If we are told this is to be an int or FP type, and it already is, ignore
281   // the advice.
282   if ((VT == MVT::isInt && isExtIntegerVT(getExtType())) ||
283       (VT == MVT::isFP  && isExtFloatingPointVT(getExtType())))
284     return false;
285       
286   // If we know this is an int or fp type, and we are told it is a specific one,
287   // take the advice.
288   if ((getExtType() == MVT::isInt && isExtIntegerVT(VT)) ||
289       (getExtType() == MVT::isFP  && isExtFloatingPointVT(VT))) {
290     setType(VT);
291     return true;
292   }      
293
294   TP.error("Type inference contradiction found in node " + 
295            getOperator()->getName() + "!");
296   return true; // unreachable
297 }
298
299
300 void TreePatternNode::print(std::ostream &OS) const {
301   if (isLeaf()) {
302     OS << *getLeafValue();
303   } else {
304     OS << "(" << getOperator()->getName();
305   }
306   
307   switch (getExtType()) {
308   case MVT::Other: OS << ":Other"; break;
309   case MVT::isInt: OS << ":isInt"; break;
310   case MVT::isFP : OS << ":isFP"; break;
311   case MVT::isUnknown: ; /*OS << ":?";*/ break;
312   default:  OS << ":" << getType(); break;
313   }
314
315   if (!isLeaf()) {
316     if (getNumChildren() != 0) {
317       OS << " ";
318       getChild(0)->print(OS);
319       for (unsigned i = 1, e = getNumChildren(); i != e; ++i) {
320         OS << ", ";
321         getChild(i)->print(OS);
322       }
323     }
324     OS << ")";
325   }
326   
327   if (!PredicateFn.empty())
328     OS << "<<P:" << PredicateFn << ">>";
329   if (TransformFn)
330     OS << "<<X:" << TransformFn->getName() << ">>";
331   if (!getName().empty())
332     OS << ":$" << getName();
333
334 }
335 void TreePatternNode::dump() const {
336   print(std::cerr);
337 }
338
339 /// isIsomorphicTo - Return true if this node is recursively isomorphic to
340 /// the specified node.  For this comparison, all of the state of the node
341 /// is considered, except for the assigned name.  Nodes with differing names
342 /// that are otherwise identical are considered isomorphic.
343 bool TreePatternNode::isIsomorphicTo(const TreePatternNode *N) const {
344   if (N == this) return true;
345   if (N->isLeaf() != isLeaf() || getExtType() != N->getExtType() ||
346       getPredicateFn() != N->getPredicateFn() ||
347       getTransformFn() != N->getTransformFn())
348     return false;
349
350   if (isLeaf()) {
351     if (DefInit *DI = dynamic_cast<DefInit*>(getLeafValue()))
352       if (DefInit *NDI = dynamic_cast<DefInit*>(N->getLeafValue()))
353         return DI->getDef() == NDI->getDef();
354     return getLeafValue() == N->getLeafValue();
355   }
356   
357   if (N->getOperator() != getOperator() ||
358       N->getNumChildren() != getNumChildren()) return false;
359   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
360     if (!getChild(i)->isIsomorphicTo(N->getChild(i)))
361       return false;
362   return true;
363 }
364
365 /// clone - Make a copy of this tree and all of its children.
366 ///
367 TreePatternNode *TreePatternNode::clone() const {
368   TreePatternNode *New;
369   if (isLeaf()) {
370     New = new TreePatternNode(getLeafValue());
371   } else {
372     std::vector<TreePatternNode*> CChildren;
373     CChildren.reserve(Children.size());
374     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
375       CChildren.push_back(getChild(i)->clone());
376     New = new TreePatternNode(getOperator(), CChildren);
377   }
378   New->setName(getName());
379   New->setType(getExtType());
380   New->setPredicateFn(getPredicateFn());
381   New->setTransformFn(getTransformFn());
382   return New;
383 }
384
385 /// SubstituteFormalArguments - Replace the formal arguments in this tree
386 /// with actual values specified by ArgMap.
387 void TreePatternNode::
388 SubstituteFormalArguments(std::map<std::string, TreePatternNode*> &ArgMap) {
389   if (isLeaf()) return;
390   
391   for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
392     TreePatternNode *Child = getChild(i);
393     if (Child->isLeaf()) {
394       Init *Val = Child->getLeafValue();
395       if (dynamic_cast<DefInit*>(Val) &&
396           static_cast<DefInit*>(Val)->getDef()->getName() == "node") {
397         // We found a use of a formal argument, replace it with its value.
398         Child = ArgMap[Child->getName()];
399         assert(Child && "Couldn't find formal argument!");
400         setChild(i, Child);
401       }
402     } else {
403       getChild(i)->SubstituteFormalArguments(ArgMap);
404     }
405   }
406 }
407
408
409 /// InlinePatternFragments - If this pattern refers to any pattern
410 /// fragments, inline them into place, giving us a pattern without any
411 /// PatFrag references.
412 TreePatternNode *TreePatternNode::InlinePatternFragments(TreePattern &TP) {
413   if (isLeaf()) return this;  // nothing to do.
414   Record *Op = getOperator();
415   
416   if (!Op->isSubClassOf("PatFrag")) {
417     // Just recursively inline children nodes.
418     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
419       setChild(i, getChild(i)->InlinePatternFragments(TP));
420     return this;
421   }
422
423   // Otherwise, we found a reference to a fragment.  First, look up its
424   // TreePattern record.
425   TreePattern *Frag = TP.getDAGISelEmitter().getPatternFragment(Op);
426   
427   // Verify that we are passing the right number of operands.
428   if (Frag->getNumArgs() != Children.size())
429     TP.error("'" + Op->getName() + "' fragment requires " +
430              utostr(Frag->getNumArgs()) + " operands!");
431
432   TreePatternNode *FragTree = Frag->getOnlyTree()->clone();
433
434   // Resolve formal arguments to their actual value.
435   if (Frag->getNumArgs()) {
436     // Compute the map of formal to actual arguments.
437     std::map<std::string, TreePatternNode*> ArgMap;
438     for (unsigned i = 0, e = Frag->getNumArgs(); i != e; ++i)
439       ArgMap[Frag->getArgName(i)] = getChild(i)->InlinePatternFragments(TP);
440   
441     FragTree->SubstituteFormalArguments(ArgMap);
442   }
443   
444   FragTree->setName(getName());
445   
446   // Get a new copy of this fragment to stitch into here.
447   //delete this;    // FIXME: implement refcounting!
448   return FragTree;
449 }
450
451 /// getIntrinsicType - Check to see if the specified record has an intrinsic
452 /// type which should be applied to it.  This infer the type of register
453 /// references from the register file information, for example.
454 ///
455 static unsigned char getIntrinsicType(Record *R, bool NotRegisters,
456                                       TreePattern &TP) {
457   // Check to see if this is a register or a register class...
458   if (R->isSubClassOf("RegisterClass")) {
459     if (NotRegisters) return MVT::isUnknown;
460     return getValueType(R->getValueAsDef("RegType"));
461   } else if (R->isSubClassOf("PatFrag")) {
462     // Pattern fragment types will be resolved when they are inlined.
463     return MVT::isUnknown;
464   } else if (R->isSubClassOf("Register")) {
465     //const CodeGenTarget &T = TP.getDAGISelEmitter().getTargetInfo();
466     // TODO: if a register appears in exactly one regclass, we could use that
467     // type info.
468     return MVT::isUnknown;
469   } else if (R->isSubClassOf("ValueType")) {
470     // Using a VTSDNode.
471     return MVT::Other;
472   } else if (R->getName() == "node") {
473     // Placeholder.
474     return MVT::isUnknown;
475   }
476   
477   TP.error("Unknown node flavor used in pattern: " + R->getName());
478   return MVT::Other;
479 }
480
481 /// ApplyTypeConstraints - Apply all of the type constraints relevent to
482 /// this node and its children in the tree.  This returns true if it makes a
483 /// change, false otherwise.  If a type contradiction is found, throw an
484 /// exception.
485 bool TreePatternNode::ApplyTypeConstraints(TreePattern &TP, bool NotRegisters) {
486   if (isLeaf()) {
487     if (DefInit *DI = dynamic_cast<DefInit*>(getLeafValue()))
488       // If it's a regclass or something else known, include the type.
489       return UpdateNodeType(getIntrinsicType(DI->getDef(), NotRegisters, TP),
490                             TP);
491     return false;
492   }
493   
494   // special handling for set, which isn't really an SDNode.
495   if (getOperator()->getName() == "set") {
496     assert (getNumChildren() == 2 && "Only handle 2 operand set's for now!");
497     bool MadeChange = getChild(0)->ApplyTypeConstraints(TP, NotRegisters);
498     MadeChange |= getChild(1)->ApplyTypeConstraints(TP, NotRegisters);
499     
500     // Types of operands must match.
501     MadeChange |= getChild(0)->UpdateNodeType(getChild(1)->getExtType(), TP);
502     MadeChange |= getChild(1)->UpdateNodeType(getChild(0)->getExtType(), TP);
503     MadeChange |= UpdateNodeType(MVT::isVoid, TP);
504     return MadeChange;
505   } else if (getOperator()->isSubClassOf("SDNode")) {
506     const SDNodeInfo &NI = TP.getDAGISelEmitter().getSDNodeInfo(getOperator());
507     
508     bool MadeChange = NI.ApplyTypeConstraints(this, TP);
509     for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
510       MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
511     return MadeChange;  
512   } else if (getOperator()->isSubClassOf("Instruction")) {
513     const DAGInstruction &Inst =
514       TP.getDAGISelEmitter().getInstruction(getOperator());
515     
516     assert(Inst.getNumResults() == 1 && "Only supports one result instrs!");
517     // Apply the result type to the node
518     bool MadeChange = UpdateNodeType(Inst.getResultType(0), TP);
519
520     if (getNumChildren() != Inst.getNumOperands())
521       TP.error("Instruction '" + getOperator()->getName() + " expects " +
522                utostr(Inst.getNumOperands()) + " operands, not " +
523                utostr(getNumChildren()) + " operands!");
524     for (unsigned i = 0, e = getNumChildren(); i != e; ++i) {
525       MadeChange |= getChild(i)->UpdateNodeType(Inst.getOperandType(i), TP);
526       MadeChange |= getChild(i)->ApplyTypeConstraints(TP, NotRegisters);
527     }
528     return MadeChange;
529   } else {
530     assert(getOperator()->isSubClassOf("SDNodeXForm") && "Unknown node type!");
531     
532     // Node transforms always take one operand, and take and return the same
533     // type.
534     if (getNumChildren() != 1)
535       TP.error("Node transform '" + getOperator()->getName() +
536                "' requires one operand!");
537     bool MadeChange = UpdateNodeType(getChild(0)->getExtType(), TP);
538     MadeChange |= getChild(0)->UpdateNodeType(getExtType(), TP);
539     return MadeChange;
540   }
541 }
542
543 /// canPatternMatch - If it is impossible for this pattern to match on this
544 /// target, fill in Reason and return false.  Otherwise, return true.  This is
545 /// used as a santity check for .td files (to prevent people from writing stuff
546 /// that can never possibly work), and to prevent the pattern permuter from
547 /// generating stuff that is useless.
548 bool TreePatternNode::canPatternMatch(std::string &Reason, DAGISelEmitter &ISE){
549   if (isLeaf()) return true;
550
551   for (unsigned i = 0, e = getNumChildren(); i != e; ++i)
552     if (!getChild(i)->canPatternMatch(Reason, ISE))
553       return false;
554   
555   // If this node is a commutative operator, check that the LHS isn't an
556   // immediate.
557   const SDNodeInfo &NodeInfo = ISE.getSDNodeInfo(getOperator());
558   if (NodeInfo.hasProperty(SDNodeInfo::SDNPCommutative)) {
559     // Scan all of the operands of the node and make sure that only the last one
560     // is a constant node.
561     for (unsigned i = 0, e = getNumChildren()-1; i != e; ++i)
562       if (!getChild(i)->isLeaf() && 
563           getChild(i)->getOperator()->getName() == "imm") {
564         Reason = "Immediate value must be on the RHS of commutative operators!";
565         return false;
566       }
567   }
568   
569   return true;
570 }
571
572 //===----------------------------------------------------------------------===//
573 // TreePattern implementation
574 //
575
576 TreePattern::TreePattern(Record *TheRec, ListInit *RawPat,
577                          DAGISelEmitter &ise) : TheRecord(TheRec), ISE(ise) {
578    for (unsigned i = 0, e = RawPat->getSize(); i != e; ++i)
579      Trees.push_back(ParseTreePattern((DagInit*)RawPat->getElement(i)));
580 }
581
582 TreePattern::TreePattern(Record *TheRec, DagInit *Pat,
583                          DAGISelEmitter &ise) : TheRecord(TheRec), ISE(ise) {
584   Trees.push_back(ParseTreePattern(Pat));
585 }
586
587 TreePattern::TreePattern(Record *TheRec, TreePatternNode *Pat, 
588                          DAGISelEmitter &ise) : TheRecord(TheRec), ISE(ise) {
589   Trees.push_back(Pat);
590 }
591
592
593
594 void TreePattern::error(const std::string &Msg) const {
595   dump();
596   throw "In " + TheRecord->getName() + ": " + Msg;
597 }
598
599 TreePatternNode *TreePattern::ParseTreePattern(DagInit *Dag) {
600   Record *Operator = Dag->getNodeType();
601   
602   if (Operator->isSubClassOf("ValueType")) {
603     // If the operator is a ValueType, then this must be "type cast" of a leaf
604     // node.
605     if (Dag->getNumArgs() != 1)
606       error("Type cast only takes one operand!");
607     
608     Init *Arg = Dag->getArg(0);
609     TreePatternNode *New;
610     if (DefInit *DI = dynamic_cast<DefInit*>(Arg)) {
611       Record *R = DI->getDef();
612       if (R->isSubClassOf("SDNode") || R->isSubClassOf("PatFrag")) {
613         Dag->setArg(0, new DagInit(R,
614                                 std::vector<std::pair<Init*, std::string> >()));
615         TreePatternNode *TPN = ParseTreePattern(Dag);
616         TPN->setName(Dag->getArgName(0));
617         return TPN;
618       }   
619       
620       New = new TreePatternNode(DI);
621     } else if (DagInit *DI = dynamic_cast<DagInit*>(Arg)) {
622       New = ParseTreePattern(DI);
623     } else {
624       Arg->dump();
625       error("Unknown leaf value for tree pattern!");
626       return 0;
627     }
628     
629     // Apply the type cast.
630     New->UpdateNodeType(getValueType(Operator), *this);
631     return New;
632   }
633   
634   // Verify that this is something that makes sense for an operator.
635   if (!Operator->isSubClassOf("PatFrag") && !Operator->isSubClassOf("SDNode") &&
636       !Operator->isSubClassOf("Instruction") && 
637       !Operator->isSubClassOf("SDNodeXForm") &&
638       Operator->getName() != "set")
639     error("Unrecognized node '" + Operator->getName() + "'!");
640   
641   std::vector<TreePatternNode*> Children;
642   
643   for (unsigned i = 0, e = Dag->getNumArgs(); i != e; ++i) {
644     Init *Arg = Dag->getArg(i);
645     if (DagInit *DI = dynamic_cast<DagInit*>(Arg)) {
646       Children.push_back(ParseTreePattern(DI));
647       Children.back()->setName(Dag->getArgName(i));
648     } else if (DefInit *DefI = dynamic_cast<DefInit*>(Arg)) {
649       Record *R = DefI->getDef();
650       // Direct reference to a leaf DagNode or PatFrag?  Turn it into a
651       // TreePatternNode if its own.
652       if (R->isSubClassOf("SDNode") || R->isSubClassOf("PatFrag")) {
653         Dag->setArg(i, new DagInit(R,
654                               std::vector<std::pair<Init*, std::string> >()));
655         --i;  // Revisit this node...
656       } else {
657         TreePatternNode *Node = new TreePatternNode(DefI);
658         Node->setName(Dag->getArgName(i));
659         Children.push_back(Node);
660         
661         // Input argument?
662         if (R->getName() == "node") {
663           if (Dag->getArgName(i).empty())
664             error("'node' argument requires a name to match with operand list");
665           Args.push_back(Dag->getArgName(i));
666         }
667       }
668     } else if (IntInit *II = dynamic_cast<IntInit*>(Arg)) {
669       TreePatternNode *Node = new TreePatternNode(II);
670       if (!Dag->getArgName(i).empty())
671         error("Constant int argument should not have a name!");
672       Children.push_back(Node);
673     } else {
674       std::cerr << '"';
675       Arg->dump();
676       std::cerr << "\": ";
677       error("Unknown leaf value for tree pattern!");
678     }
679   }
680   
681   return new TreePatternNode(Operator, Children);
682 }
683
684 /// InferAllTypes - Infer/propagate as many types throughout the expression
685 /// patterns as possible.  Return true if all types are infered, false
686 /// otherwise.  Throw an exception if a type contradiction is found.
687 bool TreePattern::InferAllTypes() {
688   bool MadeChange = true;
689   while (MadeChange) {
690     MadeChange = false;
691     for (unsigned i = 0, e = Trees.size(); i != e; ++i)
692       MadeChange |= Trees[i]->ApplyTypeConstraints(*this, false);
693   }
694   
695   bool HasUnresolvedTypes = false;
696   for (unsigned i = 0, e = Trees.size(); i != e; ++i)
697     HasUnresolvedTypes |= Trees[i]->ContainsUnresolvedType();
698   return !HasUnresolvedTypes;
699 }
700
701 void TreePattern::print(std::ostream &OS) const {
702   OS << getRecord()->getName();
703   if (!Args.empty()) {
704     OS << "(" << Args[0];
705     for (unsigned i = 1, e = Args.size(); i != e; ++i)
706       OS << ", " << Args[i];
707     OS << ")";
708   }
709   OS << ": ";
710   
711   if (Trees.size() > 1)
712     OS << "[\n";
713   for (unsigned i = 0, e = Trees.size(); i != e; ++i) {
714     OS << "\t";
715     Trees[i]->print(OS);
716     OS << "\n";
717   }
718
719   if (Trees.size() > 1)
720     OS << "]\n";
721 }
722
723 void TreePattern::dump() const { print(std::cerr); }
724
725
726
727 //===----------------------------------------------------------------------===//
728 // DAGISelEmitter implementation
729 //
730
731 // Parse all of the SDNode definitions for the target, populating SDNodes.
732 void DAGISelEmitter::ParseNodeInfo() {
733   std::vector<Record*> Nodes = Records.getAllDerivedDefinitions("SDNode");
734   while (!Nodes.empty()) {
735     SDNodes.insert(std::make_pair(Nodes.back(), Nodes.back()));
736     Nodes.pop_back();
737   }
738 }
739
740 /// ParseNodeTransforms - Parse all SDNodeXForm instances into the SDNodeXForms
741 /// map, and emit them to the file as functions.
742 void DAGISelEmitter::ParseNodeTransforms(std::ostream &OS) {
743   OS << "\n// Node transformations.\n";
744   std::vector<Record*> Xforms = Records.getAllDerivedDefinitions("SDNodeXForm");
745   while (!Xforms.empty()) {
746     Record *XFormNode = Xforms.back();
747     Record *SDNode = XFormNode->getValueAsDef("Opcode");
748     std::string Code = XFormNode->getValueAsCode("XFormFunction");
749     SDNodeXForms.insert(std::make_pair(XFormNode,
750                                        std::make_pair(SDNode, Code)));
751
752     if (!Code.empty()) {
753       std::string ClassName = getSDNodeInfo(SDNode).getSDClassName();
754       const char *C2 = ClassName == "SDNode" ? "N" : "inN";
755
756       OS << "inline SDOperand Transform_" << XFormNode->getName()
757          << "(SDNode *" << C2 << ") {\n";
758       if (ClassName != "SDNode")
759         OS << "  " << ClassName << " *N = cast<" << ClassName << ">(inN);\n";
760       OS << Code << "\n}\n";
761     }
762
763     Xforms.pop_back();
764   }
765 }
766
767
768
769 /// ParsePatternFragments - Parse all of the PatFrag definitions in the .td
770 /// file, building up the PatternFragments map.  After we've collected them all,
771 /// inline fragments together as necessary, so that there are no references left
772 /// inside a pattern fragment to a pattern fragment.
773 ///
774 /// This also emits all of the predicate functions to the output file.
775 ///
776 void DAGISelEmitter::ParsePatternFragments(std::ostream &OS) {
777   std::vector<Record*> Fragments = Records.getAllDerivedDefinitions("PatFrag");
778   
779   // First step, parse all of the fragments and emit predicate functions.
780   OS << "\n// Predicate functions.\n";
781   for (unsigned i = 0, e = Fragments.size(); i != e; ++i) {
782     DagInit *Tree = Fragments[i]->getValueAsDag("Fragment");
783     TreePattern *P = new TreePattern(Fragments[i], Tree, *this);
784     PatternFragments[Fragments[i]] = P;
785     
786     // Validate the argument list, converting it to map, to discard duplicates.
787     std::vector<std::string> &Args = P->getArgList();
788     std::set<std::string> OperandsMap(Args.begin(), Args.end());
789     
790     if (OperandsMap.count(""))
791       P->error("Cannot have unnamed 'node' values in pattern fragment!");
792     
793     // Parse the operands list.
794     DagInit *OpsList = Fragments[i]->getValueAsDag("Operands");
795     if (OpsList->getNodeType()->getName() != "ops")
796       P->error("Operands list should start with '(ops ... '!");
797     
798     // Copy over the arguments.       
799     Args.clear();
800     for (unsigned j = 0, e = OpsList->getNumArgs(); j != e; ++j) {
801       if (!dynamic_cast<DefInit*>(OpsList->getArg(j)) ||
802           static_cast<DefInit*>(OpsList->getArg(j))->
803           getDef()->getName() != "node")
804         P->error("Operands list should all be 'node' values.");
805       if (OpsList->getArgName(j).empty())
806         P->error("Operands list should have names for each operand!");
807       if (!OperandsMap.count(OpsList->getArgName(j)))
808         P->error("'" + OpsList->getArgName(j) +
809                  "' does not occur in pattern or was multiply specified!");
810       OperandsMap.erase(OpsList->getArgName(j));
811       Args.push_back(OpsList->getArgName(j));
812     }
813     
814     if (!OperandsMap.empty())
815       P->error("Operands list does not contain an entry for operand '" +
816                *OperandsMap.begin() + "'!");
817
818     // If there is a code init for this fragment, emit the predicate code and
819     // keep track of the fact that this fragment uses it.
820     std::string Code = Fragments[i]->getValueAsCode("Predicate");
821     if (!Code.empty()) {
822       assert(!P->getOnlyTree()->isLeaf() && "Can't be a leaf!");
823       std::string ClassName =
824         getSDNodeInfo(P->getOnlyTree()->getOperator()).getSDClassName();
825       const char *C2 = ClassName == "SDNode" ? "N" : "inN";
826       
827       OS << "inline bool Predicate_" << Fragments[i]->getName()
828          << "(SDNode *" << C2 << ") {\n";
829       if (ClassName != "SDNode")
830         OS << "  " << ClassName << " *N = cast<" << ClassName << ">(inN);\n";
831       OS << Code << "\n}\n";
832       P->getOnlyTree()->setPredicateFn("Predicate_"+Fragments[i]->getName());
833     }
834     
835     // If there is a node transformation corresponding to this, keep track of
836     // it.
837     Record *Transform = Fragments[i]->getValueAsDef("OperandTransform");
838     if (!getSDNodeTransform(Transform).second.empty())    // not noop xform?
839       P->getOnlyTree()->setTransformFn(Transform);
840   }
841   
842   OS << "\n\n";
843
844   // Now that we've parsed all of the tree fragments, do a closure on them so
845   // that there are not references to PatFrags left inside of them.
846   for (std::map<Record*, TreePattern*>::iterator I = PatternFragments.begin(),
847        E = PatternFragments.end(); I != E; ++I) {
848     TreePattern *ThePat = I->second;
849     ThePat->InlinePatternFragments();
850         
851     // Infer as many types as possible.  Don't worry about it if we don't infer
852     // all of them, some may depend on the inputs of the pattern.
853     try {
854       ThePat->InferAllTypes();
855     } catch (...) {
856       // If this pattern fragment is not supported by this target (no types can
857       // satisfy its constraints), just ignore it.  If the bogus pattern is
858       // actually used by instructions, the type consistency error will be
859       // reported there.
860     }
861     
862     // If debugging, print out the pattern fragment result.
863     DEBUG(ThePat->dump());
864   }
865 }
866
867 /// HandleUse - Given "Pat" a leaf in the pattern, check to see if it is an
868 /// instruction input.  Return true if this is a real use.
869 static bool HandleUse(TreePattern *I, TreePatternNode *Pat,
870                       std::map<std::string, TreePatternNode*> &InstInputs) {
871   // No name -> not interesting.
872   if (Pat->getName().empty()) {
873     if (Pat->isLeaf()) {
874       DefInit *DI = dynamic_cast<DefInit*>(Pat->getLeafValue());
875       if (DI && DI->getDef()->isSubClassOf("RegisterClass"))
876         I->error("Input " + DI->getDef()->getName() + " must be named!");
877
878     }
879     return false;
880   }
881
882   Record *Rec;
883   if (Pat->isLeaf()) {
884     DefInit *DI = dynamic_cast<DefInit*>(Pat->getLeafValue());
885     if (!DI) I->error("Input $" + Pat->getName() + " must be an identifier!");
886     Rec = DI->getDef();
887   } else {
888     assert(Pat->getNumChildren() == 0 && "can't be a use with children!");
889     Rec = Pat->getOperator();
890   }
891
892   TreePatternNode *&Slot = InstInputs[Pat->getName()];
893   if (!Slot) {
894     Slot = Pat;
895   } else {
896     Record *SlotRec;
897     if (Slot->isLeaf()) {
898       SlotRec = dynamic_cast<DefInit*>(Slot->getLeafValue())->getDef();
899     } else {
900       assert(Slot->getNumChildren() == 0 && "can't be a use with children!");
901       SlotRec = Slot->getOperator();
902     }
903     
904     // Ensure that the inputs agree if we've already seen this input.
905     if (Rec != SlotRec)
906       I->error("All $" + Pat->getName() + " inputs must agree with each other");
907     if (Slot->getExtType() != Pat->getExtType())
908       I->error("All $" + Pat->getName() + " inputs must agree with each other");
909   }
910   return true;
911 }
912
913 /// FindPatternInputsAndOutputs - Scan the specified TreePatternNode (which is
914 /// part of "I", the instruction), computing the set of inputs and outputs of
915 /// the pattern.  Report errors if we see anything naughty.
916 void DAGISelEmitter::
917 FindPatternInputsAndOutputs(TreePattern *I, TreePatternNode *Pat,
918                             std::map<std::string, TreePatternNode*> &InstInputs,
919                             std::map<std::string, Record*> &InstResults) {
920   if (Pat->isLeaf()) {
921     bool isUse = HandleUse(I, Pat, InstInputs);
922     if (!isUse && Pat->getTransformFn())
923       I->error("Cannot specify a transform function for a non-input value!");
924     return;
925   } else if (Pat->getOperator()->getName() != "set") {
926     // If this is not a set, verify that the children nodes are not void typed,
927     // and recurse.
928     for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i) {
929       if (Pat->getChild(i)->getExtType() == MVT::isVoid)
930         I->error("Cannot have void nodes inside of patterns!");
931       FindPatternInputsAndOutputs(I, Pat->getChild(i), InstInputs, InstResults);
932     }
933     
934     // If this is a non-leaf node with no children, treat it basically as if
935     // it were a leaf.  This handles nodes like (imm).
936     bool isUse = false;
937     if (Pat->getNumChildren() == 0)
938       isUse = HandleUse(I, Pat, InstInputs);
939     
940     if (!isUse && Pat->getTransformFn())
941       I->error("Cannot specify a transform function for a non-input value!");
942     return;
943   } 
944   
945   // Otherwise, this is a set, validate and collect instruction results.
946   if (Pat->getNumChildren() == 0)
947     I->error("set requires operands!");
948   else if (Pat->getNumChildren() & 1)
949     I->error("set requires an even number of operands");
950   
951   if (Pat->getTransformFn())
952     I->error("Cannot specify a transform function on a set node!");
953   
954   // Check the set destinations.
955   unsigned NumValues = Pat->getNumChildren()/2;
956   for (unsigned i = 0; i != NumValues; ++i) {
957     TreePatternNode *Dest = Pat->getChild(i);
958     if (!Dest->isLeaf())
959       I->error("set destination should be a virtual register!");
960     
961     DefInit *Val = dynamic_cast<DefInit*>(Dest->getLeafValue());
962     if (!Val)
963       I->error("set destination should be a virtual register!");
964     
965     if (!Val->getDef()->isSubClassOf("RegisterClass"))
966       I->error("set destination should be a virtual register!");
967     if (Dest->getName().empty())
968       I->error("set destination must have a name!");
969     if (InstResults.count(Dest->getName()))
970       I->error("cannot set '" + Dest->getName() +"' multiple times");
971     InstResults[Dest->getName()] = Val->getDef();
972
973     // Verify and collect info from the computation.
974     FindPatternInputsAndOutputs(I, Pat->getChild(i+NumValues),
975                                 InstInputs, InstResults);
976   }
977 }
978
979
980 /// ParseInstructions - Parse all of the instructions, inlining and resolving
981 /// any fragments involved.  This populates the Instructions list with fully
982 /// resolved instructions.
983 void DAGISelEmitter::ParseInstructions() {
984   std::vector<Record*> Instrs = Records.getAllDerivedDefinitions("Instruction");
985   
986   for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
987     ListInit *LI = 0;
988     
989     if (dynamic_cast<ListInit*>(Instrs[i]->getValueInit("Pattern")))
990       LI = Instrs[i]->getValueAsListInit("Pattern");
991     
992     // If there is no pattern, only collect minimal information about the
993     // instruction for its operand list.  We have to assume that there is one
994     // result, as we have no detailed info.
995     if (!LI || LI->getSize() == 0) {
996       std::vector<MVT::ValueType> ResultTypes;
997       std::vector<MVT::ValueType> OperandTypes;
998       
999       CodeGenInstruction &InstInfo =Target.getInstruction(Instrs[i]->getName());
1000       
1001       // Doesn't even define a result?
1002       if (InstInfo.OperandList.size() == 0)
1003         continue;
1004       
1005       // Assume the first operand is the result.
1006       ResultTypes.push_back(InstInfo.OperandList[0].Ty);
1007       
1008       // The rest are inputs.
1009       for (unsigned j = 1, e = InstInfo.OperandList.size(); j != e; ++j)
1010         OperandTypes.push_back(InstInfo.OperandList[j].Ty);
1011       
1012       // Create and insert the instruction.
1013       Instructions.insert(std::make_pair(Instrs[i], 
1014                             DAGInstruction(0, ResultTypes, OperandTypes)));
1015       continue;  // no pattern.
1016     }
1017     
1018     // Parse the instruction.
1019     TreePattern *I = new TreePattern(Instrs[i], LI, *this);
1020     // Inline pattern fragments into it.
1021     I->InlinePatternFragments();
1022     
1023     // Infer as many types as possible.  If we cannot infer all of them, we can
1024     // never do anything with this instruction pattern: report it to the user.
1025     if (!I->InferAllTypes())
1026       I->error("Could not infer all types in pattern!");
1027     
1028     // InstInputs - Keep track of all of the inputs of the instruction, along 
1029     // with the record they are declared as.
1030     std::map<std::string, TreePatternNode*> InstInputs;
1031     
1032     // InstResults - Keep track of all the virtual registers that are 'set'
1033     // in the instruction, including what reg class they are.
1034     std::map<std::string, Record*> InstResults;
1035     
1036     // Verify that the top-level forms in the instruction are of void type, and
1037     // fill in the InstResults map.
1038     for (unsigned j = 0, e = I->getNumTrees(); j != e; ++j) {
1039       TreePatternNode *Pat = I->getTree(j);
1040       if (Pat->getExtType() != MVT::isVoid) {
1041         I->dump();
1042         I->error("Top-level forms in instruction pattern should have"
1043                  " void types");
1044       }
1045
1046       // Find inputs and outputs, and verify the structure of the uses/defs.
1047       FindPatternInputsAndOutputs(I, Pat, InstInputs, InstResults);
1048     }
1049
1050     // Now that we have inputs and outputs of the pattern, inspect the operands
1051     // list for the instruction.  This determines the order that operands are
1052     // added to the machine instruction the node corresponds to.
1053     unsigned NumResults = InstResults.size();
1054
1055     // Parse the operands list from the (ops) list, validating it.
1056     std::vector<std::string> &Args = I->getArgList();
1057     assert(Args.empty() && "Args list should still be empty here!");
1058     CodeGenInstruction &CGI = Target.getInstruction(Instrs[i]->getName());
1059
1060     // Check that all of the results occur first in the list.
1061     std::vector<MVT::ValueType> ResultTypes;
1062     for (unsigned i = 0; i != NumResults; ++i) {
1063       if (i == CGI.OperandList.size())
1064         I->error("'" + InstResults.begin()->first +
1065                  "' set but does not appear in operand list!");
1066       const std::string &OpName = CGI.OperandList[i].Name;
1067       
1068       // Check that it exists in InstResults.
1069       Record *R = InstResults[OpName];
1070       if (R == 0)
1071         I->error("Operand $" + OpName + " should be a set destination: all "
1072                  "outputs must occur before inputs in operand list!");
1073       
1074       if (CGI.OperandList[i].Rec != R)
1075         I->error("Operand $" + OpName + " class mismatch!");
1076       
1077       // Remember the return type.
1078       ResultTypes.push_back(CGI.OperandList[i].Ty);
1079       
1080       // Okay, this one checks out.
1081       InstResults.erase(OpName);
1082     }
1083
1084     // Loop over the inputs next.  Make a copy of InstInputs so we can destroy
1085     // the copy while we're checking the inputs.
1086     std::map<std::string, TreePatternNode*> InstInputsCheck(InstInputs);
1087
1088     std::vector<TreePatternNode*> ResultNodeOperands;
1089     std::vector<MVT::ValueType> OperandTypes;
1090     for (unsigned i = NumResults, e = CGI.OperandList.size(); i != e; ++i) {
1091       const std::string &OpName = CGI.OperandList[i].Name;
1092       if (OpName.empty())
1093         I->error("Operand #" + utostr(i) + " in operands list has no name!");
1094
1095       if (!InstInputsCheck.count(OpName))
1096         I->error("Operand $" + OpName +
1097                  " does not appear in the instruction pattern");
1098       TreePatternNode *InVal = InstInputsCheck[OpName];
1099       InstInputsCheck.erase(OpName);   // It occurred, remove from map.
1100       if (CGI.OperandList[i].Ty != InVal->getExtType())
1101         I->error("Operand $" + OpName +
1102                  "'s type disagrees between the operand and pattern");
1103       OperandTypes.push_back(InVal->getType());
1104       
1105       // Construct the result for the dest-pattern operand list.
1106       TreePatternNode *OpNode = InVal->clone();
1107       
1108       // No predicate is useful on the result.
1109       OpNode->setPredicateFn("");
1110       
1111       // Promote the xform function to be an explicit node if set.
1112       if (Record *Xform = OpNode->getTransformFn()) {
1113         OpNode->setTransformFn(0);
1114         std::vector<TreePatternNode*> Children;
1115         Children.push_back(OpNode);
1116         OpNode = new TreePatternNode(Xform, Children);
1117       }
1118       
1119       ResultNodeOperands.push_back(OpNode);
1120     }
1121     
1122     if (!InstInputsCheck.empty())
1123       I->error("Input operand $" + InstInputsCheck.begin()->first +
1124                " occurs in pattern but not in operands list!");
1125
1126     TreePatternNode *ResultPattern =
1127       new TreePatternNode(I->getRecord(), ResultNodeOperands);
1128
1129     // Create and insert the instruction.
1130     DAGInstruction TheInst(I, ResultTypes, OperandTypes);
1131     Instructions.insert(std::make_pair(I->getRecord(), TheInst));
1132
1133     // Use a temporary tree pattern to infer all types and make sure that the
1134     // constructed result is correct.  This depends on the instruction already
1135     // being inserted into the Instructions map.
1136     TreePattern Temp(I->getRecord(), ResultPattern, *this);
1137     Temp.InferAllTypes();
1138
1139     DAGInstruction &TheInsertedInst = Instructions.find(I->getRecord())->second;
1140     TheInsertedInst.setResultPattern(Temp.getOnlyTree());
1141     
1142     DEBUG(I->dump());
1143   }
1144    
1145   // If we can, convert the instructions to be patterns that are matched!
1146   for (std::map<Record*, DAGInstruction>::iterator II = Instructions.begin(),
1147        E = Instructions.end(); II != E; ++II) {
1148     TreePattern *I = II->second.getPattern();
1149     if (I == 0) continue;  // No pattern.
1150     
1151     if (I->getNumTrees() != 1) {
1152       std::cerr << "CANNOT HANDLE: " << I->getRecord()->getName() << " yet!";
1153       continue;
1154     }
1155     TreePatternNode *Pattern = I->getTree(0);
1156     if (Pattern->getOperator()->getName() != "set")
1157       continue;  // Not a set (store or something?)
1158     
1159     if (Pattern->getNumChildren() != 2)
1160       continue;  // Not a set of a single value (not handled so far)
1161     
1162     TreePatternNode *SrcPattern = Pattern->getChild(1)->clone();
1163     
1164     std::string Reason;
1165     if (!SrcPattern->canPatternMatch(Reason, *this))
1166       I->error("Instruction can never match: " + Reason);
1167     
1168     TreePatternNode *DstPattern = II->second.getResultPattern();
1169     PatternsToMatch.push_back(std::make_pair(SrcPattern, DstPattern));
1170   }
1171 }
1172
1173 void DAGISelEmitter::ParsePatterns() {
1174   std::vector<Record*> Patterns = Records.getAllDerivedDefinitions("Pattern");
1175
1176   for (unsigned i = 0, e = Patterns.size(); i != e; ++i) {
1177     DagInit *Tree = Patterns[i]->getValueAsDag("PatternToMatch");
1178     TreePattern *Pattern = new TreePattern(Patterns[i], Tree, *this);
1179
1180     // Inline pattern fragments into it.
1181     Pattern->InlinePatternFragments();
1182     
1183     // Infer as many types as possible.  If we cannot infer all of them, we can
1184     // never do anything with this pattern: report it to the user.
1185     if (!Pattern->InferAllTypes())
1186       Pattern->error("Could not infer all types in pattern!");
1187     
1188     ListInit *LI = Patterns[i]->getValueAsListInit("ResultInstrs");
1189     if (LI->getSize() == 0) continue;  // no pattern.
1190     
1191     // Parse the instruction.
1192     TreePattern *Result = new TreePattern(Patterns[i], LI, *this);
1193     
1194     // Inline pattern fragments into it.
1195     Result->InlinePatternFragments();
1196     
1197     // Infer as many types as possible.  If we cannot infer all of them, we can
1198     // never do anything with this pattern: report it to the user.
1199     if (!Result->InferAllTypes())
1200       Result->error("Could not infer all types in pattern result!");
1201    
1202     if (Result->getNumTrees() != 1)
1203       Result->error("Cannot handle instructions producing instructions "
1204                     "with temporaries yet!");
1205
1206     std::string Reason;
1207     if (!Pattern->getOnlyTree()->canPatternMatch(Reason, *this))
1208       Pattern->error("Pattern can never match: " + Reason);
1209     
1210     PatternsToMatch.push_back(std::make_pair(Pattern->getOnlyTree(),
1211                                              Result->getOnlyTree()));
1212   }
1213 }
1214
1215 /// CombineChildVariants - Given a bunch of permutations of each child of the
1216 /// 'operator' node, put them together in all possible ways.
1217 static void CombineChildVariants(TreePatternNode *Orig, 
1218                const std::vector<std::vector<TreePatternNode*> > &ChildVariants,
1219                                  std::vector<TreePatternNode*> &OutVariants,
1220                                  DAGISelEmitter &ISE) {
1221   // Make sure that each operand has at least one variant to choose from.
1222   for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
1223     if (ChildVariants[i].empty())
1224       return;
1225         
1226   // The end result is an all-pairs construction of the resultant pattern.
1227   std::vector<unsigned> Idxs;
1228   Idxs.resize(ChildVariants.size());
1229   bool NotDone = true;
1230   while (NotDone) {
1231     // Create the variant and add it to the output list.
1232     std::vector<TreePatternNode*> NewChildren;
1233     for (unsigned i = 0, e = ChildVariants.size(); i != e; ++i)
1234       NewChildren.push_back(ChildVariants[i][Idxs[i]]);
1235     TreePatternNode *R = new TreePatternNode(Orig->getOperator(), NewChildren);
1236     
1237     // Copy over properties.
1238     R->setName(Orig->getName());
1239     R->setPredicateFn(Orig->getPredicateFn());
1240     R->setTransformFn(Orig->getTransformFn());
1241     R->setType(Orig->getExtType());
1242     
1243     // If this pattern cannot every match, do not include it as a variant.
1244     std::string ErrString;
1245     if (!R->canPatternMatch(ErrString, ISE)) {
1246       delete R;
1247     } else {
1248       bool AlreadyExists = false;
1249       
1250       // Scan to see if this pattern has already been emitted.  We can get
1251       // duplication due to things like commuting:
1252       //   (and GPRC:$a, GPRC:$b) -> (and GPRC:$b, GPRC:$a)
1253       // which are the same pattern.  Ignore the dups.
1254       for (unsigned i = 0, e = OutVariants.size(); i != e; ++i)
1255         if (R->isIsomorphicTo(OutVariants[i])) {
1256           AlreadyExists = true;
1257           break;
1258         }
1259       
1260       if (AlreadyExists)
1261         delete R;
1262       else
1263         OutVariants.push_back(R);
1264     }
1265     
1266     // Increment indices to the next permutation.
1267     NotDone = false;
1268     // Look for something we can increment without causing a wrap-around.
1269     for (unsigned IdxsIdx = 0; IdxsIdx != Idxs.size(); ++IdxsIdx) {
1270       if (++Idxs[IdxsIdx] < ChildVariants[IdxsIdx].size()) {
1271         NotDone = true;   // Found something to increment.
1272         break;
1273       }
1274       Idxs[IdxsIdx] = 0;
1275     }
1276   }
1277 }
1278
1279 /// CombineChildVariants - A helper function for binary operators.
1280 ///
1281 static void CombineChildVariants(TreePatternNode *Orig, 
1282                                  const std::vector<TreePatternNode*> &LHS,
1283                                  const std::vector<TreePatternNode*> &RHS,
1284                                  std::vector<TreePatternNode*> &OutVariants,
1285                                  DAGISelEmitter &ISE) {
1286   std::vector<std::vector<TreePatternNode*> > ChildVariants;
1287   ChildVariants.push_back(LHS);
1288   ChildVariants.push_back(RHS);
1289   CombineChildVariants(Orig, ChildVariants, OutVariants, ISE);
1290 }  
1291
1292
1293 static void GatherChildrenOfAssociativeOpcode(TreePatternNode *N,
1294                                      std::vector<TreePatternNode *> &Children) {
1295   assert(N->getNumChildren()==2 &&"Associative but doesn't have 2 children!");
1296   Record *Operator = N->getOperator();
1297   
1298   // Only permit raw nodes.
1299   if (!N->getName().empty() || !N->getPredicateFn().empty() ||
1300       N->getTransformFn()) {
1301     Children.push_back(N);
1302     return;
1303   }
1304
1305   if (N->getChild(0)->isLeaf() || N->getChild(0)->getOperator() != Operator)
1306     Children.push_back(N->getChild(0));
1307   else
1308     GatherChildrenOfAssociativeOpcode(N->getChild(0), Children);
1309
1310   if (N->getChild(1)->isLeaf() || N->getChild(1)->getOperator() != Operator)
1311     Children.push_back(N->getChild(1));
1312   else
1313     GatherChildrenOfAssociativeOpcode(N->getChild(1), Children);
1314 }
1315
1316 /// GenerateVariantsOf - Given a pattern N, generate all permutations we can of
1317 /// the (potentially recursive) pattern by using algebraic laws.
1318 ///
1319 static void GenerateVariantsOf(TreePatternNode *N,
1320                                std::vector<TreePatternNode*> &OutVariants,
1321                                DAGISelEmitter &ISE) {
1322   // We cannot permute leaves.
1323   if (N->isLeaf()) {
1324     OutVariants.push_back(N);
1325     return;
1326   }
1327
1328   // Look up interesting info about the node.
1329   const SDNodeInfo &NodeInfo = ISE.getSDNodeInfo(N->getOperator());
1330
1331   // If this node is associative, reassociate.
1332   if (NodeInfo.hasProperty(SDNodeInfo::SDNPAssociative)) {
1333     // Reassociate by pulling together all of the linked operators 
1334     std::vector<TreePatternNode*> MaximalChildren;
1335     GatherChildrenOfAssociativeOpcode(N, MaximalChildren);
1336
1337     // Only handle child sizes of 3.  Otherwise we'll end up trying too many
1338     // permutations.
1339     if (MaximalChildren.size() == 3) {
1340       // Find the variants of all of our maximal children.
1341       std::vector<TreePatternNode*> AVariants, BVariants, CVariants;
1342       GenerateVariantsOf(MaximalChildren[0], AVariants, ISE);
1343       GenerateVariantsOf(MaximalChildren[1], BVariants, ISE);
1344       GenerateVariantsOf(MaximalChildren[2], CVariants, ISE);
1345       
1346       // There are only two ways we can permute the tree:
1347       //   (A op B) op C    and    A op (B op C)
1348       // Within these forms, we can also permute A/B/C.
1349       
1350       // Generate legal pair permutations of A/B/C.
1351       std::vector<TreePatternNode*> ABVariants;
1352       std::vector<TreePatternNode*> BAVariants;
1353       std::vector<TreePatternNode*> ACVariants;
1354       std::vector<TreePatternNode*> CAVariants;
1355       std::vector<TreePatternNode*> BCVariants;
1356       std::vector<TreePatternNode*> CBVariants;
1357       CombineChildVariants(N, AVariants, BVariants, ABVariants, ISE);
1358       CombineChildVariants(N, BVariants, AVariants, BAVariants, ISE);
1359       CombineChildVariants(N, AVariants, CVariants, ACVariants, ISE);
1360       CombineChildVariants(N, CVariants, AVariants, CAVariants, ISE);
1361       CombineChildVariants(N, BVariants, CVariants, BCVariants, ISE);
1362       CombineChildVariants(N, CVariants, BVariants, CBVariants, ISE);
1363
1364       // Combine those into the result: (x op x) op x
1365       CombineChildVariants(N, ABVariants, CVariants, OutVariants, ISE);
1366       CombineChildVariants(N, BAVariants, CVariants, OutVariants, ISE);
1367       CombineChildVariants(N, ACVariants, BVariants, OutVariants, ISE);
1368       CombineChildVariants(N, CAVariants, BVariants, OutVariants, ISE);
1369       CombineChildVariants(N, BCVariants, AVariants, OutVariants, ISE);
1370       CombineChildVariants(N, CBVariants, AVariants, OutVariants, ISE);
1371
1372       // Combine those into the result: x op (x op x)
1373       CombineChildVariants(N, CVariants, ABVariants, OutVariants, ISE);
1374       CombineChildVariants(N, CVariants, BAVariants, OutVariants, ISE);
1375       CombineChildVariants(N, BVariants, ACVariants, OutVariants, ISE);
1376       CombineChildVariants(N, BVariants, CAVariants, OutVariants, ISE);
1377       CombineChildVariants(N, AVariants, BCVariants, OutVariants, ISE);
1378       CombineChildVariants(N, AVariants, CBVariants, OutVariants, ISE);
1379       return;
1380     }
1381   }
1382   
1383   // Compute permutations of all children.
1384   std::vector<std::vector<TreePatternNode*> > ChildVariants;
1385   ChildVariants.resize(N->getNumChildren());
1386   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
1387     GenerateVariantsOf(N->getChild(i), ChildVariants[i], ISE);
1388
1389   // Build all permutations based on how the children were formed.
1390   CombineChildVariants(N, ChildVariants, OutVariants, ISE);
1391
1392   // If this node is commutative, consider the commuted order.
1393   if (NodeInfo.hasProperty(SDNodeInfo::SDNPCommutative)) {
1394     assert(N->getNumChildren()==2 &&"Commutative but doesn't have 2 children!");
1395     // Consider the commuted order.
1396     CombineChildVariants(N, ChildVariants[1], ChildVariants[0],
1397                          OutVariants, ISE);
1398   }
1399 }
1400
1401
1402 // GenerateVariants - Generate variants.  For example, commutative patterns can
1403 // match multiple ways.  Add them to PatternsToMatch as well.
1404 void DAGISelEmitter::GenerateVariants() {
1405   
1406   DEBUG(std::cerr << "Generating instruction variants.\n");
1407   
1408   // Loop over all of the patterns we've collected, checking to see if we can
1409   // generate variants of the instruction, through the exploitation of
1410   // identities.  This permits the target to provide agressive matching without
1411   // the .td file having to contain tons of variants of instructions.
1412   //
1413   // Note that this loop adds new patterns to the PatternsToMatch list, but we
1414   // intentionally do not reconsider these.  Any variants of added patterns have
1415   // already been added.
1416   //
1417   for (unsigned i = 0, e = PatternsToMatch.size(); i != e; ++i) {
1418     std::vector<TreePatternNode*> Variants;
1419     GenerateVariantsOf(PatternsToMatch[i].first, Variants, *this);
1420
1421     assert(!Variants.empty() && "Must create at least original variant!");
1422     Variants.erase(Variants.begin());  // Remove the original pattern.
1423
1424     if (Variants.empty())  // No variants for this pattern.
1425       continue;
1426
1427     DEBUG(std::cerr << "FOUND VARIANTS OF: ";
1428           PatternsToMatch[i].first->dump();
1429           std::cerr << "\n");
1430
1431     for (unsigned v = 0, e = Variants.size(); v != e; ++v) {
1432       TreePatternNode *Variant = Variants[v];
1433
1434       DEBUG(std::cerr << "  VAR#" << v <<  ": ";
1435             Variant->dump();
1436             std::cerr << "\n");
1437       
1438       // Scan to see if an instruction or explicit pattern already matches this.
1439       bool AlreadyExists = false;
1440       for (unsigned p = 0, e = PatternsToMatch.size(); p != e; ++p) {
1441         // Check to see if this variant already exists.
1442         if (Variant->isIsomorphicTo(PatternsToMatch[p].first)) {
1443           DEBUG(std::cerr << "  *** ALREADY EXISTS, ignoring variant.\n");
1444           AlreadyExists = true;
1445           break;
1446         }
1447       }
1448       // If we already have it, ignore the variant.
1449       if (AlreadyExists) continue;
1450
1451       // Otherwise, add it to the list of patterns we have.
1452       PatternsToMatch.push_back(std::make_pair(Variant, 
1453                                                PatternsToMatch[i].second));
1454     }
1455
1456     DEBUG(std::cerr << "\n");
1457   }
1458 }
1459
1460
1461 /// getPatternSize - Return the 'size' of this pattern.  We want to match large
1462 /// patterns before small ones.  This is used to determine the size of a
1463 /// pattern.
1464 static unsigned getPatternSize(TreePatternNode *P) {
1465   assert(isExtIntegerVT(P->getExtType()) || 
1466          isExtFloatingPointVT(P->getExtType()) &&
1467          "Not a valid pattern node to size!");
1468   unsigned Size = 1;  // The node itself.
1469   
1470   // Count children in the count if they are also nodes.
1471   for (unsigned i = 0, e = P->getNumChildren(); i != e; ++i) {
1472     TreePatternNode *Child = P->getChild(i);
1473     if (!Child->isLeaf() && Child->getExtType() != MVT::Other)
1474       Size += getPatternSize(Child);
1475     else if (Child->isLeaf() && dynamic_cast<IntInit*>(Child->getLeafValue())) {
1476       ++Size;  // Matches a ConstantSDNode.
1477     }
1478   }
1479   
1480   return Size;
1481 }
1482
1483 /// getResultPatternCost - Compute the number of instructions for this pattern.
1484 /// This is a temporary hack.  We should really include the instruction
1485 /// latencies in this calculation.
1486 static unsigned getResultPatternCost(TreePatternNode *P) {
1487   if (P->isLeaf()) return 0;
1488   
1489   unsigned Cost = P->getOperator()->isSubClassOf("Instruction");
1490   for (unsigned i = 0, e = P->getNumChildren(); i != e; ++i)
1491     Cost += getResultPatternCost(P->getChild(i));
1492   return Cost;
1493 }
1494
1495 // PatternSortingPredicate - return true if we prefer to match LHS before RHS.
1496 // In particular, we want to match maximal patterns first and lowest cost within
1497 // a particular complexity first.
1498 struct PatternSortingPredicate {
1499   bool operator()(DAGISelEmitter::PatternToMatch *LHS,
1500                   DAGISelEmitter::PatternToMatch *RHS) {
1501     unsigned LHSSize = getPatternSize(LHS->first);
1502     unsigned RHSSize = getPatternSize(RHS->first);
1503     if (LHSSize > RHSSize) return true;   // LHS -> bigger -> less cost
1504     if (LHSSize < RHSSize) return false;
1505     
1506     // If the patterns have equal complexity, compare generated instruction cost
1507     return getResultPatternCost(LHS->second) <getResultPatternCost(RHS->second);
1508   }
1509 };
1510
1511 /// EmitMatchForPattern - Emit a matcher for N, going to the label for PatternNo
1512 /// if the match fails.  At this point, we already know that the opcode for N
1513 /// matches, and the SDNode for the result has the RootName specified name.
1514 void DAGISelEmitter::EmitMatchForPattern(TreePatternNode *N,
1515                                          const std::string &RootName,
1516                                      std::map<std::string,std::string> &VarMap,
1517                                          unsigned PatternNo, std::ostream &OS) {
1518   assert(!N->isLeaf() && "Cannot match against a leaf!");
1519   
1520   // If this node has a name associated with it, capture it in VarMap.  If
1521   // we already saw this in the pattern, emit code to verify dagness.
1522   if (!N->getName().empty()) {
1523     std::string &VarMapEntry = VarMap[N->getName()];
1524     if (VarMapEntry.empty()) {
1525       VarMapEntry = RootName;
1526     } else {
1527       // If we get here, this is a second reference to a specific name.  Since
1528       // we already have checked that the first reference is valid, we don't
1529       // have to recursively match it, just check that it's the same as the
1530       // previously named thing.
1531       OS << "      if (" << VarMapEntry << " != " << RootName
1532          << ") goto P" << PatternNo << "Fail;\n";
1533       return;
1534     }
1535   }
1536   
1537   // Emit code to load the child nodes and match their contents recursively.
1538   for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i) {
1539     OS << "      SDOperand " << RootName << i <<" = " << RootName
1540        << ".getOperand(" << i << ");\n";
1541     TreePatternNode *Child = N->getChild(i);
1542     
1543     if (!Child->isLeaf()) {
1544       // If it's not a leaf, recursively match.
1545       const SDNodeInfo &CInfo = getSDNodeInfo(Child->getOperator());
1546       OS << "      if (" << RootName << i << ".getOpcode() != "
1547          << CInfo.getEnumName() << ") goto P" << PatternNo << "Fail;\n";
1548       EmitMatchForPattern(Child, RootName + utostr(i), VarMap, PatternNo, OS);
1549     } else {
1550       // If this child has a name associated with it, capture it in VarMap.  If
1551       // we already saw this in the pattern, emit code to verify dagness.
1552       if (!Child->getName().empty()) {
1553         std::string &VarMapEntry = VarMap[Child->getName()];
1554         if (VarMapEntry.empty()) {
1555           VarMapEntry = RootName + utostr(i);
1556         } else {
1557           // If we get here, this is a second reference to a specific name.  Since
1558           // we already have checked that the first reference is valid, we don't
1559           // have to recursively match it, just check that it's the same as the
1560           // previously named thing.
1561           OS << "      if (" << VarMapEntry << " != " << RootName << i
1562           << ") goto P" << PatternNo << "Fail;\n";
1563           continue;
1564         }
1565       }
1566       
1567       // Handle leaves of various types.
1568       if (DefInit *DI = dynamic_cast<DefInit*>(Child->getLeafValue())) {
1569         Record *LeafRec = DI->getDef();
1570         if (LeafRec->isSubClassOf("RegisterClass")) {
1571           // Handle register references.  Nothing to do here.
1572         } else if (LeafRec->isSubClassOf("ValueType")) {
1573           // Make sure this is the specified value type.
1574           OS << "      if (cast<VTSDNode>(" << RootName << i << ")->getVT() != "
1575           << "MVT::" << LeafRec->getName() << ") goto P" << PatternNo
1576           << "Fail;\n";
1577         } else {
1578           Child->dump();
1579           assert(0 && "Unknown leaf type!");
1580         }
1581       } else if (IntInit *II = dynamic_cast<IntInit*>(Child->getLeafValue())) {
1582         OS << "      if (!isa<ConstantSDNode>(" << RootName << i << ") ||\n"
1583            << "          cast<ConstantSDNode>(" << RootName << i
1584            << ")->getValue() != " << II->getValue() << ")\n"
1585            << "        goto P" << PatternNo << "Fail;\n";
1586       } else {
1587         Child->dump();
1588         assert(0 && "Unknown leaf type!");
1589       }
1590     }
1591   }
1592   
1593   // If there is a node predicate for this, emit the call.
1594   if (!N->getPredicateFn().empty())
1595     OS << "      if (!" << N->getPredicateFn() << "(" << RootName
1596        << ".Val)) goto P" << PatternNo << "Fail;\n";
1597 }
1598
1599 /// CodeGenPatternResult - Emit the action for a pattern.  Now that it has
1600 /// matched, we actually have to build a DAG!
1601 unsigned DAGISelEmitter::
1602 CodeGenPatternResult(TreePatternNode *N, unsigned &Ctr,
1603                      std::map<std::string,std::string> &VariableMap, 
1604                      std::ostream &OS, bool isRoot) {
1605   // This is something selected from the pattern we matched.
1606   if (!N->getName().empty()) {
1607     assert(!isRoot && "Root of pattern cannot be a leaf!");
1608     std::string &Val = VariableMap[N->getName()];
1609     assert(!Val.empty() &&
1610            "Variable referenced but not defined and not caught earlier!");
1611     if (Val[0] == 'T' && Val[1] == 'm' && Val[2] == 'p') {
1612       // Already selected this operand, just return the tmpval.
1613       return atoi(Val.c_str()+3);
1614     }
1615     
1616     unsigned ResNo = Ctr++;
1617     if (!N->isLeaf() && N->getOperator()->getName() == "imm") {
1618       switch (N->getType()) {
1619       default: assert(0 && "Unknown type for constant node!");
1620       case MVT::i1:  OS << "      bool Tmp"; break;
1621       case MVT::i8:  OS << "      unsigned char Tmp"; break;
1622       case MVT::i16: OS << "      unsigned short Tmp"; break;
1623       case MVT::i32: OS << "      unsigned Tmp"; break;
1624       case MVT::i64: OS << "      uint64_t Tmp"; break;
1625       }
1626       OS << ResNo << "C = cast<ConstantSDNode>(" << Val << ")->getValue();\n";
1627       OS << "      SDOperand Tmp" << ResNo << " = CurDAG->getTargetConstant(Tmp"
1628          << ResNo << "C, MVT::" << getEnumName(N->getType()) << ");\n";
1629     } else {
1630       OS << "      SDOperand Tmp" << ResNo << " = Select(" << Val << ");\n";
1631     }
1632     // Add Tmp<ResNo> to VariableMap, so that we don't multiply select this
1633     // value if used multiple times by this pattern result.
1634     Val = "Tmp"+utostr(ResNo);
1635     return ResNo;
1636   }
1637   
1638   if (N->isLeaf()) {
1639     // If this is an explicit register reference, handle it.
1640     if (DefInit *DI = dynamic_cast<DefInit*>(N->getLeafValue())) {
1641       unsigned ResNo = Ctr++;
1642       if (DI->getDef()->isSubClassOf("Register")) {
1643         OS << "      SDOperand Tmp" << ResNo << " = CurDAG->getRegister("
1644            << getQualifiedName(DI->getDef()) << ", MVT::"
1645            << getEnumName(N->getType())
1646            << ");\n";
1647         return ResNo;
1648       }
1649     } else if (IntInit *II = dynamic_cast<IntInit*>(N->getLeafValue())) {
1650       unsigned ResNo = Ctr++;
1651       OS << "      SDOperand Tmp" << ResNo << " = CurDAG->getTargetConstant("
1652          << II->getValue() << ", MVT::"
1653         << getEnumName(N->getType())
1654         << ");\n";
1655       return ResNo;
1656     }
1657     
1658     N->dump();
1659     assert(0 && "Unknown leaf type!");
1660     return ~0U;
1661   }
1662
1663   Record *Op = N->getOperator();
1664   if (Op->isSubClassOf("Instruction")) {
1665     // Emit all of the operands.
1666     std::vector<unsigned> Ops;
1667     for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
1668       Ops.push_back(CodeGenPatternResult(N->getChild(i), Ctr, VariableMap, OS));
1669
1670     CodeGenInstruction &II = Target.getInstruction(Op->getName());
1671     unsigned ResNo = Ctr++;
1672     
1673     if (!isRoot) {
1674       OS << "      SDOperand Tmp" << ResNo << " = CurDAG->getTargetNode("
1675          << II.Namespace << "::" << II.TheDef->getName() << ", MVT::"
1676          << getEnumName(N->getType());
1677       for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1678         OS << ", Tmp" << Ops[i];
1679       OS << ");\n";
1680     } else {
1681       // If this instruction is the root, and if there is only one use of it,
1682       // use SelectNodeTo instead of getTargetNode to avoid an allocation.
1683       OS << "      if (N.Val->hasOneUse()) {\n";
1684       OS << "        CurDAG->SelectNodeTo(N.Val, "
1685          << II.Namespace << "::" << II.TheDef->getName() << ", MVT::"
1686          << getEnumName(N->getType());
1687       for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1688         OS << ", Tmp" << Ops[i];
1689       OS << ");\n";
1690       OS << "        return N;\n";
1691       OS << "      } else {\n";
1692       OS << "        return CodeGenMap[N] = CurDAG->getTargetNode("
1693       << II.Namespace << "::" << II.TheDef->getName() << ", MVT::"
1694       << getEnumName(N->getType());
1695       for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1696         OS << ", Tmp" << Ops[i];
1697       OS << ");\n";
1698       OS << "      }\n";
1699     }
1700     return ResNo;
1701   } else if (Op->isSubClassOf("SDNodeXForm")) {
1702     assert(N->getNumChildren() == 1 && "node xform should have one child!");
1703     unsigned OpVal = CodeGenPatternResult(N->getChild(0), Ctr, VariableMap, OS);
1704     
1705     unsigned ResNo = Ctr++;
1706     OS << "      SDOperand Tmp" << ResNo << " = Transform_" << Op->getName()
1707        << "(Tmp" << OpVal << ".Val);\n";
1708     if (isRoot) {
1709       OS << "      CodeGenMap[N] = Tmp" << ResNo << ";\n";
1710       OS << "      return Tmp" << ResNo << ";\n";
1711     }
1712     return ResNo;
1713   } else {
1714     N->dump();
1715     assert(0 && "Unknown node in result pattern!");
1716     return ~0U;
1717   }
1718 }
1719
1720 /// RemoveAllTypes - A quick recursive walk over a pattern which removes all
1721 /// type information from it.
1722 static void RemoveAllTypes(TreePatternNode *N) {
1723   N->setType(MVT::isUnknown);
1724   if (!N->isLeaf())
1725     for (unsigned i = 0, e = N->getNumChildren(); i != e; ++i)
1726       RemoveAllTypes(N->getChild(i));
1727 }
1728
1729 /// InsertOneTypeCheck - Insert a type-check for an unresolved type in 'Pat' and
1730 /// add it to the tree.  'Pat' and 'Other' are isomorphic trees except that 
1731 /// 'Pat' may be missing types.  If we find an unresolved type to add a check
1732 /// for, this returns true otherwise false if Pat has all types.
1733 static bool InsertOneTypeCheck(TreePatternNode *Pat, TreePatternNode *Other,
1734                                const std::string &Prefix, unsigned PatternNo,
1735                                std::ostream &OS) {
1736   // Did we find one?
1737   if (!Pat->hasTypeSet()) {
1738     // Move a type over from 'other' to 'pat'.
1739     Pat->setType(Other->getType());
1740     OS << "      if (" << Prefix << ".getValueType() != MVT::"
1741        << getName(Pat->getType()) << ") goto P" << PatternNo << "Fail;\n";
1742     return true;
1743   } else if (Pat->isLeaf()) {
1744     return false;
1745   }
1746   
1747   for (unsigned i = 0, e = Pat->getNumChildren(); i != e; ++i)
1748     if (InsertOneTypeCheck(Pat->getChild(i), Other->getChild(i),
1749                            Prefix + utostr(i), PatternNo, OS))
1750       return true;
1751   return false;
1752 }
1753
1754 /// EmitCodeForPattern - Given a pattern to match, emit code to the specified
1755 /// stream to match the pattern, and generate the code for the match if it
1756 /// succeeds.
1757 void DAGISelEmitter::EmitCodeForPattern(PatternToMatch &Pattern,
1758                                         std::ostream &OS) {
1759   static unsigned PatternCount = 0;
1760   unsigned PatternNo = PatternCount++;
1761   OS << "    { // Pattern #" << PatternNo << ": ";
1762   Pattern.first->print(OS);
1763   OS << "\n      // Emits: ";
1764   Pattern.second->print(OS);
1765   OS << "\n";
1766   OS << "      // Pattern complexity = " << getPatternSize(Pattern.first)
1767      << "  cost = " << getResultPatternCost(Pattern.second) << "\n";
1768
1769   // Emit the matcher, capturing named arguments in VariableMap.
1770   std::map<std::string,std::string> VariableMap;
1771   EmitMatchForPattern(Pattern.first, "N", VariableMap, PatternNo, OS);
1772   
1773   // TP - Get *SOME* tree pattern, we don't care which.
1774   TreePattern &TP = *PatternFragments.begin()->second;
1775   
1776   // At this point, we know that we structurally match the pattern, but the
1777   // types of the nodes may not match.  Figure out the fewest number of type 
1778   // comparisons we need to emit.  For example, if there is only one integer
1779   // type supported by a target, there should be no type comparisons at all for
1780   // integer patterns!
1781   //
1782   // To figure out the fewest number of type checks needed, clone the pattern,
1783   // remove the types, then perform type inference on the pattern as a whole.
1784   // If there are unresolved types, emit an explicit check for those types,
1785   // apply the type to the tree, then rerun type inference.  Iterate until all
1786   // types are resolved.
1787   //
1788   TreePatternNode *Pat = Pattern.first->clone();
1789   RemoveAllTypes(Pat);
1790   
1791   do {
1792     // Resolve/propagate as many types as possible.
1793     try {
1794       bool MadeChange = true;
1795       while (MadeChange)
1796         MadeChange = Pat->ApplyTypeConstraints(TP,true/*Ignore reg constraints*/);
1797     } catch (...) {
1798       assert(0 && "Error: could not find consistent types for something we"
1799              " already decided was ok!");
1800       abort();
1801     }
1802
1803     // Insert a check for an unresolved type and add it to the tree.  If we find
1804     // an unresolved type to add a check for, this returns true and we iterate,
1805     // otherwise we are done.
1806   } while (InsertOneTypeCheck(Pat, Pattern.first, "N", PatternNo, OS));
1807   
1808   unsigned TmpNo = 0;
1809   CodeGenPatternResult(Pattern.second, TmpNo,
1810                        VariableMap, OS, true /*the root*/);
1811   delete Pat;
1812   
1813   OS << "    }\n  P" << PatternNo << "Fail:\n";
1814 }
1815
1816
1817 namespace {
1818   /// CompareByRecordName - An ordering predicate that implements less-than by
1819   /// comparing the names records.
1820   struct CompareByRecordName {
1821     bool operator()(const Record *LHS, const Record *RHS) const {
1822       // Sort by name first.
1823       if (LHS->getName() < RHS->getName()) return true;
1824       // If both names are equal, sort by pointer.
1825       return LHS->getName() == RHS->getName() && LHS < RHS;
1826     }
1827   };
1828 }
1829
1830 void DAGISelEmitter::EmitInstructionSelector(std::ostream &OS) {
1831   std::string InstNS = Target.inst_begin()->second.Namespace;
1832   if (!InstNS.empty()) InstNS += "::";
1833   
1834   // Emit boilerplate.
1835   OS << "// The main instruction selector code.\n"
1836      << "SDOperand SelectCode(SDOperand N) {\n"
1837      << "  if (N.getOpcode() >= ISD::BUILTIN_OP_END &&\n"
1838      << "      N.getOpcode() < (ISD::BUILTIN_OP_END+" << InstNS
1839      << "INSTRUCTION_LIST_END))\n"
1840      << "    return N;   // Already selected.\n\n"
1841      << "  if (!N.Val->hasOneUse()) {\n"
1842   << "    std::map<SDOperand, SDOperand>::iterator CGMI = CodeGenMap.find(N);\n"
1843      << "    if (CGMI != CodeGenMap.end()) return CGMI->second;\n"
1844      << "  }\n"
1845      << "  switch (N.getOpcode()) {\n"
1846      << "  default: break;\n"
1847      << "  case ISD::EntryToken:       // These leaves remain the same.\n"
1848      << "    return N;\n"
1849      << "  case ISD::AssertSext:\n"
1850      << "  case ISD::AssertZext: {\n"
1851      << "    SDOperand Tmp0 = Select(N.getOperand(0));\n"
1852      << "    if (!N.Val->hasOneUse()) CodeGenMap[N] = Tmp0;\n"
1853      << "    return Tmp0;\n"
1854      << "  }\n";
1855     
1856   // Group the patterns by their top-level opcodes.
1857   std::map<Record*, std::vector<PatternToMatch*>,
1858            CompareByRecordName> PatternsByOpcode;
1859   for (unsigned i = 0, e = PatternsToMatch.size(); i != e; ++i)
1860     PatternsByOpcode[PatternsToMatch[i].first->getOperator()]
1861       .push_back(&PatternsToMatch[i]);
1862   
1863   // Loop over all of the case statements.
1864   for (std::map<Record*, std::vector<PatternToMatch*>,
1865                 CompareByRecordName>::iterator PBOI = PatternsByOpcode.begin(),
1866        E = PatternsByOpcode.end(); PBOI != E; ++PBOI) {
1867     const SDNodeInfo &OpcodeInfo = getSDNodeInfo(PBOI->first);
1868     std::vector<PatternToMatch*> &Patterns = PBOI->second;
1869     
1870     OS << "  case " << OpcodeInfo.getEnumName() << ":\n";
1871
1872     // We want to emit all of the matching code now.  However, we want to emit
1873     // the matches in order of minimal cost.  Sort the patterns so the least
1874     // cost one is at the start.
1875     std::stable_sort(Patterns.begin(), Patterns.end(),
1876                      PatternSortingPredicate());
1877     
1878     for (unsigned i = 0, e = Patterns.size(); i != e; ++i)
1879       EmitCodeForPattern(*Patterns[i], OS);
1880     OS << "    break;\n\n";
1881   }
1882   
1883
1884   OS << "  } // end of big switch.\n\n"
1885      << "  std::cerr << \"Cannot yet select: \";\n"
1886      << "  N.Val->dump();\n"
1887      << "  std::cerr << '\\n';\n"
1888      << "  abort();\n"
1889      << "}\n";
1890 }
1891
1892 void DAGISelEmitter::run(std::ostream &OS) {
1893   EmitSourceFileHeader("DAG Instruction Selector for the " + Target.getName() +
1894                        " target", OS);
1895   
1896   OS << "// *** NOTE: This file is #included into the middle of the target\n"
1897      << "// *** instruction selector class.  These functions are really "
1898      << "methods.\n\n";
1899   
1900   OS << "// Instance var to keep track of multiply used nodes that have \n"
1901      << "// already been selected.\n"
1902      << "std::map<SDOperand, SDOperand> CodeGenMap;\n";
1903   
1904   ParseNodeInfo();
1905   ParseNodeTransforms(OS);
1906   ParsePatternFragments(OS);
1907   ParseInstructions();
1908   ParsePatterns();
1909   
1910   // Generate variants.  For example, commutative patterns can match
1911   // multiple ways.  Add them to PatternsToMatch as well.
1912   GenerateVariants();
1913
1914   
1915   DEBUG(std::cerr << "\n\nALL PATTERNS TO MATCH:\n\n";
1916         for (unsigned i = 0, e = PatternsToMatch.size(); i != e; ++i) {
1917           std::cerr << "PATTERN: ";  PatternsToMatch[i].first->dump();
1918           std::cerr << "\nRESULT:  ";PatternsToMatch[i].second->dump();
1919           std::cerr << "\n";
1920         });
1921   
1922   // At this point, we have full information about the 'Patterns' we need to
1923   // parse, both implicitly from instructions as well as from explicit pattern
1924   // definitions.  Emit the resultant instruction selector.
1925   EmitInstructionSelector(OS);  
1926   
1927   for (std::map<Record*, TreePattern*>::iterator I = PatternFragments.begin(),
1928        E = PatternFragments.end(); I != E; ++I)
1929     delete I->second;
1930   PatternFragments.clear();
1931
1932   Instructions.clear();
1933 }