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;
50 /// Loc - This is the location of the upref.
53 /// NestingLevel - The number of nesting levels that need to be popped
54 /// before this type is resolved.
55 unsigned NestingLevel;
57 /// LastContainedTy - This is the type at the current binding level for
58 /// the type. Every time we reduce the nesting level, this gets updated.
59 const Type *LastContainedTy;
61 /// UpRefTy - This is the actual opaque type that the upreference is
65 UpRefRecord(LocTy L, unsigned NL, OpaqueType *URTy)
66 : Loc(L), NestingLevel(NL), LastContainedTy((Type*)URTy),
69 std::vector<UpRefRecord> UpRefs;
71 // Global Value reference information.
72 std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
73 std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
74 std::vector<GlobalValue*> NumberedVals;
76 LLParser(MemoryBuffer *F, ParseError &Err, Module *m) :
77 Context(m->getContext()), Lex(F, Err), M(m) {}
82 bool Error(LocTy L, const std::string &Msg) const {
83 return Lex.Error(L, Msg);
85 bool TokError(const std::string &Msg) const {
86 return Error(Lex.getLoc(), Msg);
89 /// GetGlobalVal - Get a value with the specified name or ID, creating a
90 /// forward reference record if needed. This can return null if the value
91 /// exists but does not have the right type.
92 GlobalValue *GetGlobalVal(const std::string &N, const Type *Ty, LocTy Loc);
93 GlobalValue *GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc);
96 bool ParseToken(lltok::Kind T, const char *ErrMsg);
97 bool EatIfPresent(lltok::Kind T) {
98 if (Lex.getKind() != T) return false;
102 bool ParseOptionalToken(lltok::Kind T, bool &Present) {
103 if (Lex.getKind() != T) {
111 bool ParseStringConstant(std::string &Result);
112 bool ParseUInt32(unsigned &Val);
113 bool ParseUInt32(unsigned &Val, LocTy &Loc) {
115 return ParseUInt32(Val);
117 bool ParseOptionalAddrSpace(unsigned &AddrSpace);
118 bool ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind);
119 bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
120 bool ParseOptionalLinkage(unsigned &Linkage) {
121 bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
123 bool ParseOptionalVisibility(unsigned &Visibility);
124 bool ParseOptionalCallingConv(unsigned &CC);
125 bool ParseOptionalAlignment(unsigned &Alignment);
126 bool ParseOptionalCommaAlignment(unsigned &Alignment);
127 bool ParseIndexList(SmallVectorImpl<unsigned> &Indices);
129 // Top-Level Entities
130 bool ParseTopLevelEntities();
131 bool ValidateEndOfModule();
132 bool ParseTargetDefinition();
134 bool ParseModuleAsm();
135 bool ParseUnnamedType();
136 bool ParseNamedType();
140 bool ParseGlobalType(bool &IsConstant);
141 bool ParseNamedGlobal();
142 bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
143 bool HasLinkage, unsigned Visibility);
144 bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
145 bool ParseStandaloneMetadata();
148 bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
149 bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
151 return ParseType(Result, AllowVoid);
153 bool ParseTypeRec(PATypeHolder &H);
154 bool ParseStructType(PATypeHolder &H, bool Packed);
155 bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
156 bool ParseFunctionType(PATypeHolder &Result);
157 PATypeHolder HandleUpRefs(const Type *Ty);
160 bool ParseValID(ValID &ID);
161 bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
162 bool ParseGlobalValue(const Type *Ty, Constant *&V);
163 bool ParseGlobalTypeAndValue(Constant *&V);
164 bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
165 bool ParseMDNodeVector(SmallVectorImpl<Value*> &);
168 // Function Semantic Analysis.
169 class PerFunctionState {
172 std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
173 std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
174 std::vector<Value*> NumberedVals;
176 PerFunctionState(LLParser &p, Function &f);
179 Function &getFunction() const { return F; }
181 bool VerifyFunctionComplete();
183 /// GetVal - Get a value with the specified name or ID, creating a
184 /// forward reference record if needed. This can return null if the value
185 /// exists but does not have the right type.
186 Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
187 Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
189 /// SetInstName - After an instruction is parsed and inserted into its
190 /// basic block, this installs its name.
191 bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
194 /// GetBB - Get a basic block with the specified name or ID, creating a
195 /// forward reference record if needed. This can return null if the value
196 /// is not a BasicBlock.
197 BasicBlock *GetBB(const std::string &Name, LocTy Loc);
198 BasicBlock *GetBB(unsigned ID, LocTy Loc);
200 /// DefineBB - Define the specified basic block, which is either named or
201 /// unnamed. If there is an error, this returns null otherwise it returns
202 /// the block being defined.
203 BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
206 bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
207 PerFunctionState &PFS);
209 bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
210 bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
211 PerFunctionState &PFS) {
213 return ParseValue(Ty, V, PFS);
216 bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
217 bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
219 return ParseTypeAndValue(V, PFS);
226 ParamInfo(LocTy loc, Value *v, unsigned attrs)
227 : Loc(loc), V(v), Attrs(attrs) {}
229 bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
230 PerFunctionState &PFS);
238 ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
239 : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
241 bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
242 bool &isVarArg, bool inType);
243 bool ParseFunctionHeader(Function *&Fn, bool isDefine);
244 bool ParseFunctionBody(Function &Fn);
245 bool ParseBasicBlock(PerFunctionState &PFS);
247 // Instruction Parsing.
248 bool ParseInstruction(Instruction *&Inst, BasicBlock *BB,
249 PerFunctionState &PFS);
250 bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
252 bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
253 bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
254 bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
255 bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
257 bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
258 unsigned OperandType);
259 bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
260 bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
261 bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
262 bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
263 bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
264 bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
265 bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
266 bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
267 bool ParsePHI(Instruction *&I, PerFunctionState &PFS);
268 bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
269 bool ParseAlloc(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
270 bool ParseFree(Instruction *&I, PerFunctionState &PFS);
271 bool ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
272 bool ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
273 bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
274 bool ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
275 bool ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
276 bool ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
278 } // End llvm namespace