lib/Bitcode/Reader/BitcodeReader.h

   1 //===- BitcodeReader.h - Internal BitcodeReader impl ------------*- 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 header defines the BitcodeReader class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef BITCODE_READER_H
  15 #define BITCODE_READER_H
  16
  17 #include "llvm/ModuleProvider.h"
  18 #include "llvm/ParameterAttributes.h"
  19 #include "llvm/Type.h"
  20 #include "llvm/User.h"
  21 #include "llvm/Bitcode/BitstreamReader.h"
  22 #include "llvm/Bitcode/LLVMBitCodes.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include <vector>
  25
  26 namespace llvm {
  27   class MemoryBuffer;
  28
  29 class BitcodeReaderValueList : public User {
  30   std::vector<Use> Uses;
  31 public:
  32   BitcodeReaderValueList() : User(Type::VoidTy, Value::ArgumentVal, 0, 0) {}
  33
  34   // vector compatibility methods
  35   unsigned size() const { return getNumOperands(); }
  36   void push_back(Value *V) {
  37     Uses.push_back(Use(V, this));
  38     OperandList = &Uses[0];
  39     ++NumOperands;
  40   }
  41
  42   void clear() {
  43     std::vector<Use>().swap(Uses);
  44   }
  45
  46   Value *operator[](unsigned i) const { return getOperand(i); }
  47
  48   Value *back() const { return Uses.back(); }
  49   void pop_back() { Uses.pop_back(); --NumOperands; }
  50   bool empty() const { return NumOperands == 0; }
  51   void shrinkTo(unsigned N) {
  52     assert(N <= NumOperands && "Invalid shrinkTo request!");
  53     Uses.resize(N);
  54     NumOperands = N;
  55   }
  56   virtual void print(std::ostream&) const {}
  57
  58   Constant *getConstantFwdRef(unsigned Idx, const Type *Ty);
  59   Value *getValueFwdRef(unsigned Idx, const Type *Ty);
  60
  61   void AssignValue(Value *V, unsigned Idx) {
  62     if (Idx == size()) {
  63       push_back(V);
  64     } else if (Value *OldV = getOperand(Idx)) {
  65       // If there was a forward reference to this value, replace it.
  66       setOperand(Idx, V);
  67       OldV->replaceAllUsesWith(V);
  68       delete OldV;
  69     } else {
  70       initVal(Idx, V);
  71     }
  72   }
  73
  74 private:
  75   void initVal(unsigned Idx, Value *V) {
  76     assert(Uses[Idx] == 0 && "Cannot init an already init'd Use!");
  77     Uses[Idx].init(V, this);
  78   }
  79 };
  80
  81
  82 class BitcodeReader : public ModuleProvider {
  83   MemoryBuffer *Buffer;
  84   BitstreamReader Stream;
  85
  86   const char *ErrorString;
  87
  88   std::vector<PATypeHolder> TypeList;
  89   BitcodeReaderValueList ValueList;
  90   std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
  91   std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits;
  92
  93   /// ParamAttrs - The set of parameter attributes by index.  Index zero in the
  94   /// file is for null, and is thus not represented here.  As such all indices
  95   /// are off by one.
  96   std::vector<PAListPtr> ParamAttrs;
  97
  98   /// FunctionBBs - While parsing a function body, this is a list of the basic
  99   /// blocks for the function.
 100   std::vector<BasicBlock*> FunctionBBs;
 101
 102   // When reading the module header, this list is populated with functions that
 103   // have bodies later in the file.
 104   std::vector<Function*> FunctionsWithBodies;
 105
 106   // When intrinsic functions are encountered which require upgrading they are
 107   // stored here with their replacement function.
 108   typedef std::vector<std::pair<Function*, Function*> > UpgradedIntrinsicMap;
 109   UpgradedIntrinsicMap UpgradedIntrinsics;
 110
 111   // After the module header has been read, the FunctionsWithBodies list is
 112   // reversed.  This keeps track of whether we've done this yet.
 113   bool HasReversedFunctionsWithBodies;
 114
 115   /// DeferredFunctionInfo - When function bodies are initially scanned, this
 116   /// map contains info about where to find deferred function body (in the
 117   /// stream) and what linkage the original function had.
 118   DenseMap<Function*, std::pair<uint64_t, unsigned> > DeferredFunctionInfo;
 119 public:
 120   explicit BitcodeReader(MemoryBuffer *buffer)
 121       : Buffer(buffer), ErrorString(0) {
 122     HasReversedFunctionsWithBodies = false;
 123   }
 124   ~BitcodeReader() {
 125     FreeState();
 126   }
 127
 128   void FreeState();
 129
 130   /// releaseMemoryBuffer - This causes the reader to completely forget about
 131   /// the memory buffer it contains, which prevents the buffer from being
 132   /// destroyed when it is deleted.
 133   void releaseMemoryBuffer() {
 134     Buffer = 0;
 135   }
 136
 137   virtual bool materializeFunction(Function *F, std::string *ErrInfo = 0);
 138   virtual Module *materializeModule(std::string *ErrInfo = 0);
 139   virtual void dematerializeFunction(Function *F);
 140   virtual Module *releaseModule(std::string *ErrInfo = 0);
 141
 142   bool Error(const char *Str) {
 143     ErrorString = Str;
 144     return true;
 145   }
 146   const char *getErrorString() const { return ErrorString; }
 147
 148   /// @brief Main interface to parsing a bitcode buffer.
 149   /// @returns true if an error occurred.
 150   bool ParseBitcode();
 151 private:
 152   const Type *getTypeByID(unsigned ID, bool isTypeTable = false);
 153   Value *getFnValueByID(unsigned ID, const Type *Ty) {
 154     return ValueList.getValueFwdRef(ID, Ty);
 155   }
 156   BasicBlock *getBasicBlock(unsigned ID) const {
 157     if (ID >= FunctionBBs.size()) return 0; // Invalid ID
 158     return FunctionBBs[ID];
 159   }
 160   PAListPtr getParamAttrs(unsigned i) const {
 161     if (i-1 < ParamAttrs.size())
 162       return ParamAttrs[i-1];
 163     return PAListPtr();
 164   }
 165
 166   /// getValueTypePair - Read a value/type pair out of the specified record from
 167   /// slot 'Slot'.  Increment Slot past the number of slots used in the record.
 168   /// Return true on failure.
 169   bool getValueTypePair(SmallVector<uint64_t, 64> &Record, unsigned &Slot,
 170                         unsigned InstNum, Value *&ResVal) {
 171     if (Slot == Record.size()) return true;
 172     unsigned ValNo = (unsigned)Record[Slot++];
 173     if (ValNo < InstNum) {
 174       // If this is not a forward reference, just return the value we already
 175       // have.
 176       ResVal = getFnValueByID(ValNo, 0);
 177       return ResVal == 0;
 178     } else if (Slot == Record.size()) {
 179       return true;
 180     }
 181
 182     unsigned TypeNo = (unsigned)Record[Slot++];
 183     ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
 184     return ResVal == 0;
 185   }
 186   bool getValue(SmallVector<uint64_t, 64> &Record, unsigned &Slot,
 187                 const Type *Ty, Value *&ResVal) {
 188     if (Slot == Record.size()) return true;
 189     unsigned ValNo = (unsigned)Record[Slot++];
 190     ResVal = getFnValueByID(ValNo, Ty);
 191     return ResVal == 0;
 192   }
 193
 194
 195   bool ParseModule(const std::string &ModuleID);
 196   bool ParseParamAttrBlock();
 197   bool ParseTypeTable();
 198   bool ParseTypeSymbolTable();
 199   bool ParseValueSymbolTable();
 200   bool ParseConstants();
 201   bool RememberAndSkipFunctionBody();
 202   bool ParseFunctionBody(Function *F);
 203   bool ResolveGlobalAndAliasInits();
 204 };
 205
 206 } // End llvm namespace
 207
 208 #endif