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(Vals.size());
1306
1307     for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1308       Init *Bit = Vals[i]->convertInitializerTo(BitRecTy::get());
1309       if (!Bit) {
1310         Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1311               ") is not convertable to a bit");
1312         return nullptr;
1313       }
1314       NewBits[Vals.size()-i-1] = Bit;
1315     }
1316     return BitsInit::get(NewBits);
1317   }
1318   case tgtok::l_square: {          // Value ::= '[' ValueList ']'
1319     Lex.Lex(); // eat the '['
1320     std::vector<Init*> Vals;
1321
1322     RecTy *DeducedEltTy = nullptr;
1323     ListRecTy *GivenListTy = nullptr;
1324
1325     if (ItemType) {
1326       ListRecTy *ListType = dyn_cast<ListRecTy>(ItemType);
1327       if (!ListType) {
1328         std::string s;
1329         raw_string_ostream ss(s);
1330         ss << "Type mismatch for list, expected list type, got "
1331            << ItemType->getAsString();
1332         TokError(ss.str());
1333         return nullptr;
1334       }
1335       GivenListTy = ListType;
1336     }
1337
1338     if (Lex.getCode() != tgtok::r_square) {
1339       Vals = ParseValueList(CurRec, nullptr,
1340                             GivenListTy ? GivenListTy->getElementType() : nullptr);
1341       if (Vals.empty()) return nullptr;
1342     }
1343     if (Lex.getCode() != tgtok::r_square) {
1344       TokError("expected ']' at end of list value");
1345       return nullptr;
1346     }
1347     Lex.Lex();  // eat the ']'
1348
1349     RecTy *GivenEltTy = nullptr;
1350     if (Lex.getCode() == tgtok::less) {
1351       // Optional list element type
1352       Lex.Lex();  // eat the '<'
1353
1354       GivenEltTy = ParseType();
1355       if (!GivenEltTy) {
1356         // Couldn't parse element type
1357         return nullptr;
1358       }
1359
1360       if (Lex.getCode() != tgtok::greater) {
1361         TokError("expected '>' at end of list element type");
1362         return nullptr;
1363       }
1364       Lex.Lex();  // eat the '>'
1365     }
1366
1367     // Check elements
1368     RecTy *EltTy = nullptr;
1369     for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1370          i != ie;
1371          ++i) {
1372       TypedInit *TArg = dyn_cast<TypedInit>(*i);
1373       if (!TArg) {
1374         TokError("Untyped list element");
1375         return nullptr;
1376       }
1377       if (EltTy) {
1378         EltTy = resolveTypes(EltTy, TArg->getType());
1379         if (!EltTy) {
1380           TokError("Incompatible types in list elements");
1381           return nullptr;
1382         }
1383       } else {
1384         EltTy = TArg->getType();
1385       }
1386     }
1387
1388     if (GivenEltTy) {
1389       if (EltTy) {
1390         // Verify consistency
1391         if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1392           TokError("Incompatible types in list elements");
1393           return nullptr;
1394         }
1395       }
1396       EltTy = GivenEltTy;
1397     }
1398
1399     if (!EltTy) {
1400       if (!ItemType) {
1401         TokError("No type for list");
1402         return nullptr;
1403       }
1404       DeducedEltTy = GivenListTy->getElementType();
1405     } else {
1406       // Make sure the deduced type is compatible with the given type
1407       if (GivenListTy) {
1408         if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1409           TokError("Element type mismatch for list");
1410           return nullptr;
1411         }
1412       }
1413       DeducedEltTy = EltTy;
1414     }
1415
1416     return ListInit::get(Vals, DeducedEltTy);
1417   }
1418   case tgtok::l_paren: {         // Value ::= '(' IDValue DagArgList ')'
1419     Lex.Lex();   // eat the '('
1420     if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1421       TokError("expected identifier in dag init");
1422       return nullptr;
1423     }
1424
1425     Init *Operator = ParseValue(CurRec);
1426     if (!Operator) return nullptr;
1427
1428     // If the operator name is present, parse it.
1429     std::string OperatorName;
1430     if (Lex.getCode() == tgtok::colon) {
1431       if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1432         TokError("expected variable name in dag operator");
1433         return nullptr;
1434       }
1435       OperatorName = Lex.getCurStrVal();
1436       Lex.Lex();  // eat the VarName.
1437     }
1438
1439     std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1440     if (Lex.getCode() != tgtok::r_paren) {
1441       DagArgs = ParseDagArgList(CurRec);
1442       if (DagArgs.empty()) return nullptr;
1443     }
1444
1445     if (Lex.getCode() != tgtok::r_paren) {
1446       TokError("expected ')' in dag init");
1447       return nullptr;
1448     }
1449     Lex.Lex();  // eat the ')'
1450
1451     return DagInit::get(Operator, OperatorName, DagArgs);
1452   }
1453
1454   case tgtok::XHead:
1455   case tgtok::XTail:
1456   case tgtok::XEmpty:
1457   case tgtok::XCast:  // Value ::= !unop '(' Value ')'
1458   case tgtok::XConcat:
1459   case tgtok::XADD:
1460   case tgtok::XAND:
1461   case tgtok::XSRA:
1462   case tgtok::XSRL:
1463   case tgtok::XSHL:
1464   case tgtok::XEq:
1465   case tgtok::XListConcat:
1466   case tgtok::XStrConcat:   // Value ::= !binop '(' Value ',' Value ')'
1467   case tgtok::XIf:
1468   case tgtok::XForEach:
1469   case tgtok::XSubst: {  // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1470     return ParseOperation(CurRec, ItemType);
1471   }
1472   }
1473
1474   return R;
1475 }
1476
1477 /// ParseValue - Parse a tblgen value.  This returns null on error.
1478 ///
1479 ///   Value       ::= SimpleValue ValueSuffix*
1480 ///   ValueSuffix ::= '{' BitList '}'
1481 ///   ValueSuffix ::= '[' BitList ']'
1482 ///   ValueSuffix ::= '.' ID
1483 ///
1484 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType, IDParseMode Mode) {
1485   Init *Result = ParseSimpleValue(CurRec, ItemType, Mode);
1486   if (!Result) return nullptr;
1487
1488   // Parse the suffixes now if present.
1489   while (1) {
1490     switch (Lex.getCode()) {
1491     default: return Result;
1492     case tgtok::l_brace: {
1493       if (Mode == ParseNameMode || Mode == ParseForeachMode)
1494         // This is the beginning of the object body.
1495         return Result;
1496
1497       SMLoc CurlyLoc = Lex.getLoc();
1498       Lex.Lex(); // eat the '{'
1499       std::vector<unsigned> Ranges = ParseRangeList();
1500       if (Ranges.empty()) return nullptr;
1501
1502       // Reverse the bitlist.
1503       std::reverse(Ranges.begin(), Ranges.end());
1504       Result = Result->convertInitializerBitRange(Ranges);
1505       if (!Result) {
1506         Error(CurlyLoc, "Invalid bit range for value");
1507         return nullptr;
1508       }
1509
1510       // Eat the '}'.
1511       if (Lex.getCode() != tgtok::r_brace) {
1512         TokError("expected '}' at end of bit range list");
1513         return nullptr;
1514       }
1515       Lex.Lex();
1516       break;
1517     }
1518     case tgtok::l_square: {
1519       SMLoc SquareLoc = Lex.getLoc();
1520       Lex.Lex(); // eat the '['
1521       std::vector<unsigned> Ranges = ParseRangeList();
1522       if (Ranges.empty()) return nullptr;
1523
1524       Result = Result->convertInitListSlice(Ranges);
1525       if (!Result) {
1526         Error(SquareLoc, "Invalid range for list slice");
1527         return nullptr;
1528       }
1529
1530       // Eat the ']'.
1531       if (Lex.getCode() != tgtok::r_square) {
1532         TokError("expected ']' at end of list slice");
1533         return nullptr;
1534       }
1535       Lex.Lex();
1536       break;
1537     }
1538     case tgtok::period:
1539       if (Lex.Lex() != tgtok::Id) {  // eat the .
1540         TokError("expected field identifier after '.'");
1541         return nullptr;
1542       }
1543       if (!Result->getFieldType(Lex.getCurStrVal())) {
1544         TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1545                  Result->getAsString() + "'");
1546         return nullptr;
1547       }
1548       Result = FieldInit::get(Result, Lex.getCurStrVal());
1549       Lex.Lex();  // eat field name
1550       break;
1551
1552     case tgtok::paste:
1553       SMLoc PasteLoc = Lex.getLoc();
1554
1555       // Create a !strconcat() operation, first casting each operand to
1556       // a string if necessary.
1557
1558       TypedInit *LHS = dyn_cast<TypedInit>(Result);
1559       if (!LHS) {
1560         Error(PasteLoc, "LHS of paste is not typed!");
1561         return nullptr;
1562       }
1563
1564       if (LHS->getType() != StringRecTy::get()) {
1565         LHS = UnOpInit::get(UnOpInit::CAST, LHS, StringRecTy::get());
1566       }
1567
1568       TypedInit *RHS = nullptr;
1569
1570       Lex.Lex();  // Eat the '#'.
1571       switch (Lex.getCode()) {
1572       case tgtok::colon:
1573       case tgtok::semi:
1574       case tgtok::l_brace:
1575         // These are all of the tokens that can begin an object body.
1576         // Some of these can also begin values but we disallow those cases
1577         // because they are unlikely to be useful.
1578
1579         // Trailing paste, concat with an empty string.
1580         RHS = StringInit::get("");
1581         break;
1582
1583       default:
1584         Init *RHSResult = ParseValue(CurRec, ItemType, ParseNameMode);
1585         RHS = dyn_cast<TypedInit>(RHSResult);
1586         if (!RHS) {
1587           Error(PasteLoc, "RHS of paste is not typed!");
1588           return nullptr;
1589         }
1590
1591         if (RHS->getType() != StringRecTy::get()) {
1592           RHS = UnOpInit::get(UnOpInit::CAST, RHS, StringRecTy::get());
1593         }
1594
1595         break;
1596       }
1597
1598       Result = BinOpInit::get(BinOpInit::STRCONCAT, LHS, RHS,
1599                               StringRecTy::get())->Fold(CurRec, CurMultiClass);
1600       break;
1601     }
1602   }
1603 }
1604
1605 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1606 ///
1607 ///    DagArg     ::= Value (':' VARNAME)?
1608 ///    DagArg     ::= VARNAME
1609 ///    DagArgList ::= DagArg
1610 ///    DagArgList ::= DagArgList ',' DagArg
1611 std::vector<std::pair<llvm::Init*, std::string> >
1612 TGParser::ParseDagArgList(Record *CurRec) {
1613   std::vector<std::pair<llvm::Init*, std::string> > Result;
1614
1615   while (1) {
1616     // DagArg ::= VARNAME
1617     if (Lex.getCode() == tgtok::VarName) {
1618       // A missing value is treated like '?'.
1619       Result.push_back(std::make_pair(UnsetInit::get(), Lex.getCurStrVal()));
1620       Lex.Lex();
1621     } else {
1622       // DagArg ::= Value (':' VARNAME)?
1623       Init *Val = ParseValue(CurRec);
1624       if (!Val)
1625         return std::vector<std::pair<llvm::Init*, std::string> >();
1626
1627       // If the variable name is present, add it.
1628       std::string VarName;
1629       if (Lex.getCode() == tgtok::colon) {
1630         if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1631           TokError("expected variable name in dag literal");
1632           return std::vector<std::pair<llvm::Init*, std::string> >();
1633         }
1634         VarName = Lex.getCurStrVal();
1635         Lex.Lex();  // eat the VarName.
1636       }
1637
1638       Result.push_back(std::make_pair(Val, VarName));
1639     }
1640     if (Lex.getCode() != tgtok::comma) break;
1641     Lex.Lex(); // eat the ','
1642   }
1643
1644   return Result;
1645 }
1646
1647
1648 /// ParseValueList - Parse a comma separated list of values, returning them as a
1649 /// vector.  Note that this always expects to be able to parse at least one
1650 /// value.  It returns an empty list if this is not possible.
1651 ///
1652 ///   ValueList ::= Value (',' Value)
1653 ///
1654 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1655                                             RecTy *EltTy) {
1656   std::vector<Init*> Result;
1657   RecTy *ItemType = EltTy;
1658   unsigned int ArgN = 0;
1659   if (ArgsRec && !EltTy) {
1660     const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1661     if (!TArgs.size()) {
1662       TokError("template argument provided to non-template class");
1663       return std::vector<Init*>();
1664     }
1665     const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1666     if (!RV) {
1667       errs() << "Cannot find template arg " << ArgN << " (" << TArgs[ArgN]
1668         << ")\n";
1669     }
1670     assert(RV && "Template argument record not found??");
1671     ItemType = RV->getType();
1672     ++ArgN;
1673   }
1674   Result.push_back(ParseValue(CurRec, ItemType));
1675   if (!Result.back()) return std::vector<Init*>();
1676
1677   while (Lex.getCode() == tgtok::comma) {
1678     Lex.Lex();  // Eat the comma
1679
1680     if (ArgsRec && !EltTy) {
1681       const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1682       if (ArgN >= TArgs.size()) {
1683         TokError("too many template arguments");
1684         return std::vector<Init*>();
1685       }
1686       const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1687       assert(RV && "Template argument record not found??");
1688       ItemType = RV->getType();
1689       ++ArgN;
1690     }
1691     Result.push_back(ParseValue(CurRec, ItemType));
1692     if (!Result.back()) return std::vector<Init*>();
1693   }
1694
1695   return Result;
1696 }
1697
1698
1699 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1700 /// empty string on error.  This can happen in a number of different context's,
1701 /// including within a def or in the template args for a def (which which case
1702 /// CurRec will be non-null) and within the template args for a multiclass (in
1703 /// which case CurRec will be null, but CurMultiClass will be set).  This can
1704 /// also happen within a def that is within a multiclass, which will set both
1705 /// CurRec and CurMultiClass.
1706 ///
1707 ///  Declaration ::= FIELD? Type ID ('=' Value)?
1708 ///
1709 Init *TGParser::ParseDeclaration(Record *CurRec,
1710                                        bool ParsingTemplateArgs) {
1711   // Read the field prefix if present.
1712   bool HasField = Lex.getCode() == tgtok::Field;
1713   if (HasField) Lex.Lex();
1714
1715   RecTy *Type = ParseType();
1716   if (!Type) return nullptr;
1717
1718   if (Lex.getCode() != tgtok::Id) {
1719     TokError("Expected identifier in declaration");
1720     return nullptr;
1721   }
1722
1723   SMLoc IdLoc = Lex.getLoc();
1724   Init *DeclName = StringInit::get(Lex.getCurStrVal());
1725   Lex.Lex();
1726
1727   if (ParsingTemplateArgs) {
1728     if (CurRec) {
1729       DeclName = QualifyName(*CurRec, CurMultiClass, DeclName, ":");
1730     } else {
1731       assert(CurMultiClass);
1732     }
1733     if (CurMultiClass)
1734       DeclName = QualifyName(CurMultiClass->Rec, CurMultiClass, DeclName,
1735                              "::");
1736   }
1737
1738   // Add the value.
1739   if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1740     return nullptr;
1741
1742   // If a value is present, parse it.
1743   if (Lex.getCode() == tgtok::equal) {
1744     Lex.Lex();
1745     SMLoc ValLoc = Lex.getLoc();
1746     Init *Val = ParseValue(CurRec, Type);
1747     if (!Val ||
1748         SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1749       // Return the name, even if an error is thrown.  This is so that we can
1750       // continue to make some progress, even without the value having been
1751       // initialized.
1752       return DeclName;
1753   }
1754
1755   return DeclName;
1756 }
1757
1758 /// ParseForeachDeclaration - Read a foreach declaration, returning
1759 /// the name of the declared object or a NULL Init on error.  Return
1760 /// the name of the parsed initializer list through ForeachListName.
1761 ///
1762 ///  ForeachDeclaration ::= ID '=' '[' ValueList ']'
1763 ///  ForeachDeclaration ::= ID '=' '{' RangeList '}'
1764 ///  ForeachDeclaration ::= ID '=' RangePiece
1765 ///
1766 VarInit *TGParser::ParseForeachDeclaration(ListInit *&ForeachListValue) {
1767   if (Lex.getCode() != tgtok::Id) {
1768     TokError("Expected identifier in foreach declaration");
1769     return nullptr;
1770   }
1771
1772   Init *DeclName = StringInit::get(Lex.getCurStrVal());
1773   Lex.Lex();
1774
1775   // If a value is present, parse it.
1776   if (Lex.getCode() != tgtok::equal) {
1777     TokError("Expected '=' in foreach declaration");
1778     return nullptr;
1779   }
1780   Lex.Lex();  // Eat the '='
1781
1782   RecTy *IterType = nullptr;
1783   std::vector<unsigned> Ranges;
1784
1785   switch (Lex.getCode()) {
1786   default: TokError("Unknown token when expecting a range list"); return nullptr;
1787   case tgtok::l_square: { // '[' ValueList ']'
1788     Init *List = ParseSimpleValue(nullptr, nullptr, ParseForeachMode);
1789     ForeachListValue = dyn_cast<ListInit>(List);
1790     if (!ForeachListValue) {
1791       TokError("Expected a Value list");
1792       return nullptr;
1793     }
1794     RecTy *ValueType = ForeachListValue->getType();
1795     ListRecTy *ListType = dyn_cast<ListRecTy>(ValueType);
1796     if (!ListType) {
1797       TokError("Value list is not of list type");
1798       return nullptr;
1799     }
1800     IterType = ListType->getElementType();
1801     break;
1802   }
1803
1804   case tgtok::IntVal: { // RangePiece.
1805     if (ParseRangePiece(Ranges))
1806       return nullptr;
1807     break;
1808   }
1809
1810   case tgtok::l_brace: { // '{' RangeList '}'
1811     Lex.Lex(); // eat the '{'
1812     Ranges = ParseRangeList();
1813     if (Lex.getCode() != tgtok::r_brace) {
1814       TokError("expected '}' at end of bit range list");
1815       return nullptr;
1816     }
1817     Lex.Lex();
1818     break;
1819   }
1820   }
1821
1822   if (!Ranges.empty()) {
1823     assert(!IterType && "Type already initialized?");
1824     IterType = IntRecTy::get();
1825     std::vector<Init*> Values;
1826     for (unsigned i = 0, e = Ranges.size(); i != e; ++i)
1827       Values.push_back(IntInit::get(Ranges[i]));
1828     ForeachListValue = ListInit::get(Values, IterType);
1829   }
1830
1831   if (!IterType)
1832     return nullptr;
1833
1834   return VarInit::get(DeclName, IterType);
1835 }
1836
1837 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1838 /// sequence of template-declarations in <>'s.  If CurRec is non-null, these are
1839 /// template args for a def, which may or may not be in a multiclass.  If null,
1840 /// these are the template args for a multiclass.
1841 ///
1842 ///    TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1843 ///
1844 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1845   assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1846   Lex.Lex(); // eat the '<'
1847
1848   Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1849
1850   // Read the first declaration.
1851   Init *TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1852   if (!TemplArg)
1853     return true;
1854
1855   TheRecToAddTo->addTemplateArg(TemplArg);
1856
1857   while (Lex.getCode() == tgtok::comma) {
1858     Lex.Lex(); // eat the ','
1859
1860     // Read the following declarations.
1861     TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1862     if (!TemplArg)
1863       return true;
1864     TheRecToAddTo->addTemplateArg(TemplArg);
1865   }
1866
1867   if (Lex.getCode() != tgtok::greater)
1868     return TokError("expected '>' at end of template argument list");
1869   Lex.Lex(); // eat the '>'.
1870   return false;
1871 }
1872
1873
1874 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1875 ///
1876 ///   BodyItem ::= Declaration ';'
1877 ///   BodyItem ::= LET ID OptionalBitList '=' Value ';'
1878 bool TGParser::ParseBodyItem(Record *CurRec) {
1879   if (Lex.getCode() != tgtok::Let) {
1880     if (!ParseDeclaration(CurRec, false))
1881       return true;
1882
1883     if (Lex.getCode() != tgtok::semi)
1884       return TokError("expected ';' after declaration");
1885     Lex.Lex();
1886     return false;
1887   }
1888
1889   // LET ID OptionalRangeList '=' Value ';'
1890   if (Lex.Lex() != tgtok::Id)
1891     return TokError("expected field identifier after let");
1892
1893   SMLoc IdLoc = Lex.getLoc();
1894   std::string FieldName = Lex.getCurStrVal();
1895   Lex.Lex();  // eat the field name.
1896
1897   std::vector<unsigned> BitList;
1898   if (ParseOptionalBitList(BitList))
1899     return true;
1900   std::reverse(BitList.begin(), BitList.end());
1901
1902   if (Lex.getCode() != tgtok::equal)
1903     return TokError("expected '=' in let expression");
1904   Lex.Lex();  // eat the '='.
1905
1906   RecordVal *Field = CurRec->getValue(FieldName);
1907   if (!Field)
1908     return TokError("Value '" + FieldName + "' unknown!");
1909
1910   RecTy *Type = Field->getType();
1911
1912   Init *Val = ParseValue(CurRec, Type);
1913   if (!Val) return true;
1914
1915   if (Lex.getCode() != tgtok::semi)
1916     return TokError("expected ';' after let expression");
1917   Lex.Lex();
1918
1919   return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1920 }
1921
1922 /// ParseBody - Read the body of a class or def.  Return true on error, false on
1923 /// success.
1924 ///
1925 ///   Body     ::= ';'
1926 ///   Body     ::= '{' BodyList '}'
1927 ///   BodyList BodyItem*
1928 ///
1929 bool TGParser::ParseBody(Record *CurRec) {
1930   // If this is a null definition, just eat the semi and return.
1931   if (Lex.getCode() == tgtok::semi) {
1932     Lex.Lex();
1933     return false;
1934   }
1935
1936   if (Lex.getCode() != tgtok::l_brace)
1937     return TokError("Expected ';' or '{' to start body");
1938   // Eat the '{'.
1939   Lex.Lex();
1940
1941   while (Lex.getCode() != tgtok::r_brace)
1942     if (ParseBodyItem(CurRec))
1943       return true;
1944
1945   // Eat the '}'.
1946   Lex.Lex();
1947   return false;
1948 }
1949
1950 /// \brief Apply the current let bindings to \a CurRec.
1951 /// \returns true on error, false otherwise.
1952 bool TGParser::ApplyLetStack(Record *CurRec) {
1953   for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1954     for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1955       if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1956                    LetStack[i][j].Bits, LetStack[i][j].Value))
1957         return true;
1958   return false;
1959 }
1960
1961 /// ParseObjectBody - Parse the body of a def or class.  This consists of an
1962 /// optional ClassList followed by a Body.  CurRec is the current def or class
1963 /// that is being parsed.
1964 ///
1965 ///   ObjectBody      ::= BaseClassList Body
1966 ///   BaseClassList   ::= /*empty*/
1967 ///   BaseClassList   ::= ':' BaseClassListNE
1968 ///   BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1969 ///
1970 bool TGParser::ParseObjectBody(Record *CurRec) {
1971   // If there is a baseclass list, read it.
1972   if (Lex.getCode() == tgtok::colon) {
1973     Lex.Lex();
1974
1975     // Read all of the subclasses.
1976     SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1977     while (1) {
1978       // Check for error.
1979       if (!SubClass.Rec) return true;
1980
1981       // Add it.
1982       if (AddSubClass(CurRec, SubClass))
1983         return true;
1984
1985       if (Lex.getCode() != tgtok::comma) break;
1986       Lex.Lex(); // eat ','.
1987       SubClass = ParseSubClassReference(CurRec, false);
1988     }
1989   }
1990
1991   if (ApplyLetStack(CurRec))
1992     return true;
1993
1994   return ParseBody(CurRec);
1995 }
1996
1997 /// ParseDef - Parse and return a top level or multiclass def, return the record
1998 /// corresponding to it.  This returns null on error.
1999 ///
2000 ///   DefInst ::= DEF ObjectName ObjectBody
2001 ///
2002 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
2003   SMLoc DefLoc = Lex.getLoc();
2004   assert(Lex.getCode() == tgtok::Def && "Unknown tok");
2005   Lex.Lex();  // Eat the 'def' token.
2006
2007   // Parse ObjectName and make a record for it.
2008   Record *CurRec;
2009   Init *Name = ParseObjectName(CurMultiClass);
2010   if (Name)
2011     CurRec = new Record(Name, DefLoc, Records);
2012   else
2013     CurRec = new Record(GetNewAnonymousName(), DefLoc, Records,
2014                         /*IsAnonymous=*/true);
2015
2016   if (!CurMultiClass && Loops.empty()) {
2017     // Top-level def definition.
2018
2019     // Ensure redefinition doesn't happen.
2020     if (Records.getDef(CurRec->getNameInitAsString())) {
2021       Error(DefLoc, "def '" + CurRec->getNameInitAsString()
2022             + "' already defined");
2023       return true;
2024     }
2025     Records.addDef(CurRec);
2026
2027     if (ParseObjectBody(CurRec))
2028       return true;
2029   } else if (CurMultiClass) {
2030     // Parse the body before adding this prototype to the DefPrototypes vector.
2031     // That way implicit definitions will be added to the DefPrototypes vector
2032     // before this object, instantiated prior to defs derived from this object,
2033     // and this available for indirect name resolution when defs derived from
2034     // this object are instantiated.
2035     if (ParseObjectBody(CurRec))
2036       return true;
2037
2038     // Otherwise, a def inside a multiclass, add it to the multiclass.
2039     for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
2040       if (CurMultiClass->DefPrototypes[i]->getNameInit()
2041           == CurRec->getNameInit()) {
2042         Error(DefLoc, "def '" + CurRec->getNameInitAsString() +
2043               "' already defined in this multiclass!");
2044         return true;
2045       }
2046     CurMultiClass->DefPrototypes.push_back(CurRec);
2047   } else if (ParseObjectBody(CurRec))
2048     return true;
2049
2050   if (!CurMultiClass)  // Def's in multiclasses aren't really defs.
2051     // See Record::setName().  This resolve step will see any new name
2052     // for the def that might have been created when resolving
2053     // inheritance, values and arguments above.
2054     CurRec->resolveReferences();
2055
2056   // If ObjectBody has template arguments, it's an error.
2057   assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
2058
2059   if (CurMultiClass) {
2060     // Copy the template arguments for the multiclass into the def.
2061     const std::vector<Init *> &TArgs =
2062                                 CurMultiClass->Rec.getTemplateArgs();
2063
2064     for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2065       const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
2066       assert(RV && "Template arg doesn't exist?");
2067       CurRec->addValue(*RV);
2068     }
2069   }
2070
2071   if (ProcessForeachDefs(CurRec, DefLoc)) {
2072     Error(DefLoc,
2073           "Could not process loops for def" + CurRec->getNameInitAsString());
2074     return true;
2075   }
2076
2077   return false;
2078 }
2079
2080 /// ParseForeach - Parse a for statement.  Return the record corresponding
2081 /// to it.  This returns true on error.
2082 ///
2083 ///   Foreach ::= FOREACH Declaration IN '{ ObjectList '}'
2084 ///   Foreach ::= FOREACH Declaration IN Object
2085 ///
2086 bool TGParser::ParseForeach(MultiClass *CurMultiClass) {
2087   assert(Lex.getCode() == tgtok::Foreach && "Unknown tok");
2088   Lex.Lex();  // Eat the 'for' token.
2089
2090   // Make a temporary object to record items associated with the for
2091   // loop.
2092   ListInit *ListValue = nullptr;
2093   VarInit *IterName = ParseForeachDeclaration(ListValue);
2094   if (!IterName)
2095     return TokError("expected declaration in for");
2096
2097   if (Lex.getCode() != tgtok::In)
2098     return TokError("Unknown tok");
2099   Lex.Lex();  // Eat the in
2100
2101   // Create a loop object and remember it.
2102   Loops.push_back(ForeachLoop(IterName, ListValue));
2103
2104   if (Lex.getCode() != tgtok::l_brace) {
2105     // FOREACH Declaration IN Object
2106     if (ParseObject(CurMultiClass))
2107       return true;
2108   }
2109   else {
2110     SMLoc BraceLoc = Lex.getLoc();
2111     // Otherwise, this is a group foreach.
2112     Lex.Lex();  // eat the '{'.
2113
2114     // Parse the object list.
2115     if (ParseObjectList(CurMultiClass))
2116       return true;
2117
2118     if (Lex.getCode() != tgtok::r_brace) {
2119       TokError("expected '}' at end of foreach command");
2120       return Error(BraceLoc, "to match this '{'");
2121     }
2122     Lex.Lex();  // Eat the }
2123   }
2124
2125   // We've processed everything in this loop.
2126   Loops.pop_back();
2127
2128   return false;
2129 }
2130
2131 /// ParseClass - Parse a tblgen class definition.
2132 ///
2133 ///   ClassInst ::= CLASS ID TemplateArgList? ObjectBody
2134 ///
2135 bool TGParser::ParseClass() {
2136   assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
2137   Lex.Lex();
2138
2139   if (Lex.getCode() != tgtok::Id)
2140     return TokError("expected class name after 'class' keyword");
2141
2142   Record *CurRec = Records.getClass(Lex.getCurStrVal());
2143   if (CurRec) {
2144     // If the body was previously defined, this is an error.
2145     if (CurRec->getValues().size() > 1 ||  // Account for NAME.
2146         !CurRec->getSuperClasses().empty() ||
2147         !CurRec->getTemplateArgs().empty())
2148       return TokError("Class '" + CurRec->getNameInitAsString()
2149                       + "' already defined");
2150   } else {
2151     // If this is the first reference to this class, create and add it.
2152     CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc(), Records);
2153     Records.addClass(CurRec);
2154   }
2155   Lex.Lex(); // eat the name.
2156
2157   // If there are template args, parse them.
2158   if (Lex.getCode() == tgtok::less)
2159     if (ParseTemplateArgList(CurRec))
2160       return true;
2161
2162   // Finally, parse the object body.
2163   return ParseObjectBody(CurRec);
2164 }
2165
2166 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
2167 /// of LetRecords.
2168 ///
2169 ///   LetList ::= LetItem (',' LetItem)*
2170 ///   LetItem ::= ID OptionalRangeList '=' Value
2171 ///
2172 std::vector<LetRecord> TGParser::ParseLetList() {
2173   std::vector<LetRecord> Result;
2174
2175   while (1) {
2176     if (Lex.getCode() != tgtok::Id) {
2177       TokError("expected identifier in let definition");
2178       return std::vector<LetRecord>();
2179     }
2180     std::string Name = Lex.getCurStrVal();
2181     SMLoc NameLoc = Lex.getLoc();
2182     Lex.Lex();  // Eat the identifier.
2183
2184     // Check for an optional RangeList.
2185     std::vector<unsigned> Bits;
2186     if (ParseOptionalRangeList(Bits))
2187       return std::vector<LetRecord>();
2188     std::reverse(Bits.begin(), Bits.end());
2189
2190     if (Lex.getCode() != tgtok::equal) {
2191       TokError("expected '=' in let expression");
2192       return std::vector<LetRecord>();
2193     }
2194     Lex.Lex();  // eat the '='.
2195
2196     Init *Val = ParseValue(nullptr);
2197     if (!Val) return std::vector<LetRecord>();
2198
2199     // Now that we have everything, add the record.
2200     Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
2201
2202     if (Lex.getCode() != tgtok::comma)
2203       return Result;
2204     Lex.Lex();  // eat the comma.
2205   }
2206 }
2207
2208 /// ParseTopLevelLet - Parse a 'let' at top level.  This can be a couple of
2209 /// different related productions. This works inside multiclasses too.
2210 ///
2211 ///   Object ::= LET LetList IN '{' ObjectList '}'
2212 ///   Object ::= LET LetList IN Object
2213 ///
2214 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
2215   assert(Lex.getCode() == tgtok::Let && "Unexpected token");
2216   Lex.Lex();
2217
2218   // Add this entry to the let stack.
2219   std::vector<LetRecord> LetInfo = ParseLetList();
2220   if (LetInfo.empty()) return true;
2221   LetStack.push_back(LetInfo);
2222
2223   if (Lex.getCode() != tgtok::In)
2224     return TokError("expected 'in' at end of top-level 'let'");
2225   Lex.Lex();
2226
2227   // If this is a scalar let, just handle it now
2228   if (Lex.getCode() != tgtok::l_brace) {
2229     // LET LetList IN Object
2230     if (ParseObject(CurMultiClass))
2231       return true;
2232   } else {   // Object ::= LETCommand '{' ObjectList '}'
2233     SMLoc BraceLoc = Lex.getLoc();
2234     // Otherwise, this is a group let.
2235     Lex.Lex();  // eat the '{'.
2236
2237     // Parse the object list.
2238     if (ParseObjectList(CurMultiClass))
2239       return true;
2240
2241     if (Lex.getCode() != tgtok::r_brace) {
2242       TokError("expected '}' at end of top level let command");
2243       return Error(BraceLoc, "to match this '{'");
2244     }
2245     Lex.Lex();
2246   }
2247
2248   // Outside this let scope, this let block is not active.
2249   LetStack.pop_back();
2250   return false;
2251 }
2252
2253 /// ParseMultiClass - Parse a multiclass definition.
2254 ///
2255 ///  MultiClassInst ::= MULTICLASS ID TemplateArgList?
2256 ///                     ':' BaseMultiClassList '{' MultiClassObject+ '}'
2257 ///  MultiClassObject ::= DefInst
2258 ///  MultiClassObject ::= MultiClassInst
2259 ///  MultiClassObject ::= DefMInst
2260 ///  MultiClassObject ::= LETCommand '{' ObjectList '}'
2261 ///  MultiClassObject ::= LETCommand Object
2262 ///
2263 bool TGParser::ParseMultiClass() {
2264   assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
2265   Lex.Lex();  // Eat the multiclass token.
2266
2267   if (Lex.getCode() != tgtok::Id)
2268     return TokError("expected identifier after multiclass for name");
2269   std::string Name = Lex.getCurStrVal();
2270
2271   if (MultiClasses.count(Name))
2272     return TokError("multiclass '" + Name + "' already defined");
2273
2274   CurMultiClass = MultiClasses[Name] = new MultiClass(Name,
2275                                                       Lex.getLoc(), Records);
2276   Lex.Lex();  // Eat the identifier.
2277
2278   // If there are template args, parse them.
2279   if (Lex.getCode() == tgtok::less)
2280     if (ParseTemplateArgList(nullptr))
2281       return true;
2282
2283   bool inherits = false;
2284
2285   // If there are submulticlasses, parse them.
2286   if (Lex.getCode() == tgtok::colon) {
2287     inherits = true;
2288
2289     Lex.Lex();
2290
2291     // Read all of the submulticlasses.
2292     SubMultiClassReference SubMultiClass =
2293       ParseSubMultiClassReference(CurMultiClass);
2294     while (1) {
2295       // Check for error.
2296       if (!SubMultiClass.MC) return true;
2297
2298       // Add it.
2299       if (AddSubMultiClass(CurMultiClass, SubMultiClass))
2300         return true;
2301
2302       if (Lex.getCode() != tgtok::comma) break;
2303       Lex.Lex(); // eat ','.
2304       SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
2305     }
2306   }
2307
2308   if (Lex.getCode() != tgtok::l_brace) {
2309     if (!inherits)
2310       return TokError("expected '{' in multiclass definition");
2311     else if (Lex.getCode() != tgtok::semi)
2312       return TokError("expected ';' in multiclass definition");
2313     else
2314       Lex.Lex();  // eat the ';'.
2315   } else {
2316     if (Lex.Lex() == tgtok::r_brace)  // eat the '{'.
2317       return TokError("multiclass must contain at least one def");
2318
2319     while (Lex.getCode() != tgtok::r_brace) {
2320       switch (Lex.getCode()) {
2321         default:
2322           return TokError("expected 'let', 'def' or 'defm' in multiclass body");
2323         case tgtok::Let:
2324         case tgtok::Def:
2325         case tgtok::Defm:
2326         case tgtok::Foreach:
2327           if (ParseObject(CurMultiClass))
2328             return true;
2329          break;
2330       }
2331     }
2332     Lex.Lex();  // eat the '}'.
2333   }
2334
2335   CurMultiClass = nullptr;
2336   return false;
2337 }
2338
2339 Record *TGParser::
2340 InstantiateMulticlassDef(MultiClass &MC,
2341                          Record *DefProto,
2342                          Init *&DefmPrefix,
2343                          SMRange DefmPrefixRange) {
2344   // We need to preserve DefProto so it can be reused for later
2345   // instantiations, so create a new Record to inherit from it.
2346
2347   // Add in the defm name.  If the defm prefix is empty, give each
2348   // instantiated def a unique name.  Otherwise, if "#NAME#" exists in the
2349   // name, substitute the prefix for #NAME#.  Otherwise, use the defm name
2350   // as a prefix.
2351
2352   bool IsAnonymous = false;
2353   if (!DefmPrefix) {
2354     DefmPrefix = StringInit::get(GetNewAnonymousName());
2355     IsAnonymous = true;
2356   }
2357
2358   Init *DefName = DefProto->getNameInit();
2359
2360   StringInit *DefNameString = dyn_cast<StringInit>(DefName);
2361
2362   if (DefNameString) {
2363     // We have a fully expanded string so there are no operators to
2364     // resolve.  We should concatenate the given prefix and name.
2365     DefName =
2366       BinOpInit::get(BinOpInit::STRCONCAT,
2367                      UnOpInit::get(UnOpInit::CAST, DefmPrefix,
2368                                    StringRecTy::get())->Fold(DefProto, &MC),
2369                      DefName, StringRecTy::get())->Fold(DefProto, &MC);
2370   }
2371
2372   // Make a trail of SMLocs from the multiclass instantiations.
2373   SmallVector<SMLoc, 4> Locs(1, DefmPrefixRange.Start);
2374   Locs.append(DefProto->getLoc().begin(), DefProto->getLoc().end());
2375   Record *CurRec = new Record(DefName, Locs, Records, IsAnonymous);
2376
2377   SubClassReference Ref;
2378   Ref.RefRange = DefmPrefixRange;
2379   Ref.Rec = DefProto;
2380   AddSubClass(CurRec, Ref);
2381
2382   // Set the value for NAME. We don't resolve references to it 'til later,
2383   // though, so that uses in nested multiclass names don't get
2384   // confused.
2385   if (SetValue(CurRec, Ref.RefRange.Start, "NAME", std::vector<unsigned>(),
2386                DefmPrefix)) {
2387     Error(DefmPrefixRange.Start, "Could not resolve "
2388           + CurRec->getNameInitAsString() + ":NAME to '"
2389           + DefmPrefix->getAsUnquotedString() + "'");
2390     return nullptr;
2391   }
2392
2393   // If the DefNameString didn't resolve, we probably have a reference to
2394   // NAME and need to replace it. We need to do at least this much greedily,
2395   // otherwise nested multiclasses will end up with incorrect NAME expansions.
2396   if (!DefNameString) {
2397     RecordVal *DefNameRV = CurRec->getValue("NAME");
2398     CurRec->resolveReferencesTo(DefNameRV);
2399   }
2400
2401   if (!CurMultiClass) {
2402     // Now that we're at the top level, resolve all NAME references
2403     // in the resultant defs that weren't in the def names themselves.
2404     RecordVal *DefNameRV = CurRec->getValue("NAME");
2405     CurRec->resolveReferencesTo(DefNameRV);
2406
2407     // Now that NAME references are resolved and we're at the top level of
2408     // any multiclass expansions, add the record to the RecordKeeper. If we are
2409     // currently in a multiclass, it means this defm appears inside a
2410     // multiclass and its name won't be fully resolvable until we see
2411     // the top-level defm.  Therefore, we don't add this to the
2412     // RecordKeeper at this point.  If we did we could get duplicate
2413     // defs as more than one probably refers to NAME or some other
2414     // common internal placeholder.
2415
2416     // Ensure redefinition doesn't happen.
2417     if (Records.getDef(CurRec->getNameInitAsString())) {
2418       Error(DefmPrefixRange.Start, "def '" + CurRec->getNameInitAsString() +
2419             "' already defined, instantiating defm with subdef '" +
2420             DefProto->getNameInitAsString() + "'");
2421       return nullptr;
2422     }
2423
2424     Records.addDef(CurRec);
2425   }
2426
2427   return CurRec;
2428 }
2429
2430 bool TGParser::ResolveMulticlassDefArgs(MultiClass &MC,
2431                                         Record *CurRec,
2432                                         SMLoc DefmPrefixLoc,
2433                                         SMLoc SubClassLoc,
2434                                         const std::vector<Init *> &TArgs,
2435                                         std::vector<Init *> &TemplateVals,
2436                                         bool DeleteArgs) {
2437   // Loop over all of the template arguments, setting them to the specified
2438   // value or leaving them as the default if necessary.
2439   for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2440     // Check if a value is specified for this temp-arg.
2441     if (i < TemplateVals.size()) {
2442       // Set it now.
2443       if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
2444                    TemplateVals[i]))
2445         return true;
2446
2447       // Resolve it next.
2448       CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
2449
2450       if (DeleteArgs)
2451         // Now remove it.
2452         CurRec->removeValue(TArgs[i]);
2453
2454     } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2455       return Error(SubClassLoc, "value not specified for template argument #"+
2456                    utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
2457                    + ") of multiclassclass '" + MC.Rec.getNameInitAsString()
2458                    + "'");
2459     }
2460   }
2461   return false;
2462 }
2463
2464 bool TGParser::ResolveMulticlassDef(MultiClass &MC,
2465                                     Record *CurRec,
2466                                     Record *DefProto,
2467                                     SMLoc DefmPrefixLoc) {
2468   // If the mdef is inside a 'let' expression, add to each def.
2469   if (ApplyLetStack(CurRec))
2470     return Error(DefmPrefixLoc, "when instantiating this defm");
2471
2472   // Don't create a top level definition for defm inside multiclasses,
2473   // instead, only update the prototypes and bind the template args
2474   // with the new created definition.
2475   if (!CurMultiClass)
2476     return false;
2477   for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2478        i != e; ++i)
2479     if (CurMultiClass->DefPrototypes[i]->getNameInit()
2480         == CurRec->getNameInit())
2481       return Error(DefmPrefixLoc, "defm '" + CurRec->getNameInitAsString() +
2482                    "' already defined in this multiclass!");
2483   CurMultiClass->DefPrototypes.push_back(CurRec);
2484
2485   // Copy the template arguments for the multiclass into the new def.
2486   const std::vector<Init *> &TA =
2487     CurMultiClass->Rec.getTemplateArgs();
2488
2489   for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2490     const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2491     assert(RV && "Template arg doesn't exist?");
2492     CurRec->addValue(*RV);
2493   }
2494
2495   return false;
2496 }
2497
2498 /// ParseDefm - Parse the instantiation of a multiclass.
2499 ///
2500 ///   DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
2501 ///
2502 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
2503   assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
2504   SMLoc DefmLoc = Lex.getLoc();
2505   Init *DefmPrefix = nullptr;
2506
2507   if (Lex.Lex() == tgtok::Id) {  // eat the defm.
2508     DefmPrefix = ParseObjectName(CurMultiClass);
2509   }
2510
2511   SMLoc DefmPrefixEndLoc = Lex.getLoc();
2512   if (Lex.getCode() != tgtok::colon)
2513     return TokError("expected ':' after defm identifier");
2514
2515   // Keep track of the new generated record definitions.
2516   std::vector<Record*> NewRecDefs;
2517
2518   // This record also inherits from a regular class (non-multiclass)?
2519   bool InheritFromClass = false;
2520
2521   // eat the colon.
2522   Lex.Lex();
2523
2524   SMLoc SubClassLoc = Lex.getLoc();
2525   SubClassReference Ref = ParseSubClassReference(nullptr, true);
2526
2527   while (1) {
2528     if (!Ref.Rec) return true;
2529
2530     // To instantiate a multiclass, we need to first get the multiclass, then
2531     // instantiate each def contained in the multiclass with the SubClassRef
2532     // template parameters.
2533     MultiClass *MC = MultiClasses[Ref.Rec->getName()];
2534     assert(MC && "Didn't lookup multiclass correctly?");
2535     std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
2536
2537     // Verify that the correct number of template arguments were specified.
2538     const std::vector<Init *> &TArgs = MC->Rec.getTemplateArgs();
2539     if (TArgs.size() < TemplateVals.size())
2540       return Error(SubClassLoc,
2541                    "more template args specified than multiclass expects");
2542
2543     // Loop over all the def's in the multiclass, instantiating each one.
2544     for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
2545       Record *DefProto = MC->DefPrototypes[i];
2546
2547       Record *CurRec = InstantiateMulticlassDef(*MC, DefProto, DefmPrefix,
2548                                                 SMRange(DefmLoc,
2549                                                         DefmPrefixEndLoc));
2550       if (!CurRec)
2551         return true;
2552
2553       if (ResolveMulticlassDefArgs(*MC, CurRec, DefmLoc, SubClassLoc,
2554                                    TArgs, TemplateVals, true/*Delete args*/))
2555         return Error(SubClassLoc, "could not instantiate def");
2556
2557       if (ResolveMulticlassDef(*MC, CurRec, DefProto, DefmLoc))
2558         return Error(SubClassLoc, "could not instantiate def");
2559
2560       NewRecDefs.push_back(CurRec);
2561     }
2562
2563
2564     if (Lex.getCode() != tgtok::comma) break;
2565     Lex.Lex(); // eat ','.
2566
2567     if (Lex.getCode() != tgtok::Id)
2568       return TokError("expected identifier");
2569
2570     SubClassLoc = Lex.getLoc();
2571
2572     // A defm can inherit from regular classes (non-multiclass) as
2573     // long as they come in the end of the inheritance list.
2574     InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != nullptr);
2575
2576     if (InheritFromClass)
2577       break;
2578
2579     Ref = ParseSubClassReference(nullptr, true);
2580   }
2581
2582   if (InheritFromClass) {
2583     // Process all the classes to inherit as if they were part of a
2584     // regular 'def' and inherit all record values.
2585     SubClassReference SubClass = ParseSubClassReference(nullptr, false);
2586     while (1) {
2587       // Check for error.
2588       if (!SubClass.Rec) return true;
2589
2590       // Get the expanded definition prototypes and teach them about
2591       // the record values the current class to inherit has
2592       for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2593         Record *CurRec = NewRecDefs[i];
2594
2595         // Add it.
2596         if (AddSubClass(CurRec, SubClass))
2597           return true;
2598
2599         if (ApplyLetStack(CurRec))
2600           return true;
2601       }
2602
2603       if (Lex.getCode() != tgtok::comma) break;
2604       Lex.Lex(); // eat ','.
2605       SubClass = ParseSubClassReference(nullptr, false);
2606     }
2607   }
2608
2609   if (!CurMultiClass)
2610     for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2611       // See Record::setName().  This resolve step will see any new
2612       // name for the def that might have been created when resolving
2613       // inheritance, values and arguments above.
2614       NewRecDefs[i]->resolveReferences();
2615
2616   if (Lex.getCode() != tgtok::semi)
2617     return TokError("expected ';' at end of defm");
2618   Lex.Lex();
2619
2620   return false;
2621 }
2622
2623 /// ParseObject
2624 ///   Object ::= ClassInst
2625 ///   Object ::= DefInst
2626 ///   Object ::= MultiClassInst
2627 ///   Object ::= DefMInst
2628 ///   Object ::= LETCommand '{' ObjectList '}'
2629 ///   Object ::= LETCommand Object
2630 bool TGParser::ParseObject(MultiClass *MC) {
2631   switch (Lex.getCode()) {
2632   default:
2633     return TokError("Expected class, def, defm, multiclass or let definition");
2634   case tgtok::Let:   return ParseTopLevelLet(MC);
2635   case tgtok::Def:   return ParseDef(MC);
2636   case tgtok::Foreach:   return ParseForeach(MC);
2637   case tgtok::Defm:  return ParseDefm(MC);
2638   case tgtok::Class: return ParseClass();
2639   case tgtok::MultiClass: return ParseMultiClass();
2640   }
2641 }
2642
2643 /// ParseObjectList
2644 ///   ObjectList :== Object*
2645 bool TGParser::ParseObjectList(MultiClass *MC) {
2646   while (isObjectStart(Lex.getCode())) {
2647     if (ParseObject(MC))
2648       return true;
2649   }
2650   return false;
2651 }
2652
2653 bool TGParser::ParseFile() {
2654   Lex.Lex(); // Prime the lexer.
2655   if (ParseObjectList()) return true;
2656
2657   // If we have unread input at the end of the file, report it.
2658   if (Lex.getCode() == tgtok::Eof)
2659     return false;
2660
2661   return TokError("Unexpected input at top level");
2662 }
2663