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 <map>
  21
  22 namespace llvm {
  23   class Module;
  24   class OpaqueType;
  25   class Function;
  26   class Value;
  27   class BasicBlock;
  28   class Instruction;
  29   class Constant;
  30   class GlobalValue;
  31   class MetadataBase;
  32   class MDString;
  33   class MDNode;
  34   struct ValID;
  35
  36   class LLParser {
  37   public:
  38     typedef LLLexer::LocTy LocTy;
  39   private:
  40     LLVMContext& Context;
  41     LLLexer Lex;
  42     Module *M;
  43
  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, Constant *> MetadataCache;
  50     std::map<unsigned, std::pair<Constant *, LocTy> > ForwardRefMDNodes;
  51
  52     struct UpRefRecord {
  53       /// Loc - This is the location of the upref.
  54       LocTy Loc;
  55
  56       /// NestingLevel - The number of nesting levels that need to be popped
  57       /// before this type is resolved.
  58       unsigned NestingLevel;
  59
  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;
  63
  64       /// UpRefTy - This is the actual opaque type that the upreference is
  65       /// represented with.
  66       OpaqueType *UpRefTy;
  67
  68       UpRefRecord(LocTy L, unsigned NL, OpaqueType *URTy)
  69         : Loc(L), NestingLevel(NL), LastContainedTy((Type*)URTy),
  70           UpRefTy(URTy) {}
  71     };
  72     std::vector<UpRefRecord> UpRefs;
  73
  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;
  78   public:
  79     LLParser(MemoryBuffer *F, SourceMgr &SM, SMDiagnostic &Err, Module *m) :
  80       Context(m->getContext()), Lex(F, SM, Err, m->getContext()), M(m) {}
  81     bool Run();
  82
  83     LLVMContext& getContext() { return Context; }
  84
  85   private:
  86
  87     bool Error(LocTy L, const std::string &Msg) const {
  88       return Lex.Error(L, Msg);
  89     }
  90     bool TokError(const std::string &Msg) const {
  91       return Error(Lex.getLoc(), Msg);
  92     }
  93
  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);
  99
 100     // Helper Routines.
 101     bool ParseToken(lltok::Kind T, const char *ErrMsg);
 102     bool EatIfPresent(lltok::Kind T) {
 103       if (Lex.getKind() != T) return false;
 104       Lex.Lex();
 105       return true;
 106     }
 107     bool ParseOptionalToken(lltok::Kind T, bool &Present) {
 108       if (Lex.getKind() != T) {
 109         Present = false;
 110       } else {
 111         Lex.Lex();
 112         Present = true;
 113       }
 114       return false;
 115     }
 116     bool ParseStringConstant(std::string &Result);
 117     bool ParseUInt32(unsigned &Val);
 118     bool ParseUInt32(unsigned &Val, LocTy &Loc) {
 119       Loc = Lex.getLoc();
 120       return ParseUInt32(Val);
 121     }
 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);
 127     }
 128     bool ParseOptionalVisibility(unsigned &Visibility);
 129     bool ParseOptionalCallingConv(unsigned &CC);
 130     bool ParseOptionalAlignment(unsigned &Alignment);
 131     bool ParseOptionalCommaAlignment(unsigned &Alignment);
 132     bool ParseIndexList(SmallVectorImpl<unsigned> &Indices);
 133
 134     // Top-Level Entities
 135     bool ParseTopLevelEntities();
 136     bool ValidateEndOfModule();
 137     bool ParseTargetDefinition();
 138     bool ParseDepLibs();
 139     bool ParseModuleAsm();
 140     bool ParseUnnamedType();
 141     bool ParseNamedType();
 142     bool ParseDeclare();
 143     bool ParseDefine();
 144
 145     bool ParseGlobalType(bool &IsConstant);
 146     bool ParseNamedGlobal();
 147     bool ParseGlobal(const std::string &Name, LocTy Loc, unsigned Linkage,
 148                      bool HasLinkage, unsigned Visibility);
 149     bool ParseAlias(const std::string &Name, LocTy Loc, unsigned Visibility);
 150     bool ParseStandaloneMetadata();
 151     bool ParseMDString(MetadataBase *&S);
 152     bool ParseMDNode(Constant *&N);
 153
 154     // Type Parsing.
 155     bool ParseType(PATypeHolder &Result, bool AllowVoid = false);
 156     bool ParseType(PATypeHolder &Result, LocTy &Loc, bool AllowVoid = false) {
 157       Loc = Lex.getLoc();
 158       return ParseType(Result, AllowVoid);
 159     }
 160     bool ParseTypeRec(PATypeHolder &H);
 161     bool ParseStructType(PATypeHolder &H, bool Packed);
 162     bool ParseArrayVectorType(PATypeHolder &H, bool isVector);
 163     bool ParseFunctionType(PATypeHolder &Result);
 164     PATypeHolder HandleUpRefs(const Type *Ty);
 165
 166     // Constants.
 167     bool ParseValID(ValID &ID);
 168     bool ConvertGlobalValIDToValue(const Type *Ty, ValID &ID, Constant *&V);
 169     bool ParseGlobalValue(const Type *Ty, Constant *&V);
 170     bool ParseGlobalTypeAndValue(Constant *&V);
 171     bool ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts);
 172     bool ParseMDNodeVector(SmallVectorImpl<Value*> &);
 173
 174
 175     // Function Semantic Analysis.
 176     class PerFunctionState {
 177       LLParser &P;
 178       Function &F;
 179       std::map<std::string, std::pair<Value*, LocTy> > ForwardRefVals;
 180       std::map<unsigned, std::pair<Value*, LocTy> > ForwardRefValIDs;
 181       std::vector<Value*> NumberedVals;
 182     public:
 183       PerFunctionState(LLParser &p, Function &f);
 184       ~PerFunctionState();
 185
 186       Function &getFunction() const { return F; }
 187
 188       bool VerifyFunctionComplete();
 189
 190       /// GetVal - Get a value with the specified name or ID, creating a
 191       /// forward reference record if needed.  This can return null if the value
 192       /// exists but does not have the right type.
 193       Value *GetVal(const std::string &Name, const Type *Ty, LocTy Loc);
 194       Value *GetVal(unsigned ID, const Type *Ty, LocTy Loc);
 195
 196       /// SetInstName - After an instruction is parsed and inserted into its
 197       /// basic block, this installs its name.
 198       bool SetInstName(int NameID, const std::string &NameStr, LocTy NameLoc,
 199                        Instruction *Inst);
 200
 201       /// GetBB - Get a basic block with the specified name or ID, creating a
 202       /// forward reference record if needed.  This can return null if the value
 203       /// is not a BasicBlock.
 204       BasicBlock *GetBB(const std::string &Name, LocTy Loc);
 205       BasicBlock *GetBB(unsigned ID, LocTy Loc);
 206
 207       /// DefineBB - Define the specified basic block, which is either named or
 208       /// unnamed.  If there is an error, this returns null otherwise it returns
 209       /// the block being defined.
 210       BasicBlock *DefineBB(const std::string &Name, LocTy Loc);
 211     };
 212
 213     bool ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
 214                              PerFunctionState &PFS);
 215
 216     bool ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS);
 217     bool ParseValue(const Type *Ty, Value *&V, LocTy &Loc,
 218                     PerFunctionState &PFS) {
 219       Loc = Lex.getLoc();
 220       return ParseValue(Ty, V, PFS);
 221     }
 222
 223     bool ParseTypeAndValue(Value *&V, PerFunctionState &PFS);
 224     bool ParseTypeAndValue(Value *&V, LocTy &Loc, PerFunctionState &PFS) {
 225       Loc = Lex.getLoc();
 226       return ParseTypeAndValue(V, PFS);
 227     }
 228
 229     struct ParamInfo {
 230       LocTy Loc;
 231       Value *V;
 232       unsigned Attrs;
 233       ParamInfo(LocTy loc, Value *v, unsigned attrs)
 234         : Loc(loc), V(v), Attrs(attrs) {}
 235     };
 236     bool ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
 237                             PerFunctionState &PFS);
 238
 239     // Function Parsing.
 240     struct ArgInfo {
 241       LocTy Loc;
 242       PATypeHolder Type;
 243       unsigned Attrs;
 244       std::string Name;
 245       ArgInfo(LocTy L, PATypeHolder Ty, unsigned Attr, const std::string &N)
 246         : Loc(L), Type(Ty), Attrs(Attr), Name(N) {}
 247     };
 248     bool ParseArgumentList(std::vector<ArgInfo> &ArgList,
 249                            bool &isVarArg, bool inType);
 250     bool ParseFunctionHeader(Function *&Fn, bool isDefine);
 251     bool ParseFunctionBody(Function &Fn);
 252     bool ParseBasicBlock(PerFunctionState &PFS);
 253
 254     // Instruction Parsing.
 255     bool ParseInstruction(Instruction *&Inst, BasicBlock *BB,
 256                           PerFunctionState &PFS);
 257     bool ParseCmpPredicate(unsigned &Pred, unsigned Opc);
 258
 259     bool ParseRet(Instruction *&Inst, BasicBlock *BB, PerFunctionState &PFS);
 260     bool ParseBr(Instruction *&Inst, PerFunctionState &PFS);
 261     bool ParseSwitch(Instruction *&Inst, PerFunctionState &PFS);
 262     bool ParseInvoke(Instruction *&Inst, PerFunctionState &PFS);
 263
 264     bool ParseArithmetic(Instruction *&I, PerFunctionState &PFS, unsigned Opc,
 265                          unsigned OperandType);
 266     bool ParseLogical(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 267     bool ParseCompare(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 268     bool ParseCast(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 269     bool ParseSelect(Instruction *&I, PerFunctionState &PFS);
 270     bool ParseVA_Arg(Instruction *&I, PerFunctionState &PFS);
 271     bool ParseExtractElement(Instruction *&I, PerFunctionState &PFS);
 272     bool ParseInsertElement(Instruction *&I, PerFunctionState &PFS);
 273     bool ParseShuffleVector(Instruction *&I, PerFunctionState &PFS);
 274     bool ParsePHI(Instruction *&I, PerFunctionState &PFS);
 275     bool ParseCall(Instruction *&I, PerFunctionState &PFS, bool isTail);
 276     bool ParseAlloc(Instruction *&I, PerFunctionState &PFS, unsigned Opc);
 277     bool ParseFree(Instruction *&I, PerFunctionState &PFS);
 278     bool ParseLoad(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
 279     bool ParseStore(Instruction *&I, PerFunctionState &PFS, bool isVolatile);
 280     bool ParseGetResult(Instruction *&I, PerFunctionState &PFS);
 281     bool ParseGetElementPtr(Instruction *&I, PerFunctionState &PFS);
 282     bool ParseExtractValue(Instruction *&I, PerFunctionState &PFS);
 283     bool ParseInsertValue(Instruction *&I, PerFunctionState &PFS);
 284   };
 285 } // End llvm namespace
 286
 287 #endif