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