1 //===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This header defines the BitcodeReader class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Bitcode/ReaderWriter.h"
15 #include "BitcodeReader.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/InlineAsm.h"
19 #include "llvm/IntrinsicInst.h"
20 #include "llvm/Module.h"
21 #include "llvm/Operator.h"
22 #include "llvm/AutoUpgrade.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/Support/MathExtras.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/OperandTraits.h"
30 void BitcodeReader::FreeState() {
34 std::vector<PATypeHolder>().swap(TypeList);
38 std::vector<AttrListPtr>().swap(MAttributes);
39 std::vector<BasicBlock*>().swap(FunctionBBs);
40 std::vector<Function*>().swap(FunctionsWithBodies);
41 DeferredFunctionInfo.clear();
45 //===----------------------------------------------------------------------===//
46 // Helper functions to implement forward reference resolution, etc.
47 //===----------------------------------------------------------------------===//
49 /// ConvertToString - Convert a string from a record into an std::string, return
51 template<typename StrTy>
52 static bool ConvertToString(SmallVector<uint64_t, 64> &Record, unsigned Idx,
54 if (Idx > Record.size())
57 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
58 Result += (char)Record[i];
62 static GlobalValue::LinkageTypes GetDecodedLinkage(unsigned Val) {
64 default: // Map unknown/new linkages to external
65 case 0: return GlobalValue::ExternalLinkage;
66 case 1: return GlobalValue::WeakAnyLinkage;
67 case 2: return GlobalValue::AppendingLinkage;
68 case 3: return GlobalValue::InternalLinkage;
69 case 4: return GlobalValue::LinkOnceAnyLinkage;
70 case 5: return GlobalValue::DLLImportLinkage;
71 case 6: return GlobalValue::DLLExportLinkage;
72 case 7: return GlobalValue::ExternalWeakLinkage;
73 case 8: return GlobalValue::CommonLinkage;
74 case 9: return GlobalValue::PrivateLinkage;
75 case 10: return GlobalValue::WeakODRLinkage;
76 case 11: return GlobalValue::LinkOnceODRLinkage;
77 case 12: return GlobalValue::AvailableExternallyLinkage;
78 case 13: return GlobalValue::LinkerPrivateLinkage;
79 case 14: return GlobalValue::LinkerPrivateWeakLinkage;
80 case 15: return GlobalValue::LinkerPrivateWeakDefAutoLinkage;
84 static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
86 default: // Map unknown visibilities to default.
87 case 0: return GlobalValue::DefaultVisibility;
88 case 1: return GlobalValue::HiddenVisibility;
89 case 2: return GlobalValue::ProtectedVisibility;
93 static int GetDecodedCastOpcode(unsigned Val) {
96 case bitc::CAST_TRUNC : return Instruction::Trunc;
97 case bitc::CAST_ZEXT : return Instruction::ZExt;
98 case bitc::CAST_SEXT : return Instruction::SExt;
99 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
100 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
101 case bitc::CAST_UITOFP : return Instruction::UIToFP;
102 case bitc::CAST_SITOFP : return Instruction::SIToFP;
103 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
104 case bitc::CAST_FPEXT : return Instruction::FPExt;
105 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
106 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
107 case bitc::CAST_BITCAST : return Instruction::BitCast;
110 static int GetDecodedBinaryOpcode(unsigned Val, const Type *Ty) {
113 case bitc::BINOP_ADD:
114 return Ty->isFPOrFPVectorTy() ? Instruction::FAdd : Instruction::Add;
115 case bitc::BINOP_SUB:
116 return Ty->isFPOrFPVectorTy() ? Instruction::FSub : Instruction::Sub;
117 case bitc::BINOP_MUL:
118 return Ty->isFPOrFPVectorTy() ? Instruction::FMul : Instruction::Mul;
119 case bitc::BINOP_UDIV: return Instruction::UDiv;
120 case bitc::BINOP_SDIV:
121 return Ty->isFPOrFPVectorTy() ? Instruction::FDiv : Instruction::SDiv;
122 case bitc::BINOP_UREM: return Instruction::URem;
123 case bitc::BINOP_SREM:
124 return Ty->isFPOrFPVectorTy() ? Instruction::FRem : Instruction::SRem;
125 case bitc::BINOP_SHL: return Instruction::Shl;
126 case bitc::BINOP_LSHR: return Instruction::LShr;
127 case bitc::BINOP_ASHR: return Instruction::AShr;
128 case bitc::BINOP_AND: return Instruction::And;
129 case bitc::BINOP_OR: return Instruction::Or;
130 case bitc::BINOP_XOR: return Instruction::Xor;
136 /// @brief A class for maintaining the slot number definition
137 /// as a placeholder for the actual definition for forward constants defs.
138 class ConstantPlaceHolder : public ConstantExpr {
139 ConstantPlaceHolder(); // DO NOT IMPLEMENT
140 void operator=(const ConstantPlaceHolder &); // DO NOT IMPLEMENT
142 // allocate space for exactly one operand
143 void *operator new(size_t s) {
144 return User::operator new(s, 1);
146 explicit ConstantPlaceHolder(const Type *Ty, LLVMContext& Context)
147 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
148 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
151 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
152 static inline bool classof(const ConstantPlaceHolder *) { return true; }
153 static bool classof(const Value *V) {
154 return isa<ConstantExpr>(V) &&
155 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
159 /// Provide fast operand accessors
160 //DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
164 // FIXME: can we inherit this from ConstantExpr?
166 struct OperandTraits<ConstantPlaceHolder> : public FixedNumOperandTraits<1> {
171 void BitcodeReaderValueList::AssignValue(Value *V, unsigned Idx) {
180 WeakVH &OldV = ValuePtrs[Idx];
186 // Handle constants and non-constants (e.g. instrs) differently for
188 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
189 ResolveConstants.push_back(std::make_pair(PHC, Idx));
192 // If there was a forward reference to this value, replace it.
193 Value *PrevVal = OldV;
194 OldV->replaceAllUsesWith(V);
200 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
205 if (Value *V = ValuePtrs[Idx]) {
206 assert(Ty == V->getType() && "Type mismatch in constant table!");
207 return cast<Constant>(V);
210 // Create and return a placeholder, which will later be RAUW'd.
211 Constant *C = new ConstantPlaceHolder(Ty, Context);
216 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, const Type *Ty) {
220 if (Value *V = ValuePtrs[Idx]) {
221 assert((Ty == 0 || Ty == V->getType()) && "Type mismatch in value table!");
225 // No type specified, must be invalid reference.
226 if (Ty == 0) return 0;
228 // Create and return a placeholder, which will later be RAUW'd.
229 Value *V = new Argument(Ty);
234 /// ResolveConstantForwardRefs - Once all constants are read, this method bulk
235 /// resolves any forward references. The idea behind this is that we sometimes
236 /// get constants (such as large arrays) which reference *many* forward ref
237 /// constants. Replacing each of these causes a lot of thrashing when
238 /// building/reuniquing the constant. Instead of doing this, we look at all the
239 /// uses and rewrite all the place holders at once for any constant that uses
241 void BitcodeReaderValueList::ResolveConstantForwardRefs() {
242 // Sort the values by-pointer so that they are efficient to look up with a
244 std::sort(ResolveConstants.begin(), ResolveConstants.end());
246 SmallVector<Constant*, 64> NewOps;
248 while (!ResolveConstants.empty()) {
249 Value *RealVal = operator[](ResolveConstants.back().second);
250 Constant *Placeholder = ResolveConstants.back().first;
251 ResolveConstants.pop_back();
253 // Loop over all users of the placeholder, updating them to reference the
254 // new value. If they reference more than one placeholder, update them all
256 while (!Placeholder->use_empty()) {
257 Value::use_iterator UI = Placeholder->use_begin();
260 // If the using object isn't uniqued, just update the operands. This
261 // handles instructions and initializers for global variables.
262 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
263 UI.getUse().set(RealVal);
267 // Otherwise, we have a constant that uses the placeholder. Replace that
268 // constant with a new constant that has *all* placeholder uses updated.
269 Constant *UserC = cast<Constant>(U);
270 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
273 if (!isa<ConstantPlaceHolder>(*I)) {
274 // Not a placeholder reference.
276 } else if (*I == Placeholder) {
277 // Common case is that it just references this one placeholder.
280 // Otherwise, look up the placeholder in ResolveConstants.
281 ResolveConstantsTy::iterator It =
282 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
283 std::pair<Constant*, unsigned>(cast<Constant>(*I),
285 assert(It != ResolveConstants.end() && It->first == *I);
286 NewOp = operator[](It->second);
289 NewOps.push_back(cast<Constant>(NewOp));
292 // Make the new constant.
294 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
295 NewC = ConstantArray::get(UserCA->getType(), &NewOps[0],
297 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
298 NewC = ConstantStruct::get(Context, &NewOps[0], NewOps.size(),
299 UserCS->getType()->isPacked());
300 } else if (ConstantUnion *UserCU = dyn_cast<ConstantUnion>(UserC)) {
301 NewC = ConstantUnion::get(UserCU->getType(), NewOps[0]);
302 } else if (isa<ConstantVector>(UserC)) {
303 NewC = ConstantVector::get(&NewOps[0], NewOps.size());
305 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
306 NewC = cast<ConstantExpr>(UserC)->getWithOperands(&NewOps[0],
310 UserC->replaceAllUsesWith(NewC);
311 UserC->destroyConstant();
315 // Update all ValueHandles, they should be the only users at this point.
316 Placeholder->replaceAllUsesWith(RealVal);
321 void BitcodeReaderMDValueList::AssignValue(Value *V, unsigned Idx) {
330 WeakVH &OldV = MDValuePtrs[Idx];
336 // If there was a forward reference to this value, replace it.
337 MDNode *PrevVal = cast<MDNode>(OldV);
338 OldV->replaceAllUsesWith(V);
339 MDNode::deleteTemporary(PrevVal);
340 // Deleting PrevVal sets Idx value in MDValuePtrs to null. Set new
342 MDValuePtrs[Idx] = V;
345 Value *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
349 if (Value *V = MDValuePtrs[Idx]) {
350 assert(V->getType()->isMetadataTy() && "Type mismatch in value table!");
354 // Create and return a placeholder, which will later be RAUW'd.
355 Value *V = MDNode::getTemporary(Context, 0, 0);
356 MDValuePtrs[Idx] = V;
360 const Type *BitcodeReader::getTypeByID(unsigned ID, bool isTypeTable) {
361 // If the TypeID is in range, return it.
362 if (ID < TypeList.size())
363 return TypeList[ID].get();
364 if (!isTypeTable) return 0;
366 // The type table allows forward references. Push as many Opaque types as
367 // needed to get up to ID.
368 while (TypeList.size() <= ID)
369 TypeList.push_back(OpaqueType::get(Context));
370 return TypeList.back().get();
373 //===----------------------------------------------------------------------===//
374 // Functions for parsing blocks from the bitcode file
375 //===----------------------------------------------------------------------===//
377 bool BitcodeReader::ParseAttributeBlock() {
378 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
379 return Error("Malformed block record");
381 if (!MAttributes.empty())
382 return Error("Multiple PARAMATTR blocks found!");
384 SmallVector<uint64_t, 64> Record;
386 SmallVector<AttributeWithIndex, 8> Attrs;
388 // Read all the records.
390 unsigned Code = Stream.ReadCode();
391 if (Code == bitc::END_BLOCK) {
392 if (Stream.ReadBlockEnd())
393 return Error("Error at end of PARAMATTR block");
397 if (Code == bitc::ENTER_SUBBLOCK) {
398 // No known subblocks, always skip them.
399 Stream.ReadSubBlockID();
400 if (Stream.SkipBlock())
401 return Error("Malformed block record");
405 if (Code == bitc::DEFINE_ABBREV) {
406 Stream.ReadAbbrevRecord();
412 switch (Stream.ReadRecord(Code, Record)) {
413 default: // Default behavior: ignore.
415 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [paramidx0, attr0, ...]
416 if (Record.size() & 1)
417 return Error("Invalid ENTRY record");
419 // FIXME : Remove this autoupgrade code in LLVM 3.0.
420 // If Function attributes are using index 0 then transfer them
421 // to index ~0. Index 0 is used for return value attributes but used to be
422 // used for function attributes.
423 Attributes RetAttribute = Attribute::None;
424 Attributes FnAttribute = Attribute::None;
425 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
426 // FIXME: remove in LLVM 3.0
427 // The alignment is stored as a 16-bit raw value from bits 31--16.
428 // We shift the bits above 31 down by 11 bits.
430 unsigned Alignment = (Record[i+1] & (0xffffull << 16)) >> 16;
431 if (Alignment && !isPowerOf2_32(Alignment))
432 return Error("Alignment is not a power of two.");
434 Attributes ReconstitutedAttr = Record[i+1] & 0xffff;
436 ReconstitutedAttr |= Attribute::constructAlignmentFromInt(Alignment);
437 ReconstitutedAttr |= (Record[i+1] & (0xffffull << 32)) >> 11;
438 Record[i+1] = ReconstitutedAttr;
441 RetAttribute = Record[i+1];
442 else if (Record[i] == ~0U)
443 FnAttribute = Record[i+1];
446 unsigned OldRetAttrs = (Attribute::NoUnwind|Attribute::NoReturn|
447 Attribute::ReadOnly|Attribute::ReadNone);
449 if (FnAttribute == Attribute::None && RetAttribute != Attribute::None &&
450 (RetAttribute & OldRetAttrs) != 0) {
451 if (FnAttribute == Attribute::None) { // add a slot so they get added.
452 Record.push_back(~0U);
456 FnAttribute |= RetAttribute & OldRetAttrs;
457 RetAttribute &= ~OldRetAttrs;
460 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
461 if (Record[i] == 0) {
462 if (RetAttribute != Attribute::None)
463 Attrs.push_back(AttributeWithIndex::get(0, RetAttribute));
464 } else if (Record[i] == ~0U) {
465 if (FnAttribute != Attribute::None)
466 Attrs.push_back(AttributeWithIndex::get(~0U, FnAttribute));
467 } else if (Record[i+1] != Attribute::None)
468 Attrs.push_back(AttributeWithIndex::get(Record[i], Record[i+1]));
471 MAttributes.push_back(AttrListPtr::get(Attrs.begin(), Attrs.end()));
480 bool BitcodeReader::ParseTypeTable() {
481 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID))
482 return Error("Malformed block record");
484 if (!TypeList.empty())
485 return Error("Multiple TYPE_BLOCKs found!");
487 SmallVector<uint64_t, 64> Record;
488 unsigned NumRecords = 0;
490 // Read all the records for this type table.
492 unsigned Code = Stream.ReadCode();
493 if (Code == bitc::END_BLOCK) {
494 if (NumRecords != TypeList.size())
495 return Error("Invalid type forward reference in TYPE_BLOCK");
496 if (Stream.ReadBlockEnd())
497 return Error("Error at end of type table block");
501 if (Code == bitc::ENTER_SUBBLOCK) {
502 // No known subblocks, always skip them.
503 Stream.ReadSubBlockID();
504 if (Stream.SkipBlock())
505 return Error("Malformed block record");
509 if (Code == bitc::DEFINE_ABBREV) {
510 Stream.ReadAbbrevRecord();
516 const Type *ResultTy = 0;
517 switch (Stream.ReadRecord(Code, Record)) {
518 default: // Default behavior: unknown type.
521 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
522 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
523 // type list. This allows us to reserve space.
524 if (Record.size() < 1)
525 return Error("Invalid TYPE_CODE_NUMENTRY record");
526 TypeList.reserve(Record[0]);
528 case bitc::TYPE_CODE_VOID: // VOID
529 ResultTy = Type::getVoidTy(Context);
531 case bitc::TYPE_CODE_FLOAT: // FLOAT
532 ResultTy = Type::getFloatTy(Context);
534 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
535 ResultTy = Type::getDoubleTy(Context);
537 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
538 ResultTy = Type::getX86_FP80Ty(Context);
540 case bitc::TYPE_CODE_FP128: // FP128
541 ResultTy = Type::getFP128Ty(Context);
543 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
544 ResultTy = Type::getPPC_FP128Ty(Context);
546 case bitc::TYPE_CODE_LABEL: // LABEL
547 ResultTy = Type::getLabelTy(Context);
549 case bitc::TYPE_CODE_OPAQUE: // OPAQUE
552 case bitc::TYPE_CODE_METADATA: // METADATA
553 ResultTy = Type::getMetadataTy(Context);
555 case bitc::TYPE_CODE_INTEGER: // INTEGER: [width]
556 if (Record.size() < 1)
557 return Error("Invalid Integer type record");
559 ResultTy = IntegerType::get(Context, Record[0]);
561 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
562 // [pointee type, address space]
563 if (Record.size() < 1)
564 return Error("Invalid POINTER type record");
565 unsigned AddressSpace = 0;
566 if (Record.size() == 2)
567 AddressSpace = Record[1];
568 ResultTy = PointerType::get(getTypeByID(Record[0], true),
572 case bitc::TYPE_CODE_FUNCTION: {
573 // FIXME: attrid is dead, remove it in LLVM 3.0
574 // FUNCTION: [vararg, attrid, retty, paramty x N]
575 if (Record.size() < 3)
576 return Error("Invalid FUNCTION type record");
577 std::vector<const Type*> ArgTys;
578 for (unsigned i = 3, e = Record.size(); i != e; ++i)
579 ArgTys.push_back(getTypeByID(Record[i], true));
581 ResultTy = FunctionType::get(getTypeByID(Record[2], true), ArgTys,
585 case bitc::TYPE_CODE_STRUCT: { // STRUCT: [ispacked, eltty x N]
586 if (Record.size() < 1)
587 return Error("Invalid STRUCT type record");
588 std::vector<const Type*> EltTys;
589 for (unsigned i = 1, e = Record.size(); i != e; ++i)
590 EltTys.push_back(getTypeByID(Record[i], true));
591 ResultTy = StructType::get(Context, EltTys, Record[0]);
594 case bitc::TYPE_CODE_UNION: { // UNION: [eltty x N]
595 SmallVector<const Type*, 8> EltTys;
596 for (unsigned i = 0, e = Record.size(); i != e; ++i)
597 EltTys.push_back(getTypeByID(Record[i], true));
598 ResultTy = UnionType::get(&EltTys[0], EltTys.size());
601 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
602 if (Record.size() < 2)
603 return Error("Invalid ARRAY type record");
604 ResultTy = ArrayType::get(getTypeByID(Record[1], true), Record[0]);
606 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
607 if (Record.size() < 2)
608 return Error("Invalid VECTOR type record");
609 ResultTy = VectorType::get(getTypeByID(Record[1], true), Record[0]);
613 if (NumRecords == TypeList.size()) {
614 // If this is a new type slot, just append it.
615 TypeList.push_back(ResultTy ? ResultTy : OpaqueType::get(Context));
617 } else if (ResultTy == 0) {
618 // Otherwise, this was forward referenced, so an opaque type was created,
619 // but the result type is actually just an opaque. Leave the one we
620 // created previously.
623 // Otherwise, this was forward referenced, so an opaque type was created.
624 // Resolve the opaque type to the real type now.
625 assert(NumRecords < TypeList.size() && "Typelist imbalance");
626 const OpaqueType *OldTy = cast<OpaqueType>(TypeList[NumRecords++].get());
628 // Don't directly push the new type on the Tab. Instead we want to replace
629 // the opaque type we previously inserted with the new concrete value. The
630 // refinement from the abstract (opaque) type to the new type causes all
631 // uses of the abstract type to use the concrete type (NewTy). This will
632 // also cause the opaque type to be deleted.
633 const_cast<OpaqueType*>(OldTy)->refineAbstractTypeTo(ResultTy);
635 // This should have replaced the old opaque type with the new type in the
636 // value table... or with a preexisting type that was already in the
637 // system. Let's just make sure it did.
638 assert(TypeList[NumRecords-1].get() != OldTy &&
639 "refineAbstractType didn't work!");
645 bool BitcodeReader::ParseTypeSymbolTable() {
646 if (Stream.EnterSubBlock(bitc::TYPE_SYMTAB_BLOCK_ID))
647 return Error("Malformed block record");
649 SmallVector<uint64_t, 64> Record;
651 // Read all the records for this type table.
652 std::string TypeName;
654 unsigned Code = Stream.ReadCode();
655 if (Code == bitc::END_BLOCK) {
656 if (Stream.ReadBlockEnd())
657 return Error("Error at end of type symbol table block");
661 if (Code == bitc::ENTER_SUBBLOCK) {
662 // No known subblocks, always skip them.
663 Stream.ReadSubBlockID();
664 if (Stream.SkipBlock())
665 return Error("Malformed block record");
669 if (Code == bitc::DEFINE_ABBREV) {
670 Stream.ReadAbbrevRecord();
676 switch (Stream.ReadRecord(Code, Record)) {
677 default: // Default behavior: unknown type.
679 case bitc::TST_CODE_ENTRY: // TST_ENTRY: [typeid, namechar x N]
680 if (ConvertToString(Record, 1, TypeName))
681 return Error("Invalid TST_ENTRY record");
682 unsigned TypeID = Record[0];
683 if (TypeID >= TypeList.size())
684 return Error("Invalid Type ID in TST_ENTRY record");
686 TheModule->addTypeName(TypeName, TypeList[TypeID].get());
693 bool BitcodeReader::ParseValueSymbolTable() {
694 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
695 return Error("Malformed block record");
697 SmallVector<uint64_t, 64> Record;
699 // Read all the records for this value table.
700 SmallString<128> ValueName;
702 unsigned Code = Stream.ReadCode();
703 if (Code == bitc::END_BLOCK) {
704 if (Stream.ReadBlockEnd())
705 return Error("Error at end of value symbol table block");
708 if (Code == bitc::ENTER_SUBBLOCK) {
709 // No known subblocks, always skip them.
710 Stream.ReadSubBlockID();
711 if (Stream.SkipBlock())
712 return Error("Malformed block record");
716 if (Code == bitc::DEFINE_ABBREV) {
717 Stream.ReadAbbrevRecord();
723 switch (Stream.ReadRecord(Code, Record)) {
724 default: // Default behavior: unknown type.
726 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
727 if (ConvertToString(Record, 1, ValueName))
728 return Error("Invalid VST_ENTRY record");
729 unsigned ValueID = Record[0];
730 if (ValueID >= ValueList.size())
731 return Error("Invalid Value ID in VST_ENTRY record");
732 Value *V = ValueList[ValueID];
734 V->setName(StringRef(ValueName.data(), ValueName.size()));
738 case bitc::VST_CODE_BBENTRY: {
739 if (ConvertToString(Record, 1, ValueName))
740 return Error("Invalid VST_BBENTRY record");
741 BasicBlock *BB = getBasicBlock(Record[0]);
743 return Error("Invalid BB ID in VST_BBENTRY record");
745 BB->setName(StringRef(ValueName.data(), ValueName.size()));
753 bool BitcodeReader::ParseMetadata() {
754 unsigned NextMDValueNo = MDValueList.size();
756 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
757 return Error("Malformed block record");
759 SmallVector<uint64_t, 64> Record;
761 // Read all the records.
763 unsigned Code = Stream.ReadCode();
764 if (Code == bitc::END_BLOCK) {
765 if (Stream.ReadBlockEnd())
766 return Error("Error at end of PARAMATTR block");
770 if (Code == bitc::ENTER_SUBBLOCK) {
771 // No known subblocks, always skip them.
772 Stream.ReadSubBlockID();
773 if (Stream.SkipBlock())
774 return Error("Malformed block record");
778 if (Code == bitc::DEFINE_ABBREV) {
779 Stream.ReadAbbrevRecord();
783 bool IsFunctionLocal = false;
786 switch (Stream.ReadRecord(Code, Record)) {
787 default: // Default behavior: ignore.
789 case bitc::METADATA_NAME: {
790 // Read named of the named metadata.
791 unsigned NameLength = Record.size();
793 Name.resize(NameLength);
794 for (unsigned i = 0; i != NameLength; ++i)
797 Code = Stream.ReadCode();
799 // METADATA_NAME is always followed by METADATA_NAMED_NODE.
800 if (Stream.ReadRecord(Code, Record) != bitc::METADATA_NAMED_NODE)
801 assert ( 0 && "Inavlid Named Metadata record");
803 // Read named metadata elements.
804 unsigned Size = Record.size();
805 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
806 for (unsigned i = 0; i != Size; ++i) {
807 MDNode *MD = dyn_cast<MDNode>(MDValueList.getValueFwdRef(Record[i]));
809 return Error("Malformed metadata record");
814 case bitc::METADATA_FN_NODE:
815 IsFunctionLocal = true;
817 case bitc::METADATA_NODE: {
818 if (Record.size() % 2 == 1)
819 return Error("Invalid METADATA_NODE record");
821 unsigned Size = Record.size();
822 SmallVector<Value*, 8> Elts;
823 for (unsigned i = 0; i != Size; i += 2) {
824 const Type *Ty = getTypeByID(Record[i], false);
825 if (Ty->isMetadataTy())
826 Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
827 else if (!Ty->isVoidTy())
828 Elts.push_back(ValueList.getValueFwdRef(Record[i+1], Ty));
830 Elts.push_back(NULL);
832 Value *V = MDNode::getWhenValsUnresolved(Context,
833 Elts.data(), Elts.size(),
835 IsFunctionLocal = false;
836 MDValueList.AssignValue(V, NextMDValueNo++);
839 case bitc::METADATA_STRING: {
840 unsigned MDStringLength = Record.size();
841 SmallString<8> String;
842 String.resize(MDStringLength);
843 for (unsigned i = 0; i != MDStringLength; ++i)
844 String[i] = Record[i];
845 Value *V = MDString::get(Context,
846 StringRef(String.data(), String.size()));
847 MDValueList.AssignValue(V, NextMDValueNo++);
850 case bitc::METADATA_KIND: {
851 unsigned RecordLength = Record.size();
852 if (Record.empty() || RecordLength < 2)
853 return Error("Invalid METADATA_KIND record");
855 Name.resize(RecordLength-1);
856 unsigned Kind = Record[0];
857 for (unsigned i = 1; i != RecordLength; ++i)
858 Name[i-1] = Record[i];
860 unsigned NewKind = TheModule->getMDKindID(Name.str());
861 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
862 return Error("Conflicting METADATA_KIND records");
869 /// DecodeSignRotatedValue - Decode a signed value stored with the sign bit in
870 /// the LSB for dense VBR encoding.
871 static uint64_t DecodeSignRotatedValue(uint64_t V) {
876 // There is no such thing as -0 with integers. "-0" really means MININT.
880 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
881 /// values and aliases that we can.
882 bool BitcodeReader::ResolveGlobalAndAliasInits() {
883 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
884 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
886 GlobalInitWorklist.swap(GlobalInits);
887 AliasInitWorklist.swap(AliasInits);
889 while (!GlobalInitWorklist.empty()) {
890 unsigned ValID = GlobalInitWorklist.back().second;
891 if (ValID >= ValueList.size()) {
892 // Not ready to resolve this yet, it requires something later in the file.
893 GlobalInits.push_back(GlobalInitWorklist.back());
895 if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
896 GlobalInitWorklist.back().first->setInitializer(C);
898 return Error("Global variable initializer is not a constant!");
900 GlobalInitWorklist.pop_back();
903 while (!AliasInitWorklist.empty()) {
904 unsigned ValID = AliasInitWorklist.back().second;
905 if (ValID >= ValueList.size()) {
906 AliasInits.push_back(AliasInitWorklist.back());
908 if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
909 AliasInitWorklist.back().first->setAliasee(C);
911 return Error("Alias initializer is not a constant!");
913 AliasInitWorklist.pop_back();
918 bool BitcodeReader::ParseConstants() {
919 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
920 return Error("Malformed block record");
922 SmallVector<uint64_t, 64> Record;
924 // Read all the records for this value table.
925 const Type *CurTy = Type::getInt32Ty(Context);
926 unsigned NextCstNo = ValueList.size();
928 unsigned Code = Stream.ReadCode();
929 if (Code == bitc::END_BLOCK)
932 if (Code == bitc::ENTER_SUBBLOCK) {
933 // No known subblocks, always skip them.
934 Stream.ReadSubBlockID();
935 if (Stream.SkipBlock())
936 return Error("Malformed block record");
940 if (Code == bitc::DEFINE_ABBREV) {
941 Stream.ReadAbbrevRecord();
948 unsigned BitCode = Stream.ReadRecord(Code, Record);
950 default: // Default behavior: unknown constant
951 case bitc::CST_CODE_UNDEF: // UNDEF
952 V = UndefValue::get(CurTy);
954 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
956 return Error("Malformed CST_SETTYPE record");
957 if (Record[0] >= TypeList.size())
958 return Error("Invalid Type ID in CST_SETTYPE record");
959 CurTy = TypeList[Record[0]];
960 continue; // Skip the ValueList manipulation.
961 case bitc::CST_CODE_NULL: // NULL
962 V = Constant::getNullValue(CurTy);
964 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
965 if (!CurTy->isIntegerTy() || Record.empty())
966 return Error("Invalid CST_INTEGER record");
967 V = ConstantInt::get(CurTy, DecodeSignRotatedValue(Record[0]));
969 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
970 if (!CurTy->isIntegerTy() || Record.empty())
971 return Error("Invalid WIDE_INTEGER record");
973 unsigned NumWords = Record.size();
974 SmallVector<uint64_t, 8> Words;
975 Words.resize(NumWords);
976 for (unsigned i = 0; i != NumWords; ++i)
977 Words[i] = DecodeSignRotatedValue(Record[i]);
978 V = ConstantInt::get(Context,
979 APInt(cast<IntegerType>(CurTy)->getBitWidth(),
980 NumWords, &Words[0]));
983 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
985 return Error("Invalid FLOAT record");
986 if (CurTy->isFloatTy())
987 V = ConstantFP::get(Context, APFloat(APInt(32, (uint32_t)Record[0])));
988 else if (CurTy->isDoubleTy())
989 V = ConstantFP::get(Context, APFloat(APInt(64, Record[0])));
990 else if (CurTy->isX86_FP80Ty()) {
991 // Bits are not stored the same way as a normal i80 APInt, compensate.
992 uint64_t Rearrange[2];
993 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
994 Rearrange[1] = Record[0] >> 48;
995 V = ConstantFP::get(Context, APFloat(APInt(80, 2, Rearrange)));
996 } else if (CurTy->isFP128Ty())
997 V = ConstantFP::get(Context, APFloat(APInt(128, 2, &Record[0]), true));
998 else if (CurTy->isPPC_FP128Ty())
999 V = ConstantFP::get(Context, APFloat(APInt(128, 2, &Record[0])));
1001 V = UndefValue::get(CurTy);
1005 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
1007 return Error("Invalid CST_AGGREGATE record");
1009 unsigned Size = Record.size();
1010 std::vector<Constant*> Elts;
1012 if (const StructType *STy = dyn_cast<StructType>(CurTy)) {
1013 for (unsigned i = 0; i != Size; ++i)
1014 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
1015 STy->getElementType(i)));
1016 V = ConstantStruct::get(STy, Elts);
1017 } else if (const UnionType *UnTy = dyn_cast<UnionType>(CurTy)) {
1018 uint64_t Index = Record[0];
1019 Constant *Val = ValueList.getConstantFwdRef(Record[1],
1020 UnTy->getElementType(Index));
1021 V = ConstantUnion::get(UnTy, Val);
1022 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
1023 const Type *EltTy = ATy->getElementType();
1024 for (unsigned i = 0; i != Size; ++i)
1025 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1026 V = ConstantArray::get(ATy, Elts);
1027 } else if (const VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
1028 const Type *EltTy = VTy->getElementType();
1029 for (unsigned i = 0; i != Size; ++i)
1030 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1031 V = ConstantVector::get(Elts);
1033 V = UndefValue::get(CurTy);
1037 case bitc::CST_CODE_STRING: { // STRING: [values]
1039 return Error("Invalid CST_AGGREGATE record");
1041 const ArrayType *ATy = cast<ArrayType>(CurTy);
1042 const Type *EltTy = ATy->getElementType();
1044 unsigned Size = Record.size();
1045 std::vector<Constant*> Elts;
1046 for (unsigned i = 0; i != Size; ++i)
1047 Elts.push_back(ConstantInt::get(EltTy, Record[i]));
1048 V = ConstantArray::get(ATy, Elts);
1051 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
1053 return Error("Invalid CST_AGGREGATE record");
1055 const ArrayType *ATy = cast<ArrayType>(CurTy);
1056 const Type *EltTy = ATy->getElementType();
1058 unsigned Size = Record.size();
1059 std::vector<Constant*> Elts;
1060 for (unsigned i = 0; i != Size; ++i)
1061 Elts.push_back(ConstantInt::get(EltTy, Record[i]));
1062 Elts.push_back(Constant::getNullValue(EltTy));
1063 V = ConstantArray::get(ATy, Elts);
1066 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
1067 if (Record.size() < 3) return Error("Invalid CE_BINOP record");
1068 int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
1070 V = UndefValue::get(CurTy); // Unknown binop.
1072 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
1073 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
1075 if (Record.size() >= 4) {
1076 if (Opc == Instruction::Add ||
1077 Opc == Instruction::Sub ||
1078 Opc == Instruction::Mul) {
1079 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1080 Flags |= OverflowingBinaryOperator::NoSignedWrap;
1081 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1082 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
1083 } else if (Opc == Instruction::SDiv) {
1084 if (Record[3] & (1 << bitc::SDIV_EXACT))
1085 Flags |= SDivOperator::IsExact;
1088 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
1092 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
1093 if (Record.size() < 3) return Error("Invalid CE_CAST record");
1094 int Opc = GetDecodedCastOpcode(Record[0]);
1096 V = UndefValue::get(CurTy); // Unknown cast.
1098 const Type *OpTy = getTypeByID(Record[1]);
1099 if (!OpTy) return Error("Invalid CE_CAST record");
1100 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
1101 V = ConstantExpr::getCast(Opc, Op, CurTy);
1105 case bitc::CST_CODE_CE_INBOUNDS_GEP:
1106 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
1107 if (Record.size() & 1) return Error("Invalid CE_GEP record");
1108 SmallVector<Constant*, 16> Elts;
1109 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1110 const Type *ElTy = getTypeByID(Record[i]);
1111 if (!ElTy) return Error("Invalid CE_GEP record");
1112 Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
1114 if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)
1115 V = ConstantExpr::getInBoundsGetElementPtr(Elts[0], &Elts[1],
1118 V = ConstantExpr::getGetElementPtr(Elts[0], &Elts[1],
1122 case bitc::CST_CODE_CE_SELECT: // CE_SELECT: [opval#, opval#, opval#]
1123 if (Record.size() < 3) return Error("Invalid CE_SELECT record");
1124 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
1125 Type::getInt1Ty(Context)),
1126 ValueList.getConstantFwdRef(Record[1],CurTy),
1127 ValueList.getConstantFwdRef(Record[2],CurTy));
1129 case bitc::CST_CODE_CE_EXTRACTELT: { // CE_EXTRACTELT: [opty, opval, opval]
1130 if (Record.size() < 3) return Error("Invalid CE_EXTRACTELT record");
1131 const VectorType *OpTy =
1132 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1133 if (OpTy == 0) return Error("Invalid CE_EXTRACTELT record");
1134 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1135 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1136 V = ConstantExpr::getExtractElement(Op0, Op1);
1139 case bitc::CST_CODE_CE_INSERTELT: { // CE_INSERTELT: [opval, opval, opval]
1140 const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1141 if (Record.size() < 3 || OpTy == 0)
1142 return Error("Invalid CE_INSERTELT record");
1143 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1144 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
1145 OpTy->getElementType());
1146 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1147 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
1150 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
1151 const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1152 if (Record.size() < 3 || OpTy == 0)
1153 return Error("Invalid CE_SHUFFLEVEC record");
1154 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1155 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
1156 const Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1157 OpTy->getNumElements());
1158 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
1159 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1162 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
1163 const VectorType *RTy = dyn_cast<VectorType>(CurTy);
1164 const VectorType *OpTy = dyn_cast<VectorType>(getTypeByID(Record[0]));
1165 if (Record.size() < 4 || RTy == 0 || OpTy == 0)
1166 return Error("Invalid CE_SHUFVEC_EX record");
1167 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1168 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1169 const Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1170 RTy->getNumElements());
1171 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
1172 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1175 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
1176 if (Record.size() < 4) return Error("Invalid CE_CMP record");
1177 const Type *OpTy = getTypeByID(Record[0]);
1178 if (OpTy == 0) return Error("Invalid CE_CMP record");
1179 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1180 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1182 if (OpTy->isFPOrFPVectorTy())
1183 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
1185 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
1188 case bitc::CST_CODE_INLINEASM: {
1189 if (Record.size() < 2) return Error("Invalid INLINEASM record");
1190 std::string AsmStr, ConstrStr;
1191 bool HasSideEffects = Record[0] & 1;
1192 bool IsAlignStack = Record[0] >> 1;
1193 unsigned AsmStrSize = Record[1];
1194 if (2+AsmStrSize >= Record.size())
1195 return Error("Invalid INLINEASM record");
1196 unsigned ConstStrSize = Record[2+AsmStrSize];
1197 if (3+AsmStrSize+ConstStrSize > Record.size())
1198 return Error("Invalid INLINEASM record");
1200 for (unsigned i = 0; i != AsmStrSize; ++i)
1201 AsmStr += (char)Record[2+i];
1202 for (unsigned i = 0; i != ConstStrSize; ++i)
1203 ConstrStr += (char)Record[3+AsmStrSize+i];
1204 const PointerType *PTy = cast<PointerType>(CurTy);
1205 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1206 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
1209 case bitc::CST_CODE_BLOCKADDRESS:{
1210 if (Record.size() < 3) return Error("Invalid CE_BLOCKADDRESS record");
1211 const Type *FnTy = getTypeByID(Record[0]);
1212 if (FnTy == 0) return Error("Invalid CE_BLOCKADDRESS record");
1214 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
1215 if (Fn == 0) return Error("Invalid CE_BLOCKADDRESS record");
1217 GlobalVariable *FwdRef = new GlobalVariable(*Fn->getParent(),
1218 Type::getInt8Ty(Context),
1219 false, GlobalValue::InternalLinkage,
1221 BlockAddrFwdRefs[Fn].push_back(std::make_pair(Record[2], FwdRef));
1227 ValueList.AssignValue(V, NextCstNo);
1231 if (NextCstNo != ValueList.size())
1232 return Error("Invalid constant reference!");
1234 if (Stream.ReadBlockEnd())
1235 return Error("Error at end of constants block");
1237 // Once all the constants have been read, go through and resolve forward
1239 ValueList.ResolveConstantForwardRefs();
1243 /// RememberAndSkipFunctionBody - When we see the block for a function body,
1244 /// remember where it is and then skip it. This lets us lazily deserialize the
1246 bool BitcodeReader::RememberAndSkipFunctionBody() {
1247 // Get the function we are talking about.
1248 if (FunctionsWithBodies.empty())
1249 return Error("Insufficient function protos");
1251 Function *Fn = FunctionsWithBodies.back();
1252 FunctionsWithBodies.pop_back();
1254 // Save the current stream state.
1255 uint64_t CurBit = Stream.GetCurrentBitNo();
1256 DeferredFunctionInfo[Fn] = CurBit;
1258 // Skip over the function block for now.
1259 if (Stream.SkipBlock())
1260 return Error("Malformed block record");
1264 bool BitcodeReader::ParseModule() {
1265 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
1266 return Error("Malformed block record");
1268 SmallVector<uint64_t, 64> Record;
1269 std::vector<std::string> SectionTable;
1270 std::vector<std::string> GCTable;
1272 // Read all the records for this module.
1273 while (!Stream.AtEndOfStream()) {
1274 unsigned Code = Stream.ReadCode();
1275 if (Code == bitc::END_BLOCK) {
1276 if (Stream.ReadBlockEnd())
1277 return Error("Error at end of module block");
1279 // Patch the initializers for globals and aliases up.
1280 ResolveGlobalAndAliasInits();
1281 if (!GlobalInits.empty() || !AliasInits.empty())
1282 return Error("Malformed global initializer set");
1283 if (!FunctionsWithBodies.empty())
1284 return Error("Too few function bodies found");
1286 // Look for intrinsic functions which need to be upgraded at some point
1287 for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
1290 if (UpgradeIntrinsicFunction(FI, NewFn))
1291 UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
1294 // Force deallocation of memory for these vectors to favor the client that
1295 // want lazy deserialization.
1296 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
1297 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
1298 std::vector<Function*>().swap(FunctionsWithBodies);
1302 if (Code == bitc::ENTER_SUBBLOCK) {
1303 switch (Stream.ReadSubBlockID()) {
1304 default: // Skip unknown content.
1305 if (Stream.SkipBlock())
1306 return Error("Malformed block record");
1308 case bitc::BLOCKINFO_BLOCK_ID:
1309 if (Stream.ReadBlockInfoBlock())
1310 return Error("Malformed BlockInfoBlock");
1312 case bitc::PARAMATTR_BLOCK_ID:
1313 if (ParseAttributeBlock())
1316 case bitc::TYPE_BLOCK_ID:
1317 if (ParseTypeTable())
1320 case bitc::TYPE_SYMTAB_BLOCK_ID:
1321 if (ParseTypeSymbolTable())
1324 case bitc::VALUE_SYMTAB_BLOCK_ID:
1325 if (ParseValueSymbolTable())
1328 case bitc::CONSTANTS_BLOCK_ID:
1329 if (ParseConstants() || ResolveGlobalAndAliasInits())
1332 case bitc::METADATA_BLOCK_ID:
1333 if (ParseMetadata())
1336 case bitc::FUNCTION_BLOCK_ID:
1337 // If this is the first function body we've seen, reverse the
1338 // FunctionsWithBodies list.
1339 if (!HasReversedFunctionsWithBodies) {
1340 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
1341 HasReversedFunctionsWithBodies = true;
1344 if (RememberAndSkipFunctionBody())
1351 if (Code == bitc::DEFINE_ABBREV) {
1352 Stream.ReadAbbrevRecord();
1357 switch (Stream.ReadRecord(Code, Record)) {
1358 default: break; // Default behavior, ignore unknown content.
1359 case bitc::MODULE_CODE_VERSION: // VERSION: [version#]
1360 if (Record.size() < 1)
1361 return Error("Malformed MODULE_CODE_VERSION");
1362 // Only version #0 is supported so far.
1364 return Error("Unknown bitstream version!");
1366 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
1368 if (ConvertToString(Record, 0, S))
1369 return Error("Invalid MODULE_CODE_TRIPLE record");
1370 TheModule->setTargetTriple(S);
1373 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
1375 if (ConvertToString(Record, 0, S))
1376 return Error("Invalid MODULE_CODE_DATALAYOUT record");
1377 TheModule->setDataLayout(S);
1380 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
1382 if (ConvertToString(Record, 0, S))
1383 return Error("Invalid MODULE_CODE_ASM record");
1384 TheModule->setModuleInlineAsm(S);
1387 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
1389 if (ConvertToString(Record, 0, S))
1390 return Error("Invalid MODULE_CODE_DEPLIB record");
1391 TheModule->addLibrary(S);
1394 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
1396 if (ConvertToString(Record, 0, S))
1397 return Error("Invalid MODULE_CODE_SECTIONNAME record");
1398 SectionTable.push_back(S);
1401 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
1403 if (ConvertToString(Record, 0, S))
1404 return Error("Invalid MODULE_CODE_GCNAME record");
1405 GCTable.push_back(S);
1408 // GLOBALVAR: [pointer type, isconst, initid,
1409 // linkage, alignment, section, visibility, threadlocal]
1410 case bitc::MODULE_CODE_GLOBALVAR: {
1411 if (Record.size() < 6)
1412 return Error("Invalid MODULE_CODE_GLOBALVAR record");
1413 const Type *Ty = getTypeByID(Record[0]);
1414 if (!Ty->isPointerTy())
1415 return Error("Global not a pointer type!");
1416 unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
1417 Ty = cast<PointerType>(Ty)->getElementType();
1419 bool isConstant = Record[1];
1420 GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
1421 unsigned Alignment = (1 << Record[4]) >> 1;
1422 std::string Section;
1424 if (Record[5]-1 >= SectionTable.size())
1425 return Error("Invalid section ID");
1426 Section = SectionTable[Record[5]-1];
1428 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
1429 if (Record.size() > 6)
1430 Visibility = GetDecodedVisibility(Record[6]);
1431 bool isThreadLocal = false;
1432 if (Record.size() > 7)
1433 isThreadLocal = Record[7];
1435 GlobalVariable *NewGV =
1436 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, 0, "", 0,
1437 isThreadLocal, AddressSpace);
1438 NewGV->setAlignment(Alignment);
1439 if (!Section.empty())
1440 NewGV->setSection(Section);
1441 NewGV->setVisibility(Visibility);
1442 NewGV->setThreadLocal(isThreadLocal);
1444 ValueList.push_back(NewGV);
1446 // Remember which value to use for the global initializer.
1447 if (unsigned InitID = Record[2])
1448 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
1451 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
1452 // alignment, section, visibility, gc]
1453 case bitc::MODULE_CODE_FUNCTION: {
1454 if (Record.size() < 8)
1455 return Error("Invalid MODULE_CODE_FUNCTION record");
1456 const Type *Ty = getTypeByID(Record[0]);
1457 if (!Ty->isPointerTy())
1458 return Error("Function not a pointer type!");
1459 const FunctionType *FTy =
1460 dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1462 return Error("Function not a pointer to function type!");
1464 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
1467 Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
1468 bool isProto = Record[2];
1469 Func->setLinkage(GetDecodedLinkage(Record[3]));
1470 Func->setAttributes(getAttributes(Record[4]));
1472 Func->setAlignment((1 << Record[5]) >> 1);
1474 if (Record[6]-1 >= SectionTable.size())
1475 return Error("Invalid section ID");
1476 Func->setSection(SectionTable[Record[6]-1]);
1478 Func->setVisibility(GetDecodedVisibility(Record[7]));
1479 if (Record.size() > 8 && Record[8]) {
1480 if (Record[8]-1 > GCTable.size())
1481 return Error("Invalid GC ID");
1482 Func->setGC(GCTable[Record[8]-1].c_str());
1484 ValueList.push_back(Func);
1486 // If this is a function with a body, remember the prototype we are
1487 // creating now, so that we can match up the body with them later.
1489 FunctionsWithBodies.push_back(Func);
1492 // ALIAS: [alias type, aliasee val#, linkage]
1493 // ALIAS: [alias type, aliasee val#, linkage, visibility]
1494 case bitc::MODULE_CODE_ALIAS: {
1495 if (Record.size() < 3)
1496 return Error("Invalid MODULE_ALIAS record");
1497 const Type *Ty = getTypeByID(Record[0]);
1498 if (!Ty->isPointerTy())
1499 return Error("Function not a pointer type!");
1501 GlobalAlias *NewGA = new GlobalAlias(Ty, GetDecodedLinkage(Record[2]),
1503 // Old bitcode files didn't have visibility field.
1504 if (Record.size() > 3)
1505 NewGA->setVisibility(GetDecodedVisibility(Record[3]));
1506 ValueList.push_back(NewGA);
1507 AliasInits.push_back(std::make_pair(NewGA, Record[1]));
1510 /// MODULE_CODE_PURGEVALS: [numvals]
1511 case bitc::MODULE_CODE_PURGEVALS:
1512 // Trim down the value list to the specified size.
1513 if (Record.size() < 1 || Record[0] > ValueList.size())
1514 return Error("Invalid MODULE_PURGEVALS record");
1515 ValueList.shrinkTo(Record[0]);
1521 return Error("Premature end of bitstream");
1524 bool BitcodeReader::ParseBitcodeInto(Module *M) {
1527 unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
1528 unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
1530 if (Buffer->getBufferSize() & 3) {
1531 if (!isRawBitcode(BufPtr, BufEnd) && !isBitcodeWrapper(BufPtr, BufEnd))
1532 return Error("Invalid bitcode signature");
1534 return Error("Bitcode stream should be a multiple of 4 bytes in length");
1537 // If we have a wrapper header, parse it and ignore the non-bc file contents.
1538 // The magic number is 0x0B17C0DE stored in little endian.
1539 if (isBitcodeWrapper(BufPtr, BufEnd))
1540 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd))
1541 return Error("Invalid bitcode wrapper header");
1543 StreamFile.init(BufPtr, BufEnd);
1544 Stream.init(StreamFile);
1546 // Sniff for the signature.
1547 if (Stream.Read(8) != 'B' ||
1548 Stream.Read(8) != 'C' ||
1549 Stream.Read(4) != 0x0 ||
1550 Stream.Read(4) != 0xC ||
1551 Stream.Read(4) != 0xE ||
1552 Stream.Read(4) != 0xD)
1553 return Error("Invalid bitcode signature");
1555 // We expect a number of well-defined blocks, though we don't necessarily
1556 // need to understand them all.
1557 while (!Stream.AtEndOfStream()) {
1558 unsigned Code = Stream.ReadCode();
1560 if (Code != bitc::ENTER_SUBBLOCK)
1561 return Error("Invalid record at top-level");
1563 unsigned BlockID = Stream.ReadSubBlockID();
1565 // We only know the MODULE subblock ID.
1567 case bitc::BLOCKINFO_BLOCK_ID:
1568 if (Stream.ReadBlockInfoBlock())
1569 return Error("Malformed BlockInfoBlock");
1571 case bitc::MODULE_BLOCK_ID:
1572 // Reject multiple MODULE_BLOCK's in a single bitstream.
1574 return Error("Multiple MODULE_BLOCKs in same stream");
1580 if (Stream.SkipBlock())
1581 return Error("Malformed block record");
1589 /// ParseMetadataAttachment - Parse metadata attachments.
1590 bool BitcodeReader::ParseMetadataAttachment() {
1591 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
1592 return Error("Malformed block record");
1594 SmallVector<uint64_t, 64> Record;
1596 unsigned Code = Stream.ReadCode();
1597 if (Code == bitc::END_BLOCK) {
1598 if (Stream.ReadBlockEnd())
1599 return Error("Error at end of PARAMATTR block");
1602 if (Code == bitc::DEFINE_ABBREV) {
1603 Stream.ReadAbbrevRecord();
1606 // Read a metadata attachment record.
1608 switch (Stream.ReadRecord(Code, Record)) {
1609 default: // Default behavior: ignore.
1611 case bitc::METADATA_ATTACHMENT: {
1612 unsigned RecordLength = Record.size();
1613 if (Record.empty() || (RecordLength - 1) % 2 == 1)
1614 return Error ("Invalid METADATA_ATTACHMENT reader!");
1615 Instruction *Inst = InstructionList[Record[0]];
1616 for (unsigned i = 1; i != RecordLength; i = i+2) {
1617 unsigned Kind = Record[i];
1618 DenseMap<unsigned, unsigned>::iterator I =
1619 MDKindMap.find(Kind);
1620 if (I == MDKindMap.end())
1621 return Error("Invalid metadata kind ID");
1622 Value *Node = MDValueList.getValueFwdRef(Record[i+1]);
1623 Inst->setMetadata(I->second, cast<MDNode>(Node));
1632 /// ParseFunctionBody - Lazily parse the specified function body block.
1633 bool BitcodeReader::ParseFunctionBody(Function *F) {
1634 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
1635 return Error("Malformed block record");
1637 InstructionList.clear();
1638 unsigned ModuleValueListSize = ValueList.size();
1639 unsigned ModuleMDValueListSize = MDValueList.size();
1641 // Add all the function arguments to the value table.
1642 for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
1643 ValueList.push_back(I);
1645 unsigned NextValueNo = ValueList.size();
1646 BasicBlock *CurBB = 0;
1647 unsigned CurBBNo = 0;
1651 // Read all the records.
1652 SmallVector<uint64_t, 64> Record;
1654 unsigned Code = Stream.ReadCode();
1655 if (Code == bitc::END_BLOCK) {
1656 if (Stream.ReadBlockEnd())
1657 return Error("Error at end of function block");
1661 if (Code == bitc::ENTER_SUBBLOCK) {
1662 switch (Stream.ReadSubBlockID()) {
1663 default: // Skip unknown content.
1664 if (Stream.SkipBlock())
1665 return Error("Malformed block record");
1667 case bitc::CONSTANTS_BLOCK_ID:
1668 if (ParseConstants()) return true;
1669 NextValueNo = ValueList.size();
1671 case bitc::VALUE_SYMTAB_BLOCK_ID:
1672 if (ParseValueSymbolTable()) return true;
1674 case bitc::METADATA_ATTACHMENT_ID:
1675 if (ParseMetadataAttachment()) return true;
1677 case bitc::METADATA_BLOCK_ID:
1678 if (ParseMetadata()) return true;
1684 if (Code == bitc::DEFINE_ABBREV) {
1685 Stream.ReadAbbrevRecord();
1692 unsigned BitCode = Stream.ReadRecord(Code, Record);
1694 default: // Default behavior: reject
1695 return Error("Unknown instruction");
1696 case bitc::FUNC_CODE_DECLAREBLOCKS: // DECLAREBLOCKS: [nblocks]
1697 if (Record.size() < 1 || Record[0] == 0)
1698 return Error("Invalid DECLAREBLOCKS record");
1699 // Create all the basic blocks for the function.
1700 FunctionBBs.resize(Record[0]);
1701 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
1702 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
1703 CurBB = FunctionBBs[0];
1707 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
1708 // This record indicates that the last instruction is at the same
1709 // location as the previous instruction with a location.
1712 // Get the last instruction emitted.
1713 if (CurBB && !CurBB->empty())
1715 else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
1716 !FunctionBBs[CurBBNo-1]->empty())
1717 I = &FunctionBBs[CurBBNo-1]->back();
1719 if (I == 0) return Error("Invalid DEBUG_LOC_AGAIN record");
1720 I->setDebugLoc(LastLoc);
1724 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
1725 I = 0; // Get the last instruction emitted.
1726 if (CurBB && !CurBB->empty())
1728 else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
1729 !FunctionBBs[CurBBNo-1]->empty())
1730 I = &FunctionBBs[CurBBNo-1]->back();
1731 if (I == 0 || Record.size() < 4)
1732 return Error("Invalid FUNC_CODE_DEBUG_LOC record");
1734 unsigned Line = Record[0], Col = Record[1];
1735 unsigned ScopeID = Record[2], IAID = Record[3];
1737 MDNode *Scope = 0, *IA = 0;
1738 if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
1739 if (IAID) IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
1740 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
1741 I->setDebugLoc(LastLoc);
1746 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
1749 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1750 getValue(Record, OpNum, LHS->getType(), RHS) ||
1751 OpNum+1 > Record.size())
1752 return Error("Invalid BINOP record");
1754 int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
1755 if (Opc == -1) return Error("Invalid BINOP record");
1756 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
1757 InstructionList.push_back(I);
1758 if (OpNum < Record.size()) {
1759 if (Opc == Instruction::Add ||
1760 Opc == Instruction::Sub ||
1761 Opc == Instruction::Mul) {
1762 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1763 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
1764 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1765 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
1766 } else if (Opc == Instruction::SDiv) {
1767 if (Record[OpNum] & (1 << bitc::SDIV_EXACT))
1768 cast<BinaryOperator>(I)->setIsExact(true);
1773 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
1776 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1777 OpNum+2 != Record.size())
1778 return Error("Invalid CAST record");
1780 const Type *ResTy = getTypeByID(Record[OpNum]);
1781 int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
1782 if (Opc == -1 || ResTy == 0)
1783 return Error("Invalid CAST record");
1784 I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
1785 InstructionList.push_back(I);
1788 case bitc::FUNC_CODE_INST_INBOUNDS_GEP:
1789 case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
1792 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
1793 return Error("Invalid GEP record");
1795 SmallVector<Value*, 16> GEPIdx;
1796 while (OpNum != Record.size()) {
1798 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1799 return Error("Invalid GEP record");
1800 GEPIdx.push_back(Op);
1803 I = GetElementPtrInst::Create(BasePtr, GEPIdx.begin(), GEPIdx.end());
1804 InstructionList.push_back(I);
1805 if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP)
1806 cast<GetElementPtrInst>(I)->setIsInBounds(true);
1810 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
1811 // EXTRACTVAL: [opty, opval, n x indices]
1814 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
1815 return Error("Invalid EXTRACTVAL record");
1817 SmallVector<unsigned, 4> EXTRACTVALIdx;
1818 for (unsigned RecSize = Record.size();
1819 OpNum != RecSize; ++OpNum) {
1820 uint64_t Index = Record[OpNum];
1821 if ((unsigned)Index != Index)
1822 return Error("Invalid EXTRACTVAL index");
1823 EXTRACTVALIdx.push_back((unsigned)Index);
1826 I = ExtractValueInst::Create(Agg,
1827 EXTRACTVALIdx.begin(), EXTRACTVALIdx.end());
1828 InstructionList.push_back(I);
1832 case bitc::FUNC_CODE_INST_INSERTVAL: {
1833 // INSERTVAL: [opty, opval, opty, opval, n x indices]
1836 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
1837 return Error("Invalid INSERTVAL record");
1839 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
1840 return Error("Invalid INSERTVAL record");
1842 SmallVector<unsigned, 4> INSERTVALIdx;
1843 for (unsigned RecSize = Record.size();
1844 OpNum != RecSize; ++OpNum) {
1845 uint64_t Index = Record[OpNum];
1846 if ((unsigned)Index != Index)
1847 return Error("Invalid INSERTVAL index");
1848 INSERTVALIdx.push_back((unsigned)Index);
1851 I = InsertValueInst::Create(Agg, Val,
1852 INSERTVALIdx.begin(), INSERTVALIdx.end());
1853 InstructionList.push_back(I);
1857 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
1858 // obsolete form of select
1859 // handles select i1 ... in old bitcode
1861 Value *TrueVal, *FalseVal, *Cond;
1862 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1863 getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1864 getValue(Record, OpNum, Type::getInt1Ty(Context), Cond))
1865 return Error("Invalid SELECT record");
1867 I = SelectInst::Create(Cond, TrueVal, FalseVal);
1868 InstructionList.push_back(I);
1872 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
1873 // new form of select
1874 // handles select i1 or select [N x i1]
1876 Value *TrueVal, *FalseVal, *Cond;
1877 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1878 getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1879 getValueTypePair(Record, OpNum, NextValueNo, Cond))
1880 return Error("Invalid SELECT record");
1882 // select condition can be either i1 or [N x i1]
1883 if (const VectorType* vector_type =
1884 dyn_cast<const VectorType>(Cond->getType())) {
1886 if (vector_type->getElementType() != Type::getInt1Ty(Context))
1887 return Error("Invalid SELECT condition type");
1890 if (Cond->getType() != Type::getInt1Ty(Context))
1891 return Error("Invalid SELECT condition type");
1894 I = SelectInst::Create(Cond, TrueVal, FalseVal);
1895 InstructionList.push_back(I);
1899 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
1902 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1903 getValue(Record, OpNum, Type::getInt32Ty(Context), Idx))
1904 return Error("Invalid EXTRACTELT record");
1905 I = ExtractElementInst::Create(Vec, Idx);
1906 InstructionList.push_back(I);
1910 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
1912 Value *Vec, *Elt, *Idx;
1913 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1914 getValue(Record, OpNum,
1915 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
1916 getValue(Record, OpNum, Type::getInt32Ty(Context), Idx))
1917 return Error("Invalid INSERTELT record");
1918 I = InsertElementInst::Create(Vec, Elt, Idx);
1919 InstructionList.push_back(I);
1923 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
1925 Value *Vec1, *Vec2, *Mask;
1926 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
1927 getValue(Record, OpNum, Vec1->getType(), Vec2))
1928 return Error("Invalid SHUFFLEVEC record");
1930 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
1931 return Error("Invalid SHUFFLEVEC record");
1932 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
1933 InstructionList.push_back(I);
1937 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
1938 // Old form of ICmp/FCmp returning bool
1939 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
1940 // both legal on vectors but had different behaviour.
1941 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
1942 // FCmp/ICmp returning bool or vector of bool
1946 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1947 getValue(Record, OpNum, LHS->getType(), RHS) ||
1948 OpNum+1 != Record.size())
1949 return Error("Invalid CMP record");
1951 if (LHS->getType()->isFPOrFPVectorTy())
1952 I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
1954 I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
1955 InstructionList.push_back(I);
1959 case bitc::FUNC_CODE_INST_GETRESULT: { // GETRESULT: [ty, val, n]
1960 if (Record.size() != 2)
1961 return Error("Invalid GETRESULT record");
1964 getValueTypePair(Record, OpNum, NextValueNo, Op);
1965 unsigned Index = Record[1];
1966 I = ExtractValueInst::Create(Op, Index);
1967 InstructionList.push_back(I);
1971 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
1973 unsigned Size = Record.size();
1975 I = ReturnInst::Create(Context);
1976 InstructionList.push_back(I);
1981 SmallVector<Value *,4> Vs;
1984 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1985 return Error("Invalid RET record");
1987 } while(OpNum != Record.size());
1989 const Type *ReturnType = F->getReturnType();
1990 // Handle multiple return values. FIXME: Remove in LLVM 3.0.
1991 if (Vs.size() > 1 ||
1992 (ReturnType->isStructTy() &&
1993 (Vs.empty() || Vs[0]->getType() != ReturnType))) {
1994 Value *RV = UndefValue::get(ReturnType);
1995 for (unsigned i = 0, e = Vs.size(); i != e; ++i) {
1996 I = InsertValueInst::Create(RV, Vs[i], i, "mrv");
1997 InstructionList.push_back(I);
1998 CurBB->getInstList().push_back(I);
1999 ValueList.AssignValue(I, NextValueNo++);
2002 I = ReturnInst::Create(Context, RV);
2003 InstructionList.push_back(I);
2007 I = ReturnInst::Create(Context, Vs[0]);
2008 InstructionList.push_back(I);
2011 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
2012 if (Record.size() != 1 && Record.size() != 3)
2013 return Error("Invalid BR record");
2014 BasicBlock *TrueDest = getBasicBlock(Record[0]);
2016 return Error("Invalid BR record");
2018 if (Record.size() == 1) {
2019 I = BranchInst::Create(TrueDest);
2020 InstructionList.push_back(I);
2023 BasicBlock *FalseDest = getBasicBlock(Record[1]);
2024 Value *Cond = getFnValueByID(Record[2], Type::getInt1Ty(Context));
2025 if (FalseDest == 0 || Cond == 0)
2026 return Error("Invalid BR record");
2027 I = BranchInst::Create(TrueDest, FalseDest, Cond);
2028 InstructionList.push_back(I);
2032 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
2033 if (Record.size() < 3 || (Record.size() & 1) == 0)
2034 return Error("Invalid SWITCH record");
2035 const Type *OpTy = getTypeByID(Record[0]);
2036 Value *Cond = getFnValueByID(Record[1], OpTy);
2037 BasicBlock *Default = getBasicBlock(Record[2]);
2038 if (OpTy == 0 || Cond == 0 || Default == 0)
2039 return Error("Invalid SWITCH record");
2040 unsigned NumCases = (Record.size()-3)/2;
2041 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
2042 InstructionList.push_back(SI);
2043 for (unsigned i = 0, e = NumCases; i != e; ++i) {
2044 ConstantInt *CaseVal =
2045 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
2046 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
2047 if (CaseVal == 0 || DestBB == 0) {
2049 return Error("Invalid SWITCH record!");
2051 SI->addCase(CaseVal, DestBB);
2056 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
2057 if (Record.size() < 2)
2058 return Error("Invalid INDIRECTBR record");
2059 const Type *OpTy = getTypeByID(Record[0]);
2060 Value *Address = getFnValueByID(Record[1], OpTy);
2061 if (OpTy == 0 || Address == 0)
2062 return Error("Invalid INDIRECTBR record");
2063 unsigned NumDests = Record.size()-2;
2064 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
2065 InstructionList.push_back(IBI);
2066 for (unsigned i = 0, e = NumDests; i != e; ++i) {
2067 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
2068 IBI->addDestination(DestBB);
2071 return Error("Invalid INDIRECTBR record!");
2078 case bitc::FUNC_CODE_INST_INVOKE: {
2079 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
2080 if (Record.size() < 4) return Error("Invalid INVOKE record");
2081 AttrListPtr PAL = getAttributes(Record[0]);
2082 unsigned CCInfo = Record[1];
2083 BasicBlock *NormalBB = getBasicBlock(Record[2]);
2084 BasicBlock *UnwindBB = getBasicBlock(Record[3]);
2088 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2089 return Error("Invalid INVOKE record");
2091 const PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
2092 const FunctionType *FTy = !CalleeTy ? 0 :
2093 dyn_cast<FunctionType>(CalleeTy->getElementType());
2095 // Check that the right number of fixed parameters are here.
2096 if (FTy == 0 || NormalBB == 0 || UnwindBB == 0 ||
2097 Record.size() < OpNum+FTy->getNumParams())
2098 return Error("Invalid INVOKE record");
2100 SmallVector<Value*, 16> Ops;
2101 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2102 Ops.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
2103 if (Ops.back() == 0) return Error("Invalid INVOKE record");
2106 if (!FTy->isVarArg()) {
2107 if (Record.size() != OpNum)
2108 return Error("Invalid INVOKE record");
2110 // Read type/value pairs for varargs params.
2111 while (OpNum != Record.size()) {
2113 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2114 return Error("Invalid INVOKE record");
2119 I = InvokeInst::Create(Callee, NormalBB, UnwindBB,
2120 Ops.begin(), Ops.end());
2121 InstructionList.push_back(I);
2122 cast<InvokeInst>(I)->setCallingConv(
2123 static_cast<CallingConv::ID>(CCInfo));
2124 cast<InvokeInst>(I)->setAttributes(PAL);
2127 case bitc::FUNC_CODE_INST_UNWIND: // UNWIND
2128 I = new UnwindInst(Context);
2129 InstructionList.push_back(I);
2131 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
2132 I = new UnreachableInst(Context);
2133 InstructionList.push_back(I);
2135 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
2136 if (Record.size() < 1 || ((Record.size()-1)&1))
2137 return Error("Invalid PHI record");
2138 const Type *Ty = getTypeByID(Record[0]);
2139 if (!Ty) return Error("Invalid PHI record");
2141 PHINode *PN = PHINode::Create(Ty);
2142 InstructionList.push_back(PN);
2143 PN->reserveOperandSpace((Record.size()-1)/2);
2145 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
2146 Value *V = getFnValueByID(Record[1+i], Ty);
2147 BasicBlock *BB = getBasicBlock(Record[2+i]);
2148 if (!V || !BB) return Error("Invalid PHI record");
2149 PN->addIncoming(V, BB);
2155 case bitc::FUNC_CODE_INST_MALLOC: { // MALLOC: [instty, op, align]
2156 // Autoupgrade malloc instruction to malloc call.
2157 // FIXME: Remove in LLVM 3.0.
2158 if (Record.size() < 3)
2159 return Error("Invalid MALLOC record");
2160 const PointerType *Ty =
2161 dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
2162 Value *Size = getFnValueByID(Record[1], Type::getInt32Ty(Context));
2163 if (!Ty || !Size) return Error("Invalid MALLOC record");
2164 if (!CurBB) return Error("Invalid malloc instruction with no BB");
2165 const Type *Int32Ty = IntegerType::getInt32Ty(CurBB->getContext());
2166 Constant *AllocSize = ConstantExpr::getSizeOf(Ty->getElementType());
2167 AllocSize = ConstantExpr::getTruncOrBitCast(AllocSize, Int32Ty);
2168 I = CallInst::CreateMalloc(CurBB, Int32Ty, Ty->getElementType(),
2169 AllocSize, Size, NULL);
2170 InstructionList.push_back(I);
2173 case bitc::FUNC_CODE_INST_FREE: { // FREE: [op, opty]
2176 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2177 OpNum != Record.size())
2178 return Error("Invalid FREE record");
2179 if (!CurBB) return Error("Invalid free instruction with no BB");
2180 I = CallInst::CreateFree(Op, CurBB);
2181 InstructionList.push_back(I);
2184 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
2185 // For backward compatibility, tolerate a lack of an opty, and use i32.
2186 // LLVM 3.0: Remove this.
2187 if (Record.size() < 3 || Record.size() > 4)
2188 return Error("Invalid ALLOCA record");
2190 const PointerType *Ty =
2191 dyn_cast_or_null<PointerType>(getTypeByID(Record[OpNum++]));
2192 const Type *OpTy = Record.size() == 4 ? getTypeByID(Record[OpNum++]) :
2193 Type::getInt32Ty(Context);
2194 Value *Size = getFnValueByID(Record[OpNum++], OpTy);
2195 unsigned Align = Record[OpNum++];
2196 if (!Ty || !Size) return Error("Invalid ALLOCA record");
2197 I = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
2198 InstructionList.push_back(I);
2201 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
2204 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2205 OpNum+2 != Record.size())
2206 return Error("Invalid LOAD record");
2208 I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2209 InstructionList.push_back(I);
2212 case bitc::FUNC_CODE_INST_STORE2: { // STORE2:[ptrty, ptr, val, align, vol]
2215 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2216 getValue(Record, OpNum,
2217 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
2218 OpNum+2 != Record.size())
2219 return Error("Invalid STORE record");
2221 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2222 InstructionList.push_back(I);
2225 case bitc::FUNC_CODE_INST_STORE: { // STORE:[val, valty, ptr, align, vol]
2226 // FIXME: Legacy form of store instruction. Should be removed in LLVM 3.0.
2229 if (getValueTypePair(Record, OpNum, NextValueNo, Val) ||
2230 getValue(Record, OpNum,
2231 PointerType::getUnqual(Val->getType()), Ptr)||
2232 OpNum+2 != Record.size())
2233 return Error("Invalid STORE record");
2235 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2236 InstructionList.push_back(I);
2239 case bitc::FUNC_CODE_INST_CALL: {
2240 // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
2241 if (Record.size() < 3)
2242 return Error("Invalid CALL record");
2244 AttrListPtr PAL = getAttributes(Record[0]);
2245 unsigned CCInfo = Record[1];
2249 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2250 return Error("Invalid CALL record");
2252 const PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
2253 const FunctionType *FTy = 0;
2254 if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
2255 if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
2256 return Error("Invalid CALL record");
2258 SmallVector<Value*, 16> Args;
2259 // Read the fixed params.
2260 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2261 if (FTy->getParamType(i)->getTypeID()==Type::LabelTyID)
2262 Args.push_back(getBasicBlock(Record[OpNum]));
2264 Args.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
2265 if (Args.back() == 0) return Error("Invalid CALL record");
2268 // Read type/value pairs for varargs params.
2269 if (!FTy->isVarArg()) {
2270 if (OpNum != Record.size())
2271 return Error("Invalid CALL record");
2273 while (OpNum != Record.size()) {
2275 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2276 return Error("Invalid CALL record");
2281 I = CallInst::Create(Callee, Args.begin(), Args.end());
2282 InstructionList.push_back(I);
2283 cast<CallInst>(I)->setCallingConv(
2284 static_cast<CallingConv::ID>(CCInfo>>1));
2285 cast<CallInst>(I)->setTailCall(CCInfo & 1);
2286 cast<CallInst>(I)->setAttributes(PAL);
2289 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
2290 if (Record.size() < 3)
2291 return Error("Invalid VAARG record");
2292 const Type *OpTy = getTypeByID(Record[0]);
2293 Value *Op = getFnValueByID(Record[1], OpTy);
2294 const Type *ResTy = getTypeByID(Record[2]);
2295 if (!OpTy || !Op || !ResTy)
2296 return Error("Invalid VAARG record");
2297 I = new VAArgInst(Op, ResTy);
2298 InstructionList.push_back(I);
2303 // Add instruction to end of current BB. If there is no current BB, reject
2307 return Error("Invalid instruction with no BB");
2309 CurBB->getInstList().push_back(I);
2311 // If this was a terminator instruction, move to the next block.
2312 if (isa<TerminatorInst>(I)) {
2314 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : 0;
2317 // Non-void values get registered in the value table for future use.
2318 if (I && !I->getType()->isVoidTy())
2319 ValueList.AssignValue(I, NextValueNo++);
2322 // Check the function list for unresolved values.
2323 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
2324 if (A->getParent() == 0) {
2325 // We found at least one unresolved value. Nuke them all to avoid leaks.
2326 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
2327 if ((A = dyn_cast<Argument>(ValueList[i])) && A->getParent() == 0) {
2328 A->replaceAllUsesWith(UndefValue::get(A->getType()));
2332 return Error("Never resolved value found in function!");
2336 // FIXME: Check for unresolved forward-declared metadata references
2337 // and clean up leaks.
2339 // See if anything took the address of blocks in this function. If so,
2340 // resolve them now.
2341 DenseMap<Function*, std::vector<BlockAddrRefTy> >::iterator BAFRI =
2342 BlockAddrFwdRefs.find(F);
2343 if (BAFRI != BlockAddrFwdRefs.end()) {
2344 std::vector<BlockAddrRefTy> &RefList = BAFRI->second;
2345 for (unsigned i = 0, e = RefList.size(); i != e; ++i) {
2346 unsigned BlockIdx = RefList[i].first;
2347 if (BlockIdx >= FunctionBBs.size())
2348 return Error("Invalid blockaddress block #");
2350 GlobalVariable *FwdRef = RefList[i].second;
2351 FwdRef->replaceAllUsesWith(BlockAddress::get(F, FunctionBBs[BlockIdx]));
2352 FwdRef->eraseFromParent();
2355 BlockAddrFwdRefs.erase(BAFRI);
2358 // Trim the value list down to the size it was before we parsed this function.
2359 ValueList.shrinkTo(ModuleValueListSize);
2360 MDValueList.shrinkTo(ModuleMDValueListSize);
2361 std::vector<BasicBlock*>().swap(FunctionBBs);
2366 //===----------------------------------------------------------------------===//
2367 // GVMaterializer implementation
2368 //===----------------------------------------------------------------------===//
2371 bool BitcodeReader::isMaterializable(const GlobalValue *GV) const {
2372 if (const Function *F = dyn_cast<Function>(GV)) {
2373 return F->isDeclaration() &&
2374 DeferredFunctionInfo.count(const_cast<Function*>(F));
2379 bool BitcodeReader::Materialize(GlobalValue *GV, std::string *ErrInfo) {
2380 Function *F = dyn_cast<Function>(GV);
2381 // If it's not a function or is already material, ignore the request.
2382 if (!F || !F->isMaterializable()) return false;
2384 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
2385 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
2387 // Move the bit stream to the saved position of the deferred function body.
2388 Stream.JumpToBit(DFII->second);
2390 if (ParseFunctionBody(F)) {
2391 if (ErrInfo) *ErrInfo = ErrorString;
2395 // Upgrade any old intrinsic calls in the function.
2396 for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
2397 E = UpgradedIntrinsics.end(); I != E; ++I) {
2398 if (I->first != I->second) {
2399 for (Value::use_iterator UI = I->first->use_begin(),
2400 UE = I->first->use_end(); UI != UE; ) {
2401 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
2402 UpgradeIntrinsicCall(CI, I->second);
2410 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
2411 const Function *F = dyn_cast<Function>(GV);
2412 if (!F || F->isDeclaration())
2414 return DeferredFunctionInfo.count(const_cast<Function*>(F));
2417 void BitcodeReader::Dematerialize(GlobalValue *GV) {
2418 Function *F = dyn_cast<Function>(GV);
2419 // If this function isn't dematerializable, this is a noop.
2420 if (!F || !isDematerializable(F))
2423 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
2425 // Just forget the function body, we can remat it later.
2430 bool BitcodeReader::MaterializeModule(Module *M, std::string *ErrInfo) {
2431 assert(M == TheModule &&
2432 "Can only Materialize the Module this BitcodeReader is attached to.");
2433 // Iterate over the module, deserializing any functions that are still on
2435 for (Module::iterator F = TheModule->begin(), E = TheModule->end();
2437 if (F->isMaterializable() &&
2438 Materialize(F, ErrInfo))
2441 // Upgrade any intrinsic calls that slipped through (should not happen!) and
2442 // delete the old functions to clean up. We can't do this unless the entire
2443 // module is materialized because there could always be another function body
2444 // with calls to the old function.
2445 for (std::vector<std::pair<Function*, Function*> >::iterator I =
2446 UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
2447 if (I->first != I->second) {
2448 for (Value::use_iterator UI = I->first->use_begin(),
2449 UE = I->first->use_end(); UI != UE; ) {
2450 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
2451 UpgradeIntrinsicCall(CI, I->second);
2453 if (!I->first->use_empty())
2454 I->first->replaceAllUsesWith(I->second);
2455 I->first->eraseFromParent();
2458 std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
2460 // Check debug info intrinsics.
2461 CheckDebugInfoIntrinsics(TheModule);
2467 //===----------------------------------------------------------------------===//
2468 // External interface
2469 //===----------------------------------------------------------------------===//
2471 /// getLazyBitcodeModule - lazy function-at-a-time loading from a file.
2473 Module *llvm::getLazyBitcodeModule(MemoryBuffer *Buffer,
2474 LLVMContext& Context,
2475 std::string *ErrMsg) {
2476 Module *M = new Module(Buffer->getBufferIdentifier(), Context);
2477 BitcodeReader *R = new BitcodeReader(Buffer, Context);
2478 M->setMaterializer(R);
2479 if (R->ParseBitcodeInto(M)) {
2481 *ErrMsg = R->getErrorString();
2483 delete M; // Also deletes R.
2486 // Have the BitcodeReader dtor delete 'Buffer'.
2487 R->setBufferOwned(true);
2491 /// ParseBitcodeFile - Read the specified bitcode file, returning the module.
2492 /// If an error occurs, return null and fill in *ErrMsg if non-null.
2493 Module *llvm::ParseBitcodeFile(MemoryBuffer *Buffer, LLVMContext& Context,
2494 std::string *ErrMsg){
2495 Module *M = getLazyBitcodeModule(Buffer, Context, ErrMsg);
2498 // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether
2499 // there was an error.
2500 static_cast<BitcodeReader*>(M->getMaterializer())->setBufferOwned(false);
2502 // Read in the entire module, and destroy the BitcodeReader.
2503 if (M->MaterializeAllPermanently(ErrMsg)) {