BitcodeReader.h revision 7b8d94933d6c04ae11bc4607cab61b7d712c5c10
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 17f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin#include "llvm/GVMaterializer.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; 2912ddd409535b52a7fa5157ded9a4cedd161fedb6Benjamin Kramer class LLVMContext; 30522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 31efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif//===----------------------------------------------------------------------===// 32efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif// BitcodeReaderValueList Class 33efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif//===----------------------------------------------------------------------===// 34efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif 3546e7740a4433383e6e5561f089a091c22125bd07Chris Lattnerclass BitcodeReaderValueList { 3646e7740a4433383e6e5561f089a091c22125bd07Chris Lattner std::vector<WeakVH> ValuePtrs; 37ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner 38ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// ResolveConstants - As we resolve forward-referenced constants, we add 39ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// information about them to this vector. This allows us to resolve them in 40ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// bulk instead of resolving each reference at a time. See the code in 41ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// ResolveConstantForwardRefs for more information about this. 42ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// 43ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// The key of this vector is the placeholder constant, the value is the slot 44ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// number that holds the resolved value. 45ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy; 46ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner ResolveConstantsTy ResolveConstants; 477af453a3bdc069ef769c3d3ba02f57b4271c56d0Chris Lattner LLVMContext &Context; 48522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattnerpublic: 497af453a3bdc069ef769c3d3ba02f57b4271c56d0Chris Lattner BitcodeReaderValueList(LLVMContext &C) : Context(C) {} 50ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner ~BitcodeReaderValueList() { 51ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner assert(ResolveConstants.empty() && "Constants not resolved?"); 52ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner } 53efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif 54522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner // vector compatibility methods 5546e7740a4433383e6e5561f089a091c22125bd07Chris Lattner unsigned size() const { return ValuePtrs.size(); } 5646e7740a4433383e6e5561f089a091c22125bd07Chris Lattner void resize(unsigned N) { ValuePtrs.resize(N); } 57522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner void push_back(Value *V) { 5846e7740a4433383e6e5561f089a091c22125bd07Chris Lattner ValuePtrs.push_back(V); 59522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner } 60522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 61b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner void clear() { 62ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner assert(ResolveConstants.empty() && "Constants not resolved?"); 6346e7740a4433383e6e5561f089a091c22125bd07Chris Lattner ValuePtrs.clear(); 64b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner } 65b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner 6646e7740a4433383e6e5561f089a091c22125bd07Chris Lattner Value *operator[](unsigned i) const { 6746e7740a4433383e6e5561f089a091c22125bd07Chris Lattner assert(i < ValuePtrs.size()); 6846e7740a4433383e6e5561f089a091c22125bd07Chris Lattner return ValuePtrs[i]; 6946e7740a4433383e6e5561f089a091c22125bd07Chris Lattner } 70522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 7146e7740a4433383e6e5561f089a091c22125bd07Chris Lattner Value *back() const { return ValuePtrs.back(); } 7246e7740a4433383e6e5561f089a091c22125bd07Chris Lattner void pop_back() { ValuePtrs.pop_back(); } 7346e7740a4433383e6e5561f089a091c22125bd07Chris Lattner bool empty() const { return ValuePtrs.empty(); } 74198f34ac359c48018c6e1f784cf3770ead63b253Chris Lattner void shrinkTo(unsigned N) { 7546e7740a4433383e6e5561f089a091c22125bd07Chris Lattner assert(N <= size() && "Invalid shrinkTo request!"); 7646e7740a4433383e6e5561f089a091c22125bd07Chris Lattner ValuePtrs.resize(N); 77198f34ac359c48018c6e1f784cf3770ead63b253Chris Lattner } 78522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner 79db125cfaf57cc83e7dd7453de2d509bc8efd0e5eChris Lattner Constant *getConstantFwdRef(unsigned Idx, Type *Ty); 80db125cfaf57cc83e7dd7453de2d509bc8efd0e5eChris Lattner Value *getValueFwdRef(unsigned Idx, Type *Ty); 81a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner 8246e7740a4433383e6e5561f089a091c22125bd07Chris Lattner void AssignValue(Value *V, unsigned Idx); 83a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner 84ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// ResolveConstantForwardRefs - Once all constants are read, this method bulk 85ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner /// resolves any forward references. 86ea693dfab48ee6fc07cc21abc20f487df5057a6bChris Lattner void ResolveConstantForwardRefs(); 87efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif}; 88efe65369a74871c3140a540a6c95ce5d1f080954Gabor Greif 89d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 90d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel//===----------------------------------------------------------------------===// 91d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel// BitcodeReaderMDValueList Class 92d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel//===----------------------------------------------------------------------===// 93d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 94d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patelclass BitcodeReaderMDValueList { 95d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel std::vector<WeakVH> MDValuePtrs; 96d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 9750b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner LLVMContext &Context; 98d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patelpublic: 99d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel BitcodeReaderMDValueList(LLVMContext& C) : Context(C) {} 100d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 101d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel // vector compatibility methods 102d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel unsigned size() const { return MDValuePtrs.size(); } 103d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel void resize(unsigned N) { MDValuePtrs.resize(N); } 104d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel void push_back(Value *V) { MDValuePtrs.push_back(V); } 105d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel void clear() { MDValuePtrs.clear(); } 106d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel Value *back() const { return MDValuePtrs.back(); } 107d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel void pop_back() { MDValuePtrs.pop_back(); } 108d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel bool empty() const { return MDValuePtrs.empty(); } 109d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 110d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel Value *operator[](unsigned i) const { 111d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel assert(i < MDValuePtrs.size()); 112d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel return MDValuePtrs[i]; 113d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel } 114d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 115d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel void shrinkTo(unsigned N) { 116d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel assert(N <= size() && "Invalid shrinkTo request!"); 117d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel MDValuePtrs.resize(N); 118d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel } 119d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 120d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel Value *getValueFwdRef(unsigned Idx); 121d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel void AssignValue(Value *V, unsigned Idx); 122d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel}; 123d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel 124f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskinclass BitcodeReader : public GVMaterializer { 12550b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner LLVMContext &Context; 126f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin Module *TheModule; 127c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner MemoryBuffer *Buffer; 128f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin bool BufferOwned; 1292ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff OwningPtr<BitstreamReader> StreamFile; 130962dde3cef3184f1683d5070c298c9a29509d62eChris Lattner BitstreamCursor Stream; 1312ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff DataStreamer *LazyStreamer; 1322ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff uint64_t NextUnreadBit; 1332ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool SeenValueSymbolTable; 13448f848716e80d01619b239111db48bfac77baad1Chris Lattner 135caee0dccffb77a003681345ab3281bcf8684526cChris Lattner const char *ErrorString; 136caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 1371afcace3a3a138b1b18e5c6270caa8dae2261ae2Chris Lattner std::vector<Type*> TypeList; 138522b7b104c864da81c19d8b16c43b7a1f6a2fc40Chris Lattner BitcodeReaderValueList ValueList; 139d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel BitcodeReaderMDValueList MDValueList; 140e8e0213cc3daa2d0457c22e4c12e6973f21fc942Devang Patel SmallVector<Instruction *, 64> InstructionList; 141cbbb09687f563fad96fd815a3a89920f436373e4Chad Rosier SmallVector<SmallVector<uint64_t, 64>, 64> UseListRecords; 142e8e0213cc3daa2d0457c22e4c12e6973f21fc942Devang Patel 143e16504eb4ef8f09611cdf6e9a0be9eb886b4ed89Chris Lattner std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits; 14407d98b4afbdcbb4eed048400d9116de1ec83e866Chris Lattner std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits; 14548f848716e80d01619b239111db48bfac77baad1Chris Lattner 14619c874638d9478a5d5028854817a5ee72293bb2bDevang Patel /// MAttributes - The set of attributes by index. Index zero in the 14748c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner /// file is for null, and is thus not represented here. As such all indices 14848c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner /// are off by one. 14919c874638d9478a5d5028854817a5ee72293bb2bDevang Patel std::vector<AttrListPtr> MAttributes; 15048c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner 151980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner /// FunctionBBs - While parsing a function body, this is a list of the basic 152980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner /// blocks for the function. 153980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner std::vector<BasicBlock*> FunctionBBs; 154980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner 15548f848716e80d01619b239111db48bfac77baad1Chris Lattner // When reading the module header, this list is populated with functions that 15648f848716e80d01619b239111db48bfac77baad1Chris Lattner // have bodies later in the file. 15748f848716e80d01619b239111db48bfac77baad1Chris Lattner std::vector<Function*> FunctionsWithBodies; 1586994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth 1596994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth // When intrinsic functions are encountered which require upgrading they are 1606994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth // stored here with their replacement function. 1616994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth typedef std::vector<std::pair<Function*, Function*> > UpgradedIntrinsicMap; 1626994040a952e5fb27605eb3cf29ed86c4e59cf62Chandler Carruth UpgradedIntrinsicMap UpgradedIntrinsics; 16319538d1e9fb4f8198b94f8450c6fc43528d8b868Dan Gohman 16419538d1e9fb4f8198b94f8450c6fc43528d8b868Dan Gohman // Map the bitcode's custom MDKind ID to the Module's MDKind ID. 16519538d1e9fb4f8198b94f8450c6fc43528d8b868Dan Gohman DenseMap<unsigned, unsigned> MDKindMap; 16648f848716e80d01619b239111db48bfac77baad1Chris Lattner 1672ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff // Several operations happen after the module header has been read, but 1682ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff // before function bodies are processed. This keeps track of whether 1692ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff // we've done this yet. 1702ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool SeenFirstFunctionBody; 17148f848716e80d01619b239111db48bfac77baad1Chris Lattner 17248f848716e80d01619b239111db48bfac77baad1Chris Lattner /// DeferredFunctionInfo - When function bodies are initially scanned, this 173f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin /// map contains info about where to find deferred function body in the 174f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin /// stream. 175f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin DenseMap<Function*, uint64_t> DeferredFunctionInfo; 17650b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner 17750b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner /// BlockAddrFwdRefs - These are blockaddr references to basic blocks. These 17850b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner /// are resolved lazily when functions are loaded. 17950b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner typedef std::pair<unsigned, GlobalVariable*> BlockAddrRefTy; 18050b136dae90eb37f9fc9517a8638020db4f04f9cChris Lattner DenseMap<Function*, std::vector<BlockAddrRefTy> > BlockAddrFwdRefs; 1819b10dfb7d6ffb0e4466f908cd7d18212a45cfdacDan Gohman 182d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// UseRelativeIDs - Indicates that we are using a new encoding for 1837b8d94933d6c04ae11bc4607cab61b7d712c5c10Jan Wen Voung /// instruction operands where most operands in the current 184d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// FUNCTION_BLOCK are encoded relative to the instruction number, 185d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// for a more compact encoding. Some instruction operands are not 186d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// relative to the instruction ID: basic block numbers, and types. 187d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// Once the old style function blocks have been phased out, we would 188d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// not need this flag. 189d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung bool UseRelativeIDs; 190d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 191caee0dccffb77a003681345ab3281bcf8684526cChris Lattnerpublic: 192081134741b40b342fb2f85722c9cea5d412489a8Chris Lattner explicit BitcodeReader(MemoryBuffer *buffer, LLVMContext &C) 193f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin : Context(C), TheModule(0), Buffer(buffer), BufferOwned(false), 1940ffe6984297ece417e591003674d4466a201eb2aDerek Schuff LazyStreamer(0), NextUnreadBit(0), SeenValueSymbolTable(false), 1950ffe6984297ece417e591003674d4466a201eb2aDerek Schuff ErrorString(0), ValueList(C), MDValueList(C), 196d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung SeenFirstFunctionBody(false), UseRelativeIDs(false) { 1972ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff } 1982ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff explicit BitcodeReader(DataStreamer *streamer, LLVMContext &C) 1992ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff : Context(C), TheModule(0), Buffer(0), BufferOwned(false), 2000ffe6984297ece417e591003674d4466a201eb2aDerek Schuff LazyStreamer(streamer), NextUnreadBit(0), SeenValueSymbolTable(false), 2010ffe6984297ece417e591003674d4466a201eb2aDerek Schuff ErrorString(0), ValueList(C), MDValueList(C), 202d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung SeenFirstFunctionBody(false), UseRelativeIDs(false) { 20348f848716e80d01619b239111db48bfac77baad1Chris Lattner } 204b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner ~BitcodeReader() { 205b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner FreeState(); 206b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner } 20747f79bb58e42f1a08a7f388b8b1596ded7d49bbbRafael Espindola 20847f79bb58e42f1a08a7f388b8b1596ded7d49bbbRafael Espindola void materializeForwardReferencedFunctions(); 20947f79bb58e42f1a08a7f388b8b1596ded7d49bbbRafael Espindola 210b348bb81253a1105d23ab1a1771f8d2a6546aa1bChris Lattner void FreeState(); 211c453f76e2b4d7fd1e042b5b6d4c20556779186dfChris Lattner 212f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin /// setBufferOwned - If this is true, the reader will destroy the MemoryBuffer 213f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin /// when the reader is destroyed. 214f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin void setBufferOwned(bool Owned) { BufferOwned = Owned; } 215caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 216f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin virtual bool isMaterializable(const GlobalValue *GV) const; 217f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin virtual bool isDematerializable(const GlobalValue *GV) const; 218f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin virtual bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0); 219f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin virtual bool MaterializeModule(Module *M, std::string *ErrInfo = 0); 220f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin virtual void Dematerialize(GlobalValue *GV); 221d67c632d968157e228cf42b588f8759059730ec0Chris Lattner 222caee0dccffb77a003681345ab3281bcf8684526cChris Lattner bool Error(const char *Str) { 223caee0dccffb77a003681345ab3281bcf8684526cChris Lattner ErrorString = Str; 224caee0dccffb77a003681345ab3281bcf8684526cChris Lattner return true; 225caee0dccffb77a003681345ab3281bcf8684526cChris Lattner } 226caee0dccffb77a003681345ab3281bcf8684526cChris Lattner const char *getErrorString() const { return ErrorString; } 227caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 228caee0dccffb77a003681345ab3281bcf8684526cChris Lattner /// @brief Main interface to parsing a bitcode buffer. 229caee0dccffb77a003681345ab3281bcf8684526cChris Lattner /// @returns true if an error occurred. 230f0356fe140af1a30587b9a86bcfb1b2c51b8ce20Jeffrey Yasskin bool ParseBitcodeInto(Module *M); 23134711747a1d2c8713e69333bacef1c880810e371Bill Wendling 23234711747a1d2c8713e69333bacef1c880810e371Bill Wendling /// @brief Cheap mechanism to just extract module triple 23334711747a1d2c8713e69333bacef1c880810e371Bill Wendling /// @returns true if an error occurred. 23434711747a1d2c8713e69333bacef1c880810e371Bill Wendling bool ParseTriple(std::string &Triple); 235d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 236d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung static uint64_t decodeSignRotatedValue(uint64_t V); 237d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 238caee0dccffb77a003681345ab3281bcf8684526cChris Lattnerprivate: 2391afcace3a3a138b1b18e5c6270caa8dae2261ae2Chris Lattner Type *getTypeByID(unsigned ID); 240db125cfaf57cc83e7dd7453de2d509bc8efd0e5eChris Lattner Value *getFnValueByID(unsigned ID, Type *Ty) { 241cbd40f8357437a15c653cb8cccd7124a1bb55ae2Chris Lattner if (Ty && Ty->isMetadataTy()) 242d5ac40457b62f37f0abfb1d61064f7c7300e91eeDevang Patel return MDValueList.getValueFwdRef(ID); 2437af453a3bdc069ef769c3d3ba02f57b4271c56d0Chris Lattner return ValueList.getValueFwdRef(ID, Ty); 244a7c49aac984fafa5dfdfcc2762d4d51b26788e38Chris Lattner } 245f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner BasicBlock *getBasicBlock(unsigned ID) const { 246f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner if (ID >= FunctionBBs.size()) return 0; // Invalid ID 247f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner return FunctionBBs[ID]; 248f4c8e5243376af58e52c4a0930d838509bbbea2fChris Lattner } 2490598866c052147c31b808391f58434ce3dbfb838Devang Patel AttrListPtr getAttributes(unsigned i) const { 25019c874638d9478a5d5028854817a5ee72293bb2bDevang Patel if (i-1 < MAttributes.size()) 25119c874638d9478a5d5028854817a5ee72293bb2bDevang Patel return MAttributes[i-1]; 2520598866c052147c31b808391f58434ce3dbfb838Devang Patel return AttrListPtr(); 25348c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner } 2547337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner 2557337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner /// getValueTypePair - Read a value/type pair out of the specified record from 2567337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner /// slot 'Slot'. Increment Slot past the number of slots used in the record. 2577337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner /// Return true on failure. 2587337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner bool getValueTypePair(SmallVector<uint64_t, 64> &Record, unsigned &Slot, 2597337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner unsigned InstNum, Value *&ResVal) { 2607337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner if (Slot == Record.size()) return true; 261650c938c41adc95e0935c75d7ed4349c46d280d1Jeff Cohen unsigned ValNo = (unsigned)Record[Slot++]; 262d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung // Adjust the ValNo, if it was encoded relative to the InstNum. 263d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung if (UseRelativeIDs) 264d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung ValNo = InstNum - ValNo; 2657337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner if (ValNo < InstNum) { 2667337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner // If this is not a forward reference, just return the value we already 2677337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner // have. 2687337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner ResVal = getFnValueByID(ValNo, 0); 2697337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return ResVal == 0; 2707337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } else if (Slot == Record.size()) { 2717337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return true; 2727337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } 273d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 274650c938c41adc95e0935c75d7ed4349c46d280d1Jeff Cohen unsigned TypeNo = (unsigned)Record[Slot++]; 2757337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo)); 2767337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return ResVal == 0; 2777337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } 278d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 279d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// popValue - Read a value out of the specified record from slot 'Slot'. 280d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// Increment Slot past the number of slots used by the value in the record. 281d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// Return true if there is an error. 282d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung bool popValue(SmallVector<uint64_t, 64> &Record, unsigned &Slot, 283d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung unsigned InstNum, Type *Ty, Value *&ResVal) { 284d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung if (getValue(Record, Slot, InstNum, Ty, ResVal)) 285d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung return true; 286d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung // All values currently take a single record slot. 287d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung ++Slot; 288d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung return false; 289d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung } 290d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 291d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// getValue -- Like popValue, but does not increment the Slot number. 292d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung bool getValue(SmallVector<uint64_t, 64> &Record, unsigned Slot, 293d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung unsigned InstNum, Type *Ty, Value *&ResVal) { 294d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung ResVal = getValue(Record, Slot, InstNum, Ty); 2957337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner return ResVal == 0; 2967337ab9e929a4a787f90d37ee0ed8f4cc27170abChris Lattner } 29748c85b84c1b66fb6a1b0d2afddf33da5bd82960dChris Lattner 298d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// getValue -- Version of getValue that returns ResVal directly, 299d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// or 0 if there is an error. 300d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung Value *getValue(SmallVector<uint64_t, 64> &Record, unsigned Slot, 301d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung unsigned InstNum, Type *Ty) { 302d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung if (Slot == Record.size()) return 0; 303d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung unsigned ValNo = (unsigned)Record[Slot]; 304d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung // Adjust the ValNo, if it was encoded relative to the InstNum. 305d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung if (UseRelativeIDs) 306d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung ValNo = InstNum - ValNo; 307d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung return getFnValueByID(ValNo, Ty); 308d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung } 309d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 310d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung /// getValueSigned -- Like getValue, but decodes signed VBRs. 311d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung Value *getValueSigned(SmallVector<uint64_t, 64> &Record, unsigned Slot, 312d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung unsigned InstNum, Type *Ty) { 313d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung if (Slot == Record.size()) return 0; 314d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]); 315d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung // Adjust the ValNo, if it was encoded relative to the InstNum. 316d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung if (UseRelativeIDs) 317d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung ValNo = InstNum - ValNo; 318d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung return getFnValueByID(ValNo, Ty); 319d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung } 320d9a3bad4487dee0b9ed1a0f5555dffe605826158Jan Wen Voung 3212ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool ParseModule(bool Resume); 3220598866c052147c31b808391f58434ce3dbfb838Devang Patel bool ParseAttributeBlock(); 323866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseTypeTable(); 3241afcace3a3a138b1b18e5c6270caa8dae2261ae2Chris Lattner bool ParseTypeTableBody(); 3251afcace3a3a138b1b18e5c6270caa8dae2261ae2Chris Lattner 326866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseValueSymbolTable(); 327866971474ced63f725bd3dbf10fdb9e3badb7d9eChris Lattner bool ParseConstants(); 328980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner bool RememberAndSkipFunctionBody(); 329980e5aad4cfaa32e13b297f4201eb1088ca96cc4Chris Lattner bool ParseFunctionBody(Function *F); 3302ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool GlobalCleanup(); 33107d98b4afbdcbb4eed048400d9116de1ec83e866Chris Lattner bool ResolveGlobalAndAliasInits(); 332e54abc90fe9942ef3902040a7ac475ce0c369dc9Devang Patel bool ParseMetadata(); 333e8e0213cc3daa2d0457c22e4c12e6973f21fc942Devang Patel bool ParseMetadataAttachment(); 33434711747a1d2c8713e69333bacef1c880810e371Bill Wendling bool ParseModuleTriple(std::string &Triple); 335cbbb09687f563fad96fd815a3a89920f436373e4Chad Rosier bool ParseUseLists(); 3362ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool InitStream(); 3372ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool InitStreamFromBuffer(); 3382ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool InitLazyStream(); 3392ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff bool FindFunctionInStream(Function *F, 3402ea93875b2f2900b9d244dfd7649c9ed02a34cd7Derek Schuff DenseMap<Function*, uint64_t>::iterator DeferredFunctionInfoIterator); 341caee0dccffb77a003681345ab3281bcf8684526cChris Lattner}; 342caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 343caee0dccffb77a003681345ab3281bcf8684526cChris Lattner} // End llvm namespace 344caee0dccffb77a003681345ab3281bcf8684526cChris Lattner 345caee0dccffb77a003681345ab3281bcf8684526cChris Lattner#endif 346