1 //===- Reader.cpp - Code to read bytecode files ---------------------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This library implements the functionality defined in llvm/Bytecode/Reader.h
12 // Note that this library should be as fast as possible, reentrant, and
15 // TODO: Allow passing in an option to ignore the symbol table
17 //===----------------------------------------------------------------------===//
20 #include "llvm/Bytecode/BytecodeHandler.h"
21 #include "llvm/BasicBlock.h"
22 #include "llvm/Config/alloca.h"
23 #include "llvm/Constants.h"
24 #include "llvm/Instructions.h"
25 #include "llvm/SymbolTable.h"
26 #include "llvm/Bytecode/Format.h"
27 #include "llvm/Support/GetElementPtrTypeIterator.h"
28 #include "llvm/Support/Compressor.h"
29 #include "llvm/ADT/StringExtras.h"
35 /// @brief A class for maintaining the slot number definition
36 /// as a placeholder for the actual definition for forward constants defs.
37 class ConstantPlaceHolder : public ConstantExpr {
38 ConstantPlaceHolder(); // DO NOT IMPLEMENT
39 void operator=(const ConstantPlaceHolder &); // DO NOT IMPLEMENT
42 ConstantPlaceHolder(const Type *Ty)
43 : ConstantExpr(Ty, Instruction::UserOp1, &Op, 1),
44 Op(UndefValue::get(Type::IntTy), this) {
49 // Provide some details on error
50 inline void BytecodeReader::error(std::string err) {
52 err += itostr(RevisionNum) ;
54 err += itostr(At-MemStart);
59 //===----------------------------------------------------------------------===//
60 // Bytecode Reading Methods
61 //===----------------------------------------------------------------------===//
63 /// Determine if the current block being read contains any more data.
64 inline bool BytecodeReader::moreInBlock() {
68 /// Throw an error if we've read past the end of the current block
69 inline void BytecodeReader::checkPastBlockEnd(const char * block_name) {
71 error(std::string("Attempt to read past the end of ") + block_name +
75 /// Align the buffer position to a 32 bit boundary
76 inline void BytecodeReader::align32() {
79 At = (const unsigned char *)((unsigned long)(At+3) & (~3UL));
81 if (Handler) Handler->handleAlignment(At - Save);
83 error("Ran out of data while aligning!");
87 /// Read a whole unsigned integer
88 inline unsigned BytecodeReader::read_uint() {
90 error("Ran out of data reading uint!");
92 return At[-4] | (At[-3] << 8) | (At[-2] << 16) | (At[-1] << 24);
95 /// Read a variable-bit-rate encoded unsigned integer
96 inline unsigned BytecodeReader::read_vbr_uint() {
103 error("Ran out of data reading vbr_uint!");
104 Result |= (unsigned)((*At++) & 0x7F) << Shift;
106 } while (At[-1] & 0x80);
107 if (Handler) Handler->handleVBR32(At-Save);
111 /// Read a variable-bit-rate encoded unsigned 64-bit integer.
112 inline uint64_t BytecodeReader::read_vbr_uint64() {
119 error("Ran out of data reading vbr_uint64!");
120 Result |= (uint64_t)((*At++) & 0x7F) << Shift;
122 } while (At[-1] & 0x80);
123 if (Handler) Handler->handleVBR64(At-Save);
127 /// Read a variable-bit-rate encoded signed 64-bit integer.
128 inline int64_t BytecodeReader::read_vbr_int64() {
129 uint64_t R = read_vbr_uint64();
132 return -(int64_t)(R >> 1);
133 else // There is no such thing as -0 with integers. "-0" really means
134 // 0x8000000000000000.
137 return (int64_t)(R >> 1);
140 /// Read a pascal-style string (length followed by text)
141 inline std::string BytecodeReader::read_str() {
142 unsigned Size = read_vbr_uint();
143 const unsigned char *OldAt = At;
145 if (At > BlockEnd) // Size invalid?
146 error("Ran out of data reading a string!");
147 return std::string((char*)OldAt, Size);
150 /// Read an arbitrary block of data
151 inline void BytecodeReader::read_data(void *Ptr, void *End) {
152 unsigned char *Start = (unsigned char *)Ptr;
153 unsigned Amount = (unsigned char *)End - Start;
154 if (At+Amount > BlockEnd)
155 error("Ran out of data!");
156 std::copy(At, At+Amount, Start);
160 /// Read a float value in little-endian order
161 inline void BytecodeReader::read_float(float& FloatVal) {
162 /// FIXME: This isn't optimal, it has size problems on some platforms
163 /// where FP is not IEEE.
168 FloatUnion.i = At[0] | (At[1] << 8) | (At[2] << 16) | (At[3] << 24);
169 At+=sizeof(uint32_t);
170 FloatVal = FloatUnion.f;
173 /// Read a double value in little-endian order
174 inline void BytecodeReader::read_double(double& DoubleVal) {
175 /// FIXME: This isn't optimal, it has size problems on some platforms
176 /// where FP is not IEEE.
181 DoubleUnion.i = (uint64_t(At[0]) << 0) | (uint64_t(At[1]) << 8) |
182 (uint64_t(At[2]) << 16) | (uint64_t(At[3]) << 24) |
183 (uint64_t(At[4]) << 32) | (uint64_t(At[5]) << 40) |
184 (uint64_t(At[6]) << 48) | (uint64_t(At[7]) << 56);
185 At+=sizeof(uint64_t);
186 DoubleVal = DoubleUnion.d;
189 /// Read a block header and obtain its type and size
190 inline void BytecodeReader::read_block(unsigned &Type, unsigned &Size) {
191 if ( hasLongBlockHeaders ) {
195 case BytecodeFormat::Reserved_DoNotUse :
196 error("Reserved_DoNotUse used as Module Type?");
197 Type = BytecodeFormat::ModuleBlockID; break;
198 case BytecodeFormat::Module:
199 Type = BytecodeFormat::ModuleBlockID; break;
200 case BytecodeFormat::Function:
201 Type = BytecodeFormat::FunctionBlockID; break;
202 case BytecodeFormat::ConstantPool:
203 Type = BytecodeFormat::ConstantPoolBlockID; break;
204 case BytecodeFormat::SymbolTable:
205 Type = BytecodeFormat::SymbolTableBlockID; break;
206 case BytecodeFormat::ModuleGlobalInfo:
207 Type = BytecodeFormat::ModuleGlobalInfoBlockID; break;
208 case BytecodeFormat::GlobalTypePlane:
209 Type = BytecodeFormat::GlobalTypePlaneBlockID; break;
210 case BytecodeFormat::InstructionList:
211 Type = BytecodeFormat::InstructionListBlockID; break;
212 case BytecodeFormat::CompactionTable:
213 Type = BytecodeFormat::CompactionTableBlockID; break;
214 case BytecodeFormat::BasicBlock:
215 /// This block type isn't used after version 1.1. However, we have to
216 /// still allow the value in case this is an old bc format file.
217 /// We just let its value creep thru.
220 error("Invalid block id found: " + utostr(Type));
225 Type = Size & 0x1F; // mask low order five bits
226 Size >>= 5; // get rid of five low order bits, leaving high 27
229 if (At + Size > BlockEnd)
230 error("Attempt to size a block past end of memory");
231 BlockEnd = At + Size;
232 if (Handler) Handler->handleBlock(Type, BlockStart, Size);
236 /// In LLVM 1.2 and before, Types were derived from Value and so they were
237 /// written as part of the type planes along with any other Value. In LLVM
238 /// 1.3 this changed so that Type does not derive from Value. Consequently,
239 /// the BytecodeReader's containers for Values can't contain Types because
240 /// there's no inheritance relationship. This means that the "Type Type"
241 /// plane is defunct along with the Type::TypeTyID TypeID. In LLVM 1.3
242 /// whenever a bytecode construct must have both types and values together,
243 /// the types are always read/written first and then the Values. Furthermore
244 /// since Type::TypeTyID no longer exists, its value (12) now corresponds to
245 /// Type::LabelTyID. In order to overcome this we must "sanitize" all the
246 /// type TypeIDs we encounter. For LLVM 1.3 bytecode files, there's no change.
247 /// For LLVM 1.2 and before, this function will decrement the type id by
248 /// one to account for the missing Type::TypeTyID enumerator if the value is
249 /// larger than 12 (Type::LabelTyID). If the value is exactly 12, then this
250 /// function returns true, otherwise false. This helps detect situations
251 /// where the pre 1.3 bytecode is indicating that what follows is a type.
252 /// @returns true iff type id corresponds to pre 1.3 "type type"
253 inline bool BytecodeReader::sanitizeTypeId(unsigned &TypeId) {
254 if (hasTypeDerivedFromValue) { /// do nothing if 1.3 or later
255 if (TypeId == Type::LabelTyID) {
256 TypeId = Type::VoidTyID; // sanitize it
257 return true; // indicate we got TypeTyID in pre 1.3 bytecode
258 } else if (TypeId > Type::LabelTyID)
259 --TypeId; // shift all planes down because type type plane is missing
264 /// Reads a vbr uint to read in a type id and does the necessary
265 /// conversion on it by calling sanitizeTypeId.
266 /// @returns true iff \p TypeId read corresponds to a pre 1.3 "type type"
267 /// @see sanitizeTypeId
268 inline bool BytecodeReader::read_typeid(unsigned &TypeId) {
269 TypeId = read_vbr_uint();
270 if ( !has32BitTypes )
271 if ( TypeId == 0x00FFFFFF )
272 TypeId = read_vbr_uint();
273 return sanitizeTypeId(TypeId);
276 //===----------------------------------------------------------------------===//
278 //===----------------------------------------------------------------------===//
280 /// Determine if a type id has an implicit null value
281 inline bool BytecodeReader::hasImplicitNull(unsigned TyID) {
282 if (!hasExplicitPrimitiveZeros)
283 return TyID != Type::LabelTyID && TyID != Type::VoidTyID;
284 return TyID >= Type::FirstDerivedTyID;
287 /// Obtain a type given a typeid and account for things like compaction tables,
288 /// function level vs module level, and the offsetting for the primitive types.
289 const Type *BytecodeReader::getType(unsigned ID) {
290 if (ID < Type::FirstDerivedTyID)
291 if (const Type *T = Type::getPrimitiveType((Type::TypeID)ID))
292 return T; // Asked for a primitive type...
294 // Otherwise, derived types need offset...
295 ID -= Type::FirstDerivedTyID;
297 if (!CompactionTypes.empty()) {
298 if (ID >= CompactionTypes.size())
299 error("Type ID out of range for compaction table!");
300 return CompactionTypes[ID].first;
303 // Is it a module-level type?
304 if (ID < ModuleTypes.size())
305 return ModuleTypes[ID].get();
307 // Nope, is it a function-level type?
308 ID -= ModuleTypes.size();
309 if (ID < FunctionTypes.size())
310 return FunctionTypes[ID].get();
312 error("Illegal type reference!");
316 /// Get a sanitized type id. This just makes sure that the \p ID
317 /// is both sanitized and not the "type type" of pre-1.3 bytecode.
318 /// @see sanitizeTypeId
319 inline const Type* BytecodeReader::getSanitizedType(unsigned& ID) {
320 if (sanitizeTypeId(ID))
321 error("Invalid type id encountered");
325 /// This method just saves some coding. It uses read_typeid to read
326 /// in a sanitized type id, errors that its not the type type, and
327 /// then calls getType to return the type value.
328 inline const Type* BytecodeReader::readSanitizedType() {
331 error("Invalid type id encountered");
335 /// Get the slot number associated with a type accounting for primitive
336 /// types, compaction tables, and function level vs module level.
337 unsigned BytecodeReader::getTypeSlot(const Type *Ty) {
338 if (Ty->isPrimitiveType())
339 return Ty->getTypeID();
341 // Scan the compaction table for the type if needed.
342 if (!CompactionTypes.empty()) {
343 for (unsigned i = 0, e = CompactionTypes.size(); i != e; ++i)
344 if (CompactionTypes[i].first == Ty)
345 return Type::FirstDerivedTyID + i;
347 error("Couldn't find type specified in compaction table!");
350 // Check the function level types first...
351 TypeListTy::iterator I = std::find(FunctionTypes.begin(),
352 FunctionTypes.end(), Ty);
354 if (I != FunctionTypes.end())
355 return Type::FirstDerivedTyID + ModuleTypes.size() +
356 (&*I - &FunctionTypes[0]);
358 // Check the module level types now...
359 I = std::find(ModuleTypes.begin(), ModuleTypes.end(), Ty);
360 if (I == ModuleTypes.end())
361 error("Didn't find type in ModuleTypes.");
362 return Type::FirstDerivedTyID + (&*I - &ModuleTypes[0]);
365 /// This is just like getType, but when a compaction table is in use, it is
366 /// ignored. It also ignores function level types.
368 const Type *BytecodeReader::getGlobalTableType(unsigned Slot) {
369 if (Slot < Type::FirstDerivedTyID) {
370 const Type *Ty = Type::getPrimitiveType((Type::TypeID)Slot);
372 error("Not a primitive type ID?");
375 Slot -= Type::FirstDerivedTyID;
376 if (Slot >= ModuleTypes.size())
377 error("Illegal compaction table type reference!");
378 return ModuleTypes[Slot];
381 /// This is just like getTypeSlot, but when a compaction table is in use, it
382 /// is ignored. It also ignores function level types.
383 unsigned BytecodeReader::getGlobalTableTypeSlot(const Type *Ty) {
384 if (Ty->isPrimitiveType())
385 return Ty->getTypeID();
386 TypeListTy::iterator I = std::find(ModuleTypes.begin(),
387 ModuleTypes.end(), Ty);
388 if (I == ModuleTypes.end())
389 error("Didn't find type in ModuleTypes.");
390 return Type::FirstDerivedTyID + (&*I - &ModuleTypes[0]);
393 /// Retrieve a value of a given type and slot number, possibly creating
394 /// it if it doesn't already exist.
395 Value * BytecodeReader::getValue(unsigned type, unsigned oNum, bool Create) {
396 assert(type != Type::LabelTyID && "getValue() cannot get blocks!");
399 // If there is a compaction table active, it defines the low-level numbers.
400 // If not, the module values define the low-level numbers.
401 if (CompactionValues.size() > type && !CompactionValues[type].empty()) {
402 if (Num < CompactionValues[type].size())
403 return CompactionValues[type][Num];
404 Num -= CompactionValues[type].size();
406 // By default, the global type id is the type id passed in
407 unsigned GlobalTyID = type;
409 // If the type plane was compactified, figure out the global type ID by
410 // adding the derived type ids and the distance.
411 if (!CompactionTypes.empty() && type >= Type::FirstDerivedTyID)
412 GlobalTyID = CompactionTypes[type-Type::FirstDerivedTyID].second;
414 if (hasImplicitNull(GlobalTyID)) {
416 return Constant::getNullValue(getType(type));
420 if (GlobalTyID < ModuleValues.size() && ModuleValues[GlobalTyID]) {
421 if (Num < ModuleValues[GlobalTyID]->size())
422 return ModuleValues[GlobalTyID]->getOperand(Num);
423 Num -= ModuleValues[GlobalTyID]->size();
427 if (FunctionValues.size() > type &&
428 FunctionValues[type] &&
429 Num < FunctionValues[type]->size())
430 return FunctionValues[type]->getOperand(Num);
432 if (!Create) return 0; // Do not create a placeholder?
434 // Did we already create a place holder?
435 std::pair<unsigned,unsigned> KeyValue(type, oNum);
436 ForwardReferenceMap::iterator I = ForwardReferences.lower_bound(KeyValue);
437 if (I != ForwardReferences.end() && I->first == KeyValue)
438 return I->second; // We have already created this placeholder
440 // If the type exists (it should)
441 if (const Type* Ty = getType(type)) {
442 // Create the place holder
443 Value *Val = new Argument(Ty);
444 ForwardReferences.insert(I, std::make_pair(KeyValue, Val));
447 throw "Can't create placeholder for value of type slot #" + utostr(type);
450 /// This is just like getValue, but when a compaction table is in use, it
451 /// is ignored. Also, no forward references or other fancy features are
453 Value* BytecodeReader::getGlobalTableValue(unsigned TyID, unsigned SlotNo) {
455 return Constant::getNullValue(getType(TyID));
457 if (!CompactionTypes.empty() && TyID >= Type::FirstDerivedTyID) {
458 TyID -= Type::FirstDerivedTyID;
459 if (TyID >= CompactionTypes.size())
460 error("Type ID out of range for compaction table!");
461 TyID = CompactionTypes[TyID].second;
466 if (TyID >= ModuleValues.size() || ModuleValues[TyID] == 0 ||
467 SlotNo >= ModuleValues[TyID]->size()) {
468 if (TyID >= ModuleValues.size() || ModuleValues[TyID] == 0)
469 error("Corrupt compaction table entry!"
470 + utostr(TyID) + ", " + utostr(SlotNo) + ": "
471 + utostr(ModuleValues.size()));
473 error("Corrupt compaction table entry!"
474 + utostr(TyID) + ", " + utostr(SlotNo) + ": "
475 + utostr(ModuleValues.size()) + ", "
476 + utohexstr(reinterpret_cast<uint64_t>(((void*)ModuleValues[TyID])))
478 + utostr(ModuleValues[TyID]->size()));
480 return ModuleValues[TyID]->getOperand(SlotNo);
483 /// Just like getValue, except that it returns a null pointer
484 /// only on error. It always returns a constant (meaning that if the value is
485 /// defined, but is not a constant, that is an error). If the specified
486 /// constant hasn't been parsed yet, a placeholder is defined and used.
487 /// Later, after the real value is parsed, the placeholder is eliminated.
488 Constant* BytecodeReader::getConstantValue(unsigned TypeSlot, unsigned Slot) {
489 if (Value *V = getValue(TypeSlot, Slot, false))
490 if (Constant *C = dyn_cast<Constant>(V))
491 return C; // If we already have the value parsed, just return it
493 error("Value for slot " + utostr(Slot) +
494 " is expected to be a constant!");
496 std::pair<unsigned, unsigned> Key(TypeSlot, Slot);
497 ConstantRefsType::iterator I = ConstantFwdRefs.lower_bound(Key);
499 if (I != ConstantFwdRefs.end() && I->first == Key) {
502 // Create a placeholder for the constant reference and
503 // keep track of the fact that we have a forward ref to recycle it
504 Constant *C = new ConstantPlaceHolder(getType(TypeSlot));
506 // Keep track of the fact that we have a forward ref to recycle it
507 ConstantFwdRefs.insert(I, std::make_pair(Key, C));
512 //===----------------------------------------------------------------------===//
513 // IR Construction Methods
514 //===----------------------------------------------------------------------===//
516 /// As values are created, they are inserted into the appropriate place
517 /// with this method. The ValueTable argument must be one of ModuleValues
518 /// or FunctionValues data members of this class.
519 unsigned BytecodeReader::insertValue(Value *Val, unsigned type,
520 ValueTable &ValueTab) {
521 assert((!isa<Constant>(Val) || !cast<Constant>(Val)->isNullValue()) ||
522 !hasImplicitNull(type) &&
523 "Cannot read null values from bytecode!");
525 if (ValueTab.size() <= type)
526 ValueTab.resize(type+1);
528 if (!ValueTab[type]) ValueTab[type] = new ValueList();
530 ValueTab[type]->push_back(Val);
532 bool HasOffset = hasImplicitNull(type);
533 return ValueTab[type]->size()-1 + HasOffset;
536 /// Insert the arguments of a function as new values in the reader.
537 void BytecodeReader::insertArguments(Function* F) {
538 const FunctionType *FT = F->getFunctionType();
539 Function::aiterator AI = F->abegin();
540 for (FunctionType::param_iterator It = FT->param_begin();
541 It != FT->param_end(); ++It, ++AI)
542 insertValue(AI, getTypeSlot(AI->getType()), FunctionValues);
545 //===----------------------------------------------------------------------===//
546 // Bytecode Parsing Methods
547 //===----------------------------------------------------------------------===//
549 /// This method parses a single instruction. The instruction is
550 /// inserted at the end of the \p BB provided. The arguments of
551 /// the instruction are provided in the \p Oprnds vector.
552 void BytecodeReader::ParseInstruction(std::vector<unsigned> &Oprnds,
556 // Clear instruction data
560 unsigned Op = read_uint();
562 // bits Instruction format: Common to all formats
563 // --------------------------
564 // 01-00: Opcode type, fixed to 1.
566 Opcode = (Op >> 2) & 63;
567 Oprnds.resize((Op >> 0) & 03);
569 // Extract the operands
570 switch (Oprnds.size()) {
572 // bits Instruction format:
573 // --------------------------
574 // 19-08: Resulting type plane
575 // 31-20: Operand #1 (if set to (2^12-1), then zero operands)
577 iType = (Op >> 8) & 4095;
578 Oprnds[0] = (Op >> 20) & 4095;
579 if (Oprnds[0] == 4095) // Handle special encoding for 0 operands...
583 // bits Instruction format:
584 // --------------------------
585 // 15-08: Resulting type plane
589 iType = (Op >> 8) & 255;
590 Oprnds[0] = (Op >> 16) & 255;
591 Oprnds[1] = (Op >> 24) & 255;
594 // bits Instruction format:
595 // --------------------------
596 // 13-08: Resulting type plane
601 iType = (Op >> 8) & 63;
602 Oprnds[0] = (Op >> 14) & 63;
603 Oprnds[1] = (Op >> 20) & 63;
604 Oprnds[2] = (Op >> 26) & 63;
607 At -= 4; // Hrm, try this again...
608 Opcode = read_vbr_uint();
610 iType = read_vbr_uint();
612 unsigned NumOprnds = read_vbr_uint();
613 Oprnds.resize(NumOprnds);
616 error("Zero-argument instruction found; this is invalid.");
618 for (unsigned i = 0; i != NumOprnds; ++i)
619 Oprnds[i] = read_vbr_uint();
624 const Type *InstTy = getSanitizedType(iType);
626 // We have enough info to inform the handler now.
627 if (Handler) Handler->handleInstruction(Opcode, InstTy, Oprnds, At-SaveAt);
629 // Declare the resulting instruction we'll build.
630 Instruction *Result = 0;
632 // If this is a bytecode format that did not include the unreachable
633 // instruction, bump up all opcodes numbers to make space.
634 if (hasNoUnreachableInst) {
635 if (Opcode >= Instruction::Unreachable &&
641 // Handle binary operators
642 if (Opcode >= Instruction::BinaryOpsBegin &&
643 Opcode < Instruction::BinaryOpsEnd && Oprnds.size() == 2)
644 Result = BinaryOperator::create((Instruction::BinaryOps)Opcode,
645 getValue(iType, Oprnds[0]),
646 getValue(iType, Oprnds[1]));
651 error("Illegal instruction read!");
653 case Instruction::VAArg:
654 Result = new VAArgInst(getValue(iType, Oprnds[0]),
655 getSanitizedType(Oprnds[1]));
657 case Instruction::VANext:
658 Result = new VANextInst(getValue(iType, Oprnds[0]),
659 getSanitizedType(Oprnds[1]));
661 case Instruction::Cast:
662 Result = new CastInst(getValue(iType, Oprnds[0]),
663 getSanitizedType(Oprnds[1]));
665 case Instruction::Select:
666 Result = new SelectInst(getValue(Type::BoolTyID, Oprnds[0]),
667 getValue(iType, Oprnds[1]),
668 getValue(iType, Oprnds[2]));
670 case Instruction::PHI: {
671 if (Oprnds.size() == 0 || (Oprnds.size() & 1))
672 error("Invalid phi node encountered!");
674 PHINode *PN = new PHINode(InstTy);
675 PN->reserveOperandSpace(Oprnds.size());
676 for (unsigned i = 0, e = Oprnds.size(); i != e; i += 2)
677 PN->addIncoming(getValue(iType, Oprnds[i]), getBasicBlock(Oprnds[i+1]));
682 case Instruction::Shl:
683 case Instruction::Shr:
684 Result = new ShiftInst((Instruction::OtherOps)Opcode,
685 getValue(iType, Oprnds[0]),
686 getValue(Type::UByteTyID, Oprnds[1]));
688 case Instruction::Ret:
689 if (Oprnds.size() == 0)
690 Result = new ReturnInst();
691 else if (Oprnds.size() == 1)
692 Result = new ReturnInst(getValue(iType, Oprnds[0]));
694 error("Unrecognized instruction!");
697 case Instruction::Br:
698 if (Oprnds.size() == 1)
699 Result = new BranchInst(getBasicBlock(Oprnds[0]));
700 else if (Oprnds.size() == 3)
701 Result = new BranchInst(getBasicBlock(Oprnds[0]),
702 getBasicBlock(Oprnds[1]), getValue(Type::BoolTyID , Oprnds[2]));
704 error("Invalid number of operands for a 'br' instruction!");
706 case Instruction::Switch: {
707 if (Oprnds.size() & 1)
708 error("Switch statement with odd number of arguments!");
710 SwitchInst *I = new SwitchInst(getValue(iType, Oprnds[0]),
711 getBasicBlock(Oprnds[1]),
713 for (unsigned i = 2, e = Oprnds.size(); i != e; i += 2)
714 I->addCase(cast<Constant>(getValue(iType, Oprnds[i])),
715 getBasicBlock(Oprnds[i+1]));
720 case Instruction::Call: {
721 if (Oprnds.size() == 0)
722 error("Invalid call instruction encountered!");
724 Value *F = getValue(iType, Oprnds[0]);
726 // Check to make sure we have a pointer to function type
727 const PointerType *PTy = dyn_cast<PointerType>(F->getType());
728 if (PTy == 0) error("Call to non function pointer value!");
729 const FunctionType *FTy = dyn_cast<FunctionType>(PTy->getElementType());
730 if (FTy == 0) error("Call to non function pointer value!");
732 std::vector<Value *> Params;
733 if (!FTy->isVarArg()) {
734 FunctionType::param_iterator It = FTy->param_begin();
736 for (unsigned i = 1, e = Oprnds.size(); i != e; ++i) {
737 if (It == FTy->param_end())
738 error("Invalid call instruction!");
739 Params.push_back(getValue(getTypeSlot(*It++), Oprnds[i]));
741 if (It != FTy->param_end())
742 error("Invalid call instruction!");
744 Oprnds.erase(Oprnds.begin(), Oprnds.begin()+1);
746 unsigned FirstVariableOperand;
747 if (Oprnds.size() < FTy->getNumParams())
748 error("Call instruction missing operands!");
750 // Read all of the fixed arguments
751 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
752 Params.push_back(getValue(getTypeSlot(FTy->getParamType(i)),Oprnds[i]));
754 FirstVariableOperand = FTy->getNumParams();
756 if ((Oprnds.size()-FirstVariableOperand) & 1)
757 error("Invalid call instruction!"); // Must be pairs of type/value
759 for (unsigned i = FirstVariableOperand, e = Oprnds.size();
761 Params.push_back(getValue(Oprnds[i], Oprnds[i+1]));
764 Result = new CallInst(F, Params);
767 case Instruction::Invoke: {
768 if (Oprnds.size() < 3)
769 error("Invalid invoke instruction!");
770 Value *F = getValue(iType, Oprnds[0]);
772 // Check to make sure we have a pointer to function type
773 const PointerType *PTy = dyn_cast<PointerType>(F->getType());
775 error("Invoke to non function pointer value!");
776 const FunctionType *FTy = dyn_cast<FunctionType>(PTy->getElementType());
778 error("Invoke to non function pointer value!");
780 std::vector<Value *> Params;
781 BasicBlock *Normal, *Except;
783 if (!FTy->isVarArg()) {
784 Normal = getBasicBlock(Oprnds[1]);
785 Except = getBasicBlock(Oprnds[2]);
787 FunctionType::param_iterator It = FTy->param_begin();
788 for (unsigned i = 3, e = Oprnds.size(); i != e; ++i) {
789 if (It == FTy->param_end())
790 error("Invalid invoke instruction!");
791 Params.push_back(getValue(getTypeSlot(*It++), Oprnds[i]));
793 if (It != FTy->param_end())
794 error("Invalid invoke instruction!");
796 Oprnds.erase(Oprnds.begin(), Oprnds.begin()+1);
798 Normal = getBasicBlock(Oprnds[0]);
799 Except = getBasicBlock(Oprnds[1]);
801 unsigned FirstVariableArgument = FTy->getNumParams()+2;
802 for (unsigned i = 2; i != FirstVariableArgument; ++i)
803 Params.push_back(getValue(getTypeSlot(FTy->getParamType(i-2)),
806 if (Oprnds.size()-FirstVariableArgument & 1) // Must be type/value pairs
807 error("Invalid invoke instruction!");
809 for (unsigned i = FirstVariableArgument; i < Oprnds.size(); i += 2)
810 Params.push_back(getValue(Oprnds[i], Oprnds[i+1]));
813 Result = new InvokeInst(F, Normal, Except, Params);
816 case Instruction::Malloc:
817 if (Oprnds.size() > 2)
818 error("Invalid malloc instruction!");
819 if (!isa<PointerType>(InstTy))
820 error("Invalid malloc instruction!");
822 Result = new MallocInst(cast<PointerType>(InstTy)->getElementType(),
823 Oprnds.size() ? getValue(Type::UIntTyID,
827 case Instruction::Alloca:
828 if (Oprnds.size() > 2)
829 error("Invalid alloca instruction!");
830 if (!isa<PointerType>(InstTy))
831 error("Invalid alloca instruction!");
833 Result = new AllocaInst(cast<PointerType>(InstTy)->getElementType(),
834 Oprnds.size() ? getValue(Type::UIntTyID,
837 case Instruction::Free:
838 if (!isa<PointerType>(InstTy))
839 error("Invalid free instruction!");
840 Result = new FreeInst(getValue(iType, Oprnds[0]));
842 case Instruction::GetElementPtr: {
843 if (Oprnds.size() == 0 || !isa<PointerType>(InstTy))
844 error("Invalid getelementptr instruction!");
846 std::vector<Value*> Idx;
848 const Type *NextTy = InstTy;
849 for (unsigned i = 1, e = Oprnds.size(); i != e; ++i) {
850 const CompositeType *TopTy = dyn_cast_or_null<CompositeType>(NextTy);
852 error("Invalid getelementptr instruction!");
854 unsigned ValIdx = Oprnds[i];
856 if (!hasRestrictedGEPTypes) {
857 // Struct indices are always uints, sequential type indices can be any
858 // of the 32 or 64-bit integer types. The actual choice of type is
859 // encoded in the low two bits of the slot number.
860 if (isa<StructType>(TopTy))
861 IdxTy = Type::UIntTyID;
863 switch (ValIdx & 3) {
865 case 0: IdxTy = Type::UIntTyID; break;
866 case 1: IdxTy = Type::IntTyID; break;
867 case 2: IdxTy = Type::ULongTyID; break;
868 case 3: IdxTy = Type::LongTyID; break;
873 IdxTy = isa<StructType>(TopTy) ? Type::UByteTyID : Type::LongTyID;
876 Idx.push_back(getValue(IdxTy, ValIdx));
878 // Convert ubyte struct indices into uint struct indices.
879 if (isa<StructType>(TopTy) && hasRestrictedGEPTypes)
880 if (ConstantUInt *C = dyn_cast<ConstantUInt>(Idx.back()))
881 Idx[Idx.size()-1] = ConstantExpr::getCast(C, Type::UIntTy);
883 NextTy = GetElementPtrInst::getIndexedType(InstTy, Idx, true);
886 Result = new GetElementPtrInst(getValue(iType, Oprnds[0]), Idx);
890 case 62: // volatile load
891 case Instruction::Load:
892 if (Oprnds.size() != 1 || !isa<PointerType>(InstTy))
893 error("Invalid load instruction!");
894 Result = new LoadInst(getValue(iType, Oprnds[0]), "", Opcode == 62);
897 case 63: // volatile store
898 case Instruction::Store: {
899 if (!isa<PointerType>(InstTy) || Oprnds.size() != 2)
900 error("Invalid store instruction!");
902 Value *Ptr = getValue(iType, Oprnds[1]);
903 const Type *ValTy = cast<PointerType>(Ptr->getType())->getElementType();
904 Result = new StoreInst(getValue(getTypeSlot(ValTy), Oprnds[0]), Ptr,
908 case Instruction::Unwind:
909 if (Oprnds.size() != 0) error("Invalid unwind instruction!");
910 Result = new UnwindInst();
912 case Instruction::Unreachable:
913 if (Oprnds.size() != 0) error("Invalid unreachable instruction!");
914 Result = new UnreachableInst();
916 } // end switch(Opcode)
919 if (Result->getType() == InstTy)
922 TypeSlot = getTypeSlot(Result->getType());
924 insertValue(Result, TypeSlot, FunctionValues);
925 BB->getInstList().push_back(Result);
928 /// Get a particular numbered basic block, which might be a forward reference.
929 /// This works together with ParseBasicBlock to handle these forward references
930 /// in a clean manner. This function is used when constructing phi, br, switch,
931 /// and other instructions that reference basic blocks. Blocks are numbered
932 /// sequentially as they appear in the function.
933 BasicBlock *BytecodeReader::getBasicBlock(unsigned ID) {
934 // Make sure there is room in the table...
935 if (ParsedBasicBlocks.size() <= ID) ParsedBasicBlocks.resize(ID+1);
937 // First check to see if this is a backwards reference, i.e., ParseBasicBlock
938 // has already created this block, or if the forward reference has already
940 if (ParsedBasicBlocks[ID])
941 return ParsedBasicBlocks[ID];
943 // Otherwise, the basic block has not yet been created. Do so and add it to
944 // the ParsedBasicBlocks list.
945 return ParsedBasicBlocks[ID] = new BasicBlock();
948 /// In LLVM 1.0 bytecode files, we used to output one basicblock at a time.
949 /// This method reads in one of the basicblock packets. This method is not used
950 /// for bytecode files after LLVM 1.0
951 /// @returns The basic block constructed.
952 BasicBlock *BytecodeReader::ParseBasicBlock(unsigned BlockNo) {
953 if (Handler) Handler->handleBasicBlockBegin(BlockNo);
957 if (ParsedBasicBlocks.size() == BlockNo)
958 ParsedBasicBlocks.push_back(BB = new BasicBlock());
959 else if (ParsedBasicBlocks[BlockNo] == 0)
960 BB = ParsedBasicBlocks[BlockNo] = new BasicBlock();
962 BB = ParsedBasicBlocks[BlockNo];
964 std::vector<unsigned> Operands;
965 while (moreInBlock())
966 ParseInstruction(Operands, BB);
968 if (Handler) Handler->handleBasicBlockEnd(BlockNo);
972 /// Parse all of the BasicBlock's & Instruction's in the body of a function.
973 /// In post 1.0 bytecode files, we no longer emit basic block individually,
974 /// in order to avoid per-basic-block overhead.
975 /// @returns Rhe number of basic blocks encountered.
976 unsigned BytecodeReader::ParseInstructionList(Function* F) {
977 unsigned BlockNo = 0;
978 std::vector<unsigned> Args;
980 while (moreInBlock()) {
981 if (Handler) Handler->handleBasicBlockBegin(BlockNo);
983 if (ParsedBasicBlocks.size() == BlockNo)
984 ParsedBasicBlocks.push_back(BB = new BasicBlock());
985 else if (ParsedBasicBlocks[BlockNo] == 0)
986 BB = ParsedBasicBlocks[BlockNo] = new BasicBlock();
988 BB = ParsedBasicBlocks[BlockNo];
990 F->getBasicBlockList().push_back(BB);
992 // Read instructions into this basic block until we get to a terminator
993 while (moreInBlock() && !BB->getTerminator())
994 ParseInstruction(Args, BB);
996 if (!BB->getTerminator())
997 error("Non-terminated basic block found!");
999 if (Handler) Handler->handleBasicBlockEnd(BlockNo-1);
1005 /// Parse a symbol table. This works for both module level and function
1006 /// level symbol tables. For function level symbol tables, the CurrentFunction
1007 /// parameter must be non-zero and the ST parameter must correspond to
1008 /// CurrentFunction's symbol table. For Module level symbol tables, the
1009 /// CurrentFunction argument must be zero.
1010 void BytecodeReader::ParseSymbolTable(Function *CurrentFunction,
1012 if (Handler) Handler->handleSymbolTableBegin(CurrentFunction,ST);
1014 // Allow efficient basic block lookup by number.
1015 std::vector<BasicBlock*> BBMap;
1016 if (CurrentFunction)
1017 for (Function::iterator I = CurrentFunction->begin(),
1018 E = CurrentFunction->end(); I != E; ++I)
1021 /// In LLVM 1.3 we write types separately from values so
1022 /// The types are always first in the symbol table. This is
1023 /// because Type no longer derives from Value.
1024 if (!hasTypeDerivedFromValue) {
1025 // Symtab block header: [num entries]
1026 unsigned NumEntries = read_vbr_uint();
1027 for (unsigned i = 0; i < NumEntries; ++i) {
1028 // Symtab entry: [def slot #][name]
1029 unsigned slot = read_vbr_uint();
1030 std::string Name = read_str();
1031 const Type* T = getType(slot);
1032 ST->insert(Name, T);
1036 while (moreInBlock()) {
1037 // Symtab block header: [num entries][type id number]
1038 unsigned NumEntries = read_vbr_uint();
1040 bool isTypeType = read_typeid(Typ);
1041 const Type *Ty = getType(Typ);
1043 for (unsigned i = 0; i != NumEntries; ++i) {
1044 // Symtab entry: [def slot #][name]
1045 unsigned slot = read_vbr_uint();
1046 std::string Name = read_str();
1048 // if we're reading a pre 1.3 bytecode file and the type plane
1049 // is the "type type", handle it here
1051 const Type* T = getType(slot);
1053 error("Failed type look-up for name '" + Name + "'");
1054 ST->insert(Name, T);
1055 continue; // code below must be short circuited
1058 if (Typ == Type::LabelTyID) {
1059 if (slot < BBMap.size())
1062 V = getValue(Typ, slot, false); // Find mapping...
1065 error("Failed value look-up for name '" + Name + "'");
1066 V->setName(Name, ST);
1070 checkPastBlockEnd("Symbol Table");
1071 if (Handler) Handler->handleSymbolTableEnd();
1074 /// Read in the types portion of a compaction table.
1075 void BytecodeReader::ParseCompactionTypes(unsigned NumEntries) {
1076 for (unsigned i = 0; i != NumEntries; ++i) {
1077 unsigned TypeSlot = 0;
1078 if (read_typeid(TypeSlot))
1079 error("Invalid type in compaction table: type type");
1080 const Type *Typ = getGlobalTableType(TypeSlot);
1081 CompactionTypes.push_back(std::make_pair(Typ, TypeSlot));
1082 if (Handler) Handler->handleCompactionTableType(i, TypeSlot, Typ);
1086 /// Parse a compaction table.
1087 void BytecodeReader::ParseCompactionTable() {
1089 // Notify handler that we're beginning a compaction table.
1090 if (Handler) Handler->handleCompactionTableBegin();
1092 // In LLVM 1.3 Type no longer derives from Value. So,
1093 // we always write them first in the compaction table
1094 // because they can't occupy a "type plane" where the
1096 if (! hasTypeDerivedFromValue) {
1097 unsigned NumEntries = read_vbr_uint();
1098 ParseCompactionTypes(NumEntries);
1101 // Compaction tables live in separate blocks so we have to loop
1102 // until we've read the whole thing.
1103 while (moreInBlock()) {
1104 // Read the number of Value* entries in the compaction table
1105 unsigned NumEntries = read_vbr_uint();
1107 unsigned isTypeType = false;
1109 // Decode the type from value read in. Most compaction table
1110 // planes will have one or two entries in them. If that's the
1111 // case then the length is encoded in the bottom two bits and
1112 // the higher bits encode the type. This saves another VBR value.
1113 if ((NumEntries & 3) == 3) {
1114 // In this case, both low-order bits are set (value 3). This
1115 // is a signal that the typeid follows.
1117 isTypeType = read_typeid(Ty);
1119 // In this case, the low-order bits specify the number of entries
1120 // and the high order bits specify the type.
1121 Ty = NumEntries >> 2;
1122 isTypeType = sanitizeTypeId(Ty);
1126 // if we're reading a pre 1.3 bytecode file and the type plane
1127 // is the "type type", handle it here
1129 ParseCompactionTypes(NumEntries);
1131 // Make sure we have enough room for the plane.
1132 if (Ty >= CompactionValues.size())
1133 CompactionValues.resize(Ty+1);
1135 // Make sure the plane is empty or we have some kind of error.
1136 if (!CompactionValues[Ty].empty())
1137 error("Compaction table plane contains multiple entries!");
1139 // Notify handler about the plane.
1140 if (Handler) Handler->handleCompactionTablePlane(Ty, NumEntries);
1142 // Push the implicit zero.
1143 CompactionValues[Ty].push_back(Constant::getNullValue(getType(Ty)));
1145 // Read in each of the entries, put them in the compaction table
1146 // and notify the handler that we have a new compaction table value.
1147 for (unsigned i = 0; i != NumEntries; ++i) {
1148 unsigned ValSlot = read_vbr_uint();
1149 Value *V = getGlobalTableValue(Ty, ValSlot);
1150 CompactionValues[Ty].push_back(V);
1151 if (Handler) Handler->handleCompactionTableValue(i, Ty, ValSlot);
1155 // Notify handler that the compaction table is done.
1156 if (Handler) Handler->handleCompactionTableEnd();
1159 // Parse a single type. The typeid is read in first. If its a primitive type
1160 // then nothing else needs to be read, we know how to instantiate it. If its
1161 // a derived type, then additional data is read to fill out the type
1163 const Type *BytecodeReader::ParseType() {
1164 unsigned PrimType = 0;
1165 if (read_typeid(PrimType))
1166 error("Invalid type (type type) in type constants!");
1168 const Type *Result = 0;
1169 if ((Result = Type::getPrimitiveType((Type::TypeID)PrimType)))
1173 case Type::FunctionTyID: {
1174 const Type *RetType = readSanitizedType();
1176 unsigned NumParams = read_vbr_uint();
1178 std::vector<const Type*> Params;
1180 Params.push_back(readSanitizedType());
1182 bool isVarArg = Params.size() && Params.back() == Type::VoidTy;
1183 if (isVarArg) Params.pop_back();
1185 Result = FunctionType::get(RetType, Params, isVarArg);
1188 case Type::ArrayTyID: {
1189 const Type *ElementType = readSanitizedType();
1190 unsigned NumElements = read_vbr_uint();
1191 Result = ArrayType::get(ElementType, NumElements);
1194 case Type::PackedTyID: {
1195 const Type *ElementType = readSanitizedType();
1196 unsigned NumElements = read_vbr_uint();
1197 Result = PackedType::get(ElementType, NumElements);
1200 case Type::StructTyID: {
1201 std::vector<const Type*> Elements;
1203 if (read_typeid(Typ))
1204 error("Invalid element type (type type) for structure!");
1206 while (Typ) { // List is terminated by void/0 typeid
1207 Elements.push_back(getType(Typ));
1208 if (read_typeid(Typ))
1209 error("Invalid element type (type type) for structure!");
1212 Result = StructType::get(Elements);
1215 case Type::PointerTyID: {
1216 Result = PointerType::get(readSanitizedType());
1220 case Type::OpaqueTyID: {
1221 Result = OpaqueType::get();
1226 error("Don't know how to deserialize primitive type " + utostr(PrimType));
1229 if (Handler) Handler->handleType(Result);
1233 // ParseTypes - We have to use this weird code to handle recursive
1234 // types. We know that recursive types will only reference the current slab of
1235 // values in the type plane, but they can forward reference types before they
1236 // have been read. For example, Type #0 might be '{ Ty#1 }' and Type #1 might
1237 // be 'Ty#0*'. When reading Type #0, type number one doesn't exist. To fix
1238 // this ugly problem, we pessimistically insert an opaque type for each type we
1239 // are about to read. This means that forward references will resolve to
1240 // something and when we reread the type later, we can replace the opaque type
1241 // with a new resolved concrete type.
1243 void BytecodeReader::ParseTypes(TypeListTy &Tab, unsigned NumEntries){
1244 assert(Tab.size() == 0 && "should not have read type constants in before!");
1246 // Insert a bunch of opaque types to be resolved later...
1247 Tab.reserve(NumEntries);
1248 for (unsigned i = 0; i != NumEntries; ++i)
1249 Tab.push_back(OpaqueType::get());
1252 Handler->handleTypeList(NumEntries);
1254 // Loop through reading all of the types. Forward types will make use of the
1255 // opaque types just inserted.
1257 for (unsigned i = 0; i != NumEntries; ++i) {
1258 const Type* NewTy = ParseType();
1259 const Type* OldTy = Tab[i].get();
1261 error("Couldn't parse type!");
1263 // Don't directly push the new type on the Tab. Instead we want to replace
1264 // the opaque type we previously inserted with the new concrete value. This
1265 // approach helps with forward references to types. The refinement from the
1266 // abstract (opaque) type to the new type causes all uses of the abstract
1267 // type to use the concrete type (NewTy). This will also cause the opaque
1268 // type to be deleted.
1269 cast<DerivedType>(const_cast<Type*>(OldTy))->refineAbstractTypeTo(NewTy);
1271 // This should have replaced the old opaque type with the new type in the
1272 // value table... or with a preexisting type that was already in the system.
1273 // Let's just make sure it did.
1274 assert(Tab[i] != OldTy && "refineAbstractType didn't work!");
1278 /// Parse a single constant value
1279 Constant *BytecodeReader::ParseConstantValue(unsigned TypeID) {
1280 // We must check for a ConstantExpr before switching by type because
1281 // a ConstantExpr can be of any type, and has no explicit value.
1283 // 0 if not expr; numArgs if is expr
1284 unsigned isExprNumArgs = read_vbr_uint();
1286 if (isExprNumArgs) {
1287 // 'undef' is encoded with 'exprnumargs' == 1.
1288 if (!hasNoUndefValue)
1289 if (--isExprNumArgs == 0)
1290 return UndefValue::get(getType(TypeID));
1292 // FIXME: Encoding of constant exprs could be much more compact!
1293 std::vector<Constant*> ArgVec;
1294 ArgVec.reserve(isExprNumArgs);
1295 unsigned Opcode = read_vbr_uint();
1297 // Bytecode files before LLVM 1.4 need have a missing terminator inst.
1298 if (hasNoUnreachableInst) Opcode++;
1300 // Read the slot number and types of each of the arguments
1301 for (unsigned i = 0; i != isExprNumArgs; ++i) {
1302 unsigned ArgValSlot = read_vbr_uint();
1303 unsigned ArgTypeSlot = 0;
1304 if (read_typeid(ArgTypeSlot))
1305 error("Invalid argument type (type type) for constant value");
1307 // Get the arg value from its slot if it exists, otherwise a placeholder
1308 ArgVec.push_back(getConstantValue(ArgTypeSlot, ArgValSlot));
1311 // Construct a ConstantExpr of the appropriate kind
1312 if (isExprNumArgs == 1) { // All one-operand expressions
1313 if (Opcode != Instruction::Cast)
1314 error("Only cast instruction has one argument for ConstantExpr");
1316 Constant* Result = ConstantExpr::getCast(ArgVec[0], getType(TypeID));
1317 if (Handler) Handler->handleConstantExpression(Opcode, ArgVec, Result);
1319 } else if (Opcode == Instruction::GetElementPtr) { // GetElementPtr
1320 std::vector<Constant*> IdxList(ArgVec.begin()+1, ArgVec.end());
1322 if (hasRestrictedGEPTypes) {
1323 const Type *BaseTy = ArgVec[0]->getType();
1324 generic_gep_type_iterator<std::vector<Constant*>::iterator>
1325 GTI = gep_type_begin(BaseTy, IdxList.begin(), IdxList.end()),
1326 E = gep_type_end(BaseTy, IdxList.begin(), IdxList.end());
1327 for (unsigned i = 0; GTI != E; ++GTI, ++i)
1328 if (isa<StructType>(*GTI)) {
1329 if (IdxList[i]->getType() != Type::UByteTy)
1330 error("Invalid index for getelementptr!");
1331 IdxList[i] = ConstantExpr::getCast(IdxList[i], Type::UIntTy);
1335 Constant* Result = ConstantExpr::getGetElementPtr(ArgVec[0], IdxList);
1336 if (Handler) Handler->handleConstantExpression(Opcode, ArgVec, Result);
1338 } else if (Opcode == Instruction::Select) {
1339 if (ArgVec.size() != 3)
1340 error("Select instruction must have three arguments.");
1341 Constant* Result = ConstantExpr::getSelect(ArgVec[0], ArgVec[1],
1343 if (Handler) Handler->handleConstantExpression(Opcode, ArgVec, Result);
1345 } else { // All other 2-operand expressions
1346 Constant* Result = ConstantExpr::get(Opcode, ArgVec[0], ArgVec[1]);
1347 if (Handler) Handler->handleConstantExpression(Opcode, ArgVec, Result);
1352 // Ok, not an ConstantExpr. We now know how to read the given type...
1353 const Type *Ty = getType(TypeID);
1354 switch (Ty->getTypeID()) {
1355 case Type::BoolTyID: {
1356 unsigned Val = read_vbr_uint();
1357 if (Val != 0 && Val != 1)
1358 error("Invalid boolean value read.");
1359 Constant* Result = ConstantBool::get(Val == 1);
1360 if (Handler) Handler->handleConstantValue(Result);
1364 case Type::UByteTyID: // Unsigned integer types...
1365 case Type::UShortTyID:
1366 case Type::UIntTyID: {
1367 unsigned Val = read_vbr_uint();
1368 if (!ConstantUInt::isValueValidForType(Ty, Val))
1369 error("Invalid unsigned byte/short/int read.");
1370 Constant* Result = ConstantUInt::get(Ty, Val);
1371 if (Handler) Handler->handleConstantValue(Result);
1375 case Type::ULongTyID: {
1376 Constant* Result = ConstantUInt::get(Ty, read_vbr_uint64());
1377 if (Handler) Handler->handleConstantValue(Result);
1381 case Type::SByteTyID: // Signed integer types...
1382 case Type::ShortTyID:
1383 case Type::IntTyID: {
1384 case Type::LongTyID:
1385 int64_t Val = read_vbr_int64();
1386 if (!ConstantSInt::isValueValidForType(Ty, Val))
1387 error("Invalid signed byte/short/int/long read.");
1388 Constant* Result = ConstantSInt::get(Ty, Val);
1389 if (Handler) Handler->handleConstantValue(Result);
1393 case Type::FloatTyID: {
1396 Constant* Result = ConstantFP::get(Ty, Val);
1397 if (Handler) Handler->handleConstantValue(Result);
1401 case Type::DoubleTyID: {
1404 Constant* Result = ConstantFP::get(Ty, Val);
1405 if (Handler) Handler->handleConstantValue(Result);
1409 case Type::ArrayTyID: {
1410 const ArrayType *AT = cast<ArrayType>(Ty);
1411 unsigned NumElements = AT->getNumElements();
1412 unsigned TypeSlot = getTypeSlot(AT->getElementType());
1413 std::vector<Constant*> Elements;
1414 Elements.reserve(NumElements);
1415 while (NumElements--) // Read all of the elements of the constant.
1416 Elements.push_back(getConstantValue(TypeSlot,
1418 Constant* Result = ConstantArray::get(AT, Elements);
1419 if (Handler) Handler->handleConstantArray(AT, Elements, TypeSlot, Result);
1423 case Type::StructTyID: {
1424 const StructType *ST = cast<StructType>(Ty);
1426 std::vector<Constant *> Elements;
1427 Elements.reserve(ST->getNumElements());
1428 for (unsigned i = 0; i != ST->getNumElements(); ++i)
1429 Elements.push_back(getConstantValue(ST->getElementType(i),
1432 Constant* Result = ConstantStruct::get(ST, Elements);
1433 if (Handler) Handler->handleConstantStruct(ST, Elements, Result);
1437 case Type::PackedTyID: {
1438 const PackedType *PT = cast<PackedType>(Ty);
1439 unsigned NumElements = PT->getNumElements();
1440 unsigned TypeSlot = getTypeSlot(PT->getElementType());
1441 std::vector<Constant*> Elements;
1442 Elements.reserve(NumElements);
1443 while (NumElements--) // Read all of the elements of the constant.
1444 Elements.push_back(getConstantValue(TypeSlot,
1446 Constant* Result = ConstantPacked::get(PT, Elements);
1447 if (Handler) Handler->handleConstantPacked(PT, Elements, TypeSlot, Result);
1451 case Type::PointerTyID: { // ConstantPointerRef value (backwards compat).
1452 const PointerType *PT = cast<PointerType>(Ty);
1453 unsigned Slot = read_vbr_uint();
1455 // Check to see if we have already read this global variable...
1456 Value *Val = getValue(TypeID, Slot, false);
1458 GlobalValue *GV = dyn_cast<GlobalValue>(Val);
1459 if (!GV) error("GlobalValue not in ValueTable!");
1460 if (Handler) Handler->handleConstantPointer(PT, Slot, GV);
1463 error("Forward references are not allowed here.");
1468 error("Don't know how to deserialize constant value of type '" +
1469 Ty->getDescription());
1475 /// Resolve references for constants. This function resolves the forward
1476 /// referenced constants in the ConstantFwdRefs map. It uses the
1477 /// replaceAllUsesWith method of Value class to substitute the placeholder
1478 /// instance with the actual instance.
1479 void BytecodeReader::ResolveReferencesToConstant(Constant *NewV, unsigned Typ,
1481 ConstantRefsType::iterator I =
1482 ConstantFwdRefs.find(std::make_pair(Typ, Slot));
1483 if (I == ConstantFwdRefs.end()) return; // Never forward referenced?
1485 Value *PH = I->second; // Get the placeholder...
1486 PH->replaceAllUsesWith(NewV);
1487 delete PH; // Delete the old placeholder
1488 ConstantFwdRefs.erase(I); // Remove the map entry for it
1491 /// Parse the constant strings section.
1492 void BytecodeReader::ParseStringConstants(unsigned NumEntries, ValueTable &Tab){
1493 for (; NumEntries; --NumEntries) {
1495 if (read_typeid(Typ))
1496 error("Invalid type (type type) for string constant");
1497 const Type *Ty = getType(Typ);
1498 if (!isa<ArrayType>(Ty))
1499 error("String constant data invalid!");
1501 const ArrayType *ATy = cast<ArrayType>(Ty);
1502 if (ATy->getElementType() != Type::SByteTy &&
1503 ATy->getElementType() != Type::UByteTy)
1504 error("String constant data invalid!");
1506 // Read character data. The type tells us how long the string is.
1507 char *Data = reinterpret_cast<char *>(alloca(ATy->getNumElements()));
1508 read_data(Data, Data+ATy->getNumElements());
1510 std::vector<Constant*> Elements(ATy->getNumElements());
1511 if (ATy->getElementType() == Type::SByteTy)
1512 for (unsigned i = 0, e = ATy->getNumElements(); i != e; ++i)
1513 Elements[i] = ConstantSInt::get(Type::SByteTy, (signed char)Data[i]);
1515 for (unsigned i = 0, e = ATy->getNumElements(); i != e; ++i)
1516 Elements[i] = ConstantUInt::get(Type::UByteTy, (unsigned char)Data[i]);
1518 // Create the constant, inserting it as needed.
1519 Constant *C = ConstantArray::get(ATy, Elements);
1520 unsigned Slot = insertValue(C, Typ, Tab);
1521 ResolveReferencesToConstant(C, Typ, Slot);
1522 if (Handler) Handler->handleConstantString(cast<ConstantArray>(C));
1526 /// Parse the constant pool.
1527 void BytecodeReader::ParseConstantPool(ValueTable &Tab,
1528 TypeListTy &TypeTab,
1530 if (Handler) Handler->handleGlobalConstantsBegin();
1532 /// In LLVM 1.3 Type does not derive from Value so the types
1533 /// do not occupy a plane. Consequently, we read the types
1534 /// first in the constant pool.
1535 if (isFunction && !hasTypeDerivedFromValue) {
1536 unsigned NumEntries = read_vbr_uint();
1537 ParseTypes(TypeTab, NumEntries);
1540 while (moreInBlock()) {
1541 unsigned NumEntries = read_vbr_uint();
1543 bool isTypeType = read_typeid(Typ);
1545 /// In LLVM 1.2 and before, Types were written to the
1546 /// bytecode file in the "Type Type" plane (#12).
1547 /// In 1.3 plane 12 is now the label plane. Handle this here.
1549 ParseTypes(TypeTab, NumEntries);
1550 } else if (Typ == Type::VoidTyID) {
1551 /// Use of Type::VoidTyID is a misnomer. It actually means
1552 /// that the following plane is constant strings
1553 assert(&Tab == &ModuleValues && "Cannot read strings in functions!");
1554 ParseStringConstants(NumEntries, Tab);
1556 for (unsigned i = 0; i < NumEntries; ++i) {
1557 Constant *C = ParseConstantValue(Typ);
1558 assert(C && "ParseConstantValue returned NULL!");
1559 unsigned Slot = insertValue(C, Typ, Tab);
1561 // If we are reading a function constant table, make sure that we adjust
1562 // the slot number to be the real global constant number.
1564 if (&Tab != &ModuleValues && Typ < ModuleValues.size() &&
1566 Slot += ModuleValues[Typ]->size();
1567 ResolveReferencesToConstant(C, Typ, Slot);
1572 // After we have finished parsing the constant pool, we had better not have
1573 // any dangling references left.
1574 if (!ConstantFwdRefs.empty()) {
1575 ConstantRefsType::const_iterator I = ConstantFwdRefs.begin();
1576 Constant* missingConst = I->second;
1577 error(utostr(ConstantFwdRefs.size()) +
1578 " unresolved constant reference exist. First one is '" +
1579 missingConst->getName() + "' of type '" +
1580 missingConst->getType()->getDescription() + "'.");
1583 checkPastBlockEnd("Constant Pool");
1584 if (Handler) Handler->handleGlobalConstantsEnd();
1587 /// Parse the contents of a function. Note that this function can be
1588 /// called lazily by materializeFunction
1589 /// @see materializeFunction
1590 void BytecodeReader::ParseFunctionBody(Function* F) {
1592 unsigned FuncSize = BlockEnd - At;
1593 GlobalValue::LinkageTypes Linkage = GlobalValue::ExternalLinkage;
1595 unsigned LinkageType = read_vbr_uint();
1596 switch (LinkageType) {
1597 case 0: Linkage = GlobalValue::ExternalLinkage; break;
1598 case 1: Linkage = GlobalValue::WeakLinkage; break;
1599 case 2: Linkage = GlobalValue::AppendingLinkage; break;
1600 case 3: Linkage = GlobalValue::InternalLinkage; break;
1601 case 4: Linkage = GlobalValue::LinkOnceLinkage; break;
1603 error("Invalid linkage type for Function.");
1604 Linkage = GlobalValue::InternalLinkage;
1608 F->setLinkage(Linkage);
1609 if (Handler) Handler->handleFunctionBegin(F,FuncSize);
1611 // Keep track of how many basic blocks we have read in...
1612 unsigned BlockNum = 0;
1613 bool InsertedArguments = false;
1615 BufPtr MyEnd = BlockEnd;
1616 while (At < MyEnd) {
1617 unsigned Type, Size;
1619 read_block(Type, Size);
1622 case BytecodeFormat::ConstantPoolBlockID:
1623 if (!InsertedArguments) {
1624 // Insert arguments into the value table before we parse the first basic
1625 // block in the function, but after we potentially read in the
1626 // compaction table.
1628 InsertedArguments = true;
1631 ParseConstantPool(FunctionValues, FunctionTypes, true);
1634 case BytecodeFormat::CompactionTableBlockID:
1635 ParseCompactionTable();
1638 case BytecodeFormat::BasicBlock: {
1639 if (!InsertedArguments) {
1640 // Insert arguments into the value table before we parse the first basic
1641 // block in the function, but after we potentially read in the
1642 // compaction table.
1644 InsertedArguments = true;
1647 BasicBlock *BB = ParseBasicBlock(BlockNum++);
1648 F->getBasicBlockList().push_back(BB);
1652 case BytecodeFormat::InstructionListBlockID: {
1653 // Insert arguments into the value table before we parse the instruction
1654 // list for the function, but after we potentially read in the compaction
1656 if (!InsertedArguments) {
1658 InsertedArguments = true;
1662 error("Already parsed basic blocks!");
1663 BlockNum = ParseInstructionList(F);
1667 case BytecodeFormat::SymbolTableBlockID:
1668 ParseSymbolTable(F, &F->getSymbolTable());
1674 error("Wrapped around reading bytecode.");
1679 // Malformed bc file if read past end of block.
1683 // Make sure there were no references to non-existant basic blocks.
1684 if (BlockNum != ParsedBasicBlocks.size())
1685 error("Illegal basic block operand reference");
1687 ParsedBasicBlocks.clear();
1689 // Resolve forward references. Replace any uses of a forward reference value
1690 // with the real value.
1691 while (!ForwardReferences.empty()) {
1692 std::map<std::pair<unsigned,unsigned>, Value*>::iterator
1693 I = ForwardReferences.begin();
1694 Value *V = getValue(I->first.first, I->first.second, false);
1695 Value *PlaceHolder = I->second;
1696 PlaceHolder->replaceAllUsesWith(V);
1697 ForwardReferences.erase(I);
1701 // Clear out function-level types...
1702 FunctionTypes.clear();
1703 CompactionTypes.clear();
1704 CompactionValues.clear();
1705 freeTable(FunctionValues);
1707 if (Handler) Handler->handleFunctionEnd(F);
1710 /// This function parses LLVM functions lazily. It obtains the type of the
1711 /// function and records where the body of the function is in the bytecode
1712 /// buffer. The caller can then use the ParseNextFunction and
1713 /// ParseAllFunctionBodies to get handler events for the functions.
1714 void BytecodeReader::ParseFunctionLazily() {
1715 if (FunctionSignatureList.empty())
1716 error("FunctionSignatureList empty!");
1718 Function *Func = FunctionSignatureList.back();
1719 FunctionSignatureList.pop_back();
1721 // Save the information for future reading of the function
1722 LazyFunctionLoadMap[Func] = LazyFunctionInfo(BlockStart, BlockEnd);
1724 // This function has a body but it's not loaded so it appears `External'.
1725 // Mark it as a `Ghost' instead to notify the users that it has a body.
1726 Func->setLinkage(GlobalValue::GhostLinkage);
1728 // Pretend we've `parsed' this function
1732 /// The ParserFunction method lazily parses one function. Use this method to
1733 /// casue the parser to parse a specific function in the module. Note that
1734 /// this will remove the function from what is to be included by
1735 /// ParseAllFunctionBodies.
1736 /// @see ParseAllFunctionBodies
1737 /// @see ParseBytecode
1738 void BytecodeReader::ParseFunction(Function* Func) {
1739 // Find {start, end} pointers and slot in the map. If not there, we're done.
1740 LazyFunctionMap::iterator Fi = LazyFunctionLoadMap.find(Func);
1742 // Make sure we found it
1743 if (Fi == LazyFunctionLoadMap.end()) {
1744 error("Unrecognized function of type " + Func->getType()->getDescription());
1748 BlockStart = At = Fi->second.Buf;
1749 BlockEnd = Fi->second.EndBuf;
1750 assert(Fi->first == Func && "Found wrong function?");
1752 LazyFunctionLoadMap.erase(Fi);
1754 this->ParseFunctionBody(Func);
1757 /// The ParseAllFunctionBodies method parses through all the previously
1758 /// unparsed functions in the bytecode file. If you want to completely parse
1759 /// a bytecode file, this method should be called after Parsebytecode because
1760 /// Parsebytecode only records the locations in the bytecode file of where
1761 /// the function definitions are located. This function uses that information
1762 /// to materialize the functions.
1763 /// @see ParseBytecode
1764 void BytecodeReader::ParseAllFunctionBodies() {
1765 LazyFunctionMap::iterator Fi = LazyFunctionLoadMap.begin();
1766 LazyFunctionMap::iterator Fe = LazyFunctionLoadMap.end();
1769 Function* Func = Fi->first;
1770 BlockStart = At = Fi->second.Buf;
1771 BlockEnd = Fi->second.EndBuf;
1772 ParseFunctionBody(Func);
1775 LazyFunctionLoadMap.clear();
1778 /// Parse the global type list
1779 void BytecodeReader::ParseGlobalTypes() {
1780 // Read the number of types
1781 unsigned NumEntries = read_vbr_uint();
1783 // Ignore the type plane identifier for types if the bc file is pre 1.3
1784 if (hasTypeDerivedFromValue)
1787 ParseTypes(ModuleTypes, NumEntries);
1790 /// Parse the Global info (types, global vars, constants)
1791 void BytecodeReader::ParseModuleGlobalInfo() {
1793 if (Handler) Handler->handleModuleGlobalsBegin();
1795 // Read global variables...
1796 unsigned VarType = read_vbr_uint();
1797 while (VarType != Type::VoidTyID) { // List is terminated by Void
1798 // VarType Fields: bit0 = isConstant, bit1 = hasInitializer, bit2,3,4 =
1799 // Linkage, bit4+ = slot#
1800 unsigned SlotNo = VarType >> 5;
1801 if (sanitizeTypeId(SlotNo))
1802 error("Invalid type (type type) for global var!");
1803 unsigned LinkageID = (VarType >> 2) & 7;
1804 bool isConstant = VarType & 1;
1805 bool hasInitializer = VarType & 2;
1806 GlobalValue::LinkageTypes Linkage;
1808 switch (LinkageID) {
1809 case 0: Linkage = GlobalValue::ExternalLinkage; break;
1810 case 1: Linkage = GlobalValue::WeakLinkage; break;
1811 case 2: Linkage = GlobalValue::AppendingLinkage; break;
1812 case 3: Linkage = GlobalValue::InternalLinkage; break;
1813 case 4: Linkage = GlobalValue::LinkOnceLinkage; break;
1815 error("Unknown linkage type: " + utostr(LinkageID));
1816 Linkage = GlobalValue::InternalLinkage;
1820 const Type *Ty = getType(SlotNo);
1822 error("Global has no type! SlotNo=" + utostr(SlotNo));
1825 if (!isa<PointerType>(Ty)) {
1826 error("Global not a pointer type! Ty= " + Ty->getDescription());
1829 const Type *ElTy = cast<PointerType>(Ty)->getElementType();
1831 // Create the global variable...
1832 GlobalVariable *GV = new GlobalVariable(ElTy, isConstant, Linkage,
1834 insertValue(GV, SlotNo, ModuleValues);
1836 unsigned initSlot = 0;
1837 if (hasInitializer) {
1838 initSlot = read_vbr_uint();
1839 GlobalInits.push_back(std::make_pair(GV, initSlot));
1842 // Notify handler about the global value.
1844 Handler->handleGlobalVariable(ElTy, isConstant, Linkage, SlotNo,initSlot);
1847 VarType = read_vbr_uint();
1850 // Read the function objects for all of the functions that are coming
1851 unsigned FnSignature = read_vbr_uint();
1853 if (hasNoFlagsForFunctions)
1854 FnSignature = (FnSignature << 5) + 1;
1856 // List is terminated by VoidTy.
1857 while ((FnSignature >> 5) != Type::VoidTyID) {
1858 const Type *Ty = getType(FnSignature >> 5);
1859 if (!isa<PointerType>(Ty) ||
1860 !isa<FunctionType>(cast<PointerType>(Ty)->getElementType())) {
1861 error("Function not a pointer to function type! Ty = " +
1862 Ty->getDescription());
1865 // We create functions by passing the underlying FunctionType to create...
1866 const FunctionType* FTy =
1867 cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1870 // Insert the place holder.
1871 Function* Func = new Function(FTy, GlobalValue::ExternalLinkage,
1873 insertValue(Func, FnSignature >> 5, ModuleValues);
1875 // Flags are not used yet.
1876 unsigned Flags = FnSignature & 31;
1878 // Save this for later so we know type of lazily instantiated functions.
1879 // Note that known-external functions do not have FunctionInfo blocks, so we
1880 // do not add them to the FunctionSignatureList.
1881 if ((Flags & (1 << 4)) == 0)
1882 FunctionSignatureList.push_back(Func);
1884 if (Handler) Handler->handleFunctionDeclaration(Func);
1886 // Get the next function signature.
1887 FnSignature = read_vbr_uint();
1888 if (hasNoFlagsForFunctions)
1889 FnSignature = (FnSignature << 5) + 1;
1892 // Now that the function signature list is set up, reverse it so that we can
1893 // remove elements efficiently from the back of the vector.
1894 std::reverse(FunctionSignatureList.begin(), FunctionSignatureList.end());
1896 // If this bytecode format has dependent library information in it ..
1897 if (!hasNoDependentLibraries) {
1898 // Read in the number of dependent library items that follow
1899 unsigned num_dep_libs = read_vbr_uint();
1900 std::string dep_lib;
1901 while( num_dep_libs-- ) {
1902 dep_lib = read_str();
1903 TheModule->addLibrary(dep_lib);
1905 Handler->handleDependentLibrary(dep_lib);
1909 // Read target triple and place into the module
1910 std::string triple = read_str();
1911 TheModule->setTargetTriple(triple);
1913 Handler->handleTargetTriple(triple);
1916 if (hasInconsistentModuleGlobalInfo)
1919 // This is for future proofing... in the future extra fields may be added that
1920 // we don't understand, so we transparently ignore them.
1924 if (Handler) Handler->handleModuleGlobalsEnd();
1927 /// Parse the version information and decode it by setting flags on the
1928 /// Reader that enable backward compatibility of the reader.
1929 void BytecodeReader::ParseVersionInfo() {
1930 unsigned Version = read_vbr_uint();
1932 // Unpack version number: low four bits are for flags, top bits = version
1933 Module::Endianness Endianness;
1934 Module::PointerSize PointerSize;
1935 Endianness = (Version & 1) ? Module::BigEndian : Module::LittleEndian;
1936 PointerSize = (Version & 2) ? Module::Pointer64 : Module::Pointer32;
1938 bool hasNoEndianness = Version & 4;
1939 bool hasNoPointerSize = Version & 8;
1941 RevisionNum = Version >> 4;
1943 // Default values for the current bytecode version
1944 hasInconsistentModuleGlobalInfo = false;
1945 hasExplicitPrimitiveZeros = false;
1946 hasRestrictedGEPTypes = false;
1947 hasTypeDerivedFromValue = false;
1948 hasLongBlockHeaders = false;
1949 has32BitTypes = false;
1950 hasNoDependentLibraries = false;
1951 hasAlignment = false;
1952 hasInconsistentBBSlotNums = false;
1953 hasVBRByteTypes = false;
1954 hasUnnecessaryModuleBlockId = false;
1955 hasNoUndefValue = false;
1956 hasNoFlagsForFunctions = false;
1957 hasNoUnreachableInst = false;
1959 switch (RevisionNum) {
1960 case 0: // LLVM 1.0, 1.1 (Released)
1961 // Base LLVM 1.0 bytecode format.
1962 hasInconsistentModuleGlobalInfo = true;
1963 hasExplicitPrimitiveZeros = true;
1967 case 1: // LLVM 1.2 (Released)
1968 // LLVM 1.2 added explicit support for emitting strings efficiently.
1970 // Also, it fixed the problem where the size of the ModuleGlobalInfo block
1971 // included the size for the alignment at the end, where the rest of the
1974 // LLVM 1.2 and before required that GEP indices be ubyte constants for
1975 // structures and longs for sequential types.
1976 hasRestrictedGEPTypes = true;
1978 // LLVM 1.2 and before had the Type class derive from Value class. This
1979 // changed in release 1.3 and consequently LLVM 1.3 bytecode files are
1980 // written differently because Types can no longer be part of the
1981 // type planes for Values.
1982 hasTypeDerivedFromValue = true;
1986 case 2: // 1.2.5 (Not Released)
1988 // LLVM 1.2 and earlier had two-word block headers. This is a bit wasteful,
1989 // especially for small files where the 8 bytes per block is a large
1990 // fraction of the total block size. In LLVM 1.3, the block type and length
1991 // are compressed into a single 32-bit unsigned integer. 27 bits for length,
1992 // 5 bits for block type.
1993 hasLongBlockHeaders = true;
1995 // LLVM 1.2 and earlier wrote type slot numbers as vbr_uint32. In LLVM 1.3
1996 // this has been reduced to vbr_uint24. It shouldn't make much difference
1997 // since we haven't run into a module with > 24 million types, but for
1998 // safety the 24-bit restriction has been enforced in 1.3 to free some bits
1999 // in various places and to ensure consistency.
2000 has32BitTypes = true;
2002 // LLVM 1.2 and earlier did not provide a target triple nor a list of
2003 // libraries on which the bytecode is dependent. LLVM 1.3 provides these
2004 // features, for use in future versions of LLVM.
2005 hasNoDependentLibraries = true;
2009 case 3: // LLVM 1.3 (Released)
2010 // LLVM 1.3 and earlier caused alignment bytes to be written on some block
2011 // boundaries and at the end of some strings. In extreme cases (e.g. lots
2012 // of GEP references to a constant array), this can increase the file size
2013 // by 30% or more. In version 1.4 alignment is done away with completely.
2014 hasAlignment = true;
2018 case 4: // 1.3.1 (Not Released)
2019 // In version 4, we did not support the 'undef' constant.
2020 hasNoUndefValue = true;
2022 // In version 4 and above, we did not include space for flags for functions
2023 // in the module info block.
2024 hasNoFlagsForFunctions = true;
2026 // In version 4 and above, we did not include the 'unreachable' instruction
2027 // in the opcode numbering in the bytecode file.
2028 hasNoUnreachableInst = true;
2033 case 5: // 1.x.x (Not Released)
2035 // FIXME: NONE of this is implemented yet!
2037 // In version 5, basic blocks have a minimum index of 0 whereas all the
2038 // other primitives have a minimum index of 1 (because 0 is the "null"
2039 // value. In version 5, we made this consistent.
2040 hasInconsistentBBSlotNums = true;
2042 // In version 5, the types SByte and UByte were encoded as vbr_uint so that
2043 // signed values > 63 and unsigned values >127 would be encoded as two
2044 // bytes. In version 5, they are encoded directly in a single byte.
2045 hasVBRByteTypes = true;
2047 // In version 5, modules begin with a "Module Block" which encodes a 4-byte
2048 // integer value 0x01 to identify the module block. This is unnecessary and
2049 // removed in version 5.
2050 hasUnnecessaryModuleBlockId = true;
2053 error("Unknown bytecode version number: " + itostr(RevisionNum));
2056 if (hasNoEndianness) Endianness = Module::AnyEndianness;
2057 if (hasNoPointerSize) PointerSize = Module::AnyPointerSize;
2059 TheModule->setEndianness(Endianness);
2060 TheModule->setPointerSize(PointerSize);
2062 if (Handler) Handler->handleVersionInfo(RevisionNum, Endianness, PointerSize);
2065 /// Parse a whole module.
2066 void BytecodeReader::ParseModule() {
2067 unsigned Type, Size;
2069 FunctionSignatureList.clear(); // Just in case...
2071 // Read into instance variables...
2075 bool SeenModuleGlobalInfo = false;
2076 bool SeenGlobalTypePlane = false;
2077 BufPtr MyEnd = BlockEnd;
2078 while (At < MyEnd) {
2080 read_block(Type, Size);
2084 case BytecodeFormat::GlobalTypePlaneBlockID:
2085 if (SeenGlobalTypePlane)
2086 error("Two GlobalTypePlane Blocks Encountered!");
2090 SeenGlobalTypePlane = true;
2093 case BytecodeFormat::ModuleGlobalInfoBlockID:
2094 if (SeenModuleGlobalInfo)
2095 error("Two ModuleGlobalInfo Blocks Encountered!");
2096 ParseModuleGlobalInfo();
2097 SeenModuleGlobalInfo = true;
2100 case BytecodeFormat::ConstantPoolBlockID:
2101 ParseConstantPool(ModuleValues, ModuleTypes,false);
2104 case BytecodeFormat::FunctionBlockID:
2105 ParseFunctionLazily();
2108 case BytecodeFormat::SymbolTableBlockID:
2109 ParseSymbolTable(0, &TheModule->getSymbolTable());
2115 error("Unexpected Block of Type #" + utostr(Type) + " encountered!");
2123 // After the module constant pool has been read, we can safely initialize
2124 // global variables...
2125 while (!GlobalInits.empty()) {
2126 GlobalVariable *GV = GlobalInits.back().first;
2127 unsigned Slot = GlobalInits.back().second;
2128 GlobalInits.pop_back();
2130 // Look up the initializer value...
2131 // FIXME: Preserve this type ID!
2133 const llvm::PointerType* GVType = GV->getType();
2134 unsigned TypeSlot = getTypeSlot(GVType->getElementType());
2135 if (Constant *CV = getConstantValue(TypeSlot, Slot)) {
2136 if (GV->hasInitializer())
2137 error("Global *already* has an initializer?!");
2138 if (Handler) Handler->handleGlobalInitializer(GV,CV);
2139 GV->setInitializer(CV);
2141 error("Cannot find initializer value.");
2144 /// Make sure we pulled them all out. If we didn't then there's a declaration
2145 /// but a missing body. That's not allowed.
2146 if (!FunctionSignatureList.empty())
2147 error("Function declared, but bytecode stream ended before definition");
2150 /// This function completely parses a bytecode buffer given by the \p Buf
2151 /// and \p Length parameters.
2152 void BytecodeReader::ParseBytecode(BufPtr Buf, unsigned Length,
2153 const std::string &ModuleID) {
2157 At = MemStart = BlockStart = Buf;
2158 MemEnd = BlockEnd = Buf + Length;
2160 // Create the module
2161 TheModule = new Module(ModuleID);
2163 if (Handler) Handler->handleStart(TheModule, Length);
2165 // Read the four bytes of the signature.
2166 unsigned Sig = read_uint();
2168 // If this is a compressed file
2169 if (Sig == ('l' | ('l' << 8) | ('v' << 16) | ('c' << 24))) {
2171 // Invoke the decompression of the bytecode. Note that we have to skip the
2172 // file's magic number which is not part of the compressed block. Hence,
2173 // the Buf+4 and Length-4. The result goes into decompressedBlock, a data
2174 // member for retention until BytecodeReader is destructed.
2175 unsigned decompressedLength = Compressor::decompressToNewBuffer(
2176 (char*)Buf+4,Length-4,decompressedBlock);
2178 // We must adjust the buffer pointers used by the bytecode reader to point
2179 // into the new decompressed block. After decompression, the
2180 // decompressedBlock will point to a contiguous memory area that has
2181 // the decompressed data.
2182 At = MemStart = BlockStart = Buf = (BufPtr) decompressedBlock;
2183 MemEnd = BlockEnd = Buf + decompressedLength;
2185 // else if this isn't a regular (uncompressed) bytecode file, then its
2186 // and error, generate that now.
2187 } else if (Sig != ('l' | ('l' << 8) | ('v' << 16) | ('m' << 24))) {
2188 error("Invalid bytecode signature: " + utohexstr(Sig));
2191 // Tell the handler we're starting a module
2192 if (Handler) Handler->handleModuleBegin(ModuleID);
2194 // Get the module block and size and verify. This is handled specially
2195 // because the module block/size is always written in long format. Other
2196 // blocks are written in short format so the read_block method is used.
2197 unsigned Type, Size;
2200 if (Type != BytecodeFormat::ModuleBlockID) {
2201 error("Expected Module Block! Type:" + utostr(Type) + ", Size:"
2205 // It looks like the darwin ranlib program is broken, and adds trailing
2206 // garbage to the end of some bytecode files. This hack allows the bc
2207 // reader to ignore trailing garbage on bytecode files.
2208 if (At + Size < MemEnd)
2209 MemEnd = BlockEnd = At+Size;
2211 if (At + Size != MemEnd)
2212 error("Invalid Top Level Block Length! Type:" + utostr(Type)
2213 + ", Size:" + utostr(Size));
2215 // Parse the module contents
2216 this->ParseModule();
2218 // Check for missing functions
2220 error("Function expected, but bytecode stream ended!");
2222 // Tell the handler we're done with the module
2224 Handler->handleModuleEnd(ModuleID);
2226 // Tell the handler we're finished the parse
2227 if (Handler) Handler->handleFinish();
2229 } catch (std::string& errstr) {
2230 if (Handler) Handler->handleError(errstr);
2234 if (decompressedBlock != 0 ) {
2235 ::free(decompressedBlock);
2236 decompressedBlock = 0;
2240 std::string msg("Unknown Exception Occurred");
2241 if (Handler) Handler->handleError(msg);
2245 if (decompressedBlock != 0) {
2246 ::free(decompressedBlock);
2247 decompressedBlock = 0;
2253 //===----------------------------------------------------------------------===//
2254 //=== Default Implementations of Handler Methods
2255 //===----------------------------------------------------------------------===//
2257 BytecodeHandler::~BytecodeHandler() {}