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(nullptr) {}
34 bool isInvalid() const { return Rec == nullptr; }
37 struct SubMultiClassReference {
40 std::vector<Init*> TemplateArgs;
41 SubMultiClassReference() : MC(nullptr) {}
43 bool isInvalid() const { return MC == nullptr; }
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) 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);
118 assert(BInit != nullptr);
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);
138 if (RV->setValue(V)) {
139 std::string InitType = "";
140 if (BitsInit *BI = dyn_cast<BitsInit>(V)) {
141 InitType = (Twine("' of type bit initializer with length ") +
142 Twine(BI->getNumBits())).str();
144 return Error(Loc, "Value '" + ValName->getAsUnquotedString() + "' of type '"
145 + RV->getType()->getAsString() +
146 "' is incompatible with initializer '" + V->getAsString()
153 /// AddSubClass - Add SubClass as a subclass to CurRec, resolving its template
154 /// args as SubClass's template arguments.
155 bool TGParser::AddSubClass(Record *CurRec, SubClassReference &SubClass) {
156 Record *SC = SubClass.Rec;
157 // Add all of the values in the subclass into the current class.
158 const std::vector<RecordVal> &Vals = SC->getValues();
159 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
160 if (AddValue(CurRec, SubClass.RefRange.Start, Vals[i]))
163 const std::vector<Init *> &TArgs = SC->getTemplateArgs();
165 // Ensure that an appropriate number of template arguments are specified.
166 if (TArgs.size() < SubClass.TemplateArgs.size())
167 return Error(SubClass.RefRange.Start,
168 "More template args specified than expected");
170 // Loop over all of the template arguments, setting them to the specified
171 // value or leaving them as the default if necessary.
172 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
173 if (i < SubClass.TemplateArgs.size()) {
174 // If a value is specified for this template arg, set it now.
175 if (SetValue(CurRec, SubClass.RefRange.Start, TArgs[i],
176 std::vector<unsigned>(), SubClass.TemplateArgs[i]))
180 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
183 CurRec->removeValue(TArgs[i]);
185 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
186 return Error(SubClass.RefRange.Start,
187 "Value not specified for template argument #"
188 + utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
189 + ") of subclass '" + SC->getNameInitAsString() + "'!");
193 // Since everything went well, we can now set the "superclass" list for the
195 const std::vector<Record*> &SCs = SC->getSuperClasses();
196 ArrayRef<SMRange> SCRanges = SC->getSuperClassRanges();
197 for (unsigned i = 0, e = SCs.size(); i != e; ++i) {
198 if (CurRec->isSubClassOf(SCs[i]))
199 return Error(SubClass.RefRange.Start,
200 "Already subclass of '" + SCs[i]->getName() + "'!\n");
201 CurRec->addSuperClass(SCs[i], SCRanges[i]);
204 if (CurRec->isSubClassOf(SC))
205 return Error(SubClass.RefRange.Start,
206 "Already subclass of '" + SC->getName() + "'!\n");
207 CurRec->addSuperClass(SC, SubClass.RefRange);
211 /// AddSubMultiClass - Add SubMultiClass as a subclass to
212 /// CurMC, resolving its template args as SubMultiClass's
213 /// template arguments.
214 bool TGParser::AddSubMultiClass(MultiClass *CurMC,
215 SubMultiClassReference &SubMultiClass) {
216 MultiClass *SMC = SubMultiClass.MC;
217 Record *CurRec = &CurMC->Rec;
219 const std::vector<RecordVal> &MCVals = CurRec->getValues();
221 // Add all of the values in the subclass into the current class.
222 const std::vector<RecordVal> &SMCVals = SMC->Rec.getValues();
223 for (unsigned i = 0, e = SMCVals.size(); i != e; ++i)
224 if (AddValue(CurRec, SubMultiClass.RefRange.Start, SMCVals[i]))
227 int newDefStart = CurMC->DefPrototypes.size();
229 // Add all of the defs in the subclass into the current multiclass.
230 for (MultiClass::RecordVector::const_iterator i = SMC->DefPrototypes.begin(),
231 iend = SMC->DefPrototypes.end();
234 // Clone the def and add it to the current multiclass
235 Record *NewDef = new Record(**i);
237 // Add all of the values in the superclass into the current def.
238 for (unsigned i = 0, e = MCVals.size(); i != e; ++i)
239 if (AddValue(NewDef, SubMultiClass.RefRange.Start, MCVals[i]))
242 CurMC->DefPrototypes.push_back(NewDef);
245 const std::vector<Init *> &SMCTArgs = SMC->Rec.getTemplateArgs();
247 // Ensure that an appropriate number of template arguments are
249 if (SMCTArgs.size() < SubMultiClass.TemplateArgs.size())
250 return Error(SubMultiClass.RefRange.Start,
251 "More template args specified than expected");
253 // Loop over all of the template arguments, setting them to the specified
254 // value or leaving them as the default if necessary.
255 for (unsigned i = 0, e = SMCTArgs.size(); i != e; ++i) {
256 if (i < SubMultiClass.TemplateArgs.size()) {
257 // If a value is specified for this template arg, set it in the
259 if (SetValue(CurRec, SubMultiClass.RefRange.Start, SMCTArgs[i],
260 std::vector<unsigned>(),
261 SubMultiClass.TemplateArgs[i]))
265 CurRec->resolveReferencesTo(CurRec->getValue(SMCTArgs[i]));
268 CurRec->removeValue(SMCTArgs[i]);
270 // If a value is specified for this template arg, set it in the
272 for (MultiClass::RecordVector::iterator j =
273 CurMC->DefPrototypes.begin() + newDefStart,
274 jend = CurMC->DefPrototypes.end();
279 if (SetValue(Def, SubMultiClass.RefRange.Start, SMCTArgs[i],
280 std::vector<unsigned>(),
281 SubMultiClass.TemplateArgs[i]))
285 Def->resolveReferencesTo(Def->getValue(SMCTArgs[i]));
288 Def->removeValue(SMCTArgs[i]);
290 } else if (!CurRec->getValue(SMCTArgs[i])->getValue()->isComplete()) {
291 return Error(SubMultiClass.RefRange.Start,
292 "Value not specified for template argument #"
293 + utostr(i) + " (" + SMCTArgs[i]->getAsUnquotedString()
294 + ") of subclass '" + SMC->Rec.getNameInitAsString() + "'!");
301 /// ProcessForeachDefs - Given a record, apply all of the variable
302 /// values in all surrounding foreach loops, creating new records for
303 /// each combination of values.
304 bool TGParser::ProcessForeachDefs(Record *CurRec, SMLoc Loc) {
308 // We want to instantiate a new copy of CurRec for each combination
309 // of nested loop iterator values. We don't want top instantiate
310 // any copies until we have values for each loop iterator.
312 return ProcessForeachDefs(CurRec, Loc, IterVals);
315 /// ProcessForeachDefs - Given a record, a loop and a loop iterator,
316 /// apply each of the variable values in this loop and then process
318 bool TGParser::ProcessForeachDefs(Record *CurRec, SMLoc Loc, IterSet &IterVals){
319 // Recursively build a tuple of iterator values.
320 if (IterVals.size() != Loops.size()) {
321 assert(IterVals.size() < Loops.size());
322 ForeachLoop &CurLoop = Loops[IterVals.size()];
323 ListInit *List = dyn_cast<ListInit>(CurLoop.ListValue);
325 Error(Loc, "Loop list is not a list");
329 // Process each value.
330 for (int64_t i = 0; i < List->getSize(); ++i) {
331 Init *ItemVal = List->resolveListElementReference(*CurRec, nullptr, i);
332 IterVals.push_back(IterRecord(CurLoop.IterVar, ItemVal));
333 if (ProcessForeachDefs(CurRec, Loc, IterVals))
340 // This is the bottom of the recursion. We have all of the iterator values
341 // for this point in the iteration space. Instantiate a new record to
342 // reflect this combination of values.
343 Record *IterRec = new Record(*CurRec);
345 // Set the iterator values now.
346 for (unsigned i = 0, e = IterVals.size(); i != e; ++i) {
347 VarInit *IterVar = IterVals[i].IterVar;
348 TypedInit *IVal = dyn_cast<TypedInit>(IterVals[i].IterValue);
350 Error(Loc, "foreach iterator value is untyped");
354 IterRec->addValue(RecordVal(IterVar->getName(), IVal->getType(), false));
356 if (SetValue(IterRec, Loc, IterVar->getName(),
357 std::vector<unsigned>(), IVal)) {
358 Error(Loc, "when instantiating this def");
363 IterRec->resolveReferencesTo(IterRec->getValue(IterVar->getName()));
366 IterRec->removeValue(IterVar->getName());
369 if (Records.getDef(IterRec->getNameInitAsString())) {
370 // If this record is anonymous, it's no problem, just generate a new name
371 if (IterRec->isAnonymous())
372 IterRec->setName(GetNewAnonymousName());
374 Error(Loc, "def already exists: " + IterRec->getNameInitAsString());
379 Records.addDef(IterRec);
380 IterRec->resolveReferences();
384 //===----------------------------------------------------------------------===//
386 //===----------------------------------------------------------------------===//
388 /// isObjectStart - Return true if this is a valid first token for an Object.
389 static bool isObjectStart(tgtok::TokKind K) {
390 return K == tgtok::Class || K == tgtok::Def ||
391 K == tgtok::Defm || K == tgtok::Let ||
392 K == tgtok::MultiClass || K == tgtok::Foreach;
395 /// GetNewAnonymousName - Generate a unique anonymous name that can be used as
397 std::string TGParser::GetNewAnonymousName() {
398 unsigned Tmp = AnonCounter++; // MSVC2012 ICEs without this.
399 return "anonymous_" + utostr(Tmp);
402 /// ParseObjectName - If an object name is specified, return it. Otherwise,
404 /// ObjectName ::= Value [ '#' Value ]*
405 /// ObjectName ::= /*empty*/
407 Init *TGParser::ParseObjectName(MultiClass *CurMultiClass) {
408 switch (Lex.getCode()) {
412 // These are all of the tokens that can begin an object body.
413 // Some of these can also begin values but we disallow those cases
414 // because they are unlikely to be useful.
420 Record *CurRec = nullptr;
422 CurRec = &CurMultiClass->Rec;
424 RecTy *Type = nullptr;
426 const TypedInit *CurRecName = dyn_cast<TypedInit>(CurRec->getNameInit());
428 TokError("Record name is not typed!");
431 Type = CurRecName->getType();
434 return ParseValue(CurRec, Type, ParseNameMode);
437 /// ParseClassID - Parse and resolve a reference to a class name. This returns
442 Record *TGParser::ParseClassID() {
443 if (Lex.getCode() != tgtok::Id) {
444 TokError("expected name for ClassID");
448 Record *Result = Records.getClass(Lex.getCurStrVal());
450 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
456 /// ParseMultiClassID - Parse and resolve a reference to a multiclass name.
457 /// This returns null on error.
459 /// MultiClassID ::= ID
461 MultiClass *TGParser::ParseMultiClassID() {
462 if (Lex.getCode() != tgtok::Id) {
463 TokError("expected name for MultiClassID");
467 MultiClass *Result = MultiClasses[Lex.getCurStrVal()];
469 TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
475 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
476 /// subclass. This returns a SubClassRefTy with a null Record* on error.
478 /// SubClassRef ::= ClassID
479 /// SubClassRef ::= ClassID '<' ValueList '>'
481 SubClassReference TGParser::
482 ParseSubClassReference(Record *CurRec, bool isDefm) {
483 SubClassReference Result;
484 Result.RefRange.Start = Lex.getLoc();
487 if (MultiClass *MC = ParseMultiClassID())
488 Result.Rec = &MC->Rec;
490 Result.Rec = ParseClassID();
492 if (!Result.Rec) return Result;
494 // If there is no template arg list, we're done.
495 if (Lex.getCode() != tgtok::less) {
496 Result.RefRange.End = Lex.getLoc();
499 Lex.Lex(); // Eat the '<'
501 if (Lex.getCode() == tgtok::greater) {
502 TokError("subclass reference requires a non-empty list of template values");
503 Result.Rec = nullptr;
507 Result.TemplateArgs = ParseValueList(CurRec, Result.Rec);
508 if (Result.TemplateArgs.empty()) {
509 Result.Rec = nullptr; // Error parsing value list.
513 if (Lex.getCode() != tgtok::greater) {
514 TokError("expected '>' in template value list");
515 Result.Rec = nullptr;
519 Result.RefRange.End = Lex.getLoc();
524 /// ParseSubMultiClassReference - Parse a reference to a subclass or to a
525 /// templated submulticlass. This returns a SubMultiClassRefTy with a null
526 /// Record* on error.
528 /// SubMultiClassRef ::= MultiClassID
529 /// SubMultiClassRef ::= MultiClassID '<' ValueList '>'
531 SubMultiClassReference TGParser::
532 ParseSubMultiClassReference(MultiClass *CurMC) {
533 SubMultiClassReference Result;
534 Result.RefRange.Start = Lex.getLoc();
536 Result.MC = ParseMultiClassID();
537 if (!Result.MC) return Result;
539 // If there is no template arg list, we're done.
540 if (Lex.getCode() != tgtok::less) {
541 Result.RefRange.End = Lex.getLoc();
544 Lex.Lex(); // Eat the '<'
546 if (Lex.getCode() == tgtok::greater) {
547 TokError("subclass reference requires a non-empty list of template values");
552 Result.TemplateArgs = ParseValueList(&CurMC->Rec, &Result.MC->Rec);
553 if (Result.TemplateArgs.empty()) {
554 Result.MC = nullptr; // Error parsing value list.
558 if (Lex.getCode() != tgtok::greater) {
559 TokError("expected '>' in template value list");
564 Result.RefRange.End = Lex.getLoc();
569 /// ParseRangePiece - Parse a bit/value range.
570 /// RangePiece ::= INTVAL
571 /// RangePiece ::= INTVAL '-' INTVAL
572 /// RangePiece ::= INTVAL INTVAL
573 bool TGParser::ParseRangePiece(std::vector<unsigned> &Ranges) {
574 if (Lex.getCode() != tgtok::IntVal) {
575 TokError("expected integer or bitrange");
578 int64_t Start = Lex.getCurIntVal();
582 return TokError("invalid range, cannot be negative");
584 switch (Lex.Lex()) { // eat first character.
586 Ranges.push_back(Start);
589 if (Lex.Lex() != tgtok::IntVal) {
590 TokError("expected integer value as end of range");
593 End = Lex.getCurIntVal();
596 End = -Lex.getCurIntVal();
600 return TokError("invalid range, cannot be negative");
605 for (; Start <= End; ++Start)
606 Ranges.push_back(Start);
608 for (; Start >= End; --Start)
609 Ranges.push_back(Start);
614 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
616 /// RangeList ::= RangePiece (',' RangePiece)*
618 std::vector<unsigned> TGParser::ParseRangeList() {
619 std::vector<unsigned> Result;
621 // Parse the first piece.
622 if (ParseRangePiece(Result))
623 return std::vector<unsigned>();
624 while (Lex.getCode() == tgtok::comma) {
625 Lex.Lex(); // Eat the comma.
627 // Parse the next range piece.
628 if (ParseRangePiece(Result))
629 return std::vector<unsigned>();
634 /// ParseOptionalRangeList - Parse either a range list in <>'s or nothing.
635 /// OptionalRangeList ::= '<' RangeList '>'
636 /// OptionalRangeList ::= /*empty*/
637 bool TGParser::ParseOptionalRangeList(std::vector<unsigned> &Ranges) {
638 if (Lex.getCode() != tgtok::less)
641 SMLoc StartLoc = Lex.getLoc();
642 Lex.Lex(); // eat the '<'
644 // Parse the range list.
645 Ranges = ParseRangeList();
646 if (Ranges.empty()) return true;
648 if (Lex.getCode() != tgtok::greater) {
649 TokError("expected '>' at end of range list");
650 return Error(StartLoc, "to match this '<'");
652 Lex.Lex(); // eat the '>'.
656 /// ParseOptionalBitList - Parse either a bit list in {}'s or nothing.
657 /// OptionalBitList ::= '{' RangeList '}'
658 /// OptionalBitList ::= /*empty*/
659 bool TGParser::ParseOptionalBitList(std::vector<unsigned> &Ranges) {
660 if (Lex.getCode() != tgtok::l_brace)
663 SMLoc StartLoc = Lex.getLoc();
664 Lex.Lex(); // eat the '{'
666 // Parse the range list.
667 Ranges = ParseRangeList();
668 if (Ranges.empty()) return true;
670 if (Lex.getCode() != tgtok::r_brace) {
671 TokError("expected '}' at end of bit list");
672 return Error(StartLoc, "to match this '{'");
674 Lex.Lex(); // eat the '}'.
679 /// ParseType - Parse and return a tblgen type. This returns null on error.
681 /// Type ::= STRING // string type
682 /// Type ::= CODE // code type
683 /// Type ::= BIT // bit type
684 /// Type ::= BITS '<' INTVAL '>' // bits<x> type
685 /// Type ::= INT // int type
686 /// Type ::= LIST '<' Type '>' // list<x> type
687 /// Type ::= DAG // dag type
688 /// Type ::= ClassID // Record Type
690 RecTy *TGParser::ParseType() {
691 switch (Lex.getCode()) {
692 default: TokError("Unknown token when expecting a type"); return nullptr;
693 case tgtok::String: Lex.Lex(); return StringRecTy::get();
694 case tgtok::Code: Lex.Lex(); return StringRecTy::get();
695 case tgtok::Bit: Lex.Lex(); return BitRecTy::get();
696 case tgtok::Int: Lex.Lex(); return IntRecTy::get();
697 case tgtok::Dag: Lex.Lex(); return DagRecTy::get();
699 if (Record *R = ParseClassID()) return RecordRecTy::get(R);
702 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
703 TokError("expected '<' after bits type");
706 if (Lex.Lex() != tgtok::IntVal) { // Eat '<'
707 TokError("expected integer in bits<n> type");
710 uint64_t Val = Lex.getCurIntVal();
711 if (Lex.Lex() != tgtok::greater) { // Eat count.
712 TokError("expected '>' at end of bits<n> type");
715 Lex.Lex(); // Eat '>'
716 return BitsRecTy::get(Val);
719 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
720 TokError("expected '<' after list type");
723 Lex.Lex(); // Eat '<'
724 RecTy *SubType = ParseType();
725 if (!SubType) return nullptr;
727 if (Lex.getCode() != tgtok::greater) {
728 TokError("expected '>' at end of list<ty> type");
731 Lex.Lex(); // Eat '>'
732 return ListRecTy::get(SubType);
737 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
738 /// has already been read.
739 Init *TGParser::ParseIDValue(Record *CurRec,
740 const std::string &Name, SMLoc NameLoc,
743 if (const RecordVal *RV = CurRec->getValue(Name))
744 return VarInit::get(Name, RV->getType());
746 Init *TemplateArgName = QualifyName(*CurRec, CurMultiClass, Name, ":");
749 TemplateArgName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
752 if (CurRec->isTemplateArg(TemplateArgName)) {
753 const RecordVal *RV = CurRec->getValue(TemplateArgName);
754 assert(RV && "Template arg doesn't exist??");
755 return VarInit::get(TemplateArgName, RV->getType());
760 Init *MCName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name,
763 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
764 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
765 assert(RV && "Template arg doesn't exist??");
766 return VarInit::get(MCName, RV->getType());
770 // If this is in a foreach loop, make sure it's not a loop iterator
771 for (LoopVector::iterator i = Loops.begin(), iend = Loops.end();
774 VarInit *IterVar = dyn_cast<VarInit>(i->IterVar);
775 if (IterVar && IterVar->getName() == Name)
779 if (Mode == ParseNameMode)
780 return StringInit::get(Name);
782 if (Record *D = Records.getDef(Name))
783 return DefInit::get(D);
785 if (Mode == ParseValueMode) {
786 Error(NameLoc, "Variable not defined: '" + Name + "'");
790 return StringInit::get(Name);
793 /// ParseOperation - Parse an operator. This returns null on error.
795 /// Operation ::= XOperator ['<' Type '>'] '(' Args ')'
797 Init *TGParser::ParseOperation(Record *CurRec, RecTy *ItemType) {
798 switch (Lex.getCode()) {
800 TokError("unknown operation");
805 case tgtok::XCast: { // Value ::= !unop '(' Value ')'
806 UnOpInit::UnaryOp Code;
807 RecTy *Type = nullptr;
809 switch (Lex.getCode()) {
810 default: llvm_unreachable("Unhandled code!");
812 Lex.Lex(); // eat the operation
813 Code = UnOpInit::CAST;
815 Type = ParseOperatorType();
818 TokError("did not get type for unary operator");
824 Lex.Lex(); // eat the operation
825 Code = UnOpInit::HEAD;
828 Lex.Lex(); // eat the operation
829 Code = UnOpInit::TAIL;
832 Lex.Lex(); // eat the operation
833 Code = UnOpInit::EMPTY;
834 Type = IntRecTy::get();
837 if (Lex.getCode() != tgtok::l_paren) {
838 TokError("expected '(' after unary operator");
841 Lex.Lex(); // eat the '('
843 Init *LHS = ParseValue(CurRec);
844 if (!LHS) return nullptr;
846 if (Code == UnOpInit::HEAD
847 || Code == UnOpInit::TAIL
848 || Code == UnOpInit::EMPTY) {
849 ListInit *LHSl = dyn_cast<ListInit>(LHS);
850 StringInit *LHSs = dyn_cast<StringInit>(LHS);
851 TypedInit *LHSt = dyn_cast<TypedInit>(LHS);
852 if (!LHSl && !LHSs && !LHSt) {
853 TokError("expected list or string type argument in unary operator");
857 ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
858 StringRecTy *SType = dyn_cast<StringRecTy>(LHSt->getType());
859 if (!LType && !SType) {
860 TokError("expected list or string type argument in unary operator");
865 if (Code == UnOpInit::HEAD
866 || Code == UnOpInit::TAIL) {
867 if (!LHSl && !LHSt) {
868 TokError("expected list type argument in unary operator");
872 if (LHSl && LHSl->getSize() == 0) {
873 TokError("empty list argument in unary operator");
877 Init *Item = LHSl->getElement(0);
878 TypedInit *Itemt = dyn_cast<TypedInit>(Item);
880 TokError("untyped list element in unary operator");
883 if (Code == UnOpInit::HEAD) {
884 Type = Itemt->getType();
886 Type = ListRecTy::get(Itemt->getType());
889 assert(LHSt && "expected list type argument in unary operator");
890 ListRecTy *LType = dyn_cast<ListRecTy>(LHSt->getType());
892 TokError("expected list type argument in unary operator");
895 if (Code == UnOpInit::HEAD) {
896 Type = LType->getElementType();
904 if (Lex.getCode() != tgtok::r_paren) {
905 TokError("expected ')' in unary operator");
908 Lex.Lex(); // eat the ')'
909 return (UnOpInit::get(Code, LHS, Type))->Fold(CurRec, CurMultiClass);
918 case tgtok::XListConcat:
919 case tgtok::XStrConcat: { // Value ::= !binop '(' Value ',' Value ')'
920 tgtok::TokKind OpTok = Lex.getCode();
921 SMLoc OpLoc = Lex.getLoc();
922 Lex.Lex(); // eat the operation
924 BinOpInit::BinaryOp Code;
925 RecTy *Type = nullptr;
928 default: llvm_unreachable("Unhandled code!");
929 case tgtok::XConcat: Code = BinOpInit::CONCAT;Type = DagRecTy::get(); break;
930 case tgtok::XADD: Code = BinOpInit::ADD; Type = IntRecTy::get(); break;
931 case tgtok::XSRA: Code = BinOpInit::SRA; Type = IntRecTy::get(); break;
932 case tgtok::XSRL: Code = BinOpInit::SRL; Type = IntRecTy::get(); break;
933 case tgtok::XSHL: Code = BinOpInit::SHL; Type = IntRecTy::get(); break;
934 case tgtok::XEq: Code = BinOpInit::EQ; Type = BitRecTy::get(); break;
935 case tgtok::XListConcat:
936 Code = BinOpInit::LISTCONCAT;
937 // We don't know the list type until we parse the first argument
939 case tgtok::XStrConcat:
940 Code = BinOpInit::STRCONCAT;
941 Type = StringRecTy::get();
945 if (Lex.getCode() != tgtok::l_paren) {
946 TokError("expected '(' after binary operator");
949 Lex.Lex(); // eat the '('
951 SmallVector<Init*, 2> InitList;
953 InitList.push_back(ParseValue(CurRec));
954 if (!InitList.back()) return nullptr;
956 while (Lex.getCode() == tgtok::comma) {
957 Lex.Lex(); // eat the ','
959 InitList.push_back(ParseValue(CurRec));
960 if (!InitList.back()) return nullptr;
963 if (Lex.getCode() != tgtok::r_paren) {
964 TokError("expected ')' in operator");
967 Lex.Lex(); // eat the ')'
969 // If we are doing !listconcat, we should know the type by now
970 if (OpTok == tgtok::XListConcat) {
971 if (VarInit *Arg0 = dyn_cast<VarInit>(InitList[0]))
972 Type = Arg0->getType();
973 else if (ListInit *Arg0 = dyn_cast<ListInit>(InitList[0]))
974 Type = Arg0->getType();
977 Error(OpLoc, "expected a list");
982 // We allow multiple operands to associative operators like !strconcat as
983 // shorthand for nesting them.
984 if (Code == BinOpInit::STRCONCAT || Code == BinOpInit::LISTCONCAT) {
985 while (InitList.size() > 2) {
986 Init *RHS = InitList.pop_back_val();
987 RHS = (BinOpInit::get(Code, InitList.back(), RHS, Type))
988 ->Fold(CurRec, CurMultiClass);
989 InitList.back() = RHS;
993 if (InitList.size() == 2)
994 return (BinOpInit::get(Code, InitList[0], InitList[1], Type))
995 ->Fold(CurRec, CurMultiClass);
997 Error(OpLoc, "expected two operands to operator");
1002 case tgtok::XForEach:
1003 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1004 TernOpInit::TernaryOp Code;
1005 RecTy *Type = nullptr;
1007 tgtok::TokKind LexCode = Lex.getCode();
1008 Lex.Lex(); // eat the operation
1010 default: llvm_unreachable("Unhandled code!");
1012 Code = TernOpInit::IF;
1014 case tgtok::XForEach:
1015 Code = TernOpInit::FOREACH;
1018 Code = TernOpInit::SUBST;
1021 if (Lex.getCode() != tgtok::l_paren) {
1022 TokError("expected '(' after ternary operator");
1025 Lex.Lex(); // eat the '('
1027 Init *LHS = ParseValue(CurRec);
1028 if (!LHS) return nullptr;
1030 if (Lex.getCode() != tgtok::comma) {
1031 TokError("expected ',' in ternary operator");
1034 Lex.Lex(); // eat the ','
1036 Init *MHS = ParseValue(CurRec, ItemType);
1040 if (Lex.getCode() != tgtok::comma) {
1041 TokError("expected ',' in ternary operator");
1044 Lex.Lex(); // eat the ','
1046 Init *RHS = ParseValue(CurRec, ItemType);
1050 if (Lex.getCode() != tgtok::r_paren) {
1051 TokError("expected ')' in binary operator");
1054 Lex.Lex(); // eat the ')'
1057 default: llvm_unreachable("Unhandled code!");
1059 RecTy *MHSTy = nullptr;
1060 RecTy *RHSTy = nullptr;
1062 if (TypedInit *MHSt = dyn_cast<TypedInit>(MHS))
1063 MHSTy = MHSt->getType();
1064 if (BitsInit *MHSbits = dyn_cast<BitsInit>(MHS))
1065 MHSTy = BitsRecTy::get(MHSbits->getNumBits());
1066 if (isa<BitInit>(MHS))
1067 MHSTy = BitRecTy::get();
1069 if (TypedInit *RHSt = dyn_cast<TypedInit>(RHS))
1070 RHSTy = RHSt->getType();
1071 if (BitsInit *RHSbits = dyn_cast<BitsInit>(RHS))
1072 RHSTy = BitsRecTy::get(RHSbits->getNumBits());
1073 if (isa<BitInit>(RHS))
1074 RHSTy = BitRecTy::get();
1076 // For UnsetInit, it's typed from the other hand.
1077 if (isa<UnsetInit>(MHS))
1079 if (isa<UnsetInit>(RHS))
1082 if (!MHSTy || !RHSTy) {
1083 TokError("could not get type for !if");
1087 if (MHSTy->typeIsConvertibleTo(RHSTy)) {
1089 } else if (RHSTy->typeIsConvertibleTo(MHSTy)) {
1092 TokError("inconsistent types for !if");
1097 case tgtok::XForEach: {
1098 TypedInit *MHSt = dyn_cast<TypedInit>(MHS);
1100 TokError("could not get type for !foreach");
1103 Type = MHSt->getType();
1106 case tgtok::XSubst: {
1107 TypedInit *RHSt = dyn_cast<TypedInit>(RHS);
1109 TokError("could not get type for !subst");
1112 Type = RHSt->getType();
1116 return (TernOpInit::get(Code, LHS, MHS, RHS, Type))->Fold(CurRec,
1122 /// ParseOperatorType - Parse a type for an operator. This returns
1125 /// OperatorType ::= '<' Type '>'
1127 RecTy *TGParser::ParseOperatorType() {
1128 RecTy *Type = nullptr;
1130 if (Lex.getCode() != tgtok::less) {
1131 TokError("expected type name for operator");
1134 Lex.Lex(); // eat the <
1139 TokError("expected type name for operator");
1143 if (Lex.getCode() != tgtok::greater) {
1144 TokError("expected type name for operator");
1147 Lex.Lex(); // eat the >
1153 /// ParseSimpleValue - Parse a tblgen value. This returns null on error.
1155 /// SimpleValue ::= IDValue
1156 /// SimpleValue ::= INTVAL
1157 /// SimpleValue ::= STRVAL+
1158 /// SimpleValue ::= CODEFRAGMENT
1159 /// SimpleValue ::= '?'
1160 /// SimpleValue ::= '{' ValueList '}'
1161 /// SimpleValue ::= ID '<' ValueListNE '>'
1162 /// SimpleValue ::= '[' ValueList ']'
1163 /// SimpleValue ::= '(' IDValue DagArgList ')'
1164 /// SimpleValue ::= CONCATTOK '(' Value ',' Value ')'
1165 /// SimpleValue ::= ADDTOK '(' Value ',' Value ')'
1166 /// SimpleValue ::= SHLTOK '(' Value ',' Value ')'
1167 /// SimpleValue ::= SRATOK '(' Value ',' Value ')'
1168 /// SimpleValue ::= SRLTOK '(' Value ',' Value ')'
1169 /// SimpleValue ::= LISTCONCATTOK '(' Value ',' Value ')'
1170 /// SimpleValue ::= STRCONCATTOK '(' Value ',' Value ')'
1172 Init *TGParser::ParseSimpleValue(Record *CurRec, RecTy *ItemType,
1175 switch (Lex.getCode()) {
1176 default: TokError("Unknown token when parsing a value"); break;
1178 // This is a leading paste operation. This is deprecated but
1179 // still exists in some .td files. Ignore it.
1180 Lex.Lex(); // Skip '#'.
1181 return ParseSimpleValue(CurRec, ItemType, Mode);
1182 case tgtok::IntVal: R = IntInit::get(Lex.getCurIntVal()); Lex.Lex(); break;
1183 case tgtok::StrVal: {
1184 std::string Val = Lex.getCurStrVal();
1187 // Handle multiple consecutive concatenated strings.
1188 while (Lex.getCode() == tgtok::StrVal) {
1189 Val += Lex.getCurStrVal();
1193 R = StringInit::get(Val);
1196 case tgtok::CodeFragment:
1197 R = StringInit::get(Lex.getCurStrVal());
1200 case tgtok::question:
1201 R = UnsetInit::get();
1205 SMLoc NameLoc = Lex.getLoc();
1206 std::string Name = Lex.getCurStrVal();
1207 if (Lex.Lex() != tgtok::less) // consume the Id.
1208 return ParseIDValue(CurRec, Name, NameLoc, Mode); // Value ::= IDValue
1210 // Value ::= ID '<' ValueListNE '>'
1211 if (Lex.Lex() == tgtok::greater) {
1212 TokError("expected non-empty value list");
1216 // This is a CLASS<initvalslist> expression. This is supposed to synthesize
1217 // a new anonymous definition, deriving from CLASS<initvalslist> with no
1219 Record *Class = Records.getClass(Name);
1221 Error(NameLoc, "Expected a class name, got '" + Name + "'");
1225 std::vector<Init*> ValueList = ParseValueList(CurRec, Class);
1226 if (ValueList.empty()) return nullptr;
1228 if (Lex.getCode() != tgtok::greater) {
1229 TokError("expected '>' at end of value list");
1232 Lex.Lex(); // eat the '>'
1233 SMLoc EndLoc = Lex.getLoc();
1235 // Create the new record, set it as CurRec temporarily.
1236 Record *NewRec = new Record(GetNewAnonymousName(), NameLoc, Records,
1237 /*IsAnonymous=*/true);
1238 SubClassReference SCRef;
1239 SCRef.RefRange = SMRange(NameLoc, EndLoc);
1241 SCRef.TemplateArgs = ValueList;
1242 // Add info about the subclass to NewRec.
1243 if (AddSubClass(NewRec, SCRef))
1245 if (!CurMultiClass) {
1246 NewRec->resolveReferences();
1247 Records.addDef(NewRec);
1249 // Otherwise, we're inside a multiclass, add it to the multiclass.
1250 CurMultiClass->DefPrototypes.push_back(NewRec);
1252 // Copy the template arguments for the multiclass into the def.
1253 const std::vector<Init *> &TArgs =
1254 CurMultiClass->Rec.getTemplateArgs();
1256 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1257 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
1258 assert(RV && "Template arg doesn't exist?");
1259 NewRec->addValue(*RV);
1262 // We can't return the prototype def here, instead return:
1263 // !cast<ItemType>(!strconcat(NAME, AnonName)).
1264 const RecordVal *MCNameRV = CurMultiClass->Rec.getValue("NAME");
1265 assert(MCNameRV && "multiclass record must have a NAME");
1267 return UnOpInit::get(UnOpInit::CAST,
1268 BinOpInit::get(BinOpInit::STRCONCAT,
1269 VarInit::get(MCNameRV->getName(),
1270 MCNameRV->getType()),
1271 NewRec->getNameInit(),
1272 StringRecTy::get()),
1273 Class->getDefInit()->getType());
1276 // The result of the expression is a reference to the new record.
1277 return DefInit::get(NewRec);
1279 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
1280 SMLoc BraceLoc = Lex.getLoc();
1281 Lex.Lex(); // eat the '{'
1282 std::vector<Init*> Vals;
1284 if (Lex.getCode() != tgtok::r_brace) {
1285 Vals = ParseValueList(CurRec);
1286 if (Vals.empty()) return nullptr;
1288 if (Lex.getCode() != tgtok::r_brace) {
1289 TokError("expected '}' at end of bit list value");
1292 Lex.Lex(); // eat the '}'
1294 SmallVector<Init *, 16> NewBits(Vals.size());
1296 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1297 Init *Bit = Vals[i]->convertInitializerTo(BitRecTy::get());
1299 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
1300 ") is not convertable to a bit");
1303 NewBits[Vals.size()-i-1] = Bit;
1305 return BitsInit::get(NewBits);
1307 case tgtok::l_square: { // Value ::= '[' ValueList ']'
1308 Lex.Lex(); // eat the '['
1309 std::vector<Init*> Vals;
1311 RecTy *DeducedEltTy = nullptr;
1312 ListRecTy *GivenListTy = nullptr;
1315 ListRecTy *ListType = dyn_cast<ListRecTy>(ItemType);
1318 raw_string_ostream ss(s);
1319 ss << "Type mismatch for list, expected list type, got "
1320 << ItemType->getAsString();
1324 GivenListTy = ListType;
1327 if (Lex.getCode() != tgtok::r_square) {
1328 Vals = ParseValueList(CurRec, nullptr,
1329 GivenListTy ? GivenListTy->getElementType() : nullptr);
1330 if (Vals.empty()) return nullptr;
1332 if (Lex.getCode() != tgtok::r_square) {
1333 TokError("expected ']' at end of list value");
1336 Lex.Lex(); // eat the ']'
1338 RecTy *GivenEltTy = nullptr;
1339 if (Lex.getCode() == tgtok::less) {
1340 // Optional list element type
1341 Lex.Lex(); // eat the '<'
1343 GivenEltTy = ParseType();
1345 // Couldn't parse element type
1349 if (Lex.getCode() != tgtok::greater) {
1350 TokError("expected '>' at end of list element type");
1353 Lex.Lex(); // eat the '>'
1357 RecTy *EltTy = nullptr;
1358 for (std::vector<Init *>::iterator i = Vals.begin(), ie = Vals.end();
1361 TypedInit *TArg = dyn_cast<TypedInit>(*i);
1363 TokError("Untyped list element");
1367 EltTy = resolveTypes(EltTy, TArg->getType());
1369 TokError("Incompatible types in list elements");
1373 EltTy = TArg->getType();
1379 // Verify consistency
1380 if (!EltTy->typeIsConvertibleTo(GivenEltTy)) {
1381 TokError("Incompatible types in list elements");
1390 TokError("No type for list");
1393 DeducedEltTy = GivenListTy->getElementType();
1395 // Make sure the deduced type is compatible with the given type
1397 if (!EltTy->typeIsConvertibleTo(GivenListTy->getElementType())) {
1398 TokError("Element type mismatch for list");
1402 DeducedEltTy = EltTy;
1405 return ListInit::get(Vals, DeducedEltTy);
1407 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
1408 Lex.Lex(); // eat the '('
1409 if (Lex.getCode() != tgtok::Id && Lex.getCode() != tgtok::XCast) {
1410 TokError("expected identifier in dag init");
1414 Init *Operator = ParseValue(CurRec);
1415 if (!Operator) return nullptr;
1417 // If the operator name is present, parse it.
1418 std::string OperatorName;
1419 if (Lex.getCode() == tgtok::colon) {
1420 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1421 TokError("expected variable name in dag operator");
1424 OperatorName = Lex.getCurStrVal();
1425 Lex.Lex(); // eat the VarName.
1428 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
1429 if (Lex.getCode() != tgtok::r_paren) {
1430 DagArgs = ParseDagArgList(CurRec);
1431 if (DagArgs.empty()) return nullptr;
1434 if (Lex.getCode() != tgtok::r_paren) {
1435 TokError("expected ')' in dag init");
1438 Lex.Lex(); // eat the ')'
1440 return DagInit::get(Operator, OperatorName, DagArgs);
1446 case tgtok::XCast: // Value ::= !unop '(' Value ')'
1447 case tgtok::XConcat:
1453 case tgtok::XListConcat:
1454 case tgtok::XStrConcat: // Value ::= !binop '(' Value ',' Value ')'
1456 case tgtok::XForEach:
1457 case tgtok::XSubst: { // Value ::= !ternop '(' Value ',' Value ',' Value ')'
1458 return ParseOperation(CurRec, ItemType);
1465 /// ParseValue - Parse a tblgen value. This returns null on error.
1467 /// Value ::= SimpleValue ValueSuffix*
1468 /// ValueSuffix ::= '{' BitList '}'
1469 /// ValueSuffix ::= '[' BitList ']'
1470 /// ValueSuffix ::= '.' ID
1472 Init *TGParser::ParseValue(Record *CurRec, RecTy *ItemType, IDParseMode Mode) {
1473 Init *Result = ParseSimpleValue(CurRec, ItemType, Mode);
1474 if (!Result) return nullptr;
1476 // Parse the suffixes now if present.
1478 switch (Lex.getCode()) {
1479 default: return Result;
1480 case tgtok::l_brace: {
1481 if (Mode == ParseNameMode || Mode == ParseForeachMode)
1482 // This is the beginning of the object body.
1485 SMLoc CurlyLoc = Lex.getLoc();
1486 Lex.Lex(); // eat the '{'
1487 std::vector<unsigned> Ranges = ParseRangeList();
1488 if (Ranges.empty()) return nullptr;
1490 // Reverse the bitlist.
1491 std::reverse(Ranges.begin(), Ranges.end());
1492 Result = Result->convertInitializerBitRange(Ranges);
1494 Error(CurlyLoc, "Invalid bit range for value");
1499 if (Lex.getCode() != tgtok::r_brace) {
1500 TokError("expected '}' at end of bit range list");
1506 case tgtok::l_square: {
1507 SMLoc SquareLoc = Lex.getLoc();
1508 Lex.Lex(); // eat the '['
1509 std::vector<unsigned> Ranges = ParseRangeList();
1510 if (Ranges.empty()) return nullptr;
1512 Result = Result->convertInitListSlice(Ranges);
1514 Error(SquareLoc, "Invalid range for list slice");
1519 if (Lex.getCode() != tgtok::r_square) {
1520 TokError("expected ']' at end of list slice");
1527 if (Lex.Lex() != tgtok::Id) { // eat the .
1528 TokError("expected field identifier after '.'");
1531 if (!Result->getFieldType(Lex.getCurStrVal())) {
1532 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
1533 Result->getAsString() + "'");
1536 Result = FieldInit::get(Result, Lex.getCurStrVal());
1537 Lex.Lex(); // eat field name
1541 SMLoc PasteLoc = Lex.getLoc();
1543 // Create a !strconcat() operation, first casting each operand to
1544 // a string if necessary.
1546 TypedInit *LHS = dyn_cast<TypedInit>(Result);
1548 Error(PasteLoc, "LHS of paste is not typed!");
1552 if (LHS->getType() != StringRecTy::get()) {
1553 LHS = UnOpInit::get(UnOpInit::CAST, LHS, StringRecTy::get());
1556 TypedInit *RHS = nullptr;
1558 Lex.Lex(); // Eat the '#'.
1559 switch (Lex.getCode()) {
1562 case tgtok::l_brace:
1563 // These are all of the tokens that can begin an object body.
1564 // Some of these can also begin values but we disallow those cases
1565 // because they are unlikely to be useful.
1567 // Trailing paste, concat with an empty string.
1568 RHS = StringInit::get("");
1572 Init *RHSResult = ParseValue(CurRec, ItemType, ParseNameMode);
1573 RHS = dyn_cast<TypedInit>(RHSResult);
1575 Error(PasteLoc, "RHS of paste is not typed!");
1579 if (RHS->getType() != StringRecTy::get()) {
1580 RHS = UnOpInit::get(UnOpInit::CAST, RHS, StringRecTy::get());
1586 Result = BinOpInit::get(BinOpInit::STRCONCAT, LHS, RHS,
1587 StringRecTy::get())->Fold(CurRec, CurMultiClass);
1593 /// ParseDagArgList - Parse the argument list for a dag literal expression.
1595 /// DagArg ::= Value (':' VARNAME)?
1596 /// DagArg ::= VARNAME
1597 /// DagArgList ::= DagArg
1598 /// DagArgList ::= DagArgList ',' DagArg
1599 std::vector<std::pair<llvm::Init*, std::string> >
1600 TGParser::ParseDagArgList(Record *CurRec) {
1601 std::vector<std::pair<llvm::Init*, std::string> > Result;
1604 // DagArg ::= VARNAME
1605 if (Lex.getCode() == tgtok::VarName) {
1606 // A missing value is treated like '?'.
1607 Result.push_back(std::make_pair(UnsetInit::get(), Lex.getCurStrVal()));
1610 // DagArg ::= Value (':' VARNAME)?
1611 Init *Val = ParseValue(CurRec);
1613 return std::vector<std::pair<llvm::Init*, std::string> >();
1615 // If the variable name is present, add it.
1616 std::string VarName;
1617 if (Lex.getCode() == tgtok::colon) {
1618 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
1619 TokError("expected variable name in dag literal");
1620 return std::vector<std::pair<llvm::Init*, std::string> >();
1622 VarName = Lex.getCurStrVal();
1623 Lex.Lex(); // eat the VarName.
1626 Result.push_back(std::make_pair(Val, VarName));
1628 if (Lex.getCode() != tgtok::comma) break;
1629 Lex.Lex(); // eat the ','
1636 /// ParseValueList - Parse a comma separated list of values, returning them as a
1637 /// vector. Note that this always expects to be able to parse at least one
1638 /// value. It returns an empty list if this is not possible.
1640 /// ValueList ::= Value (',' Value)
1642 std::vector<Init*> TGParser::ParseValueList(Record *CurRec, Record *ArgsRec,
1644 std::vector<Init*> Result;
1645 RecTy *ItemType = EltTy;
1646 unsigned int ArgN = 0;
1647 if (ArgsRec && !EltTy) {
1648 const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1649 if (!TArgs.size()) {
1650 TokError("template argument provided to non-template class");
1651 return std::vector<Init*>();
1653 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1655 errs() << "Cannot find template arg " << ArgN << " (" << TArgs[ArgN]
1658 assert(RV && "Template argument record not found??");
1659 ItemType = RV->getType();
1662 Result.push_back(ParseValue(CurRec, ItemType));
1663 if (!Result.back()) return std::vector<Init*>();
1665 while (Lex.getCode() == tgtok::comma) {
1666 Lex.Lex(); // Eat the comma
1668 if (ArgsRec && !EltTy) {
1669 const std::vector<Init *> &TArgs = ArgsRec->getTemplateArgs();
1670 if (ArgN >= TArgs.size()) {
1671 TokError("too many template arguments");
1672 return std::vector<Init*>();
1674 const RecordVal *RV = ArgsRec->getValue(TArgs[ArgN]);
1675 assert(RV && "Template argument record not found??");
1676 ItemType = RV->getType();
1679 Result.push_back(ParseValue(CurRec, ItemType));
1680 if (!Result.back()) return std::vector<Init*>();
1687 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
1688 /// empty string on error. This can happen in a number of different context's,
1689 /// including within a def or in the template args for a def (which which case
1690 /// CurRec will be non-null) and within the template args for a multiclass (in
1691 /// which case CurRec will be null, but CurMultiClass will be set). This can
1692 /// also happen within a def that is within a multiclass, which will set both
1693 /// CurRec and CurMultiClass.
1695 /// Declaration ::= FIELD? Type ID ('=' Value)?
1697 Init *TGParser::ParseDeclaration(Record *CurRec,
1698 bool ParsingTemplateArgs) {
1699 // Read the field prefix if present.
1700 bool HasField = Lex.getCode() == tgtok::Field;
1701 if (HasField) Lex.Lex();
1703 RecTy *Type = ParseType();
1704 if (!Type) return nullptr;
1706 if (Lex.getCode() != tgtok::Id) {
1707 TokError("Expected identifier in declaration");
1711 SMLoc IdLoc = Lex.getLoc();
1712 Init *DeclName = StringInit::get(Lex.getCurStrVal());
1715 if (ParsingTemplateArgs) {
1717 DeclName = QualifyName(*CurRec, CurMultiClass, DeclName, ":");
1719 assert(CurMultiClass);
1722 DeclName = QualifyName(CurMultiClass->Rec, CurMultiClass, DeclName,
1727 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
1730 // If a value is present, parse it.
1731 if (Lex.getCode() == tgtok::equal) {
1733 SMLoc ValLoc = Lex.getLoc();
1734 Init *Val = ParseValue(CurRec, Type);
1736 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
1737 // Return the name, even if an error is thrown. This is so that we can
1738 // continue to make some progress, even without the value having been
1746 /// ParseForeachDeclaration - Read a foreach declaration, returning
1747 /// the name of the declared object or a NULL Init on error. Return
1748 /// the name of the parsed initializer list through ForeachListName.
1750 /// ForeachDeclaration ::= ID '=' '[' ValueList ']'
1751 /// ForeachDeclaration ::= ID '=' '{' RangeList '}'
1752 /// ForeachDeclaration ::= ID '=' RangePiece
1754 VarInit *TGParser::ParseForeachDeclaration(ListInit *&ForeachListValue) {
1755 if (Lex.getCode() != tgtok::Id) {
1756 TokError("Expected identifier in foreach declaration");
1760 Init *DeclName = StringInit::get(Lex.getCurStrVal());
1763 // If a value is present, parse it.
1764 if (Lex.getCode() != tgtok::equal) {
1765 TokError("Expected '=' in foreach declaration");
1768 Lex.Lex(); // Eat the '='
1770 RecTy *IterType = nullptr;
1771 std::vector<unsigned> Ranges;
1773 switch (Lex.getCode()) {
1774 default: TokError("Unknown token when expecting a range list"); return nullptr;
1775 case tgtok::l_square: { // '[' ValueList ']'
1776 Init *List = ParseSimpleValue(nullptr, nullptr, ParseForeachMode);
1777 ForeachListValue = dyn_cast<ListInit>(List);
1778 if (!ForeachListValue) {
1779 TokError("Expected a Value list");
1782 RecTy *ValueType = ForeachListValue->getType();
1783 ListRecTy *ListType = dyn_cast<ListRecTy>(ValueType);
1785 TokError("Value list is not of list type");
1788 IterType = ListType->getElementType();
1792 case tgtok::IntVal: { // RangePiece.
1793 if (ParseRangePiece(Ranges))
1798 case tgtok::l_brace: { // '{' RangeList '}'
1799 Lex.Lex(); // eat the '{'
1800 Ranges = ParseRangeList();
1801 if (Lex.getCode() != tgtok::r_brace) {
1802 TokError("expected '}' at end of bit range list");
1810 if (!Ranges.empty()) {
1811 assert(!IterType && "Type already initialized?");
1812 IterType = IntRecTy::get();
1813 std::vector<Init*> Values;
1814 for (unsigned i = 0, e = Ranges.size(); i != e; ++i)
1815 Values.push_back(IntInit::get(Ranges[i]));
1816 ForeachListValue = ListInit::get(Values, IterType);
1822 return VarInit::get(DeclName, IterType);
1825 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
1826 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
1827 /// template args for a def, which may or may not be in a multiclass. If null,
1828 /// these are the template args for a multiclass.
1830 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
1832 bool TGParser::ParseTemplateArgList(Record *CurRec) {
1833 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
1834 Lex.Lex(); // eat the '<'
1836 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
1838 // Read the first declaration.
1839 Init *TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1843 TheRecToAddTo->addTemplateArg(TemplArg);
1845 while (Lex.getCode() == tgtok::comma) {
1846 Lex.Lex(); // eat the ','
1848 // Read the following declarations.
1849 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
1852 TheRecToAddTo->addTemplateArg(TemplArg);
1855 if (Lex.getCode() != tgtok::greater)
1856 return TokError("expected '>' at end of template argument list");
1857 Lex.Lex(); // eat the '>'.
1862 /// ParseBodyItem - Parse a single item at within the body of a def or class.
1864 /// BodyItem ::= Declaration ';'
1865 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
1866 bool TGParser::ParseBodyItem(Record *CurRec) {
1867 if (Lex.getCode() != tgtok::Let) {
1868 if (!ParseDeclaration(CurRec, false))
1871 if (Lex.getCode() != tgtok::semi)
1872 return TokError("expected ';' after declaration");
1877 // LET ID OptionalRangeList '=' Value ';'
1878 if (Lex.Lex() != tgtok::Id)
1879 return TokError("expected field identifier after let");
1881 SMLoc IdLoc = Lex.getLoc();
1882 std::string FieldName = Lex.getCurStrVal();
1883 Lex.Lex(); // eat the field name.
1885 std::vector<unsigned> BitList;
1886 if (ParseOptionalBitList(BitList))
1888 std::reverse(BitList.begin(), BitList.end());
1890 if (Lex.getCode() != tgtok::equal)
1891 return TokError("expected '=' in let expression");
1892 Lex.Lex(); // eat the '='.
1894 RecordVal *Field = CurRec->getValue(FieldName);
1896 return TokError("Value '" + FieldName + "' unknown!");
1898 RecTy *Type = Field->getType();
1900 Init *Val = ParseValue(CurRec, Type);
1901 if (!Val) return true;
1903 if (Lex.getCode() != tgtok::semi)
1904 return TokError("expected ';' after let expression");
1907 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
1910 /// ParseBody - Read the body of a class or def. Return true on error, false on
1914 /// Body ::= '{' BodyList '}'
1915 /// BodyList BodyItem*
1917 bool TGParser::ParseBody(Record *CurRec) {
1918 // If this is a null definition, just eat the semi and return.
1919 if (Lex.getCode() == tgtok::semi) {
1924 if (Lex.getCode() != tgtok::l_brace)
1925 return TokError("Expected ';' or '{' to start body");
1929 while (Lex.getCode() != tgtok::r_brace)
1930 if (ParseBodyItem(CurRec))
1938 /// \brief Apply the current let bindings to \a CurRec.
1939 /// \returns true on error, false otherwise.
1940 bool TGParser::ApplyLetStack(Record *CurRec) {
1941 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1942 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1943 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1944 LetStack[i][j].Bits, LetStack[i][j].Value))
1949 /// ParseObjectBody - Parse the body of a def or class. This consists of an
1950 /// optional ClassList followed by a Body. CurRec is the current def or class
1951 /// that is being parsed.
1953 /// ObjectBody ::= BaseClassList Body
1954 /// BaseClassList ::= /*empty*/
1955 /// BaseClassList ::= ':' BaseClassListNE
1956 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
1958 bool TGParser::ParseObjectBody(Record *CurRec) {
1959 // If there is a baseclass list, read it.
1960 if (Lex.getCode() == tgtok::colon) {
1963 // Read all of the subclasses.
1964 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
1967 if (!SubClass.Rec) return true;
1970 if (AddSubClass(CurRec, SubClass))
1973 if (Lex.getCode() != tgtok::comma) break;
1974 Lex.Lex(); // eat ','.
1975 SubClass = ParseSubClassReference(CurRec, false);
1979 if (ApplyLetStack(CurRec))
1982 return ParseBody(CurRec);
1985 /// ParseDef - Parse and return a top level or multiclass def, return the record
1986 /// corresponding to it. This returns null on error.
1988 /// DefInst ::= DEF ObjectName ObjectBody
1990 bool TGParser::ParseDef(MultiClass *CurMultiClass) {
1991 SMLoc DefLoc = Lex.getLoc();
1992 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1993 Lex.Lex(); // Eat the 'def' token.
1995 // Parse ObjectName and make a record for it.
1997 Init *Name = ParseObjectName(CurMultiClass);
1999 CurRec = new Record(Name, DefLoc, Records);
2001 CurRec = new Record(GetNewAnonymousName(), DefLoc, Records,
2002 /*IsAnonymous=*/true);
2004 if (!CurMultiClass && Loops.empty()) {
2005 // Top-level def definition.
2007 // Ensure redefinition doesn't happen.
2008 if (Records.getDef(CurRec->getNameInitAsString())) {
2009 Error(DefLoc, "def '" + CurRec->getNameInitAsString()
2010 + "' already defined");
2013 Records.addDef(CurRec);
2015 if (ParseObjectBody(CurRec))
2017 } else if (CurMultiClass) {
2018 // Parse the body before adding this prototype to the DefPrototypes vector.
2019 // That way implicit definitions will be added to the DefPrototypes vector
2020 // before this object, instantiated prior to defs derived from this object,
2021 // and this available for indirect name resolution when defs derived from
2022 // this object are instantiated.
2023 if (ParseObjectBody(CurRec))
2026 // Otherwise, a def inside a multiclass, add it to the multiclass.
2027 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
2028 if (CurMultiClass->DefPrototypes[i]->getNameInit()
2029 == CurRec->getNameInit()) {
2030 Error(DefLoc, "def '" + CurRec->getNameInitAsString() +
2031 "' already defined in this multiclass!");
2034 CurMultiClass->DefPrototypes.push_back(CurRec);
2035 } else if (ParseObjectBody(CurRec))
2038 if (!CurMultiClass) // Def's in multiclasses aren't really defs.
2039 // See Record::setName(). This resolve step will see any new name
2040 // for the def that might have been created when resolving
2041 // inheritance, values and arguments above.
2042 CurRec->resolveReferences();
2044 // If ObjectBody has template arguments, it's an error.
2045 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
2047 if (CurMultiClass) {
2048 // Copy the template arguments for the multiclass into the def.
2049 const std::vector<Init *> &TArgs =
2050 CurMultiClass->Rec.getTemplateArgs();
2052 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2053 const RecordVal *RV = CurMultiClass->Rec.getValue(TArgs[i]);
2054 assert(RV && "Template arg doesn't exist?");
2055 CurRec->addValue(*RV);
2059 if (ProcessForeachDefs(CurRec, DefLoc)) {
2061 "Could not process loops for def" + CurRec->getNameInitAsString());
2068 /// ParseForeach - Parse a for statement. Return the record corresponding
2069 /// to it. This returns true on error.
2071 /// Foreach ::= FOREACH Declaration IN '{ ObjectList '}'
2072 /// Foreach ::= FOREACH Declaration IN Object
2074 bool TGParser::ParseForeach(MultiClass *CurMultiClass) {
2075 assert(Lex.getCode() == tgtok::Foreach && "Unknown tok");
2076 Lex.Lex(); // Eat the 'for' token.
2078 // Make a temporary object to record items associated with the for
2080 ListInit *ListValue = nullptr;
2081 VarInit *IterName = ParseForeachDeclaration(ListValue);
2083 return TokError("expected declaration in for");
2085 if (Lex.getCode() != tgtok::In)
2086 return TokError("Unknown tok");
2087 Lex.Lex(); // Eat the in
2089 // Create a loop object and remember it.
2090 Loops.push_back(ForeachLoop(IterName, ListValue));
2092 if (Lex.getCode() != tgtok::l_brace) {
2093 // FOREACH Declaration IN Object
2094 if (ParseObject(CurMultiClass))
2098 SMLoc BraceLoc = Lex.getLoc();
2099 // Otherwise, this is a group foreach.
2100 Lex.Lex(); // eat the '{'.
2102 // Parse the object list.
2103 if (ParseObjectList(CurMultiClass))
2106 if (Lex.getCode() != tgtok::r_brace) {
2107 TokError("expected '}' at end of foreach command");
2108 return Error(BraceLoc, "to match this '{'");
2110 Lex.Lex(); // Eat the }
2113 // We've processed everything in this loop.
2119 /// ParseClass - Parse a tblgen class definition.
2121 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
2123 bool TGParser::ParseClass() {
2124 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
2127 if (Lex.getCode() != tgtok::Id)
2128 return TokError("expected class name after 'class' keyword");
2130 Record *CurRec = Records.getClass(Lex.getCurStrVal());
2132 // If the body was previously defined, this is an error.
2133 if (CurRec->getValues().size() > 1 || // Account for NAME.
2134 !CurRec->getSuperClasses().empty() ||
2135 !CurRec->getTemplateArgs().empty())
2136 return TokError("Class '" + CurRec->getNameInitAsString()
2137 + "' already defined");
2139 // If this is the first reference to this class, create and add it.
2140 CurRec = new Record(Lex.getCurStrVal(), Lex.getLoc(), Records);
2141 Records.addClass(CurRec);
2143 Lex.Lex(); // eat the name.
2145 // If there are template args, parse them.
2146 if (Lex.getCode() == tgtok::less)
2147 if (ParseTemplateArgList(CurRec))
2150 // Finally, parse the object body.
2151 return ParseObjectBody(CurRec);
2154 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
2157 /// LetList ::= LetItem (',' LetItem)*
2158 /// LetItem ::= ID OptionalRangeList '=' Value
2160 std::vector<LetRecord> TGParser::ParseLetList() {
2161 std::vector<LetRecord> Result;
2164 if (Lex.getCode() != tgtok::Id) {
2165 TokError("expected identifier in let definition");
2166 return std::vector<LetRecord>();
2168 std::string Name = Lex.getCurStrVal();
2169 SMLoc NameLoc = Lex.getLoc();
2170 Lex.Lex(); // Eat the identifier.
2172 // Check for an optional RangeList.
2173 std::vector<unsigned> Bits;
2174 if (ParseOptionalRangeList(Bits))
2175 return std::vector<LetRecord>();
2176 std::reverse(Bits.begin(), Bits.end());
2178 if (Lex.getCode() != tgtok::equal) {
2179 TokError("expected '=' in let expression");
2180 return std::vector<LetRecord>();
2182 Lex.Lex(); // eat the '='.
2184 Init *Val = ParseValue(nullptr);
2185 if (!Val) return std::vector<LetRecord>();
2187 // Now that we have everything, add the record.
2188 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
2190 if (Lex.getCode() != tgtok::comma)
2192 Lex.Lex(); // eat the comma.
2196 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
2197 /// different related productions. This works inside multiclasses too.
2199 /// Object ::= LET LetList IN '{' ObjectList '}'
2200 /// Object ::= LET LetList IN Object
2202 bool TGParser::ParseTopLevelLet(MultiClass *CurMultiClass) {
2203 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
2206 // Add this entry to the let stack.
2207 std::vector<LetRecord> LetInfo = ParseLetList();
2208 if (LetInfo.empty()) return true;
2209 LetStack.push_back(LetInfo);
2211 if (Lex.getCode() != tgtok::In)
2212 return TokError("expected 'in' at end of top-level 'let'");
2215 // If this is a scalar let, just handle it now
2216 if (Lex.getCode() != tgtok::l_brace) {
2217 // LET LetList IN Object
2218 if (ParseObject(CurMultiClass))
2220 } else { // Object ::= LETCommand '{' ObjectList '}'
2221 SMLoc BraceLoc = Lex.getLoc();
2222 // Otherwise, this is a group let.
2223 Lex.Lex(); // eat the '{'.
2225 // Parse the object list.
2226 if (ParseObjectList(CurMultiClass))
2229 if (Lex.getCode() != tgtok::r_brace) {
2230 TokError("expected '}' at end of top level let command");
2231 return Error(BraceLoc, "to match this '{'");
2236 // Outside this let scope, this let block is not active.
2237 LetStack.pop_back();
2241 /// ParseMultiClass - Parse a multiclass definition.
2243 /// MultiClassInst ::= MULTICLASS ID TemplateArgList?
2244 /// ':' BaseMultiClassList '{' MultiClassObject+ '}'
2245 /// MultiClassObject ::= DefInst
2246 /// MultiClassObject ::= MultiClassInst
2247 /// MultiClassObject ::= DefMInst
2248 /// MultiClassObject ::= LETCommand '{' ObjectList '}'
2249 /// MultiClassObject ::= LETCommand Object
2251 bool TGParser::ParseMultiClass() {
2252 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
2253 Lex.Lex(); // Eat the multiclass token.
2255 if (Lex.getCode() != tgtok::Id)
2256 return TokError("expected identifier after multiclass for name");
2257 std::string Name = Lex.getCurStrVal();
2259 if (MultiClasses.count(Name))
2260 return TokError("multiclass '" + Name + "' already defined");
2262 CurMultiClass = MultiClasses[Name] = new MultiClass(Name,
2263 Lex.getLoc(), Records);
2264 Lex.Lex(); // Eat the identifier.
2266 // If there are template args, parse them.
2267 if (Lex.getCode() == tgtok::less)
2268 if (ParseTemplateArgList(nullptr))
2271 bool inherits = false;
2273 // If there are submulticlasses, parse them.
2274 if (Lex.getCode() == tgtok::colon) {
2279 // Read all of the submulticlasses.
2280 SubMultiClassReference SubMultiClass =
2281 ParseSubMultiClassReference(CurMultiClass);
2284 if (!SubMultiClass.MC) return true;
2287 if (AddSubMultiClass(CurMultiClass, SubMultiClass))
2290 if (Lex.getCode() != tgtok::comma) break;
2291 Lex.Lex(); // eat ','.
2292 SubMultiClass = ParseSubMultiClassReference(CurMultiClass);
2296 if (Lex.getCode() != tgtok::l_brace) {
2298 return TokError("expected '{' in multiclass definition");
2299 else if (Lex.getCode() != tgtok::semi)
2300 return TokError("expected ';' in multiclass definition");
2302 Lex.Lex(); // eat the ';'.
2304 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
2305 return TokError("multiclass must contain at least one def");
2307 while (Lex.getCode() != tgtok::r_brace) {
2308 switch (Lex.getCode()) {
2310 return TokError("expected 'let', 'def' or 'defm' in multiclass body");
2314 case tgtok::Foreach:
2315 if (ParseObject(CurMultiClass))
2320 Lex.Lex(); // eat the '}'.
2323 CurMultiClass = nullptr;
2328 InstantiateMulticlassDef(MultiClass &MC,
2331 SMRange DefmPrefixRange) {
2332 // We need to preserve DefProto so it can be reused for later
2333 // instantiations, so create a new Record to inherit from it.
2335 // Add in the defm name. If the defm prefix is empty, give each
2336 // instantiated def a unique name. Otherwise, if "#NAME#" exists in the
2337 // name, substitute the prefix for #NAME#. Otherwise, use the defm name
2340 bool IsAnonymous = false;
2342 DefmPrefix = StringInit::get(GetNewAnonymousName());
2346 Init *DefName = DefProto->getNameInit();
2348 StringInit *DefNameString = dyn_cast<StringInit>(DefName);
2350 if (DefNameString) {
2351 // We have a fully expanded string so there are no operators to
2352 // resolve. We should concatenate the given prefix and name.
2354 BinOpInit::get(BinOpInit::STRCONCAT,
2355 UnOpInit::get(UnOpInit::CAST, DefmPrefix,
2356 StringRecTy::get())->Fold(DefProto, &MC),
2357 DefName, StringRecTy::get())->Fold(DefProto, &MC);
2360 // Make a trail of SMLocs from the multiclass instantiations.
2361 SmallVector<SMLoc, 4> Locs(1, DefmPrefixRange.Start);
2362 Locs.append(DefProto->getLoc().begin(), DefProto->getLoc().end());
2363 Record *CurRec = new Record(DefName, Locs, Records, IsAnonymous);
2365 SubClassReference Ref;
2366 Ref.RefRange = DefmPrefixRange;
2368 AddSubClass(CurRec, Ref);
2370 // Set the value for NAME. We don't resolve references to it 'til later,
2371 // though, so that uses in nested multiclass names don't get
2373 if (SetValue(CurRec, Ref.RefRange.Start, "NAME", std::vector<unsigned>(),
2375 Error(DefmPrefixRange.Start, "Could not resolve "
2376 + CurRec->getNameInitAsString() + ":NAME to '"
2377 + DefmPrefix->getAsUnquotedString() + "'");
2381 // If the DefNameString didn't resolve, we probably have a reference to
2382 // NAME and need to replace it. We need to do at least this much greedily,
2383 // otherwise nested multiclasses will end up with incorrect NAME expansions.
2384 if (!DefNameString) {
2385 RecordVal *DefNameRV = CurRec->getValue("NAME");
2386 CurRec->resolveReferencesTo(DefNameRV);
2389 if (!CurMultiClass) {
2390 // Now that we're at the top level, resolve all NAME references
2391 // in the resultant defs that weren't in the def names themselves.
2392 RecordVal *DefNameRV = CurRec->getValue("NAME");
2393 CurRec->resolveReferencesTo(DefNameRV);
2395 // Now that NAME references are resolved and we're at the top level of
2396 // any multiclass expansions, add the record to the RecordKeeper. If we are
2397 // currently in a multiclass, it means this defm appears inside a
2398 // multiclass and its name won't be fully resolvable until we see
2399 // the top-level defm. Therefore, we don't add this to the
2400 // RecordKeeper at this point. If we did we could get duplicate
2401 // defs as more than one probably refers to NAME or some other
2402 // common internal placeholder.
2404 // Ensure redefinition doesn't happen.
2405 if (Records.getDef(CurRec->getNameInitAsString())) {
2406 Error(DefmPrefixRange.Start, "def '" + CurRec->getNameInitAsString() +
2407 "' already defined, instantiating defm with subdef '" +
2408 DefProto->getNameInitAsString() + "'");
2412 Records.addDef(CurRec);
2418 bool TGParser::ResolveMulticlassDefArgs(MultiClass &MC,
2420 SMLoc DefmPrefixLoc,
2422 const std::vector<Init *> &TArgs,
2423 std::vector<Init *> &TemplateVals,
2425 // Loop over all of the template arguments, setting them to the specified
2426 // value or leaving them as the default if necessary.
2427 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
2428 // Check if a value is specified for this temp-arg.
2429 if (i < TemplateVals.size()) {
2431 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
2436 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
2440 CurRec->removeValue(TArgs[i]);
2442 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
2443 return Error(SubClassLoc, "value not specified for template argument #"+
2444 utostr(i) + " (" + TArgs[i]->getAsUnquotedString()
2445 + ") of multiclassclass '" + MC.Rec.getNameInitAsString()
2452 bool TGParser::ResolveMulticlassDef(MultiClass &MC,
2455 SMLoc DefmPrefixLoc) {
2456 // If the mdef is inside a 'let' expression, add to each def.
2457 if (ApplyLetStack(CurRec))
2458 return Error(DefmPrefixLoc, "when instantiating this defm");
2460 // Don't create a top level definition for defm inside multiclasses,
2461 // instead, only update the prototypes and bind the template args
2462 // with the new created definition.
2465 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size();
2467 if (CurMultiClass->DefPrototypes[i]->getNameInit()
2468 == CurRec->getNameInit())
2469 return Error(DefmPrefixLoc, "defm '" + CurRec->getNameInitAsString() +
2470 "' already defined in this multiclass!");
2471 CurMultiClass->DefPrototypes.push_back(CurRec);
2473 // Copy the template arguments for the multiclass into the new def.
2474 const std::vector<Init *> &TA =
2475 CurMultiClass->Rec.getTemplateArgs();
2477 for (unsigned i = 0, e = TA.size(); i != e; ++i) {
2478 const RecordVal *RV = CurMultiClass->Rec.getValue(TA[i]);
2479 assert(RV && "Template arg doesn't exist?");
2480 CurRec->addValue(*RV);
2486 /// ParseDefm - Parse the instantiation of a multiclass.
2488 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
2490 bool TGParser::ParseDefm(MultiClass *CurMultiClass) {
2491 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
2492 SMLoc DefmLoc = Lex.getLoc();
2493 Init *DefmPrefix = nullptr;
2495 if (Lex.Lex() == tgtok::Id) { // eat the defm.
2496 DefmPrefix = ParseObjectName(CurMultiClass);
2499 SMLoc DefmPrefixEndLoc = Lex.getLoc();
2500 if (Lex.getCode() != tgtok::colon)
2501 return TokError("expected ':' after defm identifier");
2503 // Keep track of the new generated record definitions.
2504 std::vector<Record*> NewRecDefs;
2506 // This record also inherits from a regular class (non-multiclass)?
2507 bool InheritFromClass = false;
2512 SMLoc SubClassLoc = Lex.getLoc();
2513 SubClassReference Ref = ParseSubClassReference(nullptr, true);
2516 if (!Ref.Rec) return true;
2518 // To instantiate a multiclass, we need to first get the multiclass, then
2519 // instantiate each def contained in the multiclass with the SubClassRef
2520 // template parameters.
2521 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
2522 assert(MC && "Didn't lookup multiclass correctly?");
2523 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
2525 // Verify that the correct number of template arguments were specified.
2526 const std::vector<Init *> &TArgs = MC->Rec.getTemplateArgs();
2527 if (TArgs.size() < TemplateVals.size())
2528 return Error(SubClassLoc,
2529 "more template args specified than multiclass expects");
2531 // Loop over all the def's in the multiclass, instantiating each one.
2532 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
2533 Record *DefProto = MC->DefPrototypes[i];
2535 Record *CurRec = InstantiateMulticlassDef(*MC, DefProto, DefmPrefix,
2541 if (ResolveMulticlassDefArgs(*MC, CurRec, DefmLoc, SubClassLoc,
2542 TArgs, TemplateVals, true/*Delete args*/))
2543 return Error(SubClassLoc, "could not instantiate def");
2545 if (ResolveMulticlassDef(*MC, CurRec, DefProto, DefmLoc))
2546 return Error(SubClassLoc, "could not instantiate def");
2548 NewRecDefs.push_back(CurRec);
2552 if (Lex.getCode() != tgtok::comma) break;
2553 Lex.Lex(); // eat ','.
2555 if (Lex.getCode() != tgtok::Id)
2556 return TokError("expected identifier");
2558 SubClassLoc = Lex.getLoc();
2560 // A defm can inherit from regular classes (non-multiclass) as
2561 // long as they come in the end of the inheritance list.
2562 InheritFromClass = (Records.getClass(Lex.getCurStrVal()) != nullptr);
2564 if (InheritFromClass)
2567 Ref = ParseSubClassReference(nullptr, true);
2570 if (InheritFromClass) {
2571 // Process all the classes to inherit as if they were part of a
2572 // regular 'def' and inherit all record values.
2573 SubClassReference SubClass = ParseSubClassReference(nullptr, false);
2576 if (!SubClass.Rec) return true;
2578 // Get the expanded definition prototypes and teach them about
2579 // the record values the current class to inherit has
2580 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i) {
2581 Record *CurRec = NewRecDefs[i];
2584 if (AddSubClass(CurRec, SubClass))
2587 if (ApplyLetStack(CurRec))
2591 if (Lex.getCode() != tgtok::comma) break;
2592 Lex.Lex(); // eat ','.
2593 SubClass = ParseSubClassReference(nullptr, false);
2598 for (unsigned i = 0, e = NewRecDefs.size(); i != e; ++i)
2599 // See Record::setName(). This resolve step will see any new
2600 // name for the def that might have been created when resolving
2601 // inheritance, values and arguments above.
2602 NewRecDefs[i]->resolveReferences();
2604 if (Lex.getCode() != tgtok::semi)
2605 return TokError("expected ';' at end of defm");
2612 /// Object ::= ClassInst
2613 /// Object ::= DefInst
2614 /// Object ::= MultiClassInst
2615 /// Object ::= DefMInst
2616 /// Object ::= LETCommand '{' ObjectList '}'
2617 /// Object ::= LETCommand Object
2618 bool TGParser::ParseObject(MultiClass *MC) {
2619 switch (Lex.getCode()) {
2621 return TokError("Expected class, def, defm, multiclass or let definition");
2622 case tgtok::Let: return ParseTopLevelLet(MC);
2623 case tgtok::Def: return ParseDef(MC);
2624 case tgtok::Foreach: return ParseForeach(MC);
2625 case tgtok::Defm: return ParseDefm(MC);
2626 case tgtok::Class: return ParseClass();
2627 case tgtok::MultiClass: return ParseMultiClass();
2632 /// ObjectList :== Object*
2633 bool TGParser::ParseObjectList(MultiClass *MC) {
2634 while (isObjectStart(Lex.getCode())) {
2635 if (ParseObject(MC))
2641 bool TGParser::ParseFile() {
2642 Lex.Lex(); // Prime the lexer.
2643 if (ParseObjectList()) return true;
2645 // If we have unread input at the end of the file, report it.
2646 if (Lex.getCode() == tgtok::Eof)
2649 return TokError("Unexpected input at top level");