LLVM  14.0.0git
TGParser.h
Go to the documentation of this file.
1 //===- TGParser.h - Parser for TableGen Files -------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This class represents the Parser for tablegen files.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_LIB_TABLEGEN_TGPARSER_H
14 #define LLVM_LIB_TABLEGEN_TGPARSER_H
15 
16 #include "TGLexer.h"
17 #include "llvm/TableGen/Error.h"
18 #include "llvm/TableGen/Record.h"
19 #include <map>
20 
21 namespace llvm {
22  class SourceMgr;
23  class Twine;
24  struct ForeachLoop;
25  struct MultiClass;
26  struct SubClassReference;
27  struct SubMultiClassReference;
28 
29  struct LetRecord {
31  std::vector<unsigned> Bits;
35  : Name(N), Bits(B), Value(V), Loc(L) {
36  }
37  };
38 
39  /// RecordsEntry - Holds exactly one of a Record, ForeachLoop, or
40  /// AssertionInfo.
41  struct RecordsEntry {
42  std::unique_ptr<Record> Rec;
43  std::unique_ptr<ForeachLoop> Loop;
44  std::unique_ptr<Record::AssertionInfo> Assertion;
45 
46  void dump() const;
47 
49  RecordsEntry(std::unique_ptr<Record> Rec) : Rec(std::move(Rec)) {}
50  RecordsEntry(std::unique_ptr<ForeachLoop> Loop)
51  : Loop(std::move(Loop)) {}
52  RecordsEntry(std::unique_ptr<Record::AssertionInfo> Assertion)
53  : Assertion(std::move(Assertion)) {}
54  };
55 
56  /// ForeachLoop - Record the iteration state associated with a for loop.
57  /// This is used to instantiate items in the loop body.
58  ///
59  /// IterVar is allowed to be null, in which case no iteration variable is
60  /// defined in the loop at all. (This happens when a ForeachLoop is
61  /// constructed by desugaring an if statement.)
62  struct ForeachLoop {
66  std::vector<RecordsEntry> Entries;
67 
68  void dump() const;
69 
70  ForeachLoop(SMLoc Loc, VarInit *IVar, Init *LValue)
71  : Loc(Loc), IterVar(IVar), ListValue(LValue) {}
72  };
73 
74  struct DefsetRecord {
76  RecTy *EltTy = nullptr;
78  };
79 
81  // A scope to hold local variable definitions from defvar.
82  std::map<std::string, Init *, std::less<>> vars;
83  std::unique_ptr<TGLocalVarScope> parent;
84 
85 public:
86  TGLocalVarScope() = default;
87  TGLocalVarScope(std::unique_ptr<TGLocalVarScope> parent)
88  : parent(std::move(parent)) {}
89 
90  std::unique_ptr<TGLocalVarScope> extractParent() {
91  // This is expected to be called just before we are destructed, so
92  // it doesn't much matter what state we leave 'parent' in.
93  return std::move(parent);
94  }
95 
97  auto It = vars.find(Name);
98  if (It != vars.end())
99  return It->second;
100  if (parent)
101  return parent->getVar(Name);
102  return nullptr;
103  }
104 
106  // When we check whether a variable is already defined, for the purpose of
107  // reporting an error on redefinition, we don't look up to the parent
108  // scope, because it's all right to shadow an outer definition with an
109  // inner one.
110  return vars.find(Name) != vars.end();
111  }
112 
114  bool Ins = vars.insert(std::make_pair(std::string(Name), I)).second;
115  (void)Ins;
116  assert(Ins && "Local variable already exists");
117  }
118 };
119 
120 struct MultiClass {
121  Record Rec; // Placeholder for template args and Name.
122  std::vector<RecordsEntry> Entries;
123 
124  void dump() const;
125 
127  Rec(Name, Loc, Records) {}
128 };
129 
130 class TGParser {
131  TGLexer Lex;
132  std::vector<SmallVector<LetRecord, 4>> LetStack;
133  std::map<std::string, std::unique_ptr<MultiClass>> MultiClasses;
134 
135  /// Loops - Keep track of any foreach loops we are within.
136  ///
137  std::vector<std::unique_ptr<ForeachLoop>> Loops;
138 
140 
141  /// CurMultiClass - If we are parsing a 'multiclass' definition, this is the
142  /// current value.
143  MultiClass *CurMultiClass;
144 
145  /// CurLocalScope - Innermost of the current nested scopes for 'defvar' local
146  /// variables.
147  std::unique_ptr<TGLocalVarScope> CurLocalScope;
148 
149  // Record tracker
150  RecordKeeper &Records;
151 
152  // A "named boolean" indicating how to parse identifiers. Usually
153  // identifiers map to some existing object but in special cases
154  // (e.g. parsing def names) no such object exists yet because we are
155  // in the middle of creating in. For those situations, allow the
156  // parser to ignore missing object errors.
157  enum IDParseMode {
158  ParseValueMode, // We are parsing a value we expect to look up.
159  ParseNameMode, // We are parsing a name of an object that does not yet
160  // exist.
161  };
162 
163 public:
165  RecordKeeper &records)
166  : Lex(SM, Macros), CurMultiClass(nullptr), Records(records) {}
167 
168  /// ParseFile - Main entrypoint for parsing a tblgen file. These parser
169  /// routines return true on error, or false on success.
170  bool ParseFile();
171 
172  bool Error(SMLoc L, const Twine &Msg) const {
173  PrintError(L, Msg);
174  return true;
175  }
176  bool TokError(const Twine &Msg) const {
177  return Error(Lex.getLoc(), Msg);
178  }
180  return Lex.getDependencies();
181  }
182 
184  CurLocalScope = std::make_unique<TGLocalVarScope>(std::move(CurLocalScope));
185  // Returns a pointer to the new scope, so that the caller can pass it back
186  // to PopLocalScope which will check by assertion that the pushes and pops
187  // match up properly.
188  return CurLocalScope.get();
189  }
190  void PopLocalScope(TGLocalVarScope *ExpectedStackTop) {
191  assert(ExpectedStackTop == CurLocalScope.get() &&
192  "Mismatched pushes and pops of local variable scopes");
193  CurLocalScope = CurLocalScope->extractParent();
194  }
195 
196 private: // Semantic analysis methods.
197  bool AddValue(Record *TheRec, SMLoc Loc, const RecordVal &RV);
198  bool SetValue(Record *TheRec, SMLoc Loc, Init *ValName,
199  ArrayRef<unsigned> BitList, Init *V,
200  bool AllowSelfAssignment = false);
201  bool AddSubClass(Record *Rec, SubClassReference &SubClass);
202  bool AddSubClass(RecordsEntry &Entry, SubClassReference &SubClass);
203  bool AddSubMultiClass(MultiClass *CurMC,
204  SubMultiClassReference &SubMultiClass);
205 
206  using SubstStack = SmallVector<std::pair<Init *, Init *>, 8>;
207 
208  bool addEntry(RecordsEntry E);
209  bool resolve(const ForeachLoop &Loop, SubstStack &Stack, bool Final,
210  std::vector<RecordsEntry> *Dest, SMLoc *Loc = nullptr);
211  bool resolve(const std::vector<RecordsEntry> &Source, SubstStack &Substs,
212  bool Final, std::vector<RecordsEntry> *Dest,
213  SMLoc *Loc = nullptr);
214  bool addDefOne(std::unique_ptr<Record> Rec);
215 
216 private: // Parser methods.
217  bool consume(tgtok::TokKind K);
218  bool ParseObjectList(MultiClass *MC = nullptr);
219  bool ParseObject(MultiClass *MC);
220  bool ParseClass();
221  bool ParseMultiClass();
222  bool ParseDefm(MultiClass *CurMultiClass);
223  bool ParseDef(MultiClass *CurMultiClass);
224  bool ParseDefset();
225  bool ParseDefvar();
226  bool ParseForeach(MultiClass *CurMultiClass);
227  bool ParseIf(MultiClass *CurMultiClass);
228  bool ParseIfBody(MultiClass *CurMultiClass, StringRef Kind);
229  bool ParseAssert(MultiClass *CurMultiClass, Record *CurRec = nullptr);
230  bool ParseTopLevelLet(MultiClass *CurMultiClass);
231  void ParseLetList(SmallVectorImpl<LetRecord> &Result);
232 
233  bool ParseObjectBody(Record *CurRec);
234  bool ParseBody(Record *CurRec);
235  bool ParseBodyItem(Record *CurRec);
236 
237  bool ParseTemplateArgList(Record *CurRec);
238  Init *ParseDeclaration(Record *CurRec, bool ParsingTemplateArgs);
239  VarInit *ParseForeachDeclaration(Init *&ForeachListValue);
240 
241  SubClassReference ParseSubClassReference(Record *CurRec, bool isDefm);
242  SubMultiClassReference ParseSubMultiClassReference(MultiClass *CurMC);
243 
244  Init *ParseIDValue(Record *CurRec, StringInit *Name, SMLoc NameLoc,
245  IDParseMode Mode = ParseValueMode);
246  Init *ParseSimpleValue(Record *CurRec, RecTy *ItemType = nullptr,
247  IDParseMode Mode = ParseValueMode);
248  Init *ParseValue(Record *CurRec, RecTy *ItemType = nullptr,
249  IDParseMode Mode = ParseValueMode);
250  void ParseValueList(SmallVectorImpl<llvm::Init*> &Result,
251  Record *CurRec, RecTy *ItemType = nullptr);
252  bool ParseTemplateArgValueList(SmallVectorImpl<llvm::Init *> &Result,
253  Record *CurRec, Record *ArgsRec);
254  void ParseDagArgList(
255  SmallVectorImpl<std::pair<llvm::Init*, StringInit*>> &Result,
256  Record *CurRec);
257  bool ParseOptionalRangeList(SmallVectorImpl<unsigned> &Ranges);
258  bool ParseOptionalBitList(SmallVectorImpl<unsigned> &Ranges);
259  void ParseRangeList(SmallVectorImpl<unsigned> &Result);
260  bool ParseRangePiece(SmallVectorImpl<unsigned> &Ranges,
261  TypedInit *FirstItem = nullptr);
262  RecTy *ParseType();
263  Init *ParseOperation(Record *CurRec, RecTy *ItemType);
264  Init *ParseOperationSubstr(Record *CurRec, RecTy *ItemType);
265  Init *ParseOperationFind(Record *CurRec, RecTy *ItemType);
266  Init *ParseOperationForEachFilter(Record *CurRec, RecTy *ItemType);
267  Init *ParseOperationCond(Record *CurRec, RecTy *ItemType);
268  RecTy *ParseOperatorType();
269  Init *ParseObjectName(MultiClass *CurMultiClass);
270  Record *ParseClassID();
271  MultiClass *ParseMultiClassID();
272  bool ApplyLetStack(Record *CurRec);
273  bool ApplyLetStack(RecordsEntry &Entry);
274  bool CheckTemplateArgValues(SmallVectorImpl<llvm::Init *> &Values,
275  SMLoc Loc, Record *ArgsRec);
276 };
277 
278 } // end namespace llvm
279 
280 #endif
llvm::RecordsEntry::RecordsEntry
RecordsEntry(std::unique_ptr< ForeachLoop > Loop)
Definition: TGParser.h:50
llvm::ForeachLoop::dump
void dump() const
Definition: TGParser.cpp:3774
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::RecordKeeper
Definition: Record.h:1771
llvm::TGParser::TokError
bool TokError(const Twine &Msg) const
Definition: TGParser.h:176
llvm::RecordsEntry::RecordsEntry
RecordsEntry(std::unique_ptr< Record > Rec)
Definition: TGParser.h:49
llvm::Loop
Represents a single loop in the control flow graph.
Definition: LoopInfo.h:530
llvm::MultiClass::Rec
Record Rec
Definition: TGParser.h:121
llvm::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1168
llvm::LetRecord::Loc
SMLoc Loc
Definition: TGParser.h:33
llvm::TGParser::PushLocalScope
TGLocalVarScope * PushLocalScope()
Definition: TGParser.h:183
llvm::TGLocalVarScope::varAlreadyDefined
bool varAlreadyDefined(StringRef Name) const
Definition: TGParser.h:105
TGLexer.h
ReferenceKind::LValue
@ LValue
llvm::VarInit
'Opcode' - Represent a reference to an entire variable object.
Definition: Record.h:1072
llvm::RecTy
Definition: Record.h:56
llvm::MultiClass::MultiClass
MultiClass(StringRef Name, SMLoc Loc, RecordKeeper &Records)
Definition: TGParser.h:126
llvm::DefsetRecord::Elements
SmallVector< Init *, 16 > Elements
Definition: TGParser.h:77
llvm::TGLexer::getDependencies
const DependenciesSetTy & getDependencies() const
Definition: TGLexer.h:110
llvm::TGLocalVarScope::extractParent
std::unique_ptr< TGLocalVarScope > extractParent()
Definition: TGParser.h:90
llvm::RecordsEntry::dump
void dump() const
Definition: TGParser.cpp:3767
llvm::MultiClass::dump
void dump() const
Definition: TGParser.cpp:3784
llvm::SMLoc
Represents a location in source code.
Definition: SMLoc.h:23
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::TGLexer
TGLexer - TableGen Lexer class.
Definition: TGLexer.h:80
llvm::RecordsEntry
RecordsEntry - Holds exactly one of a Record, ForeachLoop, or AssertionInfo.
Definition: TGParser.h:41
llvm::RecordsEntry::RecordsEntry
RecordsEntry()
Definition: TGParser.h:48
llvm::TGParser::Error
bool Error(SMLoc L, const Twine &Msg) const
Definition: TGParser.h:172
B
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
llvm::lltok::Kind
Kind
Definition: LLToken.h:18
llvm::ForeachLoop
ForeachLoop - Record the iteration state associated with a for loop.
Definition: TGParser.h:62
llvm::ForeachLoop::Loc
SMLoc Loc
Definition: TGParser.h:63
llvm::SubMultiClassReference
Definition: TGParser.cpp:48
Error.h
llvm::RecordsEntry::RecordsEntry
RecordsEntry(std::unique_ptr< Record::AssertionInfo > Assertion)
Definition: TGParser.h:52
llvm::TGParser
Definition: TGParser.h:130
llvm::ForeachLoop::ListValue
Init * ListValue
Definition: TGParser.h:65
move
compiles ldr LCPI1_0 ldr ldr mov lsr tst moveq r1 ldr LCPI1_1 and r0 bx lr It would be better to do something like to fold the shift into the conditional move
Definition: README.txt:546
I
#define I(x, y, z)
Definition: MD5.cpp:59
llvm::SubClassReference
Definition: TGParser.cpp:38
llvm::MultiClass
Definition: TGParser.h:120
llvm::TGLocalVarScope::TGLocalVarScope
TGLocalVarScope()=default
llvm::TGLocalVarScope::TGLocalVarScope
TGLocalVarScope(std::unique_ptr< TGLocalVarScope > parent)
Definition: TGParser.h:87
llvm::RecordsEntry::Loop
std::unique_ptr< ForeachLoop > Loop
Definition: TGParser.h:43
llvm::LetRecord::Name
StringInit * Name
Definition: TGParser.h:30
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::move
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1609
llvm::TGLocalVarScope::getVar
Init * getVar(StringRef Name) const
Definition: TGParser.h:96
llvm::TGLocalVarScope
Definition: TGParser.h:80
Mode
SI Whole Quad Mode
Definition: SIWholeQuadMode.cpp:262
llvm::Record
Definition: Record.h:1472
llvm::RecordsEntry::Rec
std::unique_ptr< Record > Rec
Definition: TGParser.h:42
llvm::StringInit
"foo" - Represent an initialization by a string value.
Definition: Record.h:611
llvm::ForeachLoop::Entries
std::vector< RecordsEntry > Entries
Definition: TGParser.h:66
llvm::Sched::Source
@ Source
Definition: TargetLowering.h:100
llvm::ArrayRef< unsigned >
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
llvm::SourceMgr
This owns the files read by a parser, handles include stacks, and handles diagnostic wrangling.
Definition: SourceMgr.h:31
llvm::LetRecord
Definition: TGParser.h:29
llvm::Init
Definition: Record.h:271
llvm::LetRecord::LetRecord
LetRecord(StringInit *N, ArrayRef< unsigned > B, Init *V, SMLoc L)
Definition: TGParser.h:34
llvm::RecordsEntry::Assertion
std::unique_ptr< Record::AssertionInfo > Assertion
Definition: TGParser.h:44
llvm::Twine
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:83
llvm::TGLocalVarScope::addVar
void addVar(StringRef Name, Init *I)
Definition: TGParser.h:113
llvm::GraphProgram::Name
Name
Definition: GraphWriter.h:52
std
Definition: BitVector.h:838
llvm::ForeachLoop::ForeachLoop
ForeachLoop(SMLoc Loc, VarInit *IVar, Init *LValue)
Definition: TGParser.h:70
llvm::TGParser::getDependencies
const TGLexer::DependenciesSetTy & getDependencies() const
Definition: TGParser.h:179
llvm::ForeachLoop::IterVar
VarInit * IterVar
Definition: TGParser.h:64
llvm::LetRecord::Value
Init * Value
Definition: TGParser.h:32
llvm::MultiClass::Entries
std::vector< RecordsEntry > Entries
Definition: TGParser.h:122
llvm::DefsetRecord::Loc
SMLoc Loc
Definition: TGParser.h:75
llvm::PrintError
void PrintError(const Twine &Msg)
Definition: Error.cpp:101
llvm::DefsetRecord
Definition: TGParser.h:74
N
#define N
llvm::tgtok::MultiClass
@ MultiClass
Definition: TGLexer.h:51
llvm::tgtok::TokKind
TokKind
Definition: TGLexer.h:32
llvm::LetRecord::Bits
std::vector< unsigned > Bits
Definition: TGParser.h:31
llvm::MipsISD::Ins
@ Ins
Definition: MipsISelLowering.h:157
llvm::SmallVectorImpl
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:43
llvm::TGLexer::DependenciesSetTy
std::set< std::string > DependenciesSetTy
Definition: TGLexer.h:97
llvm::TGLexer::getLoc
SMLoc getLoc() const
Definition: TGLexer.cpp:64
llvm::RecordVal
This class represents a field in a record, including its name, type, value, and source location.
Definition: Record.h:1402
Record.h
llvm::Value
LLVM Value Representation.
Definition: Value.h:75
llvm::TGParser::PopLocalScope
void PopLocalScope(TGLocalVarScope *ExpectedStackTop)
Definition: TGParser.h:190
llvm::DefsetRecord::EltTy
RecTy * EltTy
Definition: TGParser.h:76
llvm::TGParser::ParseFile
bool ParseFile()
ParseFile - Main entrypoint for parsing a tblgen file.
Definition: TGParser.cpp:3720
llvm::TGParser::TGParser
TGParser(SourceMgr &SM, ArrayRef< std::string > Macros, RecordKeeper &records)
Definition: TGParser.h:164
llvm::TypedInit
This is the common superclass of types that have a specific, explicit type, stored in ValueTy.
Definition: Record.h:407