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;
83 static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
85 default: // Map unknown visibilities to default.
86 case 0: return GlobalValue::DefaultVisibility;
87 case 1: return GlobalValue::HiddenVisibility;
88 case 2: return GlobalValue::ProtectedVisibility;
92 static int GetDecodedCastOpcode(unsigned Val) {
95 case bitc::CAST_TRUNC : return Instruction::Trunc;
96 case bitc::CAST_ZEXT : return Instruction::ZExt;
97 case bitc::CAST_SEXT : return Instruction::SExt;
98 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
99 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
100 case bitc::CAST_UITOFP : return Instruction::UIToFP;
101 case bitc::CAST_SITOFP : return Instruction::SIToFP;
102 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
103 case bitc::CAST_FPEXT : return Instruction::FPExt;
104 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
105 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
106 case bitc::CAST_BITCAST : return Instruction::BitCast;
109 static int GetDecodedBinaryOpcode(unsigned Val, const Type *Ty) {
112 case bitc::BINOP_ADD:
113 return Ty->isFPOrFPVectorTy() ? Instruction::FAdd : Instruction::Add;
114 case bitc::BINOP_SUB:
115 return Ty->isFPOrFPVectorTy() ? Instruction::FSub : Instruction::Sub;
116 case bitc::BINOP_MUL:
117 return Ty->isFPOrFPVectorTy() ? Instruction::FMul : Instruction::Mul;
118 case bitc::BINOP_UDIV: return Instruction::UDiv;
119 case bitc::BINOP_SDIV:
120 return Ty->isFPOrFPVectorTy() ? Instruction::FDiv : Instruction::SDiv;
121 case bitc::BINOP_UREM: return Instruction::URem;
122 case bitc::BINOP_SREM:
123 return Ty->isFPOrFPVectorTy() ? Instruction::FRem : Instruction::SRem;
124 case bitc::BINOP_SHL: return Instruction::Shl;
125 case bitc::BINOP_LSHR: return Instruction::LShr;
126 case bitc::BINOP_ASHR: return Instruction::AShr;
127 case bitc::BINOP_AND: return Instruction::And;
128 case bitc::BINOP_OR: return Instruction::Or;
129 case bitc::BINOP_XOR: return Instruction::Xor;
135 /// @brief A class for maintaining the slot number definition
136 /// as a placeholder for the actual definition for forward constants defs.
137 class ConstantPlaceHolder : public ConstantExpr {
138 ConstantPlaceHolder() ATTRIBUTE_UNUSED; // DO NOT IMPLEMENT
139 void operator=(const ConstantPlaceHolder &) ATTRIBUTE_UNUSED;//NOT IMPLEMENT
141 // allocate space for exactly one operand
142 void *operator new(size_t s) {
143 return User::operator new(s, 1);
145 explicit ConstantPlaceHolder(const Type *Ty, LLVMContext& Context)
146 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
147 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
150 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
151 static inline bool classof(const ConstantPlaceHolder *) { return true; }
152 static bool classof(const Value *V) {
153 return isa<ConstantExpr>(V) &&
154 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
158 /// Provide fast operand accessors
159 //DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
163 // FIXME: can we inherit this from ConstantExpr?
165 struct OperandTraits<ConstantPlaceHolder> : public FixedNumOperandTraits<1> {
170 void BitcodeReaderValueList::AssignValue(Value *V, unsigned Idx) {
179 WeakVH &OldV = ValuePtrs[Idx];
185 // Handle constants and non-constants (e.g. instrs) differently for
187 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
188 ResolveConstants.push_back(std::make_pair(PHC, Idx));
191 // If there was a forward reference to this value, replace it.
192 Value *PrevVal = OldV;
193 OldV->replaceAllUsesWith(V);
199 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
204 if (Value *V = ValuePtrs[Idx]) {
205 assert(Ty == V->getType() && "Type mismatch in constant table!");
206 return cast<Constant>(V);
209 // Create and return a placeholder, which will later be RAUW'd.
210 Constant *C = new ConstantPlaceHolder(Ty, Context);
215 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, const Type *Ty) {
219 if (Value *V = ValuePtrs[Idx]) {
220 assert((Ty == 0 || Ty == V->getType()) && "Type mismatch in value table!");
224 // No type specified, must be invalid reference.
225 if (Ty == 0) return 0;
227 // Create and return a placeholder, which will later be RAUW'd.
228 Value *V = new Argument(Ty);
233 /// ResolveConstantForwardRefs - Once all constants are read, this method bulk
234 /// resolves any forward references. The idea behind this is that we sometimes
235 /// get constants (such as large arrays) which reference *many* forward ref
236 /// constants. Replacing each of these causes a lot of thrashing when
237 /// building/reuniquing the constant. Instead of doing this, we look at all the
238 /// uses and rewrite all the place holders at once for any constant that uses
240 void BitcodeReaderValueList::ResolveConstantForwardRefs() {
241 // Sort the values by-pointer so that they are efficient to look up with a
243 std::sort(ResolveConstants.begin(), ResolveConstants.end());
245 SmallVector<Constant*, 64> NewOps;
247 while (!ResolveConstants.empty()) {
248 Value *RealVal = operator[](ResolveConstants.back().second);
249 Constant *Placeholder = ResolveConstants.back().first;
250 ResolveConstants.pop_back();
252 // Loop over all users of the placeholder, updating them to reference the
253 // new value. If they reference more than one placeholder, update them all
255 while (!Placeholder->use_empty()) {
256 Value::use_iterator UI = Placeholder->use_begin();
259 // If the using object isn't uniqued, just update the operands. This
260 // handles instructions and initializers for global variables.
261 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
262 UI.getUse().set(RealVal);
266 // Otherwise, we have a constant that uses the placeholder. Replace that
267 // constant with a new constant that has *all* placeholder uses updated.
268 Constant *UserC = cast<Constant>(U);
269 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
272 if (!isa<ConstantPlaceHolder>(*I)) {
273 // Not a placeholder reference.
275 } else if (*I == Placeholder) {
276 // Common case is that it just references this one placeholder.
279 // Otherwise, look up the placeholder in ResolveConstants.
280 ResolveConstantsTy::iterator It =
281 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
282 std::pair<Constant*, unsigned>(cast<Constant>(*I),
284 assert(It != ResolveConstants.end() && It->first == *I);
285 NewOp = operator[](It->second);
288 NewOps.push_back(cast<Constant>(NewOp));
291 // Make the new constant.
293 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
294 NewC = ConstantArray::get(UserCA->getType(), &NewOps[0],
296 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
297 NewC = ConstantStruct::get(Context, &NewOps[0], NewOps.size(),
298 UserCS->getType()->isPacked());
299 } else if (ConstantUnion *UserCU = dyn_cast<ConstantUnion>(UserC)) {
300 NewC = ConstantUnion::get(UserCU->getType(), NewOps[0]);
301 } else if (isa<ConstantVector>(UserC)) {
302 NewC = ConstantVector::get(&NewOps[0], NewOps.size());
304 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
305 NewC = cast<ConstantExpr>(UserC)->getWithOperands(&NewOps[0],
309 UserC->replaceAllUsesWith(NewC);
310 UserC->destroyConstant();
314 // Update all ValueHandles, they should be the only users at this point.
315 Placeholder->replaceAllUsesWith(RealVal);
320 void BitcodeReaderMDValueList::AssignValue(Value *V, unsigned Idx) {
329 WeakVH &OldV = MDValuePtrs[Idx];
335 // If there was a forward reference to this value, replace it.
336 Value *PrevVal = OldV;
337 OldV->replaceAllUsesWith(V);
339 // Deleting PrevVal sets Idx value in MDValuePtrs to null. Set new
341 MDValuePtrs[Idx] = V;
344 Value *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
348 if (Value *V = MDValuePtrs[Idx]) {
349 assert(V->getType()->isMetadataTy() && "Type mismatch in value table!");
353 // Create and return a placeholder, which will later be RAUW'd.
354 Value *V = new Argument(Type::getMetadataTy(Context));
355 MDValuePtrs[Idx] = V;
359 const Type *BitcodeReader::getTypeByID(unsigned ID, bool isTypeTable) {
360 // If the TypeID is in range, return it.
361 if (ID < TypeList.size())
362 return TypeList[ID].get();
363 if (!isTypeTable) return 0;
365 // The type table allows forward references. Push as many Opaque types as
366 // needed to get up to ID.
367 while (TypeList.size() <= ID)
368 TypeList.push_back(OpaqueType::get(Context));
369 return TypeList.back().get();
372 //===----------------------------------------------------------------------===//
373 // Functions for parsing blocks from the bitcode file
374 //===----------------------------------------------------------------------===//
376 bool BitcodeReader::ParseAttributeBlock() {
377 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
378 return Error("Malformed block record");
380 if (!MAttributes.empty())
381 return Error("Multiple PARAMATTR blocks found!");
383 SmallVector<uint64_t, 64> Record;
385 SmallVector<AttributeWithIndex, 8> Attrs;
387 // Read all the records.
389 unsigned Code = Stream.ReadCode();
390 if (Code == bitc::END_BLOCK) {
391 if (Stream.ReadBlockEnd())
392 return Error("Error at end of PARAMATTR block");
396 if (Code == bitc::ENTER_SUBBLOCK) {
397 // No known subblocks, always skip them.
398 Stream.ReadSubBlockID();
399 if (Stream.SkipBlock())
400 return Error("Malformed block record");
404 if (Code == bitc::DEFINE_ABBREV) {
405 Stream.ReadAbbrevRecord();
411 switch (Stream.ReadRecord(Code, Record)) {
412 default: // Default behavior: ignore.
414 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [paramidx0, attr0, ...]
415 if (Record.size() & 1)
416 return Error("Invalid ENTRY record");
418 // FIXME : Remove this autoupgrade code in LLVM 3.0.
419 // If Function attributes are using index 0 then transfer them
420 // to index ~0. Index 0 is used for return value attributes but used to be
421 // used for function attributes.
422 Attributes RetAttribute = Attribute::None;
423 Attributes FnAttribute = Attribute::None;
424 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
425 // FIXME: remove in LLVM 3.0
426 // The alignment is stored as a 16-bit raw value from bits 31--16.
427 // We shift the bits above 31 down by 11 bits.
429 unsigned Alignment = (Record[i+1] & (0xffffull << 16)) >> 16;
430 if (Alignment && !isPowerOf2_32(Alignment))
431 return Error("Alignment is not a power of two.");
433 Attributes ReconstitutedAttr = Record[i+1] & 0xffff;
435 ReconstitutedAttr |= Attribute::constructAlignmentFromInt(Alignment);
436 ReconstitutedAttr |= (Record[i+1] & (0xffffull << 32)) >> 11;
437 Record[i+1] = ReconstitutedAttr;
440 RetAttribute = Record[i+1];
441 else if (Record[i] == ~0U)
442 FnAttribute = Record[i+1];
445 unsigned OldRetAttrs = (Attribute::NoUnwind|Attribute::NoReturn|
446 Attribute::ReadOnly|Attribute::ReadNone);
448 if (FnAttribute == Attribute::None && RetAttribute != Attribute::None &&
449 (RetAttribute & OldRetAttrs) != 0) {
450 if (FnAttribute == Attribute::None) { // add a slot so they get added.
451 Record.push_back(~0U);
455 FnAttribute |= RetAttribute & OldRetAttrs;
456 RetAttribute &= ~OldRetAttrs;
459 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
460 if (Record[i] == 0) {
461 if (RetAttribute != Attribute::None)
462 Attrs.push_back(AttributeWithIndex::get(0, RetAttribute));
463 } else if (Record[i] == ~0U) {
464 if (FnAttribute != Attribute::None)
465 Attrs.push_back(AttributeWithIndex::get(~0U, FnAttribute));
466 } else if (Record[i+1] != Attribute::None)
467 Attrs.push_back(AttributeWithIndex::get(Record[i], Record[i+1]));
470 MAttributes.push_back(AttrListPtr::get(Attrs.begin(), Attrs.end()));
479 bool BitcodeReader::ParseTypeTable() {
480 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID))
481 return Error("Malformed block record");
483 if (!TypeList.empty())
484 return Error("Multiple TYPE_BLOCKs found!");
486 SmallVector<uint64_t, 64> Record;
487 unsigned NumRecords = 0;
489 // Read all the records for this type table.
491 unsigned Code = Stream.ReadCode();
492 if (Code == bitc::END_BLOCK) {
493 if (NumRecords != TypeList.size())
494 return Error("Invalid type forward reference in TYPE_BLOCK");
495 if (Stream.ReadBlockEnd())
496 return Error("Error at end of type table block");
500 if (Code == bitc::ENTER_SUBBLOCK) {
501 // No known subblocks, always skip them.
502 Stream.ReadSubBlockID();
503 if (Stream.SkipBlock())
504 return Error("Malformed block record");
508 if (Code == bitc::DEFINE_ABBREV) {
509 Stream.ReadAbbrevRecord();
515 const Type *ResultTy = 0;
516 switch (Stream.ReadRecord(Code, Record)) {
517 default: // Default behavior: unknown type.
520 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
521 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
522 // type list. This allows us to reserve space.
523 if (Record.size() < 1)
524 return Error("Invalid TYPE_CODE_NUMENTRY record");
525 TypeList.reserve(Record[0]);
527 case bitc::TYPE_CODE_VOID: // VOID
528 ResultTy = Type::getVoidTy(Context);
530 case bitc::TYPE_CODE_FLOAT: // FLOAT
531 ResultTy = Type::getFloatTy(Context);
533 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
534 ResultTy = Type::getDoubleTy(Context);
536 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
537 ResultTy = Type::getX86_FP80Ty(Context);
539 case bitc::TYPE_CODE_FP128: // FP128
540 ResultTy = Type::getFP128Ty(Context);
542 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
543 ResultTy = Type::getPPC_FP128Ty(Context);
545 case bitc::TYPE_CODE_LABEL: // LABEL
546 ResultTy = Type::getLabelTy(Context);
548 case bitc::TYPE_CODE_OPAQUE: // OPAQUE
551 case bitc::TYPE_CODE_METADATA: // METADATA
552 ResultTy = Type::getMetadataTy(Context);
554 case bitc::TYPE_CODE_INTEGER: // INTEGER: [width]
555 if (Record.size() < 1)
556 return Error("Invalid Integer type record");
558 ResultTy = IntegerType::get(Context, Record[0]);
560 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
561 // [pointee type, address space]
562 if (Record.size() < 1)
563 return Error("Invalid POINTER type record");
564 unsigned AddressSpace = 0;
565 if (Record.size() == 2)
566 AddressSpace = Record[1];
567 ResultTy = PointerType::get(getTypeByID(Record[0], true),
571 case bitc::TYPE_CODE_FUNCTION: {
572 // FIXME: attrid is dead, remove it in LLVM 3.0
573 // FUNCTION: [vararg, attrid, retty, paramty x N]
574 if (Record.size() < 3)
575 return Error("Invalid FUNCTION type record");
576 std::vector<const Type*> ArgTys;
577 for (unsigned i = 3, e = Record.size(); i != e; ++i)
578 ArgTys.push_back(getTypeByID(Record[i], true));
580 ResultTy = FunctionType::get(getTypeByID(Record[2], true), ArgTys,
584 case bitc::TYPE_CODE_STRUCT: { // STRUCT: [ispacked, eltty x N]
585 if (Record.size() < 1)
586 return Error("Invalid STRUCT type record");
587 std::vector<const Type*> EltTys;
588 for (unsigned i = 1, e = Record.size(); i != e; ++i)
589 EltTys.push_back(getTypeByID(Record[i], true));
590 ResultTy = StructType::get(Context, EltTys, Record[0]);
593 case bitc::TYPE_CODE_UNION: { // UNION: [eltty x N]
594 SmallVector<const Type*, 8> EltTys;
595 for (unsigned i = 0, e = Record.size(); i != e; ++i)
596 EltTys.push_back(getTypeByID(Record[i], true));
597 ResultTy = UnionType::get(&EltTys[0], EltTys.size());
600 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
601 if (Record.size() < 2)
602 return Error("Invalid ARRAY type record");
603 ResultTy = ArrayType::get(getTypeByID(Record[1], true), Record[0]);
605 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
606 if (Record.size() < 2)
607 return Error("Invalid VECTOR type record");
608 ResultTy = VectorType::get(getTypeByID(Record[1], true), Record[0]);
612 if (NumRecords == TypeList.size()) {
613 // If this is a new type slot, just append it.
614 TypeList.push_back(ResultTy ? ResultTy : OpaqueType::get(Context));
616 } else if (ResultTy == 0) {
617 // Otherwise, this was forward referenced, so an opaque type was created,
618 // but the result type is actually just an opaque. Leave the one we
619 // created previously.
622 // Otherwise, this was forward referenced, so an opaque type was created.
623 // Resolve the opaque type to the real type now.
624 assert(NumRecords < TypeList.size() && "Typelist imbalance");
625 const OpaqueType *OldTy = cast<OpaqueType>(TypeList[NumRecords++].get());
627 // Don't directly push the new type on the Tab. Instead we want to replace
628 // the opaque type we previously inserted with the new concrete value. The
629 // refinement from the abstract (opaque) type to the new type causes all
630 // uses of the abstract type to use the concrete type (NewTy). This will
631 // also cause the opaque type to be deleted.
632 const_cast<OpaqueType*>(OldTy)->refineAbstractTypeTo(ResultTy);
634 // This should have replaced the old opaque type with the new type in the
635 // value table... or with a preexisting type that was already in the
636 // system. Let's just make sure it did.
637 assert(TypeList[NumRecords-1].get() != OldTy &&
638 "refineAbstractType didn't work!");
644 bool BitcodeReader::ParseTypeSymbolTable() {
645 if (Stream.EnterSubBlock(bitc::TYPE_SYMTAB_BLOCK_ID))
646 return Error("Malformed block record");
648 SmallVector<uint64_t, 64> Record;
650 // Read all the records for this type table.
651 std::string TypeName;
653 unsigned Code = Stream.ReadCode();
654 if (Code == bitc::END_BLOCK) {
655 if (Stream.ReadBlockEnd())
656 return Error("Error at end of type symbol table block");
660 if (Code == bitc::ENTER_SUBBLOCK) {
661 // No known subblocks, always skip them.
662 Stream.ReadSubBlockID();
663 if (Stream.SkipBlock())
664 return Error("Malformed block record");
668 if (Code == bitc::DEFINE_ABBREV) {
669 Stream.ReadAbbrevRecord();
675 switch (Stream.ReadRecord(Code, Record)) {
676 default: // Default behavior: unknown type.
678 case bitc::TST_CODE_ENTRY: // TST_ENTRY: [typeid, namechar x N]
679 if (ConvertToString(Record, 1, TypeName))
680 return Error("Invalid TST_ENTRY record");
681 unsigned TypeID = Record[0];
682 if (TypeID >= TypeList.size())
683 return Error("Invalid Type ID in TST_ENTRY record");
685 TheModule->addTypeName(TypeName, TypeList[TypeID].get());
692 bool BitcodeReader::ParseValueSymbolTable() {
693 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
694 return Error("Malformed block record");
696 SmallVector<uint64_t, 64> Record;
698 // Read all the records for this value table.
699 SmallString<128> ValueName;
701 unsigned Code = Stream.ReadCode();
702 if (Code == bitc::END_BLOCK) {
703 if (Stream.ReadBlockEnd())
704 return Error("Error at end of value symbol table block");
707 if (Code == bitc::ENTER_SUBBLOCK) {
708 // No known subblocks, always skip them.
709 Stream.ReadSubBlockID();
710 if (Stream.SkipBlock())
711 return Error("Malformed block record");
715 if (Code == bitc::DEFINE_ABBREV) {
716 Stream.ReadAbbrevRecord();
722 switch (Stream.ReadRecord(Code, Record)) {
723 default: // Default behavior: unknown type.
725 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
726 if (ConvertToString(Record, 1, ValueName))
727 return Error("Invalid VST_ENTRY record");
728 unsigned ValueID = Record[0];
729 if (ValueID >= ValueList.size())
730 return Error("Invalid Value ID in VST_ENTRY record");
731 Value *V = ValueList[ValueID];
733 V->setName(StringRef(ValueName.data(), ValueName.size()));
737 case bitc::VST_CODE_BBENTRY: {
738 if (ConvertToString(Record, 1, ValueName))
739 return Error("Invalid VST_BBENTRY record");
740 BasicBlock *BB = getBasicBlock(Record[0]);
742 return Error("Invalid BB ID in VST_BBENTRY record");
744 BB->setName(StringRef(ValueName.data(), ValueName.size()));
752 bool BitcodeReader::ParseMetadata() {
753 unsigned NextMDValueNo = MDValueList.size();
755 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
756 return Error("Malformed block record");
758 SmallVector<uint64_t, 64> Record;
760 // Read all the records.
762 unsigned Code = Stream.ReadCode();
763 if (Code == bitc::END_BLOCK) {
764 if (Stream.ReadBlockEnd())
765 return Error("Error at end of PARAMATTR block");
769 if (Code == bitc::ENTER_SUBBLOCK) {
770 // No known subblocks, always skip them.
771 Stream.ReadSubBlockID();
772 if (Stream.SkipBlock())
773 return Error("Malformed block record");
777 if (Code == bitc::DEFINE_ABBREV) {
778 Stream.ReadAbbrevRecord();
782 bool IsFunctionLocal = false;
785 switch (Stream.ReadRecord(Code, Record)) {
786 default: // Default behavior: ignore.
788 case bitc::METADATA_NAME: {
789 // Read named of the named metadata.
790 unsigned NameLength = Record.size();
792 Name.resize(NameLength);
793 for (unsigned i = 0; i != NameLength; ++i)
796 Code = Stream.ReadCode();
798 // METADATA_NAME is always followed by METADATA_NAMED_NODE.
799 if (Stream.ReadRecord(Code, Record) != bitc::METADATA_NAMED_NODE)
800 assert ( 0 && "Inavlid Named Metadata record");
802 // Read named metadata elements.
803 unsigned Size = Record.size();
804 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
805 for (unsigned i = 0; i != Size; ++i) {
806 MDNode *MD = dyn_cast<MDNode>(MDValueList.getValueFwdRef(Record[i]));
808 return Error("Malformed metadata record");
813 case bitc::METADATA_FN_NODE:
814 IsFunctionLocal = true;
816 case bitc::METADATA_NODE: {
817 if (Record.size() % 2 == 1)
818 return Error("Invalid METADATA_NODE record");
820 unsigned Size = Record.size();
821 SmallVector<Value*, 8> Elts;
822 for (unsigned i = 0; i != Size; i += 2) {
823 const Type *Ty = getTypeByID(Record[i], false);
824 if (Ty->isMetadataTy())
825 Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
826 else if (!Ty->isVoidTy())
827 Elts.push_back(ValueList.getValueFwdRef(Record[i+1], Ty));
829 Elts.push_back(NULL);
831 Value *V = MDNode::getWhenValsUnresolved(Context,
832 Elts.data(), Elts.size(),
834 IsFunctionLocal = false;
835 MDValueList.AssignValue(V, NextMDValueNo++);
838 case bitc::METADATA_STRING: {
839 unsigned MDStringLength = Record.size();
840 SmallString<8> String;
841 String.resize(MDStringLength);
842 for (unsigned i = 0; i != MDStringLength; ++i)
843 String[i] = Record[i];
844 Value *V = MDString::get(Context,
845 StringRef(String.data(), String.size()));
846 MDValueList.AssignValue(V, NextMDValueNo++);
849 case bitc::METADATA_KIND: {
850 unsigned RecordLength = Record.size();
851 if (Record.empty() || RecordLength < 2)
852 return Error("Invalid METADATA_KIND record");
854 Name.resize(RecordLength-1);
855 unsigned Kind = Record[0];
856 for (unsigned i = 1; i != RecordLength; ++i)
857 Name[i-1] = Record[i];
859 unsigned NewKind = TheModule->getMDKindID(Name.str());
860 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
861 return Error("Conflicting METADATA_KIND records");
868 /// DecodeSignRotatedValue - Decode a signed value stored with the sign bit in
869 /// the LSB for dense VBR encoding.
870 static uint64_t DecodeSignRotatedValue(uint64_t V) {
875 // There is no such thing as -0 with integers. "-0" really means MININT.
879 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
880 /// values and aliases that we can.
881 bool BitcodeReader::ResolveGlobalAndAliasInits() {
882 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
883 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
885 GlobalInitWorklist.swap(GlobalInits);
886 AliasInitWorklist.swap(AliasInits);
888 while (!GlobalInitWorklist.empty()) {
889 unsigned ValID = GlobalInitWorklist.back().second;
890 if (ValID >= ValueList.size()) {
891 // Not ready to resolve this yet, it requires something later in the file.
892 GlobalInits.push_back(GlobalInitWorklist.back());
894 if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
895 GlobalInitWorklist.back().first->setInitializer(C);
897 return Error("Global variable initializer is not a constant!");
899 GlobalInitWorklist.pop_back();
902 while (!AliasInitWorklist.empty()) {
903 unsigned ValID = AliasInitWorklist.back().second;
904 if (ValID >= ValueList.size()) {
905 AliasInits.push_back(AliasInitWorklist.back());
907 if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
908 AliasInitWorklist.back().first->setAliasee(C);
910 return Error("Alias initializer is not a constant!");
912 AliasInitWorklist.pop_back();
917 bool BitcodeReader::ParseConstants() {
918 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
919 return Error("Malformed block record");
921 SmallVector<uint64_t, 64> Record;
923 // Read all the records for this value table.
924 const Type *CurTy = Type::getInt32Ty(Context);
925 unsigned NextCstNo = ValueList.size();
927 unsigned Code = Stream.ReadCode();
928 if (Code == bitc::END_BLOCK)
931 if (Code == bitc::ENTER_SUBBLOCK) {
932 // No known subblocks, always skip them.
933 Stream.ReadSubBlockID();
934 if (Stream.SkipBlock())
935 return Error("Malformed block record");
939 if (Code == bitc::DEFINE_ABBREV) {
940 Stream.ReadAbbrevRecord();
947 unsigned BitCode = Stream.ReadRecord(Code, Record);
949 default: // Default behavior: unknown constant
950 case bitc::CST_CODE_UNDEF: // UNDEF
951 V = UndefValue::get(CurTy);
953 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
955 return Error("Malformed CST_SETTYPE record");
956 if (Record[0] >= TypeList.size())
957 return Error("Invalid Type ID in CST_SETTYPE record");
958 CurTy = TypeList[Record[0]];
959 continue; // Skip the ValueList manipulation.
960 case bitc::CST_CODE_NULL: // NULL
961 V = Constant::getNullValue(CurTy);
963 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
964 if (!CurTy->isIntegerTy() || Record.empty())
965 return Error("Invalid CST_INTEGER record");
966 V = ConstantInt::get(CurTy, DecodeSignRotatedValue(Record[0]));
968 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
969 if (!CurTy->isIntegerTy() || Record.empty())
970 return Error("Invalid WIDE_INTEGER record");
972 unsigned NumWords = Record.size();
973 SmallVector<uint64_t, 8> Words;
974 Words.resize(NumWords);
975 for (unsigned i = 0; i != NumWords; ++i)
976 Words[i] = DecodeSignRotatedValue(Record[i]);
977 V = ConstantInt::get(Context,
978 APInt(cast<IntegerType>(CurTy)->getBitWidth(),
979 NumWords, &Words[0]));
982 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
984 return Error("Invalid FLOAT record");
985 if (CurTy->isFloatTy())
986 V = ConstantFP::get(Context, APFloat(APInt(32, (uint32_t)Record[0])));
987 else if (CurTy->isDoubleTy())
988 V = ConstantFP::get(Context, APFloat(APInt(64, Record[0])));
989 else if (CurTy->isX86_FP80Ty()) {
990 // Bits are not stored the same way as a normal i80 APInt, compensate.
991 uint64_t Rearrange[2];
992 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
993 Rearrange[1] = Record[0] >> 48;
994 V = ConstantFP::get(Context, APFloat(APInt(80, 2, Rearrange)));
995 } else if (CurTy->isFP128Ty())
996 V = ConstantFP::get(Context, APFloat(APInt(128, 2, &Record[0]), true));
997 else if (CurTy->isPPC_FP128Ty())
998 V = ConstantFP::get(Context, APFloat(APInt(128, 2, &Record[0])));
1000 V = UndefValue::get(CurTy);
1004 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
1006 return Error("Invalid CST_AGGREGATE record");
1008 unsigned Size = Record.size();
1009 std::vector<Constant*> Elts;
1011 if (const StructType *STy = dyn_cast<StructType>(CurTy)) {
1012 for (unsigned i = 0; i != Size; ++i)
1013 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
1014 STy->getElementType(i)));
1015 V = ConstantStruct::get(STy, Elts);
1016 } else if (const UnionType *UnTy = dyn_cast<UnionType>(CurTy)) {
1017 uint64_t Index = Record[0];
1018 Constant *Val = ValueList.getConstantFwdRef(Record[1],
1019 UnTy->getElementType(Index));
1020 V = ConstantUnion::get(UnTy, Val);
1021 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
1022 const Type *EltTy = ATy->getElementType();
1023 for (unsigned i = 0; i != Size; ++i)
1024 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1025 V = ConstantArray::get(ATy, Elts);
1026 } else if (const VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
1027 const Type *EltTy = VTy->getElementType();
1028 for (unsigned i = 0; i != Size; ++i)
1029 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1030 V = ConstantVector::get(Elts);
1032 V = UndefValue::get(CurTy);
1036 case bitc::CST_CODE_STRING: { // STRING: [values]
1038 return Error("Invalid CST_AGGREGATE record");
1040 const ArrayType *ATy = cast<ArrayType>(CurTy);
1041 const Type *EltTy = ATy->getElementType();
1043 unsigned Size = Record.size();
1044 std::vector<Constant*> Elts;
1045 for (unsigned i = 0; i != Size; ++i)
1046 Elts.push_back(ConstantInt::get(EltTy, Record[i]));
1047 V = ConstantArray::get(ATy, Elts);
1050 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
1052 return Error("Invalid CST_AGGREGATE record");
1054 const ArrayType *ATy = cast<ArrayType>(CurTy);
1055 const Type *EltTy = ATy->getElementType();
1057 unsigned Size = Record.size();
1058 std::vector<Constant*> Elts;
1059 for (unsigned i = 0; i != Size; ++i)
1060 Elts.push_back(ConstantInt::get(EltTy, Record[i]));
1061 Elts.push_back(Constant::getNullValue(EltTy));
1062 V = ConstantArray::get(ATy, Elts);
1065 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
1066 if (Record.size() < 3) return Error("Invalid CE_BINOP record");
1067 int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
1069 V = UndefValue::get(CurTy); // Unknown binop.
1071 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
1072 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
1074 if (Record.size() >= 4) {
1075 if (Opc == Instruction::Add ||
1076 Opc == Instruction::Sub ||
1077 Opc == Instruction::Mul) {
1078 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1079 Flags |= OverflowingBinaryOperator::NoSignedWrap;
1080 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1081 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
1082 } else if (Opc == Instruction::SDiv) {
1083 if (Record[3] & (1 << bitc::SDIV_EXACT))
1084 Flags |= SDivOperator::IsExact;
1087 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
1091 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
1092 if (Record.size() < 3) return Error("Invalid CE_CAST record");
1093 int Opc = GetDecodedCastOpcode(Record[0]);
1095 V = UndefValue::get(CurTy); // Unknown cast.
1097 const Type *OpTy = getTypeByID(Record[1]);
1098 if (!OpTy) return Error("Invalid CE_CAST record");
1099 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
1100 V = ConstantExpr::getCast(Opc, Op, CurTy);
1104 case bitc::CST_CODE_CE_INBOUNDS_GEP:
1105 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
1106 if (Record.size() & 1) return Error("Invalid CE_GEP record");
1107 SmallVector<Constant*, 16> Elts;
1108 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1109 const Type *ElTy = getTypeByID(Record[i]);
1110 if (!ElTy) return Error("Invalid CE_GEP record");
1111 Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
1113 if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)
1114 V = ConstantExpr::getInBoundsGetElementPtr(Elts[0], &Elts[1],
1117 V = ConstantExpr::getGetElementPtr(Elts[0], &Elts[1],
1121 case bitc::CST_CODE_CE_SELECT: // CE_SELECT: [opval#, opval#, opval#]
1122 if (Record.size() < 3) return Error("Invalid CE_SELECT record");
1123 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
1124 Type::getInt1Ty(Context)),
1125 ValueList.getConstantFwdRef(Record[1],CurTy),
1126 ValueList.getConstantFwdRef(Record[2],CurTy));
1128 case bitc::CST_CODE_CE_EXTRACTELT: { // CE_EXTRACTELT: [opty, opval, opval]
1129 if (Record.size() < 3) return Error("Invalid CE_EXTRACTELT record");
1130 const VectorType *OpTy =
1131 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1132 if (OpTy == 0) return Error("Invalid CE_EXTRACTELT record");
1133 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1134 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1135 V = ConstantExpr::getExtractElement(Op0, Op1);
1138 case bitc::CST_CODE_CE_INSERTELT: { // CE_INSERTELT: [opval, opval, opval]
1139 const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1140 if (Record.size() < 3 || OpTy == 0)
1141 return Error("Invalid CE_INSERTELT record");
1142 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1143 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
1144 OpTy->getElementType());
1145 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1146 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
1149 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
1150 const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1151 if (Record.size() < 3 || OpTy == 0)
1152 return Error("Invalid CE_SHUFFLEVEC record");
1153 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1154 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
1155 const Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1156 OpTy->getNumElements());
1157 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
1158 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1161 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
1162 const VectorType *RTy = dyn_cast<VectorType>(CurTy);
1163 const VectorType *OpTy = dyn_cast<VectorType>(getTypeByID(Record[0]));
1164 if (Record.size() < 4 || RTy == 0 || OpTy == 0)
1165 return Error("Invalid CE_SHUFVEC_EX record");
1166 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1167 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1168 const Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1169 RTy->getNumElements());
1170 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
1171 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1174 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
1175 if (Record.size() < 4) return Error("Invalid CE_CMP record");
1176 const Type *OpTy = getTypeByID(Record[0]);
1177 if (OpTy == 0) return Error("Invalid CE_CMP record");
1178 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1179 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1181 if (OpTy->isFPOrFPVectorTy())
1182 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
1184 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
1187 case bitc::CST_CODE_INLINEASM: {
1188 if (Record.size() < 2) return Error("Invalid INLINEASM record");
1189 std::string AsmStr, ConstrStr;
1190 bool HasSideEffects = Record[0] & 1;
1191 bool IsAlignStack = Record[0] >> 1;
1192 unsigned AsmStrSize = Record[1];
1193 if (2+AsmStrSize >= Record.size())
1194 return Error("Invalid INLINEASM record");
1195 unsigned ConstStrSize = Record[2+AsmStrSize];
1196 if (3+AsmStrSize+ConstStrSize > Record.size())
1197 return Error("Invalid INLINEASM record");
1199 for (unsigned i = 0; i != AsmStrSize; ++i)
1200 AsmStr += (char)Record[2+i];
1201 for (unsigned i = 0; i != ConstStrSize; ++i)
1202 ConstrStr += (char)Record[3+AsmStrSize+i];
1203 const PointerType *PTy = cast<PointerType>(CurTy);
1204 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1205 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
1208 case bitc::CST_CODE_BLOCKADDRESS:{
1209 if (Record.size() < 3) return Error("Invalid CE_BLOCKADDRESS record");
1210 const Type *FnTy = getTypeByID(Record[0]);
1211 if (FnTy == 0) return Error("Invalid CE_BLOCKADDRESS record");
1213 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
1214 if (Fn == 0) return Error("Invalid CE_BLOCKADDRESS record");
1216 GlobalVariable *FwdRef = new GlobalVariable(*Fn->getParent(),
1217 Type::getInt8Ty(Context),
1218 false, GlobalValue::InternalLinkage,
1220 BlockAddrFwdRefs[Fn].push_back(std::make_pair(Record[2], FwdRef));
1226 ValueList.AssignValue(V, NextCstNo);
1230 if (NextCstNo != ValueList.size())
1231 return Error("Invalid constant reference!");
1233 if (Stream.ReadBlockEnd())
1234 return Error("Error at end of constants block");
1236 // Once all the constants have been read, go through and resolve forward
1238 ValueList.ResolveConstantForwardRefs();
1242 /// RememberAndSkipFunctionBody - When we see the block for a function body,
1243 /// remember where it is and then skip it. This lets us lazily deserialize the
1245 bool BitcodeReader::RememberAndSkipFunctionBody() {
1246 // Get the function we are talking about.
1247 if (FunctionsWithBodies.empty())
1248 return Error("Insufficient function protos");
1250 Function *Fn = FunctionsWithBodies.back();
1251 FunctionsWithBodies.pop_back();
1253 // Save the current stream state.
1254 uint64_t CurBit = Stream.GetCurrentBitNo();
1255 DeferredFunctionInfo[Fn] = CurBit;
1257 // Skip over the function block for now.
1258 if (Stream.SkipBlock())
1259 return Error("Malformed block record");
1263 bool BitcodeReader::ParseModule() {
1264 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
1265 return Error("Malformed block record");
1267 SmallVector<uint64_t, 64> Record;
1268 std::vector<std::string> SectionTable;
1269 std::vector<std::string> GCTable;
1271 // Read all the records for this module.
1272 while (!Stream.AtEndOfStream()) {
1273 unsigned Code = Stream.ReadCode();
1274 if (Code == bitc::END_BLOCK) {
1275 if (Stream.ReadBlockEnd())
1276 return Error("Error at end of module block");
1278 // Patch the initializers for globals and aliases up.
1279 ResolveGlobalAndAliasInits();
1280 if (!GlobalInits.empty() || !AliasInits.empty())
1281 return Error("Malformed global initializer set");
1282 if (!FunctionsWithBodies.empty())
1283 return Error("Too few function bodies found");
1285 // Look for intrinsic functions which need to be upgraded at some point
1286 for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
1289 if (UpgradeIntrinsicFunction(FI, NewFn))
1290 UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
1293 // Force deallocation of memory for these vectors to favor the client that
1294 // want lazy deserialization.
1295 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
1296 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
1297 std::vector<Function*>().swap(FunctionsWithBodies);
1301 if (Code == bitc::ENTER_SUBBLOCK) {
1302 switch (Stream.ReadSubBlockID()) {
1303 default: // Skip unknown content.
1304 if (Stream.SkipBlock())
1305 return Error("Malformed block record");
1307 case bitc::BLOCKINFO_BLOCK_ID:
1308 if (Stream.ReadBlockInfoBlock())
1309 return Error("Malformed BlockInfoBlock");
1311 case bitc::PARAMATTR_BLOCK_ID:
1312 if (ParseAttributeBlock())
1315 case bitc::TYPE_BLOCK_ID:
1316 if (ParseTypeTable())
1319 case bitc::TYPE_SYMTAB_BLOCK_ID:
1320 if (ParseTypeSymbolTable())
1323 case bitc::VALUE_SYMTAB_BLOCK_ID:
1324 if (ParseValueSymbolTable())
1327 case bitc::CONSTANTS_BLOCK_ID:
1328 if (ParseConstants() || ResolveGlobalAndAliasInits())
1331 case bitc::METADATA_BLOCK_ID:
1332 if (ParseMetadata())
1335 case bitc::FUNCTION_BLOCK_ID:
1336 // If this is the first function body we've seen, reverse the
1337 // FunctionsWithBodies list.
1338 if (!HasReversedFunctionsWithBodies) {
1339 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
1340 HasReversedFunctionsWithBodies = true;
1343 if (RememberAndSkipFunctionBody())
1350 if (Code == bitc::DEFINE_ABBREV) {
1351 Stream.ReadAbbrevRecord();
1356 switch (Stream.ReadRecord(Code, Record)) {
1357 default: break; // Default behavior, ignore unknown content.
1358 case bitc::MODULE_CODE_VERSION: // VERSION: [version#]
1359 if (Record.size() < 1)
1360 return Error("Malformed MODULE_CODE_VERSION");
1361 // Only version #0 is supported so far.
1363 return Error("Unknown bitstream version!");
1365 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
1367 if (ConvertToString(Record, 0, S))
1368 return Error("Invalid MODULE_CODE_TRIPLE record");
1369 TheModule->setTargetTriple(S);
1372 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
1374 if (ConvertToString(Record, 0, S))
1375 return Error("Invalid MODULE_CODE_DATALAYOUT record");
1376 TheModule->setDataLayout(S);
1379 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
1381 if (ConvertToString(Record, 0, S))
1382 return Error("Invalid MODULE_CODE_ASM record");
1383 TheModule->setModuleInlineAsm(S);
1386 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
1388 if (ConvertToString(Record, 0, S))
1389 return Error("Invalid MODULE_CODE_DEPLIB record");
1390 TheModule->addLibrary(S);
1393 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
1395 if (ConvertToString(Record, 0, S))
1396 return Error("Invalid MODULE_CODE_SECTIONNAME record");
1397 SectionTable.push_back(S);
1400 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
1402 if (ConvertToString(Record, 0, S))
1403 return Error("Invalid MODULE_CODE_GCNAME record");
1404 GCTable.push_back(S);
1407 // GLOBALVAR: [pointer type, isconst, initid,
1408 // linkage, alignment, section, visibility, threadlocal]
1409 case bitc::MODULE_CODE_GLOBALVAR: {
1410 if (Record.size() < 6)
1411 return Error("Invalid MODULE_CODE_GLOBALVAR record");
1412 const Type *Ty = getTypeByID(Record[0]);
1413 if (!Ty->isPointerTy())
1414 return Error("Global not a pointer type!");
1415 unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
1416 Ty = cast<PointerType>(Ty)->getElementType();
1418 bool isConstant = Record[1];
1419 GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
1420 unsigned Alignment = (1 << Record[4]) >> 1;
1421 std::string Section;
1423 if (Record[5]-1 >= SectionTable.size())
1424 return Error("Invalid section ID");
1425 Section = SectionTable[Record[5]-1];
1427 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
1428 if (Record.size() > 6)
1429 Visibility = GetDecodedVisibility(Record[6]);
1430 bool isThreadLocal = false;
1431 if (Record.size() > 7)
1432 isThreadLocal = Record[7];
1434 GlobalVariable *NewGV =
1435 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, 0, "", 0,
1436 isThreadLocal, AddressSpace);
1437 NewGV->setAlignment(Alignment);
1438 if (!Section.empty())
1439 NewGV->setSection(Section);
1440 NewGV->setVisibility(Visibility);
1441 NewGV->setThreadLocal(isThreadLocal);
1443 ValueList.push_back(NewGV);
1445 // Remember which value to use for the global initializer.
1446 if (unsigned InitID = Record[2])
1447 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
1450 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
1451 // alignment, section, visibility, gc]
1452 case bitc::MODULE_CODE_FUNCTION: {
1453 if (Record.size() < 8)
1454 return Error("Invalid MODULE_CODE_FUNCTION record");
1455 const Type *Ty = getTypeByID(Record[0]);
1456 if (!Ty->isPointerTy())
1457 return Error("Function not a pointer type!");
1458 const FunctionType *FTy =
1459 dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1461 return Error("Function not a pointer to function type!");
1463 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
1466 Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
1467 bool isProto = Record[2];
1468 Func->setLinkage(GetDecodedLinkage(Record[3]));
1469 Func->setAttributes(getAttributes(Record[4]));
1471 Func->setAlignment((1 << Record[5]) >> 1);
1473 if (Record[6]-1 >= SectionTable.size())
1474 return Error("Invalid section ID");
1475 Func->setSection(SectionTable[Record[6]-1]);
1477 Func->setVisibility(GetDecodedVisibility(Record[7]));
1478 if (Record.size() > 8 && Record[8]) {
1479 if (Record[8]-1 > GCTable.size())
1480 return Error("Invalid GC ID");
1481 Func->setGC(GCTable[Record[8]-1].c_str());
1483 ValueList.push_back(Func);
1485 // If this is a function with a body, remember the prototype we are
1486 // creating now, so that we can match up the body with them later.
1488 FunctionsWithBodies.push_back(Func);
1491 // ALIAS: [alias type, aliasee val#, linkage]
1492 // ALIAS: [alias type, aliasee val#, linkage, visibility]
1493 case bitc::MODULE_CODE_ALIAS: {
1494 if (Record.size() < 3)
1495 return Error("Invalid MODULE_ALIAS record");
1496 const Type *Ty = getTypeByID(Record[0]);
1497 if (!Ty->isPointerTy())
1498 return Error("Function not a pointer type!");
1500 GlobalAlias *NewGA = new GlobalAlias(Ty, GetDecodedLinkage(Record[2]),
1502 // Old bitcode files didn't have visibility field.
1503 if (Record.size() > 3)
1504 NewGA->setVisibility(GetDecodedVisibility(Record[3]));
1505 ValueList.push_back(NewGA);
1506 AliasInits.push_back(std::make_pair(NewGA, Record[1]));
1509 /// MODULE_CODE_PURGEVALS: [numvals]
1510 case bitc::MODULE_CODE_PURGEVALS:
1511 // Trim down the value list to the specified size.
1512 if (Record.size() < 1 || Record[0] > ValueList.size())
1513 return Error("Invalid MODULE_PURGEVALS record");
1514 ValueList.shrinkTo(Record[0]);
1520 return Error("Premature end of bitstream");
1523 bool BitcodeReader::ParseBitcodeInto(Module *M) {
1526 unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
1527 unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
1529 if (Buffer->getBufferSize() & 3) {
1530 if (!isRawBitcode(BufPtr, BufEnd) && !isBitcodeWrapper(BufPtr, BufEnd))
1531 return Error("Invalid bitcode signature");
1533 return Error("Bitcode stream should be a multiple of 4 bytes in length");
1536 // If we have a wrapper header, parse it and ignore the non-bc file contents.
1537 // The magic number is 0x0B17C0DE stored in little endian.
1538 if (isBitcodeWrapper(BufPtr, BufEnd))
1539 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd))
1540 return Error("Invalid bitcode wrapper header");
1542 StreamFile.init(BufPtr, BufEnd);
1543 Stream.init(StreamFile);
1545 // Sniff for the signature.
1546 if (Stream.Read(8) != 'B' ||
1547 Stream.Read(8) != 'C' ||
1548 Stream.Read(4) != 0x0 ||
1549 Stream.Read(4) != 0xC ||
1550 Stream.Read(4) != 0xE ||
1551 Stream.Read(4) != 0xD)
1552 return Error("Invalid bitcode signature");
1554 // We expect a number of well-defined blocks, though we don't necessarily
1555 // need to understand them all.
1556 while (!Stream.AtEndOfStream()) {
1557 unsigned Code = Stream.ReadCode();
1559 if (Code != bitc::ENTER_SUBBLOCK)
1560 return Error("Invalid record at top-level");
1562 unsigned BlockID = Stream.ReadSubBlockID();
1564 // We only know the MODULE subblock ID.
1566 case bitc::BLOCKINFO_BLOCK_ID:
1567 if (Stream.ReadBlockInfoBlock())
1568 return Error("Malformed BlockInfoBlock");
1570 case bitc::MODULE_BLOCK_ID:
1571 // Reject multiple MODULE_BLOCK's in a single bitstream.
1573 return Error("Multiple MODULE_BLOCKs in same stream");
1579 if (Stream.SkipBlock())
1580 return Error("Malformed block record");
1588 /// ParseMetadataAttachment - Parse metadata attachments.
1589 bool BitcodeReader::ParseMetadataAttachment() {
1590 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
1591 return Error("Malformed block record");
1593 SmallVector<uint64_t, 64> Record;
1595 unsigned Code = Stream.ReadCode();
1596 if (Code == bitc::END_BLOCK) {
1597 if (Stream.ReadBlockEnd())
1598 return Error("Error at end of PARAMATTR block");
1601 if (Code == bitc::DEFINE_ABBREV) {
1602 Stream.ReadAbbrevRecord();
1605 // Read a metadata attachment record.
1607 switch (Stream.ReadRecord(Code, Record)) {
1608 default: // Default behavior: ignore.
1610 case bitc::METADATA_ATTACHMENT: {
1611 unsigned RecordLength = Record.size();
1612 if (Record.empty() || (RecordLength - 1) % 2 == 1)
1613 return Error ("Invalid METADATA_ATTACHMENT reader!");
1614 Instruction *Inst = InstructionList[Record[0]];
1615 for (unsigned i = 1; i != RecordLength; i = i+2) {
1616 unsigned Kind = Record[i];
1617 DenseMap<unsigned, unsigned>::iterator I =
1618 MDKindMap.find(Kind);
1619 if (I == MDKindMap.end())
1620 return Error("Invalid metadata kind ID");
1621 Value *Node = MDValueList.getValueFwdRef(Record[i+1]);
1622 Inst->setMetadata(I->second, cast<MDNode>(Node));
1631 /// ParseFunctionBody - Lazily parse the specified function body block.
1632 bool BitcodeReader::ParseFunctionBody(Function *F) {
1633 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
1634 return Error("Malformed block record");
1636 InstructionList.clear();
1637 unsigned ModuleValueListSize = ValueList.size();
1639 // Add all the function arguments to the value table.
1640 for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
1641 ValueList.push_back(I);
1643 unsigned NextValueNo = ValueList.size();
1644 BasicBlock *CurBB = 0;
1645 unsigned CurBBNo = 0;
1649 // Read all the records.
1650 SmallVector<uint64_t, 64> Record;
1652 unsigned Code = Stream.ReadCode();
1653 if (Code == bitc::END_BLOCK) {
1654 if (Stream.ReadBlockEnd())
1655 return Error("Error at end of function block");
1659 if (Code == bitc::ENTER_SUBBLOCK) {
1660 switch (Stream.ReadSubBlockID()) {
1661 default: // Skip unknown content.
1662 if (Stream.SkipBlock())
1663 return Error("Malformed block record");
1665 case bitc::CONSTANTS_BLOCK_ID:
1666 if (ParseConstants()) return true;
1667 NextValueNo = ValueList.size();
1669 case bitc::VALUE_SYMTAB_BLOCK_ID:
1670 if (ParseValueSymbolTable()) return true;
1672 case bitc::METADATA_ATTACHMENT_ID:
1673 if (ParseMetadataAttachment()) return true;
1675 case bitc::METADATA_BLOCK_ID:
1676 if (ParseMetadata()) return true;
1682 if (Code == bitc::DEFINE_ABBREV) {
1683 Stream.ReadAbbrevRecord();
1690 unsigned BitCode = Stream.ReadRecord(Code, Record);
1692 default: // Default behavior: reject
1693 return Error("Unknown instruction");
1694 case bitc::FUNC_CODE_DECLAREBLOCKS: // DECLAREBLOCKS: [nblocks]
1695 if (Record.size() < 1 || Record[0] == 0)
1696 return Error("Invalid DECLAREBLOCKS record");
1697 // Create all the basic blocks for the function.
1698 FunctionBBs.resize(Record[0]);
1699 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
1700 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
1701 CurBB = FunctionBBs[0];
1705 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
1706 // This record indicates that the last instruction is at the same
1707 // location as the previous instruction with a location.
1710 // Get the last instruction emitted.
1711 if (CurBB && !CurBB->empty())
1713 else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
1714 !FunctionBBs[CurBBNo-1]->empty())
1715 I = &FunctionBBs[CurBBNo-1]->back();
1717 if (I == 0) return Error("Invalid DEBUG_LOC_AGAIN record");
1718 I->setDebugLoc(LastLoc);
1722 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
1723 I = 0; // Get the last instruction emitted.
1724 if (CurBB && !CurBB->empty())
1726 else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
1727 !FunctionBBs[CurBBNo-1]->empty())
1728 I = &FunctionBBs[CurBBNo-1]->back();
1729 if (I == 0 || Record.size() < 4)
1730 return Error("Invalid FUNC_CODE_DEBUG_LOC record");
1732 unsigned Line = Record[0], Col = Record[1];
1733 unsigned ScopeID = Record[2], IAID = Record[3];
1735 MDNode *Scope = 0, *IA = 0;
1736 if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
1737 if (IAID) IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
1738 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
1739 I->setDebugLoc(LastLoc);
1744 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
1747 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1748 getValue(Record, OpNum, LHS->getType(), RHS) ||
1749 OpNum+1 > Record.size())
1750 return Error("Invalid BINOP record");
1752 int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
1753 if (Opc == -1) return Error("Invalid BINOP record");
1754 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
1755 InstructionList.push_back(I);
1756 if (OpNum < Record.size()) {
1757 if (Opc == Instruction::Add ||
1758 Opc == Instruction::Sub ||
1759 Opc == Instruction::Mul) {
1760 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1761 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
1762 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1763 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
1764 } else if (Opc == Instruction::SDiv) {
1765 if (Record[OpNum] & (1 << bitc::SDIV_EXACT))
1766 cast<BinaryOperator>(I)->setIsExact(true);
1771 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
1774 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1775 OpNum+2 != Record.size())
1776 return Error("Invalid CAST record");
1778 const Type *ResTy = getTypeByID(Record[OpNum]);
1779 int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
1780 if (Opc == -1 || ResTy == 0)
1781 return Error("Invalid CAST record");
1782 I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
1783 InstructionList.push_back(I);
1786 case bitc::FUNC_CODE_INST_INBOUNDS_GEP:
1787 case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
1790 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
1791 return Error("Invalid GEP record");
1793 SmallVector<Value*, 16> GEPIdx;
1794 while (OpNum != Record.size()) {
1796 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1797 return Error("Invalid GEP record");
1798 GEPIdx.push_back(Op);
1801 I = GetElementPtrInst::Create(BasePtr, GEPIdx.begin(), GEPIdx.end());
1802 InstructionList.push_back(I);
1803 if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP)
1804 cast<GetElementPtrInst>(I)->setIsInBounds(true);
1808 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
1809 // EXTRACTVAL: [opty, opval, n x indices]
1812 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
1813 return Error("Invalid EXTRACTVAL record");
1815 SmallVector<unsigned, 4> EXTRACTVALIdx;
1816 for (unsigned RecSize = Record.size();
1817 OpNum != RecSize; ++OpNum) {
1818 uint64_t Index = Record[OpNum];
1819 if ((unsigned)Index != Index)
1820 return Error("Invalid EXTRACTVAL index");
1821 EXTRACTVALIdx.push_back((unsigned)Index);
1824 I = ExtractValueInst::Create(Agg,
1825 EXTRACTVALIdx.begin(), EXTRACTVALIdx.end());
1826 InstructionList.push_back(I);
1830 case bitc::FUNC_CODE_INST_INSERTVAL: {
1831 // INSERTVAL: [opty, opval, opty, opval, n x indices]
1834 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
1835 return Error("Invalid INSERTVAL record");
1837 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
1838 return Error("Invalid INSERTVAL record");
1840 SmallVector<unsigned, 4> INSERTVALIdx;
1841 for (unsigned RecSize = Record.size();
1842 OpNum != RecSize; ++OpNum) {
1843 uint64_t Index = Record[OpNum];
1844 if ((unsigned)Index != Index)
1845 return Error("Invalid INSERTVAL index");
1846 INSERTVALIdx.push_back((unsigned)Index);
1849 I = InsertValueInst::Create(Agg, Val,
1850 INSERTVALIdx.begin(), INSERTVALIdx.end());
1851 InstructionList.push_back(I);
1855 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
1856 // obsolete form of select
1857 // handles select i1 ... in old bitcode
1859 Value *TrueVal, *FalseVal, *Cond;
1860 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1861 getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1862 getValue(Record, OpNum, Type::getInt1Ty(Context), Cond))
1863 return Error("Invalid SELECT record");
1865 I = SelectInst::Create(Cond, TrueVal, FalseVal);
1866 InstructionList.push_back(I);
1870 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
1871 // new form of select
1872 // handles select i1 or select [N x i1]
1874 Value *TrueVal, *FalseVal, *Cond;
1875 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1876 getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1877 getValueTypePair(Record, OpNum, NextValueNo, Cond))
1878 return Error("Invalid SELECT record");
1880 // select condition can be either i1 or [N x i1]
1881 if (const VectorType* vector_type =
1882 dyn_cast<const VectorType>(Cond->getType())) {
1884 if (vector_type->getElementType() != Type::getInt1Ty(Context))
1885 return Error("Invalid SELECT condition type");
1888 if (Cond->getType() != Type::getInt1Ty(Context))
1889 return Error("Invalid SELECT condition type");
1892 I = SelectInst::Create(Cond, TrueVal, FalseVal);
1893 InstructionList.push_back(I);
1897 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
1900 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1901 getValue(Record, OpNum, Type::getInt32Ty(Context), Idx))
1902 return Error("Invalid EXTRACTELT record");
1903 I = ExtractElementInst::Create(Vec, Idx);
1904 InstructionList.push_back(I);
1908 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
1910 Value *Vec, *Elt, *Idx;
1911 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1912 getValue(Record, OpNum,
1913 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
1914 getValue(Record, OpNum, Type::getInt32Ty(Context), Idx))
1915 return Error("Invalid INSERTELT record");
1916 I = InsertElementInst::Create(Vec, Elt, Idx);
1917 InstructionList.push_back(I);
1921 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
1923 Value *Vec1, *Vec2, *Mask;
1924 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
1925 getValue(Record, OpNum, Vec1->getType(), Vec2))
1926 return Error("Invalid SHUFFLEVEC record");
1928 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
1929 return Error("Invalid SHUFFLEVEC record");
1930 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
1931 InstructionList.push_back(I);
1935 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
1936 // Old form of ICmp/FCmp returning bool
1937 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
1938 // both legal on vectors but had different behaviour.
1939 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
1940 // FCmp/ICmp returning bool or vector of bool
1944 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1945 getValue(Record, OpNum, LHS->getType(), RHS) ||
1946 OpNum+1 != Record.size())
1947 return Error("Invalid CMP record");
1949 if (LHS->getType()->isFPOrFPVectorTy())
1950 I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
1952 I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
1953 InstructionList.push_back(I);
1957 case bitc::FUNC_CODE_INST_GETRESULT: { // GETRESULT: [ty, val, n]
1958 if (Record.size() != 2)
1959 return Error("Invalid GETRESULT record");
1962 getValueTypePair(Record, OpNum, NextValueNo, Op);
1963 unsigned Index = Record[1];
1964 I = ExtractValueInst::Create(Op, Index);
1965 InstructionList.push_back(I);
1969 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
1971 unsigned Size = Record.size();
1973 I = ReturnInst::Create(Context);
1974 InstructionList.push_back(I);
1979 SmallVector<Value *,4> Vs;
1982 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1983 return Error("Invalid RET record");
1985 } while(OpNum != Record.size());
1987 const Type *ReturnType = F->getReturnType();
1988 if (Vs.size() > 1 ||
1989 (ReturnType->isStructTy() &&
1990 (Vs.empty() || Vs[0]->getType() != ReturnType))) {
1991 Value *RV = UndefValue::get(ReturnType);
1992 for (unsigned i = 0, e = Vs.size(); i != e; ++i) {
1993 I = InsertValueInst::Create(RV, Vs[i], i, "mrv");
1994 InstructionList.push_back(I);
1995 CurBB->getInstList().push_back(I);
1996 ValueList.AssignValue(I, NextValueNo++);
1999 I = ReturnInst::Create(Context, RV);
2000 InstructionList.push_back(I);
2004 I = ReturnInst::Create(Context, Vs[0]);
2005 InstructionList.push_back(I);
2008 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
2009 if (Record.size() != 1 && Record.size() != 3)
2010 return Error("Invalid BR record");
2011 BasicBlock *TrueDest = getBasicBlock(Record[0]);
2013 return Error("Invalid BR record");
2015 if (Record.size() == 1) {
2016 I = BranchInst::Create(TrueDest);
2017 InstructionList.push_back(I);
2020 BasicBlock *FalseDest = getBasicBlock(Record[1]);
2021 Value *Cond = getFnValueByID(Record[2], Type::getInt1Ty(Context));
2022 if (FalseDest == 0 || Cond == 0)
2023 return Error("Invalid BR record");
2024 I = BranchInst::Create(TrueDest, FalseDest, Cond);
2025 InstructionList.push_back(I);
2029 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
2030 if (Record.size() < 3 || (Record.size() & 1) == 0)
2031 return Error("Invalid SWITCH record");
2032 const Type *OpTy = getTypeByID(Record[0]);
2033 Value *Cond = getFnValueByID(Record[1], OpTy);
2034 BasicBlock *Default = getBasicBlock(Record[2]);
2035 if (OpTy == 0 || Cond == 0 || Default == 0)
2036 return Error("Invalid SWITCH record");
2037 unsigned NumCases = (Record.size()-3)/2;
2038 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
2039 InstructionList.push_back(SI);
2040 for (unsigned i = 0, e = NumCases; i != e; ++i) {
2041 ConstantInt *CaseVal =
2042 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
2043 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
2044 if (CaseVal == 0 || DestBB == 0) {
2046 return Error("Invalid SWITCH record!");
2048 SI->addCase(CaseVal, DestBB);
2053 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
2054 if (Record.size() < 2)
2055 return Error("Invalid INDIRECTBR record");
2056 const Type *OpTy = getTypeByID(Record[0]);
2057 Value *Address = getFnValueByID(Record[1], OpTy);
2058 if (OpTy == 0 || Address == 0)
2059 return Error("Invalid INDIRECTBR record");
2060 unsigned NumDests = Record.size()-2;
2061 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
2062 InstructionList.push_back(IBI);
2063 for (unsigned i = 0, e = NumDests; i != e; ++i) {
2064 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
2065 IBI->addDestination(DestBB);
2068 return Error("Invalid INDIRECTBR record!");
2075 case bitc::FUNC_CODE_INST_INVOKE: {
2076 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
2077 if (Record.size() < 4) return Error("Invalid INVOKE record");
2078 AttrListPtr PAL = getAttributes(Record[0]);
2079 unsigned CCInfo = Record[1];
2080 BasicBlock *NormalBB = getBasicBlock(Record[2]);
2081 BasicBlock *UnwindBB = getBasicBlock(Record[3]);
2085 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2086 return Error("Invalid INVOKE record");
2088 const PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
2089 const FunctionType *FTy = !CalleeTy ? 0 :
2090 dyn_cast<FunctionType>(CalleeTy->getElementType());
2092 // Check that the right number of fixed parameters are here.
2093 if (FTy == 0 || NormalBB == 0 || UnwindBB == 0 ||
2094 Record.size() < OpNum+FTy->getNumParams())
2095 return Error("Invalid INVOKE record");
2097 SmallVector<Value*, 16> Ops;
2098 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2099 Ops.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
2100 if (Ops.back() == 0) return Error("Invalid INVOKE record");
2103 if (!FTy->isVarArg()) {
2104 if (Record.size() != OpNum)
2105 return Error("Invalid INVOKE record");
2107 // Read type/value pairs for varargs params.
2108 while (OpNum != Record.size()) {
2110 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2111 return Error("Invalid INVOKE record");
2116 I = InvokeInst::Create(Callee, NormalBB, UnwindBB,
2117 Ops.begin(), Ops.end());
2118 InstructionList.push_back(I);
2119 cast<InvokeInst>(I)->setCallingConv(
2120 static_cast<CallingConv::ID>(CCInfo));
2121 cast<InvokeInst>(I)->setAttributes(PAL);
2124 case bitc::FUNC_CODE_INST_UNWIND: // UNWIND
2125 I = new UnwindInst(Context);
2126 InstructionList.push_back(I);
2128 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
2129 I = new UnreachableInst(Context);
2130 InstructionList.push_back(I);
2132 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
2133 if (Record.size() < 1 || ((Record.size()-1)&1))
2134 return Error("Invalid PHI record");
2135 const Type *Ty = getTypeByID(Record[0]);
2136 if (!Ty) return Error("Invalid PHI record");
2138 PHINode *PN = PHINode::Create(Ty);
2139 InstructionList.push_back(PN);
2140 PN->reserveOperandSpace((Record.size()-1)/2);
2142 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
2143 Value *V = getFnValueByID(Record[1+i], Ty);
2144 BasicBlock *BB = getBasicBlock(Record[2+i]);
2145 if (!V || !BB) return Error("Invalid PHI record");
2146 PN->addIncoming(V, BB);
2152 case bitc::FUNC_CODE_INST_MALLOC: { // MALLOC: [instty, op, align]
2153 // Autoupgrade malloc instruction to malloc call.
2154 // FIXME: Remove in LLVM 3.0.
2155 if (Record.size() < 3)
2156 return Error("Invalid MALLOC record");
2157 const PointerType *Ty =
2158 dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
2159 Value *Size = getFnValueByID(Record[1], Type::getInt32Ty(Context));
2160 if (!Ty || !Size) return Error("Invalid MALLOC record");
2161 if (!CurBB) return Error("Invalid malloc instruction with no BB");
2162 const Type *Int32Ty = IntegerType::getInt32Ty(CurBB->getContext());
2163 Constant *AllocSize = ConstantExpr::getSizeOf(Ty->getElementType());
2164 AllocSize = ConstantExpr::getTruncOrBitCast(AllocSize, Int32Ty);
2165 I = CallInst::CreateMalloc(CurBB, Int32Ty, Ty->getElementType(),
2166 AllocSize, Size, NULL);
2167 InstructionList.push_back(I);
2170 case bitc::FUNC_CODE_INST_FREE: { // FREE: [op, opty]
2173 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2174 OpNum != Record.size())
2175 return Error("Invalid FREE record");
2176 if (!CurBB) return Error("Invalid free instruction with no BB");
2177 I = CallInst::CreateFree(Op, CurBB);
2178 InstructionList.push_back(I);
2181 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
2182 // For backward compatibility, tolerate a lack of an opty, and use i32.
2183 // LLVM 3.0: Remove this.
2184 if (Record.size() < 3 || Record.size() > 4)
2185 return Error("Invalid ALLOCA record");
2187 const PointerType *Ty =
2188 dyn_cast_or_null<PointerType>(getTypeByID(Record[OpNum++]));
2189 const Type *OpTy = Record.size() == 4 ? getTypeByID(Record[OpNum++]) :
2190 Type::getInt32Ty(Context);
2191 Value *Size = getFnValueByID(Record[OpNum++], OpTy);
2192 unsigned Align = Record[OpNum++];
2193 if (!Ty || !Size) return Error("Invalid ALLOCA record");
2194 I = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
2195 InstructionList.push_back(I);
2198 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
2201 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2202 OpNum+2 != Record.size())
2203 return Error("Invalid LOAD record");
2205 I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2206 InstructionList.push_back(I);
2209 case bitc::FUNC_CODE_INST_STORE2: { // STORE2:[ptrty, ptr, val, align, vol]
2212 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2213 getValue(Record, OpNum,
2214 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
2215 OpNum+2 != Record.size())
2216 return Error("Invalid STORE record");
2218 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2219 InstructionList.push_back(I);
2222 case bitc::FUNC_CODE_INST_STORE: { // STORE:[val, valty, ptr, align, vol]
2223 // FIXME: Legacy form of store instruction. Should be removed in LLVM 3.0.
2226 if (getValueTypePair(Record, OpNum, NextValueNo, Val) ||
2227 getValue(Record, OpNum,
2228 PointerType::getUnqual(Val->getType()), Ptr)||
2229 OpNum+2 != Record.size())
2230 return Error("Invalid STORE record");
2232 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2233 InstructionList.push_back(I);
2236 case bitc::FUNC_CODE_INST_CALL: {
2237 // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
2238 if (Record.size() < 3)
2239 return Error("Invalid CALL record");
2241 AttrListPtr PAL = getAttributes(Record[0]);
2242 unsigned CCInfo = Record[1];
2246 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2247 return Error("Invalid CALL record");
2249 const PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
2250 const FunctionType *FTy = 0;
2251 if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
2252 if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
2253 return Error("Invalid CALL record");
2255 SmallVector<Value*, 16> Args;
2256 // Read the fixed params.
2257 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2258 if (FTy->getParamType(i)->getTypeID()==Type::LabelTyID)
2259 Args.push_back(getBasicBlock(Record[OpNum]));
2261 Args.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
2262 if (Args.back() == 0) return Error("Invalid CALL record");
2265 // Read type/value pairs for varargs params.
2266 if (!FTy->isVarArg()) {
2267 if (OpNum != Record.size())
2268 return Error("Invalid CALL record");
2270 while (OpNum != Record.size()) {
2272 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2273 return Error("Invalid CALL record");
2278 I = CallInst::Create(Callee, Args.begin(), Args.end());
2279 InstructionList.push_back(I);
2280 cast<CallInst>(I)->setCallingConv(
2281 static_cast<CallingConv::ID>(CCInfo>>1));
2282 cast<CallInst>(I)->setTailCall(CCInfo & 1);
2283 cast<CallInst>(I)->setAttributes(PAL);
2286 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
2287 if (Record.size() < 3)
2288 return Error("Invalid VAARG record");
2289 const Type *OpTy = getTypeByID(Record[0]);
2290 Value *Op = getFnValueByID(Record[1], OpTy);
2291 const Type *ResTy = getTypeByID(Record[2]);
2292 if (!OpTy || !Op || !ResTy)
2293 return Error("Invalid VAARG record");
2294 I = new VAArgInst(Op, ResTy);
2295 InstructionList.push_back(I);
2300 // Add instruction to end of current BB. If there is no current BB, reject
2304 return Error("Invalid instruction with no BB");
2306 CurBB->getInstList().push_back(I);
2308 // If this was a terminator instruction, move to the next block.
2309 if (isa<TerminatorInst>(I)) {
2311 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : 0;
2314 // Non-void values get registered in the value table for future use.
2315 if (I && !I->getType()->isVoidTy())
2316 ValueList.AssignValue(I, NextValueNo++);
2319 // Check the function list for unresolved values.
2320 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
2321 if (A->getParent() == 0) {
2322 // We found at least one unresolved value. Nuke them all to avoid leaks.
2323 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
2324 if ((A = dyn_cast<Argument>(ValueList.back())) && A->getParent() == 0) {
2325 A->replaceAllUsesWith(UndefValue::get(A->getType()));
2329 return Error("Never resolved value found in function!");
2333 // See if anything took the address of blocks in this function. If so,
2334 // resolve them now.
2335 DenseMap<Function*, std::vector<BlockAddrRefTy> >::iterator BAFRI =
2336 BlockAddrFwdRefs.find(F);
2337 if (BAFRI != BlockAddrFwdRefs.end()) {
2338 std::vector<BlockAddrRefTy> &RefList = BAFRI->second;
2339 for (unsigned i = 0, e = RefList.size(); i != e; ++i) {
2340 unsigned BlockIdx = RefList[i].first;
2341 if (BlockIdx >= FunctionBBs.size())
2342 return Error("Invalid blockaddress block #");
2344 GlobalVariable *FwdRef = RefList[i].second;
2345 FwdRef->replaceAllUsesWith(BlockAddress::get(F, FunctionBBs[BlockIdx]));
2346 FwdRef->eraseFromParent();
2349 BlockAddrFwdRefs.erase(BAFRI);
2352 // Trim the value list down to the size it was before we parsed this function.
2353 ValueList.shrinkTo(ModuleValueListSize);
2354 std::vector<BasicBlock*>().swap(FunctionBBs);
2359 //===----------------------------------------------------------------------===//
2360 // GVMaterializer implementation
2361 //===----------------------------------------------------------------------===//
2364 bool BitcodeReader::isMaterializable(const GlobalValue *GV) const {
2365 if (const Function *F = dyn_cast<Function>(GV)) {
2366 return F->isDeclaration() &&
2367 DeferredFunctionInfo.count(const_cast<Function*>(F));
2372 bool BitcodeReader::Materialize(GlobalValue *GV, std::string *ErrInfo) {
2373 Function *F = dyn_cast<Function>(GV);
2374 // If it's not a function or is already material, ignore the request.
2375 if (!F || !F->isMaterializable()) return false;
2377 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
2378 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
2380 // Move the bit stream to the saved position of the deferred function body.
2381 Stream.JumpToBit(DFII->second);
2383 if (ParseFunctionBody(F)) {
2384 if (ErrInfo) *ErrInfo = ErrorString;
2388 // Upgrade any old intrinsic calls in the function.
2389 for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
2390 E = UpgradedIntrinsics.end(); I != E; ++I) {
2391 if (I->first != I->second) {
2392 for (Value::use_iterator UI = I->first->use_begin(),
2393 UE = I->first->use_end(); UI != UE; ) {
2394 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
2395 UpgradeIntrinsicCall(CI, I->second);
2403 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
2404 const Function *F = dyn_cast<Function>(GV);
2405 if (!F || F->isDeclaration())
2407 return DeferredFunctionInfo.count(const_cast<Function*>(F));
2410 void BitcodeReader::Dematerialize(GlobalValue *GV) {
2411 Function *F = dyn_cast<Function>(GV);
2412 // If this function isn't dematerializable, this is a noop.
2413 if (!F || !isDematerializable(F))
2416 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
2418 // Just forget the function body, we can remat it later.
2423 bool BitcodeReader::MaterializeModule(Module *M, std::string *ErrInfo) {
2424 assert(M == TheModule &&
2425 "Can only Materialize the Module this BitcodeReader is attached to.");
2426 // Iterate over the module, deserializing any functions that are still on
2428 for (Module::iterator F = TheModule->begin(), E = TheModule->end();
2430 if (F->isMaterializable() &&
2431 Materialize(F, ErrInfo))
2434 // Upgrade any intrinsic calls that slipped through (should not happen!) and
2435 // delete the old functions to clean up. We can't do this unless the entire
2436 // module is materialized because there could always be another function body
2437 // with calls to the old function.
2438 for (std::vector<std::pair<Function*, Function*> >::iterator I =
2439 UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
2440 if (I->first != I->second) {
2441 for (Value::use_iterator UI = I->first->use_begin(),
2442 UE = I->first->use_end(); UI != UE; ) {
2443 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
2444 UpgradeIntrinsicCall(CI, I->second);
2446 if (!I->first->use_empty())
2447 I->first->replaceAllUsesWith(I->second);
2448 I->first->eraseFromParent();
2451 std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
2453 // Check debug info intrinsics.
2454 CheckDebugInfoIntrinsics(TheModule);
2460 //===----------------------------------------------------------------------===//
2461 // External interface
2462 //===----------------------------------------------------------------------===//
2464 /// getLazyBitcodeModule - lazy function-at-a-time loading from a file.
2466 Module *llvm::getLazyBitcodeModule(MemoryBuffer *Buffer,
2467 LLVMContext& Context,
2468 std::string *ErrMsg) {
2469 Module *M = new Module(Buffer->getBufferIdentifier(), Context);
2470 BitcodeReader *R = new BitcodeReader(Buffer, Context);
2471 M->setMaterializer(R);
2472 if (R->ParseBitcodeInto(M)) {
2474 *ErrMsg = R->getErrorString();
2476 delete M; // Also deletes R.
2479 // Have the BitcodeReader dtor delete 'Buffer'.
2480 R->setBufferOwned(true);
2484 /// ParseBitcodeFile - Read the specified bitcode file, returning the module.
2485 /// If an error occurs, return null and fill in *ErrMsg if non-null.
2486 Module *llvm::ParseBitcodeFile(MemoryBuffer *Buffer, LLVMContext& Context,
2487 std::string *ErrMsg){
2488 Module *M = getLazyBitcodeModule(Buffer, Context, ErrMsg);
2491 // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether
2492 // there was an error.
2493 static_cast<BitcodeReader*>(M->getMaterializer())->setBufferOwned(false);
2495 // Read in the entire module, and destroy the BitcodeReader.
2496 if (M->MaterializeAllPermanently(ErrMsg)) {