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) {}
80 LLVMContext& getContext() { return Context; }
84 bool Error(LocTy L, const std::string &Msg) const {
85 return Lex.Error(L, Msg);
87 bool TokError(const std::string &Msg) const {
88 return Error(Lex.getLoc(), Msg);
91 /// GetGlobalVal - Get a value with the specified name or ID, creating a
92 /// forward reference record if needed. This can return null if the value
93 /// exists but does not have the right type.
94 GlobalValue *GetGlobalVal(const std::string &N, const Type *Ty, LocTy Loc);
95 GlobalValue *GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc);
98 bool ParseToken(lltok::Kind T, const char *ErrMsg);
99 bool EatIfPresent(lltok::Kind T) {
100 if (Lex.getKind() != T) return false;
104 bool ParseOptionalToken(lltok::Kind T, bool &Present) {
105 if (Lex.getKind() != T) {
113 bool ParseStringConstant(std::string &Result);
114 bool ParseUInt32(unsigned &Val);
115 bool ParseUInt32(unsigned &Val, LocTy &Loc) {
117 return ParseUInt32(Val);
119 bool ParseOptionalAddrSpace(unsigned &AddrSpace);
120 bool ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind);
121 bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
122 bool ParseOptionalLinkage(unsigned &Linkage) {
123 bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
125 bool ParseOptionalVisibility(unsigned &Visibility);
126 bool ParseOptionalCallingConv(unsigned &CC);
127 bool ParseOptionalAlignment(unsigned &Alignment);
128 bool ParseOptionalCommaAlignment(unsigned &Alignment);
129 bool ParseIndexList(SmallVectorImpl<unsigned> &Indices);
131 // Top-Level Entities
132 bool ParseTopLevelEntities();
133 bool ValidateEndOfModule();
134 bool ParseTargetDefinition();
136 bool ParseModuleAsm();
137 bool ParseUnnamedType();
138 bool ParseNamedType();
142 bool ParseGlobalType(bool &IsConstant);
143 bool ParseNamedGlobal();
144 bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
145 bool HasLinkage, unsigned Visibility);
146 bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
147 bool ParseStandaloneMetadata();
150 bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
151 bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
153 return ParseType(Result, AllowVoid);
155 bool ParseTypeRec(PATypeHolder &H);
156 bool ParseStructType(PATypeHolder &H, bool Packed);
157 bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
158 bool ParseFunctionType(PATypeHolder &Result);
159 PATypeHolder HandleUpRefs(const Type *Ty);
162 bool ParseValID(ValID &ID);
163 bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
164 bool ParseGlobalValue(const Type *Ty, Constant *&V);
165 bool ParseGlobalTypeAndValue(Constant *&V);
166 bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
167 bool ParseMDNodeVector(SmallVectorImpl<Value*> &);
170 // Function Semantic Analysis.
171 class PerFunctionState {
174 std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
175 std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
176 std::vector<Value*> NumberedVals;
178 PerFunctionState(LLParser &p, Function &f);
181 Function &getFunction() const { return F; }
183 bool VerifyFunctionComplete();
185 /// GetVal - Get a value with the specified name or ID, creating a
186 /// forward reference record if needed. This can return null if the value
187 /// exists but does not have the right type.
188 Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
189 Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
191 /// SetInstName - After an instruction is parsed and inserted into its
192 /// basic block, this installs its name.
193 bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
196 /// GetBB - Get a basic block with the specified name or ID, creating a
197 /// forward reference record if needed. This can return null if the value
198 /// is not a BasicBlock.
199 BasicBlock *GetBB(const std::string &Name, LocTy Loc);
200 BasicBlock *GetBB(unsigned ID, LocTy Loc);
202 /// DefineBB - Define the specified basic block, which is either named or
203 /// unnamed. If there is an error, this returns null otherwise it returns
204 /// the block being defined.
205 BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
208 bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
209 PerFunctionState &PFS);
211 bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
212 bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
213 PerFunctionState &PFS) {
215 return ParseValue(Ty, V, PFS);
218 bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
219 bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
221 return ParseTypeAndValue(V, PFS);
228 ParamInfo(LocTy loc, Value *v, unsigned attrs)
229 : Loc(loc), V(v), Attrs(attrs) {}
231 bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
232 PerFunctionState &PFS);
240 ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
241 : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
243 bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
244 bool &isVarArg, bool inType);
245 bool ParseFunctionHeader(Function *&Fn, bool isDefine);
246 bool ParseFunctionBody(Function &Fn);
247 bool ParseBasicBlock(PerFunctionState &PFS);
249 // Instruction Parsing.
250 bool ParseInstruction(Instruction *&Inst, BasicBlock *BB,
251 PerFunctionState &PFS);
252 bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
254 bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
255 bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
256 bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
257 bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
259 bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
260 unsigned OperandType);
261 bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
262 bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
263 bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
264 bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
265 bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
266 bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
267 bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
268 bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
269 bool ParsePHI(Instruction *&I, PerFunctionState &PFS);
270 bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
271 bool ParseAlloc(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
272 bool ParseFree(Instruction *&I, PerFunctionState &PFS);
273 bool ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
274 bool ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
275 bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
276 bool ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
277 bool ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
278 bool ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
280 } // End llvm namespace