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_ASMPARSER_LLPARSER_H
  15 #define LLVM_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 MDString;
  38   class MDNode;
  39   class StructType;
  40
  41   /// ValID - Represents a reference of a definition of some sort with no type.
  42   /// There are several cases where we have to parse the value but where the
  43   /// type can depend on later context.  This may either be a numeric reference
  44   /// or a symbolic (%var) reference.  This is just a discriminated union.
  45   struct ValID {
  46     enum {
  47       t_LocalID, t_GlobalID,      // ID in UIntVal.
  48       t_LocalName, t_GlobalName,  // Name in StrVal.
  49       t_APSInt, t_APFloat,        // Value in APSIntVal/APFloatVal.
  50       t_Null, t_Undef, t_Zero,    // No value.
  51       t_EmptyArray,               // No value:  []
  52       t_Constant,                 // Value in ConstantVal.
  53       t_InlineAsm,                // Value in StrVal/StrVal2/UIntVal.
  54       t_MDNode,                   // Value in MDNodeVal.
  55       t_MDString,                 // Value in MDStringVal.
  56       t_ConstantStruct,           // Value in ConstantStructElts.
  57       t_PackedConstantStruct      // Value in ConstantStructElts.
  58     } Kind;
  59
  60     LLLexer::LocTy Loc;
  61     unsigned UIntVal;
  62     std::string StrVal, StrVal2;
  63     APSInt APSIntVal;
  64     APFloat APFloatVal;
  65     Constant *ConstantVal;
  66     MDNode *MDNodeVal;
  67     MDString *MDStringVal;
  68     Constant **ConstantStructElts;
  69
  70     ValID() : Kind(t_LocalID), APFloatVal(0.0) {}
  71     ~ValID() {
  72       if (Kind == t_ConstantStruct || Kind == t_PackedConstantStruct)
  73         delete [] ConstantStructElts;
  74     }
  75
  76     bool operator<(const ValID &RHS) const {
  77       if (Kind == t_LocalID || Kind == t_GlobalID)
  78         return UIntVal < RHS.UIntVal;
  79       assert((Kind == t_LocalName || Kind == t_GlobalName ||
  80               Kind == t_ConstantStruct || Kind == t_PackedConstantStruct) &&
  81              "Ordering not defined for this ValID kind yet");
  82       return StrVal < RHS.StrVal;
  83     }
  84   };
  85
  86   class LLParser {
  87   public:
  88     typedef LLLexer::LocTy LocTy;
  89   private:
  90     LLVMContext &Context;
  91     LLLexer Lex;
  92     Module *M;
  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     DenseMap<Instruction*, std::vector<MDRef> > ForwardRefInstMetadata;
 109
 110     SmallVector<Instruction*, 64> InstsWithTBAATag;
 111
 112     // Type resolution handling data structures.  The location is set when we
 113     // have processed a use of the type but not a definition yet.
 114     StringMap<std::pair<Type*, LocTy> > NamedTypes;
 115     std::vector<std::pair<Type*, LocTy> > NumberedTypes;
 116
 117     std::vector<TrackingVH<MDNode> > NumberedMetadata;
 118     std::map<unsigned, std::pair<TrackingVH<MDNode>, LocTy> > ForwardRefMDNodes;
 119
 120     // Global Value reference information.
 121     std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
 122     std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
 123     std::vector<GlobalValue*> NumberedVals;
 124
 125     // References to blockaddress.  The key is the function ValID, the value is
 126     // a list of references to blocks in that function.
 127     std::map<ValID, std::vector<std::pair<ValID, GlobalValue*> > >
 128       ForwardRefBlockAddresses;
 129
 130     // Attribute builder reference information.
 131     std::map<Value*, std::vector<unsigned> > ForwardRefAttrGroups;
 132     std::map<unsigned, AttrBuilder> NumberedAttrBuilders;
 133
 134   public:
 135     LLParser(MemoryBuffer *F, SourceMgr &SM, SMDiagnostic &Err, Module *m) :
 136       Context(m->getContext()), Lex(F, SM, Err, m->getContext()),
 137       M(m) {}
 138     bool Run();
 139
 140     LLVMContext &getContext() { return Context; }
 141
 142   private:
 143
 144     bool Error(LocTy L, const Twine &Msg) const {
 145       return Lex.Error(L, Msg);
 146     }
 147     bool TokError(const Twine &Msg) const {
 148       return Error(Lex.getLoc(), Msg);
 149     }
 150
 151     /// GetGlobalVal - Get a value with the specified name or ID, creating a
 152     /// forward reference record if needed.  This can return null if the value
 153     /// exists but does not have the right type.
 154     GlobalValue *GetGlobalVal(const std::string &N, Type *Ty, LocTy Loc);
 155     GlobalValue *GetGlobalVal(unsigned ID, Type *Ty, LocTy Loc);
 156
 157     // Helper Routines.
 158     bool ParseToken(lltok::Kind T, const char *ErrMsg);
 159     bool EatIfPresent(lltok::Kind T) {
 160       if (Lex.getKind() != T) return false;
 161       Lex.Lex();
 162       return true;
 163     }
 164
 165     FastMathFlags EatFastMathFlagsIfPresent() {
 166       FastMathFlags FMF;
 167       while (true)
 168         switch (Lex.getKind()) {
 169         case lltok::kw_fast: FMF.setUnsafeAlgebra();   Lex.Lex(); continue;
 170         case lltok::kw_nnan: FMF.setNoNaNs();          Lex.Lex(); continue;
 171         case lltok::kw_ninf: FMF.setNoInfs();          Lex.Lex(); continue;
 172         case lltok::kw_nsz:  FMF.setNoSignedZeros();   Lex.Lex(); continue;
 173         case lltok::kw_arcp: FMF.setAllowReciprocal(); Lex.Lex(); continue;
 174         default: return FMF;
 175         }
 176       return FMF;
 177     }
 178
 179     bool ParseOptionalToken(lltok::Kind T, bool &Present,
 180                             LocTy *Loc = nullptr) {
 181       if (Lex.getKind() != T) {
 182         Present = false;
 183       } else {
 184         if (Loc)
 185           *Loc = Lex.getLoc();
 186         Lex.Lex();
 187         Present = true;
 188       }
 189       return false;
 190     }
 191     bool ParseStringConstant(std::string &Result);
 192     bool ParseUInt32(unsigned &Val);
 193     bool ParseUInt32(unsigned &Val, LocTy &Loc) {
 194       Loc = Lex.getLoc();
 195       return ParseUInt32(Val);
 196     }
 197
 198     bool ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM);
 199     bool ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM);
 200     bool parseOptionalUnnamedAddr(bool &UnnamedAddr) {
 201       return ParseOptionalToken(lltok::kw_unnamed_addr, UnnamedAddr);
 202     }
 203     bool ParseOptionalAddrSpace(unsigned &AddrSpace);
 204     bool ParseOptionalParamAttrs(AttrBuilder &B);
 205     bool ParseOptionalReturnAttrs(AttrBuilder &B);
 206     bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
 207     bool ParseOptionalLinkage(unsigned &Linkage) {
 208       bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
 209     }
 210     bool ParseOptionalVisibility(unsigned &Visibility);
 211     bool ParseOptionalDLLStorageClass(unsigned &DLLStorageClass);
 212     bool ParseOptionalCallingConv(CallingConv::ID &CC);
 213     bool ParseOptionalAlignment(unsigned &Alignment);
 214     bool ParseScopeAndOrdering(bool isAtomic, SynchronizationScope &Scope,
 215                                AtomicOrdering &Ordering);
 216     bool ParseOrdering(AtomicOrdering &Ordering);
 217     bool ParseOptionalStackAlignment(unsigned &Alignment);
 218     bool ParseOptionalCommaAlign(unsigned &Alignment, bool &AteExtraComma);
 219     bool ParseOptionalCommaInAlloca(bool &IsInAlloca);
 220     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices,bool &AteExtraComma);
 221     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices) {
 222       bool AteExtraComma;
 223       if (ParseIndexList(Indices, AteExtraComma)) return true;
 224       if (AteExtraComma)
 225         return TokError("expected index");
 226       return false;
 227     }
 228
 229     // Top-Level Entities
 230     bool ParseTopLevelEntities();
 231     bool ValidateEndOfModule();
 232     bool ParseTargetDefinition();
 233     bool ParseModuleAsm();
 234     bool ParseDepLibs();        // FIXME: Remove in 4.0.
 235     bool ParseUnnamedType();
 236     bool ParseNamedType();
 237     bool ParseDeclare();
 238     bool ParseDefine();
 239
 240     bool ParseGlobalType(bool &IsConstant);
 241     bool ParseUnnamedGlobal();
 242     bool ParseNamedGlobal();
 243     bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
 244                      bool HasLinkage, unsigned Visibility,
 245                      unsigned DLLStorageClass,
 246                      GlobalVariable::ThreadLocalMode TLM, bool UnnamedAddr);
 247     bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility,
 248                     unsigned DLLStorageClass,
 249                     GlobalVariable::ThreadLocalMode TLM, bool UnnamedAddr);
 250     bool ParseStandaloneMetadata();
 251     bool ParseNamedMetadata();
 252     bool ParseMDString(MDString *&Result);
 253     bool ParseMDNodeID(MDNode *&Result);
 254     bool ParseMDNodeID(MDNode *&Result, unsigned &SlotNo);
 255     bool ParseUnnamedAttrGrp();
 256     bool ParseFnAttributeValuePairs(AttrBuilder &B,
 257                                     std::vector<unsigned> &FwdRefAttrGrps,
 258                                     bool inAttrGrp, LocTy &BuiltinLoc);
 259
 260     // Type Parsing.
 261     bool ParseType(Type *&Result, bool AllowVoid = false);
 262     bool ParseType(Type *&Result, LocTy &Loc, bool AllowVoid = false) {
 263       Loc = Lex.getLoc();
 264       return ParseType(Result, AllowVoid);
 265     }
 266     bool ParseAnonStructType(Type *&Result, bool Packed);
 267     bool ParseStructBody(SmallVectorImpl<Type*> &Body);
 268     bool ParseStructDefinition(SMLoc TypeLoc, StringRef Name,
 269                                std::pair<Type*, LocTy> &Entry,
 270                                Type *&ResultTy);
 271
 272     bool ParseArrayVectorType(Type *&Result, bool isVector);
 273     bool ParseFunctionType(Type *&Result);
 274
 275     // Function Semantic Analysis.
 276     class PerFunctionState {
 277       LLParser &P;
 278       Function &F;
 279       std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
 280       std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
 281       std::vector<Value*> NumberedVals;
 282
 283       /// FunctionNumber - If this is an unnamed function, this is the slot
 284       /// number of it, otherwise it is -1.
 285       int FunctionNumber;
 286     public:
 287       PerFunctionState(LLParser &p, Function &f, int FunctionNumber);
 288       ~PerFunctionState();
 289
 290       Function &getFunction() const { return F; }
 291
 292       bool FinishFunction();
 293
 294       /// GetVal - Get a value with the specified name or ID, creating a
 295       /// forward reference record if needed.  This can return null if the value
 296       /// exists but does not have the right type.
 297       Value *GetVal(const std::string &Name, Type *Ty, LocTy Loc);
 298       Value *GetVal(unsigned ID, Type *Ty, LocTy Loc);
 299
 300       /// SetInstName - After an instruction is parsed and inserted into its
 301       /// basic block, this installs its name.
 302       bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
 303                        Instruction *Inst);
 304
 305       /// GetBB - Get a basic block with the specified name or ID, creating a
 306       /// forward reference record if needed.  This can return null if the value
 307       /// is not a BasicBlock.
 308       BasicBlock *GetBB(const std::string &Name, LocTy Loc);
 309       BasicBlock *GetBB(unsigned ID, LocTy Loc);
 310
 311       /// DefineBB - Define the specified basic block, which is either named or
 312       /// unnamed.  If there is an error, this returns null otherwise it returns
 313       /// the block being defined.
 314       BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
 315     };
 316
 317     bool ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
 318                              PerFunctionState *PFS);
 319
 320     bool ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS);
 321     bool ParseValue(Type *Ty, Value *&V, PerFunctionState &PFS) {
 322       return ParseValue(Ty, V, &PFS);
 323     }
 324     bool ParseValue(Type *Ty, Value *&V, LocTy &Loc,
 325                     PerFunctionState &PFS) {
 326       Loc = Lex.getLoc();
 327       return ParseValue(Ty, V, &PFS);
 328     }
 329
 330     bool ParseTypeAndValue(Value *&V, PerFunctionState *PFS);
 331     bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS) {
 332       return ParseTypeAndValue(V, &PFS);
 333     }
 334     bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
 335       Loc = Lex.getLoc();
 336       return ParseTypeAndValue(V, PFS);
 337     }
 338     bool ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
 339                                 PerFunctionState &PFS);
 340     bool ParseTypeAndBasicBlock(BasicBlock *&BB, PerFunctionState &PFS) {
 341       LocTy Loc;
 342       return ParseTypeAndBasicBlock(BB, Loc, PFS);
 343     }
 344
 345
 346     struct ParamInfo {
 347       LocTy Loc;
 348       Value *V;
 349       AttributeSet Attrs;
 350       ParamInfo(LocTy loc, Value *v, AttributeSet attrs)
 351         : Loc(loc), V(v), Attrs(attrs) {}
 352     };
 353     bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
 354                             PerFunctionState &PFS);
 355
 356     // Constant Parsing.
 357     bool ParseValID(ValID &ID, PerFunctionState *PFS = nullptr);
 358     bool ParseGlobalValue(Type *Ty, Constant *&V);
 359     bool ParseGlobalTypeAndValue(Constant *&V);
 360     bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
 361     bool ParseMetadataListValue(ValID &ID, PerFunctionState *PFS);
 362     bool ParseMetadataValue(ValID &ID, PerFunctionState *PFS);
 363     bool ParseMDNodeVector(SmallVectorImpl<Value*> &, PerFunctionState *PFS);
 364     bool ParseInstructionMetadata(Instruction *Inst, PerFunctionState *PFS);
 365
 366     // Function Parsing.
 367     struct ArgInfo {
 368       LocTy Loc;
 369       Type *Ty;
 370       AttributeSet Attrs;
 371       std::string Name;
 372       ArgInfo(LocTy L, Type *ty, AttributeSet Attr, const std::string &N)
 373         : Loc(L), Ty(ty), Attrs(Attr), Name(N) {}
 374     };
 375     bool ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList, bool &isVarArg);
 376     bool ParseFunctionHeader(Function *&Fn, bool isDefine);
 377     bool ParseFunctionBody(Function &Fn);
 378     bool ParseBasicBlock(PerFunctionState &PFS);
 379
 380     enum TailCallType { TCT_None, TCT_Tail, TCT_MustTail };
 381
 382     // Instruction Parsing.  Each instruction parsing routine can return with a
 383     // normal result, an error result, or return having eaten an extra comma.
 384     enum InstResult { InstNormal = 0, InstError = 1, InstExtraComma = 2 };
 385     int ParseInstruction(Instruction *&Inst, BasicBlock *BB,
 386                          PerFunctionState &PFS);
 387     bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
 388
 389     bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
 390     bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
 391     bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
 392     bool ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS);
 393     bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
 394     bool ParseResume(Instruction *&Inst, PerFunctionState &PFS);
 395
 396     bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
 397                          unsigned OperandType);
 398     bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 399     bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 400     bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 401     bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
 402     bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
 403     bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
 404     bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
 405     bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
 406     int ParsePHI(Instruction *&I, PerFunctionState &PFS);
 407     bool ParseLandingPad(Instruction *&I, PerFunctionState &PFS);
 408     bool ParseCall(Instruction *&I, PerFunctionState &PFS,
 409                    CallInst::TailCallKind IsTail);
 410     int ParseAlloc(Instruction *&I, PerFunctionState &PFS);
 411     int ParseLoad(Instruction *&I, PerFunctionState &PFS);
 412     int ParseStore(Instruction *&I, PerFunctionState &PFS);
 413     int ParseCmpXchg(Instruction *&I, PerFunctionState &PFS);
 414     int ParseAtomicRMW(Instruction *&I, PerFunctionState &PFS);
 415     int ParseFence(Instruction *&I, PerFunctionState &PFS);
 416     int ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
 417     int ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
 418     int ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
 419
 420     bool ResolveForwardRefBlockAddresses(Function *TheFn,
 421                              std::vector<std::pair<ValID, GlobalValue*> > &Refs,
 422                                          PerFunctionState *PFS);
 423   };
 424 } // End llvm namespace
 425
 426 #endif