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