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 //===----------------------------------------------------------------------===//
15 #include "llvm/TableGen/Record.h"
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(BitsRecTy::get(BitList.size()));
111 V->convertInitializerTo(BitsRecTy::get(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 SmallVector<Init *, 16> NewBits(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];
125 return Error(Loc, "Cannot set bit #" + utostr(Bit) + " of value '" +
126 ValName + "' more than once");
127 NewBits[Bit] = BInit->getBit(i);
130 for (unsigned i = 0, e = CurVal->getNumBits(); i != e; ++i)
132 NewBits[i] = CurVal->getBit(i);
134 V = BitsInit::get(NewBits);
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 StringRecTy::get();
585 case tgtok::Bit: Lex.Lex(); return BitRecTy::get();
586 case tgtok::Int: Lex.Lex(); return IntRecTy::get();
587 case tgtok::Code: Lex.Lex(); return CodeRecTy::get();
588 case tgtok::Dag: Lex.Lex(); return DagRecTy::get();
590 if (Record *R = ParseClassID()) return RecordRecTy::get(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 BitsRecTy::get(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 ListRecTy::get(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 VarInit::get(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 VarInit::get(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 VarInit::get(MCName, RV->getType());
669 if (Record *D = Records.getDef(Name))
670 return DefInit::get(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::HEAD;
712 Lex.Lex(); // eat the operation
713 Code = UnOpInit::TAIL;
716 Lex.Lex(); // eat the operation
717 Code = UnOpInit::EMPTY;
718 Type = IntRecTy::get();
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::HEAD
731 || Code == UnOpInit::TAIL
732 || Code == UnOpInit::EMPTY) {
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::HEAD
750 || Code == UnOpInit::TAIL) {
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::HEAD) {
768 Type = Itemt->getType();
770 Type = ListRecTy::get(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::HEAD) {
780 Type = LType->getElementType();
788 if (Lex.getCode() != tgtok::r_paren) {
789 TokError("expected ')' in unary operator");
792 Lex.Lex(); // eat the ')'
793 return (UnOpInit::get(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 = DagRecTy::get(); break;
812 case tgtok::XSRA: Code = BinOpInit::SRA; Type = IntRecTy::get(); break;
813 case tgtok::XSRL: Code = BinOpInit::SRL; Type = IntRecTy::get(); break;
814 case tgtok::XSHL: Code = BinOpInit::SHL; Type = IntRecTy::get(); break;
815 case tgtok::XEq: Code = BinOpInit::EQ; Type = BitRecTy::get(); break;
816 case tgtok::XStrConcat:
817 Code = BinOpInit::STRCONCAT;
818 Type = StringRecTy::get();
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 = (BinOpInit::get(Code, InitList.back(), RHS, Type))
852 ->Fold(CurRec, CurMultiClass);
853 InitList.back() = RHS;
857 if (InitList.size() == 2)
858 return (BinOpInit::get(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 = BitRecTy::get();
938 BitInit *MHSbit = dynamic_cast<BitInit*>(MHS);
939 BitInit *RHSbit = dynamic_cast<BitInit*>(RHS);
941 if (MHSbit && RHSbit) {
942 Type = BitRecTy::get();
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 (TernOpInit::get(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 = IntInit::get(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 = StringInit::get(Val);
1059 case tgtok::CodeFragment:
1060 R = CodeInit::get(Lex.getCurStrVal());
1063 case tgtok::question:
1064 R = UnsetInit::get();
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 = new Record("anonymous.val."+utostr(AnonCounter++),
1102 SubClassReference SCRef;
1103 SCRef.RefLoc = NameLoc;
1105 SCRef.TemplateArgs = ValueList;
1106 // Add info about the subclass to NewRec.
1107 if (AddSubClass(NewRec, SCRef))
1109 NewRec->resolveReferences();
1110 Records.addDef(NewRec);
1112 // The result of the expression is a reference to the new record.
1113 return DefInit::get(NewRec);
1115 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
1116 SMLoc BraceLoc = Lex.getLoc();
1117 Lex.Lex(); // eat the '{'
1118 std::vector<Init*> Vals;
1120 if (Lex.getCode() != tgtok::r_brace) {
1121 Vals = ParseValueList(CurRec);
1122 if (Vals.empty()) return 0;
1124 if (Lex.getCode() != tgtok::r_brace) {
1125 TokError("expected '}' at end of bit list value");
1128 Lex.Lex(); // eat the '}'
1130 SmallVector<Init *, 16> NewBits(Vals.size());
1132 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1133 Init *Bit = Vals[i]->convertInitializerTo(BitRecTy::get());
1135 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1136 ") is not convertable to a bit");
1139 NewBits[Vals.size()-i-1] = Bit;
1141 return BitsInit::get(NewBits);
1143 case tgtok::l_square: { // Value ::= '[' ValueList ']'
1144 Lex.Lex(); // eat the '['
1145 std::vector<Init*> Vals;
1147 RecTy *DeducedEltTy = 0;
1148 ListRecTy *GivenListTy = 0;
1150 if (ItemType != 0) {
1151 ListRecTy *ListType = dynamic_cast<ListRecTy*>(ItemType);
1152 if (ListType == 0) {
1153 std::stringstream s;
1154 s << "Type mismatch for list, expected list type, got "
1155 << ItemType->getAsString();
1159 GivenListTy = ListType;
1162 if (Lex.getCode() != tgtok::r_square) {
1163 Vals = ParseValueList(CurRec, 0,
1164 GivenListTy ? GivenListTy->getElementType() : 0);
1165 if (Vals.empty()) return 0;
1167 if (Lex.getCode() != tgtok::r_square) {
1168 TokError("expected ']' at end of list value");
1171 Lex.Lex(); // eat the ']'
1173 RecTy *GivenEltTy = 0;
1174 if (Lex.getCode() == tgtok::less) {
1175 // Optional list element type
1176 Lex.Lex(); // eat the '<'
1178 GivenEltTy = ParseType();
1179 if (GivenEltTy == 0) {
1180 // Couldn't parse element type
1184 if (Lex.getCode() != tgtok::greater) {
1185 TokError("expected '>' at end of list element type");
1188 Lex.Lex(); // eat the '>'
1193 for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1196 TypedInit *TArg = dynamic_cast<TypedInit*>(*i);
1198 TokError("Untyped list element");
1202 EltTy = resolveTypes(EltTy, TArg->getType());
1204 TokError("Incompatible types in list elements");
1208 EltTy = TArg->getType();
1212 if (GivenEltTy != 0) {
1214 // Verify consistency
1215 if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1216 TokError("Incompatible types in list elements");
1224 if (ItemType == 0) {
1225 TokError("No type for list");
1228 DeducedEltTy = GivenListTy->getElementType();
1230 // Make sure the deduced type is compatible with the given type
1232 if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1233 TokError("Element type mismatch for list");
1237 DeducedEltTy = EltTy;
1240 return ListInit::get(Vals, DeducedEltTy);
1242 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
1243 Lex.Lex(); // eat the '('
1244 if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1245 TokError("expected identifier in dag init");
1249 Init *Operator = ParseValue(CurRec);
1250 if (Operator == 0) return 0;
1252 // If the operator name is present, parse it.
1253 std::string OperatorName;
1254 if (Lex.getCode() == tgtok::colon) {
1255 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1256 TokError("expected variable name in dag operator");
1259 OperatorName = Lex.getCurStrVal();
1260 Lex.Lex(); // eat the VarName.
1263 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1264 if (Lex.getCode() != tgtok::r_paren) {
1265 DagArgs = ParseDagArgList(CurRec);
1266 if (DagArgs.empty()) return 0;
1269 if (Lex.getCode() != tgtok::r_paren) {
1270 TokError("expected ')' in dag init");
1273 Lex.Lex(); // eat the ')'
1275 return DagInit::get(Operator, OperatorName, DagArgs);
1281 case tgtok::XCast: // Value ::= !unop '(' Value ')'
1282 case tgtok::XConcat:
1287 case tgtok::XStrConcat: // Value ::= !binop '(' Value ',' Value ')'
1289 case tgtok::XForEach:
1290 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1291 return ParseOperation(CurRec);
1298 /// ParseValue - Parse a tblgen value. This returns null on error.
1300 /// Value ::= SimpleValue ValueSuffix*
1301 /// ValueSuffix ::= '{' BitList '}'
1302 /// ValueSuffix ::= '[' BitList ']'
1303 /// ValueSuffix ::= '.' ID
1305 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType) {
1306 Init *Result = ParseSimpleValue(CurRec, ItemType);
1307 if (Result == 0) return 0;
1309 // Parse the suffixes now if present.
1311 switch (Lex.getCode()) {
1312 default: return Result;
1313 case tgtok::l_brace: {
1314 SMLoc CurlyLoc = Lex.getLoc();
1315 Lex.Lex(); // eat the '{'
1316 std::vector<unsigned> Ranges = ParseRangeList();
1317 if (Ranges.empty()) return 0;
1319 // Reverse the bitlist.
1320 std::reverse(Ranges.begin(), Ranges.end());
1321 Result = Result->convertInitializerBitRange(Ranges);
1323 Error(CurlyLoc, "Invalid bit range for value");
1328 if (Lex.getCode() != tgtok::r_brace) {
1329 TokError("expected '}' at end of bit range list");
1335 case tgtok::l_square: {
1336 SMLoc SquareLoc = Lex.getLoc();
1337 Lex.Lex(); // eat the '['
1338 std::vector<unsigned> Ranges = ParseRangeList();
1339 if (Ranges.empty()) return 0;
1341 Result = Result->convertInitListSlice(Ranges);
1343 Error(SquareLoc, "Invalid range for list slice");
1348 if (Lex.getCode() != tgtok::r_square) {
1349 TokError("expected ']' at end of list slice");
1356 if (Lex.Lex() != tgtok::Id) { // eat the .
1357 TokError("expected field identifier after '.'");
1360 if (!Result->getFieldType(Lex.getCurStrVal())) {
1361 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1362 Result->getAsString() + "'");
1365 Result = FieldInit::get(Result, Lex.getCurStrVal());
1366 Lex.Lex(); // eat field name
1372 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1374 /// ParseDagArgList ::= Value (':' VARNAME)?
1375 /// ParseDagArgList ::= ParseDagArgList ',' Value (':' VARNAME)?
1376 std::vector<std::pair<llvm::Init*, std::string> >
1377 TGParser::ParseDagArgList(Record *CurRec) {
1378 std::vector<std::pair<llvm::Init*, std::string> > Result;
1381 Init *Val = ParseValue(CurRec);
1382 if (Val == 0) return std::vector<std::pair<llvm::Init*, std::string> >();
1384 // If the variable name is present, add it.
1385 std::string VarName;
1386 if (Lex.getCode() == tgtok::colon) {
1387 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1388 TokError("expected variable name in dag literal");
1389 return std::vector<std::pair<llvm::Init*, std::string> >();
1391 VarName = Lex.getCurStrVal();
1392 Lex.Lex(); // eat the VarName.
1395 Result.push_back(std::make_pair(Val, VarName));
1397 if (Lex.getCode() != tgtok::comma) break;
1398 Lex.Lex(); // eat the ','
1405 /// ParseValueList - Parse a comma separated list of values, returning them as a
1406 /// vector. Note that this always expects to be able to parse at least one
1407 /// value. It returns an empty list if this is not possible.
1409 /// ValueList ::= Value (',' Value)
1411 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1413 std::vector<Init*> Result;
1414 RecTy *ItemType = EltTy;
1415 unsigned int ArgN = 0;
1416 if (ArgsRec != 0 && EltTy == 0) {
1417 const std::vector<std::string> &TArgs = ArgsRec->getTemplateArgs();
1418 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1420 errs() << "Cannot find template arg " << ArgN << " (" << TArgs[ArgN]
1423 assert(RV && "Template argument record not found??");
1424 ItemType = RV->getType();
1427 Result.push_back(ParseValue(CurRec, ItemType));
1428 if (Result.back() == 0) return std::vector<Init*>();
1430 while (Lex.getCode() == tgtok::comma) {
1431 Lex.Lex(); // Eat the comma
1433 if (ArgsRec != 0 && EltTy == 0) {
1434 const std::vector<std::string> &TArgs = ArgsRec->getTemplateArgs();
1435 if (ArgN >= TArgs.size()) {
1436 TokError("too many template arguments");
1437 return std::vector<Init*>();
1439 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1440 assert(RV && "Template argument record not found??");
1441 ItemType = RV->getType();
1444 Result.push_back(ParseValue(CurRec, ItemType));
1445 if (Result.back() == 0) return std::vector<Init*>();
1452 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1453 /// empty string on error. This can happen in a number of different context's,
1454 /// including within a def or in the template args for a def (which which case
1455 /// CurRec will be non-null) and within the template args for a multiclass (in
1456 /// which case CurRec will be null, but CurMultiClass will be set). This can
1457 /// also happen within a def that is within a multiclass, which will set both
1458 /// CurRec and CurMultiClass.
1460 /// Declaration ::= FIELD? Type ID ('=' Value)?
1462 std::string TGParser::ParseDeclaration(Record *CurRec,
1463 bool ParsingTemplateArgs) {
1464 // Read the field prefix if present.
1465 bool HasField = Lex.getCode() == tgtok::Field;
1466 if (HasField) Lex.Lex();
1468 RecTy *Type = ParseType();
1469 if (Type == 0) return "";
1471 if (Lex.getCode() != tgtok::Id) {
1472 TokError("Expected identifier in declaration");
1476 SMLoc IdLoc = Lex.getLoc();
1477 std::string DeclName = Lex.getCurStrVal();
1480 if (ParsingTemplateArgs) {
1482 DeclName = CurRec->getName() + ":" + DeclName;
1484 assert(CurMultiClass);
1487 DeclName = CurMultiClass->Rec.getName() + "::" + DeclName;
1491 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1494 // If a value is present, parse it.
1495 if (Lex.getCode() == tgtok::equal) {
1497 SMLoc ValLoc = Lex.getLoc();
1498 Init *Val = ParseValue(CurRec, Type);
1500 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1507 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1508 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
1509 /// template args for a def, which may or may not be in a multiclass. If null,
1510 /// these are the template args for a multiclass.
1512 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1514 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1515 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1516 Lex.Lex(); // eat the '<'
1518 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1520 // Read the first declaration.
1521 std::string TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1522 if (TemplArg.empty())
1525 TheRecToAddTo->addTemplateArg(TemplArg);
1527 while (Lex.getCode() == tgtok::comma) {
1528 Lex.Lex(); // eat the ','
1530 // Read the following declarations.
1531 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1532 if (TemplArg.empty())
1534 TheRecToAddTo->addTemplateArg(TemplArg);
1537 if (Lex.getCode() != tgtok::greater)
1538 return TokError("expected '>' at end of template argument list");
1539 Lex.Lex(); // eat the '>'.
1544 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1546 /// BodyItem ::= Declaration ';'
1547 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
1548 bool TGParser::ParseBodyItem(Record *CurRec) {
1549 if (Lex.getCode() != tgtok::Let) {
1550 if (ParseDeclaration(CurRec, false).empty())
1553 if (Lex.getCode() != tgtok::semi)
1554 return TokError("expected ';' after declaration");
1559 // LET ID OptionalRangeList '=' Value ';'
1560 if (Lex.Lex() != tgtok::Id)
1561 return TokError("expected field identifier after let");
1563 SMLoc IdLoc = Lex.getLoc();
1564 std::string FieldName = Lex.getCurStrVal();
1565 Lex.Lex(); // eat the field name.
1567 std::vector<unsigned> BitList;
1568 if (ParseOptionalBitList(BitList))
1570 std::reverse(BitList.begin(), BitList.end());
1572 if (Lex.getCode() != tgtok::equal)
1573 return TokError("expected '=' in let expression");
1574 Lex.Lex(); // eat the '='.
1576 RecordVal *Field = CurRec->getValue(FieldName);
1578 return TokError("Value '" + FieldName + "' unknown!");
1580 RecTy *Type = Field->getType();
1582 Init *Val = ParseValue(CurRec, Type);
1583 if (Val == 0) return true;
1585 if (Lex.getCode() != tgtok::semi)
1586 return TokError("expected ';' after let expression");
1589 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1592 /// ParseBody - Read the body of a class or def. Return true on error, false on
1596 /// Body ::= '{' BodyList '}'
1597 /// BodyList BodyItem*
1599 bool TGParser::ParseBody(Record *CurRec) {
1600 // If this is a null definition, just eat the semi and return.
1601 if (Lex.getCode() == tgtok::semi) {
1606 if (Lex.getCode() != tgtok::l_brace)
1607 return TokError("Expected ';' or '{' to start body");
1611 while (Lex.getCode() != tgtok::r_brace)
1612 if (ParseBodyItem(CurRec))
1620 /// ParseObjectBody - Parse the body of a def or class. This consists of an
1621 /// optional ClassList followed by a Body. CurRec is the current def or class
1622 /// that is being parsed.
1624 /// ObjectBody ::= BaseClassList Body
1625 /// BaseClassList ::= /*empty*/
1626 /// BaseClassList ::= ':' BaseClassListNE
1627 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1629 bool TGParser::ParseObjectBody(Record *CurRec) {
1630 // If there is a baseclass list, read it.
1631 if (Lex.getCode() == tgtok::colon) {
1634 // Read all of the subclasses.
1635 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1638 if (SubClass.Rec == 0) return true;
1641 if (AddSubClass(CurRec, SubClass))
1644 if (Lex.getCode() != tgtok::comma) break;
1645 Lex.Lex(); // eat ','.
1646 SubClass = ParseSubClassReference(CurRec, false);
1650 // Process any variables on the let stack.
1651 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1652 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1653 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1654 LetStack[i][j].Bits, LetStack[i][j].Value))
1657 return ParseBody(CurRec);
1660 /// ParseDef - Parse and return a top level or multiclass def, return the record
1661 /// corresponding to it. This returns null on error.
1663 /// DefInst ::= DEF ObjectName ObjectBody
1665 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
1666 SMLoc DefLoc = Lex.getLoc();
1667 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1668 Lex.Lex(); // Eat the 'def' token.
1670 // Parse ObjectName and make a record for it.
1671 Record *CurRec = new Record(ParseObjectName(), DefLoc, Records);
1673 if (!CurMultiClass) {
1674 // Top-level def definition.
1676 // Ensure redefinition doesn't happen.
1677 if (Records.getDef(CurRec->getName())) {
1678 Error(DefLoc, "def '" + CurRec->getName() + "' already defined");
1681 Records.addDef(CurRec);
1683 // Otherwise, a def inside a multiclass, add it to the multiclass.
1684 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1685 if (CurMultiClass->DefPrototypes[i]->getName() == CurRec->getName()) {
1686 Error(DefLoc, "def '" + CurRec->getName() +
1687 "' already defined in this multiclass!");
1690 CurMultiClass->DefPrototypes.push_back(CurRec);
1693 if (ParseObjectBody(CurRec))
1696 if (CurMultiClass == 0) // Def's in multiclasses aren't really defs.
1697 // See Record::setName(). This resolve step will see any new name
1698 // for the def that might have been created when resolving
1699 // inheritance, values and arguments above.
1700 CurRec->resolveReferences();
1702 // If ObjectBody has template arguments, it's an error.
1703 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1705 if (CurMultiClass) {
1706 // Copy the template arguments for the multiclass into the def.
1707 const std::vector<std::string> &TArgs =
1708 CurMultiClass->Rec.getTemplateArgs();
1710 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1711 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1712 assert(RV && "Template arg doesn't exist?");
1713 CurRec->addValue(*RV);
1721 /// ParseMultiDef - Parse and return a multiclass multidef, return the record
1722 /// corresponding to it. This returns null on error.
1724 /// MultiDefInst ::= MULTIDEF ObjectName '<' Value ',' Declaration ','
1725 /// Value '>' ObjectBody
1727 bool TGParser::ParseMultiDef(MultiClass *CurMultiClass) {
1728 assert(CurMultiClass && "No multiclass for multidef!");
1730 SMLoc DefLoc = Lex.getLoc();
1731 assert(Lex.getCode() == tgtok::MultiDef && "Unknown tok");
1732 Lex.Lex(); // Eat the 'multidef' token.
1734 // Parse ObjectName and make a record for it.
1735 Record *CurRec = new Record(ParseObjectName(), DefLoc, Records);
1737 if (Lex.getCode() != tgtok::less)
1738 return TokError("multidef init requires a non-empty list of values");
1739 Lex.Lex(); // Eat the '<'
1741 Init *ListI = ParseValue(CurRec, 0);
1743 return TokError("First multidef init must be of list type");
1745 if (Lex.getCode() != tgtok::comma)
1746 return TokError("expected comma in multidef");
1747 Lex.Lex(); // Eat the comma
1749 std::string ItemName = ParseDeclaration(CurRec, false/*Not a template arg*/);
1750 if (ItemName.empty())
1751 return TokError("expected declaration in multidef");
1753 if (Lex.getCode() != tgtok::comma)
1754 return TokError("expected comma in multidef");
1755 Lex.Lex(); // Eat the comma
1757 Init *IntI = ParseValue(CurRec, 0);
1759 return TokError("expected integer value in multidef");
1761 if (Lex.getCode() != tgtok::greater)
1762 return TokError("multidef init requires a non-empty list of values");
1763 Lex.Lex(); // Eat the '>'
1765 TypedInit *List = dynamic_cast<TypedInit *>(ListI);
1766 if (dynamic_cast<ListRecTy *>(List->getType()) == 0)
1767 return TokError("First multidef init must be of list type");
1769 IntInit *Int = dynamic_cast<IntInit *>(IntI);
1771 return TokError("Second multidef init must be a constant integer");
1773 // Add it to the multiclass.
1774 for (unsigned i = 0, e = CurMultiClass->MultiDefPrototypes.size();
1776 if (CurMultiClass->MultiDefPrototypes[i].Rec->getName()
1777 == CurRec->getName())
1778 return Error(DefLoc, "multidef '" + CurRec->getName() +
1779 "' already defined in this multiclass!");
1781 CurMultiClass->MultiDefPrototypes.push_back(
1782 MultiClass::MultiDef(CurRec, List, Int, ItemName));
1784 if (ParseObjectBody(CurRec))
1787 // If ObjectBody has template arguments, it's an error.
1788 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1790 // Copy the template arguments for the multiclass into the
1792 const std::vector<std::string> &TArgs = CurMultiClass->Rec.getTemplateArgs();
1794 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1795 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1796 assert(RV && "Template arg doesn't exist?");
1797 CurRec->addValue(*RV);
1804 /// ParseClass - Parse a tblgen class definition.
1806 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
1808 bool TGParser::ParseClass() {
1809 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
1812 if (Lex.getCode() != tgtok::Id)
1813 return TokError("expected class name after 'class' keyword");
1815 Record *CurRec = Records.getClass(Lex.getCurStrVal());
1817 // If the body was previously defined, this is an error.
1818 if (!CurRec->getValues().empty() ||
1819 !CurRec->getSuperClasses().empty() ||
1820 !CurRec->getTemplateArgs().empty())
1821 return TokError("Class '" + CurRec->getName() + "' already defined");
1823 // If this is the first reference to this class, create and add it.
1824 CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc(), Records);
1825 Records.addClass(CurRec);
1827 Lex.Lex(); // eat the name.
1829 // If there are template args, parse them.
1830 if (Lex.getCode() == tgtok::less)
1831 if (ParseTemplateArgList(CurRec))
1834 // Finally, parse the object body.
1835 return ParseObjectBody(CurRec);
1838 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
1841 /// LetList ::= LetItem (',' LetItem)*
1842 /// LetItem ::= ID OptionalRangeList '=' Value
1844 std::vector<LetRecord> TGParser::ParseLetList() {
1845 std::vector<LetRecord> Result;
1848 if (Lex.getCode() != tgtok::Id) {
1849 TokError("expected identifier in let definition");
1850 return std::vector<LetRecord>();
1852 std::string Name = Lex.getCurStrVal();
1853 SMLoc NameLoc = Lex.getLoc();
1854 Lex.Lex(); // Eat the identifier.
1856 // Check for an optional RangeList.
1857 std::vector<unsigned> Bits;
1858 if (ParseOptionalRangeList(Bits))
1859 return std::vector<LetRecord>();
1860 std::reverse(Bits.begin(), Bits.end());
1862 if (Lex.getCode() != tgtok::equal) {
1863 TokError("expected '=' in let expression");
1864 return std::vector<LetRecord>();
1866 Lex.Lex(); // eat the '='.
1868 Init *Val = ParseValue(0);
1869 if (Val == 0) return std::vector<LetRecord>();
1871 // Now that we have everything, add the record.
1872 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
1874 if (Lex.getCode() != tgtok::comma)
1876 Lex.Lex(); // eat the comma.
1880 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
1881 /// different related productions. This works inside multiclasses too.
1883 /// Object ::= LET LetList IN '{' ObjectList '}'
1884 /// Object ::= LET LetList IN Object
1886 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
1887 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
1890 // Add this entry to the let stack.
1891 std::vector<LetRecord> LetInfo = ParseLetList();
1892 if (LetInfo.empty()) return true;
1893 LetStack.push_back(LetInfo);
1895 if (Lex.getCode() != tgtok::In)
1896 return TokError("expected 'in' at end of top-level 'let'");
1899 // If this is a scalar let, just handle it now
1900 if (Lex.getCode() != tgtok::l_brace) {
1901 // LET LetList IN Object
1902 if (ParseObject(CurMultiClass))
1904 } else { // Object ::= LETCommand '{' ObjectList '}'
1905 SMLoc BraceLoc = Lex.getLoc();
1906 // Otherwise, this is a group let.
1907 Lex.Lex(); // eat the '{'.
1909 // Parse the object list.
1910 if (ParseObjectList(CurMultiClass))
1913 if (Lex.getCode() != tgtok::r_brace) {
1914 TokError("expected '}' at end of top level let command");
1915 return Error(BraceLoc, "to match this '{'");
1920 // Outside this let scope, this let block is not active.
1921 LetStack.pop_back();
1925 /// ParseMultiClass - Parse a multiclass definition.
1927 /// MultiClassInst ::= MULTICLASS ID TemplateArgList?
1928 /// ':' BaseMultiClassList '{' MultiClassDef+ '}'
1930 bool TGParser::ParseMultiClass() {
1931 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
1932 Lex.Lex(); // Eat the multiclass token.
1934 if (Lex.getCode() != tgtok::Id)
1935 return TokError("expected identifier after multiclass for name");
1936 std::string Name = Lex.getCurStrVal();
1938 if (MultiClasses.count(Name))
1939 return TokError("multiclass '" + Name + "' already defined");
1941 CurMultiClass = MultiClasses[Name] = new MultiClass(Name,
1942 Lex.getLoc(), Records);
1943 Lex.Lex(); // Eat the identifier.
1945 // If there are template args, parse them.
1946 if (Lex.getCode() == tgtok::less)
1947 if (ParseTemplateArgList(0))
1950 bool inherits = false;
1952 // If there are submulticlasses, parse them.
1953 if (Lex.getCode() == tgtok::colon) {
1958 // Read all of the submulticlasses.
1959 SubMultiClassReference SubMultiClass =
1960 ParseSubMultiClassReference(CurMultiClass);
1963 if (SubMultiClass.MC == 0) return true;
1966 if (AddSubMultiClass(CurMultiClass, SubMultiClass))
1969 if (Lex.getCode() != tgtok::comma) break;
1970 Lex.Lex(); // eat ','.
1971 SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
1975 if (Lex.getCode() != tgtok::l_brace) {
1977 return TokError("expected '{' in multiclass definition");
1978 else if (Lex.getCode() != tgtok::semi)
1979 return TokError("expected ';' in multiclass definition");
1981 Lex.Lex(); // eat the ';'.
1983 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
1984 return TokError("multiclass must contain at least one def");
1986 while (Lex.getCode() != tgtok::r_brace) {
1987 switch (Lex.getCode()) {
1989 return TokError("expected 'let', 'def', 'defm' or 'multidef'"
1990 "in multiclass body");
1994 case tgtok::MultiDef:
1995 if (ParseObject(CurMultiClass))
2000 Lex.Lex(); // eat the '}'.
2008 InstantiateMulticlassDef(MultiClass &MC,
2010 const std::string &DefmPrefix,
2011 SMLoc DefmPrefixLoc) {
2012 // Add in the defm name. If the defm prefix is empty, give each
2013 // instantiated def a unique name. Otherwise, if "#NAME#" exists in the
2014 // name, substitute the prefix for #NAME#. Otherwise, use the defm name
2016 std::string DefName = DefProto->getName();
2017 if (DefmPrefix.empty()) {
2018 DefName = GetNewAnonymousName();
2020 std::string::size_type idx = DefName.find("#NAME#");
2021 if (idx != std::string::npos) {
2022 DefName.replace(idx, 6, DefmPrefix);
2024 // Add the suffix to the defm name to get the new name.
2025 DefName = DefmPrefix + DefName;
2029 Record *CurRec = new Record(DefName, DefmPrefixLoc, Records);
2031 SubClassReference Ref;
2032 Ref.RefLoc = DefmPrefixLoc;
2034 AddSubClass(CurRec, Ref);
2039 bool TGParser::ResolveMulticlassDefArgs(MultiClass &MC,
2041 SMLoc DefmPrefixLoc,
2043 const std::vector<std::string> &TArgs,
2044 std::vector<Init *> &TemplateVals,
2046 // Loop over all of the template arguments, setting them to the specified
2047 // value or leaving them as the default if necessary.
2048 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2049 // Check if a value is specified for this temp-arg.
2050 if (i < TemplateVals.size()) {
2052 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
2057 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
2061 CurRec->removeValue(TArgs[i]);
2063 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2064 return Error(SubClassLoc, "value not specified for template argument #"+
2065 utostr(i) + " (" + TArgs[i] + ") of multiclassclass '" +
2066 MC.Rec.getName() + "'");
2072 bool TGParser::ResolveMulticlassDef(MultiClass &MC,
2075 SMLoc DefmPrefixLoc) {
2076 // If the mdef is inside a 'let' expression, add to each def.
2077 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
2078 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
2079 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
2080 LetStack[i][j].Bits, LetStack[i][j].Value))
2081 return Error(DefmPrefixLoc, "when instantiating this defm");
2083 // Ensure redefinition doesn't happen.
2084 if (Records.getDef(CurRec->getName()))
2085 return Error(DefmPrefixLoc, "def '" + CurRec->getName() +
2086 "' already defined, instantiating defm with subdef '" +
2087 DefProto->getName() + "'");
2089 // Don't create a top level definition for defm inside multiclasses,
2090 // instead, only update the prototypes and bind the template args
2091 // with the new created definition.
2092 if (CurMultiClass) {
2093 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2095 if (CurMultiClass->DefPrototypes[i]->getName() == CurRec->getName())
2096 return Error(DefmPrefixLoc, "defm '" + CurRec->getName() +
2097 "' already defined in this multiclass!");
2098 CurMultiClass->DefPrototypes.push_back(CurRec);
2100 // Copy the template arguments for the multiclass into the new def.
2101 const std::vector<std::string> &TA =
2102 CurMultiClass->Rec.getTemplateArgs();
2104 for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2105 const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2106 assert(RV && "Template arg doesn't exist?");
2107 CurRec->addValue(*RV);
2110 Records.addDef(CurRec);
2116 /// ParseDefm - Parse the instantiation of a multiclass.
2118 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
2120 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
2121 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
2123 std::string DefmPrefix;
2124 if (Lex.Lex() == tgtok::Id) { // eat the defm.
2125 DefmPrefix = Lex.getCurStrVal();
2126 Lex.Lex(); // Eat the defm prefix.
2129 SMLoc DefmPrefixLoc = Lex.getLoc();
2130 if (Lex.getCode() != tgtok::colon)
2131 return TokError("expected ':' after defm identifier");
2133 // Keep track of the new generated record definitions.
2134 std::vector<Record*> NewRecDefs;
2136 // This record also inherits from a regular class (non-multiclass)?
2137 bool InheritFromClass = false;
2142 SMLoc SubClassLoc = Lex.getLoc();
2143 SubClassReference Ref = ParseSubClassReference(0, true);
2146 if (Ref.Rec == 0) return true;
2148 // To instantiate a multiclass, we need to first get the multiclass, then
2149 // instantiate each def contained in the multiclass with the SubClassRef
2150 // template parameters.
2151 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
2152 assert(MC && "Didn't lookup multiclass correctly?");
2153 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
2155 // Verify that the correct number of template arguments were specified.
2156 const std::vector<std::string> &TArgs = MC->Rec.getTemplateArgs();
2157 if (TArgs.size() < TemplateVals.size())
2158 return Error(SubClassLoc,
2159 "more template args specified than multiclass expects");
2161 // Loop over all the def's in the multiclass, instantiating each one.
2162 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
2163 Record *DefProto = MC->DefPrototypes[i];
2165 Record *CurRec = InstantiateMulticlassDef(*MC, DefProto, DefmPrefix, DefmPrefixLoc);
2167 if (ResolveMulticlassDefArgs(*MC, CurRec, DefmPrefixLoc, SubClassLoc,
2168 TArgs, TemplateVals, true/*Delete args*/))
2169 return Error(SubClassLoc, "could not instantiate def");
2171 if (ResolveMulticlassDef(*MC, CurRec, DefProto, DefmPrefixLoc))
2172 return Error(SubClassLoc, "could not instantiate def");
2174 NewRecDefs.push_back(CurRec);
2178 if (Lex.getCode() != tgtok::comma) break;
2179 Lex.Lex(); // eat ','.
2181 SubClassLoc = Lex.getLoc();
2183 // A defm can inherit from regular classes (non-multiclass) as
2184 // long as they come in the end of the inheritance list.
2185 InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != 0);
2187 if (InheritFromClass)
2190 Ref = ParseSubClassReference(0, true);
2193 if (InheritFromClass) {
2194 // Process all the classes to inherit as if they were part of a
2195 // regular 'def' and inherit all record values.
2196 SubClassReference SubClass = ParseSubClassReference(0, false);
2199 if (SubClass.Rec == 0) return true;
2201 // Get the expanded definition prototypes and teach them about
2202 // the record values the current class to inherit has
2203 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2204 Record *CurRec = NewRecDefs[i];
2207 if (AddSubClass(CurRec, SubClass))
2210 // Process any variables on the let stack.
2211 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
2212 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
2213 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
2214 LetStack[i][j].Bits, LetStack[i][j].Value))
2218 if (Lex.getCode() != tgtok::comma) break;
2219 Lex.Lex(); // eat ','.
2220 SubClass = ParseSubClassReference(0, false);
2225 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2226 // See Record::setName(). This resolve step will see any new
2227 // name for the def that might have been created when resolving
2228 // inheritance, values and arguments above.
2229 NewRecDefs[i]->resolveReferences();
2231 if (Lex.getCode() != tgtok::semi)
2232 return TokError("expected ';' at end of defm");
2239 /// Object ::= ClassInst
2240 /// Object ::= DefInst
2241 /// Object ::= MultiDefInst
2242 /// Object ::= MultiClassInst
2243 /// Object ::= DefMInst
2244 /// Object ::= LETCommand '{' ObjectList '}'
2245 /// Object ::= LETCommand Object
2246 bool TGParser::ParseObject(MultiClass *MC) {
2247 switch (Lex.getCode()) {
2249 return TokError("Expected class, def, defm, multiclass or let definition");
2250 case tgtok::Let: return ParseTopLevelLet(MC);
2251 case tgtok::Def: return ParseDef(MC);
2252 case tgtok::MultiDef: return ParseMultiDef(MC);
2253 case tgtok::Defm: return ParseDefm(MC);
2254 case tgtok::Class: return ParseClass();
2255 case tgtok::MultiClass: return ParseMultiClass();
2260 /// ObjectList :== Object*
2261 bool TGParser::ParseObjectList(MultiClass *MC) {
2262 while (isObjectStart(Lex.getCode())) {
2263 if (ParseObject(MC))
2269 bool TGParser::ParseFile() {
2270 Lex.Lex(); // Prime the lexer.
2271 if (ParseObjectList()) return true;
2273 // If we have unread input at the end of the file, report it.
2274 if (Lex.getCode() == tgtok::Eof)
2277 return TokError("Unexpected input at top level");