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 //===----------------------------------------------------------------------===//
18 #include "llvm/ADT/StringExtras.h"
21 //===----------------------------------------------------------------------===//
22 // Support Code for the Semantic Actions.
23 //===----------------------------------------------------------------------===//
27 Record Rec; // Placeholder for template args and Name.
28 std::vector<Record*> DefPrototypes;
30 MultiClass(const std::string &Name) : Rec(Name) {}
33 struct SubClassReference {
34 TGParser::LocTy RefLoc;
36 std::vector<Init*> TemplateArgs;
37 SubClassReference() : RefLoc(0), Rec(0) {}
39 bool isInvalid() const { return Rec == 0; }
42 } // end namespace llvm
44 bool TGParser::AddValue(Record *CurRec, LocTy Loc, const RecordVal &RV) {
46 CurRec = &CurMultiClass->Rec;
48 if (RecordVal *ERV = CurRec->getValue(RV.getName())) {
49 // The value already exists in the class, treat this as a set.
50 if (ERV->setValue(RV.getValue()))
51 return Error(Loc, "New definition of '" + RV.getName() + "' of type '" +
52 RV.getType()->getAsString() + "' is incompatible with " +
53 "previous definition of type '" +
54 ERV->getType()->getAsString() + "'");
62 /// Return true on error, false on success.
63 bool TGParser::SetValue(Record *CurRec, LocTy Loc, const std::string &ValName,
64 const std::vector<unsigned> &BitList, Init *V) {
67 if (CurRec == 0) CurRec = &CurMultiClass->Rec;
69 RecordVal *RV = CurRec->getValue(ValName);
71 return Error(Loc, "Value '" + ValName + "' unknown!");
73 // Do not allow assignments like 'X = X'. This will just cause infinite loops
74 // in the resolution machinery.
76 if (VarInit *VI = dynamic_cast<VarInit*>(V))
77 if (VI->getName() == ValName)
80 // If we are assigning to a subset of the bits in the value... then we must be
81 // assigning to a field of BitsRecTy, which must have a BitsInit
84 if (!BitList.empty()) {
85 BitsInit *CurVal = dynamic_cast<BitsInit*>(RV->getValue());
87 return Error(Loc, "Value '" + ValName + "' is not a bits type");
89 // Convert the incoming value to a bits type of the appropriate size...
90 Init *BI = V->convertInitializerTo(new BitsRecTy(BitList.size()));
92 V->convertInitializerTo(new BitsRecTy(BitList.size()));
93 return Error(Loc, "Initializer is not compatible with bit range");
96 // We should have a BitsInit type now.
97 BitsInit *BInit = dynamic_cast<BitsInit*>(BI);
100 BitsInit *NewVal = new BitsInit(CurVal->getNumBits());
102 // Loop over bits, assigning values as appropriate.
103 for (unsigned i = 0, e = BitList.size(); i != e; ++i) {
104 unsigned Bit = BitList[i];
105 if (NewVal->getBit(Bit))
106 return Error(Loc, "Cannot set bit #" + utostr(Bit) + " of value '" +
107 ValName + "' more than once");
108 NewVal->setBit(Bit, BInit->getBit(i));
111 for (unsigned i = 0, e = CurVal->getNumBits(); i != e; ++i)
112 if (NewVal->getBit(i) == 0)
113 NewVal->setBit(i, CurVal->getBit(i));
119 return Error(Loc, "Value '" + ValName + "' of type '" +
120 RV->getType()->getAsString() +
121 "' is incompatible with initializer '" + V->getAsString() +"'");
125 /// AddSubClass - Add SubClass as a subclass to CurRec, resolving its template
126 /// args as SubClass's template arguments.
127 bool TGParser::AddSubClass(Record *CurRec, class SubClassReference &SubClass) {
128 Record *SC = SubClass.Rec;
129 // Add all of the values in the subclass into the current class.
130 const std::vector<RecordVal> &Vals = SC->getValues();
131 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
132 if (AddValue(CurRec, SubClass.RefLoc, Vals[i]))
135 const std::vector<std::string> &TArgs = SC->getTemplateArgs();
137 // Ensure that an appropriate number of template arguments are specified.
138 if (TArgs.size() < SubClass.TemplateArgs.size())
139 return Error(SubClass.RefLoc, "More template args specified than expected");
141 // Loop over all of the template arguments, setting them to the specified
142 // value or leaving them as the default if necessary.
143 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
144 if (i < SubClass.TemplateArgs.size()) {
145 // If a value is specified for this template arg, set it now.
146 if (SetValue(CurRec, SubClass.RefLoc, TArgs[i], std::vector<unsigned>(),
147 SubClass.TemplateArgs[i]))
151 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
154 CurRec->removeValue(TArgs[i]);
156 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
157 return Error(SubClass.RefLoc,"Value not specified for template argument #"
158 + utostr(i) + " (" + TArgs[i] + ") of subclass '" +
159 SC->getName() + "'!");
163 // Since everything went well, we can now set the "superclass" list for the
165 const std::vector<Record*> &SCs = SC->getSuperClasses();
166 for (unsigned i = 0, e = SCs.size(); i != e; ++i) {
167 if (CurRec->isSubClassOf(SCs[i]))
168 return Error(SubClass.RefLoc,
169 "Already subclass of '" + SCs[i]->getName() + "'!\n");
170 CurRec->addSuperClass(SCs[i]);
173 if (CurRec->isSubClassOf(SC))
174 return Error(SubClass.RefLoc,
175 "Already subclass of '" + SC->getName() + "'!\n");
176 CurRec->addSuperClass(SC);
180 //===----------------------------------------------------------------------===//
182 //===----------------------------------------------------------------------===//
184 /// isObjectStart - Return true if this is a valid first token for an Object.
185 static bool isObjectStart(tgtok::TokKind K) {
186 return K == tgtok::Class || K == tgtok::Def ||
187 K == tgtok::Defm || K == tgtok::Let || K == tgtok::MultiClass;
190 /// ParseObjectName - If an object name is specified, return it. Otherwise,
191 /// return an anonymous name.
192 /// ObjectName ::= ID
193 /// ObjectName ::= /*empty*/
195 std::string TGParser::ParseObjectName() {
196 if (Lex.getCode() == tgtok::Id) {
197 std::string Ret = Lex.getCurStrVal();
202 static unsigned AnonCounter = 0;
203 return "anonymous."+utostr(AnonCounter++);
207 /// ParseClassID - Parse and resolve a reference to a class name. This returns
212 Record *TGParser::ParseClassID() {
213 if (Lex.getCode() != tgtok::Id) {
214 TokError("expected name for ClassID");
218 Record *Result = Records.getClass(Lex.getCurStrVal());
220 TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
226 Record *TGParser::ParseDefmID() {
227 if (Lex.getCode() != tgtok::Id) {
228 TokError("expected multiclass name");
232 MultiClass *MC = MultiClasses[Lex.getCurStrVal()];
234 TokError("Couldn't find multiclass '" + Lex.getCurStrVal() + "'");
244 /// ParseSubClassReference - Parse a reference to a subclass or to a templated
245 /// subclass. This returns a SubClassRefTy with a null Record* on error.
247 /// SubClassRef ::= ClassID
248 /// SubClassRef ::= ClassID '<' ValueList '>'
250 SubClassReference TGParser::
251 ParseSubClassReference(Record *CurRec, bool isDefm) {
252 SubClassReference Result;
253 Result.RefLoc = Lex.getLoc();
256 Result.Rec = ParseDefmID();
258 Result.Rec = ParseClassID();
259 if (Result.Rec == 0) return Result;
261 // If there is no template arg list, we're done.
262 if (Lex.getCode() != tgtok::less)
264 Lex.Lex(); // Eat the '<'
266 if (Lex.getCode() == tgtok::greater) {
267 TokError("subclass reference requires a non-empty list of template values");
272 Result.TemplateArgs = ParseValueList(CurRec);
273 if (Result.TemplateArgs.empty()) {
274 Result.Rec = 0; // Error parsing value list.
278 if (Lex.getCode() != tgtok::greater) {
279 TokError("expected '>' in template value list");
288 /// ParseRangePiece - Parse a bit/value range.
289 /// RangePiece ::= INTVAL
290 /// RangePiece ::= INTVAL '-' INTVAL
291 /// RangePiece ::= INTVAL INTVAL
292 bool TGParser::ParseRangePiece(std::vector<unsigned> &Ranges) {
293 assert(Lex.getCode() == tgtok::IntVal && "Invalid range");
294 int Start = Lex.getCurIntVal();
298 return TokError("invalid range, cannot be negative");
300 switch (Lex.Lex()) { // eat first character.
302 Ranges.push_back(Start);
305 if (Lex.Lex() != tgtok::IntVal) {
306 TokError("expected integer value as end of range");
309 End = Lex.getCurIntVal();
312 End = -Lex.getCurIntVal();
316 return TokError("invalid range, cannot be negative");
321 for (; Start <= End; ++Start)
322 Ranges.push_back(Start);
324 for (; Start >= End; --Start)
325 Ranges.push_back(Start);
330 /// ParseRangeList - Parse a list of scalars and ranges into scalar values.
332 /// RangeList ::= RangePiece (',' RangePiece)*
334 std::vector<unsigned> TGParser::ParseRangeList() {
335 std::vector<unsigned> Result;
337 // Parse the first piece.
338 if (ParseRangePiece(Result))
339 return std::vector<unsigned>();
340 while (Lex.getCode() == tgtok::comma) {
341 Lex.Lex(); // Eat the comma.
343 // Parse the next range piece.
344 if (ParseRangePiece(Result))
345 return std::vector<unsigned>();
350 /// ParseOptionalRangeList - Parse either a range list in <>'s or nothing.
351 /// OptionalRangeList ::= '<' RangeList '>'
352 /// OptionalRangeList ::= /*empty*/
353 bool TGParser::ParseOptionalRangeList(std::vector<unsigned> &Ranges) {
354 if (Lex.getCode() != tgtok::less)
357 LocTy StartLoc = Lex.getLoc();
358 Lex.Lex(); // eat the '<'
360 // Parse the range list.
361 Ranges = ParseRangeList();
362 if (Ranges.empty()) return true;
364 if (Lex.getCode() != tgtok::greater) {
365 TokError("expected '>' at end of range list");
366 return Error(StartLoc, "to match this '<'");
368 Lex.Lex(); // eat the '>'.
372 /// ParseOptionalBitList - Parse either a bit list in {}'s or nothing.
373 /// OptionalBitList ::= '{' RangeList '}'
374 /// OptionalBitList ::= /*empty*/
375 bool TGParser::ParseOptionalBitList(std::vector<unsigned> &Ranges) {
376 if (Lex.getCode() != tgtok::l_brace)
379 LocTy StartLoc = Lex.getLoc();
380 Lex.Lex(); // eat the '{'
382 // Parse the range list.
383 Ranges = ParseRangeList();
384 if (Ranges.empty()) return true;
386 if (Lex.getCode() != tgtok::r_brace) {
387 TokError("expected '}' at end of bit list");
388 return Error(StartLoc, "to match this '{'");
390 Lex.Lex(); // eat the '}'.
395 /// ParseType - Parse and return a tblgen type. This returns null on error.
397 /// Type ::= STRING // string type
398 /// Type ::= BIT // bit type
399 /// Type ::= BITS '<' INTVAL '>' // bits<x> type
400 /// Type ::= INT // int type
401 /// Type ::= LIST '<' Type '>' // list<x> type
402 /// Type ::= CODE // code type
403 /// Type ::= DAG // dag type
404 /// Type ::= ClassID // Record Type
406 RecTy *TGParser::ParseType() {
407 switch (Lex.getCode()) {
408 default: TokError("Unknown token when expecting a type"); return 0;
409 case tgtok::String: Lex.Lex(); return new StringRecTy();
410 case tgtok::Bit: Lex.Lex(); return new BitRecTy();
411 case tgtok::Int: Lex.Lex(); return new IntRecTy();
412 case tgtok::Code: Lex.Lex(); return new CodeRecTy();
413 case tgtok::Dag: Lex.Lex(); return new DagRecTy();
415 if (Record *R = ParseClassID()) return new RecordRecTy(R);
418 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
419 TokError("expected '<' after bits type");
422 if (Lex.Lex() != tgtok::IntVal) { // Eat '<'
423 TokError("expected integer in bits<n> type");
426 unsigned Val = Lex.getCurIntVal();
427 if (Lex.Lex() != tgtok::greater) { // Eat count.
428 TokError("expected '>' at end of bits<n> type");
431 Lex.Lex(); // Eat '>'
432 return new BitsRecTy(Val);
435 if (Lex.Lex() != tgtok::less) { // Eat 'bits'
436 TokError("expected '<' after list type");
439 Lex.Lex(); // Eat '<'
440 RecTy *SubType = ParseType();
441 if (SubType == 0) return 0;
443 if (Lex.getCode() != tgtok::greater) {
444 TokError("expected '>' at end of list<ty> type");
447 Lex.Lex(); // Eat '>'
448 return new ListRecTy(SubType);
453 /// ParseIDValue - Parse an ID as a value and decode what it means.
455 /// IDValue ::= ID [def local value]
456 /// IDValue ::= ID [def template arg]
457 /// IDValue ::= ID [multiclass local value]
458 /// IDValue ::= ID [multiclass template argument]
459 /// IDValue ::= ID [def name]
461 Init *TGParser::ParseIDValue(Record *CurRec) {
462 assert(Lex.getCode() == tgtok::Id && "Expected ID in ParseIDValue");
463 std::string Name = Lex.getCurStrVal();
464 LocTy Loc = Lex.getLoc();
466 return ParseIDValue(CurRec, Name, Loc);
469 /// ParseIDValue - This is just like ParseIDValue above, but it assumes the ID
470 /// has already been read.
471 Init *TGParser::ParseIDValue(Record *CurRec,
472 const std::string &Name, LocTy NameLoc) {
474 if (const RecordVal *RV = CurRec->getValue(Name))
475 return new VarInit(Name, RV->getType());
477 std::string TemplateArgName = CurRec->getName()+":"+Name;
478 if (CurRec->isTemplateArg(TemplateArgName)) {
479 const RecordVal *RV = CurRec->getValue(TemplateArgName);
480 assert(RV && "Template arg doesn't exist??");
481 return new VarInit(TemplateArgName, RV->getType());
486 std::string MCName = CurMultiClass->Rec.getName()+"::"+Name;
487 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
488 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
489 assert(RV && "Template arg doesn't exist??");
490 return new VarInit(MCName, RV->getType());
494 if (Record *D = Records.getDef(Name))
495 return new DefInit(D);
497 Error(NameLoc, "Variable not defined: '" + Name + "'");
501 /// ParseSimpleValue - Parse a tblgen value. This returns null on error.
503 /// SimpleValue ::= IDValue
504 /// SimpleValue ::= INTVAL
505 /// SimpleValue ::= STRVAL
506 /// SimpleValue ::= CODEFRAGMENT
507 /// SimpleValue ::= '?'
508 /// SimpleValue ::= '{' ValueList '}'
509 /// SimpleValue ::= ID '<' ValueListNE '>'
510 /// SimpleValue ::= '[' ValueList ']'
511 /// SimpleValue ::= '(' IDValue DagArgList ')'
512 /// SimpleValue ::= CONCATTOK '(' Value ',' Value ')'
513 /// SimpleValue ::= SHLTOK '(' Value ',' Value ')'
514 /// SimpleValue ::= SRATOK '(' Value ',' Value ')'
515 /// SimpleValue ::= SRLTOK '(' Value ',' Value ')'
516 /// SimpleValue ::= STRCONCATTOK '(' Value ',' Value ')'
518 Init *TGParser::ParseSimpleValue(Record *CurRec) {
520 switch (Lex.getCode()) {
521 default: TokError("Unknown token when parsing a value"); break;
522 case tgtok::IntVal: R = new IntInit(Lex.getCurIntVal()); Lex.Lex(); break;
523 case tgtok::StrVal: R = new StringInit(Lex.getCurStrVal()); Lex.Lex(); break;
524 case tgtok::CodeFragment:
525 R = new CodeInit(Lex.getCurStrVal()); Lex.Lex(); break;
526 case tgtok::question: R = new UnsetInit(); Lex.Lex(); break;
528 LocTy NameLoc = Lex.getLoc();
529 std::string Name = Lex.getCurStrVal();
530 if (Lex.Lex() != tgtok::less) // consume the Id.
531 return ParseIDValue(CurRec, Name, NameLoc); // Value ::= IDValue
533 // Value ::= ID '<' ValueListNE '>'
534 if (Lex.Lex() == tgtok::greater) {
535 TokError("expected non-empty value list");
538 std::vector<Init*> ValueList = ParseValueList(CurRec);
539 if (ValueList.empty()) return 0;
541 if (Lex.getCode() != tgtok::greater) {
542 TokError("expected '>' at end of value list");
545 Lex.Lex(); // eat the '>'
547 // This is a CLASS<initvalslist> expression. This is supposed to synthesize
548 // a new anonymous definition, deriving from CLASS<initvalslist> with no
550 Record *Class = Records.getClass(Name);
552 Error(NameLoc, "Expected a class name, got '" + Name + "'");
556 // Create the new record, set it as CurRec temporarily.
557 static unsigned AnonCounter = 0;
558 Record *NewRec = new Record("anonymous.val."+utostr(AnonCounter++));
559 SubClassReference SCRef;
560 SCRef.RefLoc = NameLoc;
562 SCRef.TemplateArgs = ValueList;
563 // Add info about the subclass to NewRec.
564 if (AddSubClass(NewRec, SCRef))
566 NewRec->resolveReferences();
567 Records.addDef(NewRec);
569 // The result of the expression is a reference to the new record.
570 return new DefInit(NewRec);
572 case tgtok::l_brace: { // Value ::= '{' ValueList '}'
573 LocTy BraceLoc = Lex.getLoc();
574 Lex.Lex(); // eat the '{'
575 std::vector<Init*> Vals;
577 if (Lex.getCode() != tgtok::r_brace) {
578 Vals = ParseValueList(CurRec);
579 if (Vals.empty()) return 0;
581 if (Lex.getCode() != tgtok::r_brace) {
582 TokError("expected '}' at end of bit list value");
585 Lex.Lex(); // eat the '}'
587 BitsInit *Result = new BitsInit(Vals.size());
588 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
589 Init *Bit = Vals[i]->convertInitializerTo(new BitRecTy());
591 Error(BraceLoc, "Element #" + utostr(i) + " (" + Vals[i]->getAsString()+
592 ") is not convertable to a bit");
595 Result->setBit(Vals.size()-i-1, Bit);
599 case tgtok::l_square: { // Value ::= '[' ValueList ']'
600 Lex.Lex(); // eat the '['
601 std::vector<Init*> Vals;
603 if (Lex.getCode() != tgtok::r_square) {
604 Vals = ParseValueList(CurRec);
605 if (Vals.empty()) return 0;
607 if (Lex.getCode() != tgtok::r_square) {
608 TokError("expected ']' at end of list value");
611 Lex.Lex(); // eat the ']'
612 return new ListInit(Vals);
614 case tgtok::l_paren: { // Value ::= '(' IDValue DagArgList ')'
615 Lex.Lex(); // eat the '('
616 Init *Operator = ParseIDValue(CurRec);
617 if (Operator == 0) return 0;
619 std::vector<std::pair<llvm::Init*, std::string> > DagArgs;
620 if (Lex.getCode() != tgtok::r_paren) {
621 DagArgs = ParseDagArgList(CurRec);
622 if (DagArgs.empty()) return 0;
625 if (Lex.getCode() != tgtok::r_paren) {
626 TokError("expected ')' in dag init");
629 Lex.Lex(); // eat the ')'
631 return new DagInit(Operator, DagArgs);
637 case tgtok::XStrConcat: { // Value ::= !binop '(' Value ',' Value ')'
638 BinOpInit::BinaryOp Code;
639 switch (Lex.getCode()) {
640 default: assert(0 && "Unhandled code!");
641 case tgtok::XConcat: Code = BinOpInit::CONCAT; break;
642 case tgtok::XSRA: Code = BinOpInit::SRA; break;
643 case tgtok::XSRL: Code = BinOpInit::SRL; break;
644 case tgtok::XSHL: Code = BinOpInit::SHL; break;
645 case tgtok::XStrConcat: Code = BinOpInit::STRCONCAT; break;
647 Lex.Lex(); // eat the operation
648 if (Lex.getCode() != tgtok::l_paren) {
649 TokError("expected '(' after binary operator");
652 Lex.Lex(); // eat the '('
654 Init *LHS = ParseValue(CurRec);
655 if (LHS == 0) return 0;
657 if (Lex.getCode() != tgtok::comma) {
658 TokError("expected ',' in binary operator");
661 Lex.Lex(); // eat the ','
663 Init *RHS = ParseValue(CurRec);
664 if (RHS == 0) return 0;
666 if (Lex.getCode() != tgtok::r_paren) {
667 TokError("expected ')' in binary operator");
670 Lex.Lex(); // eat the ')'
671 return (new BinOpInit(Code, LHS, RHS))->Fold();
678 /// ParseValue - Parse a tblgen value. This returns null on error.
680 /// Value ::= SimpleValue ValueSuffix*
681 /// ValueSuffix ::= '{' BitList '}'
682 /// ValueSuffix ::= '[' BitList ']'
683 /// ValueSuffix ::= '.' ID
685 Init *TGParser::ParseValue(Record *CurRec) {
686 Init *Result = ParseSimpleValue(CurRec);
687 if (Result == 0) return 0;
689 // Parse the suffixes now if present.
691 switch (Lex.getCode()) {
692 default: return Result;
693 case tgtok::l_brace: {
694 LocTy CurlyLoc = Lex.getLoc();
695 Lex.Lex(); // eat the '{'
696 std::vector<unsigned> Ranges = ParseRangeList();
697 if (Ranges.empty()) return 0;
699 // Reverse the bitlist.
700 std::reverse(Ranges.begin(), Ranges.end());
701 Result = Result->convertInitializerBitRange(Ranges);
703 Error(CurlyLoc, "Invalid bit range for value");
708 if (Lex.getCode() != tgtok::r_brace) {
709 TokError("expected '}' at end of bit range list");
715 case tgtok::l_square: {
716 LocTy SquareLoc = Lex.getLoc();
717 Lex.Lex(); // eat the '['
718 std::vector<unsigned> Ranges = ParseRangeList();
719 if (Ranges.empty()) return 0;
721 Result = Result->convertInitListSlice(Ranges);
723 Error(SquareLoc, "Invalid range for list slice");
728 if (Lex.getCode() != tgtok::r_square) {
729 TokError("expected ']' at end of list slice");
736 if (Lex.Lex() != tgtok::Id) { // eat the .
737 TokError("expected field identifier after '.'");
740 if (!Result->getFieldType(Lex.getCurStrVal())) {
741 TokError("Cannot access field '" + Lex.getCurStrVal() + "' of value '" +
742 Result->getAsString() + "'");
745 Result = new FieldInit(Result, Lex.getCurStrVal());
746 Lex.Lex(); // eat field name
752 /// ParseDagArgList - Parse the argument list for a dag literal expression.
754 /// ParseDagArgList ::= Value (':' VARNAME)?
755 /// ParseDagArgList ::= ParseDagArgList ',' Value (':' VARNAME)?
756 std::vector<std::pair<llvm::Init*, std::string> >
757 TGParser::ParseDagArgList(Record *CurRec) {
758 std::vector<std::pair<llvm::Init*, std::string> > Result;
761 Init *Val = ParseValue(CurRec);
762 if (Val == 0) return std::vector<std::pair<llvm::Init*, std::string> >();
764 // If the variable name is present, add it.
766 if (Lex.getCode() == tgtok::colon) {
767 if (Lex.Lex() != tgtok::VarName) { // eat the ':'
768 TokError("expected variable name in dag literal");
769 return std::vector<std::pair<llvm::Init*, std::string> >();
771 VarName = Lex.getCurStrVal();
772 Lex.Lex(); // eat the VarName.
775 Result.push_back(std::make_pair(Val, VarName));
777 if (Lex.getCode() != tgtok::comma) break;
778 Lex.Lex(); // eat the ','
785 /// ParseValueList - Parse a comma separated list of values, returning them as a
786 /// vector. Note that this always expects to be able to parse at least one
787 /// value. It returns an empty list if this is not possible.
789 /// ValueList ::= Value (',' Value)
791 std::vector<Init*> TGParser::ParseValueList(Record *CurRec) {
792 std::vector<Init*> Result;
793 Result.push_back(ParseValue(CurRec));
794 if (Result.back() == 0) return std::vector<Init*>();
796 while (Lex.getCode() == tgtok::comma) {
797 Lex.Lex(); // Eat the comma
799 Result.push_back(ParseValue(CurRec));
800 if (Result.back() == 0) return std::vector<Init*>();
808 /// ParseDeclaration - Read a declaration, returning the name of field ID, or an
809 /// empty string on error. This can happen in a number of different context's,
810 /// including within a def or in the template args for a def (which which case
811 /// CurRec will be non-null) and within the template args for a multiclass (in
812 /// which case CurRec will be null, but CurMultiClass will be set). This can
813 /// also happen within a def that is within a multiclass, which will set both
814 /// CurRec and CurMultiClass.
816 /// Declaration ::= FIELD? Type ID ('=' Value)?
818 std::string TGParser::ParseDeclaration(Record *CurRec,
819 bool ParsingTemplateArgs) {
820 // Read the field prefix if present.
821 bool HasField = Lex.getCode() == tgtok::Field;
822 if (HasField) Lex.Lex();
824 RecTy *Type = ParseType();
825 if (Type == 0) return "";
827 if (Lex.getCode() != tgtok::Id) {
828 TokError("Expected identifier in declaration");
832 LocTy IdLoc = Lex.getLoc();
833 std::string DeclName = Lex.getCurStrVal();
836 if (ParsingTemplateArgs) {
838 DeclName = CurRec->getName() + ":" + DeclName;
840 assert(CurMultiClass);
843 DeclName = CurMultiClass->Rec.getName() + "::" + DeclName;
847 if (AddValue(CurRec, IdLoc, RecordVal(DeclName, Type, HasField)))
850 // If a value is present, parse it.
851 if (Lex.getCode() == tgtok::equal) {
853 LocTy ValLoc = Lex.getLoc();
854 Init *Val = ParseValue(CurRec);
856 SetValue(CurRec, ValLoc, DeclName, std::vector<unsigned>(), Val))
863 /// ParseTemplateArgList - Read a template argument list, which is a non-empty
864 /// sequence of template-declarations in <>'s. If CurRec is non-null, these are
865 /// template args for a def, which may or may not be in a multiclass. If null,
866 /// these are the template args for a multiclass.
868 /// TemplateArgList ::= '<' Declaration (',' Declaration)* '>'
870 bool TGParser::ParseTemplateArgList(Record *CurRec) {
871 assert(Lex.getCode() == tgtok::less && "Not a template arg list!");
872 Lex.Lex(); // eat the '<'
874 Record *TheRecToAddTo = CurRec ? CurRec : &CurMultiClass->Rec;
876 // Read the first declaration.
877 std::string TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
878 if (TemplArg.empty())
881 TheRecToAddTo->addTemplateArg(TemplArg);
883 while (Lex.getCode() == tgtok::comma) {
884 Lex.Lex(); // eat the ','
886 // Read the following declarations.
887 TemplArg = ParseDeclaration(CurRec, true/*templateargs*/);
888 if (TemplArg.empty())
890 TheRecToAddTo->addTemplateArg(TemplArg);
893 if (Lex.getCode() != tgtok::greater)
894 return TokError("expected '>' at end of template argument list");
895 Lex.Lex(); // eat the '>'.
900 /// ParseBodyItem - Parse a single item at within the body of a def or class.
902 /// BodyItem ::= Declaration ';'
903 /// BodyItem ::= LET ID OptionalBitList '=' Value ';'
904 bool TGParser::ParseBodyItem(Record *CurRec) {
905 if (Lex.getCode() != tgtok::Let) {
906 if (ParseDeclaration(CurRec, false).empty())
909 if (Lex.getCode() != tgtok::semi)
910 return TokError("expected ';' after declaration");
915 // LET ID OptionalRangeList '=' Value ';'
916 if (Lex.Lex() != tgtok::Id)
917 return TokError("expected field identifier after let");
919 LocTy IdLoc = Lex.getLoc();
920 std::string FieldName = Lex.getCurStrVal();
921 Lex.Lex(); // eat the field name.
923 std::vector<unsigned> BitList;
924 if (ParseOptionalBitList(BitList))
926 std::reverse(BitList.begin(), BitList.end());
928 if (Lex.getCode() != tgtok::equal)
929 return TokError("expected '=' in let expression");
930 Lex.Lex(); // eat the '='.
932 Init *Val = ParseValue(CurRec);
933 if (Val == 0) return true;
935 if (Lex.getCode() != tgtok::semi)
936 return TokError("expected ';' after let expression");
939 return SetValue(CurRec, IdLoc, FieldName, BitList, Val);
942 /// ParseBody - Read the body of a class or def. Return true on error, false on
946 /// Body ::= '{' BodyList '}'
947 /// BodyList BodyItem*
949 bool TGParser::ParseBody(Record *CurRec) {
950 // If this is a null definition, just eat the semi and return.
951 if (Lex.getCode() == tgtok::semi) {
956 if (Lex.getCode() != tgtok::l_brace)
957 return TokError("Expected ';' or '{' to start body");
961 while (Lex.getCode() != tgtok::r_brace)
962 if (ParseBodyItem(CurRec))
970 /// ParseObjectBody - Parse the body of a def or class. This consists of an
971 /// optional ClassList followed by a Body. CurRec is the current def or class
972 /// that is being parsed.
974 /// ObjectBody ::= BaseClassList Body
975 /// BaseClassList ::= /*empty*/
976 /// BaseClassList ::= ':' BaseClassListNE
977 /// BaseClassListNE ::= SubClassRef (',' SubClassRef)*
979 bool TGParser::ParseObjectBody(Record *CurRec) {
980 // If there is a baseclass list, read it.
981 if (Lex.getCode() == tgtok::colon) {
984 // Read all of the subclasses.
985 SubClassReference SubClass = ParseSubClassReference(CurRec, false);
988 if (SubClass.Rec == 0) return true;
991 if (AddSubClass(CurRec, SubClass))
994 if (Lex.getCode() != tgtok::comma) break;
995 Lex.Lex(); // eat ','.
996 SubClass = ParseSubClassReference(CurRec, false);
1000 // Process any variables on the let stack.
1001 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1002 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1003 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1004 LetStack[i][j].Bits, LetStack[i][j].Value))
1007 return ParseBody(CurRec);
1011 /// ParseDef - Parse and return a top level or multiclass def, return the record
1012 /// corresponding to it. This returns null on error.
1014 /// DefInst ::= DEF ObjectName ObjectBody
1016 llvm::Record *TGParser::ParseDef(MultiClass *CurMultiClass) {
1017 LocTy DefLoc = Lex.getLoc();
1018 assert(Lex.getCode() == tgtok::Def && "Unknown tok");
1019 Lex.Lex(); // Eat the 'def' token.
1021 // Parse ObjectName and make a record for it.
1022 Record *CurRec = new Record(ParseObjectName());
1024 if (!CurMultiClass) {
1025 // Top-level def definition.
1027 // Ensure redefinition doesn't happen.
1028 if (Records.getDef(CurRec->getName())) {
1029 Error(DefLoc, "def '" + CurRec->getName() + "' already defined");
1032 Records.addDef(CurRec);
1034 // Otherwise, a def inside a multiclass, add it to the multiclass.
1035 for (unsigned i = 0, e = CurMultiClass->DefPrototypes.size(); i != e; ++i)
1036 if (CurMultiClass->DefPrototypes[i]->getName() == CurRec->getName()) {
1037 Error(DefLoc, "def '" + CurRec->getName() +
1038 "' already defined in this multiclass!");
1041 CurMultiClass->DefPrototypes.push_back(CurRec);
1044 if (ParseObjectBody(CurRec))
1047 if (CurMultiClass == 0) // Def's in multiclasses aren't really defs.
1048 CurRec->resolveReferences();
1050 // If ObjectBody has template arguments, it's an error.
1051 assert(CurRec->getTemplateArgs().empty() && "How'd this get template args?");
1056 /// ParseClass - Parse a tblgen class definition.
1058 /// ClassInst ::= CLASS ID TemplateArgList? ObjectBody
1060 bool TGParser::ParseClass() {
1061 assert(Lex.getCode() == tgtok::Class && "Unexpected token!");
1064 if (Lex.getCode() != tgtok::Id)
1065 return TokError("expected class name after 'class' keyword");
1067 Record *CurRec = Records.getClass(Lex.getCurStrVal());
1069 // If the body was previously defined, this is an error.
1070 if (!CurRec->getValues().empty() ||
1071 !CurRec->getSuperClasses().empty() ||
1072 !CurRec->getTemplateArgs().empty())
1073 return TokError("Class '" + CurRec->getName() + "' already defined");
1075 // If this is the first reference to this class, create and add it.
1076 CurRec = new Record(Lex.getCurStrVal());
1077 Records.addClass(CurRec);
1079 Lex.Lex(); // eat the name.
1081 // If there are template args, parse them.
1082 if (Lex.getCode() == tgtok::less)
1083 if (ParseTemplateArgList(CurRec))
1086 // Finally, parse the object body.
1087 return ParseObjectBody(CurRec);
1090 /// ParseLetList - Parse a non-empty list of assignment expressions into a list
1093 /// LetList ::= LetItem (',' LetItem)*
1094 /// LetItem ::= ID OptionalRangeList '=' Value
1096 std::vector<LetRecord> TGParser::ParseLetList() {
1097 std::vector<LetRecord> Result;
1100 if (Lex.getCode() != tgtok::Id) {
1101 TokError("expected identifier in let definition");
1102 return std::vector<LetRecord>();
1104 std::string Name = Lex.getCurStrVal();
1105 LocTy NameLoc = Lex.getLoc();
1106 Lex.Lex(); // Eat the identifier.
1108 // Check for an optional RangeList.
1109 std::vector<unsigned> Bits;
1110 if (ParseOptionalRangeList(Bits))
1111 return std::vector<LetRecord>();
1112 std::reverse(Bits.begin(), Bits.end());
1114 if (Lex.getCode() != tgtok::equal) {
1115 TokError("expected '=' in let expression");
1116 return std::vector<LetRecord>();
1118 Lex.Lex(); // eat the '='.
1120 Init *Val = ParseValue(0);
1121 if (Val == 0) return std::vector<LetRecord>();
1123 // Now that we have everything, add the record.
1124 Result.push_back(LetRecord(Name, Bits, Val, NameLoc));
1126 if (Lex.getCode() != tgtok::comma)
1128 Lex.Lex(); // eat the comma.
1132 /// ParseTopLevelLet - Parse a 'let' at top level. This can be a couple of
1133 /// different related productions.
1135 /// Object ::= LET LetList IN '{' ObjectList '}'
1136 /// Object ::= LET LetList IN Object
1138 bool TGParser::ParseTopLevelLet() {
1139 assert(Lex.getCode() == tgtok::Let && "Unexpected token");
1142 // Add this entry to the let stack.
1143 std::vector<LetRecord> LetInfo = ParseLetList();
1144 if (LetInfo.empty()) return true;
1145 LetStack.push_back(LetInfo);
1147 if (Lex.getCode() != tgtok::In)
1148 return TokError("expected 'in' at end of top-level 'let'");
1151 // If this is a scalar let, just handle it now
1152 if (Lex.getCode() != tgtok::l_brace) {
1153 // LET LetList IN Object
1156 } else { // Object ::= LETCommand '{' ObjectList '}'
1157 LocTy BraceLoc = Lex.getLoc();
1158 // Otherwise, this is a group let.
1159 Lex.Lex(); // eat the '{'.
1161 // Parse the object list.
1162 if (ParseObjectList())
1165 if (Lex.getCode() != tgtok::r_brace) {
1166 TokError("expected '}' at end of top level let command");
1167 return Error(BraceLoc, "to match this '{'");
1172 // Outside this let scope, this let block is not active.
1173 LetStack.pop_back();
1177 /// ParseMultiClassDef - Parse a def in a multiclass context.
1179 /// MultiClassDef ::= DefInst
1181 bool TGParser::ParseMultiClassDef(MultiClass *CurMC) {
1182 if (Lex.getCode() != tgtok::Def)
1183 return TokError("expected 'def' in multiclass body");
1185 Record *D = ParseDef(CurMC);
1186 if (D == 0) return true;
1188 // Copy the template arguments for the multiclass into the def.
1189 const std::vector<std::string> &TArgs = CurMC->Rec.getTemplateArgs();
1191 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1192 const RecordVal *RV = CurMC->Rec.getValue(TArgs[i]);
1193 assert(RV && "Template arg doesn't exist?");
1200 /// ParseMultiClass - Parse a multiclass definition.
1202 /// MultiClassInst ::= MULTICLASS ID TemplateArgList? '{' MultiClassDef+ '}'
1204 bool TGParser::ParseMultiClass() {
1205 assert(Lex.getCode() == tgtok::MultiClass && "Unexpected token");
1206 Lex.Lex(); // Eat the multiclass token.
1208 if (Lex.getCode() != tgtok::Id)
1209 return TokError("expected identifier after multiclass for name");
1210 std::string Name = Lex.getCurStrVal();
1212 if (MultiClasses.count(Name))
1213 return TokError("multiclass '" + Name + "' already defined");
1215 CurMultiClass = MultiClasses[Name] = new MultiClass(Name);
1216 Lex.Lex(); // Eat the identifier.
1218 // If there are template args, parse them.
1219 if (Lex.getCode() == tgtok::less)
1220 if (ParseTemplateArgList(0))
1223 if (Lex.getCode() != tgtok::l_brace)
1224 return TokError("expected '{' in multiclass definition");
1226 if (Lex.Lex() == tgtok::r_brace) // eat the '{'.
1227 return TokError("multiclass must contain at least one def");
1229 while (Lex.getCode() != tgtok::r_brace)
1230 if (ParseMultiClassDef(CurMultiClass))
1233 Lex.Lex(); // eat the '}'.
1239 /// ParseDefm - Parse the instantiation of a multiclass.
1241 /// DefMInst ::= DEFM ID ':' DefmSubClassRef ';'
1243 bool TGParser::ParseDefm() {
1244 assert(Lex.getCode() == tgtok::Defm && "Unexpected token!");
1245 if (Lex.Lex() != tgtok::Id) // eat the defm.
1246 return TokError("expected identifier after defm");
1248 LocTy DefmPrefixLoc = Lex.getLoc();
1249 std::string DefmPrefix = Lex.getCurStrVal();
1250 if (Lex.Lex() != tgtok::colon)
1251 return TokError("expected ':' after defm identifier");
1256 LocTy SubClassLoc = Lex.getLoc();
1257 SubClassReference Ref = ParseSubClassReference(0, true);
1258 if (Ref.Rec == 0) return true;
1260 if (Lex.getCode() != tgtok::semi)
1261 return TokError("expected ';' at end of defm");
1264 // To instantiate a multiclass, we need to first get the multiclass, then
1265 // instantiate each def contained in the multiclass with the SubClassRef
1266 // template parameters.
1267 MultiClass *MC = MultiClasses[Ref.Rec->getName()];
1268 assert(MC && "Didn't lookup multiclass correctly?");
1269 std::vector<Init*> &TemplateVals = Ref.TemplateArgs;
1271 // Verify that the correct number of template arguments were specified.
1272 const std::vector<std::string> &TArgs = MC->Rec.getTemplateArgs();
1273 if (TArgs.size() < TemplateVals.size())
1274 return Error(SubClassLoc,
1275 "more template args specified than multiclass expects");
1277 // Loop over all the def's in the multiclass, instantiating each one.
1278 for (unsigned i = 0, e = MC->DefPrototypes.size(); i != e; ++i) {
1279 Record *DefProto = MC->DefPrototypes[i];
1281 // Add the suffix to the defm name to get the new name.
1282 Record *CurRec = new Record(DefmPrefix + DefProto->getName());
1284 SubClassReference Ref;
1285 Ref.RefLoc = DefmPrefixLoc;
1287 AddSubClass(CurRec, Ref);
1289 // Loop over all of the template arguments, setting them to the specified
1290 // value or leaving them as the default if necessary.
1291 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1292 if (i < TemplateVals.size()) { // A value is specified for this temp-arg?
1294 if (SetValue(CurRec, DefmPrefixLoc, TArgs[i], std::vector<unsigned>(),
1299 CurRec->resolveReferencesTo(CurRec->getValue(TArgs[i]));
1302 CurRec->removeValue(TArgs[i]);
1304 } else if (!CurRec->getValue(TArgs[i])->getValue()->isComplete()) {
1305 return Error(SubClassLoc, "value not specified for template argument #"+
1306 utostr(i) + " (" + TArgs[i] + ") of multiclassclass '" +
1307 MC->Rec.getName() + "'");
1311 // If the mdef is inside a 'let' expression, add to each def.
1312 for (unsigned i = 0, e = LetStack.size(); i != e; ++i)
1313 for (unsigned j = 0, e = LetStack[i].size(); j != e; ++j)
1314 if (SetValue(CurRec, LetStack[i][j].Loc, LetStack[i][j].Name,
1315 LetStack[i][j].Bits, LetStack[i][j].Value)) {
1316 Error(DefmPrefixLoc, "when instantiating this defm");
1321 // Ensure redefinition doesn't happen.
1322 if (Records.getDef(CurRec->getName()))
1323 return Error(DefmPrefixLoc, "def '" + CurRec->getName() +
1324 "' already defined, instantiating defm with subdef '" +
1325 DefProto->getName() + "'");
1326 Records.addDef(CurRec);
1327 CurRec->resolveReferences();
1334 /// Object ::= ClassInst
1335 /// Object ::= DefInst
1336 /// Object ::= MultiClassInst
1337 /// Object ::= DefMInst
1338 /// Object ::= LETCommand '{' ObjectList '}'
1339 /// Object ::= LETCommand Object
1340 bool TGParser::ParseObject() {
1341 switch (Lex.getCode()) {
1342 default: assert(0 && "This is not an object");
1343 case tgtok::Let: return ParseTopLevelLet();
1344 case tgtok::Def: return ParseDef(0) == 0;
1345 case tgtok::Defm: return ParseDefm();
1346 case tgtok::Class: return ParseClass();
1347 case tgtok::MultiClass: return ParseMultiClass();
1352 /// ObjectList :== Object*
1353 bool TGParser::ParseObjectList() {
1354 while (isObjectStart(Lex.getCode())) {
1362 bool TGParser::ParseFile() {
1363 Lex.Lex(); // Prime the lexer.
1364 if (ParseObjectList()) return true;
1366 // If we have unread input at the end of the file, report it.
1367 if (Lex.getCode() == tgtok::Eof)
1370 return TokError("Unexpected input at top level");