New EH representation for MSVC compatibility
[oota-llvm.git] / lib / AsmParser / LLParser.h
1 //===-- LLParser.h - Parser Class -------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file defines the parser class for .ll files.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_ASMPARSER_LLPARSER_H
15 #define LLVM_LIB_ASMPARSER_LLPARSER_H
16
17 #include "LLLexer.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/IR/Attributes.h"
21 #include "llvm/IR/Instructions.h"
22 #include "llvm/IR/Module.h"
23 #include "llvm/IR/Operator.h"
24 #include "llvm/IR/Type.h"
25 #include "llvm/IR/ValueHandle.h"
26 #include <map>
27
28 namespace llvm {
29   class Module;
30   class OpaqueType;
31   class Function;
32   class Value;
33   class BasicBlock;
34   class Instruction;
35   class Constant;
36   class GlobalValue;
37   class Comdat;
38   class MDString;
39   class MDNode;
40   struct SlotMapping;
41   class StructType;
42
43   /// ValID - Represents a reference of a definition of some sort with no type.
44   /// There are several cases where we have to parse the value but where the
45   /// type can depend on later context.  This may either be a numeric reference
46   /// or a symbolic (%var) reference.  This is just a discriminated union.
47   struct ValID {
48     enum {
49       t_LocalID, t_GlobalID,      // ID in UIntVal.
50       t_LocalName, t_GlobalName,  // Name in StrVal.
51       t_APSInt, t_APFloat,        // Value in APSIntVal/APFloatVal.
52       t_Null, t_Undef, t_Zero,    // No value.
53       t_EmptyArray,               // No value:  []
54       t_Constant,                 // Value in ConstantVal.
55       t_InlineAsm,                // Value in FTy/StrVal/StrVal2/UIntVal.
56       t_ConstantStruct,           // Value in ConstantStructElts.
57       t_PackedConstantStruct      // Value in ConstantStructElts.
58     } Kind;
59
60     LLLexer::LocTy Loc;
61     unsigned UIntVal;
62     FunctionType *FTy;
63     std::string StrVal, StrVal2;
64     APSInt APSIntVal;
65     APFloat APFloatVal;
66     Constant *ConstantVal;
67     Constant **ConstantStructElts;
68
69     ValID() : Kind(t_LocalID), APFloatVal(0.0) {}
70     ~ValID() {
71       if (Kind == t_ConstantStruct || Kind == t_PackedConstantStruct)
72         delete [] ConstantStructElts;
73     }
74
75     bool operator<(const ValID &RHS) const {
76       if (Kind == t_LocalID || Kind == t_GlobalID)
77         return UIntVal < RHS.UIntVal;
78       assert((Kind == t_LocalName || Kind == t_GlobalName ||
79               Kind == t_ConstantStruct || Kind == t_PackedConstantStruct) &&
80              "Ordering not defined for this ValID kind yet");
81       return StrVal < RHS.StrVal;
82     }
83   };
84
85   class LLParser {
86   public:
87     typedef LLLexer::LocTy LocTy;
88   private:
89     LLVMContext &Context;
90     LLLexer Lex;
91     Module *M;
92     SlotMapping *Slots;
93
94     // Instruction metadata resolution.  Each instruction can have a list of
95     // MDRef info associated with them.
96     //
97     // The simpler approach of just creating temporary MDNodes and then calling
98     // RAUW on them when the definition is processed doesn't work because some
99     // instruction metadata kinds, such as dbg, get stored in the IR in an
100     // "optimized" format which doesn't participate in the normal value use
101     // lists. This means that RAUW doesn't work, even on temporary MDNodes
102     // which otherwise support RAUW. Instead, we defer resolving MDNode
103     // references until the definitions have been processed.
104     struct MDRef {
105       SMLoc Loc;
106       unsigned MDKind, MDSlot;
107     };
108
109     SmallVector<Instruction*, 64> InstsWithTBAATag;
110
111     // Type resolution handling data structures.  The location is set when we
112     // have processed a use of the type but not a definition yet.
113     StringMap<std::pair<Type*, LocTy> > NamedTypes;
114     std::map<unsigned, std::pair<Type*, LocTy> > NumberedTypes;
115
116     std::map<unsigned, TrackingMDNodeRef> NumberedMetadata;
117     std::map<unsigned, std::pair<TempMDTuple, LocTy>> ForwardRefMDNodes;
118
119     // Global Value reference information.
120     std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
121     std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
122     std::vector<GlobalValue*> NumberedVals;
123
124     // Comdat forward reference information.
125     std::map<std::string, LocTy> ForwardRefComdats;
126
127     // References to blockaddress.  The key is the function ValID, the value is
128     // a list of references to blocks in that function.
129     std::map<ValID, std::map<ValID, GlobalValue *>> ForwardRefBlockAddresses;
130     class PerFunctionState;
131     /// Reference to per-function state to allow basic blocks to be
132     /// forward-referenced by blockaddress instructions within the same
133     /// function.
134     PerFunctionState *BlockAddressPFS;
135
136     // Attribute builder reference information.
137     std::map<Value*, std::vector<unsigned> > ForwardRefAttrGroups;
138     std::map<unsigned, AttrBuilder> NumberedAttrBuilders;
139
140   public:
141     LLParser(StringRef F, SourceMgr &SM, SMDiagnostic &Err, Module *M,
142              SlotMapping *Slots = nullptr)
143         : Context(M->getContext()), Lex(F, SM, Err, M->getContext()), M(M),
144           Slots(Slots), BlockAddressPFS(nullptr) {}
145     bool Run();
146
147     bool parseStandaloneConstantValue(Constant *&C);
148
149     LLVMContext &getContext() { return Context; }
150
151   private:
152
153     bool Error(LocTy L, const Twine &Msg) const {
154       return Lex.Error(L, Msg);
155     }
156     bool TokError(const Twine &Msg) const {
157       return Error(Lex.getLoc(), Msg);
158     }
159
160     /// GetGlobalVal - Get a value with the specified name or ID, creating a
161     /// forward reference record if needed.  This can return null if the value
162     /// exists but does not have the right type.
163     GlobalValue *GetGlobalVal(const std::string &N, Type *Ty, LocTy Loc);
164     GlobalValue *GetGlobalVal(unsigned ID, Type *Ty, LocTy Loc);
165
166     /// Get a Comdat with the specified name, creating a forward reference
167     /// record if needed.
168     Comdat *getComdat(const std::string &N, LocTy Loc);
169
170     // Helper Routines.
171     bool ParseToken(lltok::Kind T, const char *ErrMsg);
172     bool EatIfPresent(lltok::Kind T) {
173       if (Lex.getKind() != T) return false;
174       Lex.Lex();
175       return true;
176     }
177
178     FastMathFlags EatFastMathFlagsIfPresent() {
179       FastMathFlags FMF;
180       while (true)
181         switch (Lex.getKind()) {
182         case lltok::kw_fast: FMF.setUnsafeAlgebra();   Lex.Lex(); continue;
183         case lltok::kw_nnan: FMF.setNoNaNs();          Lex.Lex(); continue;
184         case lltok::kw_ninf: FMF.setNoInfs();          Lex.Lex(); continue;
185         case lltok::kw_nsz:  FMF.setNoSignedZeros();   Lex.Lex(); continue;
186         case lltok::kw_arcp: FMF.setAllowReciprocal(); Lex.Lex(); continue;
187         default: return FMF;
188         }
189       return FMF;
190     }
191
192     bool ParseOptionalToken(lltok::Kind T, bool &Present,
193                             LocTy *Loc = nullptr) {
194       if (Lex.getKind() != T) {
195         Present = false;
196       } else {
197         if (Loc)
198           *Loc = Lex.getLoc();
199         Lex.Lex();
200         Present = true;
201       }
202       return false;
203     }
204     bool ParseStringConstant(std::string &Result);
205     bool ParseUInt32(unsigned &Val);
206     bool ParseUInt32(unsigned &Val, LocTy &Loc) {
207       Loc = Lex.getLoc();
208       return ParseUInt32(Val);
209     }
210     bool ParseUInt64(uint64_t &Val);
211     bool ParseUInt64(uint64_t &Val, LocTy &Loc) {
212       Loc = Lex.getLoc();
213       return ParseUInt64(Val);
214     }
215
216     bool ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM);
217     bool ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM);
218     bool parseOptionalUnnamedAddr(bool &UnnamedAddr) {
219       return ParseOptionalToken(lltok::kw_unnamed_addr, UnnamedAddr);
220     }
221     bool ParseOptionalAddrSpace(unsigned &AddrSpace);
222     bool ParseOptionalParamAttrs(AttrBuilder &B);
223     bool ParseOptionalReturnAttrs(AttrBuilder &B);
224     bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
225     bool ParseOptionalLinkage(unsigned &Linkage) {
226       bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
227     }
228     bool ParseOptionalVisibility(unsigned &Visibility);
229     bool ParseOptionalDLLStorageClass(unsigned &DLLStorageClass);
230     bool ParseOptionalCallingConv(unsigned &CC);
231     bool ParseOptionalAlignment(unsigned &Alignment);
232     bool ParseOptionalDerefAttrBytes(lltok::Kind AttrKind, uint64_t &Bytes);
233     bool ParseScopeAndOrdering(bool isAtomic, SynchronizationScope &Scope,
234                                AtomicOrdering &Ordering);
235     bool ParseOrdering(AtomicOrdering &Ordering);
236     bool ParseOptionalStackAlignment(unsigned &Alignment);
237     bool ParseOptionalCommaAlign(unsigned &Alignment, bool &AteExtraComma);
238     bool ParseOptionalCommaInAlloca(bool &IsInAlloca);
239     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices,bool &AteExtraComma);
240     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices) {
241       bool AteExtraComma;
242       if (ParseIndexList(Indices, AteExtraComma)) return true;
243       if (AteExtraComma)
244         return TokError("expected index");
245       return false;
246     }
247
248     // Top-Level Entities
249     bool ParseTopLevelEntities();
250     bool ValidateEndOfModule();
251     bool ParseTargetDefinition();
252     bool ParseModuleAsm();
253     bool ParseDepLibs();        // FIXME: Remove in 4.0.
254     bool ParseUnnamedType();
255     bool ParseNamedType();
256     bool ParseDeclare();
257     bool ParseDefine();
258
259     bool ParseGlobalType(bool &IsConstant);
260     bool ParseUnnamedGlobal();
261     bool ParseNamedGlobal();
262     bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
263                      bool HasLinkage, unsigned Visibility,
264                      unsigned DLLStorageClass,
265                      GlobalVariable::ThreadLocalMode TLM, bool UnnamedAddr);
266     bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Linkage,
267                     unsigned Visibility, unsigned DLLStorageClass,
268                     GlobalVariable::ThreadLocalMode TLM, bool UnnamedAddr);
269     bool parseComdat();
270     bool ParseStandaloneMetadata();
271     bool ParseNamedMetadata();
272     bool ParseMDString(MDString *&Result);
273     bool ParseMDNodeID(MDNode *&Result);
274     bool ParseUnnamedAttrGrp();
275     bool ParseFnAttributeValuePairs(AttrBuilder &B,
276                                     std::vector<unsigned> &FwdRefAttrGrps,
277                                     bool inAttrGrp, LocTy &BuiltinLoc);
278
279     // Type Parsing.
280     bool ParseType(Type *&Result, const Twine &Msg, bool AllowVoid = false);
281     bool ParseType(Type *&Result, bool AllowVoid = false) {
282       return ParseType(Result, "expected type", AllowVoid);
283     }
284     bool ParseType(Type *&Result, const Twine &Msg, LocTy &Loc,
285                    bool AllowVoid = false) {
286       Loc = Lex.getLoc();
287       return ParseType(Result, Msg, AllowVoid);
288     }
289     bool ParseType(Type *&Result, LocTy &Loc, bool AllowVoid = false) {
290       Loc = Lex.getLoc();
291       return ParseType(Result, AllowVoid);
292     }
293     bool ParseAnonStructType(Type *&Result, bool Packed);
294     bool ParseStructBody(SmallVectorImpl<Type*> &Body);
295     bool ParseStructDefinition(SMLoc TypeLoc, StringRef Name,
296                                std::pair<Type*, LocTy> &Entry,
297                                Type *&ResultTy);
298
299     bool ParseArrayVectorType(Type *&Result, bool isVector);
300     bool ParseFunctionType(Type *&Result);
301
302     // Function Semantic Analysis.
303     class PerFunctionState {
304       LLParser &P;
305       Function &F;
306       std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
307       std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
308       std::vector<Value*> NumberedVals;
309
310       /// FunctionNumber - If this is an unnamed function, this is the slot
311       /// number of it, otherwise it is -1.
312       int FunctionNumber;
313     public:
314       PerFunctionState(LLParser &p, Function &f, int FunctionNumber);
315       ~PerFunctionState();
316
317       Function &getFunction() const { return F; }
318
319       bool FinishFunction();
320
321       /// GetVal - Get a value with the specified name or ID, creating a
322       /// forward reference record if needed.  This can return null if the value
323       /// exists but does not have the right type.
324       Value *GetVal(const std::string &Name, Type *Ty, LocTy Loc);
325       Value *GetVal(unsigned ID, Type *Ty, LocTy Loc);
326
327       /// SetInstName - After an instruction is parsed and inserted into its
328       /// basic block, this installs its name.
329       bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
330                        Instruction *Inst);
331
332       /// GetBB - Get a basic block with the specified name or ID, creating a
333       /// forward reference record if needed.  This can return null if the value
334       /// is not a BasicBlock.
335       BasicBlock *GetBB(const std::string &Name, LocTy Loc);
336       BasicBlock *GetBB(unsigned ID, LocTy Loc);
337
338       /// DefineBB - Define the specified basic block, which is either named or
339       /// unnamed.  If there is an error, this returns null otherwise it returns
340       /// the block being defined.
341       BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
342
343       bool resolveForwardRefBlockAddresses();
344     };
345
346     bool ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
347                              PerFunctionState *PFS);
348
349     bool parseConstantValue(Type *Ty, Constant *&C);
350     bool ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS);
351     bool ParseValue(Type *Ty, Value *&V, PerFunctionState &PFS) {
352       return ParseValue(Ty, V, &PFS);
353     }
354     bool ParseValue(Type *Ty, Value *&V, LocTy &Loc,
355                     PerFunctionState &PFS) {
356       Loc = Lex.getLoc();
357       return ParseValue(Ty, V, &PFS);
358     }
359
360     bool ParseTypeAndValue(Value *&V, PerFunctionState *PFS);
361     bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS) {
362       return ParseTypeAndValue(V, &PFS);
363     }
364     bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
365       Loc = Lex.getLoc();
366       return ParseTypeAndValue(V, PFS);
367     }
368     bool ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
369                                 PerFunctionState &PFS);
370     bool ParseTypeAndBasicBlock(BasicBlock *&BB, PerFunctionState &PFS) {
371       LocTy Loc;
372       return ParseTypeAndBasicBlock(BB, Loc, PFS);
373     }
374
375
376     struct ParamInfo {
377       LocTy Loc;
378       Value *V;
379       AttributeSet Attrs;
380       ParamInfo(LocTy loc, Value *v, AttributeSet attrs)
381         : Loc(loc), V(v), Attrs(attrs) {}
382     };
383     bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
384                             PerFunctionState &PFS,
385                             bool IsMustTailCall = false,
386                             bool InVarArgsFunc = false);
387
388     bool ParseExceptionArgs(SmallVectorImpl<Value *> &Args,
389                             PerFunctionState &PFS);
390
391     // Constant Parsing.
392     bool ParseValID(ValID &ID, PerFunctionState *PFS = nullptr);
393     bool ParseGlobalValue(Type *Ty, Constant *&V);
394     bool ParseGlobalTypeAndValue(Constant *&V);
395     bool ParseGlobalValueVector(SmallVectorImpl<Constant *> &Elts);
396     bool parseOptionalComdat(StringRef GlobalName, Comdat *&C);
397     bool ParseMetadataAsValue(Value *&V, PerFunctionState &PFS);
398     bool ParseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg,
399                               PerFunctionState *PFS);
400     bool ParseMetadata(Metadata *&MD, PerFunctionState *PFS);
401     bool ParseMDTuple(MDNode *&MD, bool IsDistinct = false);
402     bool ParseMDNode(MDNode *&MD);
403     bool ParseMDNodeTail(MDNode *&MD);
404     bool ParseMDNodeVector(SmallVectorImpl<Metadata *> &MDs);
405     bool ParseMetadataAttachment(unsigned &Kind, MDNode *&MD);
406     bool ParseInstructionMetadata(Instruction &Inst);
407     bool ParseOptionalFunctionMetadata(Function &F);
408
409     template <class FieldTy>
410     bool ParseMDField(LocTy Loc, StringRef Name, FieldTy &Result);
411     template <class FieldTy> bool ParseMDField(StringRef Name, FieldTy &Result);
412     template <class ParserTy>
413     bool ParseMDFieldsImplBody(ParserTy parseField);
414     template <class ParserTy>
415     bool ParseMDFieldsImpl(ParserTy parseField, LocTy &ClosingLoc);
416     bool ParseSpecializedMDNode(MDNode *&N, bool IsDistinct = false);
417
418 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \
419   bool Parse##CLASS(MDNode *&Result, bool IsDistinct);
420 #include "llvm/IR/Metadata.def"
421
422     // Function Parsing.
423     struct ArgInfo {
424       LocTy Loc;
425       Type *Ty;
426       AttributeSet Attrs;
427       std::string Name;
428       ArgInfo(LocTy L, Type *ty, AttributeSet Attr, const std::string &N)
429         : Loc(L), Ty(ty), Attrs(Attr), Name(N) {}
430     };
431     bool ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList, bool &isVarArg);
432     bool ParseFunctionHeader(Function *&Fn, bool isDefine);
433     bool ParseFunctionBody(Function &Fn);
434     bool ParseBasicBlock(PerFunctionState &PFS);
435
436     enum TailCallType { TCT_None, TCT_Tail, TCT_MustTail };
437
438     // Instruction Parsing.  Each instruction parsing routine can return with a
439     // normal result, an error result, or return having eaten an extra comma.
440     enum InstResult { InstNormal = 0, InstError = 1, InstExtraComma = 2 };
441     int ParseInstruction(Instruction *&Inst, BasicBlock *BB,
442                          PerFunctionState &PFS);
443     bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
444
445     bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
446     bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
447     bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
448     bool ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS);
449     bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
450     bool ParseResume(Instruction *&Inst, PerFunctionState &PFS);
451     bool ParseCleanupRet(Instruction *&Inst, PerFunctionState &PFS);
452     bool ParseCatchRet(Instruction *&Inst, PerFunctionState &PFS);
453     bool ParseCatchPad(Instruction *&Inst, PerFunctionState &PFS);
454     bool ParseTerminatePad(Instruction *&Inst, PerFunctionState &PFS);
455     bool ParseCleanupPad(Instruction *&Inst, PerFunctionState &PFS);
456     bool ParseCatchEndPad(Instruction *&Inst, PerFunctionState &PFS);
457
458     bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
459                          unsigned OperandType);
460     bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
461     bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
462     bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
463     bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
464     bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
465     bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
466     bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
467     bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
468     int ParsePHI(Instruction *&I, PerFunctionState &PFS);
469     bool ParseLandingPad(Instruction *&I, PerFunctionState &PFS);
470     bool ParseCall(Instruction *&I, PerFunctionState &PFS,
471                    CallInst::TailCallKind IsTail);
472     int ParseAlloc(Instruction *&I, PerFunctionState &PFS);
473     int ParseLoad(Instruction *&I, PerFunctionState &PFS);
474     int ParseStore(Instruction *&I, PerFunctionState &PFS);
475     int ParseCmpXchg(Instruction *&I, PerFunctionState &PFS);
476     int ParseAtomicRMW(Instruction *&I, PerFunctionState &PFS);
477     int ParseFence(Instruction *&I, PerFunctionState &PFS);
478     int ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
479     int ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
480     int ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
481
482     // Use-list order directives.
483     bool ParseUseListOrder(PerFunctionState *PFS = nullptr);
484     bool ParseUseListOrderBB();
485     bool ParseUseListOrderIndexes(SmallVectorImpl<unsigned> &Indexes);
486     bool sortUseListOrder(Value *V, ArrayRef<unsigned> Indexes, SMLoc Loc);
487   };
488 } // End llvm namespace
489
490 #endif