BitcodeReader.h revision 962dde3cef3184f1683d5070c298c9a29509d62e
1caee0dccffb77a003681345ab3281bcf8684526cChris Lattner//===- BitcodeReader.h - Internal BitcodeReader impl ------------*- C++ -*-===// 2caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// 3caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// The LLVM Compiler Infrastructure 4caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// 54ee451de366474b9c228b4e5fa573795a715216dChris Lattner// This file is distributed under the University of Illinois Open Source 64ee451de366474b9c228b4e5fa573795a715216dChris Lattner// License. See LICENSE.TXT for details. 7caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// 8caee0dccffb77a003681345ab3281bcf8684526cChris Lattner//===----------------------------------------------------------------------===// 9caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// 10caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// This header defines the BitcodeReader class. 11caee0dccffb77a003681345ab3281bcf8684526cChris Lattner// 12caee0dccffb77a003681345ab3281bcf8684526cChris Lattner//===----------------------------------------------------------------------===// 13caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 14caee0dccffb77a003681345ab3281bcf8684526cChris Lattner#ifndef BITCODE_READER_H 15caee0dccffb77a003681345ab3281bcf8684526cChris Lattner#define BITCODE_READER_H 16caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 17caee0dccffb77a003681345ab3281bcf8684526cChris Lattner#include "llvm/ModuleProvider.h" 18eaf42abab6d465c38891345d999255871cf03943Devang Patel#include "llvm/Attributes.h" 19522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner#include "llvm/Type.h" 20efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif#include "llvm/OperandTraits.h" 2148f848716e80d01619b239111db48bfac77baad1Chris Lattner#include "llvm/Bitcode/BitstreamReader.h" 2247f96bf24687b5068aec7166cb8b3ac33ae964aeChris Lattner#include "llvm/Bitcode/LLVMBitCodes.h" 2346e7740a4433383e6e5561f089a091c22125bd07Chris Lattner#include "llvm/Support/ValueHandle.h" 2448f848716e80d01619b239111db48bfac77baad1Chris Lattner#include "llvm/ADT/DenseMap.h" 25caee0dccffb77a003681345ab3281bcf8684526cChris Lattner#include <vector> 26caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 27caee0dccffb77a003681345ab3281bcf8684526cChris Lattnernamespace llvm { 28c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner class MemoryBuffer; 29522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 30efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif//===----------------------------------------------------------------------===// 31efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif// BitcodeReaderValueList Class 32efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif//===----------------------------------------------------------------------===// 33efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif 3446e7740a4433383e6e5561f089a091c22125bd07Chris Lattnerclass BitcodeReaderValueList { 3546e7740a4433383e6e5561f089a091c22125bd07Chris Lattner std::vector<WeakVH> ValuePtrs; 36ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner 37ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// ResolveConstants - As we resolve forward-referenced constants, we add 38ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// information about them to this vector. This allows us to resolve them in 39ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// bulk instead of resolving each reference at a time. See the code in 40ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// ResolveConstantForwardRefs for more information about this. 41ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// 42ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// The key of this vector is the placeholder constant, the value is the slot 43ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// number that holds the resolved value. 44ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy; 45ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner ResolveConstantsTy ResolveConstants; 46522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattnerpublic: 4746e7740a4433383e6e5561f089a091c22125bd07Chris Lattner BitcodeReaderValueList() {} 48ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner ~BitcodeReaderValueList() { 49ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner assert(ResolveConstants.empty() && "Constants not resolved?"); 50ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner } 51efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif 52522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner // vector compatibility methods 5346e7740a4433383e6e5561f089a091c22125bd07Chris Lattner unsigned size() const { return ValuePtrs.size(); } 5446e7740a4433383e6e5561f089a091c22125bd07Chris Lattner void resize(unsigned N) { ValuePtrs.resize(N); } 55522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner void push_back(Value *V) { 5646e7740a4433383e6e5561f089a091c22125bd07Chris Lattner ValuePtrs.push_back(V); 57522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner } 58522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 59b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner void clear() { 60ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner assert(ResolveConstants.empty() && "Constants not resolved?"); 6146e7740a4433383e6e5561f089a091c22125bd07Chris Lattner ValuePtrs.clear(); 62b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner } 63b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner 6446e7740a4433383e6e5561f089a091c22125bd07Chris Lattner Value *operator[](unsigned i) const { 6546e7740a4433383e6e5561f089a091c22125bd07Chris Lattner assert(i < ValuePtrs.size()); 6646e7740a4433383e6e5561f089a091c22125bd07Chris Lattner return ValuePtrs[i]; 6746e7740a4433383e6e5561f089a091c22125bd07Chris Lattner } 68522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 6946e7740a4433383e6e5561f089a091c22125bd07Chris Lattner Value *back() const { return ValuePtrs.back(); } 7046e7740a4433383e6e5561f089a091c22125bd07Chris Lattner void pop_back() { ValuePtrs.pop_back(); } 7146e7740a4433383e6e5561f089a091c22125bd07Chris Lattner bool empty() const { return ValuePtrs.empty(); } 72198f34ac359c48018c6e1f784cf3770ead63b253Chris Lattner void shrinkTo(unsigned N) { 7346e7740a4433383e6e5561f089a091c22125bd07Chris Lattner assert(N <= size() && "Invalid shrinkTo request!"); 7446e7740a4433383e6e5561f089a091c22125bd07Chris Lattner ValuePtrs.resize(N); 75198f34ac359c48018c6e1f784cf3770ead63b253Chris Lattner } 76522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 77522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner Constant *getConstantFwdRef(unsigned Idx, const Type *Ty); 78a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner Value *getValueFwdRef(unsigned Idx, const Type *Ty); 79a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner 8046e7740a4433383e6e5561f089a091c22125bd07Chris Lattner void AssignValue(Value *V, unsigned Idx); 81a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner 82ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// ResolveConstantForwardRefs - Once all constants are read, this method bulk 83ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// resolves any forward references. 84ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner void ResolveConstantForwardRefs(); 85efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif}; 86efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif 87caee0dccffb77a003681345ab3281bcf8684526cChris Lattnerclass BitcodeReader : public ModuleProvider { 88c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner MemoryBuffer *Buffer; 89962dde3cef3184f1683d5070c298c9a29509d62eChris Lattner BitstreamReader StreamFile; 90962dde3cef3184f1683d5070c298c9a29509d62eChris Lattner BitstreamCursor Stream; 9148f848716e80d01619b239111db48bfac77baad1Chris Lattner 92caee0dccffb77a003681345ab3281bcf8684526cChris Lattner const char *ErrorString; 93caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 94caee0dccffb77a003681345ab3281bcf8684526cChris Lattner std::vector<PATypeHolder> TypeList; 95522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner BitcodeReaderValueList ValueList; 96e16504eb4ef8f09611cdf6e9a0be9eb886b4ed89Chris Lattner std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits; 9707d98b4afbdcbb4eed048400d9116de1ec83e866Chris Lattner std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits; 9848f848716e80d01619b239111db48bfac77baad1Chris Lattner 9919c874638d9478a5d5028854817a5ee72293bb2bDevang Patel /// MAttributes - The set of attributes by index. Index zero in the 10048c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner /// file is for null, and is thus not represented here. As such all indices 10148c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner /// are off by one. 10219c874638d9478a5d5028854817a5ee72293bb2bDevang Patel std::vector<AttrListPtr> MAttributes; 10348c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner 104980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner /// FunctionBBs - While parsing a function body, this is a list of the basic 105980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner /// blocks for the function. 106980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner std::vector<BasicBlock*> FunctionBBs; 107980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner 10848f848716e80d01619b239111db48bfac77baad1Chris Lattner // When reading the module header, this list is populated with functions that 10948f848716e80d01619b239111db48bfac77baad1Chris Lattner // have bodies later in the file. 11048f848716e80d01619b239111db48bfac77baad1Chris Lattner std::vector<Function*> FunctionsWithBodies; 1116994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth 1126994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth // When intrinsic functions are encountered which require upgrading they are 1136994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth // stored here with their replacement function. 1146994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth typedef std::vector<std::pair<Function*, Function*> > UpgradedIntrinsicMap; 1156994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth UpgradedIntrinsicMap UpgradedIntrinsics; 11648f848716e80d01619b239111db48bfac77baad1Chris Lattner 11748f848716e80d01619b239111db48bfac77baad1Chris Lattner // After the module header has been read, the FunctionsWithBodies list is 11848f848716e80d01619b239111db48bfac77baad1Chris Lattner // reversed. This keeps track of whether we've done this yet. 11948f848716e80d01619b239111db48bfac77baad1Chris Lattner bool HasReversedFunctionsWithBodies; 12048f848716e80d01619b239111db48bfac77baad1Chris Lattner 12148f848716e80d01619b239111db48bfac77baad1Chris Lattner /// DeferredFunctionInfo - When function bodies are initially scanned, this 12248f848716e80d01619b239111db48bfac77baad1Chris Lattner /// map contains info about where to find deferred function body (in the 12348f848716e80d01619b239111db48bfac77baad1Chris Lattner /// stream) and what linkage the original function had. 12448f848716e80d01619b239111db48bfac77baad1Chris Lattner DenseMap<Function*, std::pair<uint64_t, unsigned> > DeferredFunctionInfo; 125caee0dccffb77a003681345ab3281bcf8684526cChris Lattnerpublic: 126950a4c40b823cd4f09dc71be635229246dfd6cacDan Gohman explicit BitcodeReader(MemoryBuffer *buffer) 127950a4c40b823cd4f09dc71be635229246dfd6cacDan Gohman : Buffer(buffer), ErrorString(0) { 12848f848716e80d01619b239111db48bfac77baad1Chris Lattner HasReversedFunctionsWithBodies = false; 12948f848716e80d01619b239111db48bfac77baad1Chris Lattner } 130b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner ~BitcodeReader() { 131b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner FreeState(); 132b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner } 133caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 134b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner void FreeState(); 135c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner 136c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner /// releaseMemoryBuffer - This causes the reader to completely forget about 137c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner /// the memory buffer it contains, which prevents the buffer from being 138c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner /// destroyed when it is deleted. 139c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner void releaseMemoryBuffer() { 140c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner Buffer = 0; 141c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner } 142caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 14348f848716e80d01619b239111db48bfac77baad1Chris Lattner virtual bool materializeFunction(Function *F, std::string *ErrInfo = 0); 144980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner virtual Module *materializeModule(std::string *ErrInfo = 0); 145d67c632d968157e228cf42b588f8759059730ec0Chris Lattner virtual void dematerializeFunction(Function *F); 146b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner virtual Module *releaseModule(std::string *ErrInfo = 0); 147d67c632d968157e228cf42b588f8759059730ec0Chris Lattner 148caee0dccffb77a003681345ab3281bcf8684526cChris Lattner bool Error(const char *Str) { 149caee0dccffb77a003681345ab3281bcf8684526cChris Lattner ErrorString = Str; 150caee0dccffb77a003681345ab3281bcf8684526cChris Lattner return true; 151caee0dccffb77a003681345ab3281bcf8684526cChris Lattner } 152caee0dccffb77a003681345ab3281bcf8684526cChris Lattner const char *getErrorString() const { return ErrorString; } 153caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 154caee0dccffb77a003681345ab3281bcf8684526cChris Lattner /// @brief Main interface to parsing a bitcode buffer. 155caee0dccffb77a003681345ab3281bcf8684526cChris Lattner /// @returns true if an error occurred. 156c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner bool ParseBitcode(); 157caee0dccffb77a003681345ab3281bcf8684526cChris Lattnerprivate: 158caee0dccffb77a003681345ab3281bcf8684526cChris Lattner const Type *getTypeByID(unsigned ID, bool isTypeTable = false); 159a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner Value *getFnValueByID(unsigned ID, const Type *Ty) { 160a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner return ValueList.getValueFwdRef(ID, Ty); 161a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner } 162f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner BasicBlock *getBasicBlock(unsigned ID) const { 163f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner if (ID >= FunctionBBs.size()) return 0; // Invalid ID 164f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner return FunctionBBs[ID]; 165f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner } 1660598866c052147c31b808391f58434ce3dbfb838Devang Patel AttrListPtr getAttributes(unsigned i) const { 16719c874638d9478a5d5028854817a5ee72293bb2bDevang Patel if (i-1 < MAttributes.size()) 16819c874638d9478a5d5028854817a5ee72293bb2bDevang Patel return MAttributes[i-1]; 1690598866c052147c31b808391f58434ce3dbfb838Devang Patel return AttrListPtr(); 17048c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner } 1717337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner 1727337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner /// getValueTypePair - Read a value/type pair out of the specified record from 1737337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner /// slot 'Slot'. Increment Slot past the number of slots used in the record. 1747337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner /// Return true on failure. 1757337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner bool getValueTypePair(SmallVector<uint64_t, 64> &Record, unsigned &Slot, 1767337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner unsigned InstNum, Value *&ResVal) { 1777337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner if (Slot == Record.size()) return true; 178650c938c41adc95e0935c75d7ed4349c46d280d1Jeff Cohen unsigned ValNo = (unsigned)Record[Slot++]; 1797337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner if (ValNo < InstNum) { 1807337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner // If this is not a forward reference, just return the value we already 1817337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner // have. 1827337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner ResVal = getFnValueByID(ValNo, 0); 1837337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return ResVal == 0; 1847337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } else if (Slot == Record.size()) { 1857337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return true; 1867337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } 1877337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner 188650c938c41adc95e0935c75d7ed4349c46d280d1Jeff Cohen unsigned TypeNo = (unsigned)Record[Slot++]; 1897337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo)); 1907337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return ResVal == 0; 1917337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } 1927337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner bool getValue(SmallVector<uint64_t, 64> &Record, unsigned &Slot, 1937337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner const Type *Ty, Value *&ResVal) { 1947337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner if (Slot == Record.size()) return true; 195650c938c41adc95e0935c75d7ed4349c46d280d1Jeff Cohen unsigned ValNo = (unsigned)Record[Slot++]; 1967337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner ResVal = getFnValueByID(ValNo, Ty); 1977337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return ResVal == 0; 1987337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } 19948c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner 200caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 201866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseModule(const std::string &ModuleID); 2020598866c052147c31b808391f58434ce3dbfb838Devang Patel bool ParseAttributeBlock(); 203866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseTypeTable(); 204866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseTypeSymbolTable(); 205866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseValueSymbolTable(); 206866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseConstants(); 207980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner bool RememberAndSkipFunctionBody(); 208980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner bool ParseFunctionBody(Function *F); 20907d98b4afbdcbb4eed048400d9116de1ec83e866Chris Lattner bool ResolveGlobalAndAliasInits(); 210caee0dccffb77a003681345ab3281bcf8684526cChris Lattner}; 211caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 212caee0dccffb77a003681345ab3281bcf8684526cChris Lattner} // End llvm namespace 213caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 214caee0dccffb77a003681345ab3281bcf8684526cChris Lattner#endif 215