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