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 /// GetNewAnonymousName - Generate a unique anonymous name that can be used as
385 std::string TGParser::GetNewAnonymousName() {
386 unsigned Tmp = AnonCounter++; // MSVC2012 ICEs without this.
387 return "anonymous_" + utostr(Tmp);
390 /// ParseObjectName - If an object name is specified, return it. Otherwise,
392 /// ObjectName ::= Value [ '#' Value ]*
393 /// ObjectName ::= /*empty*/
395 Init *TGParser::ParseObjectName(MultiClass *CurMultiClass) {
396 switch (Lex.getCode()) {
400 // These are all of the tokens that can begin an object body.
401 // Some of these can also begin values but we disallow those cases
402 // because they are unlikely to be useful.
410 CurRec = &CurMultiClass->Rec;
414 const TypedInit *CurRecName = dyn_cast<TypedInit>(CurRec->getNameInit());
416 TokError("Record name is not typed!");
419 Type = CurRecName->getType();
422 return ParseValue(CurRec, Type, ParseNameMode);
425 /// ParseClassID - Parse and resolve a reference to a class name. This returns
430 Record *TGParser::ParseClassID() {
431 if (Lex.getCode() != tgtok::Id) {
432 TokError("expected name for ClassID");
436 Record *Result = Records.getClass(Lex.getCurStrVal());
438 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
444 /// ParseMultiClassID - Parse and resolve a reference to a multiclass name.
445 /// This returns null on error.
447 /// MultiClassID ::= ID
449 MultiClass *TGParser::ParseMultiClassID() {
450 if (Lex.getCode() != tgtok::Id) {
451 TokError("expected name for MultiClassID");
455 MultiClass *Result = MultiClasses[Lex.getCurStrVal()];
457 TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
463 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
464 /// subclass. This returns a SubClassRefTy with a null Record* on error.
466 /// SubClassRef ::= ClassID
467 /// SubClassRef ::= ClassID '<' ValueList '>'
469 SubClassReference TGParser::
470 ParseSubClassReference(Record *CurRec, bool isDefm) {
471 SubClassReference Result;
472 Result.RefRange.Start = Lex.getLoc();
475 if (MultiClass *MC = ParseMultiClassID())
476 Result.Rec = &MC->Rec;
478 Result.Rec = ParseClassID();
480 if (Result.Rec == 0) return Result;
482 // If there is no template arg list, we're done.
483 if (Lex.getCode() != tgtok::less) {
484 Result.RefRange.End = Lex.getLoc();
487 Lex.Lex(); // Eat the '<'
489 if (Lex.getCode() == tgtok::greater) {
490 TokError("subclass reference requires a non-empty list of template values");
495 Result.TemplateArgs = ParseValueList(CurRec, Result.Rec);
496 if (Result.TemplateArgs.empty()) {
497 Result.Rec = 0; // Error parsing value list.
501 if (Lex.getCode() != tgtok::greater) {
502 TokError("expected '>' in template value list");
507 Result.RefRange.End = Lex.getLoc();
512 /// ParseSubMultiClassReference - Parse a reference to a subclass or to a
513 /// templated submulticlass. This returns a SubMultiClassRefTy with a null
514 /// Record* on error.
516 /// SubMultiClassRef ::= MultiClassID
517 /// SubMultiClassRef ::= MultiClassID '<' ValueList '>'
519 SubMultiClassReference TGParser::
520 ParseSubMultiClassReference(MultiClass *CurMC) {
521 SubMultiClassReference Result;
522 Result.RefRange.Start = Lex.getLoc();
524 Result.MC = ParseMultiClassID();
525 if (Result.MC == 0) return Result;
527 // If there is no template arg list, we're done.
528 if (Lex.getCode() != tgtok::less) {
529 Result.RefRange.End = Lex.getLoc();
532 Lex.Lex(); // Eat the '<'
534 if (Lex.getCode() == tgtok::greater) {
535 TokError("subclass reference requires a non-empty list of template values");
540 Result.TemplateArgs = ParseValueList(&CurMC->Rec, &Result.MC->Rec);
541 if (Result.TemplateArgs.empty()) {
542 Result.MC = 0; // Error parsing value list.
546 if (Lex.getCode() != tgtok::greater) {
547 TokError("expected '>' in template value list");
552 Result.RefRange.End = Lex.getLoc();
557 /// ParseRangePiece - Parse a bit/value range.
558 /// RangePiece ::= INTVAL
559 /// RangePiece ::= INTVAL '-' INTVAL
560 /// RangePiece ::= INTVAL INTVAL
561 bool TGParser::ParseRangePiece(std::vector<unsigned> &Ranges) {
562 if (Lex.getCode() != tgtok::IntVal) {
563 TokError("expected integer or bitrange");
566 int64_t Start = Lex.getCurIntVal();
570 return TokError("invalid range, cannot be negative");
572 switch (Lex.Lex()) { // eat first character.
574 Ranges.push_back(Start);
577 if (Lex.Lex() != tgtok::IntVal) {
578 TokError("expected integer value as end of range");
581 End = Lex.getCurIntVal();
584 End = -Lex.getCurIntVal();
588 return TokError("invalid range, cannot be negative");
593 for (; Start <= End; ++Start)
594 Ranges.push_back(Start);
596 for (; Start >= End; --Start)
597 Ranges.push_back(Start);
602 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
604 /// RangeList ::= RangePiece (',' RangePiece)*
606 std::vector<unsigned> TGParser::ParseRangeList() {
607 std::vector<unsigned> Result;
609 // Parse the first piece.
610 if (ParseRangePiece(Result))
611 return std::vector<unsigned>();
612 while (Lex.getCode() == tgtok::comma) {
613 Lex.Lex(); // Eat the comma.
615 // Parse the next range piece.
616 if (ParseRangePiece(Result))
617 return std::vector<unsigned>();
622 /// ParseOptionalRangeList - Parse either a range list in <>'s or nothing.
623 /// OptionalRangeList ::= '<' RangeList '>'
624 /// OptionalRangeList ::= /*empty*/
625 bool TGParser::ParseOptionalRangeList(std::vector<unsigned> &Ranges) {
626 if (Lex.getCode() != tgtok::less)
629 SMLoc StartLoc = Lex.getLoc();
630 Lex.Lex(); // eat the '<'
632 // Parse the range list.
633 Ranges = ParseRangeList();
634 if (Ranges.empty()) return true;
636 if (Lex.getCode() != tgtok::greater) {
637 TokError("expected '>' at end of range list");
638 return Error(StartLoc, "to match this '<'");
640 Lex.Lex(); // eat the '>'.
644 /// ParseOptionalBitList - Parse either a bit list in {}'s or nothing.
645 /// OptionalBitList ::= '{' RangeList '}'
646 /// OptionalBitList ::= /*empty*/
647 bool TGParser::ParseOptionalBitList(std::vector<unsigned> &Ranges) {
648 if (Lex.getCode() != tgtok::l_brace)
651 SMLoc StartLoc = Lex.getLoc();
652 Lex.Lex(); // eat the '{'
654 // Parse the range list.
655 Ranges = ParseRangeList();
656 if (Ranges.empty()) return true;
658 if (Lex.getCode() != tgtok::r_brace) {
659 TokError("expected '}' at end of bit list");
660 return Error(StartLoc, "to match this '{'");
662 Lex.Lex(); // eat the '}'.
667 /// ParseType - Parse and return a tblgen type. This returns null on error.
669 /// Type ::= STRING // string type
670 /// Type ::= CODE // code type
671 /// Type ::= BIT // bit type
672 /// Type ::= BITS '<' INTVAL '>' // bits<x> type
673 /// Type ::= INT // int type
674 /// Type ::= LIST '<' Type '>' // list<x> type
675 /// Type ::= DAG // dag type
676 /// Type ::= ClassID // Record Type
678 RecTy *TGParser::ParseType() {
679 switch (Lex.getCode()) {
680 default: TokError("Unknown token when expecting a type"); return 0;
681 case tgtok::String: Lex.Lex(); return StringRecTy::get();
682 case tgtok::Code: Lex.Lex(); return StringRecTy::get();
683 case tgtok::Bit: Lex.Lex(); return BitRecTy::get();
684 case tgtok::Int: Lex.Lex(); return IntRecTy::get();
685 case tgtok::Dag: Lex.Lex(); return DagRecTy::get();
687 if (Record *R = ParseClassID()) return RecordRecTy::get(R);
690 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
691 TokError("expected '<' after bits type");
694 if (Lex.Lex() != tgtok::IntVal) { // Eat '<'
695 TokError("expected integer in bits<n> type");
698 uint64_t Val = Lex.getCurIntVal();
699 if (Lex.Lex() != tgtok::greater) { // Eat count.
700 TokError("expected '>' at end of bits<n> type");
703 Lex.Lex(); // Eat '>'
704 return BitsRecTy::get(Val);
707 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
708 TokError("expected '<' after list type");
711 Lex.Lex(); // Eat '<'
712 RecTy *SubType = ParseType();
713 if (SubType == 0) return 0;
715 if (Lex.getCode() != tgtok::greater) {
716 TokError("expected '>' at end of list<ty> type");
719 Lex.Lex(); // Eat '>'
720 return ListRecTy::get(SubType);
725 /// ParseIDValue - Parse an ID as a value and decode what it means.
727 /// IDValue ::= ID [def local value]
728 /// IDValue ::= ID [def template arg]
729 /// IDValue ::= ID [multiclass local value]
730 /// IDValue ::= ID [multiclass template argument]
731 /// IDValue ::= ID [def name]
733 Init *TGParser::ParseIDValue(Record *CurRec, IDParseMode Mode) {
734 assert(Lex.getCode() == tgtok::Id && "Expected ID in ParseIDValue");
735 std::string Name = Lex.getCurStrVal();
736 SMLoc Loc = Lex.getLoc();
738 return ParseIDValue(CurRec, Name, Loc);
741 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
742 /// has already been read.
743 Init *TGParser::ParseIDValue(Record *CurRec,
744 const std::string &Name, SMLoc NameLoc,
747 if (const RecordVal *RV = CurRec->getValue(Name))
748 return VarInit::get(Name, RV->getType());
750 Init *TemplateArgName = QualifyName(*CurRec, CurMultiClass, Name, ":");
753 TemplateArgName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
756 if (CurRec->isTemplateArg(TemplateArgName)) {
757 const RecordVal *RV = CurRec->getValue(TemplateArgName);
758 assert(RV && "Template arg doesn't exist??");
759 return VarInit::get(TemplateArgName, RV->getType());
764 Init *MCName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
767 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
768 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
769 assert(RV && "Template arg doesn't exist??");
770 return VarInit::get(MCName, RV->getType());
774 // If this is in a foreach loop, make sure it's not a loop iterator
775 for (LoopVector::iterator i = Loops.begin(), iend = Loops.end();
778 VarInit *IterVar = dyn_cast<VarInit>(i->IterVar);
779 if (IterVar && IterVar->getName() == Name)
783 if (Mode == ParseNameMode)
784 return StringInit::get(Name);
786 if (Record *D = Records.getDef(Name))
787 return DefInit::get(D);
789 if (Mode == ParseValueMode) {
790 Error(NameLoc, "Variable not defined: '" + Name + "'");
794 return StringInit::get(Name);
797 /// ParseOperation - Parse an operator. This returns null on error.
799 /// Operation ::= XOperator ['<' Type '>'] '(' Args ')'
801 Init *TGParser::ParseOperation(Record *CurRec) {
802 switch (Lex.getCode()) {
804 TokError("unknown operation");
809 case tgtok::XCast: { // Value ::= !unop '(' Value ')'
810 UnOpInit::UnaryOp Code;
813 switch (Lex.getCode()) {
814 default: llvm_unreachable("Unhandled code!");
816 Lex.Lex(); // eat the operation
817 Code = UnOpInit::CAST;
819 Type = ParseOperatorType();
822 TokError("did not get type for unary operator");
828 Lex.Lex(); // eat the operation
829 Code = UnOpInit::HEAD;
832 Lex.Lex(); // eat the operation
833 Code = UnOpInit::TAIL;
836 Lex.Lex(); // eat the operation
837 Code = UnOpInit::EMPTY;
838 Type = IntRecTy::get();
841 if (Lex.getCode() != tgtok::l_paren) {
842 TokError("expected '(' after unary operator");
845 Lex.Lex(); // eat the '('
847 Init *LHS = ParseValue(CurRec);
848 if (LHS == 0) return 0;
850 if (Code == UnOpInit::HEAD
851 || Code == UnOpInit::TAIL
852 || Code == UnOpInit::EMPTY) {
853 ListInit *LHSl = dyn_cast<ListInit>(LHS);
854 StringInit *LHSs = dyn_cast<StringInit>(LHS);
855 TypedInit *LHSt = dyn_cast<TypedInit>(LHS);
856 if (LHSl == 0 && LHSs == 0 && LHSt == 0) {
857 TokError("expected list or string type argument in unary operator");
861 ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
862 StringRecTy *SType = dyn_cast<StringRecTy>(LHSt->getType());
863 if (LType == 0 && SType == 0) {
864 TokError("expected list or string type argumnet in unary operator");
869 if (Code == UnOpInit::HEAD
870 || Code == UnOpInit::TAIL) {
871 if (LHSl == 0 && LHSt == 0) {
872 TokError("expected list type argumnet in unary operator");
876 if (LHSl && LHSl->getSize() == 0) {
877 TokError("empty list argument in unary operator");
881 Init *Item = LHSl->getElement(0);
882 TypedInit *Itemt = dyn_cast<TypedInit>(Item);
884 TokError("untyped list element in unary operator");
887 if (Code == UnOpInit::HEAD) {
888 Type = Itemt->getType();
890 Type = ListRecTy::get(Itemt->getType());
893 assert(LHSt && "expected list type argument in unary operator");
894 ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
896 TokError("expected list type argumnet in unary operator");
899 if (Code == UnOpInit::HEAD) {
900 Type = LType->getElementType();
908 if (Lex.getCode() != tgtok::r_paren) {
909 TokError("expected ')' in unary operator");
912 Lex.Lex(); // eat the ')'
913 return (UnOpInit::get(Code, LHS, Type))->Fold(CurRec, CurMultiClass);
922 case tgtok::XStrConcat: { // Value ::= !binop '(' Value ',' Value ')'
923 tgtok::TokKind OpTok = Lex.getCode();
924 SMLoc OpLoc = Lex.getLoc();
925 Lex.Lex(); // eat the operation
927 BinOpInit::BinaryOp Code;
931 default: llvm_unreachable("Unhandled code!");
932 case tgtok::XConcat: Code = BinOpInit::CONCAT;Type = DagRecTy::get(); break;
933 case tgtok::XADD: Code = BinOpInit::ADD; Type = IntRecTy::get(); break;
934 case tgtok::XSRA: Code = BinOpInit::SRA; Type = IntRecTy::get(); break;
935 case tgtok::XSRL: Code = BinOpInit::SRL; Type = IntRecTy::get(); break;
936 case tgtok::XSHL: Code = BinOpInit::SHL; Type = IntRecTy::get(); break;
937 case tgtok::XEq: Code = BinOpInit::EQ; Type = BitRecTy::get(); break;
938 case tgtok::XStrConcat:
939 Code = BinOpInit::STRCONCAT;
940 Type = StringRecTy::get();
944 if (Lex.getCode() != tgtok::l_paren) {
945 TokError("expected '(' after binary operator");
948 Lex.Lex(); // eat the '('
950 SmallVector<Init*, 2> InitList;
952 InitList.push_back(ParseValue(CurRec));
953 if (InitList.back() == 0) return 0;
955 while (Lex.getCode() == tgtok::comma) {
956 Lex.Lex(); // eat the ','
958 InitList.push_back(ParseValue(CurRec));
959 if (InitList.back() == 0) return 0;
962 if (Lex.getCode() != tgtok::r_paren) {
963 TokError("expected ')' in operator");
966 Lex.Lex(); // eat the ')'
968 // We allow multiple operands to associative operators like !strconcat as
969 // shorthand for nesting them.
970 if (Code == BinOpInit::STRCONCAT) {
971 while (InitList.size() > 2) {
972 Init *RHS = InitList.pop_back_val();
973 RHS = (BinOpInit::get(Code, InitList.back(), RHS, Type))
974 ->Fold(CurRec, CurMultiClass);
975 InitList.back() = RHS;
979 if (InitList.size() == 2)
980 return (BinOpInit::get(Code, InitList[0], InitList[1], Type))
981 ->Fold(CurRec, CurMultiClass);
983 Error(OpLoc, "expected two operands to operator");
988 case tgtok::XForEach:
989 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
990 TernOpInit::TernaryOp Code;
993 tgtok::TokKind LexCode = Lex.getCode();
994 Lex.Lex(); // eat the operation
996 default: llvm_unreachable("Unhandled code!");
998 Code = TernOpInit::IF;
1000 case tgtok::XForEach:
1001 Code = TernOpInit::FOREACH;
1004 Code = TernOpInit::SUBST;
1007 if (Lex.getCode() != tgtok::l_paren) {
1008 TokError("expected '(' after ternary operator");
1011 Lex.Lex(); // eat the '('
1013 Init *LHS = ParseValue(CurRec);
1014 if (LHS == 0) return 0;
1016 if (Lex.getCode() != tgtok::comma) {
1017 TokError("expected ',' in ternary operator");
1020 Lex.Lex(); // eat the ','
1022 Init *MHS = ParseValue(CurRec);
1023 if (MHS == 0) return 0;
1025 if (Lex.getCode() != tgtok::comma) {
1026 TokError("expected ',' in ternary operator");
1029 Lex.Lex(); // eat the ','
1031 Init *RHS = ParseValue(CurRec);
1032 if (RHS == 0) return 0;
1034 if (Lex.getCode() != tgtok::r_paren) {
1035 TokError("expected ')' in binary operator");
1038 Lex.Lex(); // eat the ')'
1041 default: llvm_unreachable("Unhandled code!");
1046 if (TypedInit *MHSt = dyn_cast<TypedInit>(MHS))
1047 MHSTy = MHSt->getType();
1048 if (BitsInit *MHSbits = dyn_cast<BitsInit>(MHS))
1049 MHSTy = BitsRecTy::get(MHSbits->getNumBits());
1050 if (isa<BitInit>(MHS))
1051 MHSTy = BitRecTy::get();
1053 if (TypedInit *RHSt = dyn_cast<TypedInit>(RHS))
1054 RHSTy = RHSt->getType();
1055 if (BitsInit *RHSbits = dyn_cast<BitsInit>(RHS))
1056 RHSTy = BitsRecTy::get(RHSbits->getNumBits());
1057 if (isa<BitInit>(RHS))
1058 RHSTy = BitRecTy::get();
1060 // For UnsetInit, it's typed from the other hand.
1061 if (isa<UnsetInit>(MHS))
1063 if (isa<UnsetInit>(RHS))
1066 if (!MHSTy || !RHSTy) {
1067 TokError("could not get type for !if");
1071 if (MHSTy->typeIsConvertibleTo(RHSTy)) {
1073 } else if (RHSTy->typeIsConvertibleTo(MHSTy)) {
1076 TokError("inconsistent types for !if");
1081 case tgtok::XForEach: {
1082 TypedInit *MHSt = dyn_cast<TypedInit>(MHS);
1084 TokError("could not get type for !foreach");
1087 Type = MHSt->getType();
1090 case tgtok::XSubst: {
1091 TypedInit *RHSt = dyn_cast<TypedInit>(RHS);
1093 TokError("could not get type for !subst");
1096 Type = RHSt->getType();
1100 return (TernOpInit::get(Code, LHS, MHS, RHS, Type))->Fold(CurRec,
1106 /// ParseOperatorType - Parse a type for an operator. This returns
1109 /// OperatorType ::= '<' Type '>'
1111 RecTy *TGParser::ParseOperatorType() {
1114 if (Lex.getCode() != tgtok::less) {
1115 TokError("expected type name for operator");
1118 Lex.Lex(); // eat the <
1123 TokError("expected type name for operator");
1127 if (Lex.getCode() != tgtok::greater) {
1128 TokError("expected type name for operator");
1131 Lex.Lex(); // eat the >
1137 /// ParseSimpleValue - Parse a tblgen value. This returns null on error.
1139 /// SimpleValue ::= IDValue
1140 /// SimpleValue ::= INTVAL
1141 /// SimpleValue ::= STRVAL+
1142 /// SimpleValue ::= CODEFRAGMENT
1143 /// SimpleValue ::= '?'
1144 /// SimpleValue ::= '{' ValueList '}'
1145 /// SimpleValue ::= ID '<' ValueListNE '>'
1146 /// SimpleValue ::= '[' ValueList ']'
1147 /// SimpleValue ::= '(' IDValue DagArgList ')'
1148 /// SimpleValue ::= CONCATTOK '(' Value ',' Value ')'
1149 /// SimpleValue ::= ADDTOK '(' Value ',' Value ')'
1150 /// SimpleValue ::= SHLTOK '(' Value ',' Value ')'
1151 /// SimpleValue ::= SRATOK '(' Value ',' Value ')'
1152 /// SimpleValue ::= SRLTOK '(' Value ',' Value ')'
1153 /// SimpleValue ::= STRCONCATTOK '(' Value ',' Value ')'
1155 Init *TGParser::ParseSimpleValue(Record *CurRec, RecTy *ItemType,
1158 switch (Lex.getCode()) {
1159 default: TokError("Unknown token when parsing a value"); break;
1161 // This is a leading paste operation. This is deprecated but
1162 // still exists in some .td files. Ignore it.
1163 Lex.Lex(); // Skip '#'.
1164 return ParseSimpleValue(CurRec, ItemType, Mode);
1165 case tgtok::IntVal: R = IntInit::get(Lex.getCurIntVal()); Lex.Lex(); break;
1166 case tgtok::StrVal: {
1167 std::string Val = Lex.getCurStrVal();
1170 // Handle multiple consecutive concatenated strings.
1171 while (Lex.getCode() == tgtok::StrVal) {
1172 Val += Lex.getCurStrVal();
1176 R = StringInit::get(Val);
1179 case tgtok::CodeFragment:
1180 R = StringInit::get(Lex.getCurStrVal());
1183 case tgtok::question:
1184 R = UnsetInit::get();
1188 SMLoc NameLoc = Lex.getLoc();
1189 std::string Name = Lex.getCurStrVal();
1190 if (Lex.Lex() != tgtok::less) // consume the Id.
1191 return ParseIDValue(CurRec, Name, NameLoc, Mode); // Value ::= IDValue
1193 // Value ::= ID '<' ValueListNE '>'
1194 if (Lex.Lex() == tgtok::greater) {
1195 TokError("expected non-empty value list");
1199 // This is a CLASS<initvalslist> expression. This is supposed to synthesize
1200 // a new anonymous definition, deriving from CLASS<initvalslist> with no
1202 Record *Class = Records.getClass(Name);
1204 Error(NameLoc, "Expected a class name, got '" + Name + "'");
1208 std::vector<Init*> ValueList = ParseValueList(CurRec, Class);
1209 if (ValueList.empty()) return 0;
1211 if (Lex.getCode() != tgtok::greater) {
1212 TokError("expected '>' at end of value list");
1215 Lex.Lex(); // eat the '>'
1216 SMLoc EndLoc = Lex.getLoc();
1218 // Create the new record, set it as CurRec temporarily.
1219 Record *NewRec = new Record(GetNewAnonymousName(), NameLoc, Records,
1220 /*IsAnonymous=*/true);
1221 SubClassReference SCRef;
1222 SCRef.RefRange = SMRange(NameLoc, EndLoc);
1224 SCRef.TemplateArgs = ValueList;
1225 // Add info about the subclass to NewRec.
1226 if (AddSubClass(NewRec, SCRef))
1228 NewRec->resolveReferences();
1229 Records.addDef(NewRec);
1231 // The result of the expression is a reference to the new record.
1232 return DefInit::get(NewRec);
1234 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
1235 SMLoc BraceLoc = Lex.getLoc();
1236 Lex.Lex(); // eat the '{'
1237 std::vector<Init*> Vals;
1239 if (Lex.getCode() != tgtok::r_brace) {
1240 Vals = ParseValueList(CurRec);
1241 if (Vals.empty()) return 0;
1243 if (Lex.getCode() != tgtok::r_brace) {
1244 TokError("expected '}' at end of bit list value");
1247 Lex.Lex(); // eat the '}'
1249 SmallVector<Init *, 16> NewBits(Vals.size());
1251 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1252 Init *Bit = Vals[i]->convertInitializerTo(BitRecTy::get());
1254 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1255 ") is not convertable to a bit");
1258 NewBits[Vals.size()-i-1] = Bit;
1260 return BitsInit::get(NewBits);
1262 case tgtok::l_square: { // Value ::= '[' ValueList ']'
1263 Lex.Lex(); // eat the '['
1264 std::vector<Init*> Vals;
1266 RecTy *DeducedEltTy = 0;
1267 ListRecTy *GivenListTy = 0;
1269 if (ItemType != 0) {
1270 ListRecTy *ListType = dyn_cast<ListRecTy>(ItemType);
1271 if (ListType == 0) {
1273 raw_string_ostream ss(s);
1274 ss << "Type mismatch for list, expected list type, got "
1275 << ItemType->getAsString();
1279 GivenListTy = ListType;
1282 if (Lex.getCode() != tgtok::r_square) {
1283 Vals = ParseValueList(CurRec, 0,
1284 GivenListTy ? GivenListTy->getElementType() : 0);
1285 if (Vals.empty()) return 0;
1287 if (Lex.getCode() != tgtok::r_square) {
1288 TokError("expected ']' at end of list value");
1291 Lex.Lex(); // eat the ']'
1293 RecTy *GivenEltTy = 0;
1294 if (Lex.getCode() == tgtok::less) {
1295 // Optional list element type
1296 Lex.Lex(); // eat the '<'
1298 GivenEltTy = ParseType();
1299 if (GivenEltTy == 0) {
1300 // Couldn't parse element type
1304 if (Lex.getCode() != tgtok::greater) {
1305 TokError("expected '>' at end of list element type");
1308 Lex.Lex(); // eat the '>'
1313 for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1316 TypedInit *TArg = dyn_cast<TypedInit>(*i);
1318 TokError("Untyped list element");
1322 EltTy = resolveTypes(EltTy, TArg->getType());
1324 TokError("Incompatible types in list elements");
1328 EltTy = TArg->getType();
1332 if (GivenEltTy != 0) {
1334 // Verify consistency
1335 if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1336 TokError("Incompatible types in list elements");
1344 if (ItemType == 0) {
1345 TokError("No type for list");
1348 DeducedEltTy = GivenListTy->getElementType();
1350 // Make sure the deduced type is compatible with the given type
1352 if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1353 TokError("Element type mismatch for list");
1357 DeducedEltTy = EltTy;
1360 return ListInit::get(Vals, DeducedEltTy);
1362 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
1363 Lex.Lex(); // eat the '('
1364 if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1365 TokError("expected identifier in dag init");
1369 Init *Operator = ParseValue(CurRec);
1370 if (Operator == 0) return 0;
1372 // If the operator name is present, parse it.
1373 std::string OperatorName;
1374 if (Lex.getCode() == tgtok::colon) {
1375 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1376 TokError("expected variable name in dag operator");
1379 OperatorName = Lex.getCurStrVal();
1380 Lex.Lex(); // eat the VarName.
1383 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1384 if (Lex.getCode() != tgtok::r_paren) {
1385 DagArgs = ParseDagArgList(CurRec);
1386 if (DagArgs.empty()) return 0;
1389 if (Lex.getCode() != tgtok::r_paren) {
1390 TokError("expected ')' in dag init");
1393 Lex.Lex(); // eat the ')'
1395 return DagInit::get(Operator, OperatorName, DagArgs);
1401 case tgtok::XCast: // Value ::= !unop '(' Value ')'
1402 case tgtok::XConcat:
1408 case tgtok::XStrConcat: // Value ::= !binop '(' Value ',' Value ')'
1410 case tgtok::XForEach:
1411 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1412 return ParseOperation(CurRec);
1419 /// ParseValue - Parse a tblgen value. This returns null on error.
1421 /// Value ::= SimpleValue ValueSuffix*
1422 /// ValueSuffix ::= '{' BitList '}'
1423 /// ValueSuffix ::= '[' BitList ']'
1424 /// ValueSuffix ::= '.' ID
1426 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType, IDParseMode Mode) {
1427 Init *Result = ParseSimpleValue(CurRec, ItemType, Mode);
1428 if (Result == 0) return 0;
1430 // Parse the suffixes now if present.
1432 switch (Lex.getCode()) {
1433 default: return Result;
1434 case tgtok::l_brace: {
1435 if (Mode == ParseNameMode || Mode == ParseForeachMode)
1436 // This is the beginning of the object body.
1439 SMLoc CurlyLoc = Lex.getLoc();
1440 Lex.Lex(); // eat the '{'
1441 std::vector<unsigned> Ranges = ParseRangeList();
1442 if (Ranges.empty()) return 0;
1444 // Reverse the bitlist.
1445 std::reverse(Ranges.begin(), Ranges.end());
1446 Result = Result->convertInitializerBitRange(Ranges);
1448 Error(CurlyLoc, "Invalid bit range for value");
1453 if (Lex.getCode() != tgtok::r_brace) {
1454 TokError("expected '}' at end of bit range list");
1460 case tgtok::l_square: {
1461 SMLoc SquareLoc = Lex.getLoc();
1462 Lex.Lex(); // eat the '['
1463 std::vector<unsigned> Ranges = ParseRangeList();
1464 if (Ranges.empty()) return 0;
1466 Result = Result->convertInitListSlice(Ranges);
1468 Error(SquareLoc, "Invalid range for list slice");
1473 if (Lex.getCode() != tgtok::r_square) {
1474 TokError("expected ']' at end of list slice");
1481 if (Lex.Lex() != tgtok::Id) { // eat the .
1482 TokError("expected field identifier after '.'");
1485 if (!Result->getFieldType(Lex.getCurStrVal())) {
1486 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1487 Result->getAsString() + "'");
1490 Result = FieldInit::get(Result, Lex.getCurStrVal());
1491 Lex.Lex(); // eat field name
1495 SMLoc PasteLoc = Lex.getLoc();
1497 // Create a !strconcat() operation, first casting each operand to
1498 // a string if necessary.
1500 TypedInit *LHS = dyn_cast<TypedInit>(Result);
1502 Error(PasteLoc, "LHS of paste is not typed!");
1506 if (LHS->getType() != StringRecTy::get()) {
1507 LHS = UnOpInit::get(UnOpInit::CAST, LHS, StringRecTy::get());
1512 Lex.Lex(); // Eat the '#'.
1513 switch (Lex.getCode()) {
1516 case tgtok::l_brace:
1517 // These are all of the tokens that can begin an object body.
1518 // Some of these can also begin values but we disallow those cases
1519 // because they are unlikely to be useful.
1521 // Trailing paste, concat with an empty string.
1522 RHS = StringInit::get("");
1526 Init *RHSResult = ParseValue(CurRec, ItemType, ParseNameMode);
1527 RHS = dyn_cast<TypedInit>(RHSResult);
1529 Error(PasteLoc, "RHS of paste is not typed!");
1533 if (RHS->getType() != StringRecTy::get()) {
1534 RHS = UnOpInit::get(UnOpInit::CAST, RHS, StringRecTy::get());
1540 Result = BinOpInit::get(BinOpInit::STRCONCAT, LHS, RHS,
1541 StringRecTy::get())->Fold(CurRec, CurMultiClass);
1547 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1549 /// DagArg ::= Value (':' VARNAME)?
1550 /// DagArg ::= VARNAME
1551 /// DagArgList ::= DagArg
1552 /// DagArgList ::= DagArgList ',' DagArg
1553 std::vector<std::pair<llvm::Init*, std::string> >
1554 TGParser::ParseDagArgList(Record *CurRec) {
1555 std::vector<std::pair<llvm::Init*, std::string> > Result;
1558 // DagArg ::= VARNAME
1559 if (Lex.getCode() == tgtok::VarName) {
1560 // A missing value is treated like '?'.
1561 Result.push_back(std::make_pair(UnsetInit::get(), Lex.getCurStrVal()));
1564 // DagArg ::= Value (':' VARNAME)?
1565 Init *Val = ParseValue(CurRec);
1567 return std::vector<std::pair<llvm::Init*, std::string> >();
1569 // If the variable name is present, add it.
1570 std::string VarName;
1571 if (Lex.getCode() == tgtok::colon) {
1572 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1573 TokError("expected variable name in dag literal");
1574 return std::vector<std::pair<llvm::Init*, std::string> >();
1576 VarName = Lex.getCurStrVal();
1577 Lex.Lex(); // eat the VarName.
1580 Result.push_back(std::make_pair(Val, VarName));
1582 if (Lex.getCode() != tgtok::comma) break;
1583 Lex.Lex(); // eat the ','
1590 /// ParseValueList - Parse a comma separated list of values, returning them as a
1591 /// vector. Note that this always expects to be able to parse at least one
1592 /// value. It returns an empty list if this is not possible.
1594 /// ValueList ::= Value (',' Value)
1596 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1598 std::vector<Init*> Result;
1599 RecTy *ItemType = EltTy;
1600 unsigned int ArgN = 0;
1601 if (ArgsRec != 0 && EltTy == 0) {
1602 const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1603 if (!TArgs.size()) {
1604 TokError("template argument provided to non-template class");
1605 return std::vector<Init*>();
1607 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1609 errs() << "Cannot find template arg " << ArgN << " (" << TArgs[ArgN]
1612 assert(RV && "Template argument record not found??");
1613 ItemType = RV->getType();
1616 Result.push_back(ParseValue(CurRec, ItemType));
1617 if (Result.back() == 0) return std::vector<Init*>();
1619 while (Lex.getCode() == tgtok::comma) {
1620 Lex.Lex(); // Eat the comma
1622 if (ArgsRec != 0 && EltTy == 0) {
1623 const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1624 if (ArgN >= TArgs.size()) {
1625 TokError("too many template arguments");
1626 return std::vector<Init*>();
1628 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1629 assert(RV && "Template argument record not found??");
1630 ItemType = RV->getType();
1633 Result.push_back(ParseValue(CurRec, ItemType));
1634 if (Result.back() == 0) return std::vector<Init*>();
1641 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1642 /// empty string on error. This can happen in a number of different context's,
1643 /// including within a def or in the template args for a def (which which case
1644 /// CurRec will be non-null) and within the template args for a multiclass (in
1645 /// which case CurRec will be null, but CurMultiClass will be set). This can
1646 /// also happen within a def that is within a multiclass, which will set both
1647 /// CurRec and CurMultiClass.
1649 /// Declaration ::= FIELD? Type ID ('=' Value)?
1651 Init *TGParser::ParseDeclaration(Record *CurRec,
1652 bool ParsingTemplateArgs) {
1653 // Read the field prefix if present.
1654 bool HasField = Lex.getCode() == tgtok::Field;
1655 if (HasField) Lex.Lex();
1657 RecTy *Type = ParseType();
1658 if (Type == 0) return 0;
1660 if (Lex.getCode() != tgtok::Id) {
1661 TokError("Expected identifier in declaration");
1665 SMLoc IdLoc = Lex.getLoc();
1666 Init *DeclName = StringInit::get(Lex.getCurStrVal());
1669 if (ParsingTemplateArgs) {
1671 DeclName = QualifyName(*CurRec, CurMultiClass, DeclName, ":");
1673 assert(CurMultiClass);
1676 DeclName = QualifyName(CurMultiClass->Rec, CurMultiClass, DeclName,
1681 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1684 // If a value is present, parse it.
1685 if (Lex.getCode() == tgtok::equal) {
1687 SMLoc ValLoc = Lex.getLoc();
1688 Init *Val = ParseValue(CurRec, Type);
1690 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1697 /// ParseForeachDeclaration - Read a foreach declaration, returning
1698 /// the name of the declared object or a NULL Init on error. Return
1699 /// the name of the parsed initializer list through ForeachListName.
1701 /// ForeachDeclaration ::= ID '=' '[' ValueList ']'
1702 /// ForeachDeclaration ::= ID '=' '{' RangeList '}'
1703 /// ForeachDeclaration ::= ID '=' RangePiece
1705 VarInit *TGParser::ParseForeachDeclaration(ListInit *&ForeachListValue) {
1706 if (Lex.getCode() != tgtok::Id) {
1707 TokError("Expected identifier in foreach declaration");
1711 Init *DeclName = StringInit::get(Lex.getCurStrVal());
1714 // If a value is present, parse it.
1715 if (Lex.getCode() != tgtok::equal) {
1716 TokError("Expected '=' in foreach declaration");
1719 Lex.Lex(); // Eat the '='
1721 RecTy *IterType = 0;
1722 std::vector<unsigned> Ranges;
1724 switch (Lex.getCode()) {
1725 default: TokError("Unknown token when expecting a range list"); return 0;
1726 case tgtok::l_square: { // '[' ValueList ']'
1727 Init *List = ParseSimpleValue(0, 0, ParseForeachMode);
1728 ForeachListValue = dyn_cast<ListInit>(List);
1729 if (ForeachListValue == 0) {
1730 TokError("Expected a Value list");
1733 RecTy *ValueType = ForeachListValue->getType();
1734 ListRecTy *ListType = dyn_cast<ListRecTy>(ValueType);
1735 if (ListType == 0) {
1736 TokError("Value list is not of list type");
1739 IterType = ListType->getElementType();
1743 case tgtok::IntVal: { // RangePiece.
1744 if (ParseRangePiece(Ranges))
1749 case tgtok::l_brace: { // '{' RangeList '}'
1750 Lex.Lex(); // eat the '{'
1751 Ranges = ParseRangeList();
1752 if (Lex.getCode() != tgtok::r_brace) {
1753 TokError("expected '}' at end of bit range list");
1761 if (!Ranges.empty()) {
1762 assert(!IterType && "Type already initialized?");
1763 IterType = IntRecTy::get();
1764 std::vector<Init*> Values;
1765 for (unsigned i = 0, e = Ranges.size(); i != e; ++i)
1766 Values.push_back(IntInit::get(Ranges[i]));
1767 ForeachListValue = ListInit::get(Values, IterType);
1773 return VarInit::get(DeclName, IterType);
1776 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1777 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
1778 /// template args for a def, which may or may not be in a multiclass. If null,
1779 /// these are the template args for a multiclass.
1781 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1783 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1784 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1785 Lex.Lex(); // eat the '<'
1787 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1789 // Read the first declaration.
1790 Init *TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1794 TheRecToAddTo->addTemplateArg(TemplArg);
1796 while (Lex.getCode() == tgtok::comma) {
1797 Lex.Lex(); // eat the ','
1799 // Read the following declarations.
1800 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1803 TheRecToAddTo->addTemplateArg(TemplArg);
1806 if (Lex.getCode() != tgtok::greater)
1807 return TokError("expected '>' at end of template argument list");
1808 Lex.Lex(); // eat the '>'.
1813 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1815 /// BodyItem ::= Declaration ';'
1816 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
1817 bool TGParser::ParseBodyItem(Record *CurRec) {
1818 if (Lex.getCode() != tgtok::Let) {
1819 if (ParseDeclaration(CurRec, false) == 0)
1822 if (Lex.getCode() != tgtok::semi)
1823 return TokError("expected ';' after declaration");
1828 // LET ID OptionalRangeList '=' Value ';'
1829 if (Lex.Lex() != tgtok::Id)
1830 return TokError("expected field identifier after let");
1832 SMLoc IdLoc = Lex.getLoc();
1833 std::string FieldName = Lex.getCurStrVal();
1834 Lex.Lex(); // eat the field name.
1836 std::vector<unsigned> BitList;
1837 if (ParseOptionalBitList(BitList))
1839 std::reverse(BitList.begin(), BitList.end());
1841 if (Lex.getCode() != tgtok::equal)
1842 return TokError("expected '=' in let expression");
1843 Lex.Lex(); // eat the '='.
1845 RecordVal *Field = CurRec->getValue(FieldName);
1847 return TokError("Value '" + FieldName + "' unknown!");
1849 RecTy *Type = Field->getType();
1851 Init *Val = ParseValue(CurRec, Type);
1852 if (Val == 0) return true;
1854 if (Lex.getCode() != tgtok::semi)
1855 return TokError("expected ';' after let expression");
1858 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1861 /// ParseBody - Read the body of a class or def. Return true on error, false on
1865 /// Body ::= '{' BodyList '}'
1866 /// BodyList BodyItem*
1868 bool TGParser::ParseBody(Record *CurRec) {
1869 // If this is a null definition, just eat the semi and return.
1870 if (Lex.getCode() == tgtok::semi) {
1875 if (Lex.getCode() != tgtok::l_brace)
1876 return TokError("Expected ';' or '{' to start body");
1880 while (Lex.getCode() != tgtok::r_brace)
1881 if (ParseBodyItem(CurRec))
1889 /// \brief Apply the current let bindings to \a CurRec.
1890 /// \returns true on error, false otherwise.
1891 bool TGParser::ApplyLetStack(Record *CurRec) {
1892 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1893 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1894 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1895 LetStack[i][j].Bits, LetStack[i][j].Value))
1900 /// ParseObjectBody - Parse the body of a def or class. This consists of an
1901 /// optional ClassList followed by a Body. CurRec is the current def or class
1902 /// that is being parsed.
1904 /// ObjectBody ::= BaseClassList Body
1905 /// BaseClassList ::= /*empty*/
1906 /// BaseClassList ::= ':' BaseClassListNE
1907 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1909 bool TGParser::ParseObjectBody(Record *CurRec) {
1910 // If there is a baseclass list, read it.
1911 if (Lex.getCode() == tgtok::colon) {
1914 // Read all of the subclasses.
1915 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1918 if (SubClass.Rec == 0) return true;
1921 if (AddSubClass(CurRec, SubClass))
1924 if (Lex.getCode() != tgtok::comma) break;
1925 Lex.Lex(); // eat ','.
1926 SubClass = ParseSubClassReference(CurRec, false);
1930 if (ApplyLetStack(CurRec))
1933 return ParseBody(CurRec);
1936 /// ParseDef - Parse and return a top level or multiclass def, return the record
1937 /// corresponding to it. This returns null on error.
1939 /// DefInst ::= DEF ObjectName ObjectBody
1941 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
1942 SMLoc DefLoc = Lex.getLoc();
1943 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1944 Lex.Lex(); // Eat the 'def' token.
1946 // Parse ObjectName and make a record for it.
1948 Init *Name = ParseObjectName(CurMultiClass);
1950 CurRec = new Record(Name, DefLoc, Records);
1952 CurRec = new Record(GetNewAnonymousName(), DefLoc, Records,
1953 /*IsAnonymous=*/true);
1955 if (!CurMultiClass && Loops.empty()) {
1956 // Top-level def definition.
1958 // Ensure redefinition doesn't happen.
1959 if (Records.getDef(CurRec->getNameInitAsString())) {
1960 Error(DefLoc, "def '" + CurRec->getNameInitAsString()
1961 + "' already defined");
1964 Records.addDef(CurRec);
1965 } else if (CurMultiClass) {
1966 // Otherwise, a def inside a multiclass, add it to the multiclass.
1967 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1968 if (CurMultiClass->DefPrototypes[i]->getNameInit()
1969 == CurRec->getNameInit()) {
1970 Error(DefLoc, "def '" + CurRec->getNameInitAsString() +
1971 "' already defined in this multiclass!");
1974 CurMultiClass->DefPrototypes.push_back(CurRec);
1977 if (ParseObjectBody(CurRec))
1980 if (CurMultiClass == 0) // Def's in multiclasses aren't really defs.
1981 // See Record::setName(). This resolve step will see any new name
1982 // for the def that might have been created when resolving
1983 // inheritance, values and arguments above.
1984 CurRec->resolveReferences();
1986 // If ObjectBody has template arguments, it's an error.
1987 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1989 if (CurMultiClass) {
1990 // Copy the template arguments for the multiclass into the def.
1991 const std::vector<Init *> &TArgs =
1992 CurMultiClass->Rec.getTemplateArgs();
1994 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1995 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1996 assert(RV && "Template arg doesn't exist?");
1997 CurRec->addValue(*RV);
2001 if (ProcessForeachDefs(CurRec, DefLoc)) {
2003 "Could not process loops for def" + CurRec->getNameInitAsString());
2010 /// ParseForeach - Parse a for statement. Return the record corresponding
2011 /// to it. This returns true on error.
2013 /// Foreach ::= FOREACH Declaration IN '{ ObjectList '}'
2014 /// Foreach ::= FOREACH Declaration IN Object
2016 bool TGParser::ParseForeach(MultiClass *CurMultiClass) {
2017 assert(Lex.getCode() == tgtok::Foreach && "Unknown tok");
2018 Lex.Lex(); // Eat the 'for' token.
2020 // Make a temporary object to record items associated with the for
2022 ListInit *ListValue = 0;
2023 VarInit *IterName = ParseForeachDeclaration(ListValue);
2025 return TokError("expected declaration in for");
2027 if (Lex.getCode() != tgtok::In)
2028 return TokError("Unknown tok");
2029 Lex.Lex(); // Eat the in
2031 // Create a loop object and remember it.
2032 Loops.push_back(ForeachLoop(IterName, ListValue));
2034 if (Lex.getCode() != tgtok::l_brace) {
2035 // FOREACH Declaration IN Object
2036 if (ParseObject(CurMultiClass))
2040 SMLoc BraceLoc = Lex.getLoc();
2041 // Otherwise, this is a group foreach.
2042 Lex.Lex(); // eat the '{'.
2044 // Parse the object list.
2045 if (ParseObjectList(CurMultiClass))
2048 if (Lex.getCode() != tgtok::r_brace) {
2049 TokError("expected '}' at end of foreach command");
2050 return Error(BraceLoc, "to match this '{'");
2052 Lex.Lex(); // Eat the }
2055 // We've processed everything in this loop.
2061 /// ParseClass - Parse a tblgen class definition.
2063 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
2065 bool TGParser::ParseClass() {
2066 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
2069 if (Lex.getCode() != tgtok::Id)
2070 return TokError("expected class name after 'class' keyword");
2072 Record *CurRec = Records.getClass(Lex.getCurStrVal());
2074 // If the body was previously defined, this is an error.
2075 if (CurRec->getValues().size() > 1 || // Account for NAME.
2076 !CurRec->getSuperClasses().empty() ||
2077 !CurRec->getTemplateArgs().empty())
2078 return TokError("Class '" + CurRec->getNameInitAsString()
2079 + "' already defined");
2081 // If this is the first reference to this class, create and add it.
2082 CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc(), Records);
2083 Records.addClass(CurRec);
2085 Lex.Lex(); // eat the name.
2087 // If there are template args, parse them.
2088 if (Lex.getCode() == tgtok::less)
2089 if (ParseTemplateArgList(CurRec))
2092 // Finally, parse the object body.
2093 return ParseObjectBody(CurRec);
2096 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
2099 /// LetList ::= LetItem (',' LetItem)*
2100 /// LetItem ::= ID OptionalRangeList '=' Value
2102 std::vector<LetRecord> TGParser::ParseLetList() {
2103 std::vector<LetRecord> Result;
2106 if (Lex.getCode() != tgtok::Id) {
2107 TokError("expected identifier in let definition");
2108 return std::vector<LetRecord>();
2110 std::string Name = Lex.getCurStrVal();
2111 SMLoc NameLoc = Lex.getLoc();
2112 Lex.Lex(); // Eat the identifier.
2114 // Check for an optional RangeList.
2115 std::vector<unsigned> Bits;
2116 if (ParseOptionalRangeList(Bits))
2117 return std::vector<LetRecord>();
2118 std::reverse(Bits.begin(), Bits.end());
2120 if (Lex.getCode() != tgtok::equal) {
2121 TokError("expected '=' in let expression");
2122 return std::vector<LetRecord>();
2124 Lex.Lex(); // eat the '='.
2126 Init *Val = ParseValue(0);
2127 if (Val == 0) return std::vector<LetRecord>();
2129 // Now that we have everything, add the record.
2130 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
2132 if (Lex.getCode() != tgtok::comma)
2134 Lex.Lex(); // eat the comma.
2138 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
2139 /// different related productions. This works inside multiclasses too.
2141 /// Object ::= LET LetList IN '{' ObjectList '}'
2142 /// Object ::= LET LetList IN Object
2144 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
2145 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
2148 // Add this entry to the let stack.
2149 std::vector<LetRecord> LetInfo = ParseLetList();
2150 if (LetInfo.empty()) return true;
2151 LetStack.push_back(LetInfo);
2153 if (Lex.getCode() != tgtok::In)
2154 return TokError("expected 'in' at end of top-level 'let'");
2157 // If this is a scalar let, just handle it now
2158 if (Lex.getCode() != tgtok::l_brace) {
2159 // LET LetList IN Object
2160 if (ParseObject(CurMultiClass))
2162 } else { // Object ::= LETCommand '{' ObjectList '}'
2163 SMLoc BraceLoc = Lex.getLoc();
2164 // Otherwise, this is a group let.
2165 Lex.Lex(); // eat the '{'.
2167 // Parse the object list.
2168 if (ParseObjectList(CurMultiClass))
2171 if (Lex.getCode() != tgtok::r_brace) {
2172 TokError("expected '}' at end of top level let command");
2173 return Error(BraceLoc, "to match this '{'");
2178 // Outside this let scope, this let block is not active.
2179 LetStack.pop_back();
2183 /// ParseMultiClass - Parse a multiclass definition.
2185 /// MultiClassInst ::= MULTICLASS ID TemplateArgList?
2186 /// ':' BaseMultiClassList '{' MultiClassObject+ '}'
2187 /// MultiClassObject ::= DefInst
2188 /// MultiClassObject ::= MultiClassInst
2189 /// MultiClassObject ::= DefMInst
2190 /// MultiClassObject ::= LETCommand '{' ObjectList '}'
2191 /// MultiClassObject ::= LETCommand Object
2193 bool TGParser::ParseMultiClass() {
2194 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
2195 Lex.Lex(); // Eat the multiclass token.
2197 if (Lex.getCode() != tgtok::Id)
2198 return TokError("expected identifier after multiclass for name");
2199 std::string Name = Lex.getCurStrVal();
2201 if (MultiClasses.count(Name))
2202 return TokError("multiclass '" + Name + "' already defined");
2204 CurMultiClass = MultiClasses[Name] = new MultiClass(Name,
2205 Lex.getLoc(), Records);
2206 Lex.Lex(); // Eat the identifier.
2208 // If there are template args, parse them.
2209 if (Lex.getCode() == tgtok::less)
2210 if (ParseTemplateArgList(0))
2213 bool inherits = false;
2215 // If there are submulticlasses, parse them.
2216 if (Lex.getCode() == tgtok::colon) {
2221 // Read all of the submulticlasses.
2222 SubMultiClassReference SubMultiClass =
2223 ParseSubMultiClassReference(CurMultiClass);
2226 if (SubMultiClass.MC == 0) return true;
2229 if (AddSubMultiClass(CurMultiClass, SubMultiClass))
2232 if (Lex.getCode() != tgtok::comma) break;
2233 Lex.Lex(); // eat ','.
2234 SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
2238 if (Lex.getCode() != tgtok::l_brace) {
2240 return TokError("expected '{' in multiclass definition");
2241 else if (Lex.getCode() != tgtok::semi)
2242 return TokError("expected ';' in multiclass definition");
2244 Lex.Lex(); // eat the ';'.
2246 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
2247 return TokError("multiclass must contain at least one def");
2249 while (Lex.getCode() != tgtok::r_brace) {
2250 switch (Lex.getCode()) {
2252 return TokError("expected 'let', 'def' or 'defm' in multiclass body");
2256 case tgtok::Foreach:
2257 if (ParseObject(CurMultiClass))
2262 Lex.Lex(); // eat the '}'.
2270 InstantiateMulticlassDef(MultiClass &MC,
2273 SMRange DefmPrefixRange) {
2274 // We need to preserve DefProto so it can be reused for later
2275 // instantiations, so create a new Record to inherit from it.
2277 // Add in the defm name. If the defm prefix is empty, give each
2278 // instantiated def a unique name. Otherwise, if "#NAME#" exists in the
2279 // name, substitute the prefix for #NAME#. Otherwise, use the defm name
2282 bool IsAnonymous = false;
2283 if (DefmPrefix == 0) {
2284 DefmPrefix = StringInit::get(GetNewAnonymousName());
2288 Init *DefName = DefProto->getNameInit();
2290 StringInit *DefNameString = dyn_cast<StringInit>(DefName);
2292 if (DefNameString != 0) {
2293 // We have a fully expanded string so there are no operators to
2294 // resolve. We should concatenate the given prefix and name.
2296 BinOpInit::get(BinOpInit::STRCONCAT,
2297 UnOpInit::get(UnOpInit::CAST, DefmPrefix,
2298 StringRecTy::get())->Fold(DefProto, &MC),
2299 DefName, StringRecTy::get())->Fold(DefProto, &MC);
2302 // Make a trail of SMLocs from the multiclass instantiations.
2303 SmallVector<SMLoc, 4> Locs(1, DefmPrefixRange.Start);
2304 Locs.append(DefProto->getLoc().begin(), DefProto->getLoc().end());
2305 Record *CurRec = new Record(DefName, Locs, Records, IsAnonymous);
2307 SubClassReference Ref;
2308 Ref.RefRange = DefmPrefixRange;
2310 AddSubClass(CurRec, Ref);
2312 // Set the value for NAME. We don't resolve references to it 'til later,
2313 // though, so that uses in nested multiclass names don't get
2315 if (SetValue(CurRec, Ref.RefRange.Start, "NAME", std::vector<unsigned>(),
2317 Error(DefmPrefixRange.Start, "Could not resolve "
2318 + CurRec->getNameInitAsString() + ":NAME to '"
2319 + DefmPrefix->getAsUnquotedString() + "'");
2323 // If the DefNameString didn't resolve, we probably have a reference to
2324 // NAME and need to replace it. We need to do at least this much greedily,
2325 // otherwise nested multiclasses will end up with incorrect NAME expansions.
2326 if (DefNameString == 0) {
2327 RecordVal *DefNameRV = CurRec->getValue("NAME");
2328 CurRec->resolveReferencesTo(DefNameRV);
2331 if (!CurMultiClass) {
2332 // Now that we're at the top level, resolve all NAME references
2333 // in the resultant defs that weren't in the def names themselves.
2334 RecordVal *DefNameRV = CurRec->getValue("NAME");
2335 CurRec->resolveReferencesTo(DefNameRV);
2337 // Now that NAME references are resolved and we're at the top level of
2338 // any multiclass expansions, add the record to the RecordKeeper. If we are
2339 // currently in a multiclass, it means this defm appears inside a
2340 // multiclass and its name won't be fully resolvable until we see
2341 // the top-level defm. Therefore, we don't add this to the
2342 // RecordKeeper at this point. If we did we could get duplicate
2343 // defs as more than one probably refers to NAME or some other
2344 // common internal placeholder.
2346 // Ensure redefinition doesn't happen.
2347 if (Records.getDef(CurRec->getNameInitAsString())) {
2348 Error(DefmPrefixRange.Start, "def '" + CurRec->getNameInitAsString() +
2349 "' already defined, instantiating defm with subdef '" +
2350 DefProto->getNameInitAsString() + "'");
2354 Records.addDef(CurRec);
2360 bool TGParser::ResolveMulticlassDefArgs(MultiClass &MC,
2362 SMLoc DefmPrefixLoc,
2364 const std::vector<Init *> &TArgs,
2365 std::vector<Init *> &TemplateVals,
2367 // Loop over all of the template arguments, setting them to the specified
2368 // value or leaving them as the default if necessary.
2369 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2370 // Check if a value is specified for this temp-arg.
2371 if (i < TemplateVals.size()) {
2373 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
2378 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
2382 CurRec->removeValue(TArgs[i]);
2384 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2385 return Error(SubClassLoc, "value not specified for template argument #"+
2386 utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
2387 + ") of multiclassclass '" + MC.Rec.getNameInitAsString()
2394 bool TGParser::ResolveMulticlassDef(MultiClass &MC,
2397 SMLoc DefmPrefixLoc) {
2398 // If the mdef is inside a 'let' expression, add to each def.
2399 if (ApplyLetStack(CurRec))
2400 return Error(DefmPrefixLoc, "when instantiating this defm");
2402 // Don't create a top level definition for defm inside multiclasses,
2403 // instead, only update the prototypes and bind the template args
2404 // with the new created definition.
2407 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2409 if (CurMultiClass->DefPrototypes[i]->getNameInit()
2410 == CurRec->getNameInit())
2411 return Error(DefmPrefixLoc, "defm '" + CurRec->getNameInitAsString() +
2412 "' already defined in this multiclass!");
2413 CurMultiClass->DefPrototypes.push_back(CurRec);
2415 // Copy the template arguments for the multiclass into the new def.
2416 const std::vector<Init *> &TA =
2417 CurMultiClass->Rec.getTemplateArgs();
2419 for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2420 const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2421 assert(RV && "Template arg doesn't exist?");
2422 CurRec->addValue(*RV);
2428 /// ParseDefm - Parse the instantiation of a multiclass.
2430 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
2432 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
2433 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
2434 SMLoc DefmLoc = Lex.getLoc();
2435 Init *DefmPrefix = 0;
2437 if (Lex.Lex() == tgtok::Id) { // eat the defm.
2438 DefmPrefix = ParseObjectName(CurMultiClass);
2441 SMLoc DefmPrefixEndLoc = Lex.getLoc();
2442 if (Lex.getCode() != tgtok::colon)
2443 return TokError("expected ':' after defm identifier");
2445 // Keep track of the new generated record definitions.
2446 std::vector<Record*> NewRecDefs;
2448 // This record also inherits from a regular class (non-multiclass)?
2449 bool InheritFromClass = false;
2454 SMLoc SubClassLoc = Lex.getLoc();
2455 SubClassReference Ref = ParseSubClassReference(0, true);
2458 if (Ref.Rec == 0) return true;
2460 // To instantiate a multiclass, we need to first get the multiclass, then
2461 // instantiate each def contained in the multiclass with the SubClassRef
2462 // template parameters.
2463 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
2464 assert(MC && "Didn't lookup multiclass correctly?");
2465 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
2467 // Verify that the correct number of template arguments were specified.
2468 const std::vector<Init *> &TArgs = MC->Rec.getTemplateArgs();
2469 if (TArgs.size() < TemplateVals.size())
2470 return Error(SubClassLoc,
2471 "more template args specified than multiclass expects");
2473 // Loop over all the def's in the multiclass, instantiating each one.
2474 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
2475 Record *DefProto = MC->DefPrototypes[i];
2477 Record *CurRec = InstantiateMulticlassDef(*MC, DefProto, DefmPrefix,
2483 if (ResolveMulticlassDefArgs(*MC, CurRec, DefmLoc, SubClassLoc,
2484 TArgs, TemplateVals, true/*Delete args*/))
2485 return Error(SubClassLoc, "could not instantiate def");
2487 if (ResolveMulticlassDef(*MC, CurRec, DefProto, DefmLoc))
2488 return Error(SubClassLoc, "could not instantiate def");
2490 NewRecDefs.push_back(CurRec);
2494 if (Lex.getCode() != tgtok::comma) break;
2495 Lex.Lex(); // eat ','.
2497 if (Lex.getCode() != tgtok::Id)
2498 return TokError("expected identifier");
2500 SubClassLoc = Lex.getLoc();
2502 // A defm can inherit from regular classes (non-multiclass) as
2503 // long as they come in the end of the inheritance list.
2504 InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != 0);
2506 if (InheritFromClass)
2509 Ref = ParseSubClassReference(0, true);
2512 if (InheritFromClass) {
2513 // Process all the classes to inherit as if they were part of a
2514 // regular 'def' and inherit all record values.
2515 SubClassReference SubClass = ParseSubClassReference(0, false);
2518 if (SubClass.Rec == 0) return true;
2520 // Get the expanded definition prototypes and teach them about
2521 // the record values the current class to inherit has
2522 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2523 Record *CurRec = NewRecDefs[i];
2526 if (AddSubClass(CurRec, SubClass))
2529 if (ApplyLetStack(CurRec))
2533 if (Lex.getCode() != tgtok::comma) break;
2534 Lex.Lex(); // eat ','.
2535 SubClass = ParseSubClassReference(0, false);
2540 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2541 // See Record::setName(). This resolve step will see any new
2542 // name for the def that might have been created when resolving
2543 // inheritance, values and arguments above.
2544 NewRecDefs[i]->resolveReferences();
2546 if (Lex.getCode() != tgtok::semi)
2547 return TokError("expected ';' at end of defm");
2554 /// Object ::= ClassInst
2555 /// Object ::= DefInst
2556 /// Object ::= MultiClassInst
2557 /// Object ::= DefMInst
2558 /// Object ::= LETCommand '{' ObjectList '}'
2559 /// Object ::= LETCommand Object
2560 bool TGParser::ParseObject(MultiClass *MC) {
2561 switch (Lex.getCode()) {
2563 return TokError("Expected class, def, defm, multiclass or let definition");
2564 case tgtok::Let: return ParseTopLevelLet(MC);
2565 case tgtok::Def: return ParseDef(MC);
2566 case tgtok::Foreach: return ParseForeach(MC);
2567 case tgtok::Defm: return ParseDefm(MC);
2568 case tgtok::Class: return ParseClass();
2569 case tgtok::MultiClass: return ParseMultiClass();
2574 /// ObjectList :== Object*
2575 bool TGParser::ParseObjectList(MultiClass *MC) {
2576 while (isObjectStart(Lex.getCode())) {
2577 if (ParseObject(MC))
2583 bool TGParser::ParseFile() {
2584 Lex.Lex(); // Prime the lexer.
2585 if (ParseObjectList()) return true;
2587 // If we have unread input at the end of the file, report it.
2588 if (Lex.getCode() == tgtok::Eof)
2591 return TokError("Unexpected input at top level");