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 //===----------------------------------------------------------------------===//
16 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/Support/CommandLine.h"
23 //===----------------------------------------------------------------------===//
24 // Support Code for the Semantic Actions.
25 //===----------------------------------------------------------------------===//
28 struct SubClassReference {
31 std::vector<Init*> TemplateArgs;
32 SubClassReference() : Rec(0) {}
34 bool isInvalid() const { return Rec == 0; }
37 struct SubMultiClassReference {
40 std::vector<Init*> TemplateArgs;
41 SubMultiClassReference() : MC(0) {}
43 bool isInvalid() const { return MC == 0; }
47 void SubMultiClassReference::dump() const {
48 errs() << "Multiclass:\n";
52 errs() << "Template args:\n";
53 for (std::vector<Init *>::const_iterator i = TemplateArgs.begin(),
54 iend = TemplateArgs.end();
61 } // end namespace llvm
63 bool TGParser::AddValue(Record *CurRec, SMLoc Loc, const RecordVal &RV) {
65 CurRec = &CurMultiClass->Rec;
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() + "'");
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, Init *V) {
86 if (CurRec == 0) CurRec = &CurMultiClass->Rec;
88 RecordVal *RV = CurRec->getValue(ValName);
90 return Error(Loc, "Value '" + ValName + "' unknown!");
92 // Do not allow assignments like 'X = X'. This will just cause infinite loops
93 // in the resolution machinery.
95 if (VarInit *VI = dynamic_cast<VarInit*>(V))
96 if (VI->getName() == ValName)
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
103 if (!BitList.empty()) {
104 BitsInit *CurVal = dynamic_cast<BitsInit*>(RV->getValue());
106 return Error(Loc, "Value '" + ValName + "' is not a bits type");
108 // Convert the incoming value to a bits type of the appropriate size...
109 Init *BI = V->convertInitializerTo(new BitsRecTy(BitList.size()));
111 V->convertInitializerTo(new BitsRecTy(BitList.size()));
112 return Error(Loc, "Initializer is not compatible with bit range");
115 // We should have a BitsInit type now.
116 BitsInit *BInit = dynamic_cast<BitsInit*>(BI);
119 BitsInit *NewVal = new BitsInit(CurVal->getNumBits());
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 (NewVal->getBit(Bit))
125 return Error(Loc, "Cannot set bit #" + utostr(Bit) + " of value '" +
126 ValName + "' more than once");
127 NewVal->setBit(Bit, BInit->getBit(i));
130 for (unsigned i = 0, e = CurVal->getNumBits(); i != e; ++i)
131 if (NewVal->getBit(i) == 0)
132 NewVal->setBit(i, CurVal->getBit(i));
138 return Error(Loc, "Value '" + ValName + "' of type '" +
139 RV->getType()->getAsString() +
140 "' is incompatible with initializer '" + V->getAsString() +"'");
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]))
154 const std::vector<std::string> &TArgs = SC->getTemplateArgs();
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");
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]))
170 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
173 CurRec->removeValue(TArgs[i]);
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() + "'!");
182 // Since everything went well, we can now set the "superclass" list for the
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]);
192 if (CurRec->isSubClassOf(SC))
193 return Error(SubClass.RefLoc,
194 "Already subclass of '" + SC->getName() + "'!\n");
195 CurRec->addSuperClass(SC);
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;
207 const std::vector<RecordVal> &MCVals = CurRec->getValues();
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]))
215 int newDefStart = CurMC->DefPrototypes.size();
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();
222 // Clone the def and add it to the current multiclass
223 Record *NewDef = new Record(**i);
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]))
230 CurMC->DefPrototypes.push_back(NewDef);
233 const std::vector<std::string> &SMCTArgs = SMC->Rec.getTemplateArgs();
235 // Ensure that an appropriate number of template arguments are
237 if (SMCTArgs.size() < SubMultiClass.TemplateArgs.size())
238 return Error(SubMultiClass.RefLoc,
239 "More template args specified than expected");
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
247 if (SetValue(CurRec, SubMultiClass.RefLoc, SMCTArgs[i],
248 std::vector<unsigned>(),
249 SubMultiClass.TemplateArgs[i]))
253 CurRec->resolveReferencesTo(CurRec->getValue(SMCTArgs[i]));
256 CurRec->removeValue(SMCTArgs[i]);
258 // If a value is specified for this template arg, set it in the
260 for (MultiClass::RecordVector::iterator j =
261 CurMC->DefPrototypes.begin() + newDefStart,
262 jend = CurMC->DefPrototypes.end();
267 if (SetValue(Def, SubMultiClass.RefLoc, SMCTArgs[i],
268 std::vector<unsigned>(),
269 SubMultiClass.TemplateArgs[i]))
273 Def->resolveReferencesTo(Def->getValue(SMCTArgs[i]));
276 Def->removeValue(SMCTArgs[i]);
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() + "'!");
289 //===----------------------------------------------------------------------===//
291 //===----------------------------------------------------------------------===//
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;
299 static std::string GetNewAnonymousName() {
300 static unsigned AnonCounter = 0;
301 return "anonymous."+utostr(AnonCounter++);
304 /// ParseObjectName - If an object name is specified, return it. Otherwise,
305 /// return an anonymous name.
306 /// ObjectName ::= ID
307 /// ObjectName ::= /*empty*/
309 std::string TGParser::ParseObjectName() {
310 if (Lex.getCode() != tgtok::Id)
311 return GetNewAnonymousName();
313 std::string Ret = Lex.getCurStrVal();
319 /// ParseClassID - Parse and resolve a reference to a class name. This returns
324 Record *TGParser::ParseClassID() {
325 if (Lex.getCode() != tgtok::Id) {
326 TokError("expected name for ClassID");
330 Record *Result = Records.getClass(Lex.getCurStrVal());
332 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
338 /// ParseMultiClassID - Parse and resolve a reference to a multiclass name.
339 /// This returns null on error.
341 /// MultiClassID ::= ID
343 MultiClass *TGParser::ParseMultiClassID() {
344 if (Lex.getCode() != tgtok::Id) {
345 TokError("expected name for ClassID");
349 MultiClass *Result = MultiClasses[Lex.getCurStrVal()];
351 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
357 Record *TGParser::ParseDefmID() {
358 if (Lex.getCode() != tgtok::Id) {
359 TokError("expected multiclass name");
363 MultiClass *MC = MultiClasses[Lex.getCurStrVal()];
365 TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
374 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
375 /// subclass. This returns a SubClassRefTy with a null Record* on error.
377 /// SubClassRef ::= ClassID
378 /// SubClassRef ::= ClassID '<' ValueList '>'
380 SubClassReference TGParser::
381 ParseSubClassReference(Record *CurRec, bool isDefm) {
382 SubClassReference Result;
383 Result.RefLoc = Lex.getLoc();
386 Result.Rec = ParseDefmID();
388 Result.Rec = ParseClassID();
389 if (Result.Rec == 0) return Result;
391 // If there is no template arg list, we're done.
392 if (Lex.getCode() != tgtok::less)
394 Lex.Lex(); // Eat the '<'
396 if (Lex.getCode() == tgtok::greater) {
397 TokError("subclass reference requires a non-empty list of template values");
402 Result.TemplateArgs = ParseValueList(CurRec, Result.Rec);
403 if (Result.TemplateArgs.empty()) {
404 Result.Rec = 0; // Error parsing value list.
408 if (Lex.getCode() != tgtok::greater) {
409 TokError("expected '>' in template value list");
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.
422 /// SubMultiClassRef ::= MultiClassID
423 /// SubMultiClassRef ::= MultiClassID '<' ValueList '>'
425 SubMultiClassReference TGParser::
426 ParseSubMultiClassReference(MultiClass *CurMC) {
427 SubMultiClassReference Result;
428 Result.RefLoc = Lex.getLoc();
430 Result.MC = ParseMultiClassID();
431 if (Result.MC == 0) return Result;
433 // If there is no template arg list, we're done.
434 if (Lex.getCode() != tgtok::less)
436 Lex.Lex(); // Eat the '<'
438 if (Lex.getCode() == tgtok::greater) {
439 TokError("subclass reference requires a non-empty list of template values");
444 Result.TemplateArgs = ParseValueList(&CurMC->Rec, &Result.MC->Rec);
445 if (Result.TemplateArgs.empty()) {
446 Result.MC = 0; // Error parsing value list.
450 if (Lex.getCode() != tgtok::greater) {
451 TokError("expected '>' in template value list");
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");
469 int64_t Start = Lex.getCurIntVal();
473 return TokError("invalid range, cannot be negative");
475 switch (Lex.Lex()) { // eat first character.
477 Ranges.push_back(Start);
480 if (Lex.Lex() != tgtok::IntVal) {
481 TokError("expected integer value as end of range");
484 End = Lex.getCurIntVal();
487 End = -Lex.getCurIntVal();
491 return TokError("invalid range, cannot be negative");
496 for (; Start <= End; ++Start)
497 Ranges.push_back(Start);
499 for (; Start >= End; --Start)
500 Ranges.push_back(Start);
505 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
507 /// RangeList ::= RangePiece (',' RangePiece)*
509 std::vector<unsigned> TGParser::ParseRangeList() {
510 std::vector<unsigned> Result;
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.
518 // Parse the next range piece.
519 if (ParseRangePiece(Result))
520 return std::vector<unsigned>();
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)
532 SMLoc StartLoc = Lex.getLoc();
533 Lex.Lex(); // eat the '<'
535 // Parse the range list.
536 Ranges = ParseRangeList();
537 if (Ranges.empty()) return true;
539 if (Lex.getCode() != tgtok::greater) {
540 TokError("expected '>' at end of range list");
541 return Error(StartLoc, "to match this '<'");
543 Lex.Lex(); // eat the '>'.
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)
554 SMLoc StartLoc = Lex.getLoc();
555 Lex.Lex(); // eat the '{'
557 // Parse the range list.
558 Ranges = ParseRangeList();
559 if (Ranges.empty()) return true;
561 if (Lex.getCode() != tgtok::r_brace) {
562 TokError("expected '}' at end of bit list");
563 return Error(StartLoc, "to match this '{'");
565 Lex.Lex(); // eat the '}'.
570 /// ParseType - Parse and return a tblgen type. This returns null on error.
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
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 new StringRecTy();
585 case tgtok::Bit: Lex.Lex(); return new BitRecTy();
586 case tgtok::Int: Lex.Lex(); return new IntRecTy();
587 case tgtok::Code: Lex.Lex(); return new CodeRecTy();
588 case tgtok::Dag: Lex.Lex(); return new DagRecTy();
590 if (Record *R = ParseClassID()) return new RecordRecTy(R);
593 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
594 TokError("expected '<' after bits type");
597 if (Lex.Lex() != tgtok::IntVal) { // Eat '<'
598 TokError("expected integer in bits<n> type");
601 uint64_t Val = Lex.getCurIntVal();
602 if (Lex.Lex() != tgtok::greater) { // Eat count.
603 TokError("expected '>' at end of bits<n> type");
606 Lex.Lex(); // Eat '>'
607 return new BitsRecTy(Val);
610 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
611 TokError("expected '<' after list type");
614 Lex.Lex(); // Eat '<'
615 RecTy *SubType = ParseType();
616 if (SubType == 0) return 0;
618 if (Lex.getCode() != tgtok::greater) {
619 TokError("expected '>' at end of list<ty> type");
622 Lex.Lex(); // Eat '>'
623 return new ListRecTy(SubType);
628 /// ParseIDValue - Parse an ID as a value and decode what it means.
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]
636 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();
641 return ParseIDValue(CurRec, Name, Loc);
644 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
645 /// has already been read.
646 Init *TGParser::ParseIDValue(Record *CurRec,
647 const std::string &Name, SMLoc NameLoc) {
649 if (const RecordVal *RV = CurRec->getValue(Name))
650 return new VarInit(Name, RV->getType());
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());
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());
669 if (Record *D = Records.getDef(Name))
670 return new DefInit(D);
672 Error(NameLoc, "Variable not defined: '" + Name + "'");
676 /// ParseOperation - Parse an operator. This returns null on error.
678 /// Operation ::= XOperator ['<' Type '>'] '(' Args ')'
680 Init *TGParser::ParseOperation(Record *CurRec) {
681 switch (Lex.getCode()) {
683 TokError("unknown operation");
689 case tgtok::XCast: { // Value ::= !unop '(' Value ')'
690 UnOpInit::UnaryOp Code;
693 switch (Lex.getCode()) {
694 default: assert(0 && "Unhandled code!");
696 Lex.Lex(); // eat the operation
697 Code = UnOpInit::CAST;
699 Type = ParseOperatorType();
702 TokError("did not get type for unary operator");
708 Lex.Lex(); // eat the operation
709 Code = UnOpInit::CAR;
712 Lex.Lex(); // eat the operation
713 Code = UnOpInit::CDR;
716 Lex.Lex(); // eat the operation
717 Code = UnOpInit::LNULL;
721 if (Lex.getCode() != tgtok::l_paren) {
722 TokError("expected '(' after unary operator");
725 Lex.Lex(); // eat the '('
727 Init *LHS = ParseValue(CurRec);
728 if (LHS == 0) return 0;
730 if (Code == UnOpInit::CAR
731 || Code == UnOpInit::CDR
732 || Code == UnOpInit::LNULL) {
733 ListInit *LHSl = dynamic_cast<ListInit*>(LHS);
734 StringInit *LHSs = dynamic_cast<StringInit*>(LHS);
735 TypedInit *LHSt = dynamic_cast<TypedInit*>(LHS);
736 if (LHSl == 0 && LHSs == 0 && LHSt == 0) {
737 TokError("expected list or string type argument in unary operator");
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");
749 if (Code == UnOpInit::CAR
750 || Code == UnOpInit::CDR) {
751 if (LHSl == 0 && LHSt == 0) {
752 TokError("expected list type argumnet in unary operator");
756 if (LHSl && LHSl->getSize() == 0) {
757 TokError("empty list argument in unary operator");
761 Init *Item = LHSl->getElement(0);
762 TypedInit *Itemt = dynamic_cast<TypedInit*>(Item);
764 TokError("untyped list element in unary operator");
767 if (Code == UnOpInit::CAR) {
768 Type = Itemt->getType();
770 Type = new ListRecTy(Itemt->getType());
773 assert(LHSt && "expected list type argument in unary operator");
774 ListRecTy *LType = dynamic_cast<ListRecTy*>(LHSt->getType());
776 TokError("expected list type argumnet in unary operator");
779 if (Code == UnOpInit::CAR) {
780 Type = LType->getElementType();
788 if (Lex.getCode() != tgtok::r_paren) {
789 TokError("expected ')' in unary operator");
792 Lex.Lex(); // eat the ')'
793 return (new UnOpInit(Code, LHS, Type))->Fold(CurRec, CurMultiClass);
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
806 BinOpInit::BinaryOp Code;
810 default: assert(0 && "Unhandled code!");
811 case tgtok::XConcat: Code = BinOpInit::CONCAT; Type = new DagRecTy(); break;
812 case tgtok::XSRA: Code = BinOpInit::SRA; Type = new IntRecTy(); break;
813 case tgtok::XSRL: Code = BinOpInit::SRL; Type = new IntRecTy(); break;
814 case tgtok::XSHL: Code = BinOpInit::SHL; Type = new IntRecTy(); break;
815 case tgtok::XEq: Code = BinOpInit::EQ; Type = new BitRecTy(); break;
816 case tgtok::XStrConcat:
817 Code = BinOpInit::STRCONCAT;
818 Type = new StringRecTy();
822 if (Lex.getCode() != tgtok::l_paren) {
823 TokError("expected '(' after binary operator");
826 Lex.Lex(); // eat the '('
828 SmallVector<Init*, 2> InitList;
830 InitList.push_back(ParseValue(CurRec));
831 if (InitList.back() == 0) return 0;
833 while (Lex.getCode() == tgtok::comma) {
834 Lex.Lex(); // eat the ','
836 InitList.push_back(ParseValue(CurRec));
837 if (InitList.back() == 0) return 0;
840 if (Lex.getCode() != tgtok::r_paren) {
841 TokError("expected ')' in operator");
844 Lex.Lex(); // eat the ')'
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 Init *RHS = InitList.pop_back_val();
851 RHS = (new BinOpInit(Code, InitList.back(), RHS, Type))
852 ->Fold(CurRec, CurMultiClass);
853 InitList.back() = RHS;
857 if (InitList.size() == 2)
858 return (new BinOpInit(Code, InitList[0], InitList[1], Type))
859 ->Fold(CurRec, CurMultiClass);
861 Error(OpLoc, "expected two operands to operator");
866 case tgtok::XForEach:
867 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
868 TernOpInit::TernaryOp Code;
871 tgtok::TokKind LexCode = Lex.getCode();
872 Lex.Lex(); // eat the operation
874 default: assert(0 && "Unhandled code!");
876 Code = TernOpInit::IF;
878 case tgtok::XForEach:
879 Code = TernOpInit::FOREACH;
882 Code = TernOpInit::SUBST;
885 if (Lex.getCode() != tgtok::l_paren) {
886 TokError("expected '(' after ternary operator");
889 Lex.Lex(); // eat the '('
891 Init *LHS = ParseValue(CurRec);
892 if (LHS == 0) return 0;
894 if (Lex.getCode() != tgtok::comma) {
895 TokError("expected ',' in ternary operator");
898 Lex.Lex(); // eat the ','
900 Init *MHS = ParseValue(CurRec);
901 if (MHS == 0) return 0;
903 if (Lex.getCode() != tgtok::comma) {
904 TokError("expected ',' in ternary operator");
907 Lex.Lex(); // eat the ','
909 Init *RHS = ParseValue(CurRec);
910 if (RHS == 0) return 0;
912 if (Lex.getCode() != tgtok::r_paren) {
913 TokError("expected ')' in binary operator");
916 Lex.Lex(); // eat the ')'
919 default: assert(0 && "Unhandled code!");
921 // FIXME: The `!if' operator doesn't handle non-TypedInit well at
922 // all. This can be made much more robust.
923 TypedInit *MHSt = dynamic_cast<TypedInit*>(MHS);
924 TypedInit *RHSt = dynamic_cast<TypedInit*>(RHS);
929 if (MHSt == 0 && RHSt == 0) {
930 BitsInit *MHSbits = dynamic_cast<BitsInit*>(MHS);
931 BitsInit *RHSbits = dynamic_cast<BitsInit*>(RHS);
933 if (MHSbits && RHSbits &&
934 MHSbits->getNumBits() == RHSbits->getNumBits()) {
935 Type = new BitRecTy();
938 BitInit *MHSbit = dynamic_cast<BitInit*>(MHS);
939 BitInit *RHSbit = dynamic_cast<BitInit*>(RHS);
941 if (MHSbit && RHSbit) {
942 Type = new BitRecTy();
946 } else if (MHSt != 0 && RHSt != 0) {
947 MHSTy = MHSt->getType();
948 RHSTy = RHSt->getType();
951 if (!MHSTy || !RHSTy) {
952 TokError("could not get type for !if");
956 if (MHSTy->typeIsConvertibleTo(RHSTy)) {
958 } else if (RHSTy->typeIsConvertibleTo(MHSTy)) {
961 TokError("inconsistent types for !if");
966 case tgtok::XForEach: {
967 TypedInit *MHSt = dynamic_cast<TypedInit *>(MHS);
969 TokError("could not get type for !foreach");
972 Type = MHSt->getType();
975 case tgtok::XSubst: {
976 TypedInit *RHSt = dynamic_cast<TypedInit *>(RHS);
978 TokError("could not get type for !subst");
981 Type = RHSt->getType();
985 return (new TernOpInit(Code, LHS, MHS, RHS, Type))->Fold(CurRec,
989 TokError("could not parse operation");
993 /// ParseOperatorType - Parse a type for an operator. This returns
996 /// OperatorType ::= '<' Type '>'
998 RecTy *TGParser::ParseOperatorType() {
1001 if (Lex.getCode() != tgtok::less) {
1002 TokError("expected type name for operator");
1005 Lex.Lex(); // eat the <
1010 TokError("expected type name for operator");
1014 if (Lex.getCode() != tgtok::greater) {
1015 TokError("expected type name for operator");
1018 Lex.Lex(); // eat the >
1024 /// ParseSimpleValue - Parse a tblgen value. This returns null on error.
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 ')'
1041 Init *TGParser::ParseSimpleValue(Record *CurRec, RecTy *ItemType) {
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();
1050 // Handle multiple consecutive concatenated strings.
1051 while (Lex.getCode() == tgtok::StrVal) {
1052 Val += Lex.getCurStrVal();
1056 R = new StringInit(Val);
1059 case tgtok::CodeFragment:
1060 R = new CodeInit(Lex.getCurStrVal());
1063 case tgtok::question:
1064 R = new UnsetInit();
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
1073 // Value ::= ID '<' ValueListNE '>'
1074 if (Lex.Lex() == tgtok::greater) {
1075 TokError("expected non-empty value list");
1079 // This is a CLASS<initvalslist> expression. This is supposed to synthesize
1080 // a new anonymous definition, deriving from CLASS<initvalslist> with no
1082 Record *Class = Records.getClass(Name);
1084 Error(NameLoc, "Expected a class name, got '" + Name + "'");
1088 std::vector<Init*> ValueList = ParseValueList(CurRec, Class);
1089 if (ValueList.empty()) return 0;
1091 if (Lex.getCode() != tgtok::greater) {
1092 TokError("expected '>' at end of value list");
1095 Lex.Lex(); // eat the '>'
1097 // Create the new record, set it as CurRec temporarily.
1098 static unsigned AnonCounter = 0;
1099 Record *NewRec = Records.createRecord(
1100 "anonymous.val."+utostr(AnonCounter++),NameLoc);
1101 SubClassReference SCRef;
1102 SCRef.RefLoc = NameLoc;
1104 SCRef.TemplateArgs = ValueList;
1105 // Add info about the subclass to NewRec.
1106 if (AddSubClass(NewRec, SCRef))
1108 NewRec->resolveReferences();
1109 Records.addDef(NewRec);
1111 // The result of the expression is a reference to the new record.
1112 return new DefInit(NewRec);
1114 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
1115 SMLoc BraceLoc = Lex.getLoc();
1116 Lex.Lex(); // eat the '{'
1117 std::vector<Init*> Vals;
1119 if (Lex.getCode() != tgtok::r_brace) {
1120 Vals = ParseValueList(CurRec);
1121 if (Vals.empty()) return 0;
1123 if (Lex.getCode() != tgtok::r_brace) {
1124 TokError("expected '}' at end of bit list value");
1127 Lex.Lex(); // eat the '}'
1129 BitsInit *Result = new BitsInit(Vals.size());
1130 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1131 Init *Bit = Vals[i]->convertInitializerTo(new BitRecTy());
1133 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1134 ") is not convertable to a bit");
1137 Result->setBit(Vals.size()-i-1, Bit);
1141 case tgtok::l_square: { // Value ::= '[' ValueList ']'
1142 Lex.Lex(); // eat the '['
1143 std::vector<Init*> Vals;
1145 RecTy *DeducedEltTy = 0;
1146 ListRecTy *GivenListTy = 0;
1148 if (ItemType != 0) {
1149 ListRecTy *ListType = dynamic_cast<ListRecTy*>(ItemType);
1150 if (ListType == 0) {
1151 std::stringstream s;
1152 s << "Type mismatch for list, expected list type, got "
1153 << ItemType->getAsString();
1156 GivenListTy = ListType;
1159 if (Lex.getCode() != tgtok::r_square) {
1160 Vals = ParseValueList(CurRec, 0,
1161 GivenListTy ? GivenListTy->getElementType() : 0);
1162 if (Vals.empty()) return 0;
1164 if (Lex.getCode() != tgtok::r_square) {
1165 TokError("expected ']' at end of list value");
1168 Lex.Lex(); // eat the ']'
1170 RecTy *GivenEltTy = 0;
1171 if (Lex.getCode() == tgtok::less) {
1172 // Optional list element type
1173 Lex.Lex(); // eat the '<'
1175 GivenEltTy = ParseType();
1176 if (GivenEltTy == 0) {
1177 // Couldn't parse element type
1181 if (Lex.getCode() != tgtok::greater) {
1182 TokError("expected '>' at end of list element type");
1185 Lex.Lex(); // eat the '>'
1190 for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1193 TypedInit *TArg = dynamic_cast<TypedInit*>(*i);
1195 TokError("Untyped list element");
1199 EltTy = resolveTypes(EltTy, TArg->getType());
1201 TokError("Incompatible types in list elements");
1205 EltTy = TArg->getType();
1209 if (GivenEltTy != 0) {
1211 // Verify consistency
1212 if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1213 TokError("Incompatible types in list elements");
1221 if (ItemType == 0) {
1222 TokError("No type for list");
1225 DeducedEltTy = GivenListTy->getElementType();
1227 // Make sure the deduced type is compatible with the given type
1229 if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1230 TokError("Element type mismatch for list");
1234 DeducedEltTy = EltTy;
1237 return new ListInit(Vals, DeducedEltTy);
1239 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
1240 Lex.Lex(); // eat the '('
1241 if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1242 TokError("expected identifier in dag init");
1246 Init *Operator = ParseValue(CurRec);
1247 if (Operator == 0) return 0;
1249 // If the operator name is present, parse it.
1250 std::string OperatorName;
1251 if (Lex.getCode() == tgtok::colon) {
1252 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1253 TokError("expected variable name in dag operator");
1256 OperatorName = Lex.getCurStrVal();
1257 Lex.Lex(); // eat the VarName.
1260 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1261 if (Lex.getCode() != tgtok::r_paren) {
1262 DagArgs = ParseDagArgList(CurRec);
1263 if (DagArgs.empty()) return 0;
1266 if (Lex.getCode() != tgtok::r_paren) {
1267 TokError("expected ')' in dag init");
1270 Lex.Lex(); // eat the ')'
1272 return new DagInit(Operator, OperatorName, DagArgs);
1278 case tgtok::XCast: // Value ::= !unop '(' Value ')'
1279 case tgtok::XConcat:
1284 case tgtok::XStrConcat: // Value ::= !binop '(' Value ',' Value ')'
1286 case tgtok::XForEach:
1287 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1288 return ParseOperation(CurRec);
1295 /// ParseValue - Parse a tblgen value. This returns null on error.
1297 /// Value ::= SimpleValue ValueSuffix*
1298 /// ValueSuffix ::= '{' BitList '}'
1299 /// ValueSuffix ::= '[' BitList ']'
1300 /// ValueSuffix ::= '.' ID
1302 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType) {
1303 Init *Result = ParseSimpleValue(CurRec, ItemType);
1304 if (Result == 0) return 0;
1306 // Parse the suffixes now if present.
1308 switch (Lex.getCode()) {
1309 default: return Result;
1310 case tgtok::l_brace: {
1311 SMLoc CurlyLoc = Lex.getLoc();
1312 Lex.Lex(); // eat the '{'
1313 std::vector<unsigned> Ranges = ParseRangeList();
1314 if (Ranges.empty()) return 0;
1316 // Reverse the bitlist.
1317 std::reverse(Ranges.begin(), Ranges.end());
1318 Result = Result->convertInitializerBitRange(Ranges);
1320 Error(CurlyLoc, "Invalid bit range for value");
1325 if (Lex.getCode() != tgtok::r_brace) {
1326 TokError("expected '}' at end of bit range list");
1332 case tgtok::l_square: {
1333 SMLoc SquareLoc = Lex.getLoc();
1334 Lex.Lex(); // eat the '['
1335 std::vector<unsigned> Ranges = ParseRangeList();
1336 if (Ranges.empty()) return 0;
1338 Result = Result->convertInitListSlice(Ranges);
1340 Error(SquareLoc, "Invalid range for list slice");
1345 if (Lex.getCode() != tgtok::r_square) {
1346 TokError("expected ']' at end of list slice");
1353 if (Lex.Lex() != tgtok::Id) { // eat the .
1354 TokError("expected field identifier after '.'");
1357 if (!Result->getFieldType(Lex.getCurStrVal())) {
1358 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1359 Result->getAsString() + "'");
1362 Result = new FieldInit(Result, Lex.getCurStrVal());
1363 Lex.Lex(); // eat field name
1369 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1371 /// ParseDagArgList ::= Value (':' VARNAME)?
1372 /// ParseDagArgList ::= ParseDagArgList ',' Value (':' VARNAME)?
1373 std::vector<std::pair<llvm::Init*, std::string> >
1374 TGParser::ParseDagArgList(Record *CurRec) {
1375 std::vector<std::pair<llvm::Init*, std::string> > Result;
1378 Init *Val = ParseValue(CurRec);
1379 if (Val == 0) return std::vector<std::pair<llvm::Init*, std::string> >();
1381 // If the variable name is present, add it.
1382 std::string VarName;
1383 if (Lex.getCode() == tgtok::colon) {
1384 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1385 TokError("expected variable name in dag literal");
1386 return std::vector<std::pair<llvm::Init*, std::string> >();
1388 VarName = Lex.getCurStrVal();
1389 Lex.Lex(); // eat the VarName.
1392 Result.push_back(std::make_pair(Val, VarName));
1394 if (Lex.getCode() != tgtok::comma) break;
1395 Lex.Lex(); // eat the ','
1402 /// ParseValueList - Parse a comma separated list of values, returning them as a
1403 /// vector. Note that this always expects to be able to parse at least one
1404 /// value. It returns an empty list if this is not possible.
1406 /// ValueList ::= Value (',' Value)
1408 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1410 std::vector<Init*> Result;
1411 RecTy *ItemType = EltTy;
1412 unsigned int ArgN = 0;
1413 if (ArgsRec != 0 && EltTy == 0) {
1414 const std::vector<std::string> &TArgs = ArgsRec->getTemplateArgs();
1415 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1416 assert(RV && "Template argument record not found??");
1417 ItemType = RV->getType();
1420 Result.push_back(ParseValue(CurRec, ItemType));
1421 if (Result.back() == 0) return std::vector<Init*>();
1423 while (Lex.getCode() == tgtok::comma) {
1424 Lex.Lex(); // Eat the comma
1426 if (ArgsRec != 0 && EltTy == 0) {
1427 const std::vector<std::string> &TArgs = ArgsRec->getTemplateArgs();
1428 if (ArgN >= TArgs.size()) {
1429 TokError("too many template arguments");
1430 return std::vector<Init*>();
1432 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1433 assert(RV && "Template argument record not found??");
1434 ItemType = RV->getType();
1437 Result.push_back(ParseValue(CurRec, ItemType));
1438 if (Result.back() == 0) return std::vector<Init*>();
1445 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1446 /// empty string on error. This can happen in a number of different context's,
1447 /// including within a def or in the template args for a def (which which case
1448 /// CurRec will be non-null) and within the template args for a multiclass (in
1449 /// which case CurRec will be null, but CurMultiClass will be set). This can
1450 /// also happen within a def that is within a multiclass, which will set both
1451 /// CurRec and CurMultiClass.
1453 /// Declaration ::= FIELD? Type ID ('=' Value)?
1455 std::string TGParser::ParseDeclaration(Record *CurRec,
1456 bool ParsingTemplateArgs) {
1457 // Read the field prefix if present.
1458 bool HasField = Lex.getCode() == tgtok::Field;
1459 if (HasField) Lex.Lex();
1461 RecTy *Type = ParseType();
1462 if (Type == 0) return "";
1464 if (Lex.getCode() != tgtok::Id) {
1465 TokError("Expected identifier in declaration");
1469 SMLoc IdLoc = Lex.getLoc();
1470 std::string DeclName = Lex.getCurStrVal();
1473 if (ParsingTemplateArgs) {
1475 DeclName = CurRec->getName() + ":" + DeclName;
1477 assert(CurMultiClass);
1480 DeclName = CurMultiClass->Rec.getName() + "::" + DeclName;
1484 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1487 // If a value is present, parse it.
1488 if (Lex.getCode() == tgtok::equal) {
1490 SMLoc ValLoc = Lex.getLoc();
1491 Init *Val = ParseValue(CurRec, Type);
1493 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1500 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1501 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
1502 /// template args for a def, which may or may not be in a multiclass. If null,
1503 /// these are the template args for a multiclass.
1505 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1507 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1508 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1509 Lex.Lex(); // eat the '<'
1511 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1513 // Read the first declaration.
1514 std::string TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1515 if (TemplArg.empty())
1518 TheRecToAddTo->addTemplateArg(TemplArg);
1520 while (Lex.getCode() == tgtok::comma) {
1521 Lex.Lex(); // eat the ','
1523 // Read the following declarations.
1524 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1525 if (TemplArg.empty())
1527 TheRecToAddTo->addTemplateArg(TemplArg);
1530 if (Lex.getCode() != tgtok::greater)
1531 return TokError("expected '>' at end of template argument list");
1532 Lex.Lex(); // eat the '>'.
1537 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1539 /// BodyItem ::= Declaration ';'
1540 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
1541 bool TGParser::ParseBodyItem(Record *CurRec) {
1542 if (Lex.getCode() != tgtok::Let) {
1543 if (ParseDeclaration(CurRec, false).empty())
1546 if (Lex.getCode() != tgtok::semi)
1547 return TokError("expected ';' after declaration");
1552 // LET ID OptionalRangeList '=' Value ';'
1553 if (Lex.Lex() != tgtok::Id)
1554 return TokError("expected field identifier after let");
1556 SMLoc IdLoc = Lex.getLoc();
1557 std::string FieldName = Lex.getCurStrVal();
1558 Lex.Lex(); // eat the field name.
1560 std::vector<unsigned> BitList;
1561 if (ParseOptionalBitList(BitList))
1563 std::reverse(BitList.begin(), BitList.end());
1565 if (Lex.getCode() != tgtok::equal)
1566 return TokError("expected '=' in let expression");
1567 Lex.Lex(); // eat the '='.
1569 RecordVal *Field = CurRec->getValue(FieldName);
1571 return TokError("Value '" + FieldName + "' unknown!");
1573 RecTy *Type = Field->getType();
1575 Init *Val = ParseValue(CurRec, Type);
1576 if (Val == 0) return true;
1578 if (Lex.getCode() != tgtok::semi)
1579 return TokError("expected ';' after let expression");
1582 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1585 /// ParseBody - Read the body of a class or def. Return true on error, false on
1589 /// Body ::= '{' BodyList '}'
1590 /// BodyList BodyItem*
1592 bool TGParser::ParseBody(Record *CurRec) {
1593 // If this is a null definition, just eat the semi and return.
1594 if (Lex.getCode() == tgtok::semi) {
1599 if (Lex.getCode() != tgtok::l_brace)
1600 return TokError("Expected ';' or '{' to start body");
1604 while (Lex.getCode() != tgtok::r_brace)
1605 if (ParseBodyItem(CurRec))
1613 /// ParseObjectBody - Parse the body of a def or class. This consists of an
1614 /// optional ClassList followed by a Body. CurRec is the current def or class
1615 /// that is being parsed.
1617 /// ObjectBody ::= BaseClassList Body
1618 /// BaseClassList ::= /*empty*/
1619 /// BaseClassList ::= ':' BaseClassListNE
1620 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1622 bool TGParser::ParseObjectBody(Record *CurRec) {
1623 // If there is a baseclass list, read it.
1624 if (Lex.getCode() == tgtok::colon) {
1627 // Read all of the subclasses.
1628 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1631 if (SubClass.Rec == 0) return true;
1634 if (AddSubClass(CurRec, SubClass))
1637 if (Lex.getCode() != tgtok::comma) break;
1638 Lex.Lex(); // eat ','.
1639 SubClass = ParseSubClassReference(CurRec, false);
1643 // Process any variables on the let stack.
1644 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1645 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1646 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1647 LetStack[i][j].Bits, LetStack[i][j].Value))
1650 return ParseBody(CurRec);
1653 /// ParseDef - Parse and return a top level or multiclass def, return the record
1654 /// corresponding to it. This returns null on error.
1656 /// DefInst ::= DEF ObjectName ObjectBody
1658 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
1659 SMLoc DefLoc = Lex.getLoc();
1660 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1661 Lex.Lex(); // Eat the 'def' token.
1663 // Parse ObjectName and make a record for it.
1664 Record *CurRec = Records.createRecord(ParseObjectName(), DefLoc);
1666 if (!CurMultiClass) {
1667 // Top-level def definition.
1669 // Ensure redefinition doesn't happen.
1670 if (Records.getDef(CurRec->getName())) {
1671 Error(DefLoc, "def '" + CurRec->getName() + "' already defined");
1674 Records.addDef(CurRec);
1676 // Otherwise, a def inside a multiclass, add it to the multiclass.
1677 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1678 if (CurMultiClass->DefPrototypes[i]->getName() == CurRec->getName()) {
1679 Error(DefLoc, "def '" + CurRec->getName() +
1680 "' already defined in this multiclass!");
1683 CurMultiClass->DefPrototypes.push_back(CurRec);
1686 if (ParseObjectBody(CurRec))
1689 if (CurMultiClass == 0) // Def's in multiclasses aren't really defs.
1690 CurRec->resolveReferences();
1692 // If ObjectBody has template arguments, it's an error.
1693 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1695 if (CurMultiClass) {
1696 // Copy the template arguments for the multiclass into the def.
1697 const std::vector<std::string> &TArgs =
1698 CurMultiClass->Rec.getTemplateArgs();
1700 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1701 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1702 assert(RV && "Template arg doesn't exist?");
1703 CurRec->addValue(*RV);
1711 /// ParseClass - Parse a tblgen class definition.
1713 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
1715 bool TGParser::ParseClass() {
1716 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
1719 if (Lex.getCode() != tgtok::Id)
1720 return TokError("expected class name after 'class' keyword");
1722 Record *CurRec = Records.getClass(Lex.getCurStrVal());
1724 // If the body was previously defined, this is an error.
1725 if (!CurRec->getValues().empty() ||
1726 !CurRec->getSuperClasses().empty() ||
1727 !CurRec->getTemplateArgs().empty())
1728 return TokError("Class '" + CurRec->getName() + "' already defined");
1730 // If this is the first reference to this class, create and add it.
1731 CurRec = Records.createRecord(Lex.getCurStrVal(), Lex.getLoc());
1732 Records.addClass(CurRec);
1734 Lex.Lex(); // eat the name.
1736 // If there are template args, parse them.
1737 if (Lex.getCode() == tgtok::less)
1738 if (ParseTemplateArgList(CurRec))
1741 // Finally, parse the object body.
1742 return ParseObjectBody(CurRec);
1745 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
1748 /// LetList ::= LetItem (',' LetItem)*
1749 /// LetItem ::= ID OptionalRangeList '=' Value
1751 std::vector<LetRecord> TGParser::ParseLetList() {
1752 std::vector<LetRecord> Result;
1755 if (Lex.getCode() != tgtok::Id) {
1756 TokError("expected identifier in let definition");
1757 return std::vector<LetRecord>();
1759 std::string Name = Lex.getCurStrVal();
1760 SMLoc NameLoc = Lex.getLoc();
1761 Lex.Lex(); // Eat the identifier.
1763 // Check for an optional RangeList.
1764 std::vector<unsigned> Bits;
1765 if (ParseOptionalRangeList(Bits))
1766 return std::vector<LetRecord>();
1767 std::reverse(Bits.begin(), Bits.end());
1769 if (Lex.getCode() != tgtok::equal) {
1770 TokError("expected '=' in let expression");
1771 return std::vector<LetRecord>();
1773 Lex.Lex(); // eat the '='.
1775 Init *Val = ParseValue(0);
1776 if (Val == 0) return std::vector<LetRecord>();
1778 // Now that we have everything, add the record.
1779 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
1781 if (Lex.getCode() != tgtok::comma)
1783 Lex.Lex(); // eat the comma.
1787 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
1788 /// different related productions. This works inside multiclasses too.
1790 /// Object ::= LET LetList IN '{' ObjectList '}'
1791 /// Object ::= LET LetList IN Object
1793 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
1794 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
1797 // Add this entry to the let stack.
1798 std::vector<LetRecord> LetInfo = ParseLetList();
1799 if (LetInfo.empty()) return true;
1800 LetStack.push_back(LetInfo);
1802 if (Lex.getCode() != tgtok::In)
1803 return TokError("expected 'in' at end of top-level 'let'");
1806 // If this is a scalar let, just handle it now
1807 if (Lex.getCode() != tgtok::l_brace) {
1808 // LET LetList IN Object
1809 if (ParseObject(CurMultiClass))
1811 } else { // Object ::= LETCommand '{' ObjectList '}'
1812 SMLoc BraceLoc = Lex.getLoc();
1813 // Otherwise, this is a group let.
1814 Lex.Lex(); // eat the '{'.
1816 // Parse the object list.
1817 if (ParseObjectList(CurMultiClass))
1820 if (Lex.getCode() != tgtok::r_brace) {
1821 TokError("expected '}' at end of top level let command");
1822 return Error(BraceLoc, "to match this '{'");
1827 // Outside this let scope, this let block is not active.
1828 LetStack.pop_back();
1832 /// ParseMultiClass - Parse a multiclass definition.
1834 /// MultiClassInst ::= MULTICLASS ID TemplateArgList?
1835 /// ':' BaseMultiClassList '{' MultiClassDef+ '}'
1837 bool TGParser::ParseMultiClass() {
1838 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
1839 Lex.Lex(); // Eat the multiclass token.
1841 if (Lex.getCode() != tgtok::Id)
1842 return TokError("expected identifier after multiclass for name");
1843 std::string Name = Lex.getCurStrVal();
1845 if (MultiClasses.count(Name))
1846 return TokError("multiclass '" + Name + "' already defined");
1848 CurMultiClass = MultiClasses[Name] = new MultiClass(Name,
1849 Lex.getLoc(), Records);
1850 Lex.Lex(); // Eat the identifier.
1852 // If there are template args, parse them.
1853 if (Lex.getCode() == tgtok::less)
1854 if (ParseTemplateArgList(0))
1857 bool inherits = false;
1859 // If there are submulticlasses, parse them.
1860 if (Lex.getCode() == tgtok::colon) {
1865 // Read all of the submulticlasses.
1866 SubMultiClassReference SubMultiClass =
1867 ParseSubMultiClassReference(CurMultiClass);
1870 if (SubMultiClass.MC == 0) return true;
1873 if (AddSubMultiClass(CurMultiClass, SubMultiClass))
1876 if (Lex.getCode() != tgtok::comma) break;
1877 Lex.Lex(); // eat ','.
1878 SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
1882 if (Lex.getCode() != tgtok::l_brace) {
1884 return TokError("expected '{' in multiclass definition");
1885 else if (Lex.getCode() != tgtok::semi)
1886 return TokError("expected ';' in multiclass definition");
1888 Lex.Lex(); // eat the ';'.
1890 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
1891 return TokError("multiclass must contain at least one def");
1893 while (Lex.getCode() != tgtok::r_brace) {
1894 switch (Lex.getCode()) {
1896 return TokError("expected 'let', 'def' or 'defm' in multiclass body");
1900 if (ParseObject(CurMultiClass))
1905 Lex.Lex(); // eat the '}'.
1912 /// ParseDefm - Parse the instantiation of a multiclass.
1914 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
1916 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
1917 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
1919 std::string DefmPrefix;
1920 if (Lex.Lex() == tgtok::Id) { // eat the defm.
1921 DefmPrefix = Lex.getCurStrVal();
1922 Lex.Lex(); // Eat the defm prefix.
1925 SMLoc DefmPrefixLoc = Lex.getLoc();
1926 if (Lex.getCode() != tgtok::colon)
1927 return TokError("expected ':' after defm identifier");
1929 // Keep track of the new generated record definitions.
1930 std::vector<Record*> NewRecDefs;
1932 // This record also inherits from a regular class (non-multiclass)?
1933 bool InheritFromClass = false;
1938 SMLoc SubClassLoc = Lex.getLoc();
1939 SubClassReference Ref = ParseSubClassReference(0, true);
1942 if (Ref.Rec == 0) return true;
1944 // To instantiate a multiclass, we need to first get the multiclass, then
1945 // instantiate each def contained in the multiclass with the SubClassRef
1946 // template parameters.
1947 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
1948 assert(MC && "Didn't lookup multiclass correctly?");
1949 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
1951 // Verify that the correct number of template arguments were specified.
1952 const std::vector<std::string> &TArgs = MC->Rec.getTemplateArgs();
1953 if (TArgs.size() < TemplateVals.size())
1954 return Error(SubClassLoc,
1955 "more template args specified than multiclass expects");
1957 // Loop over all the def's in the multiclass, instantiating each one.
1958 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
1959 Record *DefProto = MC->DefPrototypes[i];
1961 // Add in the defm name. If the defm prefix is empty, give each
1962 // instantiated def a unique name. Otherwise, if "#NAME#" exists in the
1963 // name, substitute the prefix for #NAME#. Otherwise, use the defm name
1965 std::string DefName = DefProto->getName();
1966 if (DefmPrefix.empty()) {
1967 DefName = GetNewAnonymousName();
1969 std::string::size_type idx = DefName.find("#NAME#");
1970 if (idx != std::string::npos) {
1971 DefName.replace(idx, 6, DefmPrefix);
1973 // Add the suffix to the defm name to get the new name.
1974 DefName = DefmPrefix + DefName;
1978 Record *CurRec = Records.createRecord(DefName, DefmPrefixLoc);
1980 SubClassReference Ref;
1981 Ref.RefLoc = DefmPrefixLoc;
1983 AddSubClass(CurRec, Ref);
1985 // Loop over all of the template arguments, setting them to the specified
1986 // value or leaving them as the default if necessary.
1987 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1988 // Check if a value is specified for this temp-arg.
1989 if (i < TemplateVals.size()) {
1991 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
1996 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
1999 CurRec->removeValue(TArgs[i]);
2001 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2002 return Error(SubClassLoc,
2003 "value not specified for template argument #"+
2004 utostr(i) + " (" + TArgs[i] + ") of multiclassclass '" +
2005 MC->Rec.getName() + "'");
2009 // If the mdef is inside a 'let' expression, add to each def.
2010 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
2011 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
2012 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
2013 LetStack[i][j].Bits, LetStack[i][j].Value)) {
2014 Error(DefmPrefixLoc, "when instantiating this defm");
2018 // Ensure redefinition doesn't happen.
2019 if (Records.getDef(CurRec->getName()))
2020 return Error(DefmPrefixLoc, "def '" + CurRec->getName() +
2021 "' already defined, instantiating defm with subdef '" +
2022 DefProto->getName() + "'");
2024 // Don't create a top level definition for defm inside multiclasses,
2025 // instead, only update the prototypes and bind the template args
2026 // with the new created definition.
2027 if (CurMultiClass) {
2028 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2030 if (CurMultiClass->DefPrototypes[i]->getName() == CurRec->getName()) {
2031 Error(DefmPrefixLoc, "defm '" + CurRec->getName() +
2032 "' already defined in this multiclass!");
2036 CurMultiClass->DefPrototypes.push_back(CurRec);
2038 // Copy the template arguments for the multiclass into the new def.
2039 const std::vector<std::string> &TA =
2040 CurMultiClass->Rec.getTemplateArgs();
2042 for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2043 const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2044 assert(RV && "Template arg doesn't exist?");
2045 CurRec->addValue(*RV);
2048 Records.addDef(CurRec);
2051 NewRecDefs.push_back(CurRec);
2054 if (Lex.getCode() != tgtok::comma) break;
2055 Lex.Lex(); // eat ','.
2057 SubClassLoc = Lex.getLoc();
2059 // A defm can inherit from regular classes (non-multiclass) as
2060 // long as they come in the end of the inheritance list.
2061 InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != 0);
2063 if (InheritFromClass)
2066 Ref = ParseSubClassReference(0, true);
2069 if (InheritFromClass) {
2070 // Process all the classes to inherit as if they were part of a
2071 // regular 'def' and inherit all record values.
2072 SubClassReference SubClass = ParseSubClassReference(0, false);
2075 if (SubClass.Rec == 0) return true;
2077 // Get the expanded definition prototypes and teach them about
2078 // the record values the current class to inherit has
2079 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2080 Record *CurRec = NewRecDefs[i];
2083 if (AddSubClass(CurRec, SubClass))
2086 // Process any variables on the let stack.
2087 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
2088 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
2089 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
2090 LetStack[i][j].Bits, LetStack[i][j].Value))
2094 if (Lex.getCode() != tgtok::comma) break;
2095 Lex.Lex(); // eat ','.
2096 SubClass = ParseSubClassReference(0, false);
2101 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2102 NewRecDefs[i]->resolveReferences();
2104 if (Lex.getCode() != tgtok::semi)
2105 return TokError("expected ';' at end of defm");
2112 /// Object ::= ClassInst
2113 /// Object ::= DefInst
2114 /// Object ::= MultiClassInst
2115 /// Object ::= DefMInst
2116 /// Object ::= LETCommand '{' ObjectList '}'
2117 /// Object ::= LETCommand Object
2118 bool TGParser::ParseObject(MultiClass *MC) {
2119 switch (Lex.getCode()) {
2121 return TokError("Expected class, def, defm, multiclass or let definition");
2122 case tgtok::Let: return ParseTopLevelLet(MC);
2123 case tgtok::Def: return ParseDef(MC);
2124 case tgtok::Defm: return ParseDefm(MC);
2125 case tgtok::Class: return ParseClass();
2126 case tgtok::MultiClass: return ParseMultiClass();
2131 /// ObjectList :== Object*
2132 bool TGParser::ParseObjectList(MultiClass *MC) {
2133 while (isObjectStart(Lex.getCode())) {
2134 if (ParseObject(MC))
2140 bool TGParser::ParseFile() {
2141 Lex.Lex(); // Prime the lexer.
2142 if (ParseObjectList()) return true;
2144 // If we have unread input at the end of the file, report it.
2145 if (Lex.getCode() == tgtok::Eof)
2148 return TokError("Unexpected input at top level");