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"
37 typedef LLLexer::LocTy LocTy;
43 // Type resolution handling data structures.
44 std::map<std::string, std::pair<PATypeHolder, LocTy> > ForwardRefTypes;
45 std::map<unsigned, std::pair<PATypeHolder, LocTy> > ForwardRefTypeIDs;
46 std::vector<PATypeHolder> NumberedTypes;
47 /// MetadataCache - This map keeps track of parsed metadata constants.
48 std::map<unsigned, Constant *> MetadataCache;
49 std::map<unsigned, std::pair<Constant *, LocTy> > ForwardRefMDNodes;
52 /// Loc - This is the location of the upref.
55 /// NestingLevel - The number of nesting levels that need to be popped
56 /// before this type is resolved.
57 unsigned NestingLevel;
59 /// LastContainedTy - This is the type at the current binding level for
60 /// the type. Every time we reduce the nesting level, this gets updated.
61 const Type *LastContainedTy;
63 /// UpRefTy - This is the actual opaque type that the upreference is
67 UpRefRecord(LocTy L, unsigned NL, OpaqueType *URTy)
68 : Loc(L), NestingLevel(NL), LastContainedTy((Type*)URTy),
71 std::vector<UpRefRecord> UpRefs;
73 // Global Value reference information.
74 std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
75 std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
76 std::vector<GlobalValue*> NumberedVals;
78 LLParser(MemoryBuffer *F, SourceMgr &SM, SMDiagnostic &Err, Module *m) :
79 Context(m->getContext()), Lex(F, SM, Err, m->getContext()), M(m) {}
82 LLVMContext& getContext() { return Context; }
86 bool Error(LocTy L, const std::string &Msg) const {
87 return Lex.Error(L, Msg);
89 bool TokError(const std::string &Msg) const {
90 return Error(Lex.getLoc(), Msg);
93 /// GetGlobalVal - Get a value with the specified name or ID, creating a
94 /// forward reference record if needed. This can return null if the value
95 /// exists but does not have the right type.
96 GlobalValue *GetGlobalVal(const std::string &N, const Type *Ty, LocTy Loc);
97 GlobalValue *GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc);
100 bool ParseToken(lltok::Kind T, const char *ErrMsg);
101 bool EatIfPresent(lltok::Kind T) {
102 if (Lex.getKind() != T) return false;
106 bool ParseOptionalToken(lltok::Kind T, bool &Present) {
107 if (Lex.getKind() != T) {
115 bool ParseStringConstant(std::string &Result);
116 bool ParseUInt32(unsigned &Val);
117 bool ParseUInt32(unsigned &Val, LocTy &Loc) {
119 return ParseUInt32(Val);
121 bool ParseOptionalAddrSpace(unsigned &AddrSpace);
122 bool ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind);
123 bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
124 bool ParseOptionalLinkage(unsigned &Linkage) {
125 bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
127 bool ParseOptionalVisibility(unsigned &Visibility);
128 bool ParseOptionalCallingConv(unsigned &CC);
129 bool ParseOptionalAlignment(unsigned &Alignment);
130 bool ParseOptionalCommaAlignment(unsigned &Alignment);
131 bool ParseIndexList(SmallVectorImpl<unsigned> &Indices);
133 // Top-Level Entities
134 bool ParseTopLevelEntities();
135 bool ValidateEndOfModule();
136 bool ParseTargetDefinition();
138 bool ParseModuleAsm();
139 bool ParseUnnamedType();
140 bool ParseNamedType();
144 bool ParseGlobalType(bool &IsConstant);
145 bool ParseNamedGlobal();
146 bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
147 bool HasLinkage, unsigned Visibility);
148 bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
149 bool ParseStandaloneMetadata();
150 bool ParseMDString(Constant *&S);
151 bool ParseMDNode(Constant *&N);
154 bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
155 bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
157 return ParseType(Result, AllowVoid);
159 bool ParseTypeRec(PATypeHolder &H);
160 bool ParseStructType(PATypeHolder &H, bool Packed);
161 bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
162 bool ParseFunctionType(PATypeHolder &Result);
163 PATypeHolder HandleUpRefs(const Type *Ty);
166 bool ParseValID(ValID &ID);
167 bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
168 bool ParseGlobalValue(const Type *Ty, Constant *&V);
169 bool ParseGlobalTypeAndValue(Constant *&V);
170 bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
171 bool ParseMDNodeVector(SmallVectorImpl<Value*> &);
174 // Function Semantic Analysis.
175 class PerFunctionState {
178 std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
179 std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
180 std::vector<Value*> NumberedVals;
182 PerFunctionState(LLParser &p, Function &f);
185 Function &getFunction() const { return F; }
187 bool VerifyFunctionComplete();
189 /// GetVal - Get a value with the specified name or ID, creating a
190 /// forward reference record if needed. This can return null if the value
191 /// exists but does not have the right type.
192 Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
193 Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
195 /// SetInstName - After an instruction is parsed and inserted into its
196 /// basic block, this installs its name.
197 bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
200 /// GetBB - Get a basic block with the specified name or ID, creating a
201 /// forward reference record if needed. This can return null if the value
202 /// is not a BasicBlock.
203 BasicBlock *GetBB(const std::string &Name, LocTy Loc);
204 BasicBlock *GetBB(unsigned ID, LocTy Loc);
206 /// DefineBB - Define the specified basic block, which is either named or
207 /// unnamed. If there is an error, this returns null otherwise it returns
208 /// the block being defined.
209 BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
212 bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
213 PerFunctionState &PFS);
215 bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
216 bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
217 PerFunctionState &PFS) {
219 return ParseValue(Ty, V, PFS);
222 bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
223 bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
225 return ParseTypeAndValue(V, PFS);
232 ParamInfo(LocTy loc, Value *v, unsigned attrs)
233 : Loc(loc), V(v), Attrs(attrs) {}
235 bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
236 PerFunctionState &PFS);
244 ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
245 : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
247 bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
248 bool &isVarArg, bool inType);
249 bool ParseFunctionHeader(Function *&Fn, bool isDefine);
250 bool ParseFunctionBody(Function &Fn);
251 bool ParseBasicBlock(PerFunctionState &PFS);
253 // Instruction Parsing.
254 bool ParseInstruction(Instruction *&Inst, BasicBlock *BB,
255 PerFunctionState &PFS);
256 bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
258 bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
259 bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
260 bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
261 bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
263 bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
264 unsigned OperandType);
265 bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
266 bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
267 bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
268 bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
269 bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
270 bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
271 bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
272 bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
273 bool ParsePHI(Instruction *&I, PerFunctionState &PFS);
274 bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
275 bool ParseAlloc(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
276 bool ParseFree(Instruction *&I, PerFunctionState &PFS);
277 bool ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
278 bool ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
279 bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
280 bool ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
281 bool ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
282 bool ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
284 } // End llvm namespace