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