1 //===-- LLParser.h - Parser Class -------------------------------*- C++ -*-===//
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 // This file defines the parser class for .ll files.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ASMPARSER_LLPARSER_H
15 #define LLVM_ASMPARSER_LLPARSER_H
18 #include "llvm/Module.h"
19 #include "llvm/Type.h"
20 #include "llvm/Support/ValueHandle.h"
36 /// ValID - Represents a reference of a definition of some sort with no type.
37 /// There are several cases where we have to parse the value but where the
38 /// type can depend on later context. This may either be a numeric reference
39 /// or a symbolic (%var) reference. This is just a discriminated union.
42 t_LocalID, t_GlobalID, // ID in UIntVal.
43 t_LocalName, t_GlobalName, // Name in StrVal.
44 t_APSInt, t_APFloat, // Value in APSIntVal/APFloatVal.
45 t_Null, t_Undef, t_Zero, // No value.
46 t_EmptyArray, // No value: []
47 t_Constant, // Value in ConstantVal.
48 t_InlineAsm, // Value in StrVal/StrVal2/UIntVal.
49 t_Metadata // Value in MetadataVal.
54 std::string StrVal, StrVal2;
57 Constant *ConstantVal;
58 MetadataBase *MetadataVal;
59 ValID() : APFloatVal(0.0) {}
61 bool operator<(const ValID &RHS) const {
62 if (Kind == t_LocalID || Kind == t_GlobalID)
63 return UIntVal < RHS.UIntVal;
64 assert((Kind == t_LocalName || Kind == t_GlobalName) &&
65 "Ordering not defined for this ValID kind yet");
66 return StrVal < RHS.StrVal;
72 typedef LLLexer::LocTy LocTy;
78 // Type resolution handling data structures.
79 std::map<std::string, std::pair<PATypeHolder, LocTy> > ForwardRefTypes;
80 std::map<unsigned, std::pair<PATypeHolder, LocTy> > ForwardRefTypeIDs;
81 std::vector<PATypeHolder> NumberedTypes;
82 /// MetadataCache - This map keeps track of parsed metadata constants.
83 std::map<unsigned, TrackingVH<MDNode> > MetadataCache;
84 std::map<unsigned, std::pair<TrackingVH<MDNode>, LocTy> > ForwardRefMDNodes;
85 SmallVector<std::pair<unsigned, MDNode *>, 2> MDsOnInst;
87 /// Loc - This is the location of the upref.
90 /// NestingLevel - The number of nesting levels that need to be popped
91 /// before this type is resolved.
92 unsigned NestingLevel;
94 /// LastContainedTy - This is the type at the current binding level for
95 /// the type. Every time we reduce the nesting level, this gets updated.
96 const Type *LastContainedTy;
98 /// UpRefTy - This is the actual opaque type that the upreference is
102 UpRefRecord(LocTy L, unsigned NL, OpaqueType *URTy)
103 : Loc(L), NestingLevel(NL), LastContainedTy((Type*)URTy),
106 std::vector<UpRefRecord> UpRefs;
108 // Global Value reference information.
109 std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
110 std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
111 std::vector<GlobalValue*> NumberedVals;
113 // References to blockaddress. The key is the function ValID, the value is
114 // a list of references to blocks in that function.
115 std::map<ValID, std::vector<std::pair<ValID, GlobalValue*> > >
116 ForwardRefBlockAddresses;
120 LLParser(MemoryBuffer *F, SourceMgr &SM, SMDiagnostic &Err, Module *m) :
121 Context(m->getContext()), Lex(F, SM, Err, m->getContext()),
122 M(m), MallocF(NULL) {}
125 LLVMContext& getContext() { return Context; }
129 bool Error(LocTy L, const std::string &Msg) const {
130 return Lex.Error(L, Msg);
132 bool TokError(const std::string &Msg) const {
133 return Error(Lex.getLoc(), Msg);
136 /// GetGlobalVal - Get a value with the specified name or ID, creating a
137 /// forward reference record if needed. This can return null if the value
138 /// exists but does not have the right type.
139 GlobalValue *GetGlobalVal(const std::string &N, const Type *Ty, LocTy Loc);
140 GlobalValue *GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc);
143 bool ParseToken(lltok::Kind T, const char *ErrMsg);
144 bool EatIfPresent(lltok::Kind T) {
145 if (Lex.getKind() != T) return false;
149 bool ParseOptionalToken(lltok::Kind T, bool &Present) {
150 if (Lex.getKind() != T) {
158 bool ParseStringConstant(std::string &Result);
159 bool ParseUInt32(unsigned &Val);
160 bool ParseUInt32(unsigned &Val, LocTy &Loc) {
162 return ParseUInt32(Val);
164 bool ParseOptionalAddrSpace(unsigned &AddrSpace);
165 bool ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind);
166 bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
167 bool ParseOptionalLinkage(unsigned &Linkage) {
168 bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
170 bool ParseOptionalVisibility(unsigned &Visibility);
171 bool ParseOptionalCallingConv(CallingConv::ID &CC);
172 bool ParseOptionalAlignment(unsigned &Alignment);
173 bool ParseOptionalCustomMetadata();
174 bool ParseOptionalInfo(unsigned &Alignment);
175 bool ParseIndexList(SmallVectorImpl<unsigned> &Indices);
177 // Top-Level Entities
178 bool ParseTopLevelEntities();
179 bool ValidateEndOfModule();
180 bool ParseTargetDefinition();
182 bool ParseModuleAsm();
183 bool ParseUnnamedType();
184 bool ParseNamedType();
188 bool ParseGlobalType(bool &IsConstant);
189 bool ParseUnnamedGlobal();
190 bool ParseNamedGlobal();
191 bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
192 bool HasLinkage, unsigned Visibility);
193 bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
194 bool ParseStandaloneMetadata();
195 bool ParseNamedMetadata();
196 bool ParseMDString(MetadataBase *&S);
197 bool ParseMDNode(MetadataBase *&N);
200 bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
201 bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
203 return ParseType(Result, AllowVoid);
205 bool ParseTypeRec(PATypeHolder &H);
206 bool ParseStructType(PATypeHolder &H, bool Packed);
207 bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
208 bool ParseFunctionType(PATypeHolder &Result);
209 PATypeHolder HandleUpRefs(const Type *Ty);
212 bool ParseValID(ValID &ID);
213 bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
214 bool ParseGlobalValue(const Type *Ty, Constant *&V);
215 bool ParseGlobalTypeAndValue(Constant *&V);
216 bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
217 bool ParseMDNodeVector(SmallVectorImpl<Value*> &);
220 // Function Semantic Analysis.
221 class PerFunctionState {
224 std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
225 std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
226 std::vector<Value*> NumberedVals;
228 /// FunctionNumber - If this is an unnamed function, this is the slot
229 /// number of it, otherwise it is -1.
232 PerFunctionState(LLParser &p, Function &f, int FunctionNumber);
235 Function &getFunction() const { return F; }
237 bool FinishFunction();
239 /// GetVal - Get a value with the specified name or ID, creating a
240 /// forward reference record if needed. This can return null if the value
241 /// exists but does not have the right type.
242 Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
243 Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
245 /// SetInstName - After an instruction is parsed and inserted into its
246 /// basic block, this installs its name.
247 bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
250 /// GetBB - Get a basic block with the specified name or ID, creating a
251 /// forward reference record if needed. This can return null if the value
252 /// is not a BasicBlock.
253 BasicBlock *GetBB(const std::string &Name, LocTy Loc);
254 BasicBlock *GetBB(unsigned ID, LocTy Loc);
256 /// DefineBB - Define the specified basic block, which is either named or
257 /// unnamed. If there is an error, this returns null otherwise it returns
258 /// the block being defined.
259 BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
262 bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
263 PerFunctionState &PFS);
265 bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
266 bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
267 PerFunctionState &PFS) {
269 return ParseValue(Ty, V, PFS);
272 bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
273 bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
275 return ParseTypeAndValue(V, PFS);
277 bool ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
278 PerFunctionState &PFS);
279 bool ParseTypeAndBasicBlock(BasicBlock *&BB, PerFunctionState &PFS) {
281 return ParseTypeAndBasicBlock(BB, Loc, PFS);
284 bool ParseInlineMetadata(Value *&V, PerFunctionState &PFS);
290 ParamInfo(LocTy loc, Value *v, unsigned attrs)
291 : Loc(loc), V(v), Attrs(attrs) {}
293 bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
294 PerFunctionState &PFS);
302 ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
303 : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
305 bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
306 bool &isVarArg, bool inType);
307 bool ParseFunctionHeader(Function *&Fn, bool isDefine);
308 bool ParseFunctionBody(Function &Fn);
309 bool ParseBasicBlock(PerFunctionState &PFS);
311 // Instruction Parsing.
312 bool ParseInstruction(Instruction *&Inst, BasicBlock *BB,
313 PerFunctionState &PFS);
314 bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
316 bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
317 bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
318 bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
319 bool ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS);
320 bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
322 bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
323 unsigned OperandType);
324 bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
325 bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
326 bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
327 bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
328 bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
329 bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
330 bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
331 bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
332 bool ParsePHI(Instruction *&I, PerFunctionState &PFS);
333 bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
334 bool ParseAlloc(Instruction *&I, PerFunctionState &PFS,
335 BasicBlock *BB = 0, bool isAlloca = true);
336 bool ParseFree(Instruction *&I, PerFunctionState &PFS, BasicBlock *BB);
337 bool ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
338 bool ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
339 bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
340 bool ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
341 bool ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
342 bool ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
344 bool ResolveForwardRefBlockAddresses(Function *TheFn,
345 std::vector<std::pair<ValID, GlobalValue*> > &Refs,
346 PerFunctionState *PFS);
348 } // End llvm namespace