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/Support/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, LocTy *Loc = 0) {
 180       if (Lex.getKind() != T) {
 181         Present = false;
 182       } else {
 183         if (Loc)
 184           *Loc = Lex.getLoc();
 185         Lex.Lex();
 186         Present = true;
 187       }
 188       return false;
 189     }
 190     bool ParseStringConstant(std::string &Result);
 191     bool ParseUInt32(unsigned &Val);
 192     bool ParseUInt32(unsigned &Val, LocTy &Loc) {
 193       Loc = Lex.getLoc();
 194       return ParseUInt32(Val);
 195     }
 196
 197     bool ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM);
 198     bool ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM);
 199     bool ParseOptionalAddrSpace(unsigned &AddrSpace);
 200     bool ParseOptionalParamAttrs(AttrBuilder &B);
 201     bool ParseOptionalReturnAttrs(AttrBuilder &B);
 202     bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
 203     bool ParseOptionalLinkage(unsigned &Linkage) {
 204       bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
 205     }
 206     bool ParseOptionalVisibility(unsigned &Visibility);
 207     bool ParseOptionalDLLStorageClass(unsigned &DLLStorageClass);
 208     bool ParseOptionalCallingConv(CallingConv::ID &CC);
 209     bool ParseOptionalAlignment(unsigned &Alignment);
 210     bool ParseScopeAndOrdering(bool isAtomic, SynchronizationScope &Scope,
 211                                AtomicOrdering &Ordering);
 212     bool ParseOptionalStackAlignment(unsigned &Alignment);
 213     bool ParseOptionalCommaAlign(unsigned &Alignment, bool &AteExtraComma);
 214     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices,bool &AteExtraComma);
 215     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices) {
 216       bool AteExtraComma;
 217       if (ParseIndexList(Indices, AteExtraComma)) return true;
 218       if (AteExtraComma)
 219         return TokError("expected index");
 220       return false;
 221     }
 222
 223     // Top-Level Entities
 224     bool ParseTopLevelEntities();
 225     bool ValidateEndOfModule();
 226     bool ParseTargetDefinition();
 227     bool ParseModuleAsm();
 228     bool ParseDepLibs();        // FIXME: Remove in 4.0.
 229     bool ParseUnnamedType();
 230     bool ParseNamedType();
 231     bool ParseDeclare();
 232     bool ParseDefine();
 233
 234     bool ParseGlobalType(bool &IsConstant);
 235     bool ParseUnnamedGlobal();
 236     bool ParseNamedGlobal();
 237     bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
 238                      bool HasLinkage, unsigned Visibility,
 239                      unsigned DLLStorageClass);
 240     bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility,
 241                     unsigned DLLStorageClass);
 242     bool ParseStandaloneMetadata();
 243     bool ParseNamedMetadata();
 244     bool ParseMDString(MDString *&Result);
 245     bool ParseMDNodeID(MDNode *&Result);
 246     bool ParseMDNodeID(MDNode *&Result, unsigned &SlotNo);
 247     bool ParseUnnamedAttrGrp();
 248     bool ParseFnAttributeValuePairs(AttrBuilder &B,
 249                                     std::vector<unsigned> &FwdRefAttrGrps,
 250                                     bool inAttrGrp, LocTy &BuiltinLoc);
 251
 252     // Type Parsing.
 253     bool ParseType(Type *&Result, bool AllowVoid = false);
 254     bool ParseType(Type *&Result, LocTy &Loc, bool AllowVoid = false) {
 255       Loc = Lex.getLoc();
 256       return ParseType(Result, AllowVoid);
 257     }
 258     bool ParseAnonStructType(Type *&Result, bool Packed);
 259     bool ParseStructBody(SmallVectorImpl<Type*> &Body);
 260     bool ParseStructDefinition(SMLoc TypeLoc, StringRef Name,
 261                                std::pair<Type*, LocTy> &Entry,
 262                                Type *&ResultTy);
 263
 264     bool ParseArrayVectorType(Type *&Result, bool isVector);
 265     bool ParseFunctionType(Type *&Result);
 266
 267     // Function Semantic Analysis.
 268     class PerFunctionState {
 269       LLParser &P;
 270       Function &F;
 271       std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
 272       std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
 273       std::vector<Value*> NumberedVals;
 274
 275       /// FunctionNumber - If this is an unnamed function, this is the slot
 276       /// number of it, otherwise it is -1.
 277       int FunctionNumber;
 278     public:
 279       PerFunctionState(LLParser &p, Function &f, int FunctionNumber);
 280       ~PerFunctionState();
 281
 282       Function &getFunction() const { return F; }
 283
 284       bool FinishFunction();
 285
 286       /// GetVal - Get a value with the specified name or ID, creating a
 287       /// forward reference record if needed.  This can return null if the value
 288       /// exists but does not have the right type.
 289       Value *GetVal(const std::string &Name, Type *Ty, LocTy Loc);
 290       Value *GetVal(unsigned ID, Type *Ty, LocTy Loc);
 291
 292       /// SetInstName - After an instruction is parsed and inserted into its
 293       /// basic block, this installs its name.
 294       bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
 295                        Instruction *Inst);
 296
 297       /// GetBB - Get a basic block with the specified name or ID, creating a
 298       /// forward reference record if needed.  This can return null if the value
 299       /// is not a BasicBlock.
 300       BasicBlock *GetBB(const std::string &Name, LocTy Loc);
 301       BasicBlock *GetBB(unsigned ID, LocTy Loc);
 302
 303       /// DefineBB - Define the specified basic block, which is either named or
 304       /// unnamed.  If there is an error, this returns null otherwise it returns
 305       /// the block being defined.
 306       BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
 307     };
 308
 309     bool ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
 310                              PerFunctionState *PFS);
 311
 312     bool ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS);
 313     bool ParseValue(Type *Ty, Value *&V, PerFunctionState &PFS) {
 314       return ParseValue(Ty, V, &PFS);
 315     }
 316     bool ParseValue(Type *Ty, Value *&V, LocTy &Loc,
 317                     PerFunctionState &PFS) {
 318       Loc = Lex.getLoc();
 319       return ParseValue(Ty, V, &PFS);
 320     }
 321
 322     bool ParseTypeAndValue(Value *&V, PerFunctionState *PFS);
 323     bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS) {
 324       return ParseTypeAndValue(V, &PFS);
 325     }
 326     bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
 327       Loc = Lex.getLoc();
 328       return ParseTypeAndValue(V, PFS);
 329     }
 330     bool ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
 331                                 PerFunctionState &PFS);
 332     bool ParseTypeAndBasicBlock(BasicBlock *&BB, PerFunctionState &PFS) {
 333       LocTy Loc;
 334       return ParseTypeAndBasicBlock(BB, Loc, PFS);
 335     }
 336
 337
 338     struct ParamInfo {
 339       LocTy Loc;
 340       Value *V;
 341       AttributeSet Attrs;
 342       ParamInfo(LocTy loc, Value *v, AttributeSet attrs)
 343         : Loc(loc), V(v), Attrs(attrs) {}
 344     };
 345     bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
 346                             PerFunctionState &PFS);
 347
 348     // Constant Parsing.
 349     bool ParseValID(ValID &ID, PerFunctionState *PFS = NULL);
 350     bool ParseGlobalValue(Type *Ty, Constant *&V);
 351     bool ParseGlobalTypeAndValue(Constant *&V);
 352     bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
 353     bool ParseMetadataListValue(ValID &ID, PerFunctionState *PFS);
 354     bool ParseMetadataValue(ValID &ID, PerFunctionState *PFS);
 355     bool ParseMDNodeVector(SmallVectorImpl<Value*> &, PerFunctionState *PFS);
 356     bool ParseInstructionMetadata(Instruction *Inst, PerFunctionState *PFS);
 357
 358     // Function Parsing.
 359     struct ArgInfo {
 360       LocTy Loc;
 361       Type *Ty;
 362       AttributeSet Attrs;
 363       std::string Name;
 364       ArgInfo(LocTy L, Type *ty, AttributeSet Attr, const std::string &N)
 365         : Loc(L), Ty(ty), Attrs(Attr), Name(N) {}
 366     };
 367     bool ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList, bool &isVarArg);
 368     bool ParseFunctionHeader(Function *&Fn, bool isDefine);
 369     bool ParseFunctionBody(Function &Fn);
 370     bool ParseBasicBlock(PerFunctionState &PFS);
 371
 372     // Instruction Parsing.  Each instruction parsing routine can return with a
 373     // normal result, an error result, or return having eaten an extra comma.
 374     enum InstResult { InstNormal = 0, InstError = 1, InstExtraComma = 2 };
 375     int ParseInstruction(Instruction *&Inst, BasicBlock *BB,
 376                          PerFunctionState &PFS);
 377     bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
 378
 379     bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
 380     bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
 381     bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
 382     bool ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS);
 383     bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
 384     bool ParseResume(Instruction *&Inst, PerFunctionState &PFS);
 385
 386     bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
 387                          unsigned OperandType);
 388     bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 389     bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 390     bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 391     bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
 392     bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
 393     bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
 394     bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
 395     bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
 396     int ParsePHI(Instruction *&I, PerFunctionState &PFS);
 397     bool ParseLandingPad(Instruction *&I, PerFunctionState &PFS);
 398     bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
 399     int ParseAlloc(Instruction *&I, PerFunctionState &PFS);
 400     int ParseLoad(Instruction *&I, PerFunctionState &PFS);
 401     int ParseStore(Instruction *&I, PerFunctionState &PFS);
 402     int ParseCmpXchg(Instruction *&I, PerFunctionState &PFS);
 403     int ParseAtomicRMW(Instruction *&I, PerFunctionState &PFS);
 404     int ParseFence(Instruction *&I, PerFunctionState &PFS);
 405     int ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
 406     int ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
 407     int ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
 408
 409     bool ResolveForwardRefBlockAddresses(Function *TheFn,
 410                              std::vector<std::pair<ValID, GlobalValue*> > &Refs,
 411                                          PerFunctionState *PFS);
 412   };
 413 } // End llvm namespace
 414
 415 #endif