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/Module.h"
  19 #include "llvm/Type.h"
  20 #include "llvm/Support/ValueHandle.h"
  21 #include <map>
  22
  23 namespace llvm {
  24   class Module;
  25   class OpaqueType;
  26   class Function;
  27   class Value;
  28   class BasicBlock;
  29   class Instruction;
  30   class Constant;
  31   class GlobalValue;
  32   class MetadataBase;
  33   class MDString;
  34   class MDNode;
  35
  36   /// ValID - Represents a reference of a definition of some sort with no type.
  37   /// There are several cases where we have to parse the value but where the
  38   /// type can depend on later context.  This may either be a numeric reference
  39   /// or a symbolic (%var) reference.  This is just a discriminated union.
  40   struct ValID {
  41     enum {
  42       t_LocalID, t_GlobalID,      // ID in UIntVal.
  43       t_LocalName, t_GlobalName,  // Name in StrVal.
  44       t_APSInt, t_APFloat,        // Value in APSIntVal/APFloatVal.
  45       t_Null, t_Undef, t_Zero,    // No value.
  46       t_EmptyArray,               // No value:  []
  47       t_Constant,                 // Value in ConstantVal.
  48       t_InlineAsm,                // Value in StrVal/StrVal2/UIntVal.
  49       t_MDNode,                   // Value in MDNodeVal.
  50       t_MDString                  // Value in MDStringVal.
  51     } Kind;
  52
  53     LLLexer::LocTy Loc;
  54     unsigned UIntVal;
  55     std::string StrVal, StrVal2;
  56     APSInt APSIntVal;
  57     APFloat APFloatVal;
  58     Constant *ConstantVal;
  59     MDNode *MDNodeVal;
  60     MDString *MDStringVal;
  61     ValID() : APFloatVal(0.0) {}
  62
  63     bool operator<(const ValID &RHS) const {
  64       if (Kind == t_LocalID || Kind == t_GlobalID)
  65         return UIntVal < RHS.UIntVal;
  66       assert((Kind == t_LocalName || Kind == t_GlobalName) &&
  67              "Ordering not defined for this ValID kind yet");
  68       return StrVal < RHS.StrVal;
  69     }
  70   };
  71
  72   class LLParser {
  73   public:
  74     typedef LLLexer::LocTy LocTy;
  75   private:
  76     LLVMContext& Context;
  77     LLLexer Lex;
  78     Module *M;
  79
  80     // Type resolution handling data structures.
  81     std::map<std::string, std::pair<PATypeHolder, LocTy> > ForwardRefTypes;
  82     std::map<unsigned, std::pair<PATypeHolder, LocTy> > ForwardRefTypeIDs;
  83     std::vector<PATypeHolder> NumberedTypes;
  84     std::vector<TrackingVH<MDNode> > NumberedMetadata;
  85     std::map<unsigned, std::pair<TrackingVH<MDNode>, LocTy> > ForwardRefMDNodes;
  86     struct UpRefRecord {
  87       /// Loc - This is the location of the upref.
  88       LocTy Loc;
  89
  90       /// NestingLevel - The number of nesting levels that need to be popped
  91       /// before this type is resolved.
  92       unsigned NestingLevel;
  93
  94       /// LastContainedTy - This is the type at the current binding level for
  95       /// the type.  Every time we reduce the nesting level, this gets updated.
  96       const Type *LastContainedTy;
  97
  98       /// UpRefTy - This is the actual opaque type that the upreference is
  99       /// represented with.
 100       OpaqueType *UpRefTy;
 101
 102       UpRefRecord(LocTy L, unsigned NL, OpaqueType *URTy)
 103         : Loc(L), NestingLevel(NL), LastContainedTy((Type*)URTy),
 104           UpRefTy(URTy) {}
 105     };
 106     std::vector<UpRefRecord> UpRefs;
 107
 108     // Global Value reference information.
 109     std::map<std::string, std::pair<GlobalValue*, LocTy> > ForwardRefVals;
 110     std::map<unsigned, std::pair<GlobalValue*, LocTy> > ForwardRefValIDs;
 111     std::vector<GlobalValue*> NumberedVals;
 112
 113     // References to blockaddress.  The key is the function ValID, the value is
 114     // a list of references to blocks in that function.
 115     std::map<ValID, std::vector<std::pair<ValID, GlobalValue*> > >
 116       ForwardRefBlockAddresses;
 117
 118     Function *MallocF;
 119   public:
 120     LLParser(MemoryBuffer *F, SourceMgr &SM, SMDiagnostic &Err, Module *m) :
 121       Context(m->getContext()), Lex(F, SM, Err, m->getContext()),
 122       M(m), MallocF(NULL) {}
 123     bool Run();
 124
 125     LLVMContext& getContext() { return Context; }
 126
 127   private:
 128
 129     bool Error(LocTy L, const std::string &Msg) const {
 130       return Lex.Error(L, Msg);
 131     }
 132     bool TokError(const std::string &Msg) const {
 133       return Error(Lex.getLoc(), Msg);
 134     }
 135
 136     /// GetGlobalVal - Get a value with the specified name or ID, creating a
 137     /// forward reference record if needed.  This can return null if the value
 138     /// exists but does not have the right type.
 139     GlobalValue *GetGlobalVal(const std::string &N, const Type *Ty, LocTy Loc);
 140     GlobalValue *GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc);
 141
 142     // Helper Routines.
 143     bool ParseToken(lltok::Kind T, const char *ErrMsg);
 144     bool EatIfPresent(lltok::Kind T) {
 145       if (Lex.getKind() != T) return false;
 146       Lex.Lex();
 147       return true;
 148     }
 149     bool ParseOptionalToken(lltok::Kind T, bool &Present) {
 150       if (Lex.getKind() != T) {
 151         Present = false;
 152       } else {
 153         Lex.Lex();
 154         Present = true;
 155       }
 156       return false;
 157     }
 158     bool ParseStringConstant(std::string &Result);
 159     bool ParseUInt32(unsigned &Val);
 160     bool ParseUInt32(unsigned &Val, LocTy &Loc) {
 161       Loc = Lex.getLoc();
 162       return ParseUInt32(Val);
 163     }
 164     bool ParseOptionalAddrSpace(unsigned &AddrSpace);
 165     bool ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind);
 166     bool ParseOptionalLinkage(unsigned &Linkage, bool &HasLinkage);
 167     bool ParseOptionalLinkage(unsigned &Linkage) {
 168       bool HasLinkage; return ParseOptionalLinkage(Linkage, HasLinkage);
 169     }
 170     bool ParseOptionalVisibility(unsigned &Visibility);
 171     bool ParseOptionalCallingConv(CallingConv::ID &CC);
 172     bool ParseOptionalAlignment(unsigned &Alignment);
 173     bool ParseInstructionMetadata(SmallVectorImpl<std::pair<unsigned,
 174                                                             MDNode *> > &);
 175     bool ParseOptionalCommaAlign(unsigned &Alignment, bool &AteExtraComma);
 176     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices,bool &AteExtraComma);
 177     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices) {
 178       bool AteExtraComma;
 179       if (ParseIndexList(Indices, AteExtraComma)) return true;
 180       if (AteExtraComma)
 181         return TokError("expected index");
 182       return false;
 183     }
 184
 185     // Top-Level Entities
 186     bool ParseTopLevelEntities();
 187     bool ValidateEndOfModule();
 188     bool ParseTargetDefinition();
 189     bool ParseDepLibs();
 190     bool ParseModuleAsm();
 191     bool ParseUnnamedType();
 192     bool ParseNamedType();
 193     bool ParseDeclare();
 194     bool ParseDefine();
 195
 196     bool ParseGlobalType(bool &IsConstant);
 197     bool ParseUnnamedGlobal();
 198     bool ParseNamedGlobal();
 199     bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
 200                      bool HasLinkage, unsigned Visibility);
 201     bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
 202     bool ParseStandaloneMetadata();
 203     bool ParseNamedMetadata();
 204     bool ParseMDString(MDString *&Result);
 205     bool ParseMDNodeID(MDNode *&Result);
 206
 207     // Type Parsing.
 208     bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
 209     bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
 210       Loc = Lex.getLoc();
 211       return ParseType(Result, AllowVoid);
 212     }
 213     bool ParseTypeRec(PATypeHolder &H);
 214     bool ParseStructType(PATypeHolder &H, bool Packed);
 215     bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
 216     bool ParseFunctionType(PATypeHolder &Result);
 217     PATypeHolder HandleUpRefs(const Type *Ty);
 218
 219     // Function Semantic Analysis.
 220     class PerFunctionState {
 221       LLParser &P;
 222       Function &F;
 223       std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
 224       std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
 225       std::vector<Value*> NumberedVals;
 226
 227       /// FunctionNumber - If this is an unnamed function, this is the slot
 228       /// number of it, otherwise it is -1.
 229       int FunctionNumber;
 230     public:
 231       PerFunctionState(LLParser &p, Function &f, int FunctionNumber);
 232       ~PerFunctionState();
 233
 234       Function &getFunction() const { return F; }
 235
 236       bool FinishFunction();
 237
 238       /// GetVal - Get a value with the specified name or ID, creating a
 239       /// forward reference record if needed.  This can return null if the value
 240       /// exists but does not have the right type.
 241       Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
 242       Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
 243
 244       /// SetInstName - After an instruction is parsed and inserted into its
 245       /// basic block, this installs its name.
 246       bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
 247                        Instruction *Inst);
 248
 249       /// GetBB - Get a basic block with the specified name or ID, creating a
 250       /// forward reference record if needed.  This can return null if the value
 251       /// is not a BasicBlock.
 252       BasicBlock *GetBB(const std::string &Name, LocTy Loc);
 253       BasicBlock *GetBB(unsigned ID, LocTy Loc);
 254
 255       /// DefineBB - Define the specified basic block, which is either named or
 256       /// unnamed.  If there is an error, this returns null otherwise it returns
 257       /// the block being defined.
 258       BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
 259     };
 260
 261     bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
 262                              PerFunctionState &PFS);
 263
 264     bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
 265     bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
 266                     PerFunctionState &PFS) {
 267       Loc = Lex.getLoc();
 268       return ParseValue(Ty, V, PFS);
 269     }
 270
 271     bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
 272     bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
 273       Loc = Lex.getLoc();
 274       return ParseTypeAndValue(V, PFS);
 275     }
 276     bool ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
 277                                 PerFunctionState &PFS);
 278     bool ParseTypeAndBasicBlock(BasicBlock *&BB, PerFunctionState &PFS) {
 279       LocTy Loc;
 280       return ParseTypeAndBasicBlock(BB, Loc, PFS);
 281     }
 282
 283     struct ParamInfo {
 284       LocTy Loc;
 285       Value *V;
 286       unsigned Attrs;
 287       ParamInfo(LocTy loc, Value *v, unsigned attrs)
 288         : Loc(loc), V(v), Attrs(attrs) {}
 289     };
 290     bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
 291                             PerFunctionState &PFS);
 292
 293     // Constant Parsing.
 294     bool ParseValID(ValID &ID, PerFunctionState *PFS = NULL);
 295     bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
 296     bool ConvertGlobalOrMetadataValIDToValue(const Type *Ty, ValID &ID,
 297                                              Value *&V, PerFunctionState *PFS);
 298     bool ParseGlobalValue(const Type *Ty, Constant *&V);
 299     bool ParseGlobalTypeAndValue(Constant *&V);
 300     bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
 301     bool ParseMDNodeVector(SmallVectorImpl<Value*> &, PerFunctionState *PFS);
 302
 303     // Function Parsing.
 304     struct ArgInfo {
 305       LocTy Loc;
 306       PATypeHolder Type;
 307       unsigned Attrs;
 308       std::string Name;
 309       ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
 310         : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
 311     };
 312     bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
 313                            bool &isVarArg, bool inType);
 314     bool ParseFunctionHeader(Function *&Fn, bool isDefine);
 315     bool ParseFunctionBody(Function &Fn);
 316     bool ParseBasicBlock(PerFunctionState &PFS);
 317
 318     // Instruction Parsing.  Each instruction parsing routine can return with a
 319     // normal result, an error result, or return having eaten an extra comma.
 320     enum InstResult { InstNormal = 0, InstError = 1, InstExtraComma = 2 };
 321     int ParseInstruction(Instruction *&Inst, BasicBlock *BB,
 322                          PerFunctionState &PFS);
 323     bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
 324
 325     int ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
 326     bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
 327     bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
 328     bool ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS);
 329     bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
 330
 331     bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
 332                          unsigned OperandType);
 333     bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 334     bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 335     bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 336     bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
 337     bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
 338     bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
 339     bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
 340     bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
 341     int ParsePHI(Instruction *&I, PerFunctionState &PFS);
 342     bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
 343     int ParseAlloc(Instruction *&I, PerFunctionState &PFS,
 344                     BasicBlock *BB = 0, bool isAlloca = true);
 345     bool ParseFree(Instruction *&I, PerFunctionState &PFS, BasicBlock *BB);
 346     int ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
 347     int ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
 348     bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
 349     int ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
 350     int ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
 351     int ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
 352
 353     bool ResolveForwardRefBlockAddresses(Function *TheFn,
 354                              std::vector<std::pair<ValID, GlobalValue*> > &Refs,
 355                                          PerFunctionState *PFS);
 356   };
 357 } // End llvm namespace
 358
 359 #endif