1 //===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source 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/Instructions.h"
20 #include "llvm/Module.h"
21 #include "llvm/ParameterAttributes.h"
22 #include "llvm/AutoUpgrade.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/Support/MathExtras.h"
25 #include "llvm/Support/MemoryBuffer.h"
28 void BitcodeReader::FreeState() {
31 std::vector<PATypeHolder>().swap(TypeList);
33 std::vector<const ParamAttrsList*>().swap(ParamAttrs);
34 std::vector<BasicBlock*>().swap(FunctionBBs);
35 std::vector<Function*>().swap(FunctionsWithBodies);
36 DeferredFunctionInfo.clear();
39 //===----------------------------------------------------------------------===//
40 // Helper functions to implement forward reference resolution, etc.
41 //===----------------------------------------------------------------------===//
43 /// ConvertToString - Convert a string from a record into an std::string, return
45 template<typename StrTy>
46 static bool ConvertToString(SmallVector<uint64_t, 64> &Record, unsigned Idx,
48 if (Idx > Record.size())
51 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
52 Result += (char)Record[i];
56 static GlobalValue::LinkageTypes GetDecodedLinkage(unsigned Val) {
58 default: // Map unknown/new linkages to external
59 case 0: return GlobalValue::ExternalLinkage;
60 case 1: return GlobalValue::WeakLinkage;
61 case 2: return GlobalValue::AppendingLinkage;
62 case 3: return GlobalValue::InternalLinkage;
63 case 4: return GlobalValue::LinkOnceLinkage;
64 case 5: return GlobalValue::DLLImportLinkage;
65 case 6: return GlobalValue::DLLExportLinkage;
66 case 7: return GlobalValue::ExternalWeakLinkage;
70 static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
72 default: // Map unknown visibilities to default.
73 case 0: return GlobalValue::DefaultVisibility;
74 case 1: return GlobalValue::HiddenVisibility;
75 case 2: return GlobalValue::ProtectedVisibility;
79 static int GetDecodedCastOpcode(unsigned Val) {
82 case bitc::CAST_TRUNC : return Instruction::Trunc;
83 case bitc::CAST_ZEXT : return Instruction::ZExt;
84 case bitc::CAST_SEXT : return Instruction::SExt;
85 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
86 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
87 case bitc::CAST_UITOFP : return Instruction::UIToFP;
88 case bitc::CAST_SITOFP : return Instruction::SIToFP;
89 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
90 case bitc::CAST_FPEXT : return Instruction::FPExt;
91 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
92 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
93 case bitc::CAST_BITCAST : return Instruction::BitCast;
96 static int GetDecodedBinaryOpcode(unsigned Val, const Type *Ty) {
99 case bitc::BINOP_ADD: return Instruction::Add;
100 case bitc::BINOP_SUB: return Instruction::Sub;
101 case bitc::BINOP_MUL: return Instruction::Mul;
102 case bitc::BINOP_UDIV: return Instruction::UDiv;
103 case bitc::BINOP_SDIV:
104 return Ty->isFPOrFPVector() ? Instruction::FDiv : Instruction::SDiv;
105 case bitc::BINOP_UREM: return Instruction::URem;
106 case bitc::BINOP_SREM:
107 return Ty->isFPOrFPVector() ? Instruction::FRem : Instruction::SRem;
108 case bitc::BINOP_SHL: return Instruction::Shl;
109 case bitc::BINOP_LSHR: return Instruction::LShr;
110 case bitc::BINOP_ASHR: return Instruction::AShr;
111 case bitc::BINOP_AND: return Instruction::And;
112 case bitc::BINOP_OR: return Instruction::Or;
113 case bitc::BINOP_XOR: return Instruction::Xor;
119 /// @brief A class for maintaining the slot number definition
120 /// as a placeholder for the actual definition for forward constants defs.
121 class ConstantPlaceHolder : public ConstantExpr {
122 ConstantPlaceHolder(); // DO NOT IMPLEMENT
123 void operator=(const ConstantPlaceHolder &); // DO NOT IMPLEMENT
126 ConstantPlaceHolder(const Type *Ty)
127 : ConstantExpr(Ty, Instruction::UserOp1, &Op, 1),
128 Op(UndefValue::get(Type::Int32Ty), this) {
133 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
136 // Insert a bunch of null values.
138 OperandList = &Uses[0];
142 if (Value *V = Uses[Idx]) {
143 assert(Ty == V->getType() && "Type mismatch in constant table!");
144 return cast<Constant>(V);
147 // Create and return a placeholder, which will later be RAUW'd.
148 Constant *C = new ConstantPlaceHolder(Ty);
149 Uses[Idx].init(C, this);
153 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, const Type *Ty) {
155 // Insert a bunch of null values.
157 OperandList = &Uses[0];
161 if (Value *V = Uses[Idx]) {
162 assert((Ty == 0 || Ty == V->getType()) && "Type mismatch in value table!");
166 // No type specified, must be invalid reference.
167 if (Ty == 0) return 0;
169 // Create and return a placeholder, which will later be RAUW'd.
170 Value *V = new Argument(Ty);
171 Uses[Idx].init(V, this);
176 const Type *BitcodeReader::getTypeByID(unsigned ID, bool isTypeTable) {
177 // If the TypeID is in range, return it.
178 if (ID < TypeList.size())
179 return TypeList[ID].get();
180 if (!isTypeTable) return 0;
182 // The type table allows forward references. Push as many Opaque types as
183 // needed to get up to ID.
184 while (TypeList.size() <= ID)
185 TypeList.push_back(OpaqueType::get());
186 return TypeList.back().get();
189 //===----------------------------------------------------------------------===//
190 // Functions for parsing blocks from the bitcode file
191 //===----------------------------------------------------------------------===//
193 bool BitcodeReader::ParseParamAttrBlock() {
194 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
195 return Error("Malformed block record");
197 if (!ParamAttrs.empty())
198 return Error("Multiple PARAMATTR blocks found!");
200 SmallVector<uint64_t, 64> Record;
202 ParamAttrsVector Attrs;
204 // Read all the records.
206 unsigned Code = Stream.ReadCode();
207 if (Code == bitc::END_BLOCK) {
208 if (Stream.ReadBlockEnd())
209 return Error("Error at end of PARAMATTR block");
213 if (Code == bitc::ENTER_SUBBLOCK) {
214 // No known subblocks, always skip them.
215 Stream.ReadSubBlockID();
216 if (Stream.SkipBlock())
217 return Error("Malformed block record");
221 if (Code == bitc::DEFINE_ABBREV) {
222 Stream.ReadAbbrevRecord();
228 switch (Stream.ReadRecord(Code, Record)) {
229 default: // Default behavior: ignore.
231 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [paramidx0, attr0, ...]
232 if (Record.size() & 1)
233 return Error("Invalid ENTRY record");
235 ParamAttrsWithIndex PAWI;
236 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
237 PAWI.index = Record[i];
238 PAWI.attrs = Record[i+1];
239 Attrs.push_back(PAWI);
241 ParamAttrs.push_back(ParamAttrsList::get(Attrs));
250 bool BitcodeReader::ParseTypeTable() {
251 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID))
252 return Error("Malformed block record");
254 if (!TypeList.empty())
255 return Error("Multiple TYPE_BLOCKs found!");
257 SmallVector<uint64_t, 64> Record;
258 unsigned NumRecords = 0;
260 // Read all the records for this type table.
262 unsigned Code = Stream.ReadCode();
263 if (Code == bitc::END_BLOCK) {
264 if (NumRecords != TypeList.size())
265 return Error("Invalid type forward reference in TYPE_BLOCK");
266 if (Stream.ReadBlockEnd())
267 return Error("Error at end of type table block");
271 if (Code == bitc::ENTER_SUBBLOCK) {
272 // No known subblocks, always skip them.
273 Stream.ReadSubBlockID();
274 if (Stream.SkipBlock())
275 return Error("Malformed block record");
279 if (Code == bitc::DEFINE_ABBREV) {
280 Stream.ReadAbbrevRecord();
286 const Type *ResultTy = 0;
287 switch (Stream.ReadRecord(Code, Record)) {
288 default: // Default behavior: unknown type.
291 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
292 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
293 // type list. This allows us to reserve space.
294 if (Record.size() < 1)
295 return Error("Invalid TYPE_CODE_NUMENTRY record");
296 TypeList.reserve(Record[0]);
298 case bitc::TYPE_CODE_VOID: // VOID
299 ResultTy = Type::VoidTy;
301 case bitc::TYPE_CODE_FLOAT: // FLOAT
302 ResultTy = Type::FloatTy;
304 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
305 ResultTy = Type::DoubleTy;
307 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
308 ResultTy = Type::X86_FP80Ty;
310 case bitc::TYPE_CODE_FP128: // FP128
311 ResultTy = Type::FP128Ty;
313 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
314 ResultTy = Type::PPC_FP128Ty;
316 case bitc::TYPE_CODE_LABEL: // LABEL
317 ResultTy = Type::LabelTy;
319 case bitc::TYPE_CODE_OPAQUE: // OPAQUE
322 case bitc::TYPE_CODE_INTEGER: // INTEGER: [width]
323 if (Record.size() < 1)
324 return Error("Invalid Integer type record");
326 ResultTy = IntegerType::get(Record[0]);
328 case bitc::TYPE_CODE_POINTER: // POINTER: [pointee type]
329 if (Record.size() < 1)
330 return Error("Invalid POINTER type record");
331 ResultTy = PointerType::get(getTypeByID(Record[0], true));
333 case bitc::TYPE_CODE_FUNCTION: {
334 // FUNCTION: [vararg, attrid, retty, paramty x N]
335 if (Record.size() < 3)
336 return Error("Invalid FUNCTION type record");
337 std::vector<const Type*> ArgTys;
338 for (unsigned i = 3, e = Record.size(); i != e; ++i)
339 ArgTys.push_back(getTypeByID(Record[i], true));
341 ResultTy = FunctionType::get(getTypeByID(Record[2], true), ArgTys,
342 Record[0], getParamAttrs(Record[1]));
345 case bitc::TYPE_CODE_STRUCT: { // STRUCT: [ispacked, eltty x N]
346 if (Record.size() < 1)
347 return Error("Invalid STRUCT type record");
348 std::vector<const Type*> EltTys;
349 for (unsigned i = 1, e = Record.size(); i != e; ++i)
350 EltTys.push_back(getTypeByID(Record[i], true));
351 ResultTy = StructType::get(EltTys, Record[0]);
354 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
355 if (Record.size() < 2)
356 return Error("Invalid ARRAY type record");
357 ResultTy = ArrayType::get(getTypeByID(Record[1], true), Record[0]);
359 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
360 if (Record.size() < 2)
361 return Error("Invalid VECTOR type record");
362 ResultTy = VectorType::get(getTypeByID(Record[1], true), Record[0]);
366 if (NumRecords == TypeList.size()) {
367 // If this is a new type slot, just append it.
368 TypeList.push_back(ResultTy ? ResultTy : OpaqueType::get());
370 } else if (ResultTy == 0) {
371 // Otherwise, this was forward referenced, so an opaque type was created,
372 // but the result type is actually just an opaque. Leave the one we
373 // created previously.
376 // Otherwise, this was forward referenced, so an opaque type was created.
377 // Resolve the opaque type to the real type now.
378 assert(NumRecords < TypeList.size() && "Typelist imbalance");
379 const OpaqueType *OldTy = cast<OpaqueType>(TypeList[NumRecords++].get());
381 // Don't directly push the new type on the Tab. Instead we want to replace
382 // the opaque type we previously inserted with the new concrete value. The
383 // refinement from the abstract (opaque) type to the new type causes all
384 // uses of the abstract type to use the concrete type (NewTy). This will
385 // also cause the opaque type to be deleted.
386 const_cast<OpaqueType*>(OldTy)->refineAbstractTypeTo(ResultTy);
388 // This should have replaced the old opaque type with the new type in the
389 // value table... or with a preexisting type that was already in the
390 // system. Let's just make sure it did.
391 assert(TypeList[NumRecords-1].get() != OldTy &&
392 "refineAbstractType didn't work!");
398 bool BitcodeReader::ParseTypeSymbolTable() {
399 if (Stream.EnterSubBlock(bitc::TYPE_SYMTAB_BLOCK_ID))
400 return Error("Malformed block record");
402 SmallVector<uint64_t, 64> Record;
404 // Read all the records for this type table.
405 std::string TypeName;
407 unsigned Code = Stream.ReadCode();
408 if (Code == bitc::END_BLOCK) {
409 if (Stream.ReadBlockEnd())
410 return Error("Error at end of type symbol table block");
414 if (Code == bitc::ENTER_SUBBLOCK) {
415 // No known subblocks, always skip them.
416 Stream.ReadSubBlockID();
417 if (Stream.SkipBlock())
418 return Error("Malformed block record");
422 if (Code == bitc::DEFINE_ABBREV) {
423 Stream.ReadAbbrevRecord();
429 switch (Stream.ReadRecord(Code, Record)) {
430 default: // Default behavior: unknown type.
432 case bitc::TST_CODE_ENTRY: // TST_ENTRY: [typeid, namechar x N]
433 if (ConvertToString(Record, 1, TypeName))
434 return Error("Invalid TST_ENTRY record");
435 unsigned TypeID = Record[0];
436 if (TypeID >= TypeList.size())
437 return Error("Invalid Type ID in TST_ENTRY record");
439 TheModule->addTypeName(TypeName, TypeList[TypeID].get());
446 bool BitcodeReader::ParseValueSymbolTable() {
447 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
448 return Error("Malformed block record");
450 SmallVector<uint64_t, 64> Record;
452 // Read all the records for this value table.
453 SmallString<128> ValueName;
455 unsigned Code = Stream.ReadCode();
456 if (Code == bitc::END_BLOCK) {
457 if (Stream.ReadBlockEnd())
458 return Error("Error at end of value symbol table block");
461 if (Code == bitc::ENTER_SUBBLOCK) {
462 // No known subblocks, always skip them.
463 Stream.ReadSubBlockID();
464 if (Stream.SkipBlock())
465 return Error("Malformed block record");
469 if (Code == bitc::DEFINE_ABBREV) {
470 Stream.ReadAbbrevRecord();
476 switch (Stream.ReadRecord(Code, Record)) {
477 default: // Default behavior: unknown type.
479 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
480 if (ConvertToString(Record, 1, ValueName))
481 return Error("Invalid TST_ENTRY record");
482 unsigned ValueID = Record[0];
483 if (ValueID >= ValueList.size())
484 return Error("Invalid Value ID in VST_ENTRY record");
485 Value *V = ValueList[ValueID];
487 V->setName(&ValueName[0], ValueName.size());
491 case bitc::VST_CODE_BBENTRY: {
492 if (ConvertToString(Record, 1, ValueName))
493 return Error("Invalid VST_BBENTRY record");
494 BasicBlock *BB = getBasicBlock(Record[0]);
496 return Error("Invalid BB ID in VST_BBENTRY record");
498 BB->setName(&ValueName[0], ValueName.size());
506 /// DecodeSignRotatedValue - Decode a signed value stored with the sign bit in
507 /// the LSB for dense VBR encoding.
508 static uint64_t DecodeSignRotatedValue(uint64_t V) {
513 // There is no such thing as -0 with integers. "-0" really means MININT.
517 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
518 /// values and aliases that we can.
519 bool BitcodeReader::ResolveGlobalAndAliasInits() {
520 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
521 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
523 GlobalInitWorklist.swap(GlobalInits);
524 AliasInitWorklist.swap(AliasInits);
526 while (!GlobalInitWorklist.empty()) {
527 unsigned ValID = GlobalInitWorklist.back().second;
528 if (ValID >= ValueList.size()) {
529 // Not ready to resolve this yet, it requires something later in the file.
530 GlobalInits.push_back(GlobalInitWorklist.back());
532 if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
533 GlobalInitWorklist.back().first->setInitializer(C);
535 return Error("Global variable initializer is not a constant!");
537 GlobalInitWorklist.pop_back();
540 while (!AliasInitWorklist.empty()) {
541 unsigned ValID = AliasInitWorklist.back().second;
542 if (ValID >= ValueList.size()) {
543 AliasInits.push_back(AliasInitWorklist.back());
545 if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
546 AliasInitWorklist.back().first->setAliasee(C);
548 return Error("Alias initializer is not a constant!");
550 AliasInitWorklist.pop_back();
556 bool BitcodeReader::ParseConstants() {
557 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
558 return Error("Malformed block record");
560 SmallVector<uint64_t, 64> Record;
562 // Read all the records for this value table.
563 const Type *CurTy = Type::Int32Ty;
564 unsigned NextCstNo = ValueList.size();
566 unsigned Code = Stream.ReadCode();
567 if (Code == bitc::END_BLOCK) {
568 if (NextCstNo != ValueList.size())
569 return Error("Invalid constant reference!");
571 if (Stream.ReadBlockEnd())
572 return Error("Error at end of constants block");
576 if (Code == bitc::ENTER_SUBBLOCK) {
577 // No known subblocks, always skip them.
578 Stream.ReadSubBlockID();
579 if (Stream.SkipBlock())
580 return Error("Malformed block record");
584 if (Code == bitc::DEFINE_ABBREV) {
585 Stream.ReadAbbrevRecord();
592 switch (Stream.ReadRecord(Code, Record)) {
593 default: // Default behavior: unknown constant
594 case bitc::CST_CODE_UNDEF: // UNDEF
595 V = UndefValue::get(CurTy);
597 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
599 return Error("Malformed CST_SETTYPE record");
600 if (Record[0] >= TypeList.size())
601 return Error("Invalid Type ID in CST_SETTYPE record");
602 CurTy = TypeList[Record[0]];
603 continue; // Skip the ValueList manipulation.
604 case bitc::CST_CODE_NULL: // NULL
605 V = Constant::getNullValue(CurTy);
607 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
608 if (!isa<IntegerType>(CurTy) || Record.empty())
609 return Error("Invalid CST_INTEGER record");
610 V = ConstantInt::get(CurTy, DecodeSignRotatedValue(Record[0]));
612 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
613 if (!isa<IntegerType>(CurTy) || Record.empty())
614 return Error("Invalid WIDE_INTEGER record");
616 unsigned NumWords = Record.size();
617 SmallVector<uint64_t, 8> Words;
618 Words.resize(NumWords);
619 for (unsigned i = 0; i != NumWords; ++i)
620 Words[i] = DecodeSignRotatedValue(Record[i]);
621 V = ConstantInt::get(APInt(cast<IntegerType>(CurTy)->getBitWidth(),
622 NumWords, &Words[0]));
625 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
627 return Error("Invalid FLOAT record");
628 if (CurTy == Type::FloatTy)
629 V = ConstantFP::get(CurTy, APFloat(APInt(32, (uint32_t)Record[0])));
630 else if (CurTy == Type::DoubleTy)
631 V = ConstantFP::get(CurTy, APFloat(APInt(64, Record[0])));
632 else if (CurTy == Type::X86_FP80Ty)
633 V = ConstantFP::get(CurTy, APFloat(APInt(80, 2, &Record[0])));
634 else if (CurTy == Type::FP128Ty)
635 V = ConstantFP::get(CurTy, APFloat(APInt(128, 2, &Record[0])));
636 else if (CurTy == Type::PPC_FP128Ty)
637 assert(0 && "PowerPC long double constants not handled yet.");
639 V = UndefValue::get(CurTy);
643 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
645 return Error("Invalid CST_AGGREGATE record");
647 unsigned Size = Record.size();
648 std::vector<Constant*> Elts;
650 if (const StructType *STy = dyn_cast<StructType>(CurTy)) {
651 for (unsigned i = 0; i != Size; ++i)
652 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
653 STy->getElementType(i)));
654 V = ConstantStruct::get(STy, Elts);
655 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
656 const Type *EltTy = ATy->getElementType();
657 for (unsigned i = 0; i != Size; ++i)
658 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
659 V = ConstantArray::get(ATy, Elts);
660 } else if (const VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
661 const Type *EltTy = VTy->getElementType();
662 for (unsigned i = 0; i != Size; ++i)
663 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
664 V = ConstantVector::get(Elts);
666 V = UndefValue::get(CurTy);
670 case bitc::CST_CODE_STRING: { // STRING: [values]
672 return Error("Invalid CST_AGGREGATE record");
674 const ArrayType *ATy = cast<ArrayType>(CurTy);
675 const Type *EltTy = ATy->getElementType();
677 unsigned Size = Record.size();
678 std::vector<Constant*> Elts;
679 for (unsigned i = 0; i != Size; ++i)
680 Elts.push_back(ConstantInt::get(EltTy, Record[i]));
681 V = ConstantArray::get(ATy, Elts);
684 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
686 return Error("Invalid CST_AGGREGATE record");
688 const ArrayType *ATy = cast<ArrayType>(CurTy);
689 const Type *EltTy = ATy->getElementType();
691 unsigned Size = Record.size();
692 std::vector<Constant*> Elts;
693 for (unsigned i = 0; i != Size; ++i)
694 Elts.push_back(ConstantInt::get(EltTy, Record[i]));
695 Elts.push_back(Constant::getNullValue(EltTy));
696 V = ConstantArray::get(ATy, Elts);
699 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
700 if (Record.size() < 3) return Error("Invalid CE_BINOP record");
701 int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
703 V = UndefValue::get(CurTy); // Unknown binop.
705 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
706 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
707 V = ConstantExpr::get(Opc, LHS, RHS);
711 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
712 if (Record.size() < 3) return Error("Invalid CE_CAST record");
713 int Opc = GetDecodedCastOpcode(Record[0]);
715 V = UndefValue::get(CurTy); // Unknown cast.
717 const Type *OpTy = getTypeByID(Record[1]);
718 if (!OpTy) return Error("Invalid CE_CAST record");
719 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
720 V = ConstantExpr::getCast(Opc, Op, CurTy);
724 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
725 if (Record.size() & 1) return Error("Invalid CE_GEP record");
726 SmallVector<Constant*, 16> Elts;
727 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
728 const Type *ElTy = getTypeByID(Record[i]);
729 if (!ElTy) return Error("Invalid CE_GEP record");
730 Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
732 V = ConstantExpr::getGetElementPtr(Elts[0], &Elts[1], Elts.size()-1);
735 case bitc::CST_CODE_CE_SELECT: // CE_SELECT: [opval#, opval#, opval#]
736 if (Record.size() < 3) return Error("Invalid CE_SELECT record");
737 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
739 ValueList.getConstantFwdRef(Record[1],CurTy),
740 ValueList.getConstantFwdRef(Record[2],CurTy));
742 case bitc::CST_CODE_CE_EXTRACTELT: { // CE_EXTRACTELT: [opty, opval, opval]
743 if (Record.size() < 3) return Error("Invalid CE_EXTRACTELT record");
744 const VectorType *OpTy =
745 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
746 if (OpTy == 0) return Error("Invalid CE_EXTRACTELT record");
747 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
748 Constant *Op1 = ValueList.getConstantFwdRef(Record[2],
749 OpTy->getElementType());
750 V = ConstantExpr::getExtractElement(Op0, Op1);
753 case bitc::CST_CODE_CE_INSERTELT: { // CE_INSERTELT: [opval, opval, opval]
754 const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
755 if (Record.size() < 3 || OpTy == 0)
756 return Error("Invalid CE_INSERTELT record");
757 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
758 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
759 OpTy->getElementType());
760 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], Type::Int32Ty);
761 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
764 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
765 const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
766 if (Record.size() < 3 || OpTy == 0)
767 return Error("Invalid CE_INSERTELT record");
768 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
769 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
770 const Type *ShufTy=VectorType::get(Type::Int32Ty, OpTy->getNumElements());
771 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
772 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
775 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
776 if (Record.size() < 4) return Error("Invalid CE_CMP record");
777 const Type *OpTy = getTypeByID(Record[0]);
778 if (OpTy == 0) return Error("Invalid CE_CMP record");
779 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
780 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
782 if (OpTy->isFloatingPoint())
783 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
785 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
788 case bitc::CST_CODE_INLINEASM: {
789 if (Record.size() < 2) return Error("Invalid INLINEASM record");
790 std::string AsmStr, ConstrStr;
791 bool HasSideEffects = Record[0];
792 unsigned AsmStrSize = Record[1];
793 if (2+AsmStrSize >= Record.size())
794 return Error("Invalid INLINEASM record");
795 unsigned ConstStrSize = Record[2+AsmStrSize];
796 if (3+AsmStrSize+ConstStrSize > Record.size())
797 return Error("Invalid INLINEASM record");
799 for (unsigned i = 0; i != AsmStrSize; ++i)
800 AsmStr += (char)Record[2+i];
801 for (unsigned i = 0; i != ConstStrSize; ++i)
802 ConstrStr += (char)Record[3+AsmStrSize+i];
803 const PointerType *PTy = cast<PointerType>(CurTy);
804 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
805 AsmStr, ConstrStr, HasSideEffects);
810 ValueList.AssignValue(V, NextCstNo);
815 /// RememberAndSkipFunctionBody - When we see the block for a function body,
816 /// remember where it is and then skip it. This lets us lazily deserialize the
818 bool BitcodeReader::RememberAndSkipFunctionBody() {
819 // Get the function we are talking about.
820 if (FunctionsWithBodies.empty())
821 return Error("Insufficient function protos");
823 Function *Fn = FunctionsWithBodies.back();
824 FunctionsWithBodies.pop_back();
826 // Save the current stream state.
827 uint64_t CurBit = Stream.GetCurrentBitNo();
828 DeferredFunctionInfo[Fn] = std::make_pair(CurBit, Fn->getLinkage());
830 // Set the functions linkage to GhostLinkage so we know it is lazily
832 Fn->setLinkage(GlobalValue::GhostLinkage);
834 // Skip over the function block for now.
835 if (Stream.SkipBlock())
836 return Error("Malformed block record");
840 bool BitcodeReader::ParseModule(const std::string &ModuleID) {
841 // Reject multiple MODULE_BLOCK's in a single bitstream.
843 return Error("Multiple MODULE_BLOCKs in same stream");
845 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
846 return Error("Malformed block record");
848 // Otherwise, create the module.
849 TheModule = new Module(ModuleID);
851 SmallVector<uint64_t, 64> Record;
852 std::vector<std::string> SectionTable;
854 // Read all the records for this module.
855 while (!Stream.AtEndOfStream()) {
856 unsigned Code = Stream.ReadCode();
857 if (Code == bitc::END_BLOCK) {
858 if (Stream.ReadBlockEnd())
859 return Error("Error at end of module block");
861 // Patch the initializers for globals and aliases up.
862 ResolveGlobalAndAliasInits();
863 if (!GlobalInits.empty() || !AliasInits.empty())
864 return Error("Malformed global initializer set");
865 if (!FunctionsWithBodies.empty())
866 return Error("Too few function bodies found");
868 // Look for intrinsic functions which need to be upgraded at some point
869 for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
871 if (Function* NewFn = UpgradeIntrinsicFunction(FI))
872 UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
875 // Force deallocation of memory for these vectors to favor the client that
876 // want lazy deserialization.
877 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
878 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
879 std::vector<Function*>().swap(FunctionsWithBodies);
883 if (Code == bitc::ENTER_SUBBLOCK) {
884 switch (Stream.ReadSubBlockID()) {
885 default: // Skip unknown content.
886 if (Stream.SkipBlock())
887 return Error("Malformed block record");
889 case bitc::BLOCKINFO_BLOCK_ID:
890 if (Stream.ReadBlockInfoBlock())
891 return Error("Malformed BlockInfoBlock");
893 case bitc::PARAMATTR_BLOCK_ID:
894 if (ParseParamAttrBlock())
897 case bitc::TYPE_BLOCK_ID:
898 if (ParseTypeTable())
901 case bitc::TYPE_SYMTAB_BLOCK_ID:
902 if (ParseTypeSymbolTable())
905 case bitc::VALUE_SYMTAB_BLOCK_ID:
906 if (ParseValueSymbolTable())
909 case bitc::CONSTANTS_BLOCK_ID:
910 if (ParseConstants() || ResolveGlobalAndAliasInits())
913 case bitc::FUNCTION_BLOCK_ID:
914 // If this is the first function body we've seen, reverse the
915 // FunctionsWithBodies list.
916 if (!HasReversedFunctionsWithBodies) {
917 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
918 HasReversedFunctionsWithBodies = true;
921 if (RememberAndSkipFunctionBody())
928 if (Code == bitc::DEFINE_ABBREV) {
929 Stream.ReadAbbrevRecord();
934 switch (Stream.ReadRecord(Code, Record)) {
935 default: break; // Default behavior, ignore unknown content.
936 case bitc::MODULE_CODE_VERSION: // VERSION: [version#]
937 if (Record.size() < 1)
938 return Error("Malformed MODULE_CODE_VERSION");
939 // Only version #0 is supported so far.
941 return Error("Unknown bitstream version!");
943 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
945 if (ConvertToString(Record, 0, S))
946 return Error("Invalid MODULE_CODE_TRIPLE record");
947 TheModule->setTargetTriple(S);
950 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
952 if (ConvertToString(Record, 0, S))
953 return Error("Invalid MODULE_CODE_DATALAYOUT record");
954 TheModule->setDataLayout(S);
957 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
959 if (ConvertToString(Record, 0, S))
960 return Error("Invalid MODULE_CODE_ASM record");
961 TheModule->setModuleInlineAsm(S);
964 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
966 if (ConvertToString(Record, 0, S))
967 return Error("Invalid MODULE_CODE_DEPLIB record");
968 TheModule->addLibrary(S);
971 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
973 if (ConvertToString(Record, 0, S))
974 return Error("Invalid MODULE_CODE_SECTIONNAME record");
975 SectionTable.push_back(S);
978 // GLOBALVAR: [type, isconst, initid,
979 // linkage, alignment, section, visibility, threadlocal]
980 case bitc::MODULE_CODE_GLOBALVAR: {
981 if (Record.size() < 6)
982 return Error("Invalid MODULE_CODE_GLOBALVAR record");
983 const Type *Ty = getTypeByID(Record[0]);
984 if (!isa<PointerType>(Ty))
985 return Error("Global not a pointer type!");
986 Ty = cast<PointerType>(Ty)->getElementType();
988 bool isConstant = Record[1];
989 GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
990 unsigned Alignment = (1 << Record[4]) >> 1;
993 if (Record[5]-1 >= SectionTable.size())
994 return Error("Invalid section ID");
995 Section = SectionTable[Record[5]-1];
997 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
998 if (Record.size() > 6)
999 Visibility = GetDecodedVisibility(Record[6]);
1000 bool isThreadLocal = false;
1001 if (Record.size() > 7)
1002 isThreadLocal = Record[7];
1004 GlobalVariable *NewGV =
1005 new GlobalVariable(Ty, isConstant, Linkage, 0, "", TheModule);
1006 NewGV->setAlignment(Alignment);
1007 if (!Section.empty())
1008 NewGV->setSection(Section);
1009 NewGV->setVisibility(Visibility);
1010 NewGV->setThreadLocal(isThreadLocal);
1012 ValueList.push_back(NewGV);
1014 // Remember which value to use for the global initializer.
1015 if (unsigned InitID = Record[2])
1016 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
1019 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
1020 // alignment, section, visibility]
1021 case bitc::MODULE_CODE_FUNCTION: {
1022 if (Record.size() < 8)
1023 return Error("Invalid MODULE_CODE_FUNCTION record");
1024 const Type *Ty = getTypeByID(Record[0]);
1025 if (!isa<PointerType>(Ty))
1026 return Error("Function not a pointer type!");
1027 const FunctionType *FTy =
1028 dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1030 return Error("Function not a pointer to function type!");
1032 Function *Func = new Function(FTy, GlobalValue::ExternalLinkage,
1035 Func->setCallingConv(Record[1]);
1036 bool isProto = Record[2];
1037 Func->setLinkage(GetDecodedLinkage(Record[3]));
1039 assert(Func->getFunctionType()->getParamAttrs() ==
1040 getParamAttrs(Record[4]));
1042 Func->setAlignment((1 << Record[5]) >> 1);
1044 if (Record[6]-1 >= SectionTable.size())
1045 return Error("Invalid section ID");
1046 Func->setSection(SectionTable[Record[6]-1]);
1048 Func->setVisibility(GetDecodedVisibility(Record[7]));
1050 ValueList.push_back(Func);
1052 // If this is a function with a body, remember the prototype we are
1053 // creating now, so that we can match up the body with them later.
1055 FunctionsWithBodies.push_back(Func);
1058 // ALIAS: [alias type, aliasee val#, linkage]
1059 case bitc::MODULE_CODE_ALIAS: {
1060 if (Record.size() < 3)
1061 return Error("Invalid MODULE_ALIAS record");
1062 const Type *Ty = getTypeByID(Record[0]);
1063 if (!isa<PointerType>(Ty))
1064 return Error("Function not a pointer type!");
1066 GlobalAlias *NewGA = new GlobalAlias(Ty, GetDecodedLinkage(Record[2]),
1068 ValueList.push_back(NewGA);
1069 AliasInits.push_back(std::make_pair(NewGA, Record[1]));
1072 /// MODULE_CODE_PURGEVALS: [numvals]
1073 case bitc::MODULE_CODE_PURGEVALS:
1074 // Trim down the value list to the specified size.
1075 if (Record.size() < 1 || Record[0] > ValueList.size())
1076 return Error("Invalid MODULE_PURGEVALS record");
1077 ValueList.shrinkTo(Record[0]);
1083 return Error("Premature end of bitstream");
1087 bool BitcodeReader::ParseBitcode() {
1090 if (Buffer->getBufferSize() & 3)
1091 return Error("Bitcode stream should be a multiple of 4 bytes in length");
1093 unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
1094 Stream.init(BufPtr, BufPtr+Buffer->getBufferSize());
1096 // Sniff for the signature.
1097 if (Stream.Read(8) != 'B' ||
1098 Stream.Read(8) != 'C' ||
1099 Stream.Read(4) != 0x0 ||
1100 Stream.Read(4) != 0xC ||
1101 Stream.Read(4) != 0xE ||
1102 Stream.Read(4) != 0xD)
1103 return Error("Invalid bitcode signature");
1105 // We expect a number of well-defined blocks, though we don't necessarily
1106 // need to understand them all.
1107 while (!Stream.AtEndOfStream()) {
1108 unsigned Code = Stream.ReadCode();
1110 if (Code != bitc::ENTER_SUBBLOCK)
1111 return Error("Invalid record at top-level");
1113 unsigned BlockID = Stream.ReadSubBlockID();
1115 // We only know the MODULE subblock ID.
1117 case bitc::BLOCKINFO_BLOCK_ID:
1118 if (Stream.ReadBlockInfoBlock())
1119 return Error("Malformed BlockInfoBlock");
1121 case bitc::MODULE_BLOCK_ID:
1122 if (ParseModule(Buffer->getBufferIdentifier()))
1126 if (Stream.SkipBlock())
1127 return Error("Malformed block record");
1136 /// ParseFunctionBody - Lazily parse the specified function body block.
1137 bool BitcodeReader::ParseFunctionBody(Function *F) {
1138 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
1139 return Error("Malformed block record");
1141 unsigned ModuleValueListSize = ValueList.size();
1143 // Add all the function arguments to the value table.
1144 for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
1145 ValueList.push_back(I);
1147 unsigned NextValueNo = ValueList.size();
1148 BasicBlock *CurBB = 0;
1149 unsigned CurBBNo = 0;
1151 // Read all the records.
1152 SmallVector<uint64_t, 64> Record;
1154 unsigned Code = Stream.ReadCode();
1155 if (Code == bitc::END_BLOCK) {
1156 if (Stream.ReadBlockEnd())
1157 return Error("Error at end of function block");
1161 if (Code == bitc::ENTER_SUBBLOCK) {
1162 switch (Stream.ReadSubBlockID()) {
1163 default: // Skip unknown content.
1164 if (Stream.SkipBlock())
1165 return Error("Malformed block record");
1167 case bitc::CONSTANTS_BLOCK_ID:
1168 if (ParseConstants()) return true;
1169 NextValueNo = ValueList.size();
1171 case bitc::VALUE_SYMTAB_BLOCK_ID:
1172 if (ParseValueSymbolTable()) return true;
1178 if (Code == bitc::DEFINE_ABBREV) {
1179 Stream.ReadAbbrevRecord();
1186 switch (Stream.ReadRecord(Code, Record)) {
1187 default: // Default behavior: reject
1188 return Error("Unknown instruction");
1189 case bitc::FUNC_CODE_DECLAREBLOCKS: // DECLAREBLOCKS: [nblocks]
1190 if (Record.size() < 1 || Record[0] == 0)
1191 return Error("Invalid DECLAREBLOCKS record");
1192 // Create all the basic blocks for the function.
1193 FunctionBBs.resize(Record[0]);
1194 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
1195 FunctionBBs[i] = new BasicBlock("", F);
1196 CurBB = FunctionBBs[0];
1199 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
1202 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1203 getValue(Record, OpNum, LHS->getType(), RHS) ||
1204 OpNum+1 != Record.size())
1205 return Error("Invalid BINOP record");
1207 int Opc = GetDecodedBinaryOpcode(Record[OpNum], LHS->getType());
1208 if (Opc == -1) return Error("Invalid BINOP record");
1209 I = BinaryOperator::create((Instruction::BinaryOps)Opc, LHS, RHS);
1212 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
1215 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1216 OpNum+2 != Record.size())
1217 return Error("Invalid CAST record");
1219 const Type *ResTy = getTypeByID(Record[OpNum]);
1220 int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
1221 if (Opc == -1 || ResTy == 0)
1222 return Error("Invalid CAST record");
1223 I = CastInst::create((Instruction::CastOps)Opc, Op, ResTy);
1226 case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
1229 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
1230 return Error("Invalid GEP record");
1232 SmallVector<Value*, 16> GEPIdx;
1233 while (OpNum != Record.size()) {
1235 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1236 return Error("Invalid GEP record");
1237 GEPIdx.push_back(Op);
1240 I = new GetElementPtrInst(BasePtr, GEPIdx.begin(), GEPIdx.end());
1244 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
1246 Value *TrueVal, *FalseVal, *Cond;
1247 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1248 getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1249 getValue(Record, OpNum, Type::Int1Ty, Cond))
1250 return Error("Invalid SELECT record");
1252 I = new SelectInst(Cond, TrueVal, FalseVal);
1256 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
1259 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1260 getValue(Record, OpNum, Type::Int32Ty, Idx))
1261 return Error("Invalid EXTRACTELT record");
1262 I = new ExtractElementInst(Vec, Idx);
1266 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
1268 Value *Vec, *Elt, *Idx;
1269 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1270 getValue(Record, OpNum,
1271 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
1272 getValue(Record, OpNum, Type::Int32Ty, Idx))
1273 return Error("Invalid INSERTELT record");
1274 I = new InsertElementInst(Vec, Elt, Idx);
1278 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
1280 Value *Vec1, *Vec2, *Mask;
1281 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
1282 getValue(Record, OpNum, Vec1->getType(), Vec2))
1283 return Error("Invalid SHUFFLEVEC record");
1285 const Type *MaskTy =
1286 VectorType::get(Type::Int32Ty,
1287 cast<VectorType>(Vec1->getType())->getNumElements());
1289 if (getValue(Record, OpNum, MaskTy, Mask))
1290 return Error("Invalid SHUFFLEVEC record");
1291 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
1295 case bitc::FUNC_CODE_INST_CMP: { // CMP: [opty, opval, opval, pred]
1298 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1299 getValue(Record, OpNum, LHS->getType(), RHS) ||
1300 OpNum+1 != Record.size())
1301 return Error("Invalid CMP record");
1303 if (LHS->getType()->isFPOrFPVector())
1304 I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
1306 I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
1310 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
1311 if (Record.size() == 0) {
1312 I = new ReturnInst();
1317 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1318 OpNum != Record.size())
1319 return Error("Invalid RET record");
1320 I = new ReturnInst(Op);
1323 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
1324 if (Record.size() != 1 && Record.size() != 3)
1325 return Error("Invalid BR record");
1326 BasicBlock *TrueDest = getBasicBlock(Record[0]);
1328 return Error("Invalid BR record");
1330 if (Record.size() == 1)
1331 I = new BranchInst(TrueDest);
1333 BasicBlock *FalseDest = getBasicBlock(Record[1]);
1334 Value *Cond = getFnValueByID(Record[2], Type::Int1Ty);
1335 if (FalseDest == 0 || Cond == 0)
1336 return Error("Invalid BR record");
1337 I = new BranchInst(TrueDest, FalseDest, Cond);
1341 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, opval, n, n x ops]
1342 if (Record.size() < 3 || (Record.size() & 1) == 0)
1343 return Error("Invalid SWITCH record");
1344 const Type *OpTy = getTypeByID(Record[0]);
1345 Value *Cond = getFnValueByID(Record[1], OpTy);
1346 BasicBlock *Default = getBasicBlock(Record[2]);
1347 if (OpTy == 0 || Cond == 0 || Default == 0)
1348 return Error("Invalid SWITCH record");
1349 unsigned NumCases = (Record.size()-3)/2;
1350 SwitchInst *SI = new SwitchInst(Cond, Default, NumCases);
1351 for (unsigned i = 0, e = NumCases; i != e; ++i) {
1352 ConstantInt *CaseVal =
1353 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
1354 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
1355 if (CaseVal == 0 || DestBB == 0) {
1357 return Error("Invalid SWITCH record!");
1359 SI->addCase(CaseVal, DestBB);
1365 case bitc::FUNC_CODE_INST_INVOKE: { // INVOKE: [cc,fnty, op0,op1,op2, ...]
1366 if (Record.size() < 4) return Error("Invalid INVOKE record");
1367 unsigned CCInfo = Record[1];
1368 BasicBlock *NormalBB = getBasicBlock(Record[2]);
1369 BasicBlock *UnwindBB = getBasicBlock(Record[3]);
1373 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
1374 return Error("Invalid INVOKE record");
1376 const PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
1377 const FunctionType *FTy = !CalleeTy ? 0 :
1378 dyn_cast<FunctionType>(CalleeTy->getElementType());
1380 // Check that the right number of fixed parameters are here.
1381 if (FTy == 0 || NormalBB == 0 || UnwindBB == 0 ||
1382 Record.size() < OpNum+FTy->getNumParams())
1383 return Error("Invalid INVOKE record");
1385 assert(FTy->getParamAttrs() == getParamAttrs(Record[0]));
1387 SmallVector<Value*, 16> Ops;
1388 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
1389 Ops.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
1390 if (Ops.back() == 0) return Error("Invalid INVOKE record");
1393 if (!FTy->isVarArg()) {
1394 if (Record.size() != OpNum)
1395 return Error("Invalid INVOKE record");
1397 // Read type/value pairs for varargs params.
1398 while (OpNum != Record.size()) {
1400 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1401 return Error("Invalid INVOKE record");
1406 I = new InvokeInst(Callee, NormalBB, UnwindBB, Ops.begin(), Ops.end());
1407 cast<InvokeInst>(I)->setCallingConv(CCInfo);
1410 case bitc::FUNC_CODE_INST_UNWIND: // UNWIND
1411 I = new UnwindInst();
1413 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
1414 I = new UnreachableInst();
1416 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
1417 if (Record.size() < 1 || ((Record.size()-1)&1))
1418 return Error("Invalid PHI record");
1419 const Type *Ty = getTypeByID(Record[0]);
1420 if (!Ty) return Error("Invalid PHI record");
1422 PHINode *PN = new PHINode(Ty);
1423 PN->reserveOperandSpace(Record.size()-1);
1425 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
1426 Value *V = getFnValueByID(Record[1+i], Ty);
1427 BasicBlock *BB = getBasicBlock(Record[2+i]);
1428 if (!V || !BB) return Error("Invalid PHI record");
1429 PN->addIncoming(V, BB);
1435 case bitc::FUNC_CODE_INST_MALLOC: { // MALLOC: [instty, op, align]
1436 if (Record.size() < 3)
1437 return Error("Invalid MALLOC record");
1438 const PointerType *Ty =
1439 dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
1440 Value *Size = getFnValueByID(Record[1], Type::Int32Ty);
1441 unsigned Align = Record[2];
1442 if (!Ty || !Size) return Error("Invalid MALLOC record");
1443 I = new MallocInst(Ty->getElementType(), Size, (1 << Align) >> 1);
1446 case bitc::FUNC_CODE_INST_FREE: { // FREE: [op, opty]
1449 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1450 OpNum != Record.size())
1451 return Error("Invalid FREE record");
1452 I = new FreeInst(Op);
1455 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, op, align]
1456 if (Record.size() < 3)
1457 return Error("Invalid ALLOCA record");
1458 const PointerType *Ty =
1459 dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
1460 Value *Size = getFnValueByID(Record[1], Type::Int32Ty);
1461 unsigned Align = Record[2];
1462 if (!Ty || !Size) return Error("Invalid ALLOCA record");
1463 I = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
1466 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
1469 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1470 OpNum+2 != Record.size())
1471 return Error("Invalid LOAD record");
1473 I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
1476 case bitc::FUNC_CODE_INST_STORE: { // STORE:[val, valty, ptr, align, vol]
1479 if (getValueTypePair(Record, OpNum, NextValueNo, Val) ||
1480 getValue(Record, OpNum, PointerType::get(Val->getType()), Ptr) ||
1481 OpNum+2 != Record.size())
1482 return Error("Invalid STORE record");
1484 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
1487 case bitc::FUNC_CODE_INST_CALL: { // CALL: [cc, fnty, fnid, arg0, arg1...]
1488 if (Record.size() < 2)
1489 return Error("Invalid CALL record");
1491 unsigned CCInfo = Record[1];
1495 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
1496 return Error("Invalid CALL record");
1498 const PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
1499 const FunctionType *FTy = 0;
1500 if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
1501 if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
1502 return Error("Invalid CALL record");
1504 assert(FTy->getParamAttrs() == getParamAttrs(Record[0]));
1506 SmallVector<Value*, 16> Args;
1507 // Read the fixed params.
1508 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
1509 Args.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
1510 if (Args.back() == 0) return Error("Invalid CALL record");
1513 // Read type/value pairs for varargs params.
1514 if (!FTy->isVarArg()) {
1515 if (OpNum != Record.size())
1516 return Error("Invalid CALL record");
1518 while (OpNum != Record.size()) {
1520 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1521 return Error("Invalid CALL record");
1526 I = new CallInst(Callee, Args.begin(), Args.end());
1527 cast<CallInst>(I)->setCallingConv(CCInfo>>1);
1528 cast<CallInst>(I)->setTailCall(CCInfo & 1);
1531 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
1532 if (Record.size() < 3)
1533 return Error("Invalid VAARG record");
1534 const Type *OpTy = getTypeByID(Record[0]);
1535 Value *Op = getFnValueByID(Record[1], OpTy);
1536 const Type *ResTy = getTypeByID(Record[2]);
1537 if (!OpTy || !Op || !ResTy)
1538 return Error("Invalid VAARG record");
1539 I = new VAArgInst(Op, ResTy);
1544 // Add instruction to end of current BB. If there is no current BB, reject
1548 return Error("Invalid instruction with no BB");
1550 CurBB->getInstList().push_back(I);
1552 // If this was a terminator instruction, move to the next block.
1553 if (isa<TerminatorInst>(I)) {
1555 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : 0;
1558 // Non-void values get registered in the value table for future use.
1559 if (I && I->getType() != Type::VoidTy)
1560 ValueList.AssignValue(I, NextValueNo++);
1563 // Check the function list for unresolved values.
1564 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
1565 if (A->getParent() == 0) {
1566 // We found at least one unresolved value. Nuke them all to avoid leaks.
1567 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
1568 if ((A = dyn_cast<Argument>(ValueList.back())) && A->getParent() == 0) {
1569 A->replaceAllUsesWith(UndefValue::get(A->getType()));
1573 return Error("Never resolved value found in function!");
1577 // Trim the value list down to the size it was before we parsed this function.
1578 ValueList.shrinkTo(ModuleValueListSize);
1579 std::vector<BasicBlock*>().swap(FunctionBBs);
1584 //===----------------------------------------------------------------------===//
1585 // ModuleProvider implementation
1586 //===----------------------------------------------------------------------===//
1589 bool BitcodeReader::materializeFunction(Function *F, std::string *ErrInfo) {
1590 // If it already is material, ignore the request.
1591 if (!F->hasNotBeenReadFromBitcode()) return false;
1593 DenseMap<Function*, std::pair<uint64_t, unsigned> >::iterator DFII =
1594 DeferredFunctionInfo.find(F);
1595 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
1597 // Move the bit stream to the saved position of the deferred function body and
1598 // restore the real linkage type for the function.
1599 Stream.JumpToBit(DFII->second.first);
1600 F->setLinkage((GlobalValue::LinkageTypes)DFII->second.second);
1602 if (ParseFunctionBody(F)) {
1603 if (ErrInfo) *ErrInfo = ErrorString;
1607 // Upgrade any old intrinsic calls in the function.
1608 for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
1609 E = UpgradedIntrinsics.end(); I != E; ++I) {
1610 if (I->first != I->second) {
1611 for (Value::use_iterator UI = I->first->use_begin(),
1612 UE = I->first->use_end(); UI != UE; ) {
1613 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
1614 UpgradeIntrinsicCall(CI, I->second);
1622 void BitcodeReader::dematerializeFunction(Function *F) {
1623 // If this function isn't materialized, or if it is a proto, this is a noop.
1624 if (F->hasNotBeenReadFromBitcode() || F->isDeclaration())
1627 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
1629 // Just forget the function body, we can remat it later.
1631 F->setLinkage(GlobalValue::GhostLinkage);
1635 Module *BitcodeReader::materializeModule(std::string *ErrInfo) {
1636 for (DenseMap<Function*, std::pair<uint64_t, unsigned> >::iterator I =
1637 DeferredFunctionInfo.begin(), E = DeferredFunctionInfo.end(); I != E;
1639 Function *F = I->first;
1640 if (F->hasNotBeenReadFromBitcode() &&
1641 materializeFunction(F, ErrInfo))
1645 // Upgrade any intrinsic calls that slipped through (should not happen!) and
1646 // delete the old functions to clean up. We can't do this unless the entire
1647 // module is materialized because there could always be another function body
1648 // with calls to the old function.
1649 for (std::vector<std::pair<Function*, Function*> >::iterator I =
1650 UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
1651 if (I->first != I->second) {
1652 for (Value::use_iterator UI = I->first->use_begin(),
1653 UE = I->first->use_end(); UI != UE; ) {
1654 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
1655 UpgradeIntrinsicCall(CI, I->second);
1657 ValueList.replaceUsesOfWith(I->first, I->second);
1658 I->first->eraseFromParent();
1661 std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
1667 /// This method is provided by the parent ModuleProvde class and overriden
1668 /// here. It simply releases the module from its provided and frees up our
1670 /// @brief Release our hold on the generated module
1671 Module *BitcodeReader::releaseModule(std::string *ErrInfo) {
1672 // Since we're losing control of this Module, we must hand it back complete
1673 Module *M = ModuleProvider::releaseModule(ErrInfo);
1679 //===----------------------------------------------------------------------===//
1680 // External interface
1681 //===----------------------------------------------------------------------===//
1683 /// getBitcodeModuleProvider - lazy function-at-a-time loading from a file.
1685 ModuleProvider *llvm::getBitcodeModuleProvider(MemoryBuffer *Buffer,
1686 std::string *ErrMsg) {
1687 BitcodeReader *R = new BitcodeReader(Buffer);
1688 if (R->ParseBitcode()) {
1690 *ErrMsg = R->getErrorString();
1692 // Don't let the BitcodeReader dtor delete 'Buffer'.
1693 R->releaseMemoryBuffer();
1700 /// ParseBitcodeFile - Read the specified bitcode file, returning the module.
1701 /// If an error occurs, return null and fill in *ErrMsg if non-null.
1702 Module *llvm::ParseBitcodeFile(MemoryBuffer *Buffer, std::string *ErrMsg){
1704 R = static_cast<BitcodeReader*>(getBitcodeModuleProvider(Buffer, ErrMsg));
1707 // Read in the entire module.
1708 Module *M = R->materializeModule(ErrMsg);
1710 // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether
1711 // there was an error.
1712 R->releaseMemoryBuffer();
1714 // If there was no error, tell ModuleProvider not to delete it when its dtor
1717 M = R->releaseModule(ErrMsg);