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/ADT/SmallVector.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/TableGen/Record.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.getNameInit())) {
68 // The value already exists in the class, treat this as a set.
69 if (ERV->setValue(RV.getValue()))
70 return Error(Loc, "New definition of '" + RV.getName() + "' of type '" +
71 RV.getType()->getAsString() + "' is incompatible with " +
72 "previous definition of type '" +
73 ERV->getType()->getAsString() + "'");
81 /// Return true on error, false on success.
82 bool TGParser::SetValue(Record *CurRec, SMLoc Loc, Init *ValName,
83 const std::vector<unsigned> &BitList, Init *V) {
86 if (CurRec == 0) CurRec = &CurMultiClass->Rec;
88 RecordVal *RV = CurRec->getValue(ValName);
90 return Error(Loc, "Value '" + ValName->getAsUnquotedString()
93 // Do not allow assignments like 'X = X'. This will just cause infinite loops
94 // in the resolution machinery.
96 if (VarInit *VI = dyn_cast<VarInit>(V))
97 if (VI->getNameInit() == ValName)
100 // If we are assigning to a subset of the bits in the value... then we must be
101 // assigning to a field of BitsRecTy, which must have a BitsInit
104 if (!BitList.empty()) {
105 BitsInit *CurVal = dyn_cast<BitsInit>(RV->getValue());
107 return Error(Loc, "Value '" + ValName->getAsUnquotedString()
108 + "' is not a bits type");
110 // Convert the incoming value to a bits type of the appropriate size...
111 Init *BI = V->convertInitializerTo(BitsRecTy::get(BitList.size()));
113 return Error(Loc, "Initializer is not compatible with bit range");
116 // We should have a BitsInit type now.
117 BitsInit *BInit = dyn_cast<BitsInit>(BI);
120 SmallVector<Init *, 16> NewBits(CurVal->getNumBits());
122 // Loop over bits, assigning values as appropriate.
123 for (unsigned i = 0, e = BitList.size(); i != e; ++i) {
124 unsigned Bit = BitList[i];
126 return Error(Loc, "Cannot set bit #" + utostr(Bit) + " of value '" +
127 ValName->getAsUnquotedString() + "' more than once");
128 NewBits[Bit] = BInit->getBit(i);
131 for (unsigned i = 0, e = CurVal->getNumBits(); i != e; ++i)
133 NewBits[i] = CurVal->getBit(i);
135 V = BitsInit::get(NewBits);
139 return Error(Loc, "Value '" + ValName->getAsUnquotedString() + "' of type '"
140 + RV->getType()->getAsString() +
141 "' is incompatible with initializer '" + V->getAsString()
146 /// AddSubClass - Add SubClass as a subclass to CurRec, resolving its template
147 /// args as SubClass's template arguments.
148 bool TGParser::AddSubClass(Record *CurRec, SubClassReference &SubClass) {
149 Record *SC = SubClass.Rec;
150 // Add all of the values in the subclass into the current class.
151 const std::vector<RecordVal> &Vals = SC->getValues();
152 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
153 if (AddValue(CurRec, SubClass.RefRange.Start, Vals[i]))
156 const std::vector<Init *> &TArgs = SC->getTemplateArgs();
158 // Ensure that an appropriate number of template arguments are specified.
159 if (TArgs.size() < SubClass.TemplateArgs.size())
160 return Error(SubClass.RefRange.Start,
161 "More template args specified than expected");
163 // Loop over all of the template arguments, setting them to the specified
164 // value or leaving them as the default if necessary.
165 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
166 if (i < SubClass.TemplateArgs.size()) {
167 // If a value is specified for this template arg, set it now.
168 if (SetValue(CurRec, SubClass.RefRange.Start, TArgs[i],
169 std::vector<unsigned>(), SubClass.TemplateArgs[i]))
173 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
176 CurRec->removeValue(TArgs[i]);
178 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
179 return Error(SubClass.RefRange.Start,
180 "Value not specified for template argument #"
181 + utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
182 + ") of subclass '" + SC->getNameInitAsString() + "'!");
186 // Since everything went well, we can now set the "superclass" list for the
188 const std::vector<Record*> &SCs = SC->getSuperClasses();
189 ArrayRef<SMRange> SCRanges = SC->getSuperClassRanges();
190 for (unsigned i = 0, e = SCs.size(); i != e; ++i) {
191 if (CurRec->isSubClassOf(SCs[i]))
192 return Error(SubClass.RefRange.Start,
193 "Already subclass of '" + SCs[i]->getName() + "'!\n");
194 CurRec->addSuperClass(SCs[i], SCRanges[i]);
197 if (CurRec->isSubClassOf(SC))
198 return Error(SubClass.RefRange.Start,
199 "Already subclass of '" + SC->getName() + "'!\n");
200 CurRec->addSuperClass(SC, SubClass.RefRange);
204 /// AddSubMultiClass - Add SubMultiClass as a subclass to
205 /// CurMC, resolving its template args as SubMultiClass's
206 /// template arguments.
207 bool TGParser::AddSubMultiClass(MultiClass *CurMC,
208 SubMultiClassReference &SubMultiClass) {
209 MultiClass *SMC = SubMultiClass.MC;
210 Record *CurRec = &CurMC->Rec;
212 const std::vector<RecordVal> &MCVals = CurRec->getValues();
214 // Add all of the values in the subclass into the current class.
215 const std::vector<RecordVal> &SMCVals = SMC->Rec.getValues();
216 for (unsigned i = 0, e = SMCVals.size(); i != e; ++i)
217 if (AddValue(CurRec, SubMultiClass.RefRange.Start, SMCVals[i]))
220 int newDefStart = CurMC->DefPrototypes.size();
222 // Add all of the defs in the subclass into the current multiclass.
223 for (MultiClass::RecordVector::const_iterator i = SMC->DefPrototypes.begin(),
224 iend = SMC->DefPrototypes.end();
227 // Clone the def and add it to the current multiclass
228 Record *NewDef = new Record(**i);
230 // Add all of the values in the superclass into the current def.
231 for (unsigned i = 0, e = MCVals.size(); i != e; ++i)
232 if (AddValue(NewDef, SubMultiClass.RefRange.Start, MCVals[i]))
235 CurMC->DefPrototypes.push_back(NewDef);
238 const std::vector<Init *> &SMCTArgs = SMC->Rec.getTemplateArgs();
240 // Ensure that an appropriate number of template arguments are
242 if (SMCTArgs.size() < SubMultiClass.TemplateArgs.size())
243 return Error(SubMultiClass.RefRange.Start,
244 "More template args specified than expected");
246 // Loop over all of the template arguments, setting them to the specified
247 // value or leaving them as the default if necessary.
248 for (unsigned i = 0, e = SMCTArgs.size(); i != e; ++i) {
249 if (i < SubMultiClass.TemplateArgs.size()) {
250 // If a value is specified for this template arg, set it in the
252 if (SetValue(CurRec, SubMultiClass.RefRange.Start, SMCTArgs[i],
253 std::vector<unsigned>(),
254 SubMultiClass.TemplateArgs[i]))
258 CurRec->resolveReferencesTo(CurRec->getValue(SMCTArgs[i]));
261 CurRec->removeValue(SMCTArgs[i]);
263 // If a value is specified for this template arg, set it in the
265 for (MultiClass::RecordVector::iterator j =
266 CurMC->DefPrototypes.begin() + newDefStart,
267 jend = CurMC->DefPrototypes.end();
272 if (SetValue(Def, SubMultiClass.RefRange.Start, SMCTArgs[i],
273 std::vector<unsigned>(),
274 SubMultiClass.TemplateArgs[i]))
278 Def->resolveReferencesTo(Def->getValue(SMCTArgs[i]));
281 Def->removeValue(SMCTArgs[i]);
283 } else if (!CurRec->getValue(SMCTArgs[i])->getValue()->isComplete()) {
284 return Error(SubMultiClass.RefRange.Start,
285 "Value not specified for template argument #"
286 + utostr(i) + " (" + SMCTArgs[i]->getAsUnquotedString()
287 + ") of subclass '" + SMC->Rec.getNameInitAsString() + "'!");
294 /// ProcessForeachDefs - Given a record, apply all of the variable
295 /// values in all surrounding foreach loops, creating new records for
296 /// each combination of values.
297 bool TGParser::ProcessForeachDefs(Record *CurRec, SMLoc Loc) {
301 // We want to instantiate a new copy of CurRec for each combination
302 // of nested loop iterator values. We don't want top instantiate
303 // any copies until we have values for each loop iterator.
305 return ProcessForeachDefs(CurRec, Loc, IterVals);
308 /// ProcessForeachDefs - Given a record, a loop and a loop iterator,
309 /// apply each of the variable values in this loop and then process
311 bool TGParser::ProcessForeachDefs(Record *CurRec, SMLoc Loc, IterSet &IterVals){
312 // Recursively build a tuple of iterator values.
313 if (IterVals.size() != Loops.size()) {
314 assert(IterVals.size() < Loops.size());
315 ForeachLoop &CurLoop = Loops[IterVals.size()];
316 ListInit *List = dyn_cast<ListInit>(CurLoop.ListValue);
318 Error(Loc, "Loop list is not a list");
322 // Process each value.
323 for (int64_t i = 0; i < List->getSize(); ++i) {
324 Init *ItemVal = List->resolveListElementReference(*CurRec, 0, i);
325 IterVals.push_back(IterRecord(CurLoop.IterVar, ItemVal));
326 if (ProcessForeachDefs(CurRec, Loc, IterVals))
333 // This is the bottom of the recursion. We have all of the iterator values
334 // for this point in the iteration space. Instantiate a new record to
335 // reflect this combination of values.
336 Record *IterRec = new Record(*CurRec);
338 // Set the iterator values now.
339 for (unsigned i = 0, e = IterVals.size(); i != e; ++i) {
340 VarInit *IterVar = IterVals[i].IterVar;
341 TypedInit *IVal = dyn_cast<TypedInit>(IterVals[i].IterValue);
343 Error(Loc, "foreach iterator value is untyped");
347 IterRec->addValue(RecordVal(IterVar->getName(), IVal->getType(), false));
349 if (SetValue(IterRec, Loc, IterVar->getName(),
350 std::vector<unsigned>(), IVal)) {
351 Error(Loc, "when instantiating this def");
356 IterRec->resolveReferencesTo(IterRec->getValue(IterVar->getName()));
359 IterRec->removeValue(IterVar->getName());
362 if (Records.getDef(IterRec->getNameInitAsString())) {
363 Error(Loc, "def already exists: " + IterRec->getNameInitAsString());
367 Records.addDef(IterRec);
368 IterRec->resolveReferences();
372 //===----------------------------------------------------------------------===//
374 //===----------------------------------------------------------------------===//
376 /// isObjectStart - Return true if this is a valid first token for an Object.
377 static bool isObjectStart(tgtok::TokKind K) {
378 return K == tgtok::Class || K == tgtok::Def ||
379 K == tgtok::Defm || K == tgtok::Let ||
380 K == tgtok::MultiClass || K == tgtok::Foreach;
383 static std::string GetNewAnonymousName() {
384 static unsigned AnonCounter = 0;
385 unsigned Tmp = AnonCounter++; // MSVC2012 ICEs without this.
386 return "anonymous." + utostr(Tmp);
389 /// ParseObjectName - If an object name is specified, return it. Otherwise,
391 /// ObjectName ::= Value [ '#' Value ]*
392 /// ObjectName ::= /*empty*/
394 Init *TGParser::ParseObjectName(MultiClass *CurMultiClass) {
395 switch (Lex.getCode()) {
399 // These are all of the tokens that can begin an object body.
400 // Some of these can also begin values but we disallow those cases
401 // because they are unlikely to be useful.
409 CurRec = &CurMultiClass->Rec;
413 const TypedInit *CurRecName = dyn_cast<TypedInit>(CurRec->getNameInit());
415 TokError("Record name is not typed!");
418 Type = CurRecName->getType();
421 return ParseValue(CurRec, Type, ParseNameMode);
424 /// ParseClassID - Parse and resolve a reference to a class name. This returns
429 Record *TGParser::ParseClassID() {
430 if (Lex.getCode() != tgtok::Id) {
431 TokError("expected name for ClassID");
435 Record *Result = Records.getClass(Lex.getCurStrVal());
437 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
443 /// ParseMultiClassID - Parse and resolve a reference to a multiclass name.
444 /// This returns null on error.
446 /// MultiClassID ::= ID
448 MultiClass *TGParser::ParseMultiClassID() {
449 if (Lex.getCode() != tgtok::Id) {
450 TokError("expected name for MultiClassID");
454 MultiClass *Result = MultiClasses[Lex.getCurStrVal()];
456 TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
462 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
463 /// subclass. This returns a SubClassRefTy with a null Record* on error.
465 /// SubClassRef ::= ClassID
466 /// SubClassRef ::= ClassID '<' ValueList '>'
468 SubClassReference TGParser::
469 ParseSubClassReference(Record *CurRec, bool isDefm) {
470 SubClassReference Result;
471 Result.RefRange.Start = Lex.getLoc();
474 if (MultiClass *MC = ParseMultiClassID())
475 Result.Rec = &MC->Rec;
477 Result.Rec = ParseClassID();
479 if (Result.Rec == 0) return Result;
481 // If there is no template arg list, we're done.
482 if (Lex.getCode() != tgtok::less) {
483 Result.RefRange.End = Lex.getLoc();
486 Lex.Lex(); // Eat the '<'
488 if (Lex.getCode() == tgtok::greater) {
489 TokError("subclass reference requires a non-empty list of template values");
494 Result.TemplateArgs = ParseValueList(CurRec, Result.Rec);
495 if (Result.TemplateArgs.empty()) {
496 Result.Rec = 0; // Error parsing value list.
500 if (Lex.getCode() != tgtok::greater) {
501 TokError("expected '>' in template value list");
506 Result.RefRange.End = Lex.getLoc();
511 /// ParseSubMultiClassReference - Parse a reference to a subclass or to a
512 /// templated submulticlass. This returns a SubMultiClassRefTy with a null
513 /// Record* on error.
515 /// SubMultiClassRef ::= MultiClassID
516 /// SubMultiClassRef ::= MultiClassID '<' ValueList '>'
518 SubMultiClassReference TGParser::
519 ParseSubMultiClassReference(MultiClass *CurMC) {
520 SubMultiClassReference Result;
521 Result.RefRange.Start = Lex.getLoc();
523 Result.MC = ParseMultiClassID();
524 if (Result.MC == 0) return Result;
526 // If there is no template arg list, we're done.
527 if (Lex.getCode() != tgtok::less) {
528 Result.RefRange.End = Lex.getLoc();
531 Lex.Lex(); // Eat the '<'
533 if (Lex.getCode() == tgtok::greater) {
534 TokError("subclass reference requires a non-empty list of template values");
539 Result.TemplateArgs = ParseValueList(&CurMC->Rec, &Result.MC->Rec);
540 if (Result.TemplateArgs.empty()) {
541 Result.MC = 0; // Error parsing value list.
545 if (Lex.getCode() != tgtok::greater) {
546 TokError("expected '>' in template value list");
551 Result.RefRange.End = Lex.getLoc();
556 /// ParseRangePiece - Parse a bit/value range.
557 /// RangePiece ::= INTVAL
558 /// RangePiece ::= INTVAL '-' INTVAL
559 /// RangePiece ::= INTVAL INTVAL
560 bool TGParser::ParseRangePiece(std::vector<unsigned> &Ranges) {
561 if (Lex.getCode() != tgtok::IntVal) {
562 TokError("expected integer or bitrange");
565 int64_t Start = Lex.getCurIntVal();
569 return TokError("invalid range, cannot be negative");
571 switch (Lex.Lex()) { // eat first character.
573 Ranges.push_back(Start);
576 if (Lex.Lex() != tgtok::IntVal) {
577 TokError("expected integer value as end of range");
580 End = Lex.getCurIntVal();
583 End = -Lex.getCurIntVal();
587 return TokError("invalid range, cannot be negative");
592 for (; Start <= End; ++Start)
593 Ranges.push_back(Start);
595 for (; Start >= End; --Start)
596 Ranges.push_back(Start);
601 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
603 /// RangeList ::= RangePiece (',' RangePiece)*
605 std::vector<unsigned> TGParser::ParseRangeList() {
606 std::vector<unsigned> Result;
608 // Parse the first piece.
609 if (ParseRangePiece(Result))
610 return std::vector<unsigned>();
611 while (Lex.getCode() == tgtok::comma) {
612 Lex.Lex(); // Eat the comma.
614 // Parse the next range piece.
615 if (ParseRangePiece(Result))
616 return std::vector<unsigned>();
621 /// ParseOptionalRangeList - Parse either a range list in <>'s or nothing.
622 /// OptionalRangeList ::= '<' RangeList '>'
623 /// OptionalRangeList ::= /*empty*/
624 bool TGParser::ParseOptionalRangeList(std::vector<unsigned> &Ranges) {
625 if (Lex.getCode() != tgtok::less)
628 SMLoc StartLoc = Lex.getLoc();
629 Lex.Lex(); // eat the '<'
631 // Parse the range list.
632 Ranges = ParseRangeList();
633 if (Ranges.empty()) return true;
635 if (Lex.getCode() != tgtok::greater) {
636 TokError("expected '>' at end of range list");
637 return Error(StartLoc, "to match this '<'");
639 Lex.Lex(); // eat the '>'.
643 /// ParseOptionalBitList - Parse either a bit list in {}'s or nothing.
644 /// OptionalBitList ::= '{' RangeList '}'
645 /// OptionalBitList ::= /*empty*/
646 bool TGParser::ParseOptionalBitList(std::vector<unsigned> &Ranges) {
647 if (Lex.getCode() != tgtok::l_brace)
650 SMLoc StartLoc = Lex.getLoc();
651 Lex.Lex(); // eat the '{'
653 // Parse the range list.
654 Ranges = ParseRangeList();
655 if (Ranges.empty()) return true;
657 if (Lex.getCode() != tgtok::r_brace) {
658 TokError("expected '}' at end of bit list");
659 return Error(StartLoc, "to match this '{'");
661 Lex.Lex(); // eat the '}'.
666 /// ParseType - Parse and return a tblgen type. This returns null on error.
668 /// Type ::= STRING // string type
669 /// Type ::= CODE // code type
670 /// Type ::= BIT // bit type
671 /// Type ::= BITS '<' INTVAL '>' // bits<x> type
672 /// Type ::= INT // int type
673 /// Type ::= LIST '<' Type '>' // list<x> type
674 /// Type ::= DAG // dag type
675 /// Type ::= ClassID // Record Type
677 RecTy *TGParser::ParseType() {
678 switch (Lex.getCode()) {
679 default: TokError("Unknown token when expecting a type"); return 0;
680 case tgtok::String: Lex.Lex(); return StringRecTy::get();
681 case tgtok::Code: Lex.Lex(); return StringRecTy::get();
682 case tgtok::Bit: Lex.Lex(); return BitRecTy::get();
683 case tgtok::Int: Lex.Lex(); return IntRecTy::get();
684 case tgtok::Dag: Lex.Lex(); return DagRecTy::get();
686 if (Record *R = ParseClassID()) return RecordRecTy::get(R);
689 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
690 TokError("expected '<' after bits type");
693 if (Lex.Lex() != tgtok::IntVal) { // Eat '<'
694 TokError("expected integer in bits<n> type");
697 uint64_t Val = Lex.getCurIntVal();
698 if (Lex.Lex() != tgtok::greater) { // Eat count.
699 TokError("expected '>' at end of bits<n> type");
702 Lex.Lex(); // Eat '>'
703 return BitsRecTy::get(Val);
706 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
707 TokError("expected '<' after list type");
710 Lex.Lex(); // Eat '<'
711 RecTy *SubType = ParseType();
712 if (SubType == 0) return 0;
714 if (Lex.getCode() != tgtok::greater) {
715 TokError("expected '>' at end of list<ty> type");
718 Lex.Lex(); // Eat '>'
719 return ListRecTy::get(SubType);
724 /// ParseIDValue - Parse an ID as a value and decode what it means.
726 /// IDValue ::= ID [def local value]
727 /// IDValue ::= ID [def template arg]
728 /// IDValue ::= ID [multiclass local value]
729 /// IDValue ::= ID [multiclass template argument]
730 /// IDValue ::= ID [def name]
732 Init *TGParser::ParseIDValue(Record *CurRec, IDParseMode Mode) {
733 assert(Lex.getCode() == tgtok::Id && "Expected ID in ParseIDValue");
734 std::string Name = Lex.getCurStrVal();
735 SMLoc Loc = Lex.getLoc();
737 return ParseIDValue(CurRec, Name, Loc);
740 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
741 /// has already been read.
742 Init *TGParser::ParseIDValue(Record *CurRec,
743 const std::string &Name, SMLoc NameLoc,
746 if (const RecordVal *RV = CurRec->getValue(Name))
747 return VarInit::get(Name, RV->getType());
749 Init *TemplateArgName = QualifyName(*CurRec, CurMultiClass, Name, ":");
752 TemplateArgName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
755 if (CurRec->isTemplateArg(TemplateArgName)) {
756 const RecordVal *RV = CurRec->getValue(TemplateArgName);
757 assert(RV && "Template arg doesn't exist??");
758 return VarInit::get(TemplateArgName, RV->getType());
763 Init *MCName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
766 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
767 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
768 assert(RV && "Template arg doesn't exist??");
769 return VarInit::get(MCName, RV->getType());
773 // If this is in a foreach loop, make sure it's not a loop iterator
774 for (LoopVector::iterator i = Loops.begin(), iend = Loops.end();
777 VarInit *IterVar = dyn_cast<VarInit>(i->IterVar);
778 if (IterVar && IterVar->getName() == Name)
782 if (Mode == ParseNameMode)
783 return StringInit::get(Name);
785 if (Record *D = Records.getDef(Name))
786 return DefInit::get(D);
788 if (Mode == ParseValueMode) {
789 Error(NameLoc, "Variable not defined: '" + Name + "'");
793 return StringInit::get(Name);
796 /// ParseOperation - Parse an operator. This returns null on error.
798 /// Operation ::= XOperator ['<' Type '>'] '(' Args ')'
800 Init *TGParser::ParseOperation(Record *CurRec) {
801 switch (Lex.getCode()) {
803 TokError("unknown operation");
808 case tgtok::XCast: { // Value ::= !unop '(' Value ')'
809 UnOpInit::UnaryOp Code;
812 switch (Lex.getCode()) {
813 default: llvm_unreachable("Unhandled code!");
815 Lex.Lex(); // eat the operation
816 Code = UnOpInit::CAST;
818 Type = ParseOperatorType();
821 TokError("did not get type for unary operator");
827 Lex.Lex(); // eat the operation
828 Code = UnOpInit::HEAD;
831 Lex.Lex(); // eat the operation
832 Code = UnOpInit::TAIL;
835 Lex.Lex(); // eat the operation
836 Code = UnOpInit::EMPTY;
837 Type = IntRecTy::get();
840 if (Lex.getCode() != tgtok::l_paren) {
841 TokError("expected '(' after unary operator");
844 Lex.Lex(); // eat the '('
846 Init *LHS = ParseValue(CurRec);
847 if (LHS == 0) return 0;
849 if (Code == UnOpInit::HEAD
850 || Code == UnOpInit::TAIL
851 || Code == UnOpInit::EMPTY) {
852 ListInit *LHSl = dyn_cast<ListInit>(LHS);
853 StringInit *LHSs = dyn_cast<StringInit>(LHS);
854 TypedInit *LHSt = dyn_cast<TypedInit>(LHS);
855 if (LHSl == 0 && LHSs == 0 && LHSt == 0) {
856 TokError("expected list or string type argument in unary operator");
860 ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
861 StringRecTy *SType = dyn_cast<StringRecTy>(LHSt->getType());
862 if (LType == 0 && SType == 0) {
863 TokError("expected list or string type argumnet in unary operator");
868 if (Code == UnOpInit::HEAD
869 || Code == UnOpInit::TAIL) {
870 if (LHSl == 0 && LHSt == 0) {
871 TokError("expected list type argumnet in unary operator");
875 if (LHSl && LHSl->getSize() == 0) {
876 TokError("empty list argument in unary operator");
880 Init *Item = LHSl->getElement(0);
881 TypedInit *Itemt = dyn_cast<TypedInit>(Item);
883 TokError("untyped list element in unary operator");
886 if (Code == UnOpInit::HEAD) {
887 Type = Itemt->getType();
889 Type = ListRecTy::get(Itemt->getType());
892 assert(LHSt && "expected list type argument in unary operator");
893 ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
895 TokError("expected list type argumnet in unary operator");
898 if (Code == UnOpInit::HEAD) {
899 Type = LType->getElementType();
907 if (Lex.getCode() != tgtok::r_paren) {
908 TokError("expected ')' in unary operator");
911 Lex.Lex(); // eat the ')'
912 return (UnOpInit::get(Code, LHS, Type))->Fold(CurRec, CurMultiClass);
921 case tgtok::XStrConcat: { // Value ::= !binop '(' Value ',' Value ')'
922 tgtok::TokKind OpTok = Lex.getCode();
923 SMLoc OpLoc = Lex.getLoc();
924 Lex.Lex(); // eat the operation
926 BinOpInit::BinaryOp Code;
930 default: llvm_unreachable("Unhandled code!");
931 case tgtok::XConcat: Code = BinOpInit::CONCAT;Type = DagRecTy::get(); break;
932 case tgtok::XADD: Code = BinOpInit::ADD; Type = IntRecTy::get(); break;
933 case tgtok::XSRA: Code = BinOpInit::SRA; Type = IntRecTy::get(); break;
934 case tgtok::XSRL: Code = BinOpInit::SRL; Type = IntRecTy::get(); break;
935 case tgtok::XSHL: Code = BinOpInit::SHL; Type = IntRecTy::get(); break;
936 case tgtok::XEq: Code = BinOpInit::EQ; Type = BitRecTy::get(); break;
937 case tgtok::XStrConcat:
938 Code = BinOpInit::STRCONCAT;
939 Type = StringRecTy::get();
943 if (Lex.getCode() != tgtok::l_paren) {
944 TokError("expected '(' after binary operator");
947 Lex.Lex(); // eat the '('
949 SmallVector<Init*, 2> InitList;
951 InitList.push_back(ParseValue(CurRec));
952 if (InitList.back() == 0) return 0;
954 while (Lex.getCode() == tgtok::comma) {
955 Lex.Lex(); // eat the ','
957 InitList.push_back(ParseValue(CurRec));
958 if (InitList.back() == 0) return 0;
961 if (Lex.getCode() != tgtok::r_paren) {
962 TokError("expected ')' in operator");
965 Lex.Lex(); // eat the ')'
967 // We allow multiple operands to associative operators like !strconcat as
968 // shorthand for nesting them.
969 if (Code == BinOpInit::STRCONCAT) {
970 while (InitList.size() > 2) {
971 Init *RHS = InitList.pop_back_val();
972 RHS = (BinOpInit::get(Code, InitList.back(), RHS, Type))
973 ->Fold(CurRec, CurMultiClass);
974 InitList.back() = RHS;
978 if (InitList.size() == 2)
979 return (BinOpInit::get(Code, InitList[0], InitList[1], Type))
980 ->Fold(CurRec, CurMultiClass);
982 Error(OpLoc, "expected two operands to operator");
987 case tgtok::XForEach:
988 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
989 TernOpInit::TernaryOp Code;
992 tgtok::TokKind LexCode = Lex.getCode();
993 Lex.Lex(); // eat the operation
995 default: llvm_unreachable("Unhandled code!");
997 Code = TernOpInit::IF;
999 case tgtok::XForEach:
1000 Code = TernOpInit::FOREACH;
1003 Code = TernOpInit::SUBST;
1006 if (Lex.getCode() != tgtok::l_paren) {
1007 TokError("expected '(' after ternary operator");
1010 Lex.Lex(); // eat the '('
1012 Init *LHS = ParseValue(CurRec);
1013 if (LHS == 0) return 0;
1015 if (Lex.getCode() != tgtok::comma) {
1016 TokError("expected ',' in ternary operator");
1019 Lex.Lex(); // eat the ','
1021 Init *MHS = ParseValue(CurRec);
1022 if (MHS == 0) return 0;
1024 if (Lex.getCode() != tgtok::comma) {
1025 TokError("expected ',' in ternary operator");
1028 Lex.Lex(); // eat the ','
1030 Init *RHS = ParseValue(CurRec);
1031 if (RHS == 0) return 0;
1033 if (Lex.getCode() != tgtok::r_paren) {
1034 TokError("expected ')' in binary operator");
1037 Lex.Lex(); // eat the ')'
1040 default: llvm_unreachable("Unhandled code!");
1045 if (TypedInit *MHSt = dyn_cast<TypedInit>(MHS))
1046 MHSTy = MHSt->getType();
1047 if (BitsInit *MHSbits = dyn_cast<BitsInit>(MHS))
1048 MHSTy = BitsRecTy::get(MHSbits->getNumBits());
1049 if (isa<BitInit>(MHS))
1050 MHSTy = BitRecTy::get();
1052 if (TypedInit *RHSt = dyn_cast<TypedInit>(RHS))
1053 RHSTy = RHSt->getType();
1054 if (BitsInit *RHSbits = dyn_cast<BitsInit>(RHS))
1055 RHSTy = BitsRecTy::get(RHSbits->getNumBits());
1056 if (isa<BitInit>(RHS))
1057 RHSTy = BitRecTy::get();
1059 // For UnsetInit, it's typed from the other hand.
1060 if (isa<UnsetInit>(MHS))
1062 if (isa<UnsetInit>(RHS))
1065 if (!MHSTy || !RHSTy) {
1066 TokError("could not get type for !if");
1070 if (MHSTy->typeIsConvertibleTo(RHSTy)) {
1072 } else if (RHSTy->typeIsConvertibleTo(MHSTy)) {
1075 TokError("inconsistent types for !if");
1080 case tgtok::XForEach: {
1081 TypedInit *MHSt = dyn_cast<TypedInit>(MHS);
1083 TokError("could not get type for !foreach");
1086 Type = MHSt->getType();
1089 case tgtok::XSubst: {
1090 TypedInit *RHSt = dyn_cast<TypedInit>(RHS);
1092 TokError("could not get type for !subst");
1095 Type = RHSt->getType();
1099 return (TernOpInit::get(Code, LHS, MHS, RHS, Type))->Fold(CurRec,
1105 /// ParseOperatorType - Parse a type for an operator. This returns
1108 /// OperatorType ::= '<' Type '>'
1110 RecTy *TGParser::ParseOperatorType() {
1113 if (Lex.getCode() != tgtok::less) {
1114 TokError("expected type name for operator");
1117 Lex.Lex(); // eat the <
1122 TokError("expected type name for operator");
1126 if (Lex.getCode() != tgtok::greater) {
1127 TokError("expected type name for operator");
1130 Lex.Lex(); // eat the >
1136 /// ParseSimpleValue - Parse a tblgen value. This returns null on error.
1138 /// SimpleValue ::= IDValue
1139 /// SimpleValue ::= INTVAL
1140 /// SimpleValue ::= STRVAL+
1141 /// SimpleValue ::= CODEFRAGMENT
1142 /// SimpleValue ::= '?'
1143 /// SimpleValue ::= '{' ValueList '}'
1144 /// SimpleValue ::= ID '<' ValueListNE '>'
1145 /// SimpleValue ::= '[' ValueList ']'
1146 /// SimpleValue ::= '(' IDValue DagArgList ')'
1147 /// SimpleValue ::= CONCATTOK '(' Value ',' Value ')'
1148 /// SimpleValue ::= ADDTOK '(' Value ',' Value ')'
1149 /// SimpleValue ::= SHLTOK '(' Value ',' Value ')'
1150 /// SimpleValue ::= SRATOK '(' Value ',' Value ')'
1151 /// SimpleValue ::= SRLTOK '(' Value ',' Value ')'
1152 /// SimpleValue ::= STRCONCATTOK '(' Value ',' Value ')'
1154 Init *TGParser::ParseSimpleValue(Record *CurRec, RecTy *ItemType,
1157 switch (Lex.getCode()) {
1158 default: TokError("Unknown token when parsing a value"); break;
1160 // This is a leading paste operation. This is deprecated but
1161 // still exists in some .td files. Ignore it.
1162 Lex.Lex(); // Skip '#'.
1163 return ParseSimpleValue(CurRec, ItemType, Mode);
1164 case tgtok::IntVal: R = IntInit::get(Lex.getCurIntVal()); Lex.Lex(); break;
1165 case tgtok::StrVal: {
1166 std::string Val = Lex.getCurStrVal();
1169 // Handle multiple consecutive concatenated strings.
1170 while (Lex.getCode() == tgtok::StrVal) {
1171 Val += Lex.getCurStrVal();
1175 R = StringInit::get(Val);
1178 case tgtok::CodeFragment:
1179 R = StringInit::get(Lex.getCurStrVal());
1182 case tgtok::question:
1183 R = UnsetInit::get();
1187 SMLoc NameLoc = Lex.getLoc();
1188 std::string Name = Lex.getCurStrVal();
1189 if (Lex.Lex() != tgtok::less) // consume the Id.
1190 return ParseIDValue(CurRec, Name, NameLoc, Mode); // Value ::= IDValue
1192 // Value ::= ID '<' ValueListNE '>'
1193 if (Lex.Lex() == tgtok::greater) {
1194 TokError("expected non-empty value list");
1198 // This is a CLASS<initvalslist> expression. This is supposed to synthesize
1199 // a new anonymous definition, deriving from CLASS<initvalslist> with no
1201 Record *Class = Records.getClass(Name);
1203 Error(NameLoc, "Expected a class name, got '" + Name + "'");
1207 std::vector<Init*> ValueList = ParseValueList(CurRec, Class);
1208 if (ValueList.empty()) return 0;
1210 if (Lex.getCode() != tgtok::greater) {
1211 TokError("expected '>' at end of value list");
1214 Lex.Lex(); // eat the '>'
1215 SMLoc EndLoc = Lex.getLoc();
1217 // Create the new record, set it as CurRec temporarily.
1218 static unsigned AnonCounter = 0;
1219 Record *NewRec = new Record("anonymous.val."+utostr(AnonCounter++),
1222 /*IsAnonymous=*/true);
1223 SubClassReference SCRef;
1224 SCRef.RefRange = SMRange(NameLoc, EndLoc);
1226 SCRef.TemplateArgs = ValueList;
1227 // Add info about the subclass to NewRec.
1228 if (AddSubClass(NewRec, SCRef))
1230 NewRec->resolveReferences();
1231 Records.addDef(NewRec);
1233 // The result of the expression is a reference to the new record.
1234 return DefInit::get(NewRec);
1236 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
1237 SMLoc BraceLoc = Lex.getLoc();
1238 Lex.Lex(); // eat the '{'
1239 std::vector<Init*> Vals;
1241 if (Lex.getCode() != tgtok::r_brace) {
1242 Vals = ParseValueList(CurRec);
1243 if (Vals.empty()) return 0;
1245 if (Lex.getCode() != tgtok::r_brace) {
1246 TokError("expected '}' at end of bit list value");
1249 Lex.Lex(); // eat the '}'
1251 SmallVector<Init *, 16> NewBits(Vals.size());
1253 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1254 Init *Bit = Vals[i]->convertInitializerTo(BitRecTy::get());
1256 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1257 ") is not convertable to a bit");
1260 NewBits[Vals.size()-i-1] = Bit;
1262 return BitsInit::get(NewBits);
1264 case tgtok::l_square: { // Value ::= '[' ValueList ']'
1265 Lex.Lex(); // eat the '['
1266 std::vector<Init*> Vals;
1268 RecTy *DeducedEltTy = 0;
1269 ListRecTy *GivenListTy = 0;
1271 if (ItemType != 0) {
1272 ListRecTy *ListType = dyn_cast<ListRecTy>(ItemType);
1273 if (ListType == 0) {
1275 raw_string_ostream ss(s);
1276 ss << "Type mismatch for list, expected list type, got "
1277 << ItemType->getAsString();
1281 GivenListTy = ListType;
1284 if (Lex.getCode() != tgtok::r_square) {
1285 Vals = ParseValueList(CurRec, 0,
1286 GivenListTy ? GivenListTy->getElementType() : 0);
1287 if (Vals.empty()) return 0;
1289 if (Lex.getCode() != tgtok::r_square) {
1290 TokError("expected ']' at end of list value");
1293 Lex.Lex(); // eat the ']'
1295 RecTy *GivenEltTy = 0;
1296 if (Lex.getCode() == tgtok::less) {
1297 // Optional list element type
1298 Lex.Lex(); // eat the '<'
1300 GivenEltTy = ParseType();
1301 if (GivenEltTy == 0) {
1302 // Couldn't parse element type
1306 if (Lex.getCode() != tgtok::greater) {
1307 TokError("expected '>' at end of list element type");
1310 Lex.Lex(); // eat the '>'
1315 for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1318 TypedInit *TArg = dyn_cast<TypedInit>(*i);
1320 TokError("Untyped list element");
1324 EltTy = resolveTypes(EltTy, TArg->getType());
1326 TokError("Incompatible types in list elements");
1330 EltTy = TArg->getType();
1334 if (GivenEltTy != 0) {
1336 // Verify consistency
1337 if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1338 TokError("Incompatible types in list elements");
1346 if (ItemType == 0) {
1347 TokError("No type for list");
1350 DeducedEltTy = GivenListTy->getElementType();
1352 // Make sure the deduced type is compatible with the given type
1354 if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1355 TokError("Element type mismatch for list");
1359 DeducedEltTy = EltTy;
1362 return ListInit::get(Vals, DeducedEltTy);
1364 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
1365 Lex.Lex(); // eat the '('
1366 if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1367 TokError("expected identifier in dag init");
1371 Init *Operator = ParseValue(CurRec);
1372 if (Operator == 0) return 0;
1374 // If the operator name is present, parse it.
1375 std::string OperatorName;
1376 if (Lex.getCode() == tgtok::colon) {
1377 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1378 TokError("expected variable name in dag operator");
1381 OperatorName = Lex.getCurStrVal();
1382 Lex.Lex(); // eat the VarName.
1385 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1386 if (Lex.getCode() != tgtok::r_paren) {
1387 DagArgs = ParseDagArgList(CurRec);
1388 if (DagArgs.empty()) return 0;
1391 if (Lex.getCode() != tgtok::r_paren) {
1392 TokError("expected ')' in dag init");
1395 Lex.Lex(); // eat the ')'
1397 return DagInit::get(Operator, OperatorName, DagArgs);
1403 case tgtok::XCast: // Value ::= !unop '(' Value ')'
1404 case tgtok::XConcat:
1410 case tgtok::XStrConcat: // Value ::= !binop '(' Value ',' Value ')'
1412 case tgtok::XForEach:
1413 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1414 return ParseOperation(CurRec);
1421 /// ParseValue - Parse a tblgen value. This returns null on error.
1423 /// Value ::= SimpleValue ValueSuffix*
1424 /// ValueSuffix ::= '{' BitList '}'
1425 /// ValueSuffix ::= '[' BitList ']'
1426 /// ValueSuffix ::= '.' ID
1428 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType, IDParseMode Mode) {
1429 Init *Result = ParseSimpleValue(CurRec, ItemType, Mode);
1430 if (Result == 0) return 0;
1432 // Parse the suffixes now if present.
1434 switch (Lex.getCode()) {
1435 default: return Result;
1436 case tgtok::l_brace: {
1437 if (Mode == ParseNameMode || Mode == ParseForeachMode)
1438 // This is the beginning of the object body.
1441 SMLoc CurlyLoc = Lex.getLoc();
1442 Lex.Lex(); // eat the '{'
1443 std::vector<unsigned> Ranges = ParseRangeList();
1444 if (Ranges.empty()) return 0;
1446 // Reverse the bitlist.
1447 std::reverse(Ranges.begin(), Ranges.end());
1448 Result = Result->convertInitializerBitRange(Ranges);
1450 Error(CurlyLoc, "Invalid bit range for value");
1455 if (Lex.getCode() != tgtok::r_brace) {
1456 TokError("expected '}' at end of bit range list");
1462 case tgtok::l_square: {
1463 SMLoc SquareLoc = Lex.getLoc();
1464 Lex.Lex(); // eat the '['
1465 std::vector<unsigned> Ranges = ParseRangeList();
1466 if (Ranges.empty()) return 0;
1468 Result = Result->convertInitListSlice(Ranges);
1470 Error(SquareLoc, "Invalid range for list slice");
1475 if (Lex.getCode() != tgtok::r_square) {
1476 TokError("expected ']' at end of list slice");
1483 if (Lex.Lex() != tgtok::Id) { // eat the .
1484 TokError("expected field identifier after '.'");
1487 if (!Result->getFieldType(Lex.getCurStrVal())) {
1488 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1489 Result->getAsString() + "'");
1492 Result = FieldInit::get(Result, Lex.getCurStrVal());
1493 Lex.Lex(); // eat field name
1497 SMLoc PasteLoc = Lex.getLoc();
1499 // Create a !strconcat() operation, first casting each operand to
1500 // a string if necessary.
1502 TypedInit *LHS = dyn_cast<TypedInit>(Result);
1504 Error(PasteLoc, "LHS of paste is not typed!");
1508 if (LHS->getType() != StringRecTy::get()) {
1509 LHS = UnOpInit::get(UnOpInit::CAST, LHS, StringRecTy::get());
1514 Lex.Lex(); // Eat the '#'.
1515 switch (Lex.getCode()) {
1518 case tgtok::l_brace:
1519 // These are all of the tokens that can begin an object body.
1520 // Some of these can also begin values but we disallow those cases
1521 // because they are unlikely to be useful.
1523 // Trailing paste, concat with an empty string.
1524 RHS = StringInit::get("");
1528 Init *RHSResult = ParseValue(CurRec, ItemType, ParseNameMode);
1529 RHS = dyn_cast<TypedInit>(RHSResult);
1531 Error(PasteLoc, "RHS of paste is not typed!");
1535 if (RHS->getType() != StringRecTy::get()) {
1536 RHS = UnOpInit::get(UnOpInit::CAST, RHS, StringRecTy::get());
1542 Result = BinOpInit::get(BinOpInit::STRCONCAT, LHS, RHS,
1543 StringRecTy::get())->Fold(CurRec, CurMultiClass);
1549 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1551 /// DagArg ::= Value (':' VARNAME)?
1552 /// DagArg ::= VARNAME
1553 /// DagArgList ::= DagArg
1554 /// DagArgList ::= DagArgList ',' DagArg
1555 std::vector<std::pair<llvm::Init*, std::string> >
1556 TGParser::ParseDagArgList(Record *CurRec) {
1557 std::vector<std::pair<llvm::Init*, std::string> > Result;
1560 // DagArg ::= VARNAME
1561 if (Lex.getCode() == tgtok::VarName) {
1562 // A missing value is treated like '?'.
1563 Result.push_back(std::make_pair(UnsetInit::get(), Lex.getCurStrVal()));
1566 // DagArg ::= Value (':' VARNAME)?
1567 Init *Val = ParseValue(CurRec);
1569 return std::vector<std::pair<llvm::Init*, std::string> >();
1571 // If the variable name is present, add it.
1572 std::string VarName;
1573 if (Lex.getCode() == tgtok::colon) {
1574 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1575 TokError("expected variable name in dag literal");
1576 return std::vector<std::pair<llvm::Init*, std::string> >();
1578 VarName = Lex.getCurStrVal();
1579 Lex.Lex(); // eat the VarName.
1582 Result.push_back(std::make_pair(Val, VarName));
1584 if (Lex.getCode() != tgtok::comma) break;
1585 Lex.Lex(); // eat the ','
1592 /// ParseValueList - Parse a comma separated list of values, returning them as a
1593 /// vector. Note that this always expects to be able to parse at least one
1594 /// value. It returns an empty list if this is not possible.
1596 /// ValueList ::= Value (',' Value)
1598 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1600 std::vector<Init*> Result;
1601 RecTy *ItemType = EltTy;
1602 unsigned int ArgN = 0;
1603 if (ArgsRec != 0 && EltTy == 0) {
1604 const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1605 if (!TArgs.size()) {
1606 TokError("template argument provided to non-template class");
1607 return std::vector<Init*>();
1609 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1611 errs() << "Cannot find template arg " << ArgN << " (" << TArgs[ArgN]
1614 assert(RV && "Template argument record not found??");
1615 ItemType = RV->getType();
1618 Result.push_back(ParseValue(CurRec, ItemType));
1619 if (Result.back() == 0) return std::vector<Init*>();
1621 while (Lex.getCode() == tgtok::comma) {
1622 Lex.Lex(); // Eat the comma
1624 if (ArgsRec != 0 && EltTy == 0) {
1625 const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1626 if (ArgN >= TArgs.size()) {
1627 TokError("too many template arguments");
1628 return std::vector<Init*>();
1630 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1631 assert(RV && "Template argument record not found??");
1632 ItemType = RV->getType();
1635 Result.push_back(ParseValue(CurRec, ItemType));
1636 if (Result.back() == 0) return std::vector<Init*>();
1643 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1644 /// empty string on error. This can happen in a number of different context's,
1645 /// including within a def or in the template args for a def (which which case
1646 /// CurRec will be non-null) and within the template args for a multiclass (in
1647 /// which case CurRec will be null, but CurMultiClass will be set). This can
1648 /// also happen within a def that is within a multiclass, which will set both
1649 /// CurRec and CurMultiClass.
1651 /// Declaration ::= FIELD? Type ID ('=' Value)?
1653 Init *TGParser::ParseDeclaration(Record *CurRec,
1654 bool ParsingTemplateArgs) {
1655 // Read the field prefix if present.
1656 bool HasField = Lex.getCode() == tgtok::Field;
1657 if (HasField) Lex.Lex();
1659 RecTy *Type = ParseType();
1660 if (Type == 0) return 0;
1662 if (Lex.getCode() != tgtok::Id) {
1663 TokError("Expected identifier in declaration");
1667 SMLoc IdLoc = Lex.getLoc();
1668 Init *DeclName = StringInit::get(Lex.getCurStrVal());
1671 if (ParsingTemplateArgs) {
1673 DeclName = QualifyName(*CurRec, CurMultiClass, DeclName, ":");
1675 assert(CurMultiClass);
1678 DeclName = QualifyName(CurMultiClass->Rec, CurMultiClass, DeclName,
1683 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1686 // If a value is present, parse it.
1687 if (Lex.getCode() == tgtok::equal) {
1689 SMLoc ValLoc = Lex.getLoc();
1690 Init *Val = ParseValue(CurRec, Type);
1692 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1699 /// ParseForeachDeclaration - Read a foreach declaration, returning
1700 /// the name of the declared object or a NULL Init on error. Return
1701 /// the name of the parsed initializer list through ForeachListName.
1703 /// ForeachDeclaration ::= ID '=' '[' ValueList ']'
1704 /// ForeachDeclaration ::= ID '=' '{' RangeList '}'
1705 /// ForeachDeclaration ::= ID '=' RangePiece
1707 VarInit *TGParser::ParseForeachDeclaration(ListInit *&ForeachListValue) {
1708 if (Lex.getCode() != tgtok::Id) {
1709 TokError("Expected identifier in foreach declaration");
1713 Init *DeclName = StringInit::get(Lex.getCurStrVal());
1716 // If a value is present, parse it.
1717 if (Lex.getCode() != tgtok::equal) {
1718 TokError("Expected '=' in foreach declaration");
1721 Lex.Lex(); // Eat the '='
1723 RecTy *IterType = 0;
1724 std::vector<unsigned> Ranges;
1726 switch (Lex.getCode()) {
1727 default: TokError("Unknown token when expecting a range list"); return 0;
1728 case tgtok::l_square: { // '[' ValueList ']'
1729 Init *List = ParseSimpleValue(0, 0, ParseForeachMode);
1730 ForeachListValue = dyn_cast<ListInit>(List);
1731 if (ForeachListValue == 0) {
1732 TokError("Expected a Value list");
1735 RecTy *ValueType = ForeachListValue->getType();
1736 ListRecTy *ListType = dyn_cast<ListRecTy>(ValueType);
1737 if (ListType == 0) {
1738 TokError("Value list is not of list type");
1741 IterType = ListType->getElementType();
1745 case tgtok::IntVal: { // RangePiece.
1746 if (ParseRangePiece(Ranges))
1751 case tgtok::l_brace: { // '{' RangeList '}'
1752 Lex.Lex(); // eat the '{'
1753 Ranges = ParseRangeList();
1754 if (Lex.getCode() != tgtok::r_brace) {
1755 TokError("expected '}' at end of bit range list");
1763 if (!Ranges.empty()) {
1764 assert(!IterType && "Type already initialized?");
1765 IterType = IntRecTy::get();
1766 std::vector<Init*> Values;
1767 for (unsigned i = 0, e = Ranges.size(); i != e; ++i)
1768 Values.push_back(IntInit::get(Ranges[i]));
1769 ForeachListValue = ListInit::get(Values, IterType);
1775 return VarInit::get(DeclName, IterType);
1778 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1779 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
1780 /// template args for a def, which may or may not be in a multiclass. If null,
1781 /// these are the template args for a multiclass.
1783 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1785 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1786 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1787 Lex.Lex(); // eat the '<'
1789 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1791 // Read the first declaration.
1792 Init *TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1796 TheRecToAddTo->addTemplateArg(TemplArg);
1798 while (Lex.getCode() == tgtok::comma) {
1799 Lex.Lex(); // eat the ','
1801 // Read the following declarations.
1802 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1805 TheRecToAddTo->addTemplateArg(TemplArg);
1808 if (Lex.getCode() != tgtok::greater)
1809 return TokError("expected '>' at end of template argument list");
1810 Lex.Lex(); // eat the '>'.
1815 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1817 /// BodyItem ::= Declaration ';'
1818 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
1819 bool TGParser::ParseBodyItem(Record *CurRec) {
1820 if (Lex.getCode() != tgtok::Let) {
1821 if (ParseDeclaration(CurRec, false) == 0)
1824 if (Lex.getCode() != tgtok::semi)
1825 return TokError("expected ';' after declaration");
1830 // LET ID OptionalRangeList '=' Value ';'
1831 if (Lex.Lex() != tgtok::Id)
1832 return TokError("expected field identifier after let");
1834 SMLoc IdLoc = Lex.getLoc();
1835 std::string FieldName = Lex.getCurStrVal();
1836 Lex.Lex(); // eat the field name.
1838 std::vector<unsigned> BitList;
1839 if (ParseOptionalBitList(BitList))
1841 std::reverse(BitList.begin(), BitList.end());
1843 if (Lex.getCode() != tgtok::equal)
1844 return TokError("expected '=' in let expression");
1845 Lex.Lex(); // eat the '='.
1847 RecordVal *Field = CurRec->getValue(FieldName);
1849 return TokError("Value '" + FieldName + "' unknown!");
1851 RecTy *Type = Field->getType();
1853 Init *Val = ParseValue(CurRec, Type);
1854 if (Val == 0) return true;
1856 if (Lex.getCode() != tgtok::semi)
1857 return TokError("expected ';' after let expression");
1860 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1863 /// ParseBody - Read the body of a class or def. Return true on error, false on
1867 /// Body ::= '{' BodyList '}'
1868 /// BodyList BodyItem*
1870 bool TGParser::ParseBody(Record *CurRec) {
1871 // If this is a null definition, just eat the semi and return.
1872 if (Lex.getCode() == tgtok::semi) {
1877 if (Lex.getCode() != tgtok::l_brace)
1878 return TokError("Expected ';' or '{' to start body");
1882 while (Lex.getCode() != tgtok::r_brace)
1883 if (ParseBodyItem(CurRec))
1891 /// \brief Apply the current let bindings to \a CurRec.
1892 /// \returns true on error, false otherwise.
1893 bool TGParser::ApplyLetStack(Record *CurRec) {
1894 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1895 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1896 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1897 LetStack[i][j].Bits, LetStack[i][j].Value))
1902 /// ParseObjectBody - Parse the body of a def or class. This consists of an
1903 /// optional ClassList followed by a Body. CurRec is the current def or class
1904 /// that is being parsed.
1906 /// ObjectBody ::= BaseClassList Body
1907 /// BaseClassList ::= /*empty*/
1908 /// BaseClassList ::= ':' BaseClassListNE
1909 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1911 bool TGParser::ParseObjectBody(Record *CurRec) {
1912 // If there is a baseclass list, read it.
1913 if (Lex.getCode() == tgtok::colon) {
1916 // Read all of the subclasses.
1917 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1920 if (SubClass.Rec == 0) return true;
1923 if (AddSubClass(CurRec, SubClass))
1926 if (Lex.getCode() != tgtok::comma) break;
1927 Lex.Lex(); // eat ','.
1928 SubClass = ParseSubClassReference(CurRec, false);
1932 if (ApplyLetStack(CurRec))
1935 return ParseBody(CurRec);
1938 /// ParseDef - Parse and return a top level or multiclass def, return the record
1939 /// corresponding to it. This returns null on error.
1941 /// DefInst ::= DEF ObjectName ObjectBody
1943 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
1944 SMLoc DefLoc = Lex.getLoc();
1945 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1946 Lex.Lex(); // Eat the 'def' token.
1948 // Parse ObjectName and make a record for it.
1950 Init *Name = ParseObjectName(CurMultiClass);
1952 CurRec = new Record(Name, DefLoc, Records);
1954 CurRec = new Record(GetNewAnonymousName(), DefLoc, Records,
1955 /*IsAnonymous=*/true);
1957 if (!CurMultiClass && Loops.empty()) {
1958 // Top-level def definition.
1960 // Ensure redefinition doesn't happen.
1961 if (Records.getDef(CurRec->getNameInitAsString())) {
1962 Error(DefLoc, "def '" + CurRec->getNameInitAsString()
1963 + "' already defined");
1966 Records.addDef(CurRec);
1967 } else if (CurMultiClass) {
1968 // Otherwise, a def inside a multiclass, add it to the multiclass.
1969 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1970 if (CurMultiClass->DefPrototypes[i]->getNameInit()
1971 == CurRec->getNameInit()) {
1972 Error(DefLoc, "def '" + CurRec->getNameInitAsString() +
1973 "' already defined in this multiclass!");
1976 CurMultiClass->DefPrototypes.push_back(CurRec);
1979 if (ParseObjectBody(CurRec))
1982 if (CurMultiClass == 0) // Def's in multiclasses aren't really defs.
1983 // See Record::setName(). This resolve step will see any new name
1984 // for the def that might have been created when resolving
1985 // inheritance, values and arguments above.
1986 CurRec->resolveReferences();
1988 // If ObjectBody has template arguments, it's an error.
1989 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1991 if (CurMultiClass) {
1992 // Copy the template arguments for the multiclass into the def.
1993 const std::vector<Init *> &TArgs =
1994 CurMultiClass->Rec.getTemplateArgs();
1996 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1997 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1998 assert(RV && "Template arg doesn't exist?");
1999 CurRec->addValue(*RV);
2003 if (ProcessForeachDefs(CurRec, DefLoc)) {
2005 "Could not process loops for def" + CurRec->getNameInitAsString());
2012 /// ParseForeach - Parse a for statement. Return the record corresponding
2013 /// to it. This returns true on error.
2015 /// Foreach ::= FOREACH Declaration IN '{ ObjectList '}'
2016 /// Foreach ::= FOREACH Declaration IN Object
2018 bool TGParser::ParseForeach(MultiClass *CurMultiClass) {
2019 assert(Lex.getCode() == tgtok::Foreach && "Unknown tok");
2020 Lex.Lex(); // Eat the 'for' token.
2022 // Make a temporary object to record items associated with the for
2024 ListInit *ListValue = 0;
2025 VarInit *IterName = ParseForeachDeclaration(ListValue);
2027 return TokError("expected declaration in for");
2029 if (Lex.getCode() != tgtok::In)
2030 return TokError("Unknown tok");
2031 Lex.Lex(); // Eat the in
2033 // Create a loop object and remember it.
2034 Loops.push_back(ForeachLoop(IterName, ListValue));
2036 if (Lex.getCode() != tgtok::l_brace) {
2037 // FOREACH Declaration IN Object
2038 if (ParseObject(CurMultiClass))
2042 SMLoc BraceLoc = Lex.getLoc();
2043 // Otherwise, this is a group foreach.
2044 Lex.Lex(); // eat the '{'.
2046 // Parse the object list.
2047 if (ParseObjectList(CurMultiClass))
2050 if (Lex.getCode() != tgtok::r_brace) {
2051 TokError("expected '}' at end of foreach command");
2052 return Error(BraceLoc, "to match this '{'");
2054 Lex.Lex(); // Eat the }
2057 // We've processed everything in this loop.
2063 /// ParseClass - Parse a tblgen class definition.
2065 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
2067 bool TGParser::ParseClass() {
2068 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
2071 if (Lex.getCode() != tgtok::Id)
2072 return TokError("expected class name after 'class' keyword");
2074 Record *CurRec = Records.getClass(Lex.getCurStrVal());
2076 // If the body was previously defined, this is an error.
2077 if (CurRec->getValues().size() > 1 || // Account for NAME.
2078 !CurRec->getSuperClasses().empty() ||
2079 !CurRec->getTemplateArgs().empty())
2080 return TokError("Class '" + CurRec->getNameInitAsString()
2081 + "' already defined");
2083 // If this is the first reference to this class, create and add it.
2084 CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc(), Records);
2085 Records.addClass(CurRec);
2087 Lex.Lex(); // eat the name.
2089 // If there are template args, parse them.
2090 if (Lex.getCode() == tgtok::less)
2091 if (ParseTemplateArgList(CurRec))
2094 // Finally, parse the object body.
2095 return ParseObjectBody(CurRec);
2098 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
2101 /// LetList ::= LetItem (',' LetItem)*
2102 /// LetItem ::= ID OptionalRangeList '=' Value
2104 std::vector<LetRecord> TGParser::ParseLetList() {
2105 std::vector<LetRecord> Result;
2108 if (Lex.getCode() != tgtok::Id) {
2109 TokError("expected identifier in let definition");
2110 return std::vector<LetRecord>();
2112 std::string Name = Lex.getCurStrVal();
2113 SMLoc NameLoc = Lex.getLoc();
2114 Lex.Lex(); // Eat the identifier.
2116 // Check for an optional RangeList.
2117 std::vector<unsigned> Bits;
2118 if (ParseOptionalRangeList(Bits))
2119 return std::vector<LetRecord>();
2120 std::reverse(Bits.begin(), Bits.end());
2122 if (Lex.getCode() != tgtok::equal) {
2123 TokError("expected '=' in let expression");
2124 return std::vector<LetRecord>();
2126 Lex.Lex(); // eat the '='.
2128 Init *Val = ParseValue(0);
2129 if (Val == 0) return std::vector<LetRecord>();
2131 // Now that we have everything, add the record.
2132 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
2134 if (Lex.getCode() != tgtok::comma)
2136 Lex.Lex(); // eat the comma.
2140 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
2141 /// different related productions. This works inside multiclasses too.
2143 /// Object ::= LET LetList IN '{' ObjectList '}'
2144 /// Object ::= LET LetList IN Object
2146 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
2147 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
2150 // Add this entry to the let stack.
2151 std::vector<LetRecord> LetInfo = ParseLetList();
2152 if (LetInfo.empty()) return true;
2153 LetStack.push_back(LetInfo);
2155 if (Lex.getCode() != tgtok::In)
2156 return TokError("expected 'in' at end of top-level 'let'");
2159 // If this is a scalar let, just handle it now
2160 if (Lex.getCode() != tgtok::l_brace) {
2161 // LET LetList IN Object
2162 if (ParseObject(CurMultiClass))
2164 } else { // Object ::= LETCommand '{' ObjectList '}'
2165 SMLoc BraceLoc = Lex.getLoc();
2166 // Otherwise, this is a group let.
2167 Lex.Lex(); // eat the '{'.
2169 // Parse the object list.
2170 if (ParseObjectList(CurMultiClass))
2173 if (Lex.getCode() != tgtok::r_brace) {
2174 TokError("expected '}' at end of top level let command");
2175 return Error(BraceLoc, "to match this '{'");
2180 // Outside this let scope, this let block is not active.
2181 LetStack.pop_back();
2185 /// ParseMultiClass - Parse a multiclass definition.
2187 /// MultiClassInst ::= MULTICLASS ID TemplateArgList?
2188 /// ':' BaseMultiClassList '{' MultiClassObject+ '}'
2189 /// MultiClassObject ::= DefInst
2190 /// MultiClassObject ::= MultiClassInst
2191 /// MultiClassObject ::= DefMInst
2192 /// MultiClassObject ::= LETCommand '{' ObjectList '}'
2193 /// MultiClassObject ::= LETCommand Object
2195 bool TGParser::ParseMultiClass() {
2196 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
2197 Lex.Lex(); // Eat the multiclass token.
2199 if (Lex.getCode() != tgtok::Id)
2200 return TokError("expected identifier after multiclass for name");
2201 std::string Name = Lex.getCurStrVal();
2203 if (MultiClasses.count(Name))
2204 return TokError("multiclass '" + Name + "' already defined");
2206 CurMultiClass = MultiClasses[Name] = new MultiClass(Name,
2207 Lex.getLoc(), Records);
2208 Lex.Lex(); // Eat the identifier.
2210 // If there are template args, parse them.
2211 if (Lex.getCode() == tgtok::less)
2212 if (ParseTemplateArgList(0))
2215 bool inherits = false;
2217 // If there are submulticlasses, parse them.
2218 if (Lex.getCode() == tgtok::colon) {
2223 // Read all of the submulticlasses.
2224 SubMultiClassReference SubMultiClass =
2225 ParseSubMultiClassReference(CurMultiClass);
2228 if (SubMultiClass.MC == 0) return true;
2231 if (AddSubMultiClass(CurMultiClass, SubMultiClass))
2234 if (Lex.getCode() != tgtok::comma) break;
2235 Lex.Lex(); // eat ','.
2236 SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
2240 if (Lex.getCode() != tgtok::l_brace) {
2242 return TokError("expected '{' in multiclass definition");
2243 else if (Lex.getCode() != tgtok::semi)
2244 return TokError("expected ';' in multiclass definition");
2246 Lex.Lex(); // eat the ';'.
2248 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
2249 return TokError("multiclass must contain at least one def");
2251 while (Lex.getCode() != tgtok::r_brace) {
2252 switch (Lex.getCode()) {
2254 return TokError("expected 'let', 'def' or 'defm' in multiclass body");
2258 case tgtok::Foreach:
2259 if (ParseObject(CurMultiClass))
2264 Lex.Lex(); // eat the '}'.
2272 InstantiateMulticlassDef(MultiClass &MC,
2275 SMRange DefmPrefixRange) {
2276 // We need to preserve DefProto so it can be reused for later
2277 // instantiations, so create a new Record to inherit from it.
2279 // Add in the defm name. If the defm prefix is empty, give each
2280 // instantiated def a unique name. Otherwise, if "#NAME#" exists in the
2281 // name, substitute the prefix for #NAME#. Otherwise, use the defm name
2284 bool IsAnonymous = false;
2285 if (DefmPrefix == 0) {
2286 DefmPrefix = StringInit::get(GetNewAnonymousName());
2290 Init *DefName = DefProto->getNameInit();
2292 StringInit *DefNameString = dyn_cast<StringInit>(DefName);
2294 if (DefNameString != 0) {
2295 // We have a fully expanded string so there are no operators to
2296 // resolve. We should concatenate the given prefix and name.
2298 BinOpInit::get(BinOpInit::STRCONCAT,
2299 UnOpInit::get(UnOpInit::CAST, DefmPrefix,
2300 StringRecTy::get())->Fold(DefProto, &MC),
2301 DefName, StringRecTy::get())->Fold(DefProto, &MC);
2304 // Make a trail of SMLocs from the multiclass instantiations.
2305 SmallVector<SMLoc, 4> Locs(1, DefmPrefixRange.Start);
2306 Locs.append(DefProto->getLoc().begin(), DefProto->getLoc().end());
2307 Record *CurRec = new Record(DefName, Locs, Records, IsAnonymous);
2309 SubClassReference Ref;
2310 Ref.RefRange = DefmPrefixRange;
2312 AddSubClass(CurRec, Ref);
2314 // Set the value for NAME. We don't resolve references to it 'til later,
2315 // though, so that uses in nested multiclass names don't get
2317 if (SetValue(CurRec, Ref.RefRange.Start, "NAME", std::vector<unsigned>(),
2319 Error(DefmPrefixRange.Start, "Could not resolve "
2320 + CurRec->getNameInitAsString() + ":NAME to '"
2321 + DefmPrefix->getAsUnquotedString() + "'");
2325 // If the DefNameString didn't resolve, we probably have a reference to
2326 // NAME and need to replace it. We need to do at least this much greedily,
2327 // otherwise nested multiclasses will end up with incorrect NAME expansions.
2328 if (DefNameString == 0) {
2329 RecordVal *DefNameRV = CurRec->getValue("NAME");
2330 CurRec->resolveReferencesTo(DefNameRV);
2333 if (!CurMultiClass) {
2334 // Now that we're at the top level, resolve all NAME references
2335 // in the resultant defs that weren't in the def names themselves.
2336 RecordVal *DefNameRV = CurRec->getValue("NAME");
2337 CurRec->resolveReferencesTo(DefNameRV);
2339 // Now that NAME references are resolved and we're at the top level of
2340 // any multiclass expansions, add the record to the RecordKeeper. If we are
2341 // currently in a multiclass, it means this defm appears inside a
2342 // multiclass and its name won't be fully resolvable until we see
2343 // the top-level defm. Therefore, we don't add this to the
2344 // RecordKeeper at this point. If we did we could get duplicate
2345 // defs as more than one probably refers to NAME or some other
2346 // common internal placeholder.
2348 // Ensure redefinition doesn't happen.
2349 if (Records.getDef(CurRec->getNameInitAsString())) {
2350 Error(DefmPrefixRange.Start, "def '" + CurRec->getNameInitAsString() +
2351 "' already defined, instantiating defm with subdef '" +
2352 DefProto->getNameInitAsString() + "'");
2356 Records.addDef(CurRec);
2362 bool TGParser::ResolveMulticlassDefArgs(MultiClass &MC,
2364 SMLoc DefmPrefixLoc,
2366 const std::vector<Init *> &TArgs,
2367 std::vector<Init *> &TemplateVals,
2369 // Loop over all of the template arguments, setting them to the specified
2370 // value or leaving them as the default if necessary.
2371 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2372 // Check if a value is specified for this temp-arg.
2373 if (i < TemplateVals.size()) {
2375 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
2380 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
2384 CurRec->removeValue(TArgs[i]);
2386 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2387 return Error(SubClassLoc, "value not specified for template argument #"+
2388 utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
2389 + ") of multiclassclass '" + MC.Rec.getNameInitAsString()
2396 bool TGParser::ResolveMulticlassDef(MultiClass &MC,
2399 SMLoc DefmPrefixLoc) {
2400 // If the mdef is inside a 'let' expression, add to each def.
2401 if (ApplyLetStack(CurRec))
2402 return Error(DefmPrefixLoc, "when instantiating this defm");
2404 // Don't create a top level definition for defm inside multiclasses,
2405 // instead, only update the prototypes and bind the template args
2406 // with the new created definition.
2409 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2411 if (CurMultiClass->DefPrototypes[i]->getNameInit()
2412 == CurRec->getNameInit())
2413 return Error(DefmPrefixLoc, "defm '" + CurRec->getNameInitAsString() +
2414 "' already defined in this multiclass!");
2415 CurMultiClass->DefPrototypes.push_back(CurRec);
2417 // Copy the template arguments for the multiclass into the new def.
2418 const std::vector<Init *> &TA =
2419 CurMultiClass->Rec.getTemplateArgs();
2421 for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2422 const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2423 assert(RV && "Template arg doesn't exist?");
2424 CurRec->addValue(*RV);
2430 /// ParseDefm - Parse the instantiation of a multiclass.
2432 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
2434 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
2435 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
2436 SMLoc DefmLoc = Lex.getLoc();
2437 Init *DefmPrefix = 0;
2439 if (Lex.Lex() == tgtok::Id) { // eat the defm.
2440 DefmPrefix = ParseObjectName(CurMultiClass);
2443 SMLoc DefmPrefixEndLoc = Lex.getLoc();
2444 if (Lex.getCode() != tgtok::colon)
2445 return TokError("expected ':' after defm identifier");
2447 // Keep track of the new generated record definitions.
2448 std::vector<Record*> NewRecDefs;
2450 // This record also inherits from a regular class (non-multiclass)?
2451 bool InheritFromClass = false;
2456 SMLoc SubClassLoc = Lex.getLoc();
2457 SubClassReference Ref = ParseSubClassReference(0, true);
2460 if (Ref.Rec == 0) return true;
2462 // To instantiate a multiclass, we need to first get the multiclass, then
2463 // instantiate each def contained in the multiclass with the SubClassRef
2464 // template parameters.
2465 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
2466 assert(MC && "Didn't lookup multiclass correctly?");
2467 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
2469 // Verify that the correct number of template arguments were specified.
2470 const std::vector<Init *> &TArgs = MC->Rec.getTemplateArgs();
2471 if (TArgs.size() < TemplateVals.size())
2472 return Error(SubClassLoc,
2473 "more template args specified than multiclass expects");
2475 // Loop over all the def's in the multiclass, instantiating each one.
2476 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
2477 Record *DefProto = MC->DefPrototypes[i];
2479 Record *CurRec = InstantiateMulticlassDef(*MC, DefProto, DefmPrefix,
2485 if (ResolveMulticlassDefArgs(*MC, CurRec, DefmLoc, SubClassLoc,
2486 TArgs, TemplateVals, true/*Delete args*/))
2487 return Error(SubClassLoc, "could not instantiate def");
2489 if (ResolveMulticlassDef(*MC, CurRec, DefProto, DefmLoc))
2490 return Error(SubClassLoc, "could not instantiate def");
2492 NewRecDefs.push_back(CurRec);
2496 if (Lex.getCode() != tgtok::comma) break;
2497 Lex.Lex(); // eat ','.
2499 if (Lex.getCode() != tgtok::Id)
2500 return TokError("expected identifier");
2502 SubClassLoc = Lex.getLoc();
2504 // A defm can inherit from regular classes (non-multiclass) as
2505 // long as they come in the end of the inheritance list.
2506 InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != 0);
2508 if (InheritFromClass)
2511 Ref = ParseSubClassReference(0, true);
2514 if (InheritFromClass) {
2515 // Process all the classes to inherit as if they were part of a
2516 // regular 'def' and inherit all record values.
2517 SubClassReference SubClass = ParseSubClassReference(0, false);
2520 if (SubClass.Rec == 0) return true;
2522 // Get the expanded definition prototypes and teach them about
2523 // the record values the current class to inherit has
2524 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2525 Record *CurRec = NewRecDefs[i];
2528 if (AddSubClass(CurRec, SubClass))
2531 if (ApplyLetStack(CurRec))
2535 if (Lex.getCode() != tgtok::comma) break;
2536 Lex.Lex(); // eat ','.
2537 SubClass = ParseSubClassReference(0, false);
2542 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2543 // See Record::setName(). This resolve step will see any new
2544 // name for the def that might have been created when resolving
2545 // inheritance, values and arguments above.
2546 NewRecDefs[i]->resolveReferences();
2548 if (Lex.getCode() != tgtok::semi)
2549 return TokError("expected ';' at end of defm");
2556 /// Object ::= ClassInst
2557 /// Object ::= DefInst
2558 /// Object ::= MultiClassInst
2559 /// Object ::= DefMInst
2560 /// Object ::= LETCommand '{' ObjectList '}'
2561 /// Object ::= LETCommand Object
2562 bool TGParser::ParseObject(MultiClass *MC) {
2563 switch (Lex.getCode()) {
2565 return TokError("Expected class, def, defm, multiclass or let definition");
2566 case tgtok::Let: return ParseTopLevelLet(MC);
2567 case tgtok::Def: return ParseDef(MC);
2568 case tgtok::Foreach: return ParseForeach(MC);
2569 case tgtok::Defm: return ParseDefm(MC);
2570 case tgtok::Class: return ParseClass();
2571 case tgtok::MultiClass: return ParseMultiClass();
2576 /// ObjectList :== Object*
2577 bool TGParser::ParseObjectList(MultiClass *MC) {
2578 while (isObjectStart(Lex.getCode())) {
2579 if (ParseObject(MC))
2585 bool TGParser::ParseFile() {
2586 Lex.Lex(); // Prime the lexer.
2587 if (ParseObjectList()) return true;
2589 // If we have unread input at the end of the file, report it.
2590 if (Lex.getCode() == tgtok::Eof)
2593 return TokError("Unexpected input at top level");