tblgen: Use appropriate LLVM-style RTTI functions.
[oota-llvm.git] / lib / TableGen / TGParser.cpp
1 //===- TGParser.cpp - Parser for TableGen Files ---------------------------===//
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 // Implement the Parser for TableGen.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "TGParser.h"
15 #include "llvm/TableGen/Record.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include <algorithm>
18 #include <sstream>
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/Support/CommandLine.h"
21 using namespace llvm;
22
23 //===----------------------------------------------------------------------===//
24 // Support Code for the Semantic Actions.
25 //===----------------------------------------------------------------------===//
26
27 namespace llvm {
28 struct SubClassReference {
29   SMLoc RefLoc;
30   Record *Rec;
31   std::vector<Init*> TemplateArgs;
32   SubClassReference() : Rec(0) {}
33
34   bool isInvalid() const { return Rec == 0; }
35 };
36
37 struct SubMultiClassReference {
38   SMLoc RefLoc;
39   MultiClass *MC;
40   std::vector<Init*> TemplateArgs;
41   SubMultiClassReference() : MC(0) {}
42
43   bool isInvalid() const { return MC == 0; }
44   void dump() const;
45 };
46
47 void SubMultiClassReference::dump() const {
48   errs() << "Multiclass:\n";
49
50   MC->dump();
51
52   errs() << "Template args:\n";
53   for (std::vector<Init *>::const_iterator i = TemplateArgs.begin(),
54          iend = TemplateArgs.end();
55        i != iend;
56        ++i) {
57     (*i)->dump();
58   }
59 }
60
61 } // end namespace llvm
62
63 bool TGParser::AddValue(Record *CurRec, SMLoc Loc, const RecordVal &RV) {
64   if (CurRec == 0)
65     CurRec = &CurMultiClass->Rec;
66
67   if (RecordVal *ERV = CurRec->getValue(RV.getNameInit())) {
68     // The value already exists in the class, treat this as a set.
69     if (ERV->setValue(RV.getValue()))
70       return Error(Loc, "New definition of '" + RV.getName() + "' of type '" +
71                    RV.getType()->getAsString() + "' is incompatible with " +
72                    "previous definition of type '" +
73                    ERV->getType()->getAsString() + "'");
74   } else {
75     CurRec->addValue(RV);
76   }
77   return false;
78 }
79
80 /// SetValue -
81 /// Return true on error, false on success.
82 bool TGParser::SetValue(Record *CurRec, SMLoc Loc, Init *ValName,
83                         const std::vector<unsigned> &BitList, Init *V) {
84   if (!V) return false;
85
86   if (CurRec == 0) CurRec = &CurMultiClass->Rec;
87
88   RecordVal *RV = CurRec->getValue(ValName);
89   if (RV == 0)
90     return Error(Loc, "Value '" + ValName->getAsUnquotedString()
91                  + "' unknown!");
92
93   // Do not allow assignments like 'X = X'.  This will just cause infinite loops
94   // in the resolution machinery.
95   if (BitList.empty())
96     if (VarInit *VI = dynamic_cast<VarInit*>(V))
97       if (VI->getNameInit() == ValName)
98         return false;
99
100   // If we are assigning to a subset of the bits in the value... then we must be
101   // assigning to a field of BitsRecTy, which must have a BitsInit
102   // initializer.
103   //
104   if (!BitList.empty()) {
105     BitsInit *CurVal = dynamic_cast<BitsInit*>(RV->getValue());
106     if (CurVal == 0)
107       return Error(Loc, "Value '" + ValName->getAsUnquotedString()
108                    + "' is not a bits type");
109
110     // Convert the incoming value to a bits type of the appropriate size...
111     Init *BI = V->convertInitializerTo(BitsRecTy::get(BitList.size()));
112     if (BI == 0) {
113       V->convertInitializerTo(BitsRecTy::get(BitList.size()));
114       return Error(Loc, "Initializer is not compatible with bit range");
115     }
116
117     // We should have a BitsInit type now.
118     BitsInit *BInit = dynamic_cast<BitsInit*>(BI);
119     assert(BInit != 0);
120
121     SmallVector<Init *, 16> NewBits(CurVal->getNumBits());
122
123     // Loop over bits, assigning values as appropriate.
124     for (unsigned i = 0, e = BitList.size(); i != e; ++i) {
125       unsigned Bit = BitList[i];
126       if (NewBits[Bit])
127         return Error(Loc, "Cannot set bit #" + utostr(Bit) + " of value '" +
128                      ValName->getAsUnquotedString() + "' more than once");
129       NewBits[Bit] = BInit->getBit(i);
130     }
131
132     for (unsigned i = 0, e = CurVal->getNumBits(); i != e; ++i)
133       if (NewBits[i] == 0)
134         NewBits[i] = CurVal->getBit(i);
135
136     V = BitsInit::get(NewBits);
137   }
138
139   if (RV->setValue(V))
140     return Error(Loc, "Value '" + ValName->getAsUnquotedString() + "' of type '"
141                  + RV->getType()->getAsString() +
142                  "' is incompatible with initializer '" + V->getAsString()
143                  + "'");
144   return false;
145 }
146
147 /// AddSubClass - Add SubClass as a subclass to CurRec, resolving its template
148 /// args as SubClass's template arguments.
149 bool TGParser::AddSubClass(Record *CurRec, SubClassReference &SubClass) {
150   Record *SC = SubClass.Rec;
151   // Add all of the values in the subclass into the current class.
152   const std::vector<RecordVal> &Vals = SC->getValues();
153   for (unsigned i = 0, e = Vals.size(); i != e; ++i)
154     if (AddValue(CurRec, SubClass.RefLoc, Vals[i]))
155       return true;
156
157   const std::vector<Init *> &TArgs = SC->getTemplateArgs();
158
159   // Ensure that an appropriate number of template arguments are specified.
160   if (TArgs.size() < SubClass.TemplateArgs.size())
161     return Error(SubClass.RefLoc, "More template args specified than expected");
162
163   // Loop over all of the template arguments, setting them to the specified
164   // value or leaving them as the default if necessary.
165   for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
166     if (i < SubClass.TemplateArgs.size()) {
167       // If a value is specified for this template arg, set it now.
168       if (SetValue(CurRec, SubClass.RefLoc, TArgs[i], std::vector<unsigned>(),
169                    SubClass.TemplateArgs[i]))
170         return true;
171
172       // Resolve it next.
173       CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
174
175       // Now remove it.
176       CurRec->removeValue(TArgs[i]);
177
178     } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
179       return Error(SubClass.RefLoc,"Value not specified for template argument #"
180                    + utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
181                    + ") of subclass '" + SC->getNameInitAsString() + "'!");
182     }
183   }
184
185   // Since everything went well, we can now set the "superclass" list for the
186   // current record.
187   const std::vector<Record*> &SCs = SC->getSuperClasses();
188   for (unsigned i = 0, e = SCs.size(); i != e; ++i) {
189     if (CurRec->isSubClassOf(SCs[i]))
190       return Error(SubClass.RefLoc,
191                    "Already subclass of '" + SCs[i]->getName() + "'!\n");
192     CurRec->addSuperClass(SCs[i]);
193   }
194
195   if (CurRec->isSubClassOf(SC))
196     return Error(SubClass.RefLoc,
197                  "Already subclass of '" + SC->getName() + "'!\n");
198   CurRec->addSuperClass(SC);
199   return false;
200 }
201
202 /// AddSubMultiClass - Add SubMultiClass as a subclass to
203 /// CurMC, resolving its template args as SubMultiClass's
204 /// template arguments.
205 bool TGParser::AddSubMultiClass(MultiClass *CurMC,
206                                 SubMultiClassReference &SubMultiClass) {
207   MultiClass *SMC = SubMultiClass.MC;
208   Record *CurRec = &CurMC->Rec;
209
210   const std::vector<RecordVal> &MCVals = CurRec->getValues();
211
212   // Add all of the values in the subclass into the current class.
213   const std::vector<RecordVal> &SMCVals = SMC->Rec.getValues();
214   for (unsigned i = 0, e = SMCVals.size(); i != e; ++i)
215     if (AddValue(CurRec, SubMultiClass.RefLoc, SMCVals[i]))
216       return true;
217
218   int newDefStart = CurMC->DefPrototypes.size();
219
220   // Add all of the defs in the subclass into the current multiclass.
221   for (MultiClass::RecordVector::const_iterator i = SMC->DefPrototypes.begin(),
222          iend = SMC->DefPrototypes.end();
223        i != iend;
224        ++i) {
225     // Clone the def and add it to the current multiclass
226     Record *NewDef = new Record(**i);
227
228     // Add all of the values in the superclass into the current def.
229     for (unsigned i = 0, e = MCVals.size(); i != e; ++i)
230       if (AddValue(NewDef, SubMultiClass.RefLoc, MCVals[i]))
231         return true;
232
233     CurMC->DefPrototypes.push_back(NewDef);
234   }
235
236   const std::vector<Init *> &SMCTArgs = SMC->Rec.getTemplateArgs();
237
238   // Ensure that an appropriate number of template arguments are
239   // specified.
240   if (SMCTArgs.size() < SubMultiClass.TemplateArgs.size())
241     return Error(SubMultiClass.RefLoc,
242                  "More template args specified than expected");
243
244   // Loop over all of the template arguments, setting them to the specified
245   // value or leaving them as the default if necessary.
246   for (unsigned i = 0, e = SMCTArgs.size(); i != e; ++i) {
247     if (i < SubMultiClass.TemplateArgs.size()) {
248       // If a value is specified for this template arg, set it in the
249       // superclass now.
250       if (SetValue(CurRec, SubMultiClass.RefLoc, SMCTArgs[i],
251                    std::vector<unsigned>(),
252                    SubMultiClass.TemplateArgs[i]))
253         return true;
254
255       // Resolve it next.
256       CurRec->resolveReferencesTo(CurRec->getValue(SMCTArgs[i]));
257
258       // Now remove it.
259       CurRec->removeValue(SMCTArgs[i]);
260
261       // If a value is specified for this template arg, set it in the
262       // new defs now.
263       for (MultiClass::RecordVector::iterator j =
264              CurMC->DefPrototypes.begin() + newDefStart,
265              jend = CurMC->DefPrototypes.end();
266            j != jend;
267            ++j) {
268         Record *Def = *j;
269
270         if (SetValue(Def, SubMultiClass.RefLoc, SMCTArgs[i],
271                      std::vector<unsigned>(),
272                      SubMultiClass.TemplateArgs[i]))
273           return true;
274
275         // Resolve it next.
276         Def->resolveReferencesTo(Def->getValue(SMCTArgs[i]));
277
278         // Now remove it
279         Def->removeValue(SMCTArgs[i]);
280       }
281     } else if (!CurRec->getValue(SMCTArgs[i])->getValue()->isComplete()) {
282       return Error(SubMultiClass.RefLoc,
283                    "Value not specified for template argument #"
284                    + utostr(i) + " (" + SMCTArgs[i]->getAsUnquotedString()
285                    + ") of subclass '" + SMC->Rec.getNameInitAsString() + "'!");
286     }
287   }
288
289   return false;
290 }
291
292 /// ProcessForeachDefs - Given a record, apply all of the variable
293 /// values in all surrounding foreach loops, creating new records for
294 /// each combination of values.
295 bool TGParser::ProcessForeachDefs(Record *CurRec, SMLoc Loc) {
296   if (Loops.empty())
297     return false;
298
299   // We want to instantiate a new copy of CurRec for each combination
300   // of nested loop iterator values.  We don't want top instantiate
301   // any copies until we have values for each loop iterator.
302   IterSet IterVals;
303   return ProcessForeachDefs(CurRec, Loc, IterVals);
304 }
305
306 /// ProcessForeachDefs - Given a record, a loop and a loop iterator,
307 /// apply each of the variable values in this loop and then process
308 /// subloops.
309 bool TGParser::ProcessForeachDefs(Record *CurRec, SMLoc Loc, IterSet &IterVals){
310   // Recursively build a tuple of iterator values.
311   if (IterVals.size() != Loops.size()) {
312     assert(IterVals.size() < Loops.size());
313     ForeachLoop &CurLoop = Loops[IterVals.size()];
314     ListInit *List = dynamic_cast<ListInit *>(CurLoop.ListValue);
315     if (List == 0) {
316       Error(Loc, "Loop list is not a list");
317       return true;
318     }
319
320     // Process each value.
321     for (int64_t i = 0; i < List->getSize(); ++i) {
322       Init *ItemVal = List->resolveListElementReference(*CurRec, 0, i);
323       IterVals.push_back(IterRecord(CurLoop.IterVar, ItemVal));
324       if (ProcessForeachDefs(CurRec, Loc, IterVals))
325         return true;
326       IterVals.pop_back();
327     }
328     return false;
329   }
330
331   // This is the bottom of the recursion. We have all of the iterator values
332   // for this point in the iteration space.  Instantiate a new record to
333   // reflect this combination of values.
334   Record *IterRec = new Record(*CurRec);
335
336   // Set the iterator values now.
337   for (unsigned i = 0, e = IterVals.size(); i != e; ++i) {
338     VarInit *IterVar = IterVals[i].IterVar;
339     TypedInit *IVal = dynamic_cast<TypedInit *>(IterVals[i].IterValue);
340     if (IVal == 0) {
341       Error(Loc, "foreach iterator value is untyped");
342       return true;
343     }
344
345     IterRec->addValue(RecordVal(IterVar->getName(), IVal->getType(), false));
346
347     if (SetValue(IterRec, Loc, IterVar->getName(),
348                  std::vector<unsigned>(), IVal)) {
349       Error(Loc, "when instantiating this def");
350       return true;
351     }
352
353     // Resolve it next.
354     IterRec->resolveReferencesTo(IterRec->getValue(IterVar->getName()));
355
356     // Remove it.
357     IterRec->removeValue(IterVar->getName());
358   }
359
360   if (Records.getDef(IterRec->getNameInitAsString())) {
361     Error(Loc, "def already exists: " + IterRec->getNameInitAsString());
362     return true;
363   }
364
365   Records.addDef(IterRec);
366   IterRec->resolveReferences();
367   return false;
368 }
369
370 //===----------------------------------------------------------------------===//
371 // Parser Code
372 //===----------------------------------------------------------------------===//
373
374 /// isObjectStart - Return true if this is a valid first token for an Object.
375 static bool isObjectStart(tgtok::TokKind K) {
376   return K == tgtok::Class || K == tgtok::Def ||
377          K == tgtok::Defm || K == tgtok::Let ||
378          K == tgtok::MultiClass || K == tgtok::Foreach;
379 }
380
381 static std::string GetNewAnonymousName() {
382   static unsigned AnonCounter = 0;
383   return "anonymous."+utostr(AnonCounter++);
384 }
385
386 /// ParseObjectName - If an object name is specified, return it.  Otherwise,
387 /// return an anonymous name.
388 ///   ObjectName ::= Value [ '#' Value ]*
389 ///   ObjectName ::= /*empty*/
390 ///
391 Init *TGParser::ParseObjectName(MultiClass *CurMultiClass) {
392   switch (Lex.getCode()) {
393   case tgtok::colon:
394   case tgtok::semi:
395   case tgtok::l_brace:
396     // These are all of the tokens that can begin an object body.
397     // Some of these can also begin values but we disallow those cases
398     // because they are unlikely to be useful.
399     return StringInit::get(GetNewAnonymousName());
400   default:
401     break;
402   }
403
404   Record *CurRec = 0;
405   if (CurMultiClass)
406     CurRec = &CurMultiClass->Rec;
407
408   RecTy *Type = 0;
409   if (CurRec) {
410     const TypedInit *CurRecName =
411       dynamic_cast<const TypedInit *>(CurRec->getNameInit());
412     if (!CurRecName) {
413       TokError("Record name is not typed!");
414       return 0;
415     }
416     Type = CurRecName->getType();
417   }
418
419   return ParseValue(CurRec, Type, ParseNameMode);
420 }
421
422 /// ParseClassID - Parse and resolve a reference to a class name.  This returns
423 /// null on error.
424 ///
425 ///    ClassID ::= ID
426 ///
427 Record *TGParser::ParseClassID() {
428   if (Lex.getCode() != tgtok::Id) {
429     TokError("expected name for ClassID");
430     return 0;
431   }
432
433   Record *Result = Records.getClass(Lex.getCurStrVal());
434   if (Result == 0)
435     TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
436
437   Lex.Lex();
438   return Result;
439 }
440
441 /// ParseMultiClassID - Parse and resolve a reference to a multiclass name.
442 /// This returns null on error.
443 ///
444 ///    MultiClassID ::= ID
445 ///
446 MultiClass *TGParser::ParseMultiClassID() {
447   if (Lex.getCode() != tgtok::Id) {
448     TokError("expected name for ClassID");
449     return 0;
450   }
451
452   MultiClass *Result = MultiClasses[Lex.getCurStrVal()];
453   if (Result == 0)
454     TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
455
456   Lex.Lex();
457   return Result;
458 }
459
460 Record *TGParser::ParseDefmID() {
461   if (Lex.getCode() != tgtok::Id) {
462     TokError("expected multiclass name");
463     return 0;
464   }
465
466   MultiClass *MC = MultiClasses[Lex.getCurStrVal()];
467   if (MC == 0) {
468     TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
469     return 0;
470   }
471
472   Lex.Lex();
473   return &MC->Rec;
474 }
475
476
477 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
478 /// subclass.  This returns a SubClassRefTy with a null Record* on error.
479 ///
480 ///  SubClassRef ::= ClassID
481 ///  SubClassRef ::= ClassID '<' ValueList '>'
482 ///
483 SubClassReference TGParser::
484 ParseSubClassReference(Record *CurRec, bool isDefm) {
485   SubClassReference Result;
486   Result.RefLoc = Lex.getLoc();
487
488   if (isDefm)
489     Result.Rec = ParseDefmID();
490   else
491     Result.Rec = ParseClassID();
492   if (Result.Rec == 0) return Result;
493
494   // If there is no template arg list, we're done.
495   if (Lex.getCode() != tgtok::less)
496     return Result;
497   Lex.Lex();  // Eat the '<'
498
499   if (Lex.getCode() == tgtok::greater) {
500     TokError("subclass reference requires a non-empty list of template values");
501     Result.Rec = 0;
502     return Result;
503   }
504
505   Result.TemplateArgs = ParseValueList(CurRec, Result.Rec);
506   if (Result.TemplateArgs.empty()) {
507     Result.Rec = 0;   // Error parsing value list.
508     return Result;
509   }
510
511   if (Lex.getCode() != tgtok::greater) {
512     TokError("expected '>' in template value list");
513     Result.Rec = 0;
514     return Result;
515   }
516   Lex.Lex();
517
518   return Result;
519 }
520
521 /// ParseSubMultiClassReference - Parse a reference to a subclass or to a
522 /// templated submulticlass.  This returns a SubMultiClassRefTy with a null
523 /// Record* on error.
524 ///
525 ///  SubMultiClassRef ::= MultiClassID
526 ///  SubMultiClassRef ::= MultiClassID '<' ValueList '>'
527 ///
528 SubMultiClassReference TGParser::
529 ParseSubMultiClassReference(MultiClass *CurMC) {
530   SubMultiClassReference Result;
531   Result.RefLoc = Lex.getLoc();
532
533   Result.MC = ParseMultiClassID();
534   if (Result.MC == 0) return Result;
535
536   // If there is no template arg list, we're done.
537   if (Lex.getCode() != tgtok::less)
538     return Result;
539   Lex.Lex();  // Eat the '<'
540
541   if (Lex.getCode() == tgtok::greater) {
542     TokError("subclass reference requires a non-empty list of template values");
543     Result.MC = 0;
544     return Result;
545   }
546
547   Result.TemplateArgs = ParseValueList(&CurMC->Rec, &Result.MC->Rec);
548   if (Result.TemplateArgs.empty()) {
549     Result.MC = 0;   // Error parsing value list.
550     return Result;
551   }
552
553   if (Lex.getCode() != tgtok::greater) {
554     TokError("expected '>' in template value list");
555     Result.MC = 0;
556     return Result;
557   }
558   Lex.Lex();
559
560   return Result;
561 }
562
563 /// ParseRangePiece - Parse a bit/value range.
564 ///   RangePiece ::= INTVAL
565 ///   RangePiece ::= INTVAL '-' INTVAL
566 ///   RangePiece ::= INTVAL INTVAL
567 bool TGParser::ParseRangePiece(std::vector<unsigned> &Ranges) {
568   if (Lex.getCode() != tgtok::IntVal) {
569     TokError("expected integer or bitrange");
570     return true;
571   }
572   int64_t Start = Lex.getCurIntVal();
573   int64_t End;
574
575   if (Start < 0)
576     return TokError("invalid range, cannot be negative");
577
578   switch (Lex.Lex()) {  // eat first character.
579   default:
580     Ranges.push_back(Start);
581     return false;
582   case tgtok::minus:
583     if (Lex.Lex() != tgtok::IntVal) {
584       TokError("expected integer value as end of range");
585       return true;
586     }
587     End = Lex.getCurIntVal();
588     break;
589   case tgtok::IntVal:
590     End = -Lex.getCurIntVal();
591     break;
592   }
593   if (End < 0)
594     return TokError("invalid range, cannot be negative");
595   Lex.Lex();
596
597   // Add to the range.
598   if (Start < End) {
599     for (; Start <= End; ++Start)
600       Ranges.push_back(Start);
601   } else {
602     for (; Start >= End; --Start)
603       Ranges.push_back(Start);
604   }
605   return false;
606 }
607
608 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
609 ///
610 ///   RangeList ::= RangePiece (',' RangePiece)*
611 ///
612 std::vector<unsigned> TGParser::ParseRangeList() {
613   std::vector<unsigned> Result;
614
615   // Parse the first piece.
616   if (ParseRangePiece(Result))
617     return std::vector<unsigned>();
618   while (Lex.getCode() == tgtok::comma) {
619     Lex.Lex();  // Eat the comma.
620
621     // Parse the next range piece.
622     if (ParseRangePiece(Result))
623       return std::vector<unsigned>();
624   }
625   return Result;
626 }
627
628 /// ParseOptionalRangeList - Parse either a range list in <>'s or nothing.
629 ///   OptionalRangeList ::= '<' RangeList '>'
630 ///   OptionalRangeList ::= /*empty*/
631 bool TGParser::ParseOptionalRangeList(std::vector<unsigned> &Ranges) {
632   if (Lex.getCode() != tgtok::less)
633     return false;
634
635   SMLoc StartLoc = Lex.getLoc();
636   Lex.Lex(); // eat the '<'
637
638   // Parse the range list.
639   Ranges = ParseRangeList();
640   if (Ranges.empty()) return true;
641
642   if (Lex.getCode() != tgtok::greater) {
643     TokError("expected '>' at end of range list");
644     return Error(StartLoc, "to match this '<'");
645   }
646   Lex.Lex();   // eat the '>'.
647   return false;
648 }
649
650 /// ParseOptionalBitList - Parse either a bit list in {}'s or nothing.
651 ///   OptionalBitList ::= '{' RangeList '}'
652 ///   OptionalBitList ::= /*empty*/
653 bool TGParser::ParseOptionalBitList(std::vector<unsigned> &Ranges) {
654   if (Lex.getCode() != tgtok::l_brace)
655     return false;
656
657   SMLoc StartLoc = Lex.getLoc();
658   Lex.Lex(); // eat the '{'
659
660   // Parse the range list.
661   Ranges = ParseRangeList();
662   if (Ranges.empty()) return true;
663
664   if (Lex.getCode() != tgtok::r_brace) {
665     TokError("expected '}' at end of bit list");
666     return Error(StartLoc, "to match this '{'");
667   }
668   Lex.Lex();   // eat the '}'.
669   return false;
670 }
671
672
673 /// ParseType - Parse and return a tblgen type.  This returns null on error.
674 ///
675 ///   Type ::= STRING                       // string type
676 ///   Type ::= CODE                         // code type
677 ///   Type ::= BIT                          // bit type
678 ///   Type ::= BITS '<' INTVAL '>'          // bits<x> type
679 ///   Type ::= INT                          // int type
680 ///   Type ::= LIST '<' Type '>'            // list<x> type
681 ///   Type ::= DAG                          // dag type
682 ///   Type ::= ClassID                      // Record Type
683 ///
684 RecTy *TGParser::ParseType() {
685   switch (Lex.getCode()) {
686   default: TokError("Unknown token when expecting a type"); return 0;
687   case tgtok::String: Lex.Lex(); return StringRecTy::get();
688   case tgtok::Code:   Lex.Lex(); return StringRecTy::get();
689   case tgtok::Bit:    Lex.Lex(); return BitRecTy::get();
690   case tgtok::Int:    Lex.Lex(); return IntRecTy::get();
691   case tgtok::Dag:    Lex.Lex(); return DagRecTy::get();
692   case tgtok::Id:
693     if (Record *R = ParseClassID()) return RecordRecTy::get(R);
694     return 0;
695   case tgtok::Bits: {
696     if (Lex.Lex() != tgtok::less) { // Eat 'bits'
697       TokError("expected '<' after bits type");
698       return 0;
699     }
700     if (Lex.Lex() != tgtok::IntVal) {  // Eat '<'
701       TokError("expected integer in bits<n> type");
702       return 0;
703     }
704     uint64_t Val = Lex.getCurIntVal();
705     if (Lex.Lex() != tgtok::greater) {  // Eat count.
706       TokError("expected '>' at end of bits<n> type");
707       return 0;
708     }
709     Lex.Lex();  // Eat '>'
710     return BitsRecTy::get(Val);
711   }
712   case tgtok::List: {
713     if (Lex.Lex() != tgtok::less) { // Eat 'bits'
714       TokError("expected '<' after list type");
715       return 0;
716     }
717     Lex.Lex();  // Eat '<'
718     RecTy *SubType = ParseType();
719     if (SubType == 0) return 0;
720
721     if (Lex.getCode() != tgtok::greater) {
722       TokError("expected '>' at end of list<ty> type");
723       return 0;
724     }
725     Lex.Lex();  // Eat '>'
726     return ListRecTy::get(SubType);
727   }
728   }
729 }
730
731 /// ParseIDValue - Parse an ID as a value and decode what it means.
732 ///
733 ///  IDValue ::= ID [def local value]
734 ///  IDValue ::= ID [def template arg]
735 ///  IDValue ::= ID [multiclass local value]
736 ///  IDValue ::= ID [multiclass template argument]
737 ///  IDValue ::= ID [def name]
738 ///
739 Init *TGParser::ParseIDValue(Record *CurRec, IDParseMode Mode) {
740   assert(Lex.getCode() == tgtok::Id && "Expected ID in ParseIDValue");
741   std::string Name = Lex.getCurStrVal();
742   SMLoc Loc = Lex.getLoc();
743   Lex.Lex();
744   return ParseIDValue(CurRec, Name, Loc);
745 }
746
747 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
748 /// has already been read.
749 Init *TGParser::ParseIDValue(Record *CurRec,
750                              const std::string &Name, SMLoc NameLoc,
751                              IDParseMode Mode) {
752   if (CurRec) {
753     if (const RecordVal *RV = CurRec->getValue(Name))
754       return VarInit::get(Name, RV->getType());
755
756     Init *TemplateArgName = QualifyName(*CurRec, CurMultiClass, Name, ":");
757
758     if (CurMultiClass)
759       TemplateArgName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
760                                     "::");
761
762     if (CurRec->isTemplateArg(TemplateArgName)) {
763       const RecordVal *RV = CurRec->getValue(TemplateArgName);
764       assert(RV && "Template arg doesn't exist??");
765       return VarInit::get(TemplateArgName, RV->getType());
766     }
767   }
768
769   if (CurMultiClass) {
770     Init *MCName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
771                                "::");
772
773     if (CurMultiClass->Rec.isTemplateArg(MCName)) {
774       const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
775       assert(RV && "Template arg doesn't exist??");
776       return VarInit::get(MCName, RV->getType());
777     }
778   }
779
780   // If this is in a foreach loop, make sure it's not a loop iterator
781   for (LoopVector::iterator i = Loops.begin(), iend = Loops.end();
782        i != iend;
783        ++i) {
784     VarInit *IterVar = dynamic_cast<VarInit *>(i->IterVar);
785     if (IterVar && IterVar->getName() == Name)
786       return IterVar;
787   }
788
789   if (Mode == ParseNameMode)
790     return StringInit::get(Name);
791
792   if (Record *D = Records.getDef(Name))
793     return DefInit::get(D);
794
795   if (Mode == ParseValueMode) {
796     Error(NameLoc, "Variable not defined: '" + Name + "'");
797     return 0;
798   }
799   
800   return StringInit::get(Name);
801 }
802
803 /// ParseOperation - Parse an operator.  This returns null on error.
804 ///
805 /// Operation ::= XOperator ['<' Type '>'] '(' Args ')'
806 ///
807 Init *TGParser::ParseOperation(Record *CurRec) {
808   switch (Lex.getCode()) {
809   default:
810     TokError("unknown operation");
811     return 0;
812   case tgtok::XHead:
813   case tgtok::XTail:
814   case tgtok::XEmpty:
815   case tgtok::XCast: {  // Value ::= !unop '(' Value ')'
816     UnOpInit::UnaryOp Code;
817     RecTy *Type = 0;
818
819     switch (Lex.getCode()) {
820     default: llvm_unreachable("Unhandled code!");
821     case tgtok::XCast:
822       Lex.Lex();  // eat the operation
823       Code = UnOpInit::CAST;
824
825       Type = ParseOperatorType();
826
827       if (Type == 0) {
828         TokError("did not get type for unary operator");
829         return 0;
830       }
831
832       break;
833     case tgtok::XHead:
834       Lex.Lex();  // eat the operation
835       Code = UnOpInit::HEAD;
836       break;
837     case tgtok::XTail:
838       Lex.Lex();  // eat the operation
839       Code = UnOpInit::TAIL;
840       break;
841     case tgtok::XEmpty:
842       Lex.Lex();  // eat the operation
843       Code = UnOpInit::EMPTY;
844       Type = IntRecTy::get();
845       break;
846     }
847     if (Lex.getCode() != tgtok::l_paren) {
848       TokError("expected '(' after unary operator");
849       return 0;
850     }
851     Lex.Lex();  // eat the '('
852
853     Init *LHS = ParseValue(CurRec);
854     if (LHS == 0) return 0;
855
856     if (Code == UnOpInit::HEAD
857         || Code == UnOpInit::TAIL
858         || Code == UnOpInit::EMPTY) {
859       ListInit *LHSl = dynamic_cast<ListInit*>(LHS);
860       StringInit *LHSs = dynamic_cast<StringInit*>(LHS);
861       TypedInit *LHSt = dynamic_cast<TypedInit*>(LHS);
862       if (LHSl == 0 && LHSs == 0 && LHSt == 0) {
863         TokError("expected list or string type argument in unary operator");
864         return 0;
865       }
866       if (LHSt) {
867         ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
868         StringRecTy *SType = dyn_cast<StringRecTy>(LHSt->getType());
869         if (LType == 0 && SType == 0) {
870           TokError("expected list or string type argumnet in unary operator");
871           return 0;
872         }
873       }
874
875       if (Code == UnOpInit::HEAD
876           || Code == UnOpInit::TAIL) {
877         if (LHSl == 0 && LHSt == 0) {
878           TokError("expected list type argumnet in unary operator");
879           return 0;
880         }
881
882         if (LHSl && LHSl->getSize() == 0) {
883           TokError("empty list argument in unary operator");
884           return 0;
885         }
886         if (LHSl) {
887           Init *Item = LHSl->getElement(0);
888           TypedInit *Itemt = dynamic_cast<TypedInit*>(Item);
889           if (Itemt == 0) {
890             TokError("untyped list element in unary operator");
891             return 0;
892           }
893           if (Code == UnOpInit::HEAD) {
894             Type = Itemt->getType();
895           } else {
896             Type = ListRecTy::get(Itemt->getType());
897           }
898         } else {
899           assert(LHSt && "expected list type argument in unary operator");
900           ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
901           if (LType == 0) {
902             TokError("expected list type argumnet in unary operator");
903             return 0;
904           }
905           if (Code == UnOpInit::HEAD) {
906             Type = LType->getElementType();
907           } else {
908             Type = LType;
909           }
910         }
911       }
912     }
913
914     if (Lex.getCode() != tgtok::r_paren) {
915       TokError("expected ')' in unary operator");
916       return 0;
917     }
918     Lex.Lex();  // eat the ')'
919     return (UnOpInit::get(Code, LHS, Type))->Fold(CurRec, CurMultiClass);
920   }
921
922   case tgtok::XConcat:
923   case tgtok::XSRA:
924   case tgtok::XSRL:
925   case tgtok::XSHL:
926   case tgtok::XEq:
927   case tgtok::XStrConcat: {  // Value ::= !binop '(' Value ',' Value ')'
928     tgtok::TokKind OpTok = Lex.getCode();
929     SMLoc OpLoc = Lex.getLoc();
930     Lex.Lex();  // eat the operation
931
932     BinOpInit::BinaryOp Code;
933     RecTy *Type = 0;
934
935     switch (OpTok) {
936     default: llvm_unreachable("Unhandled code!");
937     case tgtok::XConcat: Code = BinOpInit::CONCAT;Type = DagRecTy::get(); break;
938     case tgtok::XSRA:    Code = BinOpInit::SRA;   Type = IntRecTy::get(); break;
939     case tgtok::XSRL:    Code = BinOpInit::SRL;   Type = IntRecTy::get(); break;
940     case tgtok::XSHL:    Code = BinOpInit::SHL;   Type = IntRecTy::get(); break;
941     case tgtok::XEq:     Code = BinOpInit::EQ;    Type = BitRecTy::get(); break;
942     case tgtok::XStrConcat:
943       Code = BinOpInit::STRCONCAT;
944       Type = StringRecTy::get();
945       break;
946     }
947
948     if (Lex.getCode() != tgtok::l_paren) {
949       TokError("expected '(' after binary operator");
950       return 0;
951     }
952     Lex.Lex();  // eat the '('
953
954     SmallVector<Init*, 2> InitList;
955
956     InitList.push_back(ParseValue(CurRec));
957     if (InitList.back() == 0) return 0;
958
959     while (Lex.getCode() == tgtok::comma) {
960       Lex.Lex();  // eat the ','
961
962       InitList.push_back(ParseValue(CurRec));
963       if (InitList.back() == 0) return 0;
964     }
965
966     if (Lex.getCode() != tgtok::r_paren) {
967       TokError("expected ')' in operator");
968       return 0;
969     }
970     Lex.Lex();  // eat the ')'
971
972     // We allow multiple operands to associative operators like !strconcat as
973     // shorthand for nesting them.
974     if (Code == BinOpInit::STRCONCAT) {
975       while (InitList.size() > 2) {
976         Init *RHS = InitList.pop_back_val();
977         RHS = (BinOpInit::get(Code, InitList.back(), RHS, Type))
978                            ->Fold(CurRec, CurMultiClass);
979         InitList.back() = RHS;
980       }
981     }
982
983     if (InitList.size() == 2)
984       return (BinOpInit::get(Code, InitList[0], InitList[1], Type))
985         ->Fold(CurRec, CurMultiClass);
986
987     Error(OpLoc, "expected two operands to operator");
988     return 0;
989   }
990
991   case tgtok::XIf:
992   case tgtok::XForEach:
993   case tgtok::XSubst: {  // Value ::= !ternop '(' Value ',' Value ',' Value ')'
994     TernOpInit::TernaryOp Code;
995     RecTy *Type = 0;
996
997     tgtok::TokKind LexCode = Lex.getCode();
998     Lex.Lex();  // eat the operation
999     switch (LexCode) {
1000     default: llvm_unreachable("Unhandled code!");
1001     case tgtok::XIf:
1002       Code = TernOpInit::IF;
1003       break;
1004     case tgtok::XForEach:
1005       Code = TernOpInit::FOREACH;
1006       break;
1007     case tgtok::XSubst:
1008       Code = TernOpInit::SUBST;
1009       break;
1010     }
1011     if (Lex.getCode() != tgtok::l_paren) {
1012       TokError("expected '(' after ternary operator");
1013       return 0;
1014     }
1015     Lex.Lex();  // eat the '('
1016
1017     Init *LHS = ParseValue(CurRec);
1018     if (LHS == 0) return 0;
1019
1020     if (Lex.getCode() != tgtok::comma) {
1021       TokError("expected ',' in ternary operator");
1022       return 0;
1023     }
1024     Lex.Lex();  // eat the ','
1025
1026     Init *MHS = ParseValue(CurRec);
1027     if (MHS == 0) return 0;
1028
1029     if (Lex.getCode() != tgtok::comma) {
1030       TokError("expected ',' in ternary operator");
1031       return 0;
1032     }
1033     Lex.Lex();  // eat the ','
1034
1035     Init *RHS = ParseValue(CurRec);
1036     if (RHS == 0) return 0;
1037
1038     if (Lex.getCode() != tgtok::r_paren) {
1039       TokError("expected ')' in binary operator");
1040       return 0;
1041     }
1042     Lex.Lex();  // eat the ')'
1043
1044     switch (LexCode) {
1045     default: llvm_unreachable("Unhandled code!");
1046     case tgtok::XIf: {
1047       RecTy *MHSTy = 0;
1048       RecTy *RHSTy = 0;
1049
1050       if (TypedInit *MHSt = dynamic_cast<TypedInit*>(MHS))
1051         MHSTy = MHSt->getType();
1052       if (BitsInit *MHSbits = dynamic_cast<BitsInit*>(MHS))
1053         MHSTy = BitsRecTy::get(MHSbits->getNumBits());
1054       if (dynamic_cast<BitInit*>(MHS))
1055         MHSTy = BitRecTy::get();
1056
1057       if (TypedInit *RHSt = dynamic_cast<TypedInit*>(RHS))
1058         RHSTy = RHSt->getType();
1059       if (BitsInit *RHSbits = dynamic_cast<BitsInit*>(RHS))
1060         RHSTy = BitsRecTy::get(RHSbits->getNumBits());
1061       if (dynamic_cast<BitInit*>(RHS))
1062         RHSTy = BitRecTy::get();
1063
1064       // For UnsetInit, it's typed from the other hand.
1065       if (dynamic_cast<UnsetInit*>(MHS))
1066         MHSTy = RHSTy;
1067       if (dynamic_cast<UnsetInit*>(RHS))
1068         RHSTy = MHSTy;
1069
1070       if (!MHSTy || !RHSTy) {
1071         TokError("could not get type for !if");
1072         return 0;
1073       }
1074
1075       if (MHSTy->typeIsConvertibleTo(RHSTy)) {
1076         Type = RHSTy;
1077       } else if (RHSTy->typeIsConvertibleTo(MHSTy)) {
1078         Type = MHSTy;
1079       } else {
1080         TokError("inconsistent types for !if");
1081         return 0;
1082       }
1083       break;
1084     }
1085     case tgtok::XForEach: {
1086       TypedInit *MHSt = dynamic_cast<TypedInit *>(MHS);
1087       if (MHSt == 0) {
1088         TokError("could not get type for !foreach");
1089         return 0;
1090       }
1091       Type = MHSt->getType();
1092       break;
1093     }
1094     case tgtok::XSubst: {
1095       TypedInit *RHSt = dynamic_cast<TypedInit *>(RHS);
1096       if (RHSt == 0) {
1097         TokError("could not get type for !subst");
1098         return 0;
1099       }
1100       Type = RHSt->getType();
1101       break;
1102     }
1103     }
1104     return (TernOpInit::get(Code, LHS, MHS, RHS, Type))->Fold(CurRec,
1105                                                              CurMultiClass);
1106   }
1107   }
1108 }
1109
1110 /// ParseOperatorType - Parse a type for an operator.  This returns
1111 /// null on error.
1112 ///
1113 /// OperatorType ::= '<' Type '>'
1114 ///
1115 RecTy *TGParser::ParseOperatorType() {
1116   RecTy *Type = 0;
1117
1118   if (Lex.getCode() != tgtok::less) {
1119     TokError("expected type name for operator");
1120     return 0;
1121   }
1122   Lex.Lex();  // eat the <
1123
1124   Type = ParseType();
1125
1126   if (Type == 0) {
1127     TokError("expected type name for operator");
1128     return 0;
1129   }
1130
1131   if (Lex.getCode() != tgtok::greater) {
1132     TokError("expected type name for operator");
1133     return 0;
1134   }
1135   Lex.Lex();  // eat the >
1136
1137   return Type;
1138 }
1139
1140
1141 /// ParseSimpleValue - Parse a tblgen value.  This returns null on error.
1142 ///
1143 ///   SimpleValue ::= IDValue
1144 ///   SimpleValue ::= INTVAL
1145 ///   SimpleValue ::= STRVAL+
1146 ///   SimpleValue ::= CODEFRAGMENT
1147 ///   SimpleValue ::= '?'
1148 ///   SimpleValue ::= '{' ValueList '}'
1149 ///   SimpleValue ::= ID '<' ValueListNE '>'
1150 ///   SimpleValue ::= '[' ValueList ']'
1151 ///   SimpleValue ::= '(' IDValue DagArgList ')'
1152 ///   SimpleValue ::= CONCATTOK '(' Value ',' Value ')'
1153 ///   SimpleValue ::= SHLTOK '(' Value ',' Value ')'
1154 ///   SimpleValue ::= SRATOK '(' Value ',' Value ')'
1155 ///   SimpleValue ::= SRLTOK '(' Value ',' Value ')'
1156 ///   SimpleValue ::= STRCONCATTOK '(' Value ',' Value ')'
1157 ///
1158 Init *TGParser::ParseSimpleValue(Record *CurRec, RecTy *ItemType,
1159                                  IDParseMode Mode) {
1160   Init *R = 0;
1161   switch (Lex.getCode()) {
1162   default: TokError("Unknown token when parsing a value"); break;
1163   case tgtok::paste:
1164     // This is a leading paste operation.  This is deprecated but
1165     // still exists in some .td files.  Ignore it.
1166     Lex.Lex();  // Skip '#'.
1167     return ParseSimpleValue(CurRec, ItemType, Mode);
1168   case tgtok::IntVal: R = IntInit::get(Lex.getCurIntVal()); Lex.Lex(); break;
1169   case tgtok::StrVal: {
1170     std::string Val = Lex.getCurStrVal();
1171     Lex.Lex();
1172
1173     // Handle multiple consecutive concatenated strings.
1174     while (Lex.getCode() == tgtok::StrVal) {
1175       Val += Lex.getCurStrVal();
1176       Lex.Lex();
1177     }
1178
1179     R = StringInit::get(Val);
1180     break;
1181   }
1182   case tgtok::CodeFragment:
1183     R = StringInit::get(Lex.getCurStrVal());
1184     Lex.Lex();
1185     break;
1186   case tgtok::question:
1187     R = UnsetInit::get();
1188     Lex.Lex();
1189     break;
1190   case tgtok::Id: {
1191     SMLoc NameLoc = Lex.getLoc();
1192     std::string Name = Lex.getCurStrVal();
1193     if (Lex.Lex() != tgtok::less)  // consume the Id.
1194       return ParseIDValue(CurRec, Name, NameLoc, Mode);    // Value ::= IDValue
1195
1196     // Value ::= ID '<' ValueListNE '>'
1197     if (Lex.Lex() == tgtok::greater) {
1198       TokError("expected non-empty value list");
1199       return 0;
1200     }
1201
1202     // This is a CLASS<initvalslist> expression.  This is supposed to synthesize
1203     // a new anonymous definition, deriving from CLASS<initvalslist> with no
1204     // body.
1205     Record *Class = Records.getClass(Name);
1206     if (!Class) {
1207       Error(NameLoc, "Expected a class name, got '" + Name + "'");
1208       return 0;
1209     }
1210
1211     std::vector<Init*> ValueList = ParseValueList(CurRec, Class);
1212     if (ValueList.empty()) return 0;
1213
1214     if (Lex.getCode() != tgtok::greater) {
1215       TokError("expected '>' at end of value list");
1216       return 0;
1217     }
1218     Lex.Lex();  // eat the '>'
1219
1220     // Create the new record, set it as CurRec temporarily.
1221     static unsigned AnonCounter = 0;
1222     Record *NewRec = new Record("anonymous.val."+utostr(AnonCounter++),
1223                                 NameLoc,
1224                                 Records);
1225     SubClassReference SCRef;
1226     SCRef.RefLoc = NameLoc;
1227     SCRef.Rec = Class;
1228     SCRef.TemplateArgs = ValueList;
1229     // Add info about the subclass to NewRec.
1230     if (AddSubClass(NewRec, SCRef))
1231       return 0;
1232     NewRec->resolveReferences();
1233     Records.addDef(NewRec);
1234
1235     // The result of the expression is a reference to the new record.
1236     return DefInit::get(NewRec);
1237   }
1238   case tgtok::l_brace: {           // Value ::= '{' ValueList '}'
1239     SMLoc BraceLoc = Lex.getLoc();
1240     Lex.Lex(); // eat the '{'
1241     std::vector<Init*> Vals;
1242
1243     if (Lex.getCode() != tgtok::r_brace) {
1244       Vals = ParseValueList(CurRec);
1245       if (Vals.empty()) return 0;
1246     }
1247     if (Lex.getCode() != tgtok::r_brace) {
1248       TokError("expected '}' at end of bit list value");
1249       return 0;
1250     }
1251     Lex.Lex();  // eat the '}'
1252
1253     SmallVector<Init *, 16> NewBits(Vals.size());
1254
1255     for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1256       Init *Bit = Vals[i]->convertInitializerTo(BitRecTy::get());
1257       if (Bit == 0) {
1258         Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1259               ") is not convertable to a bit");
1260         return 0;
1261       }
1262       NewBits[Vals.size()-i-1] = Bit;
1263     }
1264     return BitsInit::get(NewBits);
1265   }
1266   case tgtok::l_square: {          // Value ::= '[' ValueList ']'
1267     Lex.Lex(); // eat the '['
1268     std::vector<Init*> Vals;
1269
1270     RecTy *DeducedEltTy = 0;
1271     ListRecTy *GivenListTy = 0;
1272
1273     if (ItemType != 0) {
1274       ListRecTy *ListType = dyn_cast<ListRecTy>(ItemType);
1275       if (ListType == 0) {
1276         std::stringstream s;
1277         s << "Type mismatch for list, expected list type, got "
1278           << ItemType->getAsString();
1279         TokError(s.str());
1280         return 0;
1281       }
1282       GivenListTy = ListType;
1283     }
1284
1285     if (Lex.getCode() != tgtok::r_square) {
1286       Vals = ParseValueList(CurRec, 0,
1287                             GivenListTy ? GivenListTy->getElementType() : 0);
1288       if (Vals.empty()) return 0;
1289     }
1290     if (Lex.getCode() != tgtok::r_square) {
1291       TokError("expected ']' at end of list value");
1292       return 0;
1293     }
1294     Lex.Lex();  // eat the ']'
1295
1296     RecTy *GivenEltTy = 0;
1297     if (Lex.getCode() == tgtok::less) {
1298       // Optional list element type
1299       Lex.Lex();  // eat the '<'
1300
1301       GivenEltTy = ParseType();
1302       if (GivenEltTy == 0) {
1303         // Couldn't parse element type
1304         return 0;
1305       }
1306
1307       if (Lex.getCode() != tgtok::greater) {
1308         TokError("expected '>' at end of list element type");
1309         return 0;
1310       }
1311       Lex.Lex();  // eat the '>'
1312     }
1313
1314     // Check elements
1315     RecTy *EltTy = 0;
1316     for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1317          i != ie;
1318          ++i) {
1319       TypedInit *TArg = dynamic_cast<TypedInit*>(*i);
1320       if (TArg == 0) {
1321         TokError("Untyped list element");
1322         return 0;
1323       }
1324       if (EltTy != 0) {
1325         EltTy = resolveTypes(EltTy, TArg->getType());
1326         if (EltTy == 0) {
1327           TokError("Incompatible types in list elements");
1328           return 0;
1329         }
1330       } else {
1331         EltTy = TArg->getType();
1332       }
1333     }
1334
1335     if (GivenEltTy != 0) {
1336       if (EltTy != 0) {
1337         // Verify consistency
1338         if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1339           TokError("Incompatible types in list elements");
1340           return 0;
1341         }
1342       }
1343       EltTy = GivenEltTy;
1344     }
1345
1346     if (EltTy == 0) {
1347       if (ItemType == 0) {
1348         TokError("No type for list");
1349         return 0;
1350       }
1351       DeducedEltTy = GivenListTy->getElementType();
1352     } else {
1353       // Make sure the deduced type is compatible with the given type
1354       if (GivenListTy) {
1355         if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1356           TokError("Element type mismatch for list");
1357           return 0;
1358         }
1359       }
1360       DeducedEltTy = EltTy;
1361     }
1362
1363     return ListInit::get(Vals, DeducedEltTy);
1364   }
1365   case tgtok::l_paren: {         // Value ::= '(' IDValue DagArgList ')'
1366     Lex.Lex();   // eat the '('
1367     if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1368       TokError("expected identifier in dag init");
1369       return 0;
1370     }
1371
1372     Init *Operator = ParseValue(CurRec);
1373     if (Operator == 0) return 0;
1374
1375     // If the operator name is present, parse it.
1376     std::string OperatorName;
1377     if (Lex.getCode() == tgtok::colon) {
1378       if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1379         TokError("expected variable name in dag operator");
1380         return 0;
1381       }
1382       OperatorName = Lex.getCurStrVal();
1383       Lex.Lex();  // eat the VarName.
1384     }
1385
1386     std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1387     if (Lex.getCode() != tgtok::r_paren) {
1388       DagArgs = ParseDagArgList(CurRec);
1389       if (DagArgs.empty()) return 0;
1390     }
1391
1392     if (Lex.getCode() != tgtok::r_paren) {
1393       TokError("expected ')' in dag init");
1394       return 0;
1395     }
1396     Lex.Lex();  // eat the ')'
1397
1398     return DagInit::get(Operator, OperatorName, DagArgs);
1399   }
1400
1401   case tgtok::XHead:
1402   case tgtok::XTail:
1403   case tgtok::XEmpty:
1404   case tgtok::XCast:  // Value ::= !unop '(' Value ')'
1405   case tgtok::XConcat:
1406   case tgtok::XSRA:
1407   case tgtok::XSRL:
1408   case tgtok::XSHL:
1409   case tgtok::XEq:
1410   case tgtok::XStrConcat:   // Value ::= !binop '(' Value ',' Value ')'
1411   case tgtok::XIf:
1412   case tgtok::XForEach:
1413   case tgtok::XSubst: {  // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1414     return ParseOperation(CurRec);
1415   }
1416   }
1417
1418   return R;
1419 }
1420
1421 /// ParseValue - Parse a tblgen value.  This returns null on error.
1422 ///
1423 ///   Value       ::= SimpleValue ValueSuffix*
1424 ///   ValueSuffix ::= '{' BitList '}'
1425 ///   ValueSuffix ::= '[' BitList ']'
1426 ///   ValueSuffix ::= '.' ID
1427 ///
1428 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType, IDParseMode Mode) {
1429   Init *Result = ParseSimpleValue(CurRec, ItemType, Mode);
1430   if (Result == 0) return 0;
1431
1432   // Parse the suffixes now if present.
1433   while (1) {
1434     switch (Lex.getCode()) {
1435     default: return Result;
1436     case tgtok::l_brace: {
1437       if (Mode == ParseNameMode || Mode == ParseForeachMode)
1438         // This is the beginning of the object body.
1439         return Result;
1440
1441       SMLoc CurlyLoc = Lex.getLoc();
1442       Lex.Lex(); // eat the '{'
1443       std::vector<unsigned> Ranges = ParseRangeList();
1444       if (Ranges.empty()) return 0;
1445
1446       // Reverse the bitlist.
1447       std::reverse(Ranges.begin(), Ranges.end());
1448       Result = Result->convertInitializerBitRange(Ranges);
1449       if (Result == 0) {
1450         Error(CurlyLoc, "Invalid bit range for value");
1451         return 0;
1452       }
1453
1454       // Eat the '}'.
1455       if (Lex.getCode() != tgtok::r_brace) {
1456         TokError("expected '}' at end of bit range list");
1457         return 0;
1458       }
1459       Lex.Lex();
1460       break;
1461     }
1462     case tgtok::l_square: {
1463       SMLoc SquareLoc = Lex.getLoc();
1464       Lex.Lex(); // eat the '['
1465       std::vector<unsigned> Ranges = ParseRangeList();
1466       if (Ranges.empty()) return 0;
1467
1468       Result = Result->convertInitListSlice(Ranges);
1469       if (Result == 0) {
1470         Error(SquareLoc, "Invalid range for list slice");
1471         return 0;
1472       }
1473
1474       // Eat the ']'.
1475       if (Lex.getCode() != tgtok::r_square) {
1476         TokError("expected ']' at end of list slice");
1477         return 0;
1478       }
1479       Lex.Lex();
1480       break;
1481     }
1482     case tgtok::period:
1483       if (Lex.Lex() != tgtok::Id) {  // eat the .
1484         TokError("expected field identifier after '.'");
1485         return 0;
1486       }
1487       if (!Result->getFieldType(Lex.getCurStrVal())) {
1488         TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1489                  Result->getAsString() + "'");
1490         return 0;
1491       }
1492       Result = FieldInit::get(Result, Lex.getCurStrVal());
1493       Lex.Lex();  // eat field name
1494       break;
1495
1496     case tgtok::paste:
1497       SMLoc PasteLoc = Lex.getLoc();
1498
1499       // Create a !strconcat() operation, first casting each operand to
1500       // a string if necessary.
1501
1502       TypedInit *LHS = dynamic_cast<TypedInit *>(Result);
1503       if (!LHS) {
1504         Error(PasteLoc, "LHS of paste is not typed!");
1505         return 0;
1506       }
1507   
1508       if (LHS->getType() != StringRecTy::get()) {
1509         LHS = UnOpInit::get(UnOpInit::CAST, LHS, StringRecTy::get());
1510       }
1511
1512       TypedInit *RHS = 0;
1513
1514       Lex.Lex();  // Eat the '#'.
1515       switch (Lex.getCode()) { 
1516       case tgtok::colon:
1517       case tgtok::semi:
1518       case tgtok::l_brace:
1519         // These are all of the tokens that can begin an object body.
1520         // Some of these can also begin values but we disallow those cases
1521         // because they are unlikely to be useful.
1522        
1523         // Trailing paste, concat with an empty string.
1524         RHS = StringInit::get("");
1525         break;
1526
1527       default:
1528         Init *RHSResult = ParseValue(CurRec, ItemType, ParseNameMode);
1529         RHS = dynamic_cast<TypedInit *>(RHSResult);
1530         if (!RHS) {
1531           Error(PasteLoc, "RHS of paste is not typed!");
1532           return 0;
1533         }
1534
1535         if (RHS->getType() != StringRecTy::get()) {
1536           RHS = UnOpInit::get(UnOpInit::CAST, RHS, StringRecTy::get());
1537         }
1538   
1539         break;
1540       }
1541
1542       Result = BinOpInit::get(BinOpInit::STRCONCAT, LHS, RHS,
1543                               StringRecTy::get())->Fold(CurRec, CurMultiClass);
1544       break;
1545     }
1546   }
1547 }
1548
1549 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1550 ///
1551 ///    ParseDagArgList ::= Value (':' VARNAME)?
1552 ///    ParseDagArgList ::= ParseDagArgList ',' Value (':' VARNAME)?
1553 std::vector<std::pair<llvm::Init*, std::string> >
1554 TGParser::ParseDagArgList(Record *CurRec) {
1555   std::vector<std::pair<llvm::Init*, std::string> > Result;
1556
1557   while (1) {
1558     Init *Val = ParseValue(CurRec);
1559     if (Val == 0) return std::vector<std::pair<llvm::Init*, std::string> >();
1560
1561     // If the variable name is present, add it.
1562     std::string VarName;
1563     if (Lex.getCode() == tgtok::colon) {
1564       if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1565         TokError("expected variable name in dag literal");
1566         return std::vector<std::pair<llvm::Init*, std::string> >();
1567       }
1568       VarName = Lex.getCurStrVal();
1569       Lex.Lex();  // eat the VarName.
1570     }
1571
1572     Result.push_back(std::make_pair(Val, VarName));
1573
1574     if (Lex.getCode() != tgtok::comma) break;
1575     Lex.Lex(); // eat the ','
1576   }
1577
1578   return Result;
1579 }
1580
1581
1582 /// ParseValueList - Parse a comma separated list of values, returning them as a
1583 /// vector.  Note that this always expects to be able to parse at least one
1584 /// value.  It returns an empty list if this is not possible.
1585 ///
1586 ///   ValueList ::= Value (',' Value)
1587 ///
1588 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1589                                             RecTy *EltTy) {
1590   std::vector<Init*> Result;
1591   RecTy *ItemType = EltTy;
1592   unsigned int ArgN = 0;
1593   if (ArgsRec != 0 && EltTy == 0) {
1594     const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1595     if (!TArgs.size()) {
1596       TokError("template argument provided to non-template class");
1597       return std::vector<Init*>();
1598     }
1599     const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1600     if (!RV) {
1601       errs() << "Cannot find template arg " << ArgN << " (" << TArgs[ArgN]
1602         << ")\n";
1603     }
1604     assert(RV && "Template argument record not found??");
1605     ItemType = RV->getType();
1606     ++ArgN;
1607   }
1608   Result.push_back(ParseValue(CurRec, ItemType));
1609   if (Result.back() == 0) return std::vector<Init*>();
1610
1611   while (Lex.getCode() == tgtok::comma) {
1612     Lex.Lex();  // Eat the comma
1613
1614     if (ArgsRec != 0 && EltTy == 0) {
1615       const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1616       if (ArgN >= TArgs.size()) {
1617         TokError("too many template arguments");
1618         return std::vector<Init*>();
1619       }
1620       const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1621       assert(RV && "Template argument record not found??");
1622       ItemType = RV->getType();
1623       ++ArgN;
1624     }
1625     Result.push_back(ParseValue(CurRec, ItemType));
1626     if (Result.back() == 0) return std::vector<Init*>();
1627   }
1628
1629   return Result;
1630 }
1631
1632
1633 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1634 /// empty string on error.  This can happen in a number of different context's,
1635 /// including within a def or in the template args for a def (which which case
1636 /// CurRec will be non-null) and within the template args for a multiclass (in
1637 /// which case CurRec will be null, but CurMultiClass will be set).  This can
1638 /// also happen within a def that is within a multiclass, which will set both
1639 /// CurRec and CurMultiClass.
1640 ///
1641 ///  Declaration ::= FIELD? Type ID ('=' Value)?
1642 ///
1643 Init *TGParser::ParseDeclaration(Record *CurRec,
1644                                        bool ParsingTemplateArgs) {
1645   // Read the field prefix if present.
1646   bool HasField = Lex.getCode() == tgtok::Field;
1647   if (HasField) Lex.Lex();
1648
1649   RecTy *Type = ParseType();
1650   if (Type == 0) return 0;
1651
1652   if (Lex.getCode() != tgtok::Id) {
1653     TokError("Expected identifier in declaration");
1654     return 0;
1655   }
1656
1657   SMLoc IdLoc = Lex.getLoc();
1658   Init *DeclName = StringInit::get(Lex.getCurStrVal());
1659   Lex.Lex();
1660
1661   if (ParsingTemplateArgs) {
1662     if (CurRec) {
1663       DeclName = QualifyName(*CurRec, CurMultiClass, DeclName, ":");
1664     } else {
1665       assert(CurMultiClass);
1666     }
1667     if (CurMultiClass)
1668       DeclName = QualifyName(CurMultiClass->Rec, CurMultiClass, DeclName,
1669                              "::");
1670   }
1671
1672   // Add the value.
1673   if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1674     return 0;
1675
1676   // If a value is present, parse it.
1677   if (Lex.getCode() == tgtok::equal) {
1678     Lex.Lex();
1679     SMLoc ValLoc = Lex.getLoc();
1680     Init *Val = ParseValue(CurRec, Type);
1681     if (Val == 0 ||
1682         SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1683       return 0;
1684   }
1685
1686   return DeclName;
1687 }
1688
1689 /// ParseForeachDeclaration - Read a foreach declaration, returning
1690 /// the name of the declared object or a NULL Init on error.  Return
1691 /// the name of the parsed initializer list through ForeachListName.
1692 ///
1693 ///  ForeachDeclaration ::= ID '=' '[' ValueList ']'
1694 ///  ForeachDeclaration ::= ID '=' '{' RangeList '}'
1695 ///  ForeachDeclaration ::= ID '=' RangePiece
1696 ///
1697 VarInit *TGParser::ParseForeachDeclaration(ListInit *&ForeachListValue) {
1698   if (Lex.getCode() != tgtok::Id) {
1699     TokError("Expected identifier in foreach declaration");
1700     return 0;
1701   }
1702
1703   Init *DeclName = StringInit::get(Lex.getCurStrVal());
1704   Lex.Lex();
1705
1706   // If a value is present, parse it.
1707   if (Lex.getCode() != tgtok::equal) {
1708     TokError("Expected '=' in foreach declaration");
1709     return 0;
1710   }
1711   Lex.Lex();  // Eat the '='
1712
1713   RecTy *IterType = 0;
1714   std::vector<unsigned> Ranges;
1715
1716   switch (Lex.getCode()) {
1717   default: TokError("Unknown token when expecting a range list"); return 0;
1718   case tgtok::l_square: { // '[' ValueList ']'
1719     Init *List = ParseSimpleValue(0, 0, ParseForeachMode);
1720     ForeachListValue = dynamic_cast<ListInit*>(List);
1721     if (ForeachListValue == 0) {
1722       TokError("Expected a Value list");
1723       return 0;
1724     }
1725     RecTy *ValueType = ForeachListValue->getType();
1726     ListRecTy *ListType = dyn_cast<ListRecTy>(ValueType);
1727     if (ListType == 0) {
1728       TokError("Value list is not of list type");
1729       return 0;
1730     }
1731     IterType = ListType->getElementType();
1732     break;
1733   }
1734
1735   case tgtok::IntVal: { // RangePiece.
1736     if (ParseRangePiece(Ranges))
1737       return 0;
1738     break;
1739   }
1740
1741   case tgtok::l_brace: { // '{' RangeList '}'
1742     Lex.Lex(); // eat the '{'
1743     Ranges = ParseRangeList();
1744     if (Lex.getCode() != tgtok::r_brace) {
1745       TokError("expected '}' at end of bit range list");
1746       return 0;
1747     }
1748     Lex.Lex();
1749     break;
1750   }
1751   }
1752
1753   if (!Ranges.empty()) {
1754     assert(!IterType && "Type already initialized?");
1755     IterType = IntRecTy::get();
1756     std::vector<Init*> Values;
1757     for (unsigned i = 0, e = Ranges.size(); i != e; ++i)
1758       Values.push_back(IntInit::get(Ranges[i]));
1759     ForeachListValue = ListInit::get(Values, IterType);
1760   }
1761
1762   if (!IterType)
1763     return 0;
1764
1765   return VarInit::get(DeclName, IterType);
1766 }
1767
1768 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1769 /// sequence of template-declarations in <>'s.  If CurRec is non-null, these are
1770 /// template args for a def, which may or may not be in a multiclass.  If null,
1771 /// these are the template args for a multiclass.
1772 ///
1773 ///    TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1774 ///
1775 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1776   assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1777   Lex.Lex(); // eat the '<'
1778
1779   Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1780
1781   // Read the first declaration.
1782   Init *TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1783   if (TemplArg == 0)
1784     return true;
1785
1786   TheRecToAddTo->addTemplateArg(TemplArg);
1787
1788   while (Lex.getCode() == tgtok::comma) {
1789     Lex.Lex(); // eat the ','
1790
1791     // Read the following declarations.
1792     TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1793     if (TemplArg == 0)
1794       return true;
1795     TheRecToAddTo->addTemplateArg(TemplArg);
1796   }
1797
1798   if (Lex.getCode() != tgtok::greater)
1799     return TokError("expected '>' at end of template argument list");
1800   Lex.Lex(); // eat the '>'.
1801   return false;
1802 }
1803
1804
1805 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1806 ///
1807 ///   BodyItem ::= Declaration ';'
1808 ///   BodyItem ::= LET ID OptionalBitList '=' Value ';'
1809 bool TGParser::ParseBodyItem(Record *CurRec) {
1810   if (Lex.getCode() != tgtok::Let) {
1811     if (ParseDeclaration(CurRec, false) == 0)
1812       return true;
1813
1814     if (Lex.getCode() != tgtok::semi)
1815       return TokError("expected ';' after declaration");
1816     Lex.Lex();
1817     return false;
1818   }
1819
1820   // LET ID OptionalRangeList '=' Value ';'
1821   if (Lex.Lex() != tgtok::Id)
1822     return TokError("expected field identifier after let");
1823
1824   SMLoc IdLoc = Lex.getLoc();
1825   std::string FieldName = Lex.getCurStrVal();
1826   Lex.Lex();  // eat the field name.
1827
1828   std::vector<unsigned> BitList;
1829   if (ParseOptionalBitList(BitList))
1830     return true;
1831   std::reverse(BitList.begin(), BitList.end());
1832
1833   if (Lex.getCode() != tgtok::equal)
1834     return TokError("expected '=' in let expression");
1835   Lex.Lex();  // eat the '='.
1836
1837   RecordVal *Field = CurRec->getValue(FieldName);
1838   if (Field == 0)
1839     return TokError("Value '" + FieldName + "' unknown!");
1840
1841   RecTy *Type = Field->getType();
1842
1843   Init *Val = ParseValue(CurRec, Type);
1844   if (Val == 0) return true;
1845
1846   if (Lex.getCode() != tgtok::semi)
1847     return TokError("expected ';' after let expression");
1848   Lex.Lex();
1849
1850   return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1851 }
1852
1853 /// ParseBody - Read the body of a class or def.  Return true on error, false on
1854 /// success.
1855 ///
1856 ///   Body     ::= ';'
1857 ///   Body     ::= '{' BodyList '}'
1858 ///   BodyList BodyItem*
1859 ///
1860 bool TGParser::ParseBody(Record *CurRec) {
1861   // If this is a null definition, just eat the semi and return.
1862   if (Lex.getCode() == tgtok::semi) {
1863     Lex.Lex();
1864     return false;
1865   }
1866
1867   if (Lex.getCode() != tgtok::l_brace)
1868     return TokError("Expected ';' or '{' to start body");
1869   // Eat the '{'.
1870   Lex.Lex();
1871
1872   while (Lex.getCode() != tgtok::r_brace)
1873     if (ParseBodyItem(CurRec))
1874       return true;
1875
1876   // Eat the '}'.
1877   Lex.Lex();
1878   return false;
1879 }
1880
1881 /// ParseObjectBody - Parse the body of a def or class.  This consists of an
1882 /// optional ClassList followed by a Body.  CurRec is the current def or class
1883 /// that is being parsed.
1884 ///
1885 ///   ObjectBody      ::= BaseClassList Body
1886 ///   BaseClassList   ::= /*empty*/
1887 ///   BaseClassList   ::= ':' BaseClassListNE
1888 ///   BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1889 ///
1890 bool TGParser::ParseObjectBody(Record *CurRec) {
1891   // If there is a baseclass list, read it.
1892   if (Lex.getCode() == tgtok::colon) {
1893     Lex.Lex();
1894
1895     // Read all of the subclasses.
1896     SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1897     while (1) {
1898       // Check for error.
1899       if (SubClass.Rec == 0) return true;
1900
1901       // Add it.
1902       if (AddSubClass(CurRec, SubClass))
1903         return true;
1904
1905       if (Lex.getCode() != tgtok::comma) break;
1906       Lex.Lex(); // eat ','.
1907       SubClass = ParseSubClassReference(CurRec, false);
1908     }
1909   }
1910
1911   // Process any variables on the let stack.
1912   for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1913     for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1914       if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1915                    LetStack[i][j].Bits, LetStack[i][j].Value))
1916         return true;
1917
1918   return ParseBody(CurRec);
1919 }
1920
1921 /// ParseDef - Parse and return a top level or multiclass def, return the record
1922 /// corresponding to it.  This returns null on error.
1923 ///
1924 ///   DefInst ::= DEF ObjectName ObjectBody
1925 ///
1926 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
1927   SMLoc DefLoc = Lex.getLoc();
1928   assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1929   Lex.Lex();  // Eat the 'def' token.
1930
1931   // Parse ObjectName and make a record for it.
1932   Record *CurRec = new Record(ParseObjectName(CurMultiClass), DefLoc, Records);
1933
1934   if (!CurMultiClass && Loops.empty()) {
1935     // Top-level def definition.
1936
1937     // Ensure redefinition doesn't happen.
1938     if (Records.getDef(CurRec->getNameInitAsString())) {
1939       Error(DefLoc, "def '" + CurRec->getNameInitAsString()
1940             + "' already defined");
1941       return true;
1942     }
1943     Records.addDef(CurRec);
1944   } else if (CurMultiClass) {
1945     // Otherwise, a def inside a multiclass, add it to the multiclass.
1946     for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1947       if (CurMultiClass->DefPrototypes[i]->getNameInit()
1948           == CurRec->getNameInit()) {
1949         Error(DefLoc, "def '" + CurRec->getNameInitAsString() +
1950               "' already defined in this multiclass!");
1951         return true;
1952       }
1953     CurMultiClass->DefPrototypes.push_back(CurRec);
1954   }
1955
1956   if (ParseObjectBody(CurRec))
1957     return true;
1958
1959   if (CurMultiClass == 0)  // Def's in multiclasses aren't really defs.
1960     // See Record::setName().  This resolve step will see any new name
1961     // for the def that might have been created when resolving
1962     // inheritance, values and arguments above.
1963     CurRec->resolveReferences();
1964
1965   // If ObjectBody has template arguments, it's an error.
1966   assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1967
1968   if (CurMultiClass) {
1969     // Copy the template arguments for the multiclass into the def.
1970     const std::vector<Init *> &TArgs =
1971                                 CurMultiClass->Rec.getTemplateArgs();
1972
1973     for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1974       const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1975       assert(RV && "Template arg doesn't exist?");
1976       CurRec->addValue(*RV);
1977     }
1978   }
1979
1980   if (ProcessForeachDefs(CurRec, DefLoc)) {
1981     Error(DefLoc,
1982           "Could not process loops for def" + CurRec->getNameInitAsString());
1983     return true;
1984   }
1985
1986   return false;
1987 }
1988
1989 /// ParseForeach - Parse a for statement.  Return the record corresponding
1990 /// to it.  This returns true on error.
1991 ///
1992 ///   Foreach ::= FOREACH Declaration IN '{ ObjectList '}'
1993 ///   Foreach ::= FOREACH Declaration IN Object
1994 ///
1995 bool TGParser::ParseForeach(MultiClass *CurMultiClass) {
1996   assert(Lex.getCode() == tgtok::Foreach && "Unknown tok");
1997   Lex.Lex();  // Eat the 'for' token.
1998
1999   // Make a temporary object to record items associated with the for
2000   // loop.
2001   ListInit *ListValue = 0;
2002   VarInit *IterName = ParseForeachDeclaration(ListValue);
2003   if (IterName == 0)
2004     return TokError("expected declaration in for");
2005
2006   if (Lex.getCode() != tgtok::In)
2007     return TokError("Unknown tok");
2008   Lex.Lex();  // Eat the in
2009
2010   // Create a loop object and remember it.
2011   Loops.push_back(ForeachLoop(IterName, ListValue));
2012
2013   if (Lex.getCode() != tgtok::l_brace) {
2014     // FOREACH Declaration IN Object
2015     if (ParseObject(CurMultiClass))
2016       return true;
2017   }
2018   else {
2019     SMLoc BraceLoc = Lex.getLoc();
2020     // Otherwise, this is a group foreach.
2021     Lex.Lex();  // eat the '{'.
2022
2023     // Parse the object list.
2024     if (ParseObjectList(CurMultiClass))
2025       return true;
2026
2027     if (Lex.getCode() != tgtok::r_brace) {
2028       TokError("expected '}' at end of foreach command");
2029       return Error(BraceLoc, "to match this '{'");
2030     }
2031     Lex.Lex();  // Eat the }
2032   }
2033
2034   // We've processed everything in this loop.
2035   Loops.pop_back();
2036
2037   return false;
2038 }
2039
2040 /// ParseClass - Parse a tblgen class definition.
2041 ///
2042 ///   ClassInst ::= CLASS ID TemplateArgList? ObjectBody
2043 ///
2044 bool TGParser::ParseClass() {
2045   assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
2046   Lex.Lex();
2047
2048   if (Lex.getCode() != tgtok::Id)
2049     return TokError("expected class name after 'class' keyword");
2050
2051   Record *CurRec = Records.getClass(Lex.getCurStrVal());
2052   if (CurRec) {
2053     // If the body was previously defined, this is an error.
2054     if (CurRec->getValues().size() > 1 ||  // Account for NAME.
2055         !CurRec->getSuperClasses().empty() ||
2056         !CurRec->getTemplateArgs().empty())
2057       return TokError("Class '" + CurRec->getNameInitAsString()
2058                       + "' already defined");
2059   } else {
2060     // If this is the first reference to this class, create and add it.
2061     CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc(), Records);
2062     Records.addClass(CurRec);
2063   }
2064   Lex.Lex(); // eat the name.
2065
2066   // If there are template args, parse them.
2067   if (Lex.getCode() == tgtok::less)
2068     if (ParseTemplateArgList(CurRec))
2069       return true;
2070
2071   // Finally, parse the object body.
2072   return ParseObjectBody(CurRec);
2073 }
2074
2075 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
2076 /// of LetRecords.
2077 ///
2078 ///   LetList ::= LetItem (',' LetItem)*
2079 ///   LetItem ::= ID OptionalRangeList '=' Value
2080 ///
2081 std::vector<LetRecord> TGParser::ParseLetList() {
2082   std::vector<LetRecord> Result;
2083
2084   while (1) {
2085     if (Lex.getCode() != tgtok::Id) {
2086       TokError("expected identifier in let definition");
2087       return std::vector<LetRecord>();
2088     }
2089     std::string Name = Lex.getCurStrVal();
2090     SMLoc NameLoc = Lex.getLoc();
2091     Lex.Lex();  // Eat the identifier.
2092
2093     // Check for an optional RangeList.
2094     std::vector<unsigned> Bits;
2095     if (ParseOptionalRangeList(Bits))
2096       return std::vector<LetRecord>();
2097     std::reverse(Bits.begin(), Bits.end());
2098
2099     if (Lex.getCode() != tgtok::equal) {
2100       TokError("expected '=' in let expression");
2101       return std::vector<LetRecord>();
2102     }
2103     Lex.Lex();  // eat the '='.
2104
2105     Init *Val = ParseValue(0);
2106     if (Val == 0) return std::vector<LetRecord>();
2107
2108     // Now that we have everything, add the record.
2109     Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
2110
2111     if (Lex.getCode() != tgtok::comma)
2112       return Result;
2113     Lex.Lex();  // eat the comma.
2114   }
2115 }
2116
2117 /// ParseTopLevelLet - Parse a 'let' at top level.  This can be a couple of
2118 /// different related productions. This works inside multiclasses too.
2119 ///
2120 ///   Object ::= LET LetList IN '{' ObjectList '}'
2121 ///   Object ::= LET LetList IN Object
2122 ///
2123 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
2124   assert(Lex.getCode() == tgtok::Let && "Unexpected token");
2125   Lex.Lex();
2126
2127   // Add this entry to the let stack.
2128   std::vector<LetRecord> LetInfo = ParseLetList();
2129   if (LetInfo.empty()) return true;
2130   LetStack.push_back(LetInfo);
2131
2132   if (Lex.getCode() != tgtok::In)
2133     return TokError("expected 'in' at end of top-level 'let'");
2134   Lex.Lex();
2135
2136   // If this is a scalar let, just handle it now
2137   if (Lex.getCode() != tgtok::l_brace) {
2138     // LET LetList IN Object
2139     if (ParseObject(CurMultiClass))
2140       return true;
2141   } else {   // Object ::= LETCommand '{' ObjectList '}'
2142     SMLoc BraceLoc = Lex.getLoc();
2143     // Otherwise, this is a group let.
2144     Lex.Lex();  // eat the '{'.
2145
2146     // Parse the object list.
2147     if (ParseObjectList(CurMultiClass))
2148       return true;
2149
2150     if (Lex.getCode() != tgtok::r_brace) {
2151       TokError("expected '}' at end of top level let command");
2152       return Error(BraceLoc, "to match this '{'");
2153     }
2154     Lex.Lex();
2155   }
2156
2157   // Outside this let scope, this let block is not active.
2158   LetStack.pop_back();
2159   return false;
2160 }
2161
2162 /// ParseMultiClass - Parse a multiclass definition.
2163 ///
2164 ///  MultiClassInst ::= MULTICLASS ID TemplateArgList?
2165 ///                     ':' BaseMultiClassList '{' MultiClassDef+ '}'
2166 ///
2167 bool TGParser::ParseMultiClass() {
2168   assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
2169   Lex.Lex();  // Eat the multiclass token.
2170
2171   if (Lex.getCode() != tgtok::Id)
2172     return TokError("expected identifier after multiclass for name");
2173   std::string Name = Lex.getCurStrVal();
2174
2175   if (MultiClasses.count(Name))
2176     return TokError("multiclass '" + Name + "' already defined");
2177
2178   CurMultiClass = MultiClasses[Name] = new MultiClass(Name, 
2179                                                       Lex.getLoc(), Records);
2180   Lex.Lex();  // Eat the identifier.
2181
2182   // If there are template args, parse them.
2183   if (Lex.getCode() == tgtok::less)
2184     if (ParseTemplateArgList(0))
2185       return true;
2186
2187   bool inherits = false;
2188
2189   // If there are submulticlasses, parse them.
2190   if (Lex.getCode() == tgtok::colon) {
2191     inherits = true;
2192
2193     Lex.Lex();
2194
2195     // Read all of the submulticlasses.
2196     SubMultiClassReference SubMultiClass =
2197       ParseSubMultiClassReference(CurMultiClass);
2198     while (1) {
2199       // Check for error.
2200       if (SubMultiClass.MC == 0) return true;
2201
2202       // Add it.
2203       if (AddSubMultiClass(CurMultiClass, SubMultiClass))
2204         return true;
2205
2206       if (Lex.getCode() != tgtok::comma) break;
2207       Lex.Lex(); // eat ','.
2208       SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
2209     }
2210   }
2211
2212   if (Lex.getCode() != tgtok::l_brace) {
2213     if (!inherits)
2214       return TokError("expected '{' in multiclass definition");
2215     else if (Lex.getCode() != tgtok::semi)
2216       return TokError("expected ';' in multiclass definition");
2217     else
2218       Lex.Lex();  // eat the ';'.
2219   } else {
2220     if (Lex.Lex() == tgtok::r_brace)  // eat the '{'.
2221       return TokError("multiclass must contain at least one def");
2222
2223     while (Lex.getCode() != tgtok::r_brace) {
2224       switch (Lex.getCode()) {
2225         default:
2226           return TokError("expected 'let', 'def' or 'defm' in multiclass body");
2227         case tgtok::Let:
2228         case tgtok::Def:
2229         case tgtok::Defm:
2230         case tgtok::Foreach:
2231           if (ParseObject(CurMultiClass))
2232             return true;
2233          break;
2234       }
2235     }
2236     Lex.Lex();  // eat the '}'.
2237   }
2238
2239   CurMultiClass = 0;
2240   return false;
2241 }
2242
2243 Record *TGParser::
2244 InstantiateMulticlassDef(MultiClass &MC,
2245                          Record *DefProto,
2246                          Init *DefmPrefix,
2247                          SMLoc DefmPrefixLoc) {
2248   // We need to preserve DefProto so it can be reused for later
2249   // instantiations, so create a new Record to inherit from it.
2250
2251   // Add in the defm name.  If the defm prefix is empty, give each
2252   // instantiated def a unique name.  Otherwise, if "#NAME#" exists in the
2253   // name, substitute the prefix for #NAME#.  Otherwise, use the defm name
2254   // as a prefix.
2255
2256   if (DefmPrefix == 0)
2257     DefmPrefix = StringInit::get(GetNewAnonymousName());
2258
2259   Init *DefName = DefProto->getNameInit();
2260
2261   StringInit *DefNameString = dynamic_cast<StringInit *>(DefName);
2262
2263   if (DefNameString != 0) {
2264     // We have a fully expanded string so there are no operators to
2265     // resolve.  We should concatenate the given prefix and name.
2266     DefName =
2267       BinOpInit::get(BinOpInit::STRCONCAT,
2268                      UnOpInit::get(UnOpInit::CAST, DefmPrefix,
2269                                    StringRecTy::get())->Fold(DefProto, &MC),
2270                      DefName, StringRecTy::get())->Fold(DefProto, &MC);
2271   }
2272
2273   // Make a trail of SMLocs from the multiclass instantiations.
2274   SmallVector<SMLoc, 4> Locs(1, DefmPrefixLoc);
2275   Locs.append(DefProto->getLoc().begin(), DefProto->getLoc().end());
2276   Record *CurRec = new Record(DefName, Locs, Records);
2277
2278   SubClassReference Ref;
2279   Ref.RefLoc = DefmPrefixLoc;
2280   Ref.Rec = DefProto;
2281   AddSubClass(CurRec, Ref);
2282
2283   // Set the value for NAME. We don't resolve references to it 'til later,
2284   // though, so that uses in nested multiclass names don't get
2285   // confused.
2286   if (SetValue(CurRec, Ref.RefLoc, "NAME", std::vector<unsigned>(),
2287                DefmPrefix)) {
2288     Error(DefmPrefixLoc, "Could not resolve "
2289           + CurRec->getNameInitAsString() + ":NAME to '"
2290           + DefmPrefix->getAsUnquotedString() + "'");
2291     return 0;
2292   }
2293
2294   // If the DefNameString didn't resolve, we probably have a reference to
2295   // NAME and need to replace it. We need to do at least this much greedily,
2296   // otherwise nested multiclasses will end up with incorrect NAME expansions.
2297   if (DefNameString == 0) {
2298     RecordVal *DefNameRV = CurRec->getValue("NAME");
2299     CurRec->resolveReferencesTo(DefNameRV);
2300   }
2301
2302   if (!CurMultiClass) {
2303     // Now that we're at the top level, resolve all NAME references
2304     // in the resultant defs that weren't in the def names themselves.
2305     RecordVal *DefNameRV = CurRec->getValue("NAME");
2306     CurRec->resolveReferencesTo(DefNameRV);
2307
2308     // Now that NAME references are resolved and we're at the top level of
2309     // any multiclass expansions, add the record to the RecordKeeper. If we are
2310     // currently in a multiclass, it means this defm appears inside a
2311     // multiclass and its name won't be fully resolvable until we see
2312     // the top-level defm.  Therefore, we don't add this to the
2313     // RecordKeeper at this point.  If we did we could get duplicate
2314     // defs as more than one probably refers to NAME or some other
2315     // common internal placeholder.
2316
2317     // Ensure redefinition doesn't happen.
2318     if (Records.getDef(CurRec->getNameInitAsString())) {
2319       Error(DefmPrefixLoc, "def '" + CurRec->getNameInitAsString() + 
2320             "' already defined, instantiating defm with subdef '" + 
2321             DefProto->getNameInitAsString() + "'");
2322       return 0;
2323     }
2324
2325     Records.addDef(CurRec);
2326   }
2327
2328   return CurRec;
2329 }
2330
2331 bool TGParser::ResolveMulticlassDefArgs(MultiClass &MC,
2332                                         Record *CurRec,
2333                                         SMLoc DefmPrefixLoc,
2334                                         SMLoc SubClassLoc,
2335                                         const std::vector<Init *> &TArgs,
2336                                         std::vector<Init *> &TemplateVals,
2337                                         bool DeleteArgs) {
2338   // Loop over all of the template arguments, setting them to the specified
2339   // value or leaving them as the default if necessary.
2340   for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2341     // Check if a value is specified for this temp-arg.
2342     if (i < TemplateVals.size()) {
2343       // Set it now.
2344       if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
2345                    TemplateVals[i]))
2346         return true;
2347         
2348       // Resolve it next.
2349       CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
2350
2351       if (DeleteArgs)
2352         // Now remove it.
2353         CurRec->removeValue(TArgs[i]);
2354         
2355     } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2356       return Error(SubClassLoc, "value not specified for template argument #"+
2357                    utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
2358                    + ") of multiclassclass '" + MC.Rec.getNameInitAsString()
2359                    + "'");
2360     }
2361   }
2362   return false;
2363 }
2364
2365 bool TGParser::ResolveMulticlassDef(MultiClass &MC,
2366                                     Record *CurRec,
2367                                     Record *DefProto,
2368                                     SMLoc DefmPrefixLoc) {
2369   // If the mdef is inside a 'let' expression, add to each def.
2370   for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
2371     for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
2372       if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
2373                    LetStack[i][j].Bits, LetStack[i][j].Value))
2374         return Error(DefmPrefixLoc, "when instantiating this defm");
2375
2376   // Don't create a top level definition for defm inside multiclasses,
2377   // instead, only update the prototypes and bind the template args
2378   // with the new created definition.
2379   if (CurMultiClass) {
2380     for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2381          i != e; ++i)
2382       if (CurMultiClass->DefPrototypes[i]->getNameInit()
2383           == CurRec->getNameInit())
2384         return Error(DefmPrefixLoc, "defm '" + CurRec->getNameInitAsString() +
2385                      "' already defined in this multiclass!");
2386     CurMultiClass->DefPrototypes.push_back(CurRec);
2387
2388     // Copy the template arguments for the multiclass into the new def.
2389     const std::vector<Init *> &TA =
2390       CurMultiClass->Rec.getTemplateArgs();
2391
2392     for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2393       const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2394       assert(RV && "Template arg doesn't exist?");
2395       CurRec->addValue(*RV);
2396     }
2397   }
2398
2399   return false;
2400 }
2401
2402 /// ParseDefm - Parse the instantiation of a multiclass.
2403 ///
2404 ///   DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
2405 ///
2406 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
2407   assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
2408
2409   Init *DefmPrefix = 0;
2410
2411   if (Lex.Lex() == tgtok::Id) {  // eat the defm.
2412     DefmPrefix = ParseObjectName(CurMultiClass);
2413   }
2414
2415   SMLoc DefmPrefixLoc = Lex.getLoc();
2416   if (Lex.getCode() != tgtok::colon)
2417     return TokError("expected ':' after defm identifier");
2418
2419   // Keep track of the new generated record definitions.
2420   std::vector<Record*> NewRecDefs;
2421
2422   // This record also inherits from a regular class (non-multiclass)?
2423   bool InheritFromClass = false;
2424
2425   // eat the colon.
2426   Lex.Lex();
2427
2428   SMLoc SubClassLoc = Lex.getLoc();
2429   SubClassReference Ref = ParseSubClassReference(0, true);
2430
2431   while (1) {
2432     if (Ref.Rec == 0) return true;
2433
2434     // To instantiate a multiclass, we need to first get the multiclass, then
2435     // instantiate each def contained in the multiclass with the SubClassRef
2436     // template parameters.
2437     MultiClass *MC = MultiClasses[Ref.Rec->getName()];
2438     assert(MC && "Didn't lookup multiclass correctly?");
2439     std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
2440
2441     // Verify that the correct number of template arguments were specified.
2442     const std::vector<Init *> &TArgs = MC->Rec.getTemplateArgs();
2443     if (TArgs.size() < TemplateVals.size())
2444       return Error(SubClassLoc,
2445                    "more template args specified than multiclass expects");
2446
2447     // Loop over all the def's in the multiclass, instantiating each one.
2448     for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
2449       Record *DefProto = MC->DefPrototypes[i];
2450
2451       Record *CurRec = InstantiateMulticlassDef(*MC, DefProto, DefmPrefix, DefmPrefixLoc);
2452       if (!CurRec)
2453         return true;
2454
2455       if (ResolveMulticlassDefArgs(*MC, CurRec, DefmPrefixLoc, SubClassLoc,
2456                                    TArgs, TemplateVals, true/*Delete args*/))
2457         return Error(SubClassLoc, "could not instantiate def");
2458
2459       if (ResolveMulticlassDef(*MC, CurRec, DefProto, DefmPrefixLoc))
2460         return Error(SubClassLoc, "could not instantiate def");
2461
2462       NewRecDefs.push_back(CurRec);
2463     }
2464
2465
2466     if (Lex.getCode() != tgtok::comma) break;
2467     Lex.Lex(); // eat ','.
2468
2469     SubClassLoc = Lex.getLoc();
2470
2471     // A defm can inherit from regular classes (non-multiclass) as
2472     // long as they come in the end of the inheritance list.
2473     InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != 0);
2474
2475     if (InheritFromClass)
2476       break;
2477
2478     Ref = ParseSubClassReference(0, true);
2479   }
2480
2481   if (InheritFromClass) {
2482     // Process all the classes to inherit as if they were part of a
2483     // regular 'def' and inherit all record values.
2484     SubClassReference SubClass = ParseSubClassReference(0, false);
2485     while (1) {
2486       // Check for error.
2487       if (SubClass.Rec == 0) return true;
2488
2489       // Get the expanded definition prototypes and teach them about
2490       // the record values the current class to inherit has
2491       for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2492         Record *CurRec = NewRecDefs[i];
2493
2494         // Add it.
2495         if (AddSubClass(CurRec, SubClass))
2496           return true;
2497
2498         // Process any variables on the let stack.
2499         for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
2500           for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
2501             if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
2502                          LetStack[i][j].Bits, LetStack[i][j].Value))
2503               return true;
2504       }
2505
2506       if (Lex.getCode() != tgtok::comma) break;
2507       Lex.Lex(); // eat ','.
2508       SubClass = ParseSubClassReference(0, false);
2509     }
2510   }
2511
2512   if (!CurMultiClass)
2513     for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2514       // See Record::setName().  This resolve step will see any new
2515       // name for the def that might have been created when resolving
2516       // inheritance, values and arguments above.
2517       NewRecDefs[i]->resolveReferences();
2518
2519   if (Lex.getCode() != tgtok::semi)
2520     return TokError("expected ';' at end of defm");
2521   Lex.Lex();
2522
2523   return false;
2524 }
2525
2526 /// ParseObject
2527 ///   Object ::= ClassInst
2528 ///   Object ::= DefInst
2529 ///   Object ::= MultiClassInst
2530 ///   Object ::= DefMInst
2531 ///   Object ::= LETCommand '{' ObjectList '}'
2532 ///   Object ::= LETCommand Object
2533 bool TGParser::ParseObject(MultiClass *MC) {
2534   switch (Lex.getCode()) {
2535   default:
2536     return TokError("Expected class, def, defm, multiclass or let definition");
2537   case tgtok::Let:   return ParseTopLevelLet(MC);
2538   case tgtok::Def:   return ParseDef(MC);
2539   case tgtok::Foreach:   return ParseForeach(MC);
2540   case tgtok::Defm:  return ParseDefm(MC);
2541   case tgtok::Class: return ParseClass();
2542   case tgtok::MultiClass: return ParseMultiClass();
2543   }
2544 }
2545
2546 /// ParseObjectList
2547 ///   ObjectList :== Object*
2548 bool TGParser::ParseObjectList(MultiClass *MC) {
2549   while (isObjectStart(Lex.getCode())) {
2550     if (ParseObject(MC))
2551       return true;
2552   }
2553   return false;
2554 }
2555
2556 bool TGParser::ParseFile() {
2557   Lex.Lex(); // Prime the lexer.
2558   if (ParseObjectList()) return true;
2559
2560   // If we have unread input at the end of the file, report it.
2561   if (Lex.getCode() == tgtok::Eof)
2562     return false;
2563
2564   return TokError("Unexpected input at top level");
2565 }
2566