blob: 8713855b271070f4596c1386a49f854be34ed237 [file] [log] [blame]
Chris Lattnerd6b65252001-10-24 01:15:12 +00001//===- Reader.cpp - Code to read bytecode files ---------------------------===//
Chris Lattner00950542001-06-06 20:29:01 +00002//
3// This library implements the functionality defined in llvm/Bytecode/Reader.h
4//
5// Note that this library should be as fast as possible, reentrant, and
6// threadsafe!!
7//
Chris Lattner74734132002-08-17 22:01:27 +00008// TODO: Return error messages to caller instead of printing them out directly.
Chris Lattner00950542001-06-06 20:29:01 +00009// TODO: Allow passing in an option to ignore the symbol table
10//
Chris Lattnerd6b65252001-10-24 01:15:12 +000011//===----------------------------------------------------------------------===//
Chris Lattner00950542001-06-06 20:29:01 +000012
Chris Lattner7061dc52001-12-03 18:02:31 +000013#include "ReaderInternals.h"
Chris Lattner00950542001-06-06 20:29:01 +000014#include "llvm/Bytecode/Reader.h"
15#include "llvm/Bytecode/Format.h"
Chris Lattner31bcdb82002-04-28 19:55:58 +000016#include "llvm/Constants.h"
Chris Lattner7061dc52001-12-03 18:02:31 +000017#include "llvm/iPHINode.h"
Chris Lattner00950542001-06-06 20:29:01 +000018#include "llvm/iOther.h"
Misha Brukman12c29d12003-09-22 23:38:23 +000019#include "llvm/Module.h"
20#include "Support/StringExtras.h"
John Criswell7a73b802003-06-30 21:59:07 +000021#include "Config/unistd.h"
Misha Brukman12c29d12003-09-22 23:38:23 +000022#include "Config/sys/mman.h"
23#include "Config/sys/stat.h"
24#include "Config/sys/types.h"
Chris Lattner00950542001-06-06 20:29:01 +000025#include <algorithm>
Misha Brukman12c29d12003-09-22 23:38:23 +000026#include <memory>
Chris Lattner00950542001-06-06 20:29:01 +000027
Misha Brukmane0dd0d42003-09-23 16:15:29 +000028static inline void ALIGN32(const unsigned char *&begin,
29 const unsigned char *end) {
30 if (align32(begin, end))
31 throw std::string("Alignment error in buffer: read past end of block.");
32}
Misha Brukman12c29d12003-09-22 23:38:23 +000033
Chris Lattner9e460f22003-10-04 20:00:03 +000034unsigned BytecodeParser::getTypeSlot(const Type *Ty) {
35 if (Ty->isPrimitiveType())
36 return Ty->getPrimitiveID();
37
38 // Check the function level types first...
39 TypeValuesListTy::iterator I = find(FunctionTypeValues.begin(),
40 FunctionTypeValues.end(), Ty);
41 if (I != FunctionTypeValues.end())
42 return FirstDerivedTyID + ModuleTypeValues.size() +
43 (&*I - &FunctionTypeValues[0]);
44
45 I = find(ModuleTypeValues.begin(), ModuleTypeValues.end(), Ty);
46 if (I == ModuleTypeValues.end())
47 throw std::string("Didn't find type in ModuleTypeValues.");
48 return FirstDerivedTyID + (&*I - &ModuleTypeValues[0]);
Chris Lattner00950542001-06-06 20:29:01 +000049}
50
51const Type *BytecodeParser::getType(unsigned ID) {
Chris Lattner927b1852003-10-09 20:22:47 +000052 if (ID < Type::NumPrimitiveIDs)
53 if (const Type *T = Type::getPrimitiveType((Type::PrimitiveID)ID))
54 return T;
Chris Lattner00950542001-06-06 20:29:01 +000055
Chris Lattner697954c2002-01-20 22:54:45 +000056 //cerr << "Looking up Type ID: " << ID << "\n";
Chris Lattner36392bc2003-10-08 21:18:57 +000057
Chris Lattner927b1852003-10-09 20:22:47 +000058 if (ID < Type::NumPrimitiveIDs)
59 if (const Type *T = Type::getPrimitiveType((Type::PrimitiveID)ID))
60 return T; // Asked for a primitive type...
Chris Lattner36392bc2003-10-08 21:18:57 +000061
62 // Otherwise, derived types need offset...
63 ID -= FirstDerivedTyID;
64
65 // Is it a module-level type?
66 if (ID < ModuleTypeValues.size())
67 return ModuleTypeValues[ID].get();
68
69 // Nope, is it a function-level type?
70 ID -= ModuleTypeValues.size();
71 if (ID < FunctionTypeValues.size())
72 return FunctionTypeValues[ID].get();
73
Chris Lattner927b1852003-10-09 20:22:47 +000074 throw std::string("Illegal type reference!");
Chris Lattner00950542001-06-06 20:29:01 +000075}
76
Chris Lattner927b1852003-10-09 20:22:47 +000077unsigned BytecodeParser::insertValue(Value *Val, ValueTable &ValueTab) {
Chris Lattnerf0d92732003-10-13 14:34:59 +000078 return insertValue(Val, getTypeSlot(Val->getType()), ValueTab);
79}
80
81unsigned BytecodeParser::insertValue(Value *Val, unsigned type,
82 ValueTable &ValueTab) {
Chris Lattner52e20b02003-03-19 20:54:26 +000083 assert((!HasImplicitZeroInitializer || !isa<Constant>(Val) ||
84 Val->getType()->isPrimitiveType() ||
85 !cast<Constant>(Val)->isNullValue()) &&
86 "Cannot read null values from bytecode!");
Chris Lattner1d670cc2001-09-07 16:37:43 +000087 assert(type != Type::TypeTyID && "Types should never be insertValue'd!");
Chris Lattner00950542001-06-06 20:29:01 +000088
Chris Lattner52e20b02003-03-19 20:54:26 +000089 if (ValueTab.size() <= type) {
90 unsigned OldSize = ValueTab.size();
91 ValueTab.resize(type+1);
92 while (OldSize != type+1)
93 ValueTab[OldSize++] = new ValueList();
Chris Lattner036b8aa2003-03-06 17:55:45 +000094 }
Chris Lattner00950542001-06-06 20:29:01 +000095
96 //cerr << "insertValue Values[" << type << "][" << ValueTab[type].size()
Misha Brukman12c29d12003-09-22 23:38:23 +000097 // << "] = " << Val << "\n";
Chris Lattner52e20b02003-03-19 20:54:26 +000098 ValueTab[type]->push_back(Val);
Chris Lattner00950542001-06-06 20:29:01 +000099
Chris Lattner52e20b02003-03-19 20:54:26 +0000100 bool HasOffset = HasImplicitZeroInitializer &&
Misha Brukman12c29d12003-09-22 23:38:23 +0000101 !Val->getType()->isPrimitiveType();
Chris Lattner52e20b02003-03-19 20:54:26 +0000102
103 return ValueTab[type]->size()-1 + HasOffset;
104}
105
106
Chris Lattner00950542001-06-06 20:29:01 +0000107Value *BytecodeParser::getValue(const Type *Ty, unsigned oNum, bool Create) {
Chris Lattner36392bc2003-10-08 21:18:57 +0000108 return getValue(getTypeSlot(Ty), oNum, Create);
109}
110
111Value *BytecodeParser::getValue(unsigned type, unsigned oNum, bool Create) {
112 assert(type != Type::TypeTyID && "getValue() cannot get types!");
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000113 assert(type != Type::LabelTyID && "getValue() cannot get blocks!");
Chris Lattner00950542001-06-06 20:29:01 +0000114 unsigned Num = oNum;
Chris Lattner00950542001-06-06 20:29:01 +0000115
Chris Lattner52e20b02003-03-19 20:54:26 +0000116 if (HasImplicitZeroInitializer && type >= FirstDerivedTyID) {
117 if (Num == 0)
Chris Lattner36392bc2003-10-08 21:18:57 +0000118 return Constant::getNullValue(getType(type));
Chris Lattner52e20b02003-03-19 20:54:26 +0000119 --Num;
Chris Lattner00950542001-06-06 20:29:01 +0000120 }
121
Chris Lattner52e20b02003-03-19 20:54:26 +0000122 if (type < ModuleValues.size()) {
123 if (Num < ModuleValues[type]->size())
124 return ModuleValues[type]->getOperand(Num);
125 Num -= ModuleValues[type]->size();
126 }
127
128 if (Values.size() > type && Values[type]->size() > Num)
129 return Values[type]->getOperand(Num);
Chris Lattner00950542001-06-06 20:29:01 +0000130
Chris Lattner74734132002-08-17 22:01:27 +0000131 if (!Create) return 0; // Do not create a placeholder?
Chris Lattner00950542001-06-06 20:29:01 +0000132
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000133 std::pair<unsigned,unsigned> KeyValue(type, oNum);
134 std::map<std::pair<unsigned,unsigned>, Value*>::iterator I =
135 ForwardReferences.lower_bound(KeyValue);
136 if (I != ForwardReferences.end() && I->first == KeyValue)
137 return I->second; // We have already created this placeholder
138
Chris Lattnerbf43ac62003-10-09 06:14:26 +0000139 Value *Val = new Argument(getType(type));
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000140 ForwardReferences.insert(I, std::make_pair(KeyValue, Val));
Chris Lattner36392bc2003-10-08 21:18:57 +0000141 return Val;
Chris Lattner00950542001-06-06 20:29:01 +0000142}
143
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000144/// getBasicBlock - Get a particular numbered basic block, which might be a
145/// forward reference. This works together with ParseBasicBlock to handle these
146/// forward references in a clean manner.
147///
148BasicBlock *BytecodeParser::getBasicBlock(unsigned ID) {
149 // Make sure there is room in the table...
150 if (ParsedBasicBlocks.size() <= ID) ParsedBasicBlocks.resize(ID+1);
151
152 // First check to see if this is a backwards reference, i.e., ParseBasicBlock
153 // has already created this block, or if the forward reference has already
154 // been created.
155 if (ParsedBasicBlocks[ID])
156 return ParsedBasicBlocks[ID];
157
158 // Otherwise, the basic block has not yet been created. Do so and add it to
159 // the ParsedBasicBlocks list.
160 return ParsedBasicBlocks[ID] = new BasicBlock();
161}
162
Chris Lattnerbbd4b302002-10-14 03:33:02 +0000163/// getConstantValue - Just like getValue, except that it returns a null pointer
164/// only on error. It always returns a constant (meaning that if the value is
165/// defined, but is not a constant, that is an error). If the specified
166/// constant hasn't been parsed yet, a placeholder is defined and used. Later,
167/// after the real value is parsed, the placeholder is eliminated.
168///
169Constant *BytecodeParser::getConstantValue(const Type *Ty, unsigned Slot) {
170 if (Value *V = getValue(Ty, Slot, false))
Chris Lattnerc9456ca2003-10-09 20:41:16 +0000171 if (Constant *C = dyn_cast<Constant>(V))
172 return C; // If we already have the value parsed, just return it
173 else
174 throw std::string("Reference of a value is expected to be a constant!");
Chris Lattnerbbd4b302002-10-14 03:33:02 +0000175
Chris Lattner52e20b02003-03-19 20:54:26 +0000176 std::pair<const Type*, unsigned> Key(Ty, Slot);
177 GlobalRefsType::iterator I = GlobalRefs.lower_bound(Key);
178
179 if (I != GlobalRefs.end() && I->first == Key) {
Chris Lattnerbbd4b302002-10-14 03:33:02 +0000180 BCR_TRACE(5, "Previous forward ref found!\n");
181 return cast<Constant>(I->second);
182 } else {
183 // Create a placeholder for the constant reference and
184 // keep track of the fact that we have a forward ref to recycle it
185 BCR_TRACE(5, "Creating new forward ref to a constant!\n");
186 Constant *C = new ConstPHolder(Ty, Slot);
187
188 // Keep track of the fact that we have a forward ref to recycle it
Chris Lattner52e20b02003-03-19 20:54:26 +0000189 GlobalRefs.insert(I, std::make_pair(Key, C));
Chris Lattnerbbd4b302002-10-14 03:33:02 +0000190 return C;
191 }
192}
193
194
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000195BasicBlock *BytecodeParser::ParseBasicBlock(const unsigned char *&Buf,
196 const unsigned char *EndBuf,
197 unsigned BlockNo) {
198 BasicBlock *BB;
199 if (ParsedBasicBlocks.size() == BlockNo)
200 ParsedBasicBlocks.push_back(BB = new BasicBlock());
201 else if (ParsedBasicBlocks[BlockNo] == 0)
202 BB = ParsedBasicBlocks[BlockNo] = new BasicBlock();
203 else
204 BB = ParsedBasicBlocks[BlockNo];
Chris Lattner00950542001-06-06 20:29:01 +0000205
206 while (Buf < EndBuf) {
Chris Lattner6fcf5032003-10-09 20:45:42 +0000207 std::vector<unsigned> Args;
208 Instruction *Inst = ParseInstruction(Buf, EndBuf, Args);
Chris Lattner927b1852003-10-09 20:22:47 +0000209 insertValue(Inst, Values);
Chris Lattner1d670cc2001-09-07 16:37:43 +0000210 BB->getInstList().push_back(Inst);
Chris Lattner1d670cc2001-09-07 16:37:43 +0000211 BCR_TRACE(4, Inst);
Chris Lattner00950542001-06-06 20:29:01 +0000212 }
213
Misha Brukman12c29d12003-09-22 23:38:23 +0000214 return BB;
Chris Lattner00950542001-06-06 20:29:01 +0000215}
216
Misha Brukman12c29d12003-09-22 23:38:23 +0000217void BytecodeParser::ParseSymbolTable(const unsigned char *&Buf,
Chris Lattner12e64652003-05-22 18:08:30 +0000218 const unsigned char *EndBuf,
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000219 SymbolTable *ST,
220 Function *CurrentFunction) {
Chris Lattner39cacce2003-10-10 05:43:47 +0000221 // Allow efficient basic block lookup by number.
222 std::vector<BasicBlock*> BBMap;
223 if (CurrentFunction)
224 for (Function::iterator I = CurrentFunction->begin(),
225 E = CurrentFunction->end(); I != E; ++I)
226 BBMap.push_back(I);
227
Chris Lattner00950542001-06-06 20:29:01 +0000228 while (Buf < EndBuf) {
229 // Symtab block header: [num entries][type id number]
230 unsigned NumEntries, Typ;
231 if (read_vbr(Buf, EndBuf, NumEntries) ||
Misha Brukman12c29d12003-09-22 23:38:23 +0000232 read_vbr(Buf, EndBuf, Typ)) throw Error_readvbr;
Chris Lattner00950542001-06-06 20:29:01 +0000233 const Type *Ty = getType(Typ);
Chris Lattner927b1852003-10-09 20:22:47 +0000234 BCR_TRACE(3, "Plane Type: '" << *Ty << "' with " << NumEntries <<
Misha Brukman12c29d12003-09-22 23:38:23 +0000235 " entries\n");
Chris Lattner1d670cc2001-09-07 16:37:43 +0000236
Chris Lattner7fc9fe32001-06-27 23:41:11 +0000237 for (unsigned i = 0; i < NumEntries; ++i) {
Chris Lattner00950542001-06-06 20:29:01 +0000238 // Symtab entry: [def slot #][name]
239 unsigned slot;
Misha Brukman12c29d12003-09-22 23:38:23 +0000240 if (read_vbr(Buf, EndBuf, slot)) throw Error_readvbr;
Chris Lattner697954c2002-01-20 22:54:45 +0000241 std::string Name;
Chris Lattner00950542001-06-06 20:29:01 +0000242 if (read(Buf, EndBuf, Name, false)) // Not aligned...
Misha Brukman12c29d12003-09-22 23:38:23 +0000243 throw std::string("Buffer not aligned.");
Chris Lattner00950542001-06-06 20:29:01 +0000244
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000245 Value *V = 0;
Chris Lattner36392bc2003-10-08 21:18:57 +0000246 if (Typ == Type::TypeTyID)
247 V = (Value*)getType(slot);
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000248 else if (Typ == Type::LabelTyID) {
Chris Lattner39cacce2003-10-10 05:43:47 +0000249 if (slot < BBMap.size())
250 V = BBMap[slot];
251 } else {
Chris Lattner36392bc2003-10-08 21:18:57 +0000252 V = getValue(Typ, slot, false); // Find mapping...
Chris Lattner39cacce2003-10-10 05:43:47 +0000253 }
Chris Lattner36392bc2003-10-08 21:18:57 +0000254 if (V == 0) throw std::string("Failed value look-up.");
Chris Lattner52e20b02003-03-19 20:54:26 +0000255 BCR_TRACE(4, "Map: '" << Name << "' to #" << slot << ":" << *V;
Misha Brukman12c29d12003-09-22 23:38:23 +0000256 if (!isa<Instruction>(V)) std::cerr << "\n");
Chris Lattner1d670cc2001-09-07 16:37:43 +0000257
Chris Lattner52e20b02003-03-19 20:54:26 +0000258 V->setName(Name, ST);
Chris Lattner00950542001-06-06 20:29:01 +0000259 }
260 }
261
Misha Brukman12c29d12003-09-22 23:38:23 +0000262 if (Buf > EndBuf) throw std::string("Tried to read past end of buffer.");
Chris Lattner00950542001-06-06 20:29:01 +0000263}
264
Chris Lattner74734132002-08-17 22:01:27 +0000265void BytecodeParser::ResolveReferencesToValue(Value *NewV, unsigned Slot) {
Chris Lattner0d75d8d72003-03-06 16:32:25 +0000266 GlobalRefsType::iterator I = GlobalRefs.find(std::make_pair(NewV->getType(),
267 Slot));
Chris Lattner74734132002-08-17 22:01:27 +0000268 if (I == GlobalRefs.end()) return; // Never forward referenced?
Chris Lattner00950542001-06-06 20:29:01 +0000269
Chris Lattner74734132002-08-17 22:01:27 +0000270 BCR_TRACE(3, "Mutating forward refs!\n");
271 Value *VPH = I->second; // Get the placeholder...
Chris Lattner52e20b02003-03-19 20:54:26 +0000272 VPH->replaceAllUsesWith(NewV);
273
274 // If this is a global variable being resolved, remove the placeholder from
275 // the module...
276 if (GlobalValue* GVal = dyn_cast<GlobalValue>(NewV))
277 GVal->getParent()->getGlobalList().remove(cast<GlobalVariable>(VPH));
Vikram S. Advec1e4a812002-07-14 23:04:18 +0000278
Chris Lattner74734132002-08-17 22:01:27 +0000279 delete VPH; // Delete the old placeholder
280 GlobalRefs.erase(I); // Remove the map entry for it
Vikram S. Advec1e4a812002-07-14 23:04:18 +0000281}
282
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000283void BytecodeParser::ParseFunction(const unsigned char *&Buf,
284 const unsigned char *EndBuf) {
Misha Brukman12c29d12003-09-22 23:38:23 +0000285 if (FunctionSignatureList.empty())
286 throw std::string("FunctionSignatureList empty!");
Chris Lattner52e20b02003-03-19 20:54:26 +0000287
Misha Brukman12c29d12003-09-22 23:38:23 +0000288 Function *F = FunctionSignatureList.back().first;
289 unsigned FunctionSlot = FunctionSignatureList.back().second;
290 FunctionSignatureList.pop_back();
291
292 // Save the information for future reading of the function
293 LazyFunctionInfo *LFI = new LazyFunctionInfo();
294 LFI->Buf = Buf; LFI->EndBuf = EndBuf; LFI->FunctionSlot = FunctionSlot;
295 LazyFunctionLoadMap[F] = LFI;
296 // Pretend we've `parsed' this function
297 Buf = EndBuf;
298}
299
300void BytecodeParser::materializeFunction(Function* F) {
301 // Find {start, end} pointers and slot in the map. If not there, we're done.
302 std::map<Function*, LazyFunctionInfo*>::iterator Fi =
303 LazyFunctionLoadMap.find(F);
304 if (Fi == LazyFunctionLoadMap.end()) return;
305
306 LazyFunctionInfo *LFI = Fi->second;
307 const unsigned char *Buf = LFI->Buf;
308 const unsigned char *EndBuf = LFI->EndBuf;
309 unsigned FunctionSlot = LFI->FunctionSlot;
310 LazyFunctionLoadMap.erase(Fi);
311 delete LFI;
Chris Lattner00950542001-06-06 20:29:01 +0000312
Chris Lattnere3869c82003-04-16 21:16:05 +0000313 GlobalValue::LinkageTypes Linkage = GlobalValue::ExternalLinkage;
314
315 if (!hasInternalMarkerOnly) {
316 unsigned LinkageType;
Misha Brukman12c29d12003-09-22 23:38:23 +0000317 if (read_vbr(Buf, EndBuf, LinkageType))
318 throw std::string("ParseFunction: Error reading from buffer.");
319 if (LinkageType & ~0x3)
320 throw std::string("Invalid linkage type for Function.");
Chris Lattnere3869c82003-04-16 21:16:05 +0000321 Linkage = (GlobalValue::LinkageTypes)LinkageType;
322 } else {
323 // We used to only support two linkage models: internal and external
324 unsigned isInternal;
Misha Brukman12c29d12003-09-22 23:38:23 +0000325 if (read_vbr(Buf, EndBuf, isInternal))
326 throw std::string("ParseFunction: Error reading from buffer.");
Chris Lattnere3869c82003-04-16 21:16:05 +0000327 if (isInternal) Linkage = GlobalValue::InternalLinkage;
328 }
Chris Lattnerd23b1d32001-11-26 18:56:10 +0000329
Chris Lattnere3869c82003-04-16 21:16:05 +0000330 F->setLinkage(Linkage);
Chris Lattner00950542001-06-06 20:29:01 +0000331
Chris Lattner52e20b02003-03-19 20:54:26 +0000332 const FunctionType::ParamTypes &Params =F->getFunctionType()->getParamTypes();
333 Function::aiterator AI = F->abegin();
Chris Lattnerc9aa7df2002-03-29 03:51:11 +0000334 for (FunctionType::ParamTypes::const_iterator It = Params.begin();
Chris Lattner927b1852003-10-09 20:22:47 +0000335 It != Params.end(); ++It, ++AI)
336 insertValue(AI, Values);
Chris Lattner00950542001-06-06 20:29:01 +0000337
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000338 // Keep track of how many basic blocks we have read in...
339 unsigned BlockNum = 0;
340
Chris Lattner00950542001-06-06 20:29:01 +0000341 while (Buf < EndBuf) {
342 unsigned Type, Size;
Chris Lattnerb6c46952003-03-06 17:03:28 +0000343 const unsigned char *OldBuf = Buf;
Misha Brukman12c29d12003-09-22 23:38:23 +0000344 readBlock(Buf, EndBuf, Type, Size);
Chris Lattner00950542001-06-06 20:29:01 +0000345
346 switch (Type) {
Misha Brukman12c29d12003-09-22 23:38:23 +0000347 case BytecodeFormat::ConstantPool: {
Chris Lattner1d670cc2001-09-07 16:37:43 +0000348 BCR_TRACE(2, "BLOCK BytecodeFormat::ConstantPool: {\n");
Misha Brukman12c29d12003-09-22 23:38:23 +0000349 ParseConstantPool(Buf, Buf+Size, Values, FunctionTypeValues);
Chris Lattner00950542001-06-06 20:29:01 +0000350 break;
Misha Brukman12c29d12003-09-22 23:38:23 +0000351 }
Chris Lattner00950542001-06-06 20:29:01 +0000352
353 case BytecodeFormat::BasicBlock: {
Chris Lattner1d670cc2001-09-07 16:37:43 +0000354 BCR_TRACE(2, "BLOCK BytecodeFormat::BasicBlock: {\n");
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000355 BasicBlock *BB = ParseBasicBlock(Buf, Buf+Size, BlockNum++);
356 F->getBasicBlockList().push_back(BB);
Chris Lattner00950542001-06-06 20:29:01 +0000357 break;
358 }
359
Misha Brukman12c29d12003-09-22 23:38:23 +0000360 case BytecodeFormat::SymbolTable: {
Chris Lattner1d670cc2001-09-07 16:37:43 +0000361 BCR_TRACE(2, "BLOCK BytecodeFormat::SymbolTable: {\n");
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000362 ParseSymbolTable(Buf, Buf+Size, &F->getSymbolTable(), F);
Chris Lattner00950542001-06-06 20:29:01 +0000363 break;
Misha Brukman12c29d12003-09-22 23:38:23 +0000364 }
Chris Lattner00950542001-06-06 20:29:01 +0000365
366 default:
Chris Lattner1d670cc2001-09-07 16:37:43 +0000367 BCR_TRACE(2, "BLOCK <unknown>:ignored! {\n");
Chris Lattner00950542001-06-06 20:29:01 +0000368 Buf += Size;
Misha Brukman12c29d12003-09-22 23:38:23 +0000369 if (OldBuf > Buf)
370 throw std::string("Wrapped around reading bytecode.");
Chris Lattner00950542001-06-06 20:29:01 +0000371 break;
372 }
Chris Lattner1d670cc2001-09-07 16:37:43 +0000373 BCR_TRACE(2, "} end block\n");
374
Misha Brukman12c29d12003-09-22 23:38:23 +0000375 // Malformed bc file if read past end of block.
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000376 ALIGN32(Buf, EndBuf);
Chris Lattner00950542001-06-06 20:29:01 +0000377 }
378
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000379 // Make sure there were no references to non-existant basic blocks.
380 if (BlockNum != ParsedBasicBlocks.size())
381 throw std::string("Illegal basic block operand reference");
382 ParsedBasicBlocks.clear();
383
Chris Lattner97330cf2003-10-09 23:10:14 +0000384 // Resolve forward references. Replace any uses of a forward reference value
385 // with the real value.
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000386
Chris Lattner97330cf2003-10-09 23:10:14 +0000387 // replaceAllUsesWith is very inefficient for instructions which have a LARGE
388 // number of operands. PHI nodes often have forward references, and can also
389 // often have a very large number of operands.
390 std::map<Value*, Value*> ForwardRefMapping;
391 for (std::map<std::pair<unsigned,unsigned>, Value*>::iterator
392 I = ForwardReferences.begin(), E = ForwardReferences.end();
393 I != E; ++I)
394 ForwardRefMapping[I->second] = getValue(I->first.first, I->first.second,
395 false);
396
397 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
398 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
399 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
400 if (Argument *A = dyn_cast<Argument>(I->getOperand(i))) {
401 std::map<Value*, Value*>::iterator It = ForwardRefMapping.find(A);
402 if (It != ForwardRefMapping.end()) I->setOperand(i, It->second);
403 }
404
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000405 while (!ForwardReferences.empty()) {
Chris Lattner35d2ca62003-10-09 22:39:30 +0000406 std::map<std::pair<unsigned,unsigned>, Value*>::iterator I =
407 ForwardReferences.begin();
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000408 Value *PlaceHolder = I->second;
409 ForwardReferences.erase(I);
Chris Lattner00950542001-06-06 20:29:01 +0000410
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000411 // Now that all the uses are gone, delete the placeholder...
412 // If we couldn't find a def (error case), then leak a little
413 // memory, because otherwise we can't remove all uses!
414 delete PlaceHolder;
Chris Lattner6e448022003-10-08 21:51:46 +0000415 }
Chris Lattner00950542001-06-06 20:29:01 +0000416
Misha Brukman12c29d12003-09-22 23:38:23 +0000417 // Clear out function-level types...
Chris Lattner6e5a0e42003-03-06 17:18:14 +0000418 FunctionTypeValues.clear();
Chris Lattnere4d71a12001-09-14 22:03:42 +0000419
Chris Lattner52e20b02003-03-19 20:54:26 +0000420 freeTable(Values);
Chris Lattner00950542001-06-06 20:29:01 +0000421}
422
Misha Brukman12c29d12003-09-22 23:38:23 +0000423void BytecodeParser::ParseModuleGlobalInfo(const unsigned char *&Buf,
424 const unsigned char *End) {
425 if (!FunctionSignatureList.empty())
426 throw std::string("Two ModuleGlobalInfo packets found!");
Chris Lattner00950542001-06-06 20:29:01 +0000427
Chris Lattner70cc3392001-09-10 07:58:01 +0000428 // Read global variables...
429 unsigned VarType;
Misha Brukman12c29d12003-09-22 23:38:23 +0000430 if (read_vbr(Buf, End, VarType)) throw Error_readvbr;
Chris Lattner70cc3392001-09-10 07:58:01 +0000431 while (VarType != Type::VoidTyID) { // List is terminated by Void
Chris Lattnere3869c82003-04-16 21:16:05 +0000432 unsigned SlotNo;
433 GlobalValue::LinkageTypes Linkage;
434
435 if (!hasInternalMarkerOnly) {
436 // VarType Fields: bit0 = isConstant, bit1 = hasInitializer,
437 // bit2,3 = Linkage, bit4+ = slot#
438 SlotNo = VarType >> 4;
439 Linkage = (GlobalValue::LinkageTypes)((VarType >> 2) & 3);
440 } else {
441 // VarType Fields: bit0 = isConstant, bit1 = hasInitializer,
442 // bit2 = isInternal, bit3+ = slot#
443 SlotNo = VarType >> 3;
444 Linkage = (VarType & 4) ? GlobalValue::InternalLinkage :
445 GlobalValue::ExternalLinkage;
446 }
447
448 const Type *Ty = getType(SlotNo);
Chris Lattner927b1852003-10-09 20:22:47 +0000449 if (!isa<PointerType>(Ty))
Misha Brukman12c29d12003-09-22 23:38:23 +0000450 throw std::string("Global not pointer type! Ty = " +
451 Ty->getDescription());
Chris Lattner70cc3392001-09-10 07:58:01 +0000452
Chris Lattner52e20b02003-03-19 20:54:26 +0000453 const Type *ElTy = cast<PointerType>(Ty)->getElementType();
Chris Lattnerd70684f2001-09-18 04:01:05 +0000454
Chris Lattner70cc3392001-09-10 07:58:01 +0000455 // Create the global variable...
Chris Lattner4ad02e72003-04-16 20:28:45 +0000456 GlobalVariable *GV = new GlobalVariable(ElTy, VarType & 1, Linkage,
Chris Lattner52e20b02003-03-19 20:54:26 +0000457 0, "", TheModule);
Chris Lattner52e20b02003-03-19 20:54:26 +0000458 BCR_TRACE(2, "Global Variable of type: " << *Ty << "\n");
Chris Lattnerf0d92732003-10-13 14:34:59 +0000459 ResolveReferencesToValue(GV, insertValue(GV, SlotNo, ModuleValues));
Chris Lattner05950c32001-10-13 06:47:01 +0000460
Misha Brukman37f92e22003-09-11 22:34:13 +0000461 if (VarType & 2) { // Does it have an initializer?
Chris Lattner52e20b02003-03-19 20:54:26 +0000462 unsigned InitSlot;
Misha Brukman12c29d12003-09-22 23:38:23 +0000463 if (read_vbr(Buf, End, InitSlot)) throw Error_readvbr;
Chris Lattner52e20b02003-03-19 20:54:26 +0000464 GlobalInits.push_back(std::make_pair(GV, InitSlot));
465 }
Misha Brukman12c29d12003-09-22 23:38:23 +0000466 if (read_vbr(Buf, End, VarType)) throw Error_readvbr;
Chris Lattner70cc3392001-09-10 07:58:01 +0000467 }
468
Chris Lattner52e20b02003-03-19 20:54:26 +0000469 // Read the function objects for all of the functions that are coming
Chris Lattner74734132002-08-17 22:01:27 +0000470 unsigned FnSignature;
Misha Brukman12c29d12003-09-22 23:38:23 +0000471 if (read_vbr(Buf, End, FnSignature)) throw Error_readvbr;
Chris Lattner74734132002-08-17 22:01:27 +0000472 while (FnSignature != Type::VoidTyID) { // List is terminated by Void
473 const Type *Ty = getType(FnSignature);
Chris Lattner927b1852003-10-09 20:22:47 +0000474 if (!isa<PointerType>(Ty) ||
475 !isa<FunctionType>(cast<PointerType>(Ty)->getElementType()))
Misha Brukman12c29d12003-09-22 23:38:23 +0000476 throw std::string("Function not ptr to func type! Ty = " +
477 Ty->getDescription());
Chris Lattner8cdc6b72002-10-23 00:51:54 +0000478
Chris Lattner2a7b6ba2003-03-06 17:15:19 +0000479 // We create functions by passing the underlying FunctionType to create...
Chris Lattner7a176752001-12-04 00:03:30 +0000480 Ty = cast<PointerType>(Ty)->getElementType();
Chris Lattner00950542001-06-06 20:29:01 +0000481
Chris Lattner2a7b6ba2003-03-06 17:15:19 +0000482 // When the ModuleGlobalInfo section is read, we load the type of each
483 // function and the 'ModuleValues' slot that it lands in. We then load a
484 // placeholder into its slot to reserve it. When the function is loaded,
485 // this placeholder is replaced.
Chris Lattner00950542001-06-06 20:29:01 +0000486
487 // Insert the placeholder...
Chris Lattner4ad02e72003-04-16 20:28:45 +0000488 Function *Func = new Function(cast<FunctionType>(Ty),
489 GlobalValue::InternalLinkage, "", TheModule);
Chris Lattnerf0d92732003-10-13 14:34:59 +0000490 unsigned DestSlot = insertValue(Func, FnSignature, ModuleValues);
Chris Lattner927b1852003-10-09 20:22:47 +0000491 ResolveReferencesToValue(Func, DestSlot);
Chris Lattner00950542001-06-06 20:29:01 +0000492
Chris Lattner52e20b02003-03-19 20:54:26 +0000493 // Keep track of this information in a list that is emptied as functions are
494 // loaded...
Chris Lattner00950542001-06-06 20:29:01 +0000495 //
Chris Lattner52e20b02003-03-19 20:54:26 +0000496 FunctionSignatureList.push_back(std::make_pair(Func, DestSlot));
497
Misha Brukman12c29d12003-09-22 23:38:23 +0000498 if (read_vbr(Buf, End, FnSignature)) throw Error_readvbr;
Chris Lattnerc9aa7df2002-03-29 03:51:11 +0000499 BCR_TRACE(2, "Function of type: " << Ty << "\n");
Chris Lattner00950542001-06-06 20:29:01 +0000500 }
501
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000502 ALIGN32(Buf, End);
Chris Lattner74734132002-08-17 22:01:27 +0000503
504 // Now that the function signature list is set up, reverse it so that we can
505 // remove elements efficiently from the back of the vector.
506 std::reverse(FunctionSignatureList.begin(), FunctionSignatureList.end());
Chris Lattner00950542001-06-06 20:29:01 +0000507
508 // This is for future proofing... in the future extra fields may be added that
509 // we don't understand, so we transparently ignore them.
510 //
511 Buf = End;
Chris Lattner00950542001-06-06 20:29:01 +0000512}
513
Misha Brukman12c29d12003-09-22 23:38:23 +0000514void BytecodeParser::ParseVersionInfo(const unsigned char *&Buf,
Chris Lattner12e64652003-05-22 18:08:30 +0000515 const unsigned char *EndBuf) {
Chris Lattner036b8aa2003-03-06 17:55:45 +0000516 unsigned Version;
Misha Brukman12c29d12003-09-22 23:38:23 +0000517 if (read_vbr(Buf, EndBuf, Version)) throw Error_readvbr;
Chris Lattner036b8aa2003-03-06 17:55:45 +0000518
519 // Unpack version number: low four bits are for flags, top bits = version
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000520 Module::Endianness Endianness;
521 Module::PointerSize PointerSize;
522 Endianness = (Version & 1) ? Module::BigEndian : Module::LittleEndian;
523 PointerSize = (Version & 2) ? Module::Pointer64 : Module::Pointer32;
524
525 bool hasNoEndianness = Version & 4;
526 bool hasNoPointerSize = Version & 8;
527
528 RevisionNum = Version >> 4;
Chris Lattnere3869c82003-04-16 21:16:05 +0000529
530 // Default values for the current bytecode version
Chris Lattner036b8aa2003-03-06 17:55:45 +0000531 HasImplicitZeroInitializer = true;
Chris Lattnere3869c82003-04-16 21:16:05 +0000532 hasInternalMarkerOnly = false;
533 FirstDerivedTyID = 14;
Chris Lattner036b8aa2003-03-06 17:55:45 +0000534
535 switch (RevisionNum) {
536 case 0: // Initial revision
Chris Lattner52e20b02003-03-19 20:54:26 +0000537 // Version #0 didn't have any of the flags stored correctly, and in fact as
538 // only valid with a 14 in the flags values. Also, it does not support
539 // encoding zero initializers for arrays compactly.
540 //
Misha Brukman12c29d12003-09-22 23:38:23 +0000541 if (Version != 14) throw std::string("Unknown revision 0 flags?");
Chris Lattner036b8aa2003-03-06 17:55:45 +0000542 HasImplicitZeroInitializer = false;
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000543 Endianness = Module::BigEndian;
544 PointerSize = Module::Pointer64;
Chris Lattnere3869c82003-04-16 21:16:05 +0000545 hasInternalMarkerOnly = true;
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000546 hasNoEndianness = hasNoPointerSize = false;
Chris Lattner036b8aa2003-03-06 17:55:45 +0000547 break;
548 case 1:
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000549 // Version #1 has four bit fields: isBigEndian, hasLongPointers,
550 // hasNoEndianness, and hasNoPointerSize.
Chris Lattnere3869c82003-04-16 21:16:05 +0000551 hasInternalMarkerOnly = true;
552 break;
553 case 2:
554 // Version #2 added information about all 4 linkage types instead of just
555 // having internal and external.
Chris Lattner036b8aa2003-03-06 17:55:45 +0000556 break;
557 default:
Misha Brukman12c29d12003-09-22 23:38:23 +0000558 throw std::string("Unknown bytecode version number!");
Chris Lattner036b8aa2003-03-06 17:55:45 +0000559 }
560
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000561 if (hasNoEndianness) Endianness = Module::AnyEndianness;
562 if (hasNoPointerSize) PointerSize = Module::AnyPointerSize;
Chris Lattner76e38962003-04-22 18:15:10 +0000563
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000564 TheModule->setEndianness(Endianness);
565 TheModule->setPointerSize(PointerSize);
Chris Lattner036b8aa2003-03-06 17:55:45 +0000566 BCR_TRACE(1, "Bytecode Rev = " << (unsigned)RevisionNum << "\n");
Chris Lattnerd445c6b2003-08-24 13:47:36 +0000567 BCR_TRACE(1, "Endianness/PointerSize = " << Endianness << ","
568 << PointerSize << "\n");
Chris Lattner036b8aa2003-03-06 17:55:45 +0000569 BCR_TRACE(1, "HasImplicitZeroInit = " << HasImplicitZeroInitializer << "\n");
Chris Lattner036b8aa2003-03-06 17:55:45 +0000570}
571
Misha Brukman12c29d12003-09-22 23:38:23 +0000572void BytecodeParser::ParseModule(const unsigned char *Buf,
Chris Lattner12e64652003-05-22 18:08:30 +0000573 const unsigned char *EndBuf) {
Chris Lattner00950542001-06-06 20:29:01 +0000574 unsigned Type, Size;
Misha Brukman12c29d12003-09-22 23:38:23 +0000575 readBlock(Buf, EndBuf, Type, Size);
576 if (Type != BytecodeFormat::Module || Buf+Size != EndBuf)
577 throw std::string("Expected Module packet! B: "+
578 utostr((unsigned)(intptr_t)Buf) + ", S: "+utostr(Size)+
579 " E: "+utostr((unsigned)(intptr_t)EndBuf)); // Hrm, not a class?
Chris Lattner00950542001-06-06 20:29:01 +0000580
Chris Lattner1d670cc2001-09-07 16:37:43 +0000581 BCR_TRACE(0, "BLOCK BytecodeFormat::Module: {\n");
Chris Lattner74734132002-08-17 22:01:27 +0000582 FunctionSignatureList.clear(); // Just in case...
Chris Lattner00950542001-06-06 20:29:01 +0000583
584 // Read into instance variables...
Misha Brukman12c29d12003-09-22 23:38:23 +0000585 ParseVersionInfo(Buf, EndBuf);
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000586 ALIGN32(Buf, EndBuf);
Chris Lattner00950542001-06-06 20:29:01 +0000587
Chris Lattner00950542001-06-06 20:29:01 +0000588 while (Buf < EndBuf) {
Chris Lattnerb6c46952003-03-06 17:03:28 +0000589 const unsigned char *OldBuf = Buf;
Misha Brukman12c29d12003-09-22 23:38:23 +0000590 readBlock(Buf, EndBuf, Type, Size);
Chris Lattner00950542001-06-06 20:29:01 +0000591 switch (Type) {
Chris Lattner52e20b02003-03-19 20:54:26 +0000592 case BytecodeFormat::GlobalTypePlane:
593 BCR_TRACE(1, "BLOCK BytecodeFormat::GlobalTypePlane: {\n");
Misha Brukman12c29d12003-09-22 23:38:23 +0000594 ParseGlobalTypes(Buf, Buf+Size);
Chris Lattner52e20b02003-03-19 20:54:26 +0000595 break;
596
597 case BytecodeFormat::ModuleGlobalInfo:
598 BCR_TRACE(1, "BLOCK BytecodeFormat::ModuleGlobalInfo: {\n");
Misha Brukman12c29d12003-09-22 23:38:23 +0000599 ParseModuleGlobalInfo(Buf, Buf+Size);
Chris Lattner52e20b02003-03-19 20:54:26 +0000600 break;
601
Chris Lattner1d670cc2001-09-07 16:37:43 +0000602 case BytecodeFormat::ConstantPool:
603 BCR_TRACE(1, "BLOCK BytecodeFormat::ConstantPool: {\n");
Misha Brukman12c29d12003-09-22 23:38:23 +0000604 ParseConstantPool(Buf, Buf+Size, ModuleValues, ModuleTypeValues);
Chris Lattner00950542001-06-06 20:29:01 +0000605 break;
606
Chris Lattnerc9aa7df2002-03-29 03:51:11 +0000607 case BytecodeFormat::Function: {
608 BCR_TRACE(1, "BLOCK BytecodeFormat::Function: {\n");
Misha Brukman12c29d12003-09-22 23:38:23 +0000609 ParseFunction(Buf, Buf+Size);
Chris Lattner00950542001-06-06 20:29:01 +0000610 break;
611 }
612
613 case BytecodeFormat::SymbolTable:
Chris Lattner1d670cc2001-09-07 16:37:43 +0000614 BCR_TRACE(1, "BLOCK BytecodeFormat::SymbolTable: {\n");
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000615 ParseSymbolTable(Buf, Buf+Size, &TheModule->getSymbolTable(), 0);
Chris Lattner00950542001-06-06 20:29:01 +0000616 break;
617
618 default:
Chris Lattner00950542001-06-06 20:29:01 +0000619 Buf += Size;
Misha Brukman12c29d12003-09-22 23:38:23 +0000620 if (OldBuf > Buf) throw std::string("Expected Module Block!");
Chris Lattner00950542001-06-06 20:29:01 +0000621 break;
622 }
Chris Lattner1d670cc2001-09-07 16:37:43 +0000623 BCR_TRACE(1, "} end block\n");
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000624 ALIGN32(Buf, EndBuf);
Chris Lattner00950542001-06-06 20:29:01 +0000625 }
626
Chris Lattner52e20b02003-03-19 20:54:26 +0000627 // After the module constant pool has been read, we can safely initialize
628 // global variables...
629 while (!GlobalInits.empty()) {
630 GlobalVariable *GV = GlobalInits.back().first;
631 unsigned Slot = GlobalInits.back().second;
632 GlobalInits.pop_back();
633
634 // Look up the initializer value...
635 if (Value *V = getValue(GV->getType()->getElementType(), Slot, false)) {
Misha Brukman12c29d12003-09-22 23:38:23 +0000636 if (GV->hasInitializer())
637 throw std::string("Global *already* has an initializer?!");
Chris Lattner52e20b02003-03-19 20:54:26 +0000638 GV->setInitializer(cast<Constant>(V));
639 } else
Misha Brukman12c29d12003-09-22 23:38:23 +0000640 throw std::string("Cannot find initializer value.");
Chris Lattner52e20b02003-03-19 20:54:26 +0000641 }
642
Misha Brukman12c29d12003-09-22 23:38:23 +0000643 if (!FunctionSignatureList.empty())
644 throw std::string("Function expected, but bytecode stream ended!");
Chris Lattner1d670cc2001-09-07 16:37:43 +0000645
646 BCR_TRACE(0, "} end block\n\n");
Chris Lattner00950542001-06-06 20:29:01 +0000647}
648
Misha Brukman12c29d12003-09-22 23:38:23 +0000649void
650BytecodeParser::ParseBytecode(const unsigned char *Buf, unsigned Length,
651 const std::string &ModuleID) {
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000652
Misha Brukman12c29d12003-09-22 23:38:23 +0000653 unsigned char *EndBuf = (unsigned char*)(Buf + Length);
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000654
Chris Lattner00950542001-06-06 20:29:01 +0000655 // Read and check signature...
Misha Brukmane0dd0d42003-09-23 16:15:29 +0000656 unsigned Sig;
Chris Lattner00950542001-06-06 20:29:01 +0000657 if (read(Buf, EndBuf, Sig) ||
Misha Brukman12c29d12003-09-22 23:38:23 +0000658 Sig != ('l' | ('l' << 8) | ('v' << 16) | ('m' << 24)))
659 throw std::string("Invalid bytecode signature!");
Chris Lattner00950542001-06-06 20:29:01 +0000660
Chris Lattner75f20532003-04-22 18:02:52 +0000661 TheModule = new Module(ModuleID);
Misha Brukman12c29d12003-09-22 23:38:23 +0000662 try {
663 ParseModule(Buf, EndBuf);
664 } catch (std::string &Error) {
Chris Lattnera2602f32003-05-22 18:26:48 +0000665 freeState(); // Must destroy handles before deleting module!
Chris Lattner2a7b6ba2003-03-06 17:15:19 +0000666 delete TheModule;
667 TheModule = 0;
Chris Lattnerb0b7c0d2003-09-26 14:44:52 +0000668 throw;
Chris Lattner2a7b6ba2003-03-06 17:15:19 +0000669 }
Chris Lattner00950542001-06-06 20:29:01 +0000670}