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