blob: 49792693dcc1f0872a06ed135f93fc17c2f2b7d5 [file] [log] [blame]
Chris Lattnerd6b65252001-10-24 01:15:12 +00001//===- Reader.cpp - Code to read bytecode files ---------------------------===//
Misha Brukman8a96c532005-04-21 21:44:41 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
Misha Brukman8a96c532005-04-21 21:44:41 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner00950542001-06-06 20:29:01 +00009//
10// This library implements the functionality defined in llvm/Bytecode/Reader.h
11//
Misha Brukman8a96c532005-04-21 21:44:41 +000012// Note that this library should be as fast as possible, reentrant, and
Chris Lattner00950542001-06-06 20:29:01 +000013// threadsafe!!
14//
Chris Lattner00950542001-06-06 20:29:01 +000015// TODO: Allow passing in an option to ignore the symbol table
16//
Chris Lattnerd6b65252001-10-24 01:15:12 +000017//===----------------------------------------------------------------------===//
Chris Lattner00950542001-06-06 20:29:01 +000018
Reid Spencer060d25d2004-06-29 23:29:38 +000019#include "Reader.h"
20#include "llvm/Bytecode/BytecodeHandler.h"
21#include "llvm/BasicBlock.h"
Chris Lattnerdee199f2005-05-06 22:34:01 +000022#include "llvm/CallingConv.h"
Reid Spencer060d25d2004-06-29 23:29:38 +000023#include "llvm/Constants.h"
Chris Lattner3bc5a602006-01-25 23:08:15 +000024#include "llvm/InlineAsm.h"
Reid Spencer04cde2c2004-07-04 11:33:49 +000025#include "llvm/Instructions.h"
Reid Spencer91ac04a2007-04-09 06:14:31 +000026#include "llvm/ParameterAttributes.h"
Reid Spencer78d033e2007-01-06 07:24:44 +000027#include "llvm/TypeSymbolTable.h"
Chris Lattner00950542001-06-06 20:29:01 +000028#include "llvm/Bytecode/Format.h"
Chris Lattnerdee199f2005-05-06 22:34:01 +000029#include "llvm/Config/alloca.h"
Reid Spencer060d25d2004-06-29 23:29:38 +000030#include "llvm/Support/GetElementPtrTypeIterator.h"
Jim Laskeycb6682f2005-08-17 19:34:49 +000031#include "llvm/Support/MathExtras.h"
Chris Lattner4c3d3a92007-01-31 19:56:15 +000032#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000033#include "llvm/ADT/StringExtras.h"
Reid Spencer060d25d2004-06-29 23:29:38 +000034#include <sstream>
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000035#include <algorithm>
Chris Lattner29b789b2003-11-19 17:27:18 +000036using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000037
Reid Spencer46b002c2004-07-11 17:28:43 +000038namespace {
Chris Lattnercad28bd2005-01-29 00:36:19 +000039 /// @brief A class for maintaining the slot number definition
40 /// as a placeholder for the actual definition for forward constants defs.
41 class ConstantPlaceHolder : public ConstantExpr {
42 ConstantPlaceHolder(); // DO NOT IMPLEMENT
43 void operator=(const ConstantPlaceHolder &); // DO NOT IMPLEMENT
44 public:
Chris Lattner61323322005-01-31 01:11:13 +000045 Use Op;
Misha Brukman8a96c532005-04-21 21:44:41 +000046 ConstantPlaceHolder(const Type *Ty)
Chris Lattner61323322005-01-31 01:11:13 +000047 : ConstantExpr(Ty, Instruction::UserOp1, &Op, 1),
Reid Spencer88cfda22006-12-31 05:44:24 +000048 Op(UndefValue::get(Type::Int32Ty), this) {
Chris Lattner61323322005-01-31 01:11:13 +000049 }
Chris Lattnercad28bd2005-01-29 00:36:19 +000050 };
Reid Spencer46b002c2004-07-11 17:28:43 +000051}
Reid Spencer060d25d2004-06-29 23:29:38 +000052
Reid Spencer24399722004-07-09 22:21:33 +000053// Provide some details on error
Reid Spencer233fe722006-08-22 16:09:19 +000054inline void BytecodeReader::error(const std::string& err) {
55 ErrorMsg = err + " (Vers=" + itostr(RevisionNum) + ", Pos="
56 + itostr(At-MemStart) + ")";
Reid Spenceref9b9a72007-02-05 20:47:22 +000057 if (Handler) Handler->handleError(ErrorMsg);
Reid Spencer233fe722006-08-22 16:09:19 +000058 longjmp(context,1);
Reid Spencer24399722004-07-09 22:21:33 +000059}
60
Reid Spencer060d25d2004-06-29 23:29:38 +000061//===----------------------------------------------------------------------===//
62// Bytecode Reading Methods
63//===----------------------------------------------------------------------===//
64
Reid Spencer04cde2c2004-07-04 11:33:49 +000065/// Determine if the current block being read contains any more data.
Reid Spencer060d25d2004-06-29 23:29:38 +000066inline bool BytecodeReader::moreInBlock() {
67 return At < BlockEnd;
Chris Lattner00950542001-06-06 20:29:01 +000068}
69
Reid Spencer04cde2c2004-07-04 11:33:49 +000070/// Throw an error if we've read past the end of the current block
Reid Spencer060d25d2004-06-29 23:29:38 +000071inline void BytecodeReader::checkPastBlockEnd(const char * block_name) {
Reid Spencer46b002c2004-07-11 17:28:43 +000072 if (At > BlockEnd)
Chris Lattnera79e7cc2004-10-16 18:18:16 +000073 error(std::string("Attempt to read past the end of ") + block_name +
74 " block.");
Reid Spencer060d25d2004-06-29 23:29:38 +000075}
Chris Lattner36392bc2003-10-08 21:18:57 +000076
Reid Spencer04cde2c2004-07-04 11:33:49 +000077/// Read a whole unsigned integer
Reid Spencer060d25d2004-06-29 23:29:38 +000078inline unsigned BytecodeReader::read_uint() {
Misha Brukman8a96c532005-04-21 21:44:41 +000079 if (At+4 > BlockEnd)
Reid Spencer24399722004-07-09 22:21:33 +000080 error("Ran out of data reading uint!");
Reid Spencer060d25d2004-06-29 23:29:38 +000081 At += 4;
82 return At[-4] | (At[-3] << 8) | (At[-2] << 16) | (At[-1] << 24);
83}
84
Reid Spencer04cde2c2004-07-04 11:33:49 +000085/// Read a variable-bit-rate encoded unsigned integer
Reid Spencer060d25d2004-06-29 23:29:38 +000086inline unsigned BytecodeReader::read_vbr_uint() {
87 unsigned Shift = 0;
88 unsigned Result = 0;
Misha Brukman8a96c532005-04-21 21:44:41 +000089
Reid Spencer060d25d2004-06-29 23:29:38 +000090 do {
Misha Brukman8a96c532005-04-21 21:44:41 +000091 if (At == BlockEnd)
Reid Spencer24399722004-07-09 22:21:33 +000092 error("Ran out of data reading vbr_uint!");
Reid Spencer060d25d2004-06-29 23:29:38 +000093 Result |= (unsigned)((*At++) & 0x7F) << Shift;
94 Shift += 7;
95 } while (At[-1] & 0x80);
Reid Spencer060d25d2004-06-29 23:29:38 +000096 return Result;
97}
98
Reid Spencer04cde2c2004-07-04 11:33:49 +000099/// Read a variable-bit-rate encoded unsigned 64-bit integer.
Reid Spencer060d25d2004-06-29 23:29:38 +0000100inline uint64_t BytecodeReader::read_vbr_uint64() {
101 unsigned Shift = 0;
102 uint64_t Result = 0;
Misha Brukman8a96c532005-04-21 21:44:41 +0000103
Reid Spencer060d25d2004-06-29 23:29:38 +0000104 do {
Misha Brukman8a96c532005-04-21 21:44:41 +0000105 if (At == BlockEnd)
Reid Spencer24399722004-07-09 22:21:33 +0000106 error("Ran out of data reading vbr_uint64!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000107 Result |= (uint64_t)((*At++) & 0x7F) << Shift;
108 Shift += 7;
109 } while (At[-1] & 0x80);
Reid Spencer060d25d2004-06-29 23:29:38 +0000110 return Result;
111}
112
Reid Spencer04cde2c2004-07-04 11:33:49 +0000113/// Read a variable-bit-rate encoded signed 64-bit integer.
Reid Spencer060d25d2004-06-29 23:29:38 +0000114inline int64_t BytecodeReader::read_vbr_int64() {
115 uint64_t R = read_vbr_uint64();
116 if (R & 1) {
117 if (R != 1)
118 return -(int64_t)(R >> 1);
119 else // There is no such thing as -0 with integers. "-0" really means
120 // 0x8000000000000000.
121 return 1LL << 63;
122 } else
123 return (int64_t)(R >> 1);
124}
125
Reid Spencer04cde2c2004-07-04 11:33:49 +0000126/// Read a pascal-style string (length followed by text)
Reid Spencer060d25d2004-06-29 23:29:38 +0000127inline std::string BytecodeReader::read_str() {
128 unsigned Size = read_vbr_uint();
129 const unsigned char *OldAt = At;
130 At += Size;
131 if (At > BlockEnd) // Size invalid?
Reid Spencer24399722004-07-09 22:21:33 +0000132 error("Ran out of data reading a string!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000133 return std::string((char*)OldAt, Size);
134}
135
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000136void BytecodeReader::read_str(SmallVectorImpl<char> &StrData) {
137 StrData.clear();
138 unsigned Size = read_vbr_uint();
139 const unsigned char *OldAt = At;
140 At += Size;
141 if (At > BlockEnd) // Size invalid?
142 error("Ran out of data reading a string!");
143 StrData.append(OldAt, At);
144}
145
146
Reid Spencer04cde2c2004-07-04 11:33:49 +0000147/// Read an arbitrary block of data
Reid Spencer060d25d2004-06-29 23:29:38 +0000148inline void BytecodeReader::read_data(void *Ptr, void *End) {
149 unsigned char *Start = (unsigned char *)Ptr;
150 unsigned Amount = (unsigned char *)End - Start;
Misha Brukman8a96c532005-04-21 21:44:41 +0000151 if (At+Amount > BlockEnd)
Reid Spencer24399722004-07-09 22:21:33 +0000152 error("Ran out of data!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000153 std::copy(At, At+Amount, Start);
154 At += Amount;
155}
156
Reid Spencer46b002c2004-07-11 17:28:43 +0000157/// Read a float value in little-endian order
158inline void BytecodeReader::read_float(float& FloatVal) {
Reid Spencerada16182004-07-25 21:36:26 +0000159 /// FIXME: This isn't optimal, it has size problems on some platforms
160 /// where FP is not IEEE.
Jim Laskeycb6682f2005-08-17 19:34:49 +0000161 FloatVal = BitsToFloat(At[0] | (At[1] << 8) | (At[2] << 16) | (At[3] << 24));
Reid Spencerada16182004-07-25 21:36:26 +0000162 At+=sizeof(uint32_t);
Reid Spencer46b002c2004-07-11 17:28:43 +0000163}
164
165/// Read a double value in little-endian order
166inline void BytecodeReader::read_double(double& DoubleVal) {
Reid Spencerada16182004-07-25 21:36:26 +0000167 /// FIXME: This isn't optimal, it has size problems on some platforms
168 /// where FP is not IEEE.
Jim Laskeycb6682f2005-08-17 19:34:49 +0000169 DoubleVal = BitsToDouble((uint64_t(At[0]) << 0) | (uint64_t(At[1]) << 8) |
170 (uint64_t(At[2]) << 16) | (uint64_t(At[3]) << 24) |
171 (uint64_t(At[4]) << 32) | (uint64_t(At[5]) << 40) |
172 (uint64_t(At[6]) << 48) | (uint64_t(At[7]) << 56));
Reid Spencerada16182004-07-25 21:36:26 +0000173 At+=sizeof(uint64_t);
Reid Spencer46b002c2004-07-11 17:28:43 +0000174}
175
Reid Spencer04cde2c2004-07-04 11:33:49 +0000176/// Read a block header and obtain its type and size
Reid Spencer060d25d2004-06-29 23:29:38 +0000177inline void BytecodeReader::read_block(unsigned &Type, unsigned &Size) {
Reid Spencerd798a512006-11-14 04:47:22 +0000178 Size = read_uint(); // Read the header
179 Type = Size & 0x1F; // mask low order five bits to get type
180 Size >>= 5; // high order 27 bits is the size
Reid Spencer060d25d2004-06-29 23:29:38 +0000181 BlockStart = At;
Reid Spencer46b002c2004-07-11 17:28:43 +0000182 if (At + Size > BlockEnd)
Reid Spencer24399722004-07-09 22:21:33 +0000183 error("Attempt to size a block past end of memory");
Reid Spencer060d25d2004-06-29 23:29:38 +0000184 BlockEnd = At + Size;
Reid Spencer46b002c2004-07-11 17:28:43 +0000185 if (Handler) Handler->handleBlock(Type, BlockStart, Size);
Reid Spencer04cde2c2004-07-04 11:33:49 +0000186}
187
Reid Spencer060d25d2004-06-29 23:29:38 +0000188//===----------------------------------------------------------------------===//
189// IR Lookup Methods
190//===----------------------------------------------------------------------===//
191
Reid Spencer04cde2c2004-07-04 11:33:49 +0000192/// Determine if a type id has an implicit null value
Reid Spencer46b002c2004-07-11 17:28:43 +0000193inline bool BytecodeReader::hasImplicitNull(unsigned TyID) {
Reid Spencerd798a512006-11-14 04:47:22 +0000194 return TyID != Type::LabelTyID && TyID != Type::VoidTyID;
Reid Spencer060d25d2004-06-29 23:29:38 +0000195}
196
Reid Spencerd2bb8872007-01-30 19:36:46 +0000197/// Obtain a type given a typeid and account for things like function level vs
198/// module level, and the offsetting for the primitive types.
Reid Spencer060d25d2004-06-29 23:29:38 +0000199const Type *BytecodeReader::getType(unsigned ID) {
Reid Spencera54b7cb2007-01-12 07:05:14 +0000200 if (ID <= Type::LastPrimitiveTyID)
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000201 if (const Type *T = Type::getPrimitiveType((Type::TypeID)ID))
Chris Lattner927b1852003-10-09 20:22:47 +0000202 return T; // Asked for a primitive type...
Chris Lattner36392bc2003-10-08 21:18:57 +0000203
204 // Otherwise, derived types need offset...
Chris Lattner89e02532004-01-18 21:08:15 +0000205 ID -= Type::FirstDerivedTyID;
206
Chris Lattner36392bc2003-10-08 21:18:57 +0000207 // Is it a module-level type?
Reid Spencer46b002c2004-07-11 17:28:43 +0000208 if (ID < ModuleTypes.size())
209 return ModuleTypes[ID].get();
Chris Lattner36392bc2003-10-08 21:18:57 +0000210
Reid Spencer46b002c2004-07-11 17:28:43 +0000211 // Nope, is it a function-level type?
212 ID -= ModuleTypes.size();
213 if (ID < FunctionTypes.size())
214 return FunctionTypes[ID].get();
Chris Lattner36392bc2003-10-08 21:18:57 +0000215
Reid Spencer46b002c2004-07-11 17:28:43 +0000216 error("Illegal type reference!");
217 return Type::VoidTy;
Chris Lattner00950542001-06-06 20:29:01 +0000218}
219
Reid Spencer3795ad12006-12-03 05:47:10 +0000220/// This method just saves some coding. It uses read_vbr_uint to read in a
221/// type id, errors that its not the type type, and then calls getType to
222/// return the type value.
Reid Spencerd798a512006-11-14 04:47:22 +0000223inline const Type* BytecodeReader::readType() {
224 return getType(read_vbr_uint());
Reid Spencer04cde2c2004-07-04 11:33:49 +0000225}
226
227/// Get the slot number associated with a type accounting for primitive
Reid Spencerd2bb8872007-01-30 19:36:46 +0000228/// types and function level vs module level.
Reid Spencer060d25d2004-06-29 23:29:38 +0000229unsigned BytecodeReader::getTypeSlot(const Type *Ty) {
230 if (Ty->isPrimitiveType())
231 return Ty->getTypeID();
232
Reid Spencer060d25d2004-06-29 23:29:38 +0000233 // Check the function level types first...
Chris Lattnera79e7cc2004-10-16 18:18:16 +0000234 TypeListTy::iterator I = std::find(FunctionTypes.begin(),
235 FunctionTypes.end(), Ty);
Reid Spencer060d25d2004-06-29 23:29:38 +0000236
237 if (I != FunctionTypes.end())
Misha Brukman8a96c532005-04-21 21:44:41 +0000238 return Type::FirstDerivedTyID + ModuleTypes.size() +
Reid Spencer46b002c2004-07-11 17:28:43 +0000239 (&*I - &FunctionTypes[0]);
Reid Spencer060d25d2004-06-29 23:29:38 +0000240
Chris Lattnereebac5f2005-10-03 21:26:53 +0000241 // If we don't have our cache yet, build it now.
242 if (ModuleTypeIDCache.empty()) {
243 unsigned N = 0;
244 ModuleTypeIDCache.reserve(ModuleTypes.size());
245 for (TypeListTy::iterator I = ModuleTypes.begin(), E = ModuleTypes.end();
246 I != E; ++I, ++N)
247 ModuleTypeIDCache.push_back(std::make_pair(*I, N));
248
249 std::sort(ModuleTypeIDCache.begin(), ModuleTypeIDCache.end());
250 }
251
252 // Binary search the cache for the entry.
253 std::vector<std::pair<const Type*, unsigned> >::iterator IT =
254 std::lower_bound(ModuleTypeIDCache.begin(), ModuleTypeIDCache.end(),
255 std::make_pair(Ty, 0U));
256 if (IT == ModuleTypeIDCache.end() || IT->first != Ty)
Reid Spencer24399722004-07-09 22:21:33 +0000257 error("Didn't find type in ModuleTypes.");
Chris Lattnereebac5f2005-10-03 21:26:53 +0000258
259 return Type::FirstDerivedTyID + IT->second;
Chris Lattner80b97342004-01-17 23:25:43 +0000260}
261
Misha Brukman8a96c532005-04-21 21:44:41 +0000262/// Retrieve a value of a given type and slot number, possibly creating
263/// it if it doesn't already exist.
Reid Spencer060d25d2004-06-29 23:29:38 +0000264Value * BytecodeReader::getValue(unsigned type, unsigned oNum, bool Create) {
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000265 assert(type != Type::LabelTyID && "getValue() cannot get blocks!");
Chris Lattner00950542001-06-06 20:29:01 +0000266 unsigned Num = oNum;
Chris Lattner00950542001-06-06 20:29:01 +0000267
Reid Spencerd2bb8872007-01-30 19:36:46 +0000268 // By default, the global type id is the type id passed in
269 unsigned GlobalTyID = type;
Reid Spencer060d25d2004-06-29 23:29:38 +0000270
Reid Spencerd2bb8872007-01-30 19:36:46 +0000271 if (hasImplicitNull(GlobalTyID)) {
272 const Type *Ty = getType(type);
273 if (!isa<OpaqueType>(Ty)) {
274 if (Num == 0)
275 return Constant::getNullValue(Ty);
276 --Num;
Chris Lattner89e02532004-01-18 21:08:15 +0000277 }
Reid Spencerd2bb8872007-01-30 19:36:46 +0000278 }
Chris Lattner89e02532004-01-18 21:08:15 +0000279
Reid Spencer8dd4f532007-04-08 23:58:41 +0000280 if (GlobalTyID < ModuleValues.size())
281 if (ValueList *Globals = ModuleValues[GlobalTyID]) {
282 if (Num < Globals->size())
283 return Globals->getOperand(Num);
284 Num -= Globals->size();
285 }
Chris Lattner52e20b02003-03-19 20:54:26 +0000286
Reid Spencer8dd4f532007-04-08 23:58:41 +0000287 if (type < FunctionValues.size())
288 if (ValueList *Locals = FunctionValues[type])
289 if (Num < Locals->size())
290 return Locals->getOperand(Num);
Chris Lattner00950542001-06-06 20:29:01 +0000291
Reid Spencer91ac04a2007-04-09 06:14:31 +0000292 // We did not find the value.
293
Chris Lattner74734132002-08-17 22:01:27 +0000294 if (!Create) return 0; // Do not create a placeholder?
Chris Lattner00950542001-06-06 20:29:01 +0000295
Reid Spencer551ccae2004-09-01 22:55:40 +0000296 // Did we already create a place holder?
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000297 std::pair<unsigned,unsigned> KeyValue(type, oNum);
Reid Spencer060d25d2004-06-29 23:29:38 +0000298 ForwardReferenceMap::iterator I = ForwardReferences.lower_bound(KeyValue);
Chris Lattner8eb10ce2003-10-09 06:05:40 +0000299 if (I != ForwardReferences.end() && I->first == KeyValue)
300 return I->second; // We have already created this placeholder
301
Reid Spencer551ccae2004-09-01 22:55:40 +0000302 // If the type exists (it should)
303 if (const Type* Ty = getType(type)) {
304 // Create the place holder
305 Value *Val = new Argument(Ty);
306 ForwardReferences.insert(I, std::make_pair(KeyValue, Val));
307 return Val;
308 }
Reid Spencer233fe722006-08-22 16:09:19 +0000309 error("Can't create placeholder for value of type slot #" + utostr(type));
310 return 0; // just silence warning, error calls longjmp
Chris Lattner00950542001-06-06 20:29:01 +0000311}
312
Reid Spencer060d25d2004-06-29 23:29:38 +0000313
Reid Spencer04cde2c2004-07-04 11:33:49 +0000314/// Just like getValue, except that it returns a null pointer
315/// only on error. It always returns a constant (meaning that if the value is
316/// defined, but is not a constant, that is an error). If the specified
Misha Brukman8a96c532005-04-21 21:44:41 +0000317/// constant hasn't been parsed yet, a placeholder is defined and used.
Reid Spencer04cde2c2004-07-04 11:33:49 +0000318/// Later, after the real value is parsed, the placeholder is eliminated.
Reid Spencer060d25d2004-06-29 23:29:38 +0000319Constant* BytecodeReader::getConstantValue(unsigned TypeSlot, unsigned Slot) {
320 if (Value *V = getValue(TypeSlot, Slot, false))
321 if (Constant *C = dyn_cast<Constant>(V))
322 return C; // If we already have the value parsed, just return it
Reid Spencer060d25d2004-06-29 23:29:38 +0000323 else
Misha Brukman8a96c532005-04-21 21:44:41 +0000324 error("Value for slot " + utostr(Slot) +
Reid Spencera86037e2004-07-18 00:12:03 +0000325 " is expected to be a constant!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000326
Chris Lattner389bd042004-12-09 06:19:44 +0000327 std::pair<unsigned, unsigned> Key(TypeSlot, Slot);
Reid Spencer060d25d2004-06-29 23:29:38 +0000328 ConstantRefsType::iterator I = ConstantFwdRefs.lower_bound(Key);
329
330 if (I != ConstantFwdRefs.end() && I->first == Key) {
331 return I->second;
332 } else {
333 // Create a placeholder for the constant reference and
334 // keep track of the fact that we have a forward ref to recycle it
Chris Lattner389bd042004-12-09 06:19:44 +0000335 Constant *C = new ConstantPlaceHolder(getType(TypeSlot));
Misha Brukman8a96c532005-04-21 21:44:41 +0000336
Reid Spencer060d25d2004-06-29 23:29:38 +0000337 // Keep track of the fact that we have a forward ref to recycle it
338 ConstantFwdRefs.insert(I, std::make_pair(Key, C));
339 return C;
340 }
341}
342
343//===----------------------------------------------------------------------===//
344// IR Construction Methods
345//===----------------------------------------------------------------------===//
346
Reid Spencer04cde2c2004-07-04 11:33:49 +0000347/// As values are created, they are inserted into the appropriate place
348/// with this method. The ValueTable argument must be one of ModuleValues
349/// or FunctionValues data members of this class.
Misha Brukman8a96c532005-04-21 21:44:41 +0000350unsigned BytecodeReader::insertValue(Value *Val, unsigned type,
Reid Spencer46b002c2004-07-11 17:28:43 +0000351 ValueTable &ValueTab) {
Reid Spencer060d25d2004-06-29 23:29:38 +0000352 if (ValueTab.size() <= type)
353 ValueTab.resize(type+1);
354
355 if (!ValueTab[type]) ValueTab[type] = new ValueList();
356
357 ValueTab[type]->push_back(Val);
358
Chris Lattneraba5ff52005-05-05 20:57:00 +0000359 bool HasOffset = hasImplicitNull(type) && !isa<OpaqueType>(Val->getType());
Reid Spencer060d25d2004-06-29 23:29:38 +0000360 return ValueTab[type]->size()-1 + HasOffset;
361}
362
Reid Spencer04cde2c2004-07-04 11:33:49 +0000363/// Insert the arguments of a function as new values in the reader.
Reid Spencer46b002c2004-07-11 17:28:43 +0000364void BytecodeReader::insertArguments(Function* F) {
Reid Spencer060d25d2004-06-29 23:29:38 +0000365 const FunctionType *FT = F->getFunctionType();
Chris Lattnere4d5c442005-03-15 04:54:21 +0000366 Function::arg_iterator AI = F->arg_begin();
Reid Spencer060d25d2004-06-29 23:29:38 +0000367 for (FunctionType::param_iterator It = FT->param_begin();
368 It != FT->param_end(); ++It, ++AI)
369 insertValue(AI, getTypeSlot(AI->getType()), FunctionValues);
370}
371
372//===----------------------------------------------------------------------===//
373// Bytecode Parsing Methods
374//===----------------------------------------------------------------------===//
375
Reid Spencer04cde2c2004-07-04 11:33:49 +0000376/// This method parses a single instruction. The instruction is
377/// inserted at the end of the \p BB provided. The arguments of
Misha Brukman44666b12004-09-28 16:57:46 +0000378/// the instruction are provided in the \p Oprnds vector.
Chris Lattner63cf59e2007-02-07 05:08:39 +0000379void BytecodeReader::ParseInstruction(SmallVector<unsigned, 8> &Oprnds,
Reid Spencer46b002c2004-07-11 17:28:43 +0000380 BasicBlock* BB) {
Reid Spencer060d25d2004-06-29 23:29:38 +0000381 BufPtr SaveAt = At;
382
383 // Clear instruction data
384 Oprnds.clear();
385 unsigned iType = 0;
386 unsigned Opcode = 0;
387 unsigned Op = read_uint();
388
389 // bits Instruction format: Common to all formats
390 // --------------------------
391 // 01-00: Opcode type, fixed to 1.
392 // 07-02: Opcode
393 Opcode = (Op >> 2) & 63;
394 Oprnds.resize((Op >> 0) & 03);
395
396 // Extract the operands
397 switch (Oprnds.size()) {
398 case 1:
399 // bits Instruction format:
400 // --------------------------
401 // 19-08: Resulting type plane
402 // 31-20: Operand #1 (if set to (2^12-1), then zero operands)
403 //
404 iType = (Op >> 8) & 4095;
405 Oprnds[0] = (Op >> 20) & 4095;
406 if (Oprnds[0] == 4095) // Handle special encoding for 0 operands...
407 Oprnds.resize(0);
408 break;
409 case 2:
410 // bits Instruction format:
411 // --------------------------
412 // 15-08: Resulting type plane
413 // 23-16: Operand #1
Misha Brukman8a96c532005-04-21 21:44:41 +0000414 // 31-24: Operand #2
Reid Spencer060d25d2004-06-29 23:29:38 +0000415 //
416 iType = (Op >> 8) & 255;
417 Oprnds[0] = (Op >> 16) & 255;
418 Oprnds[1] = (Op >> 24) & 255;
419 break;
420 case 3:
421 // bits Instruction format:
422 // --------------------------
423 // 13-08: Resulting type plane
424 // 19-14: Operand #1
425 // 25-20: Operand #2
426 // 31-26: Operand #3
427 //
428 iType = (Op >> 8) & 63;
429 Oprnds[0] = (Op >> 14) & 63;
430 Oprnds[1] = (Op >> 20) & 63;
431 Oprnds[2] = (Op >> 26) & 63;
432 break;
433 case 0:
434 At -= 4; // Hrm, try this again...
435 Opcode = read_vbr_uint();
436 Opcode >>= 2;
437 iType = read_vbr_uint();
438
439 unsigned NumOprnds = read_vbr_uint();
440 Oprnds.resize(NumOprnds);
441
442 if (NumOprnds == 0)
Reid Spencer24399722004-07-09 22:21:33 +0000443 error("Zero-argument instruction found; this is invalid.");
Reid Spencer060d25d2004-06-29 23:29:38 +0000444
445 for (unsigned i = 0; i != NumOprnds; ++i)
446 Oprnds[i] = read_vbr_uint();
Reid Spencer060d25d2004-06-29 23:29:38 +0000447 break;
448 }
449
Reid Spencerd798a512006-11-14 04:47:22 +0000450 const Type *InstTy = getType(iType);
Reid Spencer060d25d2004-06-29 23:29:38 +0000451
Reid Spencer1628cec2006-10-26 06:15:43 +0000452 // Make the necessary adjustments for dealing with backwards compatibility
453 // of opcodes.
Reid Spencer3795ad12006-12-03 05:47:10 +0000454 Instruction* Result = 0;
Reid Spencer1628cec2006-10-26 06:15:43 +0000455
Reid Spencer3795ad12006-12-03 05:47:10 +0000456 // First, handle the easy binary operators case
457 if (Opcode >= Instruction::BinaryOpsBegin &&
Reid Spencerc8dab492006-12-03 06:28:54 +0000458 Opcode < Instruction::BinaryOpsEnd && Oprnds.size() == 2) {
Reid Spencer3795ad12006-12-03 05:47:10 +0000459 Result = BinaryOperator::create(Instruction::BinaryOps(Opcode),
460 getValue(iType, Oprnds[0]),
461 getValue(iType, Oprnds[1]));
Reid Spencerc8dab492006-12-03 06:28:54 +0000462 } else {
Reid Spencer1628cec2006-10-26 06:15:43 +0000463 // Indicate that we don't think this is a call instruction (yet).
464 // Process based on the Opcode read
465 switch (Opcode) {
466 default: // There was an error, this shouldn't happen.
467 if (Result == 0)
468 error("Illegal instruction read!");
469 break;
470 case Instruction::VAArg:
471 if (Oprnds.size() != 2)
472 error("Invalid VAArg instruction!");
473 Result = new VAArgInst(getValue(iType, Oprnds[0]),
Reid Spencerd798a512006-11-14 04:47:22 +0000474 getType(Oprnds[1]));
Reid Spencer1628cec2006-10-26 06:15:43 +0000475 break;
476 case Instruction::ExtractElement: {
477 if (Oprnds.size() != 2)
478 error("Invalid extractelement instruction!");
479 Value *V1 = getValue(iType, Oprnds[0]);
Reid Spencera54b7cb2007-01-12 07:05:14 +0000480 Value *V2 = getValue(Int32TySlot, Oprnds[1]);
Chris Lattner59fecec2006-04-08 04:09:19 +0000481
Reid Spencer1628cec2006-10-26 06:15:43 +0000482 if (!ExtractElementInst::isValidOperands(V1, V2))
483 error("Invalid extractelement instruction!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000484
Reid Spencer1628cec2006-10-26 06:15:43 +0000485 Result = new ExtractElementInst(V1, V2);
486 break;
Chris Lattnera65371e2006-05-26 18:42:34 +0000487 }
Reid Spencer1628cec2006-10-26 06:15:43 +0000488 case Instruction::InsertElement: {
Reid Spencerac9dcb92007-02-15 03:39:18 +0000489 const VectorType *VectorTy = dyn_cast<VectorType>(InstTy);
490 if (!VectorTy || Oprnds.size() != 3)
Reid Spencer1628cec2006-10-26 06:15:43 +0000491 error("Invalid insertelement instruction!");
492
493 Value *V1 = getValue(iType, Oprnds[0]);
Reid Spencerac9dcb92007-02-15 03:39:18 +0000494 Value *V2 = getValue(getTypeSlot(VectorTy->getElementType()),Oprnds[1]);
Reid Spencera54b7cb2007-01-12 07:05:14 +0000495 Value *V3 = getValue(Int32TySlot, Oprnds[2]);
Reid Spencer1628cec2006-10-26 06:15:43 +0000496
497 if (!InsertElementInst::isValidOperands(V1, V2, V3))
498 error("Invalid insertelement instruction!");
499 Result = new InsertElementInst(V1, V2, V3);
500 break;
501 }
502 case Instruction::ShuffleVector: {
Reid Spencerac9dcb92007-02-15 03:39:18 +0000503 const VectorType *VectorTy = dyn_cast<VectorType>(InstTy);
504 if (!VectorTy || Oprnds.size() != 3)
Reid Spencer1628cec2006-10-26 06:15:43 +0000505 error("Invalid shufflevector instruction!");
506 Value *V1 = getValue(iType, Oprnds[0]);
507 Value *V2 = getValue(iType, Oprnds[1]);
Reid Spencer9d6565a2007-02-15 02:26:10 +0000508 const VectorType *EltTy =
Reid Spencerac9dcb92007-02-15 03:39:18 +0000509 VectorType::get(Type::Int32Ty, VectorTy->getNumElements());
Reid Spencer1628cec2006-10-26 06:15:43 +0000510 Value *V3 = getValue(getTypeSlot(EltTy), Oprnds[2]);
511 if (!ShuffleVectorInst::isValidOperands(V1, V2, V3))
512 error("Invalid shufflevector instruction!");
513 Result = new ShuffleVectorInst(V1, V2, V3);
514 break;
515 }
Reid Spencer3da59db2006-11-27 01:05:10 +0000516 case Instruction::Trunc:
517 if (Oprnds.size() != 2)
518 error("Invalid cast instruction!");
519 Result = new TruncInst(getValue(iType, Oprnds[0]),
520 getType(Oprnds[1]));
521 break;
522 case Instruction::ZExt:
523 if (Oprnds.size() != 2)
524 error("Invalid cast instruction!");
525 Result = new ZExtInst(getValue(iType, Oprnds[0]),
526 getType(Oprnds[1]));
527 break;
528 case Instruction::SExt:
Reid Spencer1628cec2006-10-26 06:15:43 +0000529 if (Oprnds.size() != 2)
530 error("Invalid Cast instruction!");
Reid Spencer3da59db2006-11-27 01:05:10 +0000531 Result = new SExtInst(getValue(iType, Oprnds[0]),
Reid Spencerd798a512006-11-14 04:47:22 +0000532 getType(Oprnds[1]));
Reid Spencer1628cec2006-10-26 06:15:43 +0000533 break;
Reid Spencer3da59db2006-11-27 01:05:10 +0000534 case Instruction::FPTrunc:
535 if (Oprnds.size() != 2)
536 error("Invalid cast instruction!");
537 Result = new FPTruncInst(getValue(iType, Oprnds[0]),
538 getType(Oprnds[1]));
539 break;
540 case Instruction::FPExt:
541 if (Oprnds.size() != 2)
542 error("Invalid cast instruction!");
543 Result = new FPExtInst(getValue(iType, Oprnds[0]),
544 getType(Oprnds[1]));
545 break;
546 case Instruction::UIToFP:
547 if (Oprnds.size() != 2)
548 error("Invalid cast instruction!");
549 Result = new UIToFPInst(getValue(iType, Oprnds[0]),
550 getType(Oprnds[1]));
551 break;
552 case Instruction::SIToFP:
553 if (Oprnds.size() != 2)
554 error("Invalid cast instruction!");
555 Result = new SIToFPInst(getValue(iType, Oprnds[0]),
556 getType(Oprnds[1]));
557 break;
558 case Instruction::FPToUI:
559 if (Oprnds.size() != 2)
560 error("Invalid cast instruction!");
561 Result = new FPToUIInst(getValue(iType, Oprnds[0]),
562 getType(Oprnds[1]));
563 break;
564 case Instruction::FPToSI:
565 if (Oprnds.size() != 2)
566 error("Invalid cast instruction!");
567 Result = new FPToSIInst(getValue(iType, Oprnds[0]),
568 getType(Oprnds[1]));
569 break;
570 case Instruction::IntToPtr:
571 if (Oprnds.size() != 2)
572 error("Invalid cast instruction!");
573 Result = new IntToPtrInst(getValue(iType, Oprnds[0]),
574 getType(Oprnds[1]));
575 break;
576 case Instruction::PtrToInt:
577 if (Oprnds.size() != 2)
578 error("Invalid cast instruction!");
579 Result = new PtrToIntInst(getValue(iType, Oprnds[0]),
580 getType(Oprnds[1]));
581 break;
582 case Instruction::BitCast:
583 if (Oprnds.size() != 2)
584 error("Invalid cast instruction!");
585 Result = new BitCastInst(getValue(iType, Oprnds[0]),
586 getType(Oprnds[1]));
587 break;
Reid Spencer1628cec2006-10-26 06:15:43 +0000588 case Instruction::Select:
589 if (Oprnds.size() != 3)
590 error("Invalid Select instruction!");
Reid Spencera54b7cb2007-01-12 07:05:14 +0000591 Result = new SelectInst(getValue(BoolTySlot, Oprnds[0]),
Reid Spencer1628cec2006-10-26 06:15:43 +0000592 getValue(iType, Oprnds[1]),
593 getValue(iType, Oprnds[2]));
594 break;
595 case Instruction::PHI: {
596 if (Oprnds.size() == 0 || (Oprnds.size() & 1))
597 error("Invalid phi node encountered!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000598
Reid Spencer1628cec2006-10-26 06:15:43 +0000599 PHINode *PN = new PHINode(InstTy);
600 PN->reserveOperandSpace(Oprnds.size());
601 for (unsigned i = 0, e = Oprnds.size(); i != e; i += 2)
602 PN->addIncoming(
603 getValue(iType, Oprnds[i]), getBasicBlock(Oprnds[i+1]));
604 Result = PN;
605 break;
606 }
Reid Spencerc8dab492006-12-03 06:28:54 +0000607 case Instruction::ICmp:
608 case Instruction::FCmp:
Reid Spencer9f132762006-12-03 17:17:02 +0000609 if (Oprnds.size() != 3)
610 error("Cmp instructions requires 3 operands");
Reid Spencerc8dab492006-12-03 06:28:54 +0000611 // These instructions encode the comparison predicate as the 3rd operand.
612 Result = CmpInst::create(Instruction::OtherOps(Opcode),
613 static_cast<unsigned short>(Oprnds[2]),
614 getValue(iType, Oprnds[0]), getValue(iType, Oprnds[1]));
615 break;
Reid Spencer1628cec2006-10-26 06:15:43 +0000616 case Instruction::Ret:
617 if (Oprnds.size() == 0)
618 Result = new ReturnInst();
619 else if (Oprnds.size() == 1)
620 Result = new ReturnInst(getValue(iType, Oprnds[0]));
621 else
622 error("Unrecognized instruction!");
623 break;
624
625 case Instruction::Br:
626 if (Oprnds.size() == 1)
627 Result = new BranchInst(getBasicBlock(Oprnds[0]));
628 else if (Oprnds.size() == 3)
629 Result = new BranchInst(getBasicBlock(Oprnds[0]),
Reid Spencera54b7cb2007-01-12 07:05:14 +0000630 getBasicBlock(Oprnds[1]), getValue(BoolTySlot, Oprnds[2]));
Reid Spencer1628cec2006-10-26 06:15:43 +0000631 else
632 error("Invalid number of operands for a 'br' instruction!");
633 break;
634 case Instruction::Switch: {
635 if (Oprnds.size() & 1)
636 error("Switch statement with odd number of arguments!");
637
638 SwitchInst *I = new SwitchInst(getValue(iType, Oprnds[0]),
639 getBasicBlock(Oprnds[1]),
640 Oprnds.size()/2-1);
641 for (unsigned i = 2, e = Oprnds.size(); i != e; i += 2)
642 I->addCase(cast<ConstantInt>(getValue(iType, Oprnds[i])),
643 getBasicBlock(Oprnds[i+1]));
644 Result = I;
645 break;
646 }
647 case 58: // Call with extra operand for calling conv
648 case 59: // tail call, Fast CC
649 case 60: // normal call, Fast CC
650 case 61: // tail call, C Calling Conv
651 case Instruction::Call: { // Normal Call, C Calling Convention
652 if (Oprnds.size() == 0)
653 error("Invalid call instruction encountered!");
Reid Spencer1628cec2006-10-26 06:15:43 +0000654 Value *F = getValue(iType, Oprnds[0]);
655
656 unsigned CallingConv = CallingConv::C;
657 bool isTailCall = false;
658
659 if (Opcode == 61 || Opcode == 59)
660 isTailCall = true;
661
662 if (Opcode == 58) {
663 isTailCall = Oprnds.back() & 1;
664 CallingConv = Oprnds.back() >> 1;
665 Oprnds.pop_back();
666 } else if (Opcode == 59 || Opcode == 60) {
667 CallingConv = CallingConv::Fast;
668 }
669
670 // Check to make sure we have a pointer to function type
671 const PointerType *PTy = dyn_cast<PointerType>(F->getType());
672 if (PTy == 0) error("Call to non function pointer value!");
673 const FunctionType *FTy = dyn_cast<FunctionType>(PTy->getElementType());
674 if (FTy == 0) error("Call to non function pointer value!");
675
Chris Lattnerd0e44c22007-02-13 06:30:42 +0000676 SmallVector<Value *, 8> Params;
Reid Spencer1628cec2006-10-26 06:15:43 +0000677 if (!FTy->isVarArg()) {
678 FunctionType::param_iterator It = FTy->param_begin();
679
680 for (unsigned i = 1, e = Oprnds.size(); i != e; ++i) {
681 if (It == FTy->param_end())
682 error("Invalid call instruction!");
683 Params.push_back(getValue(getTypeSlot(*It++), Oprnds[i]));
684 }
685 if (It != FTy->param_end())
Reid Spencer24399722004-07-09 22:21:33 +0000686 error("Invalid call instruction!");
Reid Spencer1628cec2006-10-26 06:15:43 +0000687 } else {
688 Oprnds.erase(Oprnds.begin(), Oprnds.begin()+1);
689
690 unsigned FirstVariableOperand;
691 if (Oprnds.size() < FTy->getNumParams())
692 error("Call instruction missing operands!");
693
694 // Read all of the fixed arguments
695 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
696 Params.push_back(
697 getValue(getTypeSlot(FTy->getParamType(i)),Oprnds[i]));
698
699 FirstVariableOperand = FTy->getNumParams();
700
701 if ((Oprnds.size()-FirstVariableOperand) & 1)
702 error("Invalid call instruction!"); // Must be pairs of type/value
703
704 for (unsigned i = FirstVariableOperand, e = Oprnds.size();
705 i != e; i += 2)
706 Params.push_back(getValue(Oprnds[i], Oprnds[i+1]));
Reid Spencer060d25d2004-06-29 23:29:38 +0000707 }
Reid Spencer060d25d2004-06-29 23:29:38 +0000708
Chris Lattnere4339192007-02-13 01:53:54 +0000709 Result = new CallInst(F, &Params[0], Params.size());
Reid Spencer1628cec2006-10-26 06:15:43 +0000710 if (isTailCall) cast<CallInst>(Result)->setTailCall();
711 if (CallingConv) cast<CallInst>(Result)->setCallingConv(CallingConv);
712 break;
Reid Spencer060d25d2004-06-29 23:29:38 +0000713 }
Reid Spencer1628cec2006-10-26 06:15:43 +0000714 case Instruction::Invoke: { // Invoke C CC
715 if (Oprnds.size() < 3)
716 error("Invalid invoke instruction!");
717 Value *F = getValue(iType, Oprnds[0]);
Reid Spencer060d25d2004-06-29 23:29:38 +0000718
Reid Spencer1628cec2006-10-26 06:15:43 +0000719 // Check to make sure we have a pointer to function type
720 const PointerType *PTy = dyn_cast<PointerType>(F->getType());
721 if (PTy == 0)
722 error("Invoke to non function pointer value!");
723 const FunctionType *FTy = dyn_cast<FunctionType>(PTy->getElementType());
724 if (FTy == 0)
725 error("Invoke to non function pointer value!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000726
Chris Lattnerd0e44c22007-02-13 06:30:42 +0000727 SmallVector<Value *, 8> Params;
Reid Spencer1628cec2006-10-26 06:15:43 +0000728 BasicBlock *Normal, *Except;
Reid Spencer3da59db2006-11-27 01:05:10 +0000729 unsigned CallingConv = Oprnds.back();
730 Oprnds.pop_back();
Chris Lattnerdee199f2005-05-06 22:34:01 +0000731
Reid Spencer1628cec2006-10-26 06:15:43 +0000732 if (!FTy->isVarArg()) {
733 Normal = getBasicBlock(Oprnds[1]);
734 Except = getBasicBlock(Oprnds[2]);
Reid Spencer060d25d2004-06-29 23:29:38 +0000735
Reid Spencer1628cec2006-10-26 06:15:43 +0000736 FunctionType::param_iterator It = FTy->param_begin();
737 for (unsigned i = 3, e = Oprnds.size(); i != e; ++i) {
738 if (It == FTy->param_end())
739 error("Invalid invoke instruction!");
740 Params.push_back(getValue(getTypeSlot(*It++), Oprnds[i]));
741 }
742 if (It != FTy->param_end())
Reid Spencer24399722004-07-09 22:21:33 +0000743 error("Invalid invoke instruction!");
Reid Spencer1628cec2006-10-26 06:15:43 +0000744 } else {
745 Oprnds.erase(Oprnds.begin(), Oprnds.begin()+1);
746
747 Normal = getBasicBlock(Oprnds[0]);
748 Except = getBasicBlock(Oprnds[1]);
749
750 unsigned FirstVariableArgument = FTy->getNumParams()+2;
751 for (unsigned i = 2; i != FirstVariableArgument; ++i)
752 Params.push_back(getValue(getTypeSlot(FTy->getParamType(i-2)),
753 Oprnds[i]));
754
755 // Must be type/value pairs. If not, error out.
756 if (Oprnds.size()-FirstVariableArgument & 1)
757 error("Invalid invoke instruction!");
758
759 for (unsigned i = FirstVariableArgument; i < Oprnds.size(); i += 2)
760 Params.push_back(getValue(Oprnds[i], Oprnds[i+1]));
Reid Spencer060d25d2004-06-29 23:29:38 +0000761 }
Reid Spencer060d25d2004-06-29 23:29:38 +0000762
Chris Lattnere4339192007-02-13 01:53:54 +0000763 Result = new InvokeInst(F, Normal, Except, &Params[0], Params.size());
Reid Spencer1628cec2006-10-26 06:15:43 +0000764 if (CallingConv) cast<InvokeInst>(Result)->setCallingConv(CallingConv);
765 break;
Reid Spencer060d25d2004-06-29 23:29:38 +0000766 }
Reid Spencer1628cec2006-10-26 06:15:43 +0000767 case Instruction::Malloc: {
768 unsigned Align = 0;
769 if (Oprnds.size() == 2)
770 Align = (1 << Oprnds[1]) >> 1;
771 else if (Oprnds.size() > 2)
772 error("Invalid malloc instruction!");
773 if (!isa<PointerType>(InstTy))
774 error("Invalid malloc instruction!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000775
Reid Spencer1628cec2006-10-26 06:15:43 +0000776 Result = new MallocInst(cast<PointerType>(InstTy)->getElementType(),
Reid Spencera54b7cb2007-01-12 07:05:14 +0000777 getValue(Int32TySlot, Oprnds[0]), Align);
Reid Spencer1628cec2006-10-26 06:15:43 +0000778 break;
779 }
780 case Instruction::Alloca: {
781 unsigned Align = 0;
782 if (Oprnds.size() == 2)
783 Align = (1 << Oprnds[1]) >> 1;
784 else if (Oprnds.size() > 2)
785 error("Invalid alloca instruction!");
786 if (!isa<PointerType>(InstTy))
787 error("Invalid alloca instruction!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000788
Reid Spencer1628cec2006-10-26 06:15:43 +0000789 Result = new AllocaInst(cast<PointerType>(InstTy)->getElementType(),
Reid Spencera54b7cb2007-01-12 07:05:14 +0000790 getValue(Int32TySlot, Oprnds[0]), Align);
Reid Spencer1628cec2006-10-26 06:15:43 +0000791 break;
792 }
793 case Instruction::Free:
794 if (!isa<PointerType>(InstTy))
795 error("Invalid free instruction!");
796 Result = new FreeInst(getValue(iType, Oprnds[0]));
797 break;
798 case Instruction::GetElementPtr: {
799 if (Oprnds.size() == 0 || !isa<PointerType>(InstTy))
Misha Brukman8a96c532005-04-21 21:44:41 +0000800 error("Invalid getelementptr instruction!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000801
Chris Lattner4c3d3a92007-01-31 19:56:15 +0000802 SmallVector<Value*, 8> Idx;
Reid Spencer1628cec2006-10-26 06:15:43 +0000803
804 const Type *NextTy = InstTy;
805 for (unsigned i = 1, e = Oprnds.size(); i != e; ++i) {
806 const CompositeType *TopTy = dyn_cast_or_null<CompositeType>(NextTy);
807 if (!TopTy)
808 error("Invalid getelementptr instruction!");
809
810 unsigned ValIdx = Oprnds[i];
811 unsigned IdxTy = 0;
Reid Spencerd798a512006-11-14 04:47:22 +0000812 // Struct indices are always uints, sequential type indices can be
813 // any of the 32 or 64-bit integer types. The actual choice of
Reid Spencer88cfda22006-12-31 05:44:24 +0000814 // type is encoded in the low bit of the slot number.
Reid Spencerd798a512006-11-14 04:47:22 +0000815 if (isa<StructType>(TopTy))
Reid Spencera54b7cb2007-01-12 07:05:14 +0000816 IdxTy = Int32TySlot;
Reid Spencerd798a512006-11-14 04:47:22 +0000817 else {
Reid Spencer88cfda22006-12-31 05:44:24 +0000818 switch (ValIdx & 1) {
Reid Spencerd798a512006-11-14 04:47:22 +0000819 default:
Reid Spencera54b7cb2007-01-12 07:05:14 +0000820 case 0: IdxTy = Int32TySlot; break;
821 case 1: IdxTy = Int64TySlot; break;
Reid Spencer060d25d2004-06-29 23:29:38 +0000822 }
Reid Spencer88cfda22006-12-31 05:44:24 +0000823 ValIdx >>= 1;
Reid Spencer060d25d2004-06-29 23:29:38 +0000824 }
Reid Spencer1628cec2006-10-26 06:15:43 +0000825 Idx.push_back(getValue(IdxTy, ValIdx));
Chris Lattner4c3d3a92007-01-31 19:56:15 +0000826 NextTy = GetElementPtrInst::getIndexedType(InstTy, &Idx[0], Idx.size(),
827 true);
Reid Spencer060d25d2004-06-29 23:29:38 +0000828 }
829
Chris Lattner4c3d3a92007-01-31 19:56:15 +0000830 Result = new GetElementPtrInst(getValue(iType, Oprnds[0]),
831 &Idx[0], Idx.size());
Reid Spencer1628cec2006-10-26 06:15:43 +0000832 break;
Reid Spencer060d25d2004-06-29 23:29:38 +0000833 }
Reid Spencer1628cec2006-10-26 06:15:43 +0000834 case 62: // volatile load
835 case Instruction::Load:
836 if (Oprnds.size() != 1 || !isa<PointerType>(InstTy))
837 error("Invalid load instruction!");
838 Result = new LoadInst(getValue(iType, Oprnds[0]), "", Opcode == 62);
839 break;
840 case 63: // volatile store
841 case Instruction::Store: {
842 if (!isa<PointerType>(InstTy) || Oprnds.size() != 2)
843 error("Invalid store instruction!");
Reid Spencer060d25d2004-06-29 23:29:38 +0000844
Reid Spencer1628cec2006-10-26 06:15:43 +0000845 Value *Ptr = getValue(iType, Oprnds[1]);
846 const Type *ValTy = cast<PointerType>(Ptr->getType())->getElementType();
847 Result = new StoreInst(getValue(getTypeSlot(ValTy), Oprnds[0]), Ptr,
848 Opcode == 63);
849 break;
850 }
851 case Instruction::Unwind:
852 if (Oprnds.size() != 0) error("Invalid unwind instruction!");
853 Result = new UnwindInst();
854 break;
855 case Instruction::Unreachable:
856 if (Oprnds.size() != 0) error("Invalid unreachable instruction!");
857 Result = new UnreachableInst();
858 break;
859 } // end switch(Opcode)
Reid Spencer3795ad12006-12-03 05:47:10 +0000860 } // end if !Result
Reid Spencer060d25d2004-06-29 23:29:38 +0000861
Reid Spencere1e96c02006-01-19 07:02:16 +0000862 BB->getInstList().push_back(Result);
863
Reid Spencer060d25d2004-06-29 23:29:38 +0000864 unsigned TypeSlot;
865 if (Result->getType() == InstTy)
866 TypeSlot = iType;
867 else
868 TypeSlot = getTypeSlot(Result->getType());
869
Reid Spenceref9b9a72007-02-05 20:47:22 +0000870 // We have enough info to inform the handler now.
871 if (Handler)
Chris Lattner63cf59e2007-02-07 05:08:39 +0000872 Handler->handleInstruction(Opcode, InstTy, &Oprnds[0], Oprnds.size(),
873 Result, At-SaveAt);
Reid Spenceref9b9a72007-02-05 20:47:22 +0000874
Reid Spencer060d25d2004-06-29 23:29:38 +0000875 insertValue(Result, TypeSlot, FunctionValues);
Reid Spencer060d25d2004-06-29 23:29:38 +0000876}
877
Reid Spencer04cde2c2004-07-04 11:33:49 +0000878/// Get a particular numbered basic block, which might be a forward reference.
Reid Spencerd798a512006-11-14 04:47:22 +0000879/// This works together with ParseInstructionList to handle these forward
880/// references in a clean manner. This function is used when constructing
881/// phi, br, switch, and other instructions that reference basic blocks.
882/// Blocks are numbered sequentially as they appear in the function.
Reid Spencer060d25d2004-06-29 23:29:38 +0000883BasicBlock *BytecodeReader::getBasicBlock(unsigned ID) {
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000884 // Make sure there is room in the table...
885 if (ParsedBasicBlocks.size() <= ID) ParsedBasicBlocks.resize(ID+1);
886
Reid Spencerd798a512006-11-14 04:47:22 +0000887 // First check to see if this is a backwards reference, i.e. this block
888 // has already been created, or if the forward reference has already
Chris Lattner4ee8ef22003-10-08 22:52:54 +0000889 // been created.
890 if (ParsedBasicBlocks[ID])
891 return ParsedBasicBlocks[ID];
892
893 // Otherwise, the basic block has not yet been created. Do so and add it to
894 // the ParsedBasicBlocks list.
895 return ParsedBasicBlocks[ID] = new BasicBlock();
896}
897
Reid Spencer04cde2c2004-07-04 11:33:49 +0000898/// Parse all of the BasicBlock's & Instruction's in the body of a function.
Misha Brukman8a96c532005-04-21 21:44:41 +0000899/// In post 1.0 bytecode files, we no longer emit basic block individually,
Reid Spencer04cde2c2004-07-04 11:33:49 +0000900/// in order to avoid per-basic-block overhead.
Reid Spencerd798a512006-11-14 04:47:22 +0000901/// @returns the number of basic blocks encountered.
Reid Spencer060d25d2004-06-29 23:29:38 +0000902unsigned BytecodeReader::ParseInstructionList(Function* F) {
Chris Lattner8d1dbd22003-12-01 07:05:31 +0000903 unsigned BlockNo = 0;
Chris Lattner63cf59e2007-02-07 05:08:39 +0000904 SmallVector<unsigned, 8> Args;
Chris Lattner8d1dbd22003-12-01 07:05:31 +0000905
Reid Spencer46b002c2004-07-11 17:28:43 +0000906 while (moreInBlock()) {
907 if (Handler) Handler->handleBasicBlockBegin(BlockNo);
Chris Lattner8d1dbd22003-12-01 07:05:31 +0000908 BasicBlock *BB;
909 if (ParsedBasicBlocks.size() == BlockNo)
910 ParsedBasicBlocks.push_back(BB = new BasicBlock());
911 else if (ParsedBasicBlocks[BlockNo] == 0)
912 BB = ParsedBasicBlocks[BlockNo] = new BasicBlock();
913 else
914 BB = ParsedBasicBlocks[BlockNo];
915 ++BlockNo;
916 F->getBasicBlockList().push_back(BB);
917
918 // Read instructions into this basic block until we get to a terminator
Reid Spencer46b002c2004-07-11 17:28:43 +0000919 while (moreInBlock() && !BB->getTerminator())
Reid Spencer060d25d2004-06-29 23:29:38 +0000920 ParseInstruction(Args, BB);
Chris Lattner8d1dbd22003-12-01 07:05:31 +0000921
922 if (!BB->getTerminator())
Reid Spencer24399722004-07-09 22:21:33 +0000923 error("Non-terminated basic block found!");
Reid Spencer5c15fe52004-07-05 00:57:50 +0000924
Reid Spencer46b002c2004-07-11 17:28:43 +0000925 if (Handler) Handler->handleBasicBlockEnd(BlockNo-1);
Chris Lattner8d1dbd22003-12-01 07:05:31 +0000926 }
927
928 return BlockNo;
929}
930
Reid Spencer78d033e2007-01-06 07:24:44 +0000931/// Parse a type symbol table.
932void BytecodeReader::ParseTypeSymbolTable(TypeSymbolTable *TST) {
933 // Type Symtab block header: [num entries]
934 unsigned NumEntries = read_vbr_uint();
935 for (unsigned i = 0; i < NumEntries; ++i) {
936 // Symtab entry: [type slot #][name]
937 unsigned slot = read_vbr_uint();
938 std::string Name = read_str();
939 const Type* T = getType(slot);
940 TST->insert(Name, T);
941 }
942}
943
944/// Parse a value symbol table. This works for both module level and function
Reid Spencer04cde2c2004-07-04 11:33:49 +0000945/// level symbol tables. For function level symbol tables, the CurrentFunction
946/// parameter must be non-zero and the ST parameter must correspond to
947/// CurrentFunction's symbol table. For Module level symbol tables, the
948/// CurrentFunction argument must be zero.
Reid Spencer78d033e2007-01-06 07:24:44 +0000949void BytecodeReader::ParseValueSymbolTable(Function *CurrentFunction,
Reid Spenceref9b9a72007-02-05 20:47:22 +0000950 ValueSymbolTable *VST) {
Reid Spencer78d033e2007-01-06 07:24:44 +0000951
Reid Spenceref9b9a72007-02-05 20:47:22 +0000952 if (Handler) Handler->handleValueSymbolTableBegin(CurrentFunction,VST);
Reid Spencer060d25d2004-06-29 23:29:38 +0000953
Chris Lattner39cacce2003-10-10 05:43:47 +0000954 // Allow efficient basic block lookup by number.
Chris Lattner63cf59e2007-02-07 05:08:39 +0000955 SmallVector<BasicBlock*, 32> BBMap;
Chris Lattner39cacce2003-10-10 05:43:47 +0000956 if (CurrentFunction)
957 for (Function::iterator I = CurrentFunction->begin(),
958 E = CurrentFunction->end(); I != E; ++I)
959 BBMap.push_back(I);
960
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000961 SmallVector<char, 32> NameStr;
962
Reid Spencer46b002c2004-07-11 17:28:43 +0000963 while (moreInBlock()) {
Chris Lattner00950542001-06-06 20:29:01 +0000964 // Symtab block header: [num entries][type id number]
Reid Spencer060d25d2004-06-29 23:29:38 +0000965 unsigned NumEntries = read_vbr_uint();
Reid Spencerd798a512006-11-14 04:47:22 +0000966 unsigned Typ = read_vbr_uint();
Chris Lattner1d670cc2001-09-07 16:37:43 +0000967
Chris Lattner7dc3a2e2003-10-13 14:57:53 +0000968 for (unsigned i = 0; i != NumEntries; ++i) {
Chris Lattner00950542001-06-06 20:29:01 +0000969 // Symtab entry: [def slot #][name]
Reid Spencer060d25d2004-06-29 23:29:38 +0000970 unsigned slot = read_vbr_uint();
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000971 read_str(NameStr);
Reid Spencerd798a512006-11-14 04:47:22 +0000972 Value *V = 0;
Reid Spencera54b7cb2007-01-12 07:05:14 +0000973 if (Typ == LabelTySlot) {
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000974 V = (slot < BBMap.size()) ? BBMap[slot] : 0;
Chris Lattner39cacce2003-10-10 05:43:47 +0000975 } else {
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000976 V = getValue(Typ, slot, false); // Find mapping.
Chris Lattner39cacce2003-10-10 05:43:47 +0000977 }
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000978 if (Handler) Handler->handleSymbolTableValue(Typ, slot,
979 &NameStr[0], NameStr.size());
Reid Spencerd798a512006-11-14 04:47:22 +0000980 if (V == 0)
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000981 error("Failed value look-up for name '" +
982 std::string(NameStr.begin(), NameStr.end()) + "', type #" +
Reid Spenceref9b9a72007-02-05 20:47:22 +0000983 utostr(Typ) + " slot #" + utostr(slot));
Chris Lattnerdd8cec52007-02-12 18:53:43 +0000984 V->setName(&NameStr[0], NameStr.size());
985
986 NameStr.clear();
Chris Lattner00950542001-06-06 20:29:01 +0000987 }
988 }
Reid Spencer060d25d2004-06-29 23:29:38 +0000989 checkPastBlockEnd("Symbol Table");
Reid Spenceref9b9a72007-02-05 20:47:22 +0000990 if (Handler) Handler->handleValueSymbolTableEnd();
Chris Lattner00950542001-06-06 20:29:01 +0000991}
992
Reid Spencer46b002c2004-07-11 17:28:43 +0000993// Parse a single type. The typeid is read in first. If its a primitive type
994// then nothing else needs to be read, we know how to instantiate it. If its
Misha Brukman8a96c532005-04-21 21:44:41 +0000995// a derived type, then additional data is read to fill out the type
Reid Spencer46b002c2004-07-11 17:28:43 +0000996// definition.
997const Type *BytecodeReader::ParseType() {
Reid Spencerd798a512006-11-14 04:47:22 +0000998 unsigned PrimType = read_vbr_uint();
Reid Spencer060d25d2004-06-29 23:29:38 +0000999 const Type *Result = 0;
1000 if ((Result = Type::getPrimitiveType((Type::TypeID)PrimType)))
1001 return Result;
Misha Brukman8a96c532005-04-21 21:44:41 +00001002
Reid Spencer060d25d2004-06-29 23:29:38 +00001003 switch (PrimType) {
Reid Spencera54b7cb2007-01-12 07:05:14 +00001004 case Type::IntegerTyID: {
1005 unsigned NumBits = read_vbr_uint();
1006 Result = IntegerType::get(NumBits);
1007 break;
1008 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001009 case Type::FunctionTyID: {
Reid Spencerd798a512006-11-14 04:47:22 +00001010 const Type *RetType = readType();
Reid Spencer060d25d2004-06-29 23:29:38 +00001011 unsigned NumParams = read_vbr_uint();
1012
1013 std::vector<const Type*> Params;
Reid Spencer88cfda22006-12-31 05:44:24 +00001014 while (NumParams--) {
Reid Spencerd798a512006-11-14 04:47:22 +00001015 Params.push_back(readType());
Reid Spencer88cfda22006-12-31 05:44:24 +00001016 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001017
1018 bool isVarArg = Params.size() && Params.back() == Type::VoidTy;
Reid Spencer91ac04a2007-04-09 06:14:31 +00001019 if (isVarArg)
1020 Params.pop_back();
1021
1022 ParamAttrsList *Attrs = ParseParamAttrsList();
Reid Spencer060d25d2004-06-29 23:29:38 +00001023
Reid Spencer88cfda22006-12-31 05:44:24 +00001024 Result = FunctionType::get(RetType, Params, isVarArg, Attrs);
Reid Spencer060d25d2004-06-29 23:29:38 +00001025 break;
1026 }
1027 case Type::ArrayTyID: {
Reid Spencerd798a512006-11-14 04:47:22 +00001028 const Type *ElementType = readType();
Reid Spencer060d25d2004-06-29 23:29:38 +00001029 unsigned NumElements = read_vbr_uint();
Reid Spencer060d25d2004-06-29 23:29:38 +00001030 Result = ArrayType::get(ElementType, NumElements);
1031 break;
1032 }
Reid Spencer9d6565a2007-02-15 02:26:10 +00001033 case Type::VectorTyID: {
Reid Spencerd798a512006-11-14 04:47:22 +00001034 const Type *ElementType = readType();
Brian Gaeke715c90b2004-08-20 06:00:58 +00001035 unsigned NumElements = read_vbr_uint();
Reid Spencer9d6565a2007-02-15 02:26:10 +00001036 Result = VectorType::get(ElementType, NumElements);
Brian Gaeke715c90b2004-08-20 06:00:58 +00001037 break;
1038 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001039 case Type::StructTyID: {
1040 std::vector<const Type*> Elements;
Reid Spencerd798a512006-11-14 04:47:22 +00001041 unsigned Typ = read_vbr_uint();
Reid Spencer060d25d2004-06-29 23:29:38 +00001042 while (Typ) { // List is terminated by void/0 typeid
1043 Elements.push_back(getType(Typ));
Reid Spencerd798a512006-11-14 04:47:22 +00001044 Typ = read_vbr_uint();
Reid Spencer060d25d2004-06-29 23:29:38 +00001045 }
1046
Andrew Lenharth38ecbf12006-12-08 18:06:16 +00001047 Result = StructType::get(Elements, false);
1048 break;
1049 }
Reid Spencera54b7cb2007-01-12 07:05:14 +00001050 case Type::PackedStructTyID: {
Andrew Lenharth38ecbf12006-12-08 18:06:16 +00001051 std::vector<const Type*> Elements;
1052 unsigned Typ = read_vbr_uint();
1053 while (Typ) { // List is terminated by void/0 typeid
1054 Elements.push_back(getType(Typ));
1055 Typ = read_vbr_uint();
1056 }
1057
1058 Result = StructType::get(Elements, true);
Reid Spencer060d25d2004-06-29 23:29:38 +00001059 break;
1060 }
1061 case Type::PointerTyID: {
Reid Spencerd798a512006-11-14 04:47:22 +00001062 Result = PointerType::get(readType());
Reid Spencer060d25d2004-06-29 23:29:38 +00001063 break;
1064 }
1065
1066 case Type::OpaqueTyID: {
1067 Result = OpaqueType::get();
1068 break;
1069 }
1070
1071 default:
Reid Spencer24399722004-07-09 22:21:33 +00001072 error("Don't know how to deserialize primitive type " + utostr(PrimType));
Reid Spencer060d25d2004-06-29 23:29:38 +00001073 break;
1074 }
Reid Spencer46b002c2004-07-11 17:28:43 +00001075 if (Handler) Handler->handleType(Result);
Reid Spencer060d25d2004-06-29 23:29:38 +00001076 return Result;
1077}
1078
Reid Spencer91ac04a2007-04-09 06:14:31 +00001079ParamAttrsList *BytecodeReader::ParseParamAttrsList() {
1080 unsigned NumAttrs = read_vbr_uint();
1081 ParamAttrsList *Attrs = 0;
1082 if (NumAttrs) {
1083 Attrs = new ParamAttrsList();
1084 while (NumAttrs--) {
1085 uint16_t index = read_vbr_uint();
1086 uint16_t attrs = read_vbr_uint();
1087 Attrs->addAttributes(index, attrs);
1088 }
1089 }
1090 return Attrs;
1091}
1092
1093
Reid Spencer5b472d92004-08-21 20:49:23 +00001094// ParseTypes - We have to use this weird code to handle recursive
Reid Spencer060d25d2004-06-29 23:29:38 +00001095// types. We know that recursive types will only reference the current slab of
1096// values in the type plane, but they can forward reference types before they
1097// have been read. For example, Type #0 might be '{ Ty#1 }' and Type #1 might
1098// be 'Ty#0*'. When reading Type #0, type number one doesn't exist. To fix
1099// this ugly problem, we pessimistically insert an opaque type for each type we
1100// are about to read. This means that forward references will resolve to
1101// something and when we reread the type later, we can replace the opaque type
1102// with a new resolved concrete type.
1103//
Reid Spencer46b002c2004-07-11 17:28:43 +00001104void BytecodeReader::ParseTypes(TypeListTy &Tab, unsigned NumEntries){
Reid Spencer060d25d2004-06-29 23:29:38 +00001105 assert(Tab.size() == 0 && "should not have read type constants in before!");
1106
1107 // Insert a bunch of opaque types to be resolved later...
1108 Tab.reserve(NumEntries);
1109 for (unsigned i = 0; i != NumEntries; ++i)
1110 Tab.push_back(OpaqueType::get());
1111
Misha Brukman8a96c532005-04-21 21:44:41 +00001112 if (Handler)
Reid Spencer5b472d92004-08-21 20:49:23 +00001113 Handler->handleTypeList(NumEntries);
1114
Chris Lattnereebac5f2005-10-03 21:26:53 +00001115 // If we are about to resolve types, make sure the type cache is clear.
1116 if (NumEntries)
1117 ModuleTypeIDCache.clear();
1118
Reid Spencer060d25d2004-06-29 23:29:38 +00001119 // Loop through reading all of the types. Forward types will make use of the
1120 // opaque types just inserted.
1121 //
1122 for (unsigned i = 0; i != NumEntries; ++i) {
Reid Spencer46b002c2004-07-11 17:28:43 +00001123 const Type* NewTy = ParseType();
Reid Spencer04cde2c2004-07-04 11:33:49 +00001124 const Type* OldTy = Tab[i].get();
Misha Brukman8a96c532005-04-21 21:44:41 +00001125 if (NewTy == 0)
Reid Spencer24399722004-07-09 22:21:33 +00001126 error("Couldn't parse type!");
Reid Spencer060d25d2004-06-29 23:29:38 +00001127
Misha Brukman8a96c532005-04-21 21:44:41 +00001128 // Don't directly push the new type on the Tab. Instead we want to replace
Reid Spencer060d25d2004-06-29 23:29:38 +00001129 // the opaque type we previously inserted with the new concrete value. This
1130 // approach helps with forward references to types. The refinement from the
1131 // abstract (opaque) type to the new type causes all uses of the abstract
1132 // type to use the concrete type (NewTy). This will also cause the opaque
1133 // type to be deleted.
1134 cast<DerivedType>(const_cast<Type*>(OldTy))->refineAbstractTypeTo(NewTy);
1135
1136 // This should have replaced the old opaque type with the new type in the
1137 // value table... or with a preexisting type that was already in the system.
1138 // Let's just make sure it did.
1139 assert(Tab[i] != OldTy && "refineAbstractType didn't work!");
1140 }
1141}
1142
Reid Spencer04cde2c2004-07-04 11:33:49 +00001143/// Parse a single constant value
Chris Lattner3bc5a602006-01-25 23:08:15 +00001144Value *BytecodeReader::ParseConstantPoolValue(unsigned TypeID) {
Reid Spencer060d25d2004-06-29 23:29:38 +00001145 // We must check for a ConstantExpr before switching by type because
1146 // a ConstantExpr can be of any type, and has no explicit value.
Misha Brukman8a96c532005-04-21 21:44:41 +00001147 //
Reid Spencer060d25d2004-06-29 23:29:38 +00001148 // 0 if not expr; numArgs if is expr
1149 unsigned isExprNumArgs = read_vbr_uint();
Chris Lattnera79e7cc2004-10-16 18:18:16 +00001150
Reid Spencer060d25d2004-06-29 23:29:38 +00001151 if (isExprNumArgs) {
Reid Spencerd798a512006-11-14 04:47:22 +00001152 // 'undef' is encoded with 'exprnumargs' == 1.
1153 if (isExprNumArgs == 1)
1154 return UndefValue::get(getType(TypeID));
Misha Brukman8a96c532005-04-21 21:44:41 +00001155
Reid Spencerd798a512006-11-14 04:47:22 +00001156 // Inline asm is encoded with exprnumargs == ~0U.
1157 if (isExprNumArgs == ~0U) {
1158 std::string AsmStr = read_str();
1159 std::string ConstraintStr = read_str();
1160 unsigned Flags = read_vbr_uint();
Chris Lattner3bc5a602006-01-25 23:08:15 +00001161
Reid Spencerd798a512006-11-14 04:47:22 +00001162 const PointerType *PTy = dyn_cast<PointerType>(getType(TypeID));
1163 const FunctionType *FTy =
1164 PTy ? dyn_cast<FunctionType>(PTy->getElementType()) : 0;
1165
1166 if (!FTy || !InlineAsm::Verify(FTy, ConstraintStr))
1167 error("Invalid constraints for inline asm");
1168 if (Flags & ~1U)
1169 error("Invalid flags for inline asm");
1170 bool HasSideEffects = Flags & 1;
1171 return InlineAsm::get(FTy, AsmStr, ConstraintStr, HasSideEffects);
Chris Lattner3bc5a602006-01-25 23:08:15 +00001172 }
Reid Spencerd798a512006-11-14 04:47:22 +00001173
1174 --isExprNumArgs;
Chris Lattner3bc5a602006-01-25 23:08:15 +00001175
Reid Spencer060d25d2004-06-29 23:29:38 +00001176 // FIXME: Encoding of constant exprs could be much more compact!
Chris Lattner670ccfe2007-02-07 05:15:28 +00001177 SmallVector<Constant*, 8> ArgVec;
Reid Spencer060d25d2004-06-29 23:29:38 +00001178 ArgVec.reserve(isExprNumArgs);
1179 unsigned Opcode = read_vbr_uint();
Chris Lattnera79e7cc2004-10-16 18:18:16 +00001180
Reid Spencer060d25d2004-06-29 23:29:38 +00001181 // Read the slot number and types of each of the arguments
1182 for (unsigned i = 0; i != isExprNumArgs; ++i) {
1183 unsigned ArgValSlot = read_vbr_uint();
Reid Spencerd798a512006-11-14 04:47:22 +00001184 unsigned ArgTypeSlot = read_vbr_uint();
Misha Brukman8a96c532005-04-21 21:44:41 +00001185
Reid Spencer060d25d2004-06-29 23:29:38 +00001186 // Get the arg value from its slot if it exists, otherwise a placeholder
1187 ArgVec.push_back(getConstantValue(ArgTypeSlot, ArgValSlot));
1188 }
Misha Brukman8a96c532005-04-21 21:44:41 +00001189
Reid Spencer060d25d2004-06-29 23:29:38 +00001190 // Construct a ConstantExpr of the appropriate kind
1191 if (isExprNumArgs == 1) { // All one-operand expressions
Reid Spencer3da59db2006-11-27 01:05:10 +00001192 if (!Instruction::isCast(Opcode))
Chris Lattner02dce162004-12-04 05:28:27 +00001193 error("Only cast instruction has one argument for ConstantExpr");
Reid Spencer46b002c2004-07-11 17:28:43 +00001194
Reid Spencera77fa7e2006-12-11 23:20:20 +00001195 Constant *Result = ConstantExpr::getCast(Opcode, ArgVec[0],
1196 getType(TypeID));
Chris Lattner63cf59e2007-02-07 05:08:39 +00001197 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1198 ArgVec.size(), Result);
Reid Spencer060d25d2004-06-29 23:29:38 +00001199 return Result;
1200 } else if (Opcode == Instruction::GetElementPtr) { // GetElementPtr
Chris Lattnere0135402007-01-31 04:43:46 +00001201 Constant *Result = ConstantExpr::getGetElementPtr(ArgVec[0], &ArgVec[1],
1202 ArgVec.size()-1);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001203 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1204 ArgVec.size(), Result);
Reid Spencer060d25d2004-06-29 23:29:38 +00001205 return Result;
1206 } else if (Opcode == Instruction::Select) {
Reid Spencer46b002c2004-07-11 17:28:43 +00001207 if (ArgVec.size() != 3)
1208 error("Select instruction must have three arguments.");
Misha Brukman8a96c532005-04-21 21:44:41 +00001209 Constant* Result = ConstantExpr::getSelect(ArgVec[0], ArgVec[1],
Reid Spencer04cde2c2004-07-04 11:33:49 +00001210 ArgVec[2]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001211 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1212 ArgVec.size(), Result);
Reid Spencer060d25d2004-06-29 23:29:38 +00001213 return Result;
Robert Bocchinofee31b32006-01-10 19:04:39 +00001214 } else if (Opcode == Instruction::ExtractElement) {
Chris Lattner59fecec2006-04-08 04:09:19 +00001215 if (ArgVec.size() != 2 ||
1216 !ExtractElementInst::isValidOperands(ArgVec[0], ArgVec[1]))
1217 error("Invalid extractelement constand expr arguments");
Robert Bocchinofee31b32006-01-10 19:04:39 +00001218 Constant* Result = ConstantExpr::getExtractElement(ArgVec[0], ArgVec[1]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001219 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1220 ArgVec.size(), Result);
Robert Bocchinofee31b32006-01-10 19:04:39 +00001221 return Result;
Robert Bocchinob1f240b2006-01-17 20:06:35 +00001222 } else if (Opcode == Instruction::InsertElement) {
Chris Lattner59fecec2006-04-08 04:09:19 +00001223 if (ArgVec.size() != 3 ||
1224 !InsertElementInst::isValidOperands(ArgVec[0], ArgVec[1], ArgVec[2]))
1225 error("Invalid insertelement constand expr arguments");
1226
1227 Constant *Result =
Robert Bocchinob1f240b2006-01-17 20:06:35 +00001228 ConstantExpr::getInsertElement(ArgVec[0], ArgVec[1], ArgVec[2]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001229 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1230 ArgVec.size(), Result);
Robert Bocchinob1f240b2006-01-17 20:06:35 +00001231 return Result;
Chris Lattner30b44b62006-04-08 01:17:59 +00001232 } else if (Opcode == Instruction::ShuffleVector) {
1233 if (ArgVec.size() != 3 ||
1234 !ShuffleVectorInst::isValidOperands(ArgVec[0], ArgVec[1], ArgVec[2]))
Chris Lattner59fecec2006-04-08 04:09:19 +00001235 error("Invalid shufflevector constant expr arguments.");
Chris Lattner30b44b62006-04-08 01:17:59 +00001236 Constant *Result =
1237 ConstantExpr::getShuffleVector(ArgVec[0], ArgVec[1], ArgVec[2]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001238 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1239 ArgVec.size(), Result);
Chris Lattner30b44b62006-04-08 01:17:59 +00001240 return Result;
Reid Spencer9f132762006-12-03 17:17:02 +00001241 } else if (Opcode == Instruction::ICmp) {
1242 if (ArgVec.size() != 2)
Reid Spencer595b4772006-12-04 05:23:49 +00001243 error("Invalid ICmp constant expr arguments.");
1244 unsigned predicate = read_vbr_uint();
1245 Constant *Result = ConstantExpr::getICmp(predicate, ArgVec[0], ArgVec[1]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001246 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1247 ArgVec.size(), Result);
Reid Spencer595b4772006-12-04 05:23:49 +00001248 return Result;
Reid Spencer9f132762006-12-03 17:17:02 +00001249 } else if (Opcode == Instruction::FCmp) {
1250 if (ArgVec.size() != 2)
Reid Spencer595b4772006-12-04 05:23:49 +00001251 error("Invalid FCmp constant expr arguments.");
1252 unsigned predicate = read_vbr_uint();
1253 Constant *Result = ConstantExpr::getFCmp(predicate, ArgVec[0], ArgVec[1]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001254 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1255 ArgVec.size(), Result);
Reid Spencer595b4772006-12-04 05:23:49 +00001256 return Result;
Reid Spencer060d25d2004-06-29 23:29:38 +00001257 } else { // All other 2-operand expressions
1258 Constant* Result = ConstantExpr::get(Opcode, ArgVec[0], ArgVec[1]);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001259 if (Handler) Handler->handleConstantExpression(Opcode, &ArgVec[0],
1260 ArgVec.size(), Result);
Reid Spencer060d25d2004-06-29 23:29:38 +00001261 return Result;
1262 }
1263 }
Misha Brukman8a96c532005-04-21 21:44:41 +00001264
Reid Spencer060d25d2004-06-29 23:29:38 +00001265 // Ok, not an ConstantExpr. We now know how to read the given type...
1266 const Type *Ty = getType(TypeID);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001267 Constant *Result = 0;
Reid Spencer060d25d2004-06-29 23:29:38 +00001268 switch (Ty->getTypeID()) {
Reid Spencera54b7cb2007-01-12 07:05:14 +00001269 case Type::IntegerTyID: {
1270 const IntegerType *IT = cast<IntegerType>(Ty);
1271 if (IT->getBitWidth() <= 32) {
1272 uint32_t Val = read_vbr_uint();
Reid Spencerb61c1ce2007-01-13 00:09:12 +00001273 if (!ConstantInt::isValueValidForType(Ty, uint64_t(Val)))
1274 error("Integer value read is invalid for type.");
1275 Result = ConstantInt::get(IT, Val);
1276 if (Handler) Handler->handleConstantValue(Result);
Reid Spencera54b7cb2007-01-12 07:05:14 +00001277 } else if (IT->getBitWidth() <= 64) {
1278 uint64_t Val = read_vbr_uint64();
1279 if (!ConstantInt::isValueValidForType(Ty, Val))
1280 error("Invalid constant integer read.");
1281 Result = ConstantInt::get(IT, Val);
1282 if (Handler) Handler->handleConstantValue(Result);
Reid Spencerfa1353c2007-02-28 02:25:48 +00001283 } else {
1284 uint32_t numWords = read_vbr_uint();
1285 uint64_t *data = new uint64_t[numWords];
1286 for (uint32_t i = 0; i < numWords; ++i)
1287 data[i] = read_vbr_uint64();
Reid Spencere2a6acd2007-03-01 20:25:31 +00001288 Result = ConstantInt::get(APInt(IT->getBitWidth(), numWords, data));
Reid Spencerfa1353c2007-02-28 02:25:48 +00001289 if (Handler) Handler->handleConstantValue(Result);
1290 }
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001291 break;
Reid Spencer060d25d2004-06-29 23:29:38 +00001292 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001293 case Type::FloatTyID: {
Reid Spencer46b002c2004-07-11 17:28:43 +00001294 float Val;
1295 read_float(Val);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001296 Result = ConstantFP::get(Ty, Val);
Reid Spencer04cde2c2004-07-04 11:33:49 +00001297 if (Handler) Handler->handleConstantValue(Result);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001298 break;
Reid Spencer060d25d2004-06-29 23:29:38 +00001299 }
1300
1301 case Type::DoubleTyID: {
1302 double Val;
Reid Spencer46b002c2004-07-11 17:28:43 +00001303 read_double(Val);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001304 Result = ConstantFP::get(Ty, Val);
Reid Spencer04cde2c2004-07-04 11:33:49 +00001305 if (Handler) Handler->handleConstantValue(Result);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001306 break;
Reid Spencer060d25d2004-06-29 23:29:38 +00001307 }
1308
Reid Spencer060d25d2004-06-29 23:29:38 +00001309 case Type::ArrayTyID: {
1310 const ArrayType *AT = cast<ArrayType>(Ty);
1311 unsigned NumElements = AT->getNumElements();
1312 unsigned TypeSlot = getTypeSlot(AT->getElementType());
1313 std::vector<Constant*> Elements;
1314 Elements.reserve(NumElements);
1315 while (NumElements--) // Read all of the elements of the constant.
1316 Elements.push_back(getConstantValue(TypeSlot,
1317 read_vbr_uint()));
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001318 Result = ConstantArray::get(AT, Elements);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001319 if (Handler) Handler->handleConstantArray(AT, &Elements[0], Elements.size(),
1320 TypeSlot, Result);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001321 break;
Reid Spencer060d25d2004-06-29 23:29:38 +00001322 }
1323
1324 case Type::StructTyID: {
1325 const StructType *ST = cast<StructType>(Ty);
1326
1327 std::vector<Constant *> Elements;
1328 Elements.reserve(ST->getNumElements());
1329 for (unsigned i = 0; i != ST->getNumElements(); ++i)
1330 Elements.push_back(getConstantValue(ST->getElementType(i),
1331 read_vbr_uint()));
1332
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001333 Result = ConstantStruct::get(ST, Elements);
Chris Lattner63cf59e2007-02-07 05:08:39 +00001334 if (Handler) Handler->handleConstantStruct(ST, &Elements[0],Elements.size(),
1335 Result);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001336 break;
Misha Brukman8a96c532005-04-21 21:44:41 +00001337 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001338
Reid Spencer9d6565a2007-02-15 02:26:10 +00001339 case Type::VectorTyID: {
1340 const VectorType *PT = cast<VectorType>(Ty);
Brian Gaeke715c90b2004-08-20 06:00:58 +00001341 unsigned NumElements = PT->getNumElements();
1342 unsigned TypeSlot = getTypeSlot(PT->getElementType());
1343 std::vector<Constant*> Elements;
1344 Elements.reserve(NumElements);
1345 while (NumElements--) // Read all of the elements of the constant.
1346 Elements.push_back(getConstantValue(TypeSlot,
1347 read_vbr_uint()));
Reid Spencer9d6565a2007-02-15 02:26:10 +00001348 Result = ConstantVector::get(PT, Elements);
1349 if (Handler) Handler->handleConstantVector(PT, &Elements[0],Elements.size(),
Chris Lattner63cf59e2007-02-07 05:08:39 +00001350 TypeSlot, Result);
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001351 break;
Brian Gaeke715c90b2004-08-20 06:00:58 +00001352 }
1353
Chris Lattner638c3812004-11-19 16:24:05 +00001354 case Type::PointerTyID: { // ConstantPointerRef value (backwards compat).
Reid Spencer060d25d2004-06-29 23:29:38 +00001355 const PointerType *PT = cast<PointerType>(Ty);
1356 unsigned Slot = read_vbr_uint();
Misha Brukman8a96c532005-04-21 21:44:41 +00001357
Reid Spencer060d25d2004-06-29 23:29:38 +00001358 // Check to see if we have already read this global variable...
1359 Value *Val = getValue(TypeID, Slot, false);
Reid Spencer060d25d2004-06-29 23:29:38 +00001360 if (Val) {
Chris Lattnerbcb11cf2004-07-27 02:34:49 +00001361 GlobalValue *GV = dyn_cast<GlobalValue>(Val);
1362 if (!GV) error("GlobalValue not in ValueTable!");
1363 if (Handler) Handler->handleConstantPointer(PT, Slot, GV);
1364 return GV;
Reid Spencer060d25d2004-06-29 23:29:38 +00001365 } else {
Reid Spencer24399722004-07-09 22:21:33 +00001366 error("Forward references are not allowed here.");
Reid Spencer060d25d2004-06-29 23:29:38 +00001367 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001368 }
1369
1370 default:
Reid Spencer24399722004-07-09 22:21:33 +00001371 error("Don't know how to deserialize constant value of type '" +
Reid Spencer060d25d2004-06-29 23:29:38 +00001372 Ty->getDescription());
1373 break;
1374 }
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001375
1376 // Check that we didn't read a null constant if they are implicit for this
1377 // type plane. Do not do this check for constantexprs, as they may be folded
1378 // to a null value in a way that isn't predicted when a .bc file is initially
1379 // produced.
1380 assert((!isa<Constant>(Result) || !cast<Constant>(Result)->isNullValue()) ||
Reid Spencerfa1353c2007-02-28 02:25:48 +00001381 !hasImplicitNull(TypeID) && "Cannot read null values from bytecode!");
Chris Lattnerd2cfb7a2006-04-07 05:00:02 +00001382 return Result;
Reid Spencer060d25d2004-06-29 23:29:38 +00001383}
1384
Misha Brukman8a96c532005-04-21 21:44:41 +00001385/// Resolve references for constants. This function resolves the forward
1386/// referenced constants in the ConstantFwdRefs map. It uses the
Reid Spencer04cde2c2004-07-04 11:33:49 +00001387/// replaceAllUsesWith method of Value class to substitute the placeholder
1388/// instance with the actual instance.
Chris Lattner389bd042004-12-09 06:19:44 +00001389void BytecodeReader::ResolveReferencesToConstant(Constant *NewV, unsigned Typ,
1390 unsigned Slot) {
Chris Lattner29b789b2003-11-19 17:27:18 +00001391 ConstantRefsType::iterator I =
Chris Lattner389bd042004-12-09 06:19:44 +00001392 ConstantFwdRefs.find(std::make_pair(Typ, Slot));
Chris Lattner29b789b2003-11-19 17:27:18 +00001393 if (I == ConstantFwdRefs.end()) return; // Never forward referenced?
Chris Lattner00950542001-06-06 20:29:01 +00001394
Chris Lattner29b789b2003-11-19 17:27:18 +00001395 Value *PH = I->second; // Get the placeholder...
1396 PH->replaceAllUsesWith(NewV);
1397 delete PH; // Delete the old placeholder
1398 ConstantFwdRefs.erase(I); // Remove the map entry for it
Vikram S. Advec1e4a812002-07-14 23:04:18 +00001399}
1400
Reid Spencer04cde2c2004-07-04 11:33:49 +00001401/// Parse the constant strings section.
Reid Spencer060d25d2004-06-29 23:29:38 +00001402void BytecodeReader::ParseStringConstants(unsigned NumEntries, ValueTable &Tab){
1403 for (; NumEntries; --NumEntries) {
Reid Spencerd798a512006-11-14 04:47:22 +00001404 unsigned Typ = read_vbr_uint();
Reid Spencer060d25d2004-06-29 23:29:38 +00001405 const Type *Ty = getType(Typ);
1406 if (!isa<ArrayType>(Ty))
Reid Spencer24399722004-07-09 22:21:33 +00001407 error("String constant data invalid!");
Misha Brukman8a96c532005-04-21 21:44:41 +00001408
Reid Spencer060d25d2004-06-29 23:29:38 +00001409 const ArrayType *ATy = cast<ArrayType>(Ty);
Reid Spencer88cfda22006-12-31 05:44:24 +00001410 if (ATy->getElementType() != Type::Int8Ty &&
1411 ATy->getElementType() != Type::Int8Ty)
Reid Spencer24399722004-07-09 22:21:33 +00001412 error("String constant data invalid!");
Misha Brukman8a96c532005-04-21 21:44:41 +00001413
Reid Spencer060d25d2004-06-29 23:29:38 +00001414 // Read character data. The type tells us how long the string is.
Misha Brukman8a96c532005-04-21 21:44:41 +00001415 char *Data = reinterpret_cast<char *>(alloca(ATy->getNumElements()));
Reid Spencer060d25d2004-06-29 23:29:38 +00001416 read_data(Data, Data+ATy->getNumElements());
Chris Lattner52e20b02003-03-19 20:54:26 +00001417
Reid Spencer060d25d2004-06-29 23:29:38 +00001418 std::vector<Constant*> Elements(ATy->getNumElements());
Reid Spencerb83eb642006-10-20 07:07:24 +00001419 const Type* ElemType = ATy->getElementType();
1420 for (unsigned i = 0, e = ATy->getNumElements(); i != e; ++i)
1421 Elements[i] = ConstantInt::get(ElemType, (unsigned char)Data[i]);
Misha Brukman12c29d12003-09-22 23:38:23 +00001422
Reid Spencer060d25d2004-06-29 23:29:38 +00001423 // Create the constant, inserting it as needed.
1424 Constant *C = ConstantArray::get(ATy, Elements);
1425 unsigned Slot = insertValue(C, Typ, Tab);
Chris Lattner389bd042004-12-09 06:19:44 +00001426 ResolveReferencesToConstant(C, Typ, Slot);
Reid Spencer04cde2c2004-07-04 11:33:49 +00001427 if (Handler) Handler->handleConstantString(cast<ConstantArray>(C));
Reid Spencer060d25d2004-06-29 23:29:38 +00001428 }
Misha Brukman12c29d12003-09-22 23:38:23 +00001429}
1430
Reid Spencer04cde2c2004-07-04 11:33:49 +00001431/// Parse the constant pool.
Misha Brukman8a96c532005-04-21 21:44:41 +00001432void BytecodeReader::ParseConstantPool(ValueTable &Tab,
Reid Spencer04cde2c2004-07-04 11:33:49 +00001433 TypeListTy &TypeTab,
Reid Spencer46b002c2004-07-11 17:28:43 +00001434 bool isFunction) {
Reid Spencer04cde2c2004-07-04 11:33:49 +00001435 if (Handler) Handler->handleGlobalConstantsBegin();
1436
1437 /// In LLVM 1.3 Type does not derive from Value so the types
1438 /// do not occupy a plane. Consequently, we read the types
1439 /// first in the constant pool.
Reid Spencerd798a512006-11-14 04:47:22 +00001440 if (isFunction) {
Reid Spencer04cde2c2004-07-04 11:33:49 +00001441 unsigned NumEntries = read_vbr_uint();
Reid Spencer46b002c2004-07-11 17:28:43 +00001442 ParseTypes(TypeTab, NumEntries);
Reid Spencer04cde2c2004-07-04 11:33:49 +00001443 }
1444
Reid Spencer46b002c2004-07-11 17:28:43 +00001445 while (moreInBlock()) {
Reid Spencer060d25d2004-06-29 23:29:38 +00001446 unsigned NumEntries = read_vbr_uint();
Reid Spencerd798a512006-11-14 04:47:22 +00001447 unsigned Typ = read_vbr_uint();
Reid Spencer04cde2c2004-07-04 11:33:49 +00001448
Reid Spencerd798a512006-11-14 04:47:22 +00001449 if (Typ == Type::VoidTyID) {
Reid Spencer04cde2c2004-07-04 11:33:49 +00001450 /// Use of Type::VoidTyID is a misnomer. It actually means
1451 /// that the following plane is constant strings
Reid Spencer060d25d2004-06-29 23:29:38 +00001452 assert(&Tab == &ModuleValues && "Cannot read strings in functions!");
1453 ParseStringConstants(NumEntries, Tab);
1454 } else {
1455 for (unsigned i = 0; i < NumEntries; ++i) {
Chris Lattner3bc5a602006-01-25 23:08:15 +00001456 Value *V = ParseConstantPoolValue(Typ);
1457 assert(V && "ParseConstantPoolValue returned NULL!");
1458 unsigned Slot = insertValue(V, Typ, Tab);
Chris Lattner29b789b2003-11-19 17:27:18 +00001459
Reid Spencer060d25d2004-06-29 23:29:38 +00001460 // If we are reading a function constant table, make sure that we adjust
1461 // the slot number to be the real global constant number.
1462 //
1463 if (&Tab != &ModuleValues && Typ < ModuleValues.size() &&
1464 ModuleValues[Typ])
1465 Slot += ModuleValues[Typ]->size();
Chris Lattner3bc5a602006-01-25 23:08:15 +00001466 if (Constant *C = dyn_cast<Constant>(V))
1467 ResolveReferencesToConstant(C, Typ, Slot);
Reid Spencer060d25d2004-06-29 23:29:38 +00001468 }
1469 }
1470 }
Chris Lattner02dce162004-12-04 05:28:27 +00001471
1472 // After we have finished parsing the constant pool, we had better not have
1473 // any dangling references left.
Reid Spencer3c391272004-12-04 22:19:53 +00001474 if (!ConstantFwdRefs.empty()) {
Reid Spencer3c391272004-12-04 22:19:53 +00001475 ConstantRefsType::const_iterator I = ConstantFwdRefs.begin();
Reid Spencer3c391272004-12-04 22:19:53 +00001476 Constant* missingConst = I->second;
Misha Brukman8a96c532005-04-21 21:44:41 +00001477 error(utostr(ConstantFwdRefs.size()) +
1478 " unresolved constant reference exist. First one is '" +
1479 missingConst->getName() + "' of type '" +
Chris Lattner389bd042004-12-09 06:19:44 +00001480 missingConst->getType()->getDescription() + "'.");
Reid Spencer3c391272004-12-04 22:19:53 +00001481 }
Chris Lattner02dce162004-12-04 05:28:27 +00001482
Reid Spencer060d25d2004-06-29 23:29:38 +00001483 checkPastBlockEnd("Constant Pool");
Reid Spencer04cde2c2004-07-04 11:33:49 +00001484 if (Handler) Handler->handleGlobalConstantsEnd();
Reid Spencer060d25d2004-06-29 23:29:38 +00001485}
Chris Lattner00950542001-06-06 20:29:01 +00001486
Reid Spencer04cde2c2004-07-04 11:33:49 +00001487/// Parse the contents of a function. Note that this function can be
1488/// called lazily by materializeFunction
1489/// @see materializeFunction
Reid Spencer46b002c2004-07-11 17:28:43 +00001490void BytecodeReader::ParseFunctionBody(Function* F) {
Reid Spencer060d25d2004-06-29 23:29:38 +00001491
1492 unsigned FuncSize = BlockEnd - At;
Chris Lattnere3869c82003-04-16 21:16:05 +00001493 GlobalValue::LinkageTypes Linkage = GlobalValue::ExternalLinkage;
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001494 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
Chris Lattnere3869c82003-04-16 21:16:05 +00001495
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001496 unsigned rWord = read_vbr_uint();
1497 unsigned LinkageID = rWord & 65535;
1498 unsigned VisibilityID = rWord >> 16;
1499 switch (LinkageID) {
Chris Lattnerc08912f2004-01-14 16:44:44 +00001500 case 0: Linkage = GlobalValue::ExternalLinkage; break;
1501 case 1: Linkage = GlobalValue::WeakLinkage; break;
1502 case 2: Linkage = GlobalValue::AppendingLinkage; break;
1503 case 3: Linkage = GlobalValue::InternalLinkage; break;
1504 case 4: Linkage = GlobalValue::LinkOnceLinkage; break;
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00001505 case 5: Linkage = GlobalValue::DLLImportLinkage; break;
1506 case 6: Linkage = GlobalValue::DLLExportLinkage; break;
1507 case 7: Linkage = GlobalValue::ExternalWeakLinkage; break;
Reid Spencer060d25d2004-06-29 23:29:38 +00001508 default:
Reid Spencer24399722004-07-09 22:21:33 +00001509 error("Invalid linkage type for Function.");
Reid Spencer060d25d2004-06-29 23:29:38 +00001510 Linkage = GlobalValue::InternalLinkage;
1511 break;
Chris Lattnere3869c82003-04-16 21:16:05 +00001512 }
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001513 switch (VisibilityID) {
1514 case 0: Visibility = GlobalValue::DefaultVisibility; break;
1515 case 1: Visibility = GlobalValue::HiddenVisibility; break;
1516 default:
1517 error("Unknown visibility type: " + utostr(VisibilityID));
1518 Visibility = GlobalValue::DefaultVisibility;
1519 break;
1520 }
Chris Lattnerd23b1d32001-11-26 18:56:10 +00001521
Reid Spencer46b002c2004-07-11 17:28:43 +00001522 F->setLinkage(Linkage);
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001523 F->setVisibility(Visibility);
Reid Spencer04cde2c2004-07-04 11:33:49 +00001524 if (Handler) Handler->handleFunctionBegin(F,FuncSize);
Chris Lattner00950542001-06-06 20:29:01 +00001525
Chris Lattner4ee8ef22003-10-08 22:52:54 +00001526 // Keep track of how many basic blocks we have read in...
1527 unsigned BlockNum = 0;
Chris Lattner89e02532004-01-18 21:08:15 +00001528 bool InsertedArguments = false;
Chris Lattner4ee8ef22003-10-08 22:52:54 +00001529
Reid Spencer060d25d2004-06-29 23:29:38 +00001530 BufPtr MyEnd = BlockEnd;
Reid Spencer46b002c2004-07-11 17:28:43 +00001531 while (At < MyEnd) {
Chris Lattner00950542001-06-06 20:29:01 +00001532 unsigned Type, Size;
Reid Spencer060d25d2004-06-29 23:29:38 +00001533 BufPtr OldAt = At;
1534 read_block(Type, Size);
Chris Lattner00950542001-06-06 20:29:01 +00001535
1536 switch (Type) {
Reid Spencerad89bd62004-07-25 18:07:36 +00001537 case BytecodeFormat::ConstantPoolBlockID:
Chris Lattner89e02532004-01-18 21:08:15 +00001538 if (!InsertedArguments) {
1539 // Insert arguments into the value table before we parse the first basic
Reid Spencerd2bb8872007-01-30 19:36:46 +00001540 // block in the function
Reid Spencer04cde2c2004-07-04 11:33:49 +00001541 insertArguments(F);
Chris Lattner89e02532004-01-18 21:08:15 +00001542 InsertedArguments = true;
1543 }
1544
Reid Spencer04cde2c2004-07-04 11:33:49 +00001545 ParseConstantPool(FunctionValues, FunctionTypes, true);
Chris Lattner00950542001-06-06 20:29:01 +00001546 break;
1547
Reid Spencerad89bd62004-07-25 18:07:36 +00001548 case BytecodeFormat::InstructionListBlockID: {
Chris Lattner89e02532004-01-18 21:08:15 +00001549 // Insert arguments into the value table before we parse the instruction
Reid Spencerd2bb8872007-01-30 19:36:46 +00001550 // list for the function
Chris Lattner89e02532004-01-18 21:08:15 +00001551 if (!InsertedArguments) {
Reid Spencer04cde2c2004-07-04 11:33:49 +00001552 insertArguments(F);
Chris Lattner89e02532004-01-18 21:08:15 +00001553 InsertedArguments = true;
1554 }
1555
Misha Brukman8a96c532005-04-21 21:44:41 +00001556 if (BlockNum)
Reid Spencer24399722004-07-09 22:21:33 +00001557 error("Already parsed basic blocks!");
Reid Spencer060d25d2004-06-29 23:29:38 +00001558 BlockNum = ParseInstructionList(F);
Chris Lattner8d1dbd22003-12-01 07:05:31 +00001559 break;
1560 }
1561
Reid Spencer78d033e2007-01-06 07:24:44 +00001562 case BytecodeFormat::ValueSymbolTableBlockID:
1563 ParseValueSymbolTable(F, &F->getValueSymbolTable());
1564 break;
1565
1566 case BytecodeFormat::TypeSymbolTableBlockID:
1567 error("Functions don't have type symbol tables");
Chris Lattner00950542001-06-06 20:29:01 +00001568 break;
1569
1570 default:
Reid Spencer060d25d2004-06-29 23:29:38 +00001571 At += Size;
Misha Brukman8a96c532005-04-21 21:44:41 +00001572 if (OldAt > At)
Reid Spencer24399722004-07-09 22:21:33 +00001573 error("Wrapped around reading bytecode.");
Chris Lattner00950542001-06-06 20:29:01 +00001574 break;
1575 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001576 BlockEnd = MyEnd;
Chris Lattner00950542001-06-06 20:29:01 +00001577 }
1578
Chris Lattner4ee8ef22003-10-08 22:52:54 +00001579 // Make sure there were no references to non-existant basic blocks.
1580 if (BlockNum != ParsedBasicBlocks.size())
Reid Spencer24399722004-07-09 22:21:33 +00001581 error("Illegal basic block operand reference");
Reid Spencer060d25d2004-06-29 23:29:38 +00001582
Chris Lattner4ee8ef22003-10-08 22:52:54 +00001583 ParsedBasicBlocks.clear();
1584
Chris Lattner97330cf2003-10-09 23:10:14 +00001585 // Resolve forward references. Replace any uses of a forward reference value
1586 // with the real value.
Chris Lattner8eb10ce2003-10-09 06:05:40 +00001587 while (!ForwardReferences.empty()) {
Chris Lattnerc4d69162004-12-09 04:51:50 +00001588 std::map<std::pair<unsigned,unsigned>, Value*>::iterator
1589 I = ForwardReferences.begin();
1590 Value *V = getValue(I->first.first, I->first.second, false);
Chris Lattner8eb10ce2003-10-09 06:05:40 +00001591 Value *PlaceHolder = I->second;
Chris Lattnerc4d69162004-12-09 04:51:50 +00001592 PlaceHolder->replaceAllUsesWith(V);
Chris Lattner8eb10ce2003-10-09 06:05:40 +00001593 ForwardReferences.erase(I);
Chris Lattner8eb10ce2003-10-09 06:05:40 +00001594 delete PlaceHolder;
Chris Lattner6e448022003-10-08 21:51:46 +00001595 }
Chris Lattner00950542001-06-06 20:29:01 +00001596
Misha Brukman12c29d12003-09-22 23:38:23 +00001597 // Clear out function-level types...
Reid Spencer060d25d2004-06-29 23:29:38 +00001598 FunctionTypes.clear();
Reid Spencer060d25d2004-06-29 23:29:38 +00001599 freeTable(FunctionValues);
1600
Reid Spencer04cde2c2004-07-04 11:33:49 +00001601 if (Handler) Handler->handleFunctionEnd(F);
Chris Lattner00950542001-06-06 20:29:01 +00001602}
1603
Reid Spencer04cde2c2004-07-04 11:33:49 +00001604/// This function parses LLVM functions lazily. It obtains the type of the
1605/// function and records where the body of the function is in the bytecode
Misha Brukman8a96c532005-04-21 21:44:41 +00001606/// buffer. The caller can then use the ParseNextFunction and
Reid Spencer04cde2c2004-07-04 11:33:49 +00001607/// ParseAllFunctionBodies to get handler events for the functions.
Reid Spencer060d25d2004-06-29 23:29:38 +00001608void BytecodeReader::ParseFunctionLazily() {
1609 if (FunctionSignatureList.empty())
Reid Spencer24399722004-07-09 22:21:33 +00001610 error("FunctionSignatureList empty!");
Chris Lattner89e02532004-01-18 21:08:15 +00001611
Reid Spencer060d25d2004-06-29 23:29:38 +00001612 Function *Func = FunctionSignatureList.back();
1613 FunctionSignatureList.pop_back();
Chris Lattner24102432004-01-18 22:35:34 +00001614
Reid Spencer060d25d2004-06-29 23:29:38 +00001615 // Save the information for future reading of the function
1616 LazyFunctionLoadMap[Func] = LazyFunctionInfo(BlockStart, BlockEnd);
Chris Lattner89e02532004-01-18 21:08:15 +00001617
Misha Brukmana3e6ad62004-11-14 21:02:55 +00001618 // This function has a body but it's not loaded so it appears `External'.
1619 // Mark it as a `Ghost' instead to notify the users that it has a body.
1620 Func->setLinkage(GlobalValue::GhostLinkage);
1621
Reid Spencer060d25d2004-06-29 23:29:38 +00001622 // Pretend we've `parsed' this function
1623 At = BlockEnd;
1624}
Chris Lattner89e02532004-01-18 21:08:15 +00001625
Misha Brukman8a96c532005-04-21 21:44:41 +00001626/// The ParserFunction method lazily parses one function. Use this method to
1627/// casue the parser to parse a specific function in the module. Note that
1628/// this will remove the function from what is to be included by
Reid Spencer04cde2c2004-07-04 11:33:49 +00001629/// ParseAllFunctionBodies.
1630/// @see ParseAllFunctionBodies
1631/// @see ParseBytecode
Reid Spencer99655e12006-08-25 19:54:53 +00001632bool BytecodeReader::ParseFunction(Function* Func, std::string* ErrMsg) {
1633
Reid Spencer9b84ad12006-12-15 19:49:23 +00001634 if (setjmp(context)) {
1635 // Set caller's error message, if requested
1636 if (ErrMsg)
1637 *ErrMsg = ErrorMsg;
1638 // Indicate an error occurred
Reid Spencer99655e12006-08-25 19:54:53 +00001639 return true;
Reid Spencer9b84ad12006-12-15 19:49:23 +00001640 }
Reid Spencer99655e12006-08-25 19:54:53 +00001641
Reid Spencer060d25d2004-06-29 23:29:38 +00001642 // Find {start, end} pointers and slot in the map. If not there, we're done.
1643 LazyFunctionMap::iterator Fi = LazyFunctionLoadMap.find(Func);
Chris Lattner89e02532004-01-18 21:08:15 +00001644
Reid Spencer060d25d2004-06-29 23:29:38 +00001645 // Make sure we found it
Reid Spencer46b002c2004-07-11 17:28:43 +00001646 if (Fi == LazyFunctionLoadMap.end()) {
Reid Spencer24399722004-07-09 22:21:33 +00001647 error("Unrecognized function of type " + Func->getType()->getDescription());
Reid Spencer99655e12006-08-25 19:54:53 +00001648 return true;
Chris Lattner89e02532004-01-18 21:08:15 +00001649 }
1650
Reid Spencer060d25d2004-06-29 23:29:38 +00001651 BlockStart = At = Fi->second.Buf;
1652 BlockEnd = Fi->second.EndBuf;
Reid Spencer24399722004-07-09 22:21:33 +00001653 assert(Fi->first == Func && "Found wrong function?");
Reid Spencer060d25d2004-06-29 23:29:38 +00001654
Reid Spencer46b002c2004-07-11 17:28:43 +00001655 this->ParseFunctionBody(Func);
Reid Spencer99655e12006-08-25 19:54:53 +00001656 return false;
Chris Lattner89e02532004-01-18 21:08:15 +00001657}
1658
Reid Spencer04cde2c2004-07-04 11:33:49 +00001659/// The ParseAllFunctionBodies method parses through all the previously
1660/// unparsed functions in the bytecode file. If you want to completely parse
1661/// a bytecode file, this method should be called after Parsebytecode because
1662/// Parsebytecode only records the locations in the bytecode file of where
1663/// the function definitions are located. This function uses that information
1664/// to materialize the functions.
1665/// @see ParseBytecode
Reid Spencer99655e12006-08-25 19:54:53 +00001666bool BytecodeReader::ParseAllFunctionBodies(std::string* ErrMsg) {
Reid Spencer9b84ad12006-12-15 19:49:23 +00001667 if (setjmp(context)) {
1668 // Set caller's error message, if requested
1669 if (ErrMsg)
1670 *ErrMsg = ErrorMsg;
1671 // Indicate an error occurred
Reid Spencer99655e12006-08-25 19:54:53 +00001672 return true;
Reid Spencer9b84ad12006-12-15 19:49:23 +00001673 }
Reid Spencer99655e12006-08-25 19:54:53 +00001674
Chris Lattner24e90d32007-04-09 20:28:40 +00001675 for (LazyFunctionMap::iterator I = LazyFunctionLoadMap.begin(),
1676 E = LazyFunctionLoadMap.end(); I != E; ++I) {
1677 Function *Func = I->first;
1678 if (Func->hasNotBeenReadFromBytecode()) {
1679 BlockStart = At = I->second.Buf;
1680 BlockEnd = I->second.EndBuf;
1681 ParseFunctionBody(Func);
1682 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001683 }
Reid Spencer99655e12006-08-25 19:54:53 +00001684 return false;
Reid Spencer060d25d2004-06-29 23:29:38 +00001685}
Chris Lattner89e02532004-01-18 21:08:15 +00001686
Reid Spencer04cde2c2004-07-04 11:33:49 +00001687/// Parse the global type list
Reid Spencer060d25d2004-06-29 23:29:38 +00001688void BytecodeReader::ParseGlobalTypes() {
Reid Spencer04cde2c2004-07-04 11:33:49 +00001689 // Read the number of types
1690 unsigned NumEntries = read_vbr_uint();
Reid Spencer46b002c2004-07-11 17:28:43 +00001691 ParseTypes(ModuleTypes, NumEntries);
Reid Spencer060d25d2004-06-29 23:29:38 +00001692}
1693
Reid Spencer04cde2c2004-07-04 11:33:49 +00001694/// Parse the Global info (types, global vars, constants)
Reid Spencer060d25d2004-06-29 23:29:38 +00001695void BytecodeReader::ParseModuleGlobalInfo() {
1696
Reid Spencer04cde2c2004-07-04 11:33:49 +00001697 if (Handler) Handler->handleModuleGlobalsBegin();
Chris Lattner00950542001-06-06 20:29:01 +00001698
Chris Lattner404cddf2005-11-12 01:33:40 +00001699 // SectionID - If a global has an explicit section specified, this map
1700 // remembers the ID until we can translate it into a string.
1701 std::map<GlobalValue*, unsigned> SectionID;
1702
Chris Lattner70cc3392001-09-10 07:58:01 +00001703 // Read global variables...
Reid Spencer060d25d2004-06-29 23:29:38 +00001704 unsigned VarType = read_vbr_uint();
Chris Lattner70cc3392001-09-10 07:58:01 +00001705 while (VarType != Type::VoidTyID) { // List is terminated by Void
Chris Lattner9dd87702004-04-03 23:43:42 +00001706 // VarType Fields: bit0 = isConstant, bit1 = hasInitializer, bit2,3,4 =
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001707 // Linkage, bit5 = isThreadLocal, bit6+ = slot#
1708 unsigned SlotNo = VarType >> 6;
Chris Lattner9dd87702004-04-03 23:43:42 +00001709 unsigned LinkageID = (VarType >> 2) & 7;
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001710 unsigned VisibilityID = 0;
Reid Spencer060d25d2004-06-29 23:29:38 +00001711 bool isConstant = VarType & 1;
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001712 bool isThreadLocal = (VarType >> 5) & 1;
Chris Lattnerce5e04e2005-11-06 08:23:17 +00001713 bool hasInitializer = (VarType & 2) != 0;
Chris Lattner8eb52dd2005-11-06 07:11:04 +00001714 unsigned Alignment = 0;
Chris Lattner404cddf2005-11-12 01:33:40 +00001715 unsigned GlobalSectionID = 0;
Chris Lattner8eb52dd2005-11-06 07:11:04 +00001716
1717 // An extension word is present when linkage = 3 (internal) and hasinit = 0.
1718 if (LinkageID == 3 && !hasInitializer) {
1719 unsigned ExtWord = read_vbr_uint();
1720 // The extension word has this format: bit 0 = has initializer, bit 1-3 =
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001721 // linkage, bit 4-8 = alignment (log2), bit 9 = has section,
1722 // bits 10-12 = visibility, bits 13+ = future use.
Chris Lattner8eb52dd2005-11-06 07:11:04 +00001723 hasInitializer = ExtWord & 1;
1724 LinkageID = (ExtWord >> 1) & 7;
1725 Alignment = (1 << ((ExtWord >> 4) & 31)) >> 1;
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001726 VisibilityID = (ExtWord >> 10) & 7;
Chris Lattner404cddf2005-11-12 01:33:40 +00001727
1728 if (ExtWord & (1 << 9)) // Has a section ID.
1729 GlobalSectionID = read_vbr_uint();
Chris Lattner8eb52dd2005-11-06 07:11:04 +00001730 }
Chris Lattnere3869c82003-04-16 21:16:05 +00001731
Chris Lattnerce5e04e2005-11-06 08:23:17 +00001732 GlobalValue::LinkageTypes Linkage;
Chris Lattnerc08912f2004-01-14 16:44:44 +00001733 switch (LinkageID) {
Chris Lattnerc08912f2004-01-14 16:44:44 +00001734 case 0: Linkage = GlobalValue::ExternalLinkage; break;
1735 case 1: Linkage = GlobalValue::WeakLinkage; break;
1736 case 2: Linkage = GlobalValue::AppendingLinkage; break;
1737 case 3: Linkage = GlobalValue::InternalLinkage; break;
1738 case 4: Linkage = GlobalValue::LinkOnceLinkage; break;
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00001739 case 5: Linkage = GlobalValue::DLLImportLinkage; break;
1740 case 6: Linkage = GlobalValue::DLLExportLinkage; break;
1741 case 7: Linkage = GlobalValue::ExternalWeakLinkage; break;
Misha Brukman8a96c532005-04-21 21:44:41 +00001742 default:
Reid Spencer24399722004-07-09 22:21:33 +00001743 error("Unknown linkage type: " + utostr(LinkageID));
Reid Spencer060d25d2004-06-29 23:29:38 +00001744 Linkage = GlobalValue::InternalLinkage;
1745 break;
Chris Lattnere3869c82003-04-16 21:16:05 +00001746 }
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001747 GlobalValue::VisibilityTypes Visibility;
1748 switch (VisibilityID) {
1749 case 0: Visibility = GlobalValue::DefaultVisibility; break;
1750 case 1: Visibility = GlobalValue::HiddenVisibility; break;
1751 default:
1752 error("Unknown visibility type: " + utostr(VisibilityID));
1753 Visibility = GlobalValue::DefaultVisibility;
1754 break;
1755 }
1756
Chris Lattnere3869c82003-04-16 21:16:05 +00001757 const Type *Ty = getType(SlotNo);
Chris Lattnere73bd452005-11-06 07:43:39 +00001758 if (!Ty)
Reid Spencer24399722004-07-09 22:21:33 +00001759 error("Global has no type! SlotNo=" + utostr(SlotNo));
Reid Spencer060d25d2004-06-29 23:29:38 +00001760
Chris Lattnere73bd452005-11-06 07:43:39 +00001761 if (!isa<PointerType>(Ty))
Reid Spencer24399722004-07-09 22:21:33 +00001762 error("Global not a pointer type! Ty= " + Ty->getDescription());
Chris Lattner70cc3392001-09-10 07:58:01 +00001763
Chris Lattner52e20b02003-03-19 20:54:26 +00001764 const Type *ElTy = cast<PointerType>(Ty)->getElementType();
Chris Lattnerd70684f2001-09-18 04:01:05 +00001765
Chris Lattner70cc3392001-09-10 07:58:01 +00001766 // Create the global variable...
Reid Spencer060d25d2004-06-29 23:29:38 +00001767 GlobalVariable *GV = new GlobalVariable(ElTy, isConstant, Linkage,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001768 0, "", TheModule, isThreadLocal);
Chris Lattner8eb52dd2005-11-06 07:11:04 +00001769 GV->setAlignment(Alignment);
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001770 GV->setVisibility(Visibility);
Chris Lattner29b789b2003-11-19 17:27:18 +00001771 insertValue(GV, SlotNo, ModuleValues);
Chris Lattner05950c32001-10-13 06:47:01 +00001772
Chris Lattner404cddf2005-11-12 01:33:40 +00001773 if (GlobalSectionID != 0)
1774 SectionID[GV] = GlobalSectionID;
1775
Reid Spencer060d25d2004-06-29 23:29:38 +00001776 unsigned initSlot = 0;
Misha Brukman8a96c532005-04-21 21:44:41 +00001777 if (hasInitializer) {
Reid Spencer060d25d2004-06-29 23:29:38 +00001778 initSlot = read_vbr_uint();
1779 GlobalInits.push_back(std::make_pair(GV, initSlot));
1780 }
1781
1782 // Notify handler about the global value.
Chris Lattner4a242b32004-10-14 01:39:18 +00001783 if (Handler)
Anton Korobeynikov7f705592007-01-12 19:20:47 +00001784 Handler->handleGlobalVariable(ElTy, isConstant, Linkage, Visibility,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001785 SlotNo, initSlot, isThreadLocal);
Reid Spencer060d25d2004-06-29 23:29:38 +00001786
1787 // Get next item
1788 VarType = read_vbr_uint();
Chris Lattner70cc3392001-09-10 07:58:01 +00001789 }
1790
Chris Lattner52e20b02003-03-19 20:54:26 +00001791 // Read the function objects for all of the functions that are coming
Chris Lattnera79e7cc2004-10-16 18:18:16 +00001792 unsigned FnSignature = read_vbr_uint();
Reid Spencer24399722004-07-09 22:21:33 +00001793
Chris Lattnera79e7cc2004-10-16 18:18:16 +00001794 // List is terminated by VoidTy.
Chris Lattnere73bd452005-11-06 07:43:39 +00001795 while (((FnSignature & (~0U >> 1)) >> 5) != Type::VoidTyID) {
1796 const Type *Ty = getType((FnSignature & (~0U >> 1)) >> 5);
Chris Lattner927b1852003-10-09 20:22:47 +00001797 if (!isa<PointerType>(Ty) ||
Reid Spencer060d25d2004-06-29 23:29:38 +00001798 !isa<FunctionType>(cast<PointerType>(Ty)->getElementType())) {
Misha Brukman8a96c532005-04-21 21:44:41 +00001799 error("Function not a pointer to function type! Ty = " +
Reid Spencer46b002c2004-07-11 17:28:43 +00001800 Ty->getDescription());
Reid Spencer060d25d2004-06-29 23:29:38 +00001801 }
Chris Lattner8cdc6b72002-10-23 00:51:54 +00001802
Chris Lattner2a7b6ba2003-03-06 17:15:19 +00001803 // We create functions by passing the underlying FunctionType to create...
Misha Brukman8a96c532005-04-21 21:44:41 +00001804 const FunctionType* FTy =
Reid Spencer060d25d2004-06-29 23:29:38 +00001805 cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
Chris Lattner00950542001-06-06 20:29:01 +00001806
Chris Lattner18549c22004-11-15 21:43:03 +00001807 // Insert the place holder.
Chris Lattner404cddf2005-11-12 01:33:40 +00001808 Function *Func = new Function(FTy, GlobalValue::ExternalLinkage,
Reid Spencer04cde2c2004-07-04 11:33:49 +00001809 "", TheModule);
Reid Spencere1e96c02006-01-19 07:02:16 +00001810
Chris Lattnere73bd452005-11-06 07:43:39 +00001811 insertValue(Func, (FnSignature & (~0U >> 1)) >> 5, ModuleValues);
Chris Lattnera79e7cc2004-10-16 18:18:16 +00001812
1813 // Flags are not used yet.
Chris Lattner97fbc502004-11-15 22:38:52 +00001814 unsigned Flags = FnSignature & 31;
Chris Lattner00950542001-06-06 20:29:01 +00001815
Chris Lattner97fbc502004-11-15 22:38:52 +00001816 // Save this for later so we know type of lazily instantiated functions.
1817 // Note that known-external functions do not have FunctionInfo blocks, so we
1818 // do not add them to the FunctionSignatureList.
1819 if ((Flags & (1 << 4)) == 0)
1820 FunctionSignatureList.push_back(Func);
Chris Lattner52e20b02003-03-19 20:54:26 +00001821
Chris Lattnere73bd452005-11-06 07:43:39 +00001822 // Get the calling convention from the low bits.
1823 unsigned CC = Flags & 15;
1824 unsigned Alignment = 0;
1825 if (FnSignature & (1 << 31)) { // Has extension word?
1826 unsigned ExtWord = read_vbr_uint();
1827 Alignment = (1 << (ExtWord & 31)) >> 1;
1828 CC |= ((ExtWord >> 5) & 15) << 4;
Chris Lattner404cddf2005-11-12 01:33:40 +00001829
1830 if (ExtWord & (1 << 10)) // Has a section ID.
1831 SectionID[Func] = read_vbr_uint();
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00001832
1833 // Parse external declaration linkage
1834 switch ((ExtWord >> 11) & 3) {
1835 case 0: break;
1836 case 1: Func->setLinkage(Function::DLLImportLinkage); break;
1837 case 2: Func->setLinkage(Function::ExternalWeakLinkage); break;
1838 default: assert(0 && "Unsupported external linkage");
1839 }
Chris Lattnere73bd452005-11-06 07:43:39 +00001840 }
1841
Chris Lattner54b369e2005-11-06 07:46:13 +00001842 Func->setCallingConv(CC-1);
Chris Lattnere73bd452005-11-06 07:43:39 +00001843 Func->setAlignment(Alignment);
Chris Lattner479ffeb2005-05-06 20:42:57 +00001844
Reid Spencer04cde2c2004-07-04 11:33:49 +00001845 if (Handler) Handler->handleFunctionDeclaration(Func);
Reid Spencer060d25d2004-06-29 23:29:38 +00001846
Chris Lattnera79e7cc2004-10-16 18:18:16 +00001847 // Get the next function signature.
1848 FnSignature = read_vbr_uint();
Chris Lattner00950542001-06-06 20:29:01 +00001849 }
1850
Misha Brukman8a96c532005-04-21 21:44:41 +00001851 // Now that the function signature list is set up, reverse it so that we can
Chris Lattner74734132002-08-17 22:01:27 +00001852 // remove elements efficiently from the back of the vector.
1853 std::reverse(FunctionSignatureList.begin(), FunctionSignatureList.end());
Chris Lattner00950542001-06-06 20:29:01 +00001854
Chris Lattner404cddf2005-11-12 01:33:40 +00001855 /// SectionNames - This contains the list of section names encoded in the
1856 /// moduleinfoblock. Functions and globals with an explicit section index
1857 /// into this to get their section name.
1858 std::vector<std::string> SectionNames;
1859
Reid Spencerd798a512006-11-14 04:47:22 +00001860 // Read in the dependent library information.
1861 unsigned num_dep_libs = read_vbr_uint();
1862 std::string dep_lib;
1863 while (num_dep_libs--) {
1864 dep_lib = read_str();
1865 TheModule->addLibrary(dep_lib);
Reid Spencer5b472d92004-08-21 20:49:23 +00001866 if (Handler)
Reid Spencerd798a512006-11-14 04:47:22 +00001867 Handler->handleDependentLibrary(dep_lib);
Reid Spencerad89bd62004-07-25 18:07:36 +00001868 }
1869
Reid Spencerd798a512006-11-14 04:47:22 +00001870 // Read target triple and place into the module.
1871 std::string triple = read_str();
1872 TheModule->setTargetTriple(triple);
1873 if (Handler)
1874 Handler->handleTargetTriple(triple);
1875
Reid Spenceraacc35a2007-01-26 08:10:24 +00001876 // Read the data layout string and place into the module.
1877 std::string datalayout = read_str();
1878 TheModule->setDataLayout(datalayout);
1879 // FIXME: Implement
1880 // if (Handler)
1881 // Handler->handleDataLayout(datalayout);
1882
Reid Spencerd798a512006-11-14 04:47:22 +00001883 if (At != BlockEnd) {
1884 // If the file has section info in it, read the section names now.
1885 unsigned NumSections = read_vbr_uint();
1886 while (NumSections--)
1887 SectionNames.push_back(read_str());
1888 }
1889
1890 // If the file has module-level inline asm, read it now.
1891 if (At != BlockEnd)
1892 TheModule->setModuleInlineAsm(read_str());
1893
Chris Lattner404cddf2005-11-12 01:33:40 +00001894 // If any globals are in specified sections, assign them now.
1895 for (std::map<GlobalValue*, unsigned>::iterator I = SectionID.begin(), E =
1896 SectionID.end(); I != E; ++I)
1897 if (I->second) {
1898 if (I->second > SectionID.size())
1899 error("SectionID out of range for global!");
1900 I->first->setSection(SectionNames[I->second-1]);
1901 }
Reid Spencerad89bd62004-07-25 18:07:36 +00001902
Chris Lattner00950542001-06-06 20:29:01 +00001903 // This is for future proofing... in the future extra fields may be added that
1904 // we don't understand, so we transparently ignore them.
1905 //
Reid Spencer060d25d2004-06-29 23:29:38 +00001906 At = BlockEnd;
1907
Reid Spencer04cde2c2004-07-04 11:33:49 +00001908 if (Handler) Handler->handleModuleGlobalsEnd();
Chris Lattner00950542001-06-06 20:29:01 +00001909}
1910
Reid Spencer04cde2c2004-07-04 11:33:49 +00001911/// Parse the version information and decode it by setting flags on the
1912/// Reader that enable backward compatibility of the reader.
Reid Spencer060d25d2004-06-29 23:29:38 +00001913void BytecodeReader::ParseVersionInfo() {
Reid Spenceraacc35a2007-01-26 08:10:24 +00001914 unsigned RevisionNum = read_vbr_uint();
Chris Lattnere3869c82003-04-16 21:16:05 +00001915
Reid Spencer3795ad12006-12-03 05:47:10 +00001916 // We don't provide backwards compatibility in the Reader any more. To
1917 // upgrade, the user should use llvm-upgrade.
1918 if (RevisionNum < 7)
1919 error("Bytecode formats < 7 are no longer supported. Use llvm-upgrade.");
Chris Lattner036b8aa2003-03-06 17:55:45 +00001920
Reid Spenceraacc35a2007-01-26 08:10:24 +00001921 if (Handler) Handler->handleVersionInfo(RevisionNum);
Chris Lattner036b8aa2003-03-06 17:55:45 +00001922}
1923
Reid Spencer04cde2c2004-07-04 11:33:49 +00001924/// Parse a whole module.
Reid Spencer060d25d2004-06-29 23:29:38 +00001925void BytecodeReader::ParseModule() {
Chris Lattner00950542001-06-06 20:29:01 +00001926 unsigned Type, Size;
Chris Lattner00950542001-06-06 20:29:01 +00001927
Reid Spencer060d25d2004-06-29 23:29:38 +00001928 FunctionSignatureList.clear(); // Just in case...
Chris Lattner00950542001-06-06 20:29:01 +00001929
1930 // Read into instance variables...
Reid Spencer060d25d2004-06-29 23:29:38 +00001931 ParseVersionInfo();
Chris Lattner00950542001-06-06 20:29:01 +00001932
Reid Spencer060d25d2004-06-29 23:29:38 +00001933 bool SeenModuleGlobalInfo = false;
1934 bool SeenGlobalTypePlane = false;
1935 BufPtr MyEnd = BlockEnd;
1936 while (At < MyEnd) {
1937 BufPtr OldAt = At;
1938 read_block(Type, Size);
1939
Chris Lattner00950542001-06-06 20:29:01 +00001940 switch (Type) {
Reid Spencer060d25d2004-06-29 23:29:38 +00001941
Reid Spencerad89bd62004-07-25 18:07:36 +00001942 case BytecodeFormat::GlobalTypePlaneBlockID:
Reid Spencer46b002c2004-07-11 17:28:43 +00001943 if (SeenGlobalTypePlane)
Reid Spencer24399722004-07-09 22:21:33 +00001944 error("Two GlobalTypePlane Blocks Encountered!");
Reid Spencer060d25d2004-06-29 23:29:38 +00001945
Reid Spencer5b472d92004-08-21 20:49:23 +00001946 if (Size > 0)
1947 ParseGlobalTypes();
Reid Spencer060d25d2004-06-29 23:29:38 +00001948 SeenGlobalTypePlane = true;
Chris Lattner52e20b02003-03-19 20:54:26 +00001949 break;
1950
Misha Brukman8a96c532005-04-21 21:44:41 +00001951 case BytecodeFormat::ModuleGlobalInfoBlockID:
Reid Spencer46b002c2004-07-11 17:28:43 +00001952 if (SeenModuleGlobalInfo)
Reid Spencer24399722004-07-09 22:21:33 +00001953 error("Two ModuleGlobalInfo Blocks Encountered!");
Reid Spencer060d25d2004-06-29 23:29:38 +00001954 ParseModuleGlobalInfo();
1955 SeenModuleGlobalInfo = true;
Chris Lattner52e20b02003-03-19 20:54:26 +00001956 break;
1957
Reid Spencerad89bd62004-07-25 18:07:36 +00001958 case BytecodeFormat::ConstantPoolBlockID:
Reid Spencer04cde2c2004-07-04 11:33:49 +00001959 ParseConstantPool(ModuleValues, ModuleTypes,false);
Chris Lattner00950542001-06-06 20:29:01 +00001960 break;
1961
Reid Spencerad89bd62004-07-25 18:07:36 +00001962 case BytecodeFormat::FunctionBlockID:
Reid Spencer060d25d2004-06-29 23:29:38 +00001963 ParseFunctionLazily();
Chris Lattner00950542001-06-06 20:29:01 +00001964 break;
Chris Lattner00950542001-06-06 20:29:01 +00001965
Reid Spencer78d033e2007-01-06 07:24:44 +00001966 case BytecodeFormat::ValueSymbolTableBlockID:
1967 ParseValueSymbolTable(0, &TheModule->getValueSymbolTable());
1968 break;
1969
1970 case BytecodeFormat::TypeSymbolTableBlockID:
1971 ParseTypeSymbolTable(&TheModule->getTypeSymbolTable());
Chris Lattner00950542001-06-06 20:29:01 +00001972 break;
Reid Spencer060d25d2004-06-29 23:29:38 +00001973
Chris Lattner00950542001-06-06 20:29:01 +00001974 default:
Reid Spencer060d25d2004-06-29 23:29:38 +00001975 At += Size;
1976 if (OldAt > At) {
Reid Spencer46b002c2004-07-11 17:28:43 +00001977 error("Unexpected Block of Type #" + utostr(Type) + " encountered!");
Reid Spencer060d25d2004-06-29 23:29:38 +00001978 }
Chris Lattner00950542001-06-06 20:29:01 +00001979 break;
1980 }
Reid Spencer060d25d2004-06-29 23:29:38 +00001981 BlockEnd = MyEnd;
Chris Lattner00950542001-06-06 20:29:01 +00001982 }
1983
Chris Lattner52e20b02003-03-19 20:54:26 +00001984 // After the module constant pool has been read, we can safely initialize
1985 // global variables...
1986 while (!GlobalInits.empty()) {
1987 GlobalVariable *GV = GlobalInits.back().first;
1988 unsigned Slot = GlobalInits.back().second;
1989 GlobalInits.pop_back();
1990
1991 // Look up the initializer value...
Chris Lattner29b789b2003-11-19 17:27:18 +00001992 // FIXME: Preserve this type ID!
Reid Spencer060d25d2004-06-29 23:29:38 +00001993
1994 const llvm::PointerType* GVType = GV->getType();
1995 unsigned TypeSlot = getTypeSlot(GVType->getElementType());
Chris Lattner93361992004-01-15 18:45:25 +00001996 if (Constant *CV = getConstantValue(TypeSlot, Slot)) {
Misha Brukman8a96c532005-04-21 21:44:41 +00001997 if (GV->hasInitializer())
Reid Spencer24399722004-07-09 22:21:33 +00001998 error("Global *already* has an initializer?!");
Reid Spencer04cde2c2004-07-04 11:33:49 +00001999 if (Handler) Handler->handleGlobalInitializer(GV,CV);
Chris Lattner93361992004-01-15 18:45:25 +00002000 GV->setInitializer(CV);
Chris Lattner52e20b02003-03-19 20:54:26 +00002001 } else
Reid Spencer24399722004-07-09 22:21:33 +00002002 error("Cannot find initializer value.");
Chris Lattner52e20b02003-03-19 20:54:26 +00002003 }
2004
Chris Lattneraba5ff52005-05-05 20:57:00 +00002005 if (!ConstantFwdRefs.empty())
2006 error("Use of undefined constants in a module");
2007
Reid Spencer060d25d2004-06-29 23:29:38 +00002008 /// Make sure we pulled them all out. If we didn't then there's a declaration
2009 /// but a missing body. That's not allowed.
Misha Brukman12c29d12003-09-22 23:38:23 +00002010 if (!FunctionSignatureList.empty())
Reid Spencer24399722004-07-09 22:21:33 +00002011 error("Function declared, but bytecode stream ended before definition");
Chris Lattner00950542001-06-06 20:29:01 +00002012}
2013
Reid Spencer04cde2c2004-07-04 11:33:49 +00002014/// This function completely parses a bytecode buffer given by the \p Buf
2015/// and \p Length parameters.
Anton Korobeynikov7d515442006-09-01 20:35:17 +00002016bool BytecodeReader::ParseBytecode(volatile BufPtr Buf, unsigned Length,
Reid Spencer233fe722006-08-22 16:09:19 +00002017 const std::string &ModuleID,
Chris Lattnerf2e292c2007-02-07 21:41:02 +00002018 BCDecompressor_t *Decompressor,
Reid Spencer233fe722006-08-22 16:09:19 +00002019 std::string* ErrMsg) {
Misha Brukmane0dd0d42003-09-23 16:15:29 +00002020
Reid Spencer233fe722006-08-22 16:09:19 +00002021 /// We handle errors by
2022 if (setjmp(context)) {
2023 // Cleanup after error
2024 if (Handler) Handler->handleError(ErrorMsg);
Reid Spencer060d25d2004-06-29 23:29:38 +00002025 freeState();
Chris Lattner2a7b6ba2003-03-06 17:15:19 +00002026 delete TheModule;
2027 TheModule = 0;
Chris Lattner3bdad692004-11-15 21:55:33 +00002028 if (decompressedBlock != 0 ) {
Reid Spencer61aaf2e2004-11-14 21:59:21 +00002029 ::free(decompressedBlock);
Chris Lattner3bdad692004-11-15 21:55:33 +00002030 decompressedBlock = 0;
2031 }
Reid Spencer233fe722006-08-22 16:09:19 +00002032 // Set caller's error message, if requested
2033 if (ErrMsg)
2034 *ErrMsg = ErrorMsg;
2035 // Indicate an error occurred
2036 return true;
Chris Lattner2a7b6ba2003-03-06 17:15:19 +00002037 }
Reid Spencer233fe722006-08-22 16:09:19 +00002038
2039 RevisionNum = 0;
2040 At = MemStart = BlockStart = Buf;
2041 MemEnd = BlockEnd = Buf + Length;
2042
2043 // Create the module
2044 TheModule = new Module(ModuleID);
2045
2046 if (Handler) Handler->handleStart(TheModule, Length);
2047
2048 // Read the four bytes of the signature.
2049 unsigned Sig = read_uint();
2050
2051 // If this is a compressed file
2052 if (Sig == ('l' | ('l' << 8) | ('v' << 16) | ('c' << 24))) {
Chris Lattnerf2e292c2007-02-07 21:41:02 +00002053 if (!Decompressor) {
2054 error("Compressed bytecode found, but not decompressor available");
2055 }
Reid Spencer233fe722006-08-22 16:09:19 +00002056
2057 // Invoke the decompression of the bytecode. Note that we have to skip the
2058 // file's magic number which is not part of the compressed block. Hence,
2059 // the Buf+4 and Length-4. The result goes into decompressedBlock, a data
2060 // member for retention until BytecodeReader is destructed.
Chris Lattner0d3382a2007-02-07 19:49:01 +00002061 unsigned decompressedLength =
2062 Decompressor((char*)Buf+4,Length-4,decompressedBlock, 0);
Reid Spencer233fe722006-08-22 16:09:19 +00002063
2064 // We must adjust the buffer pointers used by the bytecode reader to point
2065 // into the new decompressed block. After decompression, the
2066 // decompressedBlock will point to a contiguous memory area that has
2067 // the decompressed data.
2068 At = MemStart = BlockStart = Buf = (BufPtr) decompressedBlock;
2069 MemEnd = BlockEnd = Buf + decompressedLength;
2070
2071 // else if this isn't a regular (uncompressed) bytecode file, then its
2072 // and error, generate that now.
2073 } else if (Sig != ('l' | ('l' << 8) | ('v' << 16) | ('m' << 24))) {
2074 error("Invalid bytecode signature: " + utohexstr(Sig));
2075 }
2076
2077 // Tell the handler we're starting a module
2078 if (Handler) Handler->handleModuleBegin(ModuleID);
2079
2080 // Get the module block and size and verify. This is handled specially
2081 // because the module block/size is always written in long format. Other
2082 // blocks are written in short format so the read_block method is used.
2083 unsigned Type, Size;
2084 Type = read_uint();
2085 Size = read_uint();
2086 if (Type != BytecodeFormat::ModuleBlockID) {
2087 error("Expected Module Block! Type:" + utostr(Type) + ", Size:"
2088 + utostr(Size));
2089 }
2090
2091 // It looks like the darwin ranlib program is broken, and adds trailing
2092 // garbage to the end of some bytecode files. This hack allows the bc
2093 // reader to ignore trailing garbage on bytecode files.
2094 if (At + Size < MemEnd)
2095 MemEnd = BlockEnd = At+Size;
2096
2097 if (At + Size != MemEnd)
2098 error("Invalid Top Level Block Length! Type:" + utostr(Type)
2099 + ", Size:" + utostr(Size));
2100
2101 // Parse the module contents
2102 this->ParseModule();
2103
2104 // Check for missing functions
2105 if (hasFunctions())
2106 error("Function expected, but bytecode stream ended!");
2107
Reid Spencer233fe722006-08-22 16:09:19 +00002108 // Tell the handler we're done with the module
2109 if (Handler)
2110 Handler->handleModuleEnd(ModuleID);
2111
2112 // Tell the handler we're finished the parse
2113 if (Handler) Handler->handleFinish();
2114
2115 return false;
2116
Chris Lattner00950542001-06-06 20:29:01 +00002117}
Reid Spencer060d25d2004-06-29 23:29:38 +00002118
2119//===----------------------------------------------------------------------===//
2120//=== Default Implementations of Handler Methods
2121//===----------------------------------------------------------------------===//
2122
2123BytecodeHandler::~BytecodeHandler() {}