1 //===- TGParser.cpp - Parser for TableGen Files ---------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Implement the Parser for TableGen.
12 //===----------------------------------------------------------------------===//
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/Support/Streams.h"
22 //===----------------------------------------------------------------------===//
23 // Support Code for the Semantic Actions.
24 //===----------------------------------------------------------------------===//
27 struct SubClassReference {
30 std::vector<Init*> TemplateArgs;
31 SubClassReference() : Rec(0) {}
33 bool isInvalid() const { return Rec == 0; }
36 struct SubMultiClassReference {
39 std::vector<Init*> TemplateArgs;
40 SubMultiClassReference() : MC(0) {}
42 bool isInvalid() const { return MC == 0; }
46 void SubMultiClassReference::dump() const {
47 cerr << "Multiclass:\n";
51 cerr << "Template args:\n";
52 for (std::vector<Init *>::const_iterator i = TemplateArgs.begin(),
53 iend = TemplateArgs.end();
60 } // end namespace llvm
62 bool TGParser::AddValue(Record *CurRec, TGLoc Loc, const RecordVal &RV) {
64 CurRec = &CurMultiClass->Rec;
66 if (RecordVal *ERV = CurRec->getValue(RV.getName())) {
67 // The value already exists in the class, treat this as a set.
68 if (ERV->setValue(RV.getValue()))
69 return Error(Loc, "New definition of '" + RV.getName() + "' of type '" +
70 RV.getType()->getAsString() + "' is incompatible with " +
71 "previous definition of type '" +
72 ERV->getType()->getAsString() + "'");
80 /// Return true on error, false on success.
81 bool TGParser::SetValue(Record *CurRec, TGLoc Loc, const std::string &ValName,
82 const std::vector<unsigned> &BitList, Init *V) {
85 if (CurRec == 0) CurRec = &CurMultiClass->Rec;
87 RecordVal *RV = CurRec->getValue(ValName);
89 return Error(Loc, "Value '" + ValName + "' unknown!");
91 // Do not allow assignments like 'X = X'. This will just cause infinite loops
92 // in the resolution machinery.
94 if (VarInit *VI = dynamic_cast<VarInit*>(V))
95 if (VI->getName() == ValName)
98 // If we are assigning to a subset of the bits in the value... then we must be
99 // assigning to a field of BitsRecTy, which must have a BitsInit
102 if (!BitList.empty()) {
103 BitsInit *CurVal = dynamic_cast<BitsInit*>(RV->getValue());
105 return Error(Loc, "Value '" + ValName + "' is not a bits type");
107 // Convert the incoming value to a bits type of the appropriate size...
108 Init *BI = V->convertInitializerTo(new BitsRecTy(BitList.size()));
110 V->convertInitializerTo(new BitsRecTy(BitList.size()));
111 return Error(Loc, "Initializer is not compatible with bit range");
114 // We should have a BitsInit type now.
115 BitsInit *BInit = dynamic_cast<BitsInit*>(BI);
118 BitsInit *NewVal = new BitsInit(CurVal->getNumBits());
120 // Loop over bits, assigning values as appropriate.
121 for (unsigned i = 0, e = BitList.size(); i != e; ++i) {
122 unsigned Bit = BitList[i];
123 if (NewVal->getBit(Bit))
124 return Error(Loc, "Cannot set bit #" + utostr(Bit) + " of value '" +
125 ValName + "' more than once");
126 NewVal->setBit(Bit, BInit->getBit(i));
129 for (unsigned i = 0, e = CurVal->getNumBits(); i != e; ++i)
130 if (NewVal->getBit(i) == 0)
131 NewVal->setBit(i, CurVal->getBit(i));
137 return Error(Loc, "Value '" + ValName + "' of type '" +
138 RV->getType()->getAsString() +
139 "' is incompatible with initializer '" + V->getAsString() +"'");
143 /// AddSubClass - Add SubClass as a subclass to CurRec, resolving its template
144 /// args as SubClass's template arguments.
145 bool TGParser::AddSubClass(Record *CurRec, SubClassReference &SubClass) {
146 Record *SC = SubClass.Rec;
147 // Add all of the values in the subclass into the current class.
148 const std::vector<RecordVal> &Vals = SC->getValues();
149 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
150 if (AddValue(CurRec, SubClass.RefLoc, Vals[i]))
153 const std::vector<std::string> &TArgs = SC->getTemplateArgs();
155 // Ensure that an appropriate number of template arguments are specified.
156 if (TArgs.size() < SubClass.TemplateArgs.size())
157 return Error(SubClass.RefLoc, "More template args specified than expected");
159 // Loop over all of the template arguments, setting them to the specified
160 // value or leaving them as the default if necessary.
161 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
162 if (i < SubClass.TemplateArgs.size()) {
163 // If a value is specified for this template arg, set it now.
164 if (SetValue(CurRec, SubClass.RefLoc, TArgs[i], std::vector<unsigned>(),
165 SubClass.TemplateArgs[i]))
169 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
172 CurRec->removeValue(TArgs[i]);
174 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
175 return Error(SubClass.RefLoc,"Value not specified for template argument #"
176 + utostr(i) + " (" + TArgs[i] + ") of subclass '" +
177 SC->getName() + "'!");
181 // Since everything went well, we can now set the "superclass" list for the
183 const std::vector<Record*> &SCs = SC->getSuperClasses();
184 for (unsigned i = 0, e = SCs.size(); i != e; ++i) {
185 if (CurRec->isSubClassOf(SCs[i]))
186 return Error(SubClass.RefLoc,
187 "Already subclass of '" + SCs[i]->getName() + "'!\n");
188 CurRec->addSuperClass(SCs[i]);
191 if (CurRec->isSubClassOf(SC))
192 return Error(SubClass.RefLoc,
193 "Already subclass of '" + SC->getName() + "'!\n");
194 CurRec->addSuperClass(SC);
198 /// AddSubMultiClass - Add SubMultiClass as a subclass to
199 /// CurMC, resolving its template args as SubMultiClass's
200 /// template arguments.
201 bool TGParser::AddSubMultiClass(MultiClass *CurMC,
202 SubMultiClassReference &SubMultiClass) {
203 MultiClass *SMC = SubMultiClass.MC;
204 Record *CurRec = &CurMC->Rec;
206 const std::vector<RecordVal> &MCVals = CurRec->getValues();
208 // Add all of the values in the subclass into the current class.
209 const std::vector<RecordVal> &SMCVals = SMC->Rec.getValues();
210 for (unsigned i = 0, e = SMCVals.size(); i != e; ++i)
211 if (AddValue(CurRec, SubMultiClass.RefLoc, SMCVals[i]))
214 int newDefStart = CurMC->DefPrototypes.size();
216 // Add all of the defs in the subclass into the current multiclass.
217 for (MultiClass::RecordVector::const_iterator i = SMC->DefPrototypes.begin(),
218 iend = SMC->DefPrototypes.end();
221 // Clone the def and add it to the current multiclass
222 Record *NewDef = new Record(**i);
224 // Add all of the values in the superclass into the current def.
225 for (unsigned i = 0, e = MCVals.size(); i != e; ++i)
226 if (AddValue(NewDef, SubMultiClass.RefLoc, MCVals[i]))
229 CurMC->DefPrototypes.push_back(NewDef);
232 const std::vector<std::string> &SMCTArgs = SMC->Rec.getTemplateArgs();
234 // Ensure that an appropriate number of template arguments are
236 if (SMCTArgs.size() < SubMultiClass.TemplateArgs.size())
237 return Error(SubMultiClass.RefLoc,
238 "More template args specified than expected");
240 // Loop over all of the template arguments, setting them to the specified
241 // value or leaving them as the default if necessary.
242 for (unsigned i = 0, e = SMCTArgs.size(); i != e; ++i) {
243 if (i < SubMultiClass.TemplateArgs.size()) {
244 // If a value is specified for this template arg, set it in the
246 if (SetValue(CurRec, SubMultiClass.RefLoc, SMCTArgs[i],
247 std::vector<unsigned>(),
248 SubMultiClass.TemplateArgs[i]))
252 CurRec->resolveReferencesTo(CurRec->getValue(SMCTArgs[i]));
255 CurRec->removeValue(SMCTArgs[i]);
257 // If a value is specified for this template arg, set it in the
259 for (MultiClass::RecordVector::iterator j =
260 CurMC->DefPrototypes.begin() + newDefStart,
261 jend = CurMC->DefPrototypes.end();
266 if (SetValue(Def, SubMultiClass.RefLoc, SMCTArgs[i],
267 std::vector<unsigned>(),
268 SubMultiClass.TemplateArgs[i]))
272 Def->resolveReferencesTo(Def->getValue(SMCTArgs[i]));
275 Def->removeValue(SMCTArgs[i]);
277 } else if (!CurRec->getValue(SMCTArgs[i])->getValue()->isComplete()) {
278 return Error(SubMultiClass.RefLoc,
279 "Value not specified for template argument #"
280 + utostr(i) + " (" + SMCTArgs[i] + ") of subclass '" +
281 SMC->Rec.getName() + "'!");
288 //===----------------------------------------------------------------------===//
290 //===----------------------------------------------------------------------===//
292 /// isObjectStart - Return true if this is a valid first token for an Object.
293 static bool isObjectStart(tgtok::TokKind K) {
294 return K == tgtok::Class || K == tgtok::Def ||
295 K == tgtok::Defm || K == tgtok::Let || K == tgtok::MultiClass;
298 /// ParseObjectName - If an object name is specified, return it. Otherwise,
299 /// return an anonymous name.
300 /// ObjectName ::= ID
301 /// ObjectName ::= /*empty*/
303 std::string TGParser::ParseObjectName() {
304 if (Lex.getCode() == tgtok::Id) {
305 std::string Ret = Lex.getCurStrVal();
310 static unsigned AnonCounter = 0;
311 return "anonymous."+utostr(AnonCounter++);
315 /// ParseClassID - Parse and resolve a reference to a class name. This returns
320 Record *TGParser::ParseClassID() {
321 if (Lex.getCode() != tgtok::Id) {
322 TokError("expected name for ClassID");
326 Record *Result = Records.getClass(Lex.getCurStrVal());
328 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
334 /// ParseMultiClassID - Parse and resolve a reference to a multiclass name.
335 /// This returns null on error.
337 /// MultiClassID ::= ID
339 MultiClass *TGParser::ParseMultiClassID() {
340 if (Lex.getCode() != tgtok::Id) {
341 TokError("expected name for ClassID");
345 MultiClass *Result = MultiClasses[Lex.getCurStrVal()];
347 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
353 Record *TGParser::ParseDefmID() {
354 if (Lex.getCode() != tgtok::Id) {
355 TokError("expected multiclass name");
359 MultiClass *MC = MultiClasses[Lex.getCurStrVal()];
361 TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
371 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
372 /// subclass. This returns a SubClassRefTy with a null Record* on error.
374 /// SubClassRef ::= ClassID
375 /// SubClassRef ::= ClassID '<' ValueList '>'
377 SubClassReference TGParser::
378 ParseSubClassReference(Record *CurRec, bool isDefm) {
379 SubClassReference Result;
380 Result.RefLoc = Lex.getLoc();
383 Result.Rec = ParseDefmID();
385 Result.Rec = ParseClassID();
386 if (Result.Rec == 0) return Result;
388 // If there is no template arg list, we're done.
389 if (Lex.getCode() != tgtok::less)
391 Lex.Lex(); // Eat the '<'
393 if (Lex.getCode() == tgtok::greater) {
394 TokError("subclass reference requires a non-empty list of template values");
399 Result.TemplateArgs = ParseValueList(CurRec);
400 if (Result.TemplateArgs.empty()) {
401 Result.Rec = 0; // Error parsing value list.
405 if (Lex.getCode() != tgtok::greater) {
406 TokError("expected '>' in template value list");
415 /// ParseSubMultiClassReference - Parse a reference to a subclass or to a
416 /// templated submulticlass. This returns a SubMultiClassRefTy with a null
417 /// Record* on error.
419 /// SubMultiClassRef ::= MultiClassID
420 /// SubMultiClassRef ::= MultiClassID '<' ValueList '>'
422 SubMultiClassReference TGParser::
423 ParseSubMultiClassReference(MultiClass *CurMC) {
424 SubMultiClassReference Result;
425 Result.RefLoc = Lex.getLoc();
427 Result.MC = ParseMultiClassID();
428 if (Result.MC == 0) return Result;
430 // If there is no template arg list, we're done.
431 if (Lex.getCode() != tgtok::less)
433 Lex.Lex(); // Eat the '<'
435 if (Lex.getCode() == tgtok::greater) {
436 TokError("subclass reference requires a non-empty list of template values");
441 Result.TemplateArgs = ParseValueList(&CurMC->Rec);
442 if (Result.TemplateArgs.empty()) {
443 Result.MC = 0; // Error parsing value list.
447 if (Lex.getCode() != tgtok::greater) {
448 TokError("expected '>' in template value list");
457 /// ParseRangePiece - Parse a bit/value range.
458 /// RangePiece ::= INTVAL
459 /// RangePiece ::= INTVAL '-' INTVAL
460 /// RangePiece ::= INTVAL INTVAL
461 bool TGParser::ParseRangePiece(std::vector<unsigned> &Ranges) {
462 if (Lex.getCode() != tgtok::IntVal) {
463 TokError("expected integer or bitrange");
466 int64_t Start = Lex.getCurIntVal();
470 return TokError("invalid range, cannot be negative");
472 switch (Lex.Lex()) { // eat first character.
474 Ranges.push_back(Start);
477 if (Lex.Lex() != tgtok::IntVal) {
478 TokError("expected integer value as end of range");
481 End = Lex.getCurIntVal();
484 End = -Lex.getCurIntVal();
488 return TokError("invalid range, cannot be negative");
493 for (; Start <= End; ++Start)
494 Ranges.push_back(Start);
496 for (; Start >= End; --Start)
497 Ranges.push_back(Start);
502 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
504 /// RangeList ::= RangePiece (',' RangePiece)*
506 std::vector<unsigned> TGParser::ParseRangeList() {
507 std::vector<unsigned> Result;
509 // Parse the first piece.
510 if (ParseRangePiece(Result))
511 return std::vector<unsigned>();
512 while (Lex.getCode() == tgtok::comma) {
513 Lex.Lex(); // Eat the comma.
515 // Parse the next range piece.
516 if (ParseRangePiece(Result))
517 return std::vector<unsigned>();
522 /// ParseOptionalRangeList - Parse either a range list in <>'s or nothing.
523 /// OptionalRangeList ::= '<' RangeList '>'
524 /// OptionalRangeList ::= /*empty*/
525 bool TGParser::ParseOptionalRangeList(std::vector<unsigned> &Ranges) {
526 if (Lex.getCode() != tgtok::less)
529 TGLoc StartLoc = Lex.getLoc();
530 Lex.Lex(); // eat the '<'
532 // Parse the range list.
533 Ranges = ParseRangeList();
534 if (Ranges.empty()) return true;
536 if (Lex.getCode() != tgtok::greater) {
537 TokError("expected '>' at end of range list");
538 return Error(StartLoc, "to match this '<'");
540 Lex.Lex(); // eat the '>'.
544 /// ParseOptionalBitList - Parse either a bit list in {}'s or nothing.
545 /// OptionalBitList ::= '{' RangeList '}'
546 /// OptionalBitList ::= /*empty*/
547 bool TGParser::ParseOptionalBitList(std::vector<unsigned> &Ranges) {
548 if (Lex.getCode() != tgtok::l_brace)
551 TGLoc StartLoc = Lex.getLoc();
552 Lex.Lex(); // eat the '{'
554 // Parse the range list.
555 Ranges = ParseRangeList();
556 if (Ranges.empty()) return true;
558 if (Lex.getCode() != tgtok::r_brace) {
559 TokError("expected '}' at end of bit list");
560 return Error(StartLoc, "to match this '{'");
562 Lex.Lex(); // eat the '}'.
567 /// ParseType - Parse and return a tblgen type. This returns null on error.
569 /// Type ::= STRING // string type
570 /// Type ::= BIT // bit type
571 /// Type ::= BITS '<' INTVAL '>' // bits<x> type
572 /// Type ::= INT // int type
573 /// Type ::= LIST '<' Type '>' // list<x> type
574 /// Type ::= CODE // code type
575 /// Type ::= DAG // dag type
576 /// Type ::= ClassID // Record Type
578 RecTy *TGParser::ParseType() {
579 switch (Lex.getCode()) {
580 default: TokError("Unknown token when expecting a type"); return 0;
581 case tgtok::String: Lex.Lex(); return new StringRecTy();
582 case tgtok::Bit: Lex.Lex(); return new BitRecTy();
583 case tgtok::Int: Lex.Lex(); return new IntRecTy();
584 case tgtok::Code: Lex.Lex(); return new CodeRecTy();
585 case tgtok::Dag: Lex.Lex(); return new DagRecTy();
587 if (Record *R = ParseClassID()) return new RecordRecTy(R);
590 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
591 TokError("expected '<' after bits type");
594 if (Lex.Lex() != tgtok::IntVal) { // Eat '<'
595 TokError("expected integer in bits<n> type");
598 uint64_t Val = Lex.getCurIntVal();
599 if (Lex.Lex() != tgtok::greater) { // Eat count.
600 TokError("expected '>' at end of bits<n> type");
603 Lex.Lex(); // Eat '>'
604 return new BitsRecTy(Val);
607 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
608 TokError("expected '<' after list type");
611 Lex.Lex(); // Eat '<'
612 RecTy *SubType = ParseType();
613 if (SubType == 0) return 0;
615 if (Lex.getCode() != tgtok::greater) {
616 TokError("expected '>' at end of list<ty> type");
619 Lex.Lex(); // Eat '>'
620 return new ListRecTy(SubType);
625 /// ParseIDValue - Parse an ID as a value and decode what it means.
627 /// IDValue ::= ID [def local value]
628 /// IDValue ::= ID [def template arg]
629 /// IDValue ::= ID [multiclass local value]
630 /// IDValue ::= ID [multiclass template argument]
631 /// IDValue ::= ID [def name]
633 Init *TGParser::ParseIDValue(Record *CurRec) {
634 assert(Lex.getCode() == tgtok::Id && "Expected ID in ParseIDValue");
635 std::string Name = Lex.getCurStrVal();
636 TGLoc Loc = Lex.getLoc();
638 return ParseIDValue(CurRec, Name, Loc);
641 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
642 /// has already been read.
643 Init *TGParser::ParseIDValue(Record *CurRec,
644 const std::string &Name, TGLoc NameLoc) {
646 if (const RecordVal *RV = CurRec->getValue(Name))
647 return new VarInit(Name, RV->getType());
649 std::string TemplateArgName = CurRec->getName()+":"+Name;
650 if (CurRec->isTemplateArg(TemplateArgName)) {
651 const RecordVal *RV = CurRec->getValue(TemplateArgName);
652 assert(RV && "Template arg doesn't exist??");
653 return new VarInit(TemplateArgName, RV->getType());
658 std::string MCName = CurMultiClass->Rec.getName()+"::"+Name;
659 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
660 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
661 assert(RV && "Template arg doesn't exist??");
662 return new VarInit(MCName, RV->getType());
666 if (Record *D = Records.getDef(Name))
667 return new DefInit(D);
669 Error(NameLoc, "Variable not defined: '" + Name + "'");
673 /// ParseOperation - Parse an operator. This returns null on error.
675 /// Operation ::= XOperator ['<' Type '>'] '(' Args ')'
677 Init *TGParser::ParseOperation(Record *CurRec) {
678 switch (Lex.getCode()) {
680 TokError("unknown operation");
683 case tgtok::XCast: { // Value ::= !unop '(' Value ')'
684 UnOpInit::UnaryOp Code;
687 switch (Lex.getCode()) {
688 default: assert(0 && "Unhandled code!");
690 Lex.Lex(); // eat the operation
691 Code = UnOpInit::CAST;
693 Type = ParseOperatorType();
696 TokError("did not get type for binary operator");
702 if (Lex.getCode() != tgtok::l_paren) {
703 TokError("expected '(' after unary operator");
706 Lex.Lex(); // eat the '('
708 Init *LHS = ParseValue(CurRec);
709 if (LHS == 0) return 0;
711 if (Lex.getCode() != tgtok::r_paren) {
712 TokError("expected ')' in unary operator");
715 Lex.Lex(); // eat the ')'
716 return (new UnOpInit(Code, LHS, Type))->Fold(CurRec, CurMultiClass);
723 case tgtok::XStrConcat:
724 case tgtok::XNameConcat: { // Value ::= !binop '(' Value ',' Value ')'
725 BinOpInit::BinaryOp Code;
729 switch (Lex.getCode()) {
730 default: assert(0 && "Unhandled code!");
732 Lex.Lex(); // eat the operation
733 Code = BinOpInit::CONCAT;
734 Type = new DagRecTy();
737 Lex.Lex(); // eat the operation
738 Code = BinOpInit::SRA;
739 Type = new IntRecTy();
742 Lex.Lex(); // eat the operation
743 Code = BinOpInit::SRL;
744 Type = new IntRecTy();
747 Lex.Lex(); // eat the operation
748 Code = BinOpInit::SHL;
749 Type = new IntRecTy();
751 case tgtok::XStrConcat:
752 Lex.Lex(); // eat the operation
753 Code = BinOpInit::STRCONCAT;
754 Type = new StringRecTy();
756 case tgtok::XNameConcat:
757 Lex.Lex(); // eat the operation
758 Code = BinOpInit::NAMECONCAT;
760 Type = ParseOperatorType();
763 TokError("did not get type for binary operator");
769 if (Lex.getCode() != tgtok::l_paren) {
770 TokError("expected '(' after binary operator");
773 Lex.Lex(); // eat the '('
775 Init *LHS = ParseValue(CurRec);
776 if (LHS == 0) return 0;
778 if (Lex.getCode() != tgtok::comma) {
779 TokError("expected ',' in binary operator");
782 Lex.Lex(); // eat the ','
784 Init *RHS = ParseValue(CurRec);
785 if (RHS == 0) return 0;
787 if (Lex.getCode() != tgtok::r_paren) {
788 TokError("expected ')' in binary operator");
791 Lex.Lex(); // eat the ')'
792 return (new BinOpInit(Code, LHS, RHS, Type))->Fold(CurRec, CurMultiClass);
795 case tgtok::XForEach:
796 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
797 TernOpInit::TernaryOp Code;
801 tgtok::TokKind LexCode = Lex.getCode();
802 Lex.Lex(); // eat the operation
804 default: assert(0 && "Unhandled code!");
805 case tgtok::XForEach:
806 Code = TernOpInit::FOREACH;
809 Code = TernOpInit::SUBST;
812 if (Lex.getCode() != tgtok::l_paren) {
813 TokError("expected '(' after ternary operator");
816 Lex.Lex(); // eat the '('
818 Init *LHS = ParseValue(CurRec);
819 if (LHS == 0) return 0;
821 if (Lex.getCode() != tgtok::comma) {
822 TokError("expected ',' in ternary operator");
825 Lex.Lex(); // eat the ','
827 Init *MHS = ParseValue(CurRec);
828 if (MHS == 0) return 0;
830 if (Lex.getCode() != tgtok::comma) {
831 TokError("expected ',' in ternary operator");
834 Lex.Lex(); // eat the ','
836 Init *RHS = ParseValue(CurRec);
837 if (RHS == 0) return 0;
839 if (Lex.getCode() != tgtok::r_paren) {
840 TokError("expected ')' in binary operator");
843 Lex.Lex(); // eat the ')'
846 default: assert(0 && "Unhandled code!");
847 case tgtok::XForEach: {
848 TypedInit *MHSt = dynamic_cast<TypedInit *>(MHS);
850 TokError("could not get type for !foreach");
853 Type = MHSt->getType();
856 case tgtok::XSubst: {
857 TypedInit *RHSt = dynamic_cast<TypedInit *>(RHS);
859 TokError("could not get type for !subst");
862 Type = RHSt->getType();
866 return (new TernOpInit(Code, LHS, MHS, RHS, Type))->Fold(CurRec, CurMultiClass);
869 TokError("could not parse operation");
873 /// ParseOperatorType - Parse a type for an operator. This returns
876 /// OperatorType ::= '<' Type '>'
878 RecTy *TGParser::ParseOperatorType(void) {
881 if (Lex.getCode() != tgtok::less) {
882 TokError("expected type name for operator");
885 Lex.Lex(); // eat the <
890 TokError("expected type name for operator");
894 if (Lex.getCode() != tgtok::greater) {
895 TokError("expected type name for operator");
898 Lex.Lex(); // eat the >
904 /// ParseSimpleValue - Parse a tblgen value. This returns null on error.
906 /// SimpleValue ::= IDValue
907 /// SimpleValue ::= INTVAL
908 /// SimpleValue ::= STRVAL+
909 /// SimpleValue ::= CODEFRAGMENT
910 /// SimpleValue ::= '?'
911 /// SimpleValue ::= '{' ValueList '}'
912 /// SimpleValue ::= ID '<' ValueListNE '>'
913 /// SimpleValue ::= '[' ValueList ']'
914 /// SimpleValue ::= '(' IDValue DagArgList ')'
915 /// SimpleValue ::= CONCATTOK '(' Value ',' Value ')'
916 /// SimpleValue ::= SHLTOK '(' Value ',' Value ')'
917 /// SimpleValue ::= SRATOK '(' Value ',' Value ')'
918 /// SimpleValue ::= SRLTOK '(' Value ',' Value ')'
919 /// SimpleValue ::= STRCONCATTOK '(' Value ',' Value ')'
921 Init *TGParser::ParseSimpleValue(Record *CurRec) {
923 switch (Lex.getCode()) {
924 default: TokError("Unknown token when parsing a value"); break;
925 case tgtok::IntVal: R = new IntInit(Lex.getCurIntVal()); Lex.Lex(); break;
926 case tgtok::StrVal: {
927 std::string Val = Lex.getCurStrVal();
930 // Handle multiple consecutive concatenated strings.
931 while (Lex.getCode() == tgtok::StrVal) {
932 Val += Lex.getCurStrVal();
936 R = new StringInit(Val);
939 case tgtok::CodeFragment:
940 R = new CodeInit(Lex.getCurStrVal()); Lex.Lex(); break;
941 case tgtok::question: R = new UnsetInit(); Lex.Lex(); break;
943 TGLoc NameLoc = Lex.getLoc();
944 std::string Name = Lex.getCurStrVal();
945 if (Lex.Lex() != tgtok::less) // consume the Id.
946 return ParseIDValue(CurRec, Name, NameLoc); // Value ::= IDValue
948 // Value ::= ID '<' ValueListNE '>'
949 if (Lex.Lex() == tgtok::greater) {
950 TokError("expected non-empty value list");
953 std::vector<Init*> ValueList = ParseValueList(CurRec);
954 if (ValueList.empty()) return 0;
956 if (Lex.getCode() != tgtok::greater) {
957 TokError("expected '>' at end of value list");
960 Lex.Lex(); // eat the '>'
962 // This is a CLASS<initvalslist> expression. This is supposed to synthesize
963 // a new anonymous definition, deriving from CLASS<initvalslist> with no
965 Record *Class = Records.getClass(Name);
967 Error(NameLoc, "Expected a class name, got '" + Name + "'");
971 // Create the new record, set it as CurRec temporarily.
972 static unsigned AnonCounter = 0;
973 Record *NewRec = new Record("anonymous.val."+utostr(AnonCounter++),NameLoc);
974 SubClassReference SCRef;
975 SCRef.RefLoc = NameLoc;
977 SCRef.TemplateArgs = ValueList;
978 // Add info about the subclass to NewRec.
979 if (AddSubClass(NewRec, SCRef))
981 NewRec->resolveReferences();
982 Records.addDef(NewRec);
984 // The result of the expression is a reference to the new record.
985 return new DefInit(NewRec);
987 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
988 TGLoc BraceLoc = Lex.getLoc();
989 Lex.Lex(); // eat the '{'
990 std::vector<Init*> Vals;
992 if (Lex.getCode() != tgtok::r_brace) {
993 Vals = ParseValueList(CurRec);
994 if (Vals.empty()) return 0;
996 if (Lex.getCode() != tgtok::r_brace) {
997 TokError("expected '}' at end of bit list value");
1000 Lex.Lex(); // eat the '}'
1002 BitsInit *Result = new BitsInit(Vals.size());
1003 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1004 Init *Bit = Vals[i]->convertInitializerTo(new BitRecTy());
1006 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1007 ") is not convertable to a bit");
1010 Result->setBit(Vals.size()-i-1, Bit);
1014 case tgtok::l_square: { // Value ::= '[' ValueList ']'
1015 Lex.Lex(); // eat the '['
1016 std::vector<Init*> Vals;
1018 if (Lex.getCode() != tgtok::r_square) {
1019 Vals = ParseValueList(CurRec);
1020 if (Vals.empty()) return 0;
1022 if (Lex.getCode() != tgtok::r_square) {
1023 TokError("expected ']' at end of list value");
1026 Lex.Lex(); // eat the ']'
1027 return new ListInit(Vals);
1029 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
1030 Lex.Lex(); // eat the '('
1031 if (Lex.getCode() != tgtok::Id
1032 && Lex.getCode() != tgtok::XCast
1033 && Lex.getCode() != tgtok::XNameConcat) {
1034 TokError("expected identifier in dag init");
1039 if (Lex.getCode() == tgtok::Id) {
1040 Operator = ParseIDValue(CurRec);
1041 if (Operator == 0) return 0;
1044 Operator = ParseOperation(CurRec);
1045 if (Operator == 0) return 0;
1048 // If the operator name is present, parse it.
1049 std::string OperatorName;
1050 if (Lex.getCode() == tgtok::colon) {
1051 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1052 TokError("expected variable name in dag operator");
1055 OperatorName = Lex.getCurStrVal();
1056 Lex.Lex(); // eat the VarName.
1059 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1060 if (Lex.getCode() != tgtok::r_paren) {
1061 DagArgs = ParseDagArgList(CurRec);
1062 if (DagArgs.empty()) return 0;
1065 if (Lex.getCode() != tgtok::r_paren) {
1066 TokError("expected ')' in dag init");
1069 Lex.Lex(); // eat the ')'
1071 return new DagInit(Operator, OperatorName, DagArgs);
1075 case tgtok::XCast: // Value ::= !unop '(' Value ')'
1076 case tgtok::XConcat:
1080 case tgtok::XStrConcat:
1081 case tgtok::XNameConcat: // Value ::= !binop '(' Value ',' Value ')'
1082 case tgtok::XForEach:
1083 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1084 return ParseOperation(CurRec);
1092 /// ParseValue - Parse a tblgen value. This returns null on error.
1094 /// Value ::= SimpleValue ValueSuffix*
1095 /// ValueSuffix ::= '{' BitList '}'
1096 /// ValueSuffix ::= '[' BitList ']'
1097 /// ValueSuffix ::= '.' ID
1099 Init *TGParser::ParseValue(Record *CurRec) {
1100 Init *Result = ParseSimpleValue(CurRec);
1101 if (Result == 0) return 0;
1103 // Parse the suffixes now if present.
1105 switch (Lex.getCode()) {
1106 default: return Result;
1107 case tgtok::l_brace: {
1108 TGLoc CurlyLoc = Lex.getLoc();
1109 Lex.Lex(); // eat the '{'
1110 std::vector<unsigned> Ranges = ParseRangeList();
1111 if (Ranges.empty()) return 0;
1113 // Reverse the bitlist.
1114 std::reverse(Ranges.begin(), Ranges.end());
1115 Result = Result->convertInitializerBitRange(Ranges);
1117 Error(CurlyLoc, "Invalid bit range for value");
1122 if (Lex.getCode() != tgtok::r_brace) {
1123 TokError("expected '}' at end of bit range list");
1129 case tgtok::l_square: {
1130 TGLoc SquareLoc = Lex.getLoc();
1131 Lex.Lex(); // eat the '['
1132 std::vector<unsigned> Ranges = ParseRangeList();
1133 if (Ranges.empty()) return 0;
1135 Result = Result->convertInitListSlice(Ranges);
1137 Error(SquareLoc, "Invalid range for list slice");
1142 if (Lex.getCode() != tgtok::r_square) {
1143 TokError("expected ']' at end of list slice");
1150 if (Lex.Lex() != tgtok::Id) { // eat the .
1151 TokError("expected field identifier after '.'");
1154 if (!Result->getFieldType(Lex.getCurStrVal())) {
1155 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1156 Result->getAsString() + "'");
1159 Result = new FieldInit(Result, Lex.getCurStrVal());
1160 Lex.Lex(); // eat field name
1166 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1168 /// ParseDagArgList ::= Value (':' VARNAME)?
1169 /// ParseDagArgList ::= ParseDagArgList ',' Value (':' VARNAME)?
1170 std::vector<std::pair<llvm::Init*, std::string> >
1171 TGParser::ParseDagArgList(Record *CurRec) {
1172 std::vector<std::pair<llvm::Init*, std::string> > Result;
1175 Init *Val = ParseValue(CurRec);
1176 if (Val == 0) return std::vector<std::pair<llvm::Init*, std::string> >();
1178 // If the variable name is present, add it.
1179 std::string VarName;
1180 if (Lex.getCode() == tgtok::colon) {
1181 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1182 TokError("expected variable name in dag literal");
1183 return std::vector<std::pair<llvm::Init*, std::string> >();
1185 VarName = Lex.getCurStrVal();
1186 Lex.Lex(); // eat the VarName.
1189 Result.push_back(std::make_pair(Val, VarName));
1191 if (Lex.getCode() != tgtok::comma) break;
1192 Lex.Lex(); // eat the ','
1199 /// ParseValueList - Parse a comma separated list of values, returning them as a
1200 /// vector. Note that this always expects to be able to parse at least one
1201 /// value. It returns an empty list if this is not possible.
1203 /// ValueList ::= Value (',' Value)
1205 std::vector<Init*> TGParser::ParseValueList(Record *CurRec) {
1206 std::vector<Init*> Result;
1207 Result.push_back(ParseValue(CurRec));
1208 if (Result.back() == 0) return std::vector<Init*>();
1210 while (Lex.getCode() == tgtok::comma) {
1211 Lex.Lex(); // Eat the comma
1213 Result.push_back(ParseValue(CurRec));
1214 if (Result.back() == 0) return std::vector<Init*>();
1222 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1223 /// empty string on error. This can happen in a number of different context's,
1224 /// including within a def or in the template args for a def (which which case
1225 /// CurRec will be non-null) and within the template args for a multiclass (in
1226 /// which case CurRec will be null, but CurMultiClass will be set). This can
1227 /// also happen within a def that is within a multiclass, which will set both
1228 /// CurRec and CurMultiClass.
1230 /// Declaration ::= FIELD? Type ID ('=' Value)?
1232 std::string TGParser::ParseDeclaration(Record *CurRec,
1233 bool ParsingTemplateArgs) {
1234 // Read the field prefix if present.
1235 bool HasField = Lex.getCode() == tgtok::Field;
1236 if (HasField) Lex.Lex();
1238 RecTy *Type = ParseType();
1239 if (Type == 0) return "";
1241 if (Lex.getCode() != tgtok::Id) {
1242 TokError("Expected identifier in declaration");
1246 TGLoc IdLoc = Lex.getLoc();
1247 std::string DeclName = Lex.getCurStrVal();
1250 if (ParsingTemplateArgs) {
1252 DeclName = CurRec->getName() + ":" + DeclName;
1254 assert(CurMultiClass);
1257 DeclName = CurMultiClass->Rec.getName() + "::" + DeclName;
1261 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1264 // If a value is present, parse it.
1265 if (Lex.getCode() == tgtok::equal) {
1267 TGLoc ValLoc = Lex.getLoc();
1268 Init *Val = ParseValue(CurRec);
1270 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1277 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1278 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
1279 /// template args for a def, which may or may not be in a multiclass. If null,
1280 /// these are the template args for a multiclass.
1282 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1284 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1285 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1286 Lex.Lex(); // eat the '<'
1288 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1290 // Read the first declaration.
1291 std::string TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1292 if (TemplArg.empty())
1295 TheRecToAddTo->addTemplateArg(TemplArg);
1297 while (Lex.getCode() == tgtok::comma) {
1298 Lex.Lex(); // eat the ','
1300 // Read the following declarations.
1301 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1302 if (TemplArg.empty())
1304 TheRecToAddTo->addTemplateArg(TemplArg);
1307 if (Lex.getCode() != tgtok::greater)
1308 return TokError("expected '>' at end of template argument list");
1309 Lex.Lex(); // eat the '>'.
1314 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1316 /// BodyItem ::= Declaration ';'
1317 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
1318 bool TGParser::ParseBodyItem(Record *CurRec) {
1319 if (Lex.getCode() != tgtok::Let) {
1320 if (ParseDeclaration(CurRec, false).empty())
1323 if (Lex.getCode() != tgtok::semi)
1324 return TokError("expected ';' after declaration");
1329 // LET ID OptionalRangeList '=' Value ';'
1330 if (Lex.Lex() != tgtok::Id)
1331 return TokError("expected field identifier after let");
1333 TGLoc IdLoc = Lex.getLoc();
1334 std::string FieldName = Lex.getCurStrVal();
1335 Lex.Lex(); // eat the field name.
1337 std::vector<unsigned> BitList;
1338 if (ParseOptionalBitList(BitList))
1340 std::reverse(BitList.begin(), BitList.end());
1342 if (Lex.getCode() != tgtok::equal)
1343 return TokError("expected '=' in let expression");
1344 Lex.Lex(); // eat the '='.
1346 Init *Val = ParseValue(CurRec);
1347 if (Val == 0) return true;
1349 if (Lex.getCode() != tgtok::semi)
1350 return TokError("expected ';' after let expression");
1353 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1356 /// ParseBody - Read the body of a class or def. Return true on error, false on
1360 /// Body ::= '{' BodyList '}'
1361 /// BodyList BodyItem*
1363 bool TGParser::ParseBody(Record *CurRec) {
1364 // If this is a null definition, just eat the semi and return.
1365 if (Lex.getCode() == tgtok::semi) {
1370 if (Lex.getCode() != tgtok::l_brace)
1371 return TokError("Expected ';' or '{' to start body");
1375 while (Lex.getCode() != tgtok::r_brace)
1376 if (ParseBodyItem(CurRec))
1384 /// ParseObjectBody - Parse the body of a def or class. This consists of an
1385 /// optional ClassList followed by a Body. CurRec is the current def or class
1386 /// that is being parsed.
1388 /// ObjectBody ::= BaseClassList Body
1389 /// BaseClassList ::= /*empty*/
1390 /// BaseClassList ::= ':' BaseClassListNE
1391 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1393 bool TGParser::ParseObjectBody(Record *CurRec) {
1394 // If there is a baseclass list, read it.
1395 if (Lex.getCode() == tgtok::colon) {
1398 // Read all of the subclasses.
1399 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1402 if (SubClass.Rec == 0) return true;
1405 if (AddSubClass(CurRec, SubClass))
1408 if (Lex.getCode() != tgtok::comma) break;
1409 Lex.Lex(); // eat ','.
1410 SubClass = ParseSubClassReference(CurRec, false);
1414 // Process any variables on the let stack.
1415 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1416 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1417 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1418 LetStack[i][j].Bits, LetStack[i][j].Value))
1421 return ParseBody(CurRec);
1425 /// ParseDef - Parse and return a top level or multiclass def, return the record
1426 /// corresponding to it. This returns null on error.
1428 /// DefInst ::= DEF ObjectName ObjectBody
1430 llvm::Record *TGParser::ParseDef(MultiClass *CurMultiClass) {
1431 TGLoc DefLoc = Lex.getLoc();
1432 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1433 Lex.Lex(); // Eat the 'def' token.
1435 // Parse ObjectName and make a record for it.
1436 Record *CurRec = new Record(ParseObjectName(), DefLoc);
1438 if (!CurMultiClass) {
1439 // Top-level def definition.
1441 // Ensure redefinition doesn't happen.
1442 if (Records.getDef(CurRec->getName())) {
1443 Error(DefLoc, "def '" + CurRec->getName() + "' already defined");
1446 Records.addDef(CurRec);
1448 // Otherwise, a def inside a multiclass, add it to the multiclass.
1449 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1450 if (CurMultiClass->DefPrototypes[i]->getName() == CurRec->getName()) {
1451 Error(DefLoc, "def '" + CurRec->getName() +
1452 "' already defined in this multiclass!");
1455 CurMultiClass->DefPrototypes.push_back(CurRec);
1458 if (ParseObjectBody(CurRec))
1461 if (CurMultiClass == 0) // Def's in multiclasses aren't really defs.
1462 CurRec->resolveReferences();
1464 // If ObjectBody has template arguments, it's an error.
1465 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1470 /// ParseClass - Parse a tblgen class definition.
1472 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
1474 bool TGParser::ParseClass() {
1475 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
1478 if (Lex.getCode() != tgtok::Id)
1479 return TokError("expected class name after 'class' keyword");
1481 Record *CurRec = Records.getClass(Lex.getCurStrVal());
1483 // If the body was previously defined, this is an error.
1484 if (!CurRec->getValues().empty() ||
1485 !CurRec->getSuperClasses().empty() ||
1486 !CurRec->getTemplateArgs().empty())
1487 return TokError("Class '" + CurRec->getName() + "' already defined");
1489 // If this is the first reference to this class, create and add it.
1490 CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc());
1491 Records.addClass(CurRec);
1493 Lex.Lex(); // eat the name.
1495 // If there are template args, parse them.
1496 if (Lex.getCode() == tgtok::less)
1497 if (ParseTemplateArgList(CurRec))
1500 // Finally, parse the object body.
1501 return ParseObjectBody(CurRec);
1504 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
1507 /// LetList ::= LetItem (',' LetItem)*
1508 /// LetItem ::= ID OptionalRangeList '=' Value
1510 std::vector<LetRecord> TGParser::ParseLetList() {
1511 std::vector<LetRecord> Result;
1514 if (Lex.getCode() != tgtok::Id) {
1515 TokError("expected identifier in let definition");
1516 return std::vector<LetRecord>();
1518 std::string Name = Lex.getCurStrVal();
1519 TGLoc NameLoc = Lex.getLoc();
1520 Lex.Lex(); // Eat the identifier.
1522 // Check for an optional RangeList.
1523 std::vector<unsigned> Bits;
1524 if (ParseOptionalRangeList(Bits))
1525 return std::vector<LetRecord>();
1526 std::reverse(Bits.begin(), Bits.end());
1528 if (Lex.getCode() != tgtok::equal) {
1529 TokError("expected '=' in let expression");
1530 return std::vector<LetRecord>();
1532 Lex.Lex(); // eat the '='.
1534 Init *Val = ParseValue(0);
1535 if (Val == 0) return std::vector<LetRecord>();
1537 // Now that we have everything, add the record.
1538 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
1540 if (Lex.getCode() != tgtok::comma)
1542 Lex.Lex(); // eat the comma.
1546 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
1547 /// different related productions.
1549 /// Object ::= LET LetList IN '{' ObjectList '}'
1550 /// Object ::= LET LetList IN Object
1552 bool TGParser::ParseTopLevelLet() {
1553 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
1556 // Add this entry to the let stack.
1557 std::vector<LetRecord> LetInfo = ParseLetList();
1558 if (LetInfo.empty()) return true;
1559 LetStack.push_back(LetInfo);
1561 if (Lex.getCode() != tgtok::In)
1562 return TokError("expected 'in' at end of top-level 'let'");
1565 // If this is a scalar let, just handle it now
1566 if (Lex.getCode() != tgtok::l_brace) {
1567 // LET LetList IN Object
1570 } else { // Object ::= LETCommand '{' ObjectList '}'
1571 TGLoc BraceLoc = Lex.getLoc();
1572 // Otherwise, this is a group let.
1573 Lex.Lex(); // eat the '{'.
1575 // Parse the object list.
1576 if (ParseObjectList())
1579 if (Lex.getCode() != tgtok::r_brace) {
1580 TokError("expected '}' at end of top level let command");
1581 return Error(BraceLoc, "to match this '{'");
1586 // Outside this let scope, this let block is not active.
1587 LetStack.pop_back();
1591 /// ParseMultiClassDef - Parse a def in a multiclass context.
1593 /// MultiClassDef ::= DefInst
1595 bool TGParser::ParseMultiClassDef(MultiClass *CurMC) {
1596 if (Lex.getCode() != tgtok::Def)
1597 return TokError("expected 'def' in multiclass body");
1599 Record *D = ParseDef(CurMC);
1600 if (D == 0) return true;
1602 // Copy the template arguments for the multiclass into the def.
1603 const std::vector<std::string> &TArgs = CurMC->Rec.getTemplateArgs();
1605 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1606 const RecordVal *RV = CurMC->Rec.getValue(TArgs[i]);
1607 assert(RV && "Template arg doesn't exist?");
1614 /// ParseMultiClass - Parse a multiclass definition.
1616 /// MultiClassInst ::= MULTICLASS ID TemplateArgList?
1617 /// ':' BaseMultiClassList '{' MultiClassDef+ '}'
1619 bool TGParser::ParseMultiClass() {
1620 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
1621 Lex.Lex(); // Eat the multiclass token.
1623 if (Lex.getCode() != tgtok::Id)
1624 return TokError("expected identifier after multiclass for name");
1625 std::string Name = Lex.getCurStrVal();
1627 if (MultiClasses.count(Name))
1628 return TokError("multiclass '" + Name + "' already defined");
1630 CurMultiClass = MultiClasses[Name] = new MultiClass(Name, Lex.getLoc());
1631 Lex.Lex(); // Eat the identifier.
1633 // If there are template args, parse them.
1634 if (Lex.getCode() == tgtok::less)
1635 if (ParseTemplateArgList(0))
1638 bool inherits = false;
1640 // If there are submulticlasses, parse them.
1641 if (Lex.getCode() == tgtok::colon) {
1646 // Read all of the submulticlasses.
1647 SubMultiClassReference SubMultiClass =
1648 ParseSubMultiClassReference(CurMultiClass);
1651 if (SubMultiClass.MC == 0) return true;
1654 if (AddSubMultiClass(CurMultiClass, SubMultiClass))
1657 if (Lex.getCode() != tgtok::comma) break;
1658 Lex.Lex(); // eat ','.
1659 SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
1663 if (Lex.getCode() != tgtok::l_brace) {
1665 return TokError("expected '{' in multiclass definition");
1667 if (Lex.getCode() != tgtok::semi)
1668 return TokError("expected ';' in multiclass definition");
1670 Lex.Lex(); // eat the ';'.
1673 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
1674 return TokError("multiclass must contain at least one def");
1676 while (Lex.getCode() != tgtok::r_brace)
1677 if (ParseMultiClassDef(CurMultiClass))
1680 Lex.Lex(); // eat the '}'.
1687 /// ParseDefm - Parse the instantiation of a multiclass.
1689 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
1691 bool TGParser::ParseDefm() {
1692 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
1693 if (Lex.Lex() != tgtok::Id) // eat the defm.
1694 return TokError("expected identifier after defm");
1696 TGLoc DefmPrefixLoc = Lex.getLoc();
1697 std::string DefmPrefix = Lex.getCurStrVal();
1698 if (Lex.Lex() != tgtok::colon)
1699 return TokError("expected ':' after defm identifier");
1704 TGLoc SubClassLoc = Lex.getLoc();
1705 SubClassReference Ref = ParseSubClassReference(0, true);
1708 if (Ref.Rec == 0) return true;
1710 // To instantiate a multiclass, we need to first get the multiclass, then
1711 // instantiate each def contained in the multiclass with the SubClassRef
1712 // template parameters.
1713 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
1714 assert(MC && "Didn't lookup multiclass correctly?");
1715 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
1717 // Verify that the correct number of template arguments were specified.
1718 const std::vector<std::string> &TArgs = MC->Rec.getTemplateArgs();
1719 if (TArgs.size() < TemplateVals.size())
1720 return Error(SubClassLoc,
1721 "more template args specified than multiclass expects");
1723 // Loop over all the def's in the multiclass, instantiating each one.
1724 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
1725 Record *DefProto = MC->DefPrototypes[i];
1727 // Add in the defm name
1728 std::string DefName = DefProto->getName();
1729 std::string::size_type idx = DefName.find("#NAME#");
1730 if (idx != std::string::npos) {
1731 DefName.replace(idx, 6, DefmPrefix);
1734 // Add the suffix to the defm name to get the new name.
1735 DefName = DefmPrefix + DefName;
1738 Record *CurRec = new Record(DefName, DefmPrefixLoc);
1740 SubClassReference Ref;
1741 Ref.RefLoc = DefmPrefixLoc;
1743 AddSubClass(CurRec, Ref);
1745 // Loop over all of the template arguments, setting them to the specified
1746 // value or leaving them as the default if necessary.
1747 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1748 // Check if a value is specified for this temp-arg.
1749 if (i < TemplateVals.size()) {
1751 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
1756 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
1759 CurRec->removeValue(TArgs[i]);
1761 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
1762 return Error(SubClassLoc,
1763 "value not specified for template argument #"+
1764 utostr(i) + " (" + TArgs[i] + ") of multiclassclass '" +
1765 MC->Rec.getName() + "'");
1769 // If the mdef is inside a 'let' expression, add to each def.
1770 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1771 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1772 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1773 LetStack[i][j].Bits, LetStack[i][j].Value)) {
1774 Error(DefmPrefixLoc, "when instantiating this defm");
1778 // Ensure redefinition doesn't happen.
1779 if (Records.getDef(CurRec->getName()))
1780 return Error(DefmPrefixLoc, "def '" + CurRec->getName() +
1781 "' already defined, instantiating defm with subdef '" +
1782 DefProto->getName() + "'");
1783 Records.addDef(CurRec);
1784 CurRec->resolveReferences();
1787 if (Lex.getCode() != tgtok::comma) break;
1788 Lex.Lex(); // eat ','.
1790 SubClassLoc = Lex.getLoc();
1791 Ref = ParseSubClassReference(0, true);
1794 if (Lex.getCode() != tgtok::semi)
1795 return TokError("expected ';' at end of defm");
1802 /// Object ::= ClassInst
1803 /// Object ::= DefInst
1804 /// Object ::= MultiClassInst
1805 /// Object ::= DefMInst
1806 /// Object ::= LETCommand '{' ObjectList '}'
1807 /// Object ::= LETCommand Object
1808 bool TGParser::ParseObject() {
1809 switch (Lex.getCode()) {
1810 default: assert(0 && "This is not an object");
1811 case tgtok::Let: return ParseTopLevelLet();
1812 case tgtok::Def: return ParseDef(0) == 0;
1813 case tgtok::Defm: return ParseDefm();
1814 case tgtok::Class: return ParseClass();
1815 case tgtok::MultiClass: return ParseMultiClass();
1820 /// ObjectList :== Object*
1821 bool TGParser::ParseObjectList() {
1822 while (isObjectStart(Lex.getCode())) {
1830 bool TGParser::ParseFile() {
1831 Lex.Lex(); // Prime the lexer.
1832 if (ParseObjectList()) return true;
1834 // If we have unread input at the end of the file, report it.
1835 if (Lex.getCode() == tgtok::Eof)
1838 return TokError("Unexpected input at top level");