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"
38 typedef LLLexer::LocTy LocTy;
44 // Type resolution handling data structures.
45 std::map<std::string, std::pair<PATypeHolder, LocTy> > ForwardRefTypes;
46 std::map<unsigned, std::pair<PATypeHolder, LocTy> > ForwardRefTypeIDs;
47 std::vector<PATypeHolder> NumberedTypes;
48 /// MetadataCache - This map keeps track of parsed metadata constants.
49 std::map<unsigned, MetadataBase *> MetadataCache;
50 std::map<unsigned, std::pair<MetadataBase *, LocTy> > ForwardRefMDNodes;
51 SmallVector<std::pair<unsigned, MDNode *>, 2> MDsOnInst;
53 /// Loc - This is the location of the upref.
56 /// NestingLevel - The number of nesting levels that need to be popped
57 /// before this type is resolved.
58 unsigned NestingLevel;
60 /// LastContainedTy - This is the type at the current binding level for
61 /// the type. Every time we reduce the nesting level, this gets updated.
62 const Type *LastContainedTy;
64 /// UpRefTy - This is the actual opaque type that the upreference is
68 UpRefRecord(LocTy L, unsigned NL, OpaqueType *URTy)
69 : Loc(L), NestingLevel(NL), LastContainedTy((Type*)URTy),
72 std::vector<UpRefRecord> UpRefs;
74 // Global Value reference information.
75 std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
76 std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
77 std::vector<GlobalValue*> NumberedVals;
79 LLParser(MemoryBuffer *F, SourceMgr &SM, SMDiagnostic &Err, Module *m) :
80 Context(m->getContext()), Lex(F, SM, Err, m->getContext()), M(m) {}
83 LLVMContext& getContext() { return Context; }
87 bool Error(LocTy L, const std::string &Msg) const {
88 return Lex.Error(L, Msg);
90 bool TokError(const std::string &Msg) const {
91 return Error(Lex.getLoc(), Msg);
94 /// GetGlobalVal - Get a value with the specified name or ID, creating a
95 /// forward reference record if needed. This can return null if the value
96 /// exists but does not have the right type.
97 GlobalValue *GetGlobalVal(const std::string &N, const Type *Ty, LocTy Loc);
98 GlobalValue *GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc);
101 bool ParseToken(lltok::Kind T, const char *ErrMsg);
102 bool EatIfPresent(lltok::Kind T) {
103 if (Lex.getKind() != T) return false;
107 bool ParseOptionalToken(lltok::Kind T, bool &Present) {
108 if (Lex.getKind() != T) {
116 bool ParseStringConstant(std::string &Result);
117 bool ParseUInt32(unsigned &Val);
118 bool ParseUInt32(unsigned &Val, LocTy &Loc) {
120 return ParseUInt32(Val);
122 bool ParseOptionalAddrSpace(unsigned &AddrSpace);
123 bool ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind);
124 bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
125 bool ParseOptionalLinkage(unsigned &Linkage) {
126 bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
128 bool ParseOptionalVisibility(unsigned &Visibility);
129 bool ParseOptionalCallingConv(CallingConv::ID &CC);
130 bool ParseOptionalAlignment(unsigned &Alignment);
131 bool ParseOptionalCustomMetadata();
132 bool ParseOptionalInfo(unsigned &Alignment);
133 bool ParseIndexList(SmallVectorImpl<unsigned> &Indices);
135 // Top-Level Entities
136 bool ParseTopLevelEntities();
137 bool ValidateEndOfModule();
138 bool ParseTargetDefinition();
140 bool ParseModuleAsm();
141 bool ParseUnnamedType();
142 bool ParseNamedType();
146 bool ParseGlobalType(bool &IsConstant);
147 bool ParseUnnamedGlobal();
148 bool ParseNamedGlobal();
149 bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
150 bool HasLinkage, unsigned Visibility);
151 bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
152 bool ParseStandaloneMetadata();
153 bool ParseNamedMetadata();
154 bool ParseMDString(MetadataBase *&S);
155 bool ParseMDNode(MetadataBase *&N);
158 bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
159 bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
161 return ParseType(Result, AllowVoid);
163 bool ParseTypeRec(PATypeHolder &H);
164 bool ParseStructType(PATypeHolder &H, bool Packed);
165 bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
166 bool ParseFunctionType(PATypeHolder &Result);
167 PATypeHolder HandleUpRefs(const Type *Ty);
170 bool ParseValID(ValID &ID);
171 bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
172 bool ParseGlobalValue(const Type *Ty, Constant *&V);
173 bool ParseGlobalTypeAndValue(Constant *&V);
174 bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
175 bool ParseMDNodeVector(SmallVectorImpl<Value*> &);
178 // Function Semantic Analysis.
179 class PerFunctionState {
182 std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
183 std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
184 std::vector<Value*> NumberedVals;
186 PerFunctionState(LLParser &p, Function &f);
189 Function &getFunction() const { return F; }
191 bool VerifyFunctionComplete();
193 /// GetVal - Get a value with the specified name or ID, creating a
194 /// forward reference record if needed. This can return null if the value
195 /// exists but does not have the right type.
196 Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
197 Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
199 /// SetInstName - After an instruction is parsed and inserted into its
200 /// basic block, this installs its name.
201 bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
204 /// GetBB - Get a basic block with the specified name or ID, creating a
205 /// forward reference record if needed. This can return null if the value
206 /// is not a BasicBlock.
207 BasicBlock *GetBB(const std::string &Name, LocTy Loc);
208 BasicBlock *GetBB(unsigned ID, LocTy Loc);
210 /// DefineBB - Define the specified basic block, which is either named or
211 /// unnamed. If there is an error, this returns null otherwise it returns
212 /// the block being defined.
213 BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
216 bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
217 PerFunctionState &PFS);
219 bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
220 bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
221 PerFunctionState &PFS) {
223 return ParseValue(Ty, V, PFS);
226 bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
227 bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
229 return ParseTypeAndValue(V, PFS);
236 ParamInfo(LocTy loc, Value *v, unsigned attrs)
237 : Loc(loc), V(v), Attrs(attrs) {}
239 bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
240 PerFunctionState &PFS);
248 ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
249 : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
251 bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
252 bool &isVarArg, bool inType);
253 bool ParseFunctionHeader(Function *&Fn, bool isDefine);
254 bool ParseFunctionBody(Function &Fn);
255 bool ParseBasicBlock(PerFunctionState &PFS);
257 // Instruction Parsing.
258 bool ParseInstruction(Instruction *&Inst, BasicBlock *BB,
259 PerFunctionState &PFS);
260 bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
262 bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
263 bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
264 bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
265 bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
267 bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
268 unsigned OperandType);
269 bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
270 bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
271 bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
272 bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
273 bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
274 bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
275 bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
276 bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
277 bool ParsePHI(Instruction *&I, PerFunctionState &PFS);
278 bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
279 bool ParseAlloc(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
280 bool ParseFree(Instruction *&I, PerFunctionState &PFS);
281 bool ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
282 bool ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
283 bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
284 bool ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
285 bool ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
286 bool ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
288 } // End llvm namespace