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 #include "llvm/Bitcode/ReaderWriter.h"
11 #include "BitcodeReader.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/Bitcode/LLVMBitCodes.h"
15 #include "llvm/IR/AutoUpgrade.h"
16 #include "llvm/IR/Constants.h"
17 #include "llvm/IR/DerivedTypes.h"
18 #include "llvm/IR/InlineAsm.h"
19 #include "llvm/IR/IntrinsicInst.h"
20 #include "llvm/IR/LLVMContext.h"
21 #include "llvm/IR/Module.h"
22 #include "llvm/IR/OperandTraits.h"
23 #include "llvm/IR/Operator.h"
24 #include "llvm/Support/DataStream.h"
25 #include "llvm/Support/MathExtras.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include "llvm/Support/ManagedStatic.h"
33 SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
36 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
37 if (WillMaterializeAllForwardRefs)
38 return std::error_code();
41 WillMaterializeAllForwardRefs = true;
43 while (!BasicBlockFwdRefQueue.empty()) {
44 Function *F = BasicBlockFwdRefQueue.front();
45 BasicBlockFwdRefQueue.pop_front();
46 assert(F && "Expected valid function");
47 if (!BasicBlockFwdRefs.count(F))
48 // Already materialized.
51 // Check for a function that isn't materializable to prevent an infinite
52 // loop. When parsing a blockaddress stored in a global variable, there
53 // isn't a trivial way to check if a function will have a body without a
54 // linear search through FunctionsWithBodies, so just check it here.
55 if (!F->isMaterializable())
56 return Error(BitcodeError::NeverResolvedFunctionFromBlockAddress);
58 // Try to materialize F.
59 if (std::error_code EC = Materialize(F))
62 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
65 WillMaterializeAllForwardRefs = false;
66 return std::error_code();
69 void BitcodeReader::FreeState() {
71 std::vector<Type*>().swap(TypeList);
74 std::vector<Comdat *>().swap(ComdatList);
76 std::vector<AttributeSet>().swap(MAttributes);
77 std::vector<BasicBlock*>().swap(FunctionBBs);
78 std::vector<Function*>().swap(FunctionsWithBodies);
79 DeferredFunctionInfo.clear();
82 assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
83 BasicBlockFwdRefQueue.clear();
86 //===----------------------------------------------------------------------===//
87 // Helper functions to implement forward reference resolution, etc.
88 //===----------------------------------------------------------------------===//
90 /// ConvertToString - Convert a string from a record into an std::string, return
92 template<typename StrTy>
93 static bool ConvertToString(ArrayRef<uint64_t> Record, unsigned Idx,
95 if (Idx > Record.size())
98 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
99 Result += (char)Record[i];
103 static GlobalValue::LinkageTypes GetDecodedLinkage(unsigned Val) {
105 default: // Map unknown/new linkages to external
106 case 0: return GlobalValue::ExternalLinkage;
107 case 1: return GlobalValue::WeakAnyLinkage;
108 case 2: return GlobalValue::AppendingLinkage;
109 case 3: return GlobalValue::InternalLinkage;
110 case 4: return GlobalValue::LinkOnceAnyLinkage;
111 case 5: return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
112 case 6: return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
113 case 7: return GlobalValue::ExternalWeakLinkage;
114 case 8: return GlobalValue::CommonLinkage;
115 case 9: return GlobalValue::PrivateLinkage;
116 case 10: return GlobalValue::WeakODRLinkage;
117 case 11: return GlobalValue::LinkOnceODRLinkage;
118 case 12: return GlobalValue::AvailableExternallyLinkage;
120 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
122 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
126 static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
128 default: // Map unknown visibilities to default.
129 case 0: return GlobalValue::DefaultVisibility;
130 case 1: return GlobalValue::HiddenVisibility;
131 case 2: return GlobalValue::ProtectedVisibility;
135 static GlobalValue::DLLStorageClassTypes
136 GetDecodedDLLStorageClass(unsigned Val) {
138 default: // Map unknown values to default.
139 case 0: return GlobalValue::DefaultStorageClass;
140 case 1: return GlobalValue::DLLImportStorageClass;
141 case 2: return GlobalValue::DLLExportStorageClass;
145 static GlobalVariable::ThreadLocalMode GetDecodedThreadLocalMode(unsigned Val) {
147 case 0: return GlobalVariable::NotThreadLocal;
148 default: // Map unknown non-zero value to general dynamic.
149 case 1: return GlobalVariable::GeneralDynamicTLSModel;
150 case 2: return GlobalVariable::LocalDynamicTLSModel;
151 case 3: return GlobalVariable::InitialExecTLSModel;
152 case 4: return GlobalVariable::LocalExecTLSModel;
156 static int GetDecodedCastOpcode(unsigned Val) {
159 case bitc::CAST_TRUNC : return Instruction::Trunc;
160 case bitc::CAST_ZEXT : return Instruction::ZExt;
161 case bitc::CAST_SEXT : return Instruction::SExt;
162 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
163 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
164 case bitc::CAST_UITOFP : return Instruction::UIToFP;
165 case bitc::CAST_SITOFP : return Instruction::SIToFP;
166 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
167 case bitc::CAST_FPEXT : return Instruction::FPExt;
168 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
169 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
170 case bitc::CAST_BITCAST : return Instruction::BitCast;
171 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
174 static int GetDecodedBinaryOpcode(unsigned Val, Type *Ty) {
177 case bitc::BINOP_ADD:
178 return Ty->isFPOrFPVectorTy() ? Instruction::FAdd : Instruction::Add;
179 case bitc::BINOP_SUB:
180 return Ty->isFPOrFPVectorTy() ? Instruction::FSub : Instruction::Sub;
181 case bitc::BINOP_MUL:
182 return Ty->isFPOrFPVectorTy() ? Instruction::FMul : Instruction::Mul;
183 case bitc::BINOP_UDIV: return Instruction::UDiv;
184 case bitc::BINOP_SDIV:
185 return Ty->isFPOrFPVectorTy() ? Instruction::FDiv : Instruction::SDiv;
186 case bitc::BINOP_UREM: return Instruction::URem;
187 case bitc::BINOP_SREM:
188 return Ty->isFPOrFPVectorTy() ? Instruction::FRem : Instruction::SRem;
189 case bitc::BINOP_SHL: return Instruction::Shl;
190 case bitc::BINOP_LSHR: return Instruction::LShr;
191 case bitc::BINOP_ASHR: return Instruction::AShr;
192 case bitc::BINOP_AND: return Instruction::And;
193 case bitc::BINOP_OR: return Instruction::Or;
194 case bitc::BINOP_XOR: return Instruction::Xor;
198 static AtomicRMWInst::BinOp GetDecodedRMWOperation(unsigned Val) {
200 default: return AtomicRMWInst::BAD_BINOP;
201 case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
202 case bitc::RMW_ADD: return AtomicRMWInst::Add;
203 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
204 case bitc::RMW_AND: return AtomicRMWInst::And;
205 case bitc::RMW_NAND: return AtomicRMWInst::Nand;
206 case bitc::RMW_OR: return AtomicRMWInst::Or;
207 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
208 case bitc::RMW_MAX: return AtomicRMWInst::Max;
209 case bitc::RMW_MIN: return AtomicRMWInst::Min;
210 case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
211 case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
215 static AtomicOrdering GetDecodedOrdering(unsigned Val) {
217 case bitc::ORDERING_NOTATOMIC: return NotAtomic;
218 case bitc::ORDERING_UNORDERED: return Unordered;
219 case bitc::ORDERING_MONOTONIC: return Monotonic;
220 case bitc::ORDERING_ACQUIRE: return Acquire;
221 case bitc::ORDERING_RELEASE: return Release;
222 case bitc::ORDERING_ACQREL: return AcquireRelease;
223 default: // Map unknown orderings to sequentially-consistent.
224 case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
228 static SynchronizationScope GetDecodedSynchScope(unsigned Val) {
230 case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
231 default: // Map unknown scopes to cross-thread.
232 case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
236 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
238 default: // Map unknown selection kinds to any.
239 case bitc::COMDAT_SELECTION_KIND_ANY:
241 case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
242 return Comdat::ExactMatch;
243 case bitc::COMDAT_SELECTION_KIND_LARGEST:
244 return Comdat::Largest;
245 case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
246 return Comdat::NoDuplicates;
247 case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
248 return Comdat::SameSize;
252 static void UpgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
254 case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
255 case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
261 /// @brief A class for maintaining the slot number definition
262 /// as a placeholder for the actual definition for forward constants defs.
263 class ConstantPlaceHolder : public ConstantExpr {
264 void operator=(const ConstantPlaceHolder &) LLVM_DELETED_FUNCTION;
266 // allocate space for exactly one operand
267 void *operator new(size_t s) {
268 return User::operator new(s, 1);
270 explicit ConstantPlaceHolder(Type *Ty, LLVMContext& Context)
271 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
272 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
275 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
276 static bool classof(const Value *V) {
277 return isa<ConstantExpr>(V) &&
278 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
282 /// Provide fast operand accessors
283 //DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
287 // FIXME: can we inherit this from ConstantExpr?
289 struct OperandTraits<ConstantPlaceHolder> :
290 public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
295 void BitcodeReaderValueList::AssignValue(Value *V, unsigned Idx) {
304 WeakVH &OldV = ValuePtrs[Idx];
310 // Handle constants and non-constants (e.g. instrs) differently for
312 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
313 ResolveConstants.push_back(std::make_pair(PHC, Idx));
316 // If there was a forward reference to this value, replace it.
317 Value *PrevVal = OldV;
318 OldV->replaceAllUsesWith(V);
324 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
329 if (Value *V = ValuePtrs[Idx]) {
330 assert(Ty == V->getType() && "Type mismatch in constant table!");
331 return cast<Constant>(V);
334 // Create and return a placeholder, which will later be RAUW'd.
335 Constant *C = new ConstantPlaceHolder(Ty, Context);
340 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty) {
344 if (Value *V = ValuePtrs[Idx]) {
345 assert((!Ty || Ty == V->getType()) && "Type mismatch in value table!");
349 // No type specified, must be invalid reference.
350 if (!Ty) return nullptr;
352 // Create and return a placeholder, which will later be RAUW'd.
353 Value *V = new Argument(Ty);
358 /// ResolveConstantForwardRefs - Once all constants are read, this method bulk
359 /// resolves any forward references. The idea behind this is that we sometimes
360 /// get constants (such as large arrays) which reference *many* forward ref
361 /// constants. Replacing each of these causes a lot of thrashing when
362 /// building/reuniquing the constant. Instead of doing this, we look at all the
363 /// uses and rewrite all the place holders at once for any constant that uses
365 void BitcodeReaderValueList::ResolveConstantForwardRefs() {
366 // Sort the values by-pointer so that they are efficient to look up with a
368 std::sort(ResolveConstants.begin(), ResolveConstants.end());
370 SmallVector<Constant*, 64> NewOps;
372 while (!ResolveConstants.empty()) {
373 Value *RealVal = operator[](ResolveConstants.back().second);
374 Constant *Placeholder = ResolveConstants.back().first;
375 ResolveConstants.pop_back();
377 // Loop over all users of the placeholder, updating them to reference the
378 // new value. If they reference more than one placeholder, update them all
380 while (!Placeholder->use_empty()) {
381 auto UI = Placeholder->user_begin();
384 // If the using object isn't uniqued, just update the operands. This
385 // handles instructions and initializers for global variables.
386 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
387 UI.getUse().set(RealVal);
391 // Otherwise, we have a constant that uses the placeholder. Replace that
392 // constant with a new constant that has *all* placeholder uses updated.
393 Constant *UserC = cast<Constant>(U);
394 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
397 if (!isa<ConstantPlaceHolder>(*I)) {
398 // Not a placeholder reference.
400 } else if (*I == Placeholder) {
401 // Common case is that it just references this one placeholder.
404 // Otherwise, look up the placeholder in ResolveConstants.
405 ResolveConstantsTy::iterator It =
406 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
407 std::pair<Constant*, unsigned>(cast<Constant>(*I),
409 assert(It != ResolveConstants.end() && It->first == *I);
410 NewOp = operator[](It->second);
413 NewOps.push_back(cast<Constant>(NewOp));
416 // Make the new constant.
418 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
419 NewC = ConstantArray::get(UserCA->getType(), NewOps);
420 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
421 NewC = ConstantStruct::get(UserCS->getType(), NewOps);
422 } else if (isa<ConstantVector>(UserC)) {
423 NewC = ConstantVector::get(NewOps);
425 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
426 NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
429 UserC->replaceAllUsesWith(NewC);
430 UserC->destroyConstant();
434 // Update all ValueHandles, they should be the only users at this point.
435 Placeholder->replaceAllUsesWith(RealVal);
440 void BitcodeReaderMDValueList::AssignValue(Value *V, unsigned Idx) {
449 WeakVH &OldV = MDValuePtrs[Idx];
455 // If there was a forward reference to this value, replace it.
456 MDNode *PrevVal = cast<MDNode>(OldV);
457 OldV->replaceAllUsesWith(V);
458 MDNode::deleteTemporary(PrevVal);
459 // Deleting PrevVal sets Idx value in MDValuePtrs to null. Set new
461 MDValuePtrs[Idx] = V;
464 Value *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
468 if (Value *V = MDValuePtrs[Idx]) {
469 assert(V->getType()->isMetadataTy() && "Type mismatch in value table!");
473 // Create and return a placeholder, which will later be RAUW'd.
474 Value *V = MDNode::getTemporary(Context, None);
475 MDValuePtrs[Idx] = V;
479 Type *BitcodeReader::getTypeByID(unsigned ID) {
480 // The type table size is always specified correctly.
481 if (ID >= TypeList.size())
484 if (Type *Ty = TypeList[ID])
487 // If we have a forward reference, the only possible case is when it is to a
488 // named struct. Just create a placeholder for now.
489 return TypeList[ID] = StructType::create(Context);
493 //===----------------------------------------------------------------------===//
494 // Functions for parsing blocks from the bitcode file
495 //===----------------------------------------------------------------------===//
498 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
499 /// been decoded from the given integer. This function must stay in sync with
500 /// 'encodeLLVMAttributesForBitcode'.
501 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
502 uint64_t EncodedAttrs) {
503 // FIXME: Remove in 4.0.
505 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
506 // the bits above 31 down by 11 bits.
507 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
508 assert((!Alignment || isPowerOf2_32(Alignment)) &&
509 "Alignment must be a power of two.");
512 B.addAlignmentAttr(Alignment);
513 B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
514 (EncodedAttrs & 0xffff));
517 std::error_code BitcodeReader::ParseAttributeBlock() {
518 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
519 return Error(BitcodeError::InvalidRecord);
521 if (!MAttributes.empty())
522 return Error(BitcodeError::InvalidMultipleBlocks);
524 SmallVector<uint64_t, 64> Record;
526 SmallVector<AttributeSet, 8> Attrs;
528 // Read all the records.
530 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
532 switch (Entry.Kind) {
533 case BitstreamEntry::SubBlock: // Handled for us already.
534 case BitstreamEntry::Error:
535 return Error(BitcodeError::MalformedBlock);
536 case BitstreamEntry::EndBlock:
537 return std::error_code();
538 case BitstreamEntry::Record:
539 // The interesting case.
545 switch (Stream.readRecord(Entry.ID, Record)) {
546 default: // Default behavior: ignore.
548 case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
549 // FIXME: Remove in 4.0.
550 if (Record.size() & 1)
551 return Error(BitcodeError::InvalidRecord);
553 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
555 decodeLLVMAttributesForBitcode(B, Record[i+1]);
556 Attrs.push_back(AttributeSet::get(Context, Record[i], B));
559 MAttributes.push_back(AttributeSet::get(Context, Attrs));
563 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
564 for (unsigned i = 0, e = Record.size(); i != e; ++i)
565 Attrs.push_back(MAttributeGroups[Record[i]]);
567 MAttributes.push_back(AttributeSet::get(Context, Attrs));
575 // Returns Attribute::None on unrecognized codes.
576 static Attribute::AttrKind GetAttrFromCode(uint64_t Code) {
579 return Attribute::None;
580 case bitc::ATTR_KIND_ALIGNMENT:
581 return Attribute::Alignment;
582 case bitc::ATTR_KIND_ALWAYS_INLINE:
583 return Attribute::AlwaysInline;
584 case bitc::ATTR_KIND_BUILTIN:
585 return Attribute::Builtin;
586 case bitc::ATTR_KIND_BY_VAL:
587 return Attribute::ByVal;
588 case bitc::ATTR_KIND_IN_ALLOCA:
589 return Attribute::InAlloca;
590 case bitc::ATTR_KIND_COLD:
591 return Attribute::Cold;
592 case bitc::ATTR_KIND_INLINE_HINT:
593 return Attribute::InlineHint;
594 case bitc::ATTR_KIND_IN_REG:
595 return Attribute::InReg;
596 case bitc::ATTR_KIND_JUMP_TABLE:
597 return Attribute::JumpTable;
598 case bitc::ATTR_KIND_MIN_SIZE:
599 return Attribute::MinSize;
600 case bitc::ATTR_KIND_NAKED:
601 return Attribute::Naked;
602 case bitc::ATTR_KIND_NEST:
603 return Attribute::Nest;
604 case bitc::ATTR_KIND_NO_ALIAS:
605 return Attribute::NoAlias;
606 case bitc::ATTR_KIND_NO_BUILTIN:
607 return Attribute::NoBuiltin;
608 case bitc::ATTR_KIND_NO_CAPTURE:
609 return Attribute::NoCapture;
610 case bitc::ATTR_KIND_NO_DUPLICATE:
611 return Attribute::NoDuplicate;
612 case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
613 return Attribute::NoImplicitFloat;
614 case bitc::ATTR_KIND_NO_INLINE:
615 return Attribute::NoInline;
616 case bitc::ATTR_KIND_NON_LAZY_BIND:
617 return Attribute::NonLazyBind;
618 case bitc::ATTR_KIND_NON_NULL:
619 return Attribute::NonNull;
620 case bitc::ATTR_KIND_DEREFERENCEABLE:
621 return Attribute::Dereferenceable;
622 case bitc::ATTR_KIND_NO_RED_ZONE:
623 return Attribute::NoRedZone;
624 case bitc::ATTR_KIND_NO_RETURN:
625 return Attribute::NoReturn;
626 case bitc::ATTR_KIND_NO_UNWIND:
627 return Attribute::NoUnwind;
628 case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
629 return Attribute::OptimizeForSize;
630 case bitc::ATTR_KIND_OPTIMIZE_NONE:
631 return Attribute::OptimizeNone;
632 case bitc::ATTR_KIND_READ_NONE:
633 return Attribute::ReadNone;
634 case bitc::ATTR_KIND_READ_ONLY:
635 return Attribute::ReadOnly;
636 case bitc::ATTR_KIND_RETURNED:
637 return Attribute::Returned;
638 case bitc::ATTR_KIND_RETURNS_TWICE:
639 return Attribute::ReturnsTwice;
640 case bitc::ATTR_KIND_S_EXT:
641 return Attribute::SExt;
642 case bitc::ATTR_KIND_STACK_ALIGNMENT:
643 return Attribute::StackAlignment;
644 case bitc::ATTR_KIND_STACK_PROTECT:
645 return Attribute::StackProtect;
646 case bitc::ATTR_KIND_STACK_PROTECT_REQ:
647 return Attribute::StackProtectReq;
648 case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
649 return Attribute::StackProtectStrong;
650 case bitc::ATTR_KIND_STRUCT_RET:
651 return Attribute::StructRet;
652 case bitc::ATTR_KIND_SANITIZE_ADDRESS:
653 return Attribute::SanitizeAddress;
654 case bitc::ATTR_KIND_SANITIZE_THREAD:
655 return Attribute::SanitizeThread;
656 case bitc::ATTR_KIND_SANITIZE_MEMORY:
657 return Attribute::SanitizeMemory;
658 case bitc::ATTR_KIND_UW_TABLE:
659 return Attribute::UWTable;
660 case bitc::ATTR_KIND_Z_EXT:
661 return Attribute::ZExt;
665 std::error_code BitcodeReader::ParseAttrKind(uint64_t Code,
666 Attribute::AttrKind *Kind) {
667 *Kind = GetAttrFromCode(Code);
668 if (*Kind == Attribute::None)
669 return Error(BitcodeError::InvalidValue);
670 return std::error_code();
673 std::error_code BitcodeReader::ParseAttributeGroupBlock() {
674 if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
675 return Error(BitcodeError::InvalidRecord);
677 if (!MAttributeGroups.empty())
678 return Error(BitcodeError::InvalidMultipleBlocks);
680 SmallVector<uint64_t, 64> Record;
682 // Read all the records.
684 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
686 switch (Entry.Kind) {
687 case BitstreamEntry::SubBlock: // Handled for us already.
688 case BitstreamEntry::Error:
689 return Error(BitcodeError::MalformedBlock);
690 case BitstreamEntry::EndBlock:
691 return std::error_code();
692 case BitstreamEntry::Record:
693 // The interesting case.
699 switch (Stream.readRecord(Entry.ID, Record)) {
700 default: // Default behavior: ignore.
702 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
703 if (Record.size() < 3)
704 return Error(BitcodeError::InvalidRecord);
706 uint64_t GrpID = Record[0];
707 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
710 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
711 if (Record[i] == 0) { // Enum attribute
712 Attribute::AttrKind Kind;
713 if (std::error_code EC = ParseAttrKind(Record[++i], &Kind))
716 B.addAttribute(Kind);
717 } else if (Record[i] == 1) { // Integer attribute
718 Attribute::AttrKind Kind;
719 if (std::error_code EC = ParseAttrKind(Record[++i], &Kind))
721 if (Kind == Attribute::Alignment)
722 B.addAlignmentAttr(Record[++i]);
723 else if (Kind == Attribute::StackAlignment)
724 B.addStackAlignmentAttr(Record[++i]);
725 else if (Kind == Attribute::Dereferenceable)
726 B.addDereferenceableAttr(Record[++i]);
727 } else { // String attribute
728 assert((Record[i] == 3 || Record[i] == 4) &&
729 "Invalid attribute group entry");
730 bool HasValue = (Record[i++] == 4);
731 SmallString<64> KindStr;
732 SmallString<64> ValStr;
734 while (Record[i] != 0 && i != e)
735 KindStr += Record[i++];
736 assert(Record[i] == 0 && "Kind string not null terminated");
739 // Has a value associated with it.
740 ++i; // Skip the '0' that terminates the "kind" string.
741 while (Record[i] != 0 && i != e)
742 ValStr += Record[i++];
743 assert(Record[i] == 0 && "Value string not null terminated");
746 B.addAttribute(KindStr.str(), ValStr.str());
750 MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
757 std::error_code BitcodeReader::ParseTypeTable() {
758 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
759 return Error(BitcodeError::InvalidRecord);
761 return ParseTypeTableBody();
764 std::error_code BitcodeReader::ParseTypeTableBody() {
765 if (!TypeList.empty())
766 return Error(BitcodeError::InvalidMultipleBlocks);
768 SmallVector<uint64_t, 64> Record;
769 unsigned NumRecords = 0;
771 SmallString<64> TypeName;
773 // Read all the records for this type table.
775 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
777 switch (Entry.Kind) {
778 case BitstreamEntry::SubBlock: // Handled for us already.
779 case BitstreamEntry::Error:
780 return Error(BitcodeError::MalformedBlock);
781 case BitstreamEntry::EndBlock:
782 if (NumRecords != TypeList.size())
783 return Error(BitcodeError::MalformedBlock);
784 return std::error_code();
785 case BitstreamEntry::Record:
786 // The interesting case.
792 Type *ResultTy = nullptr;
793 switch (Stream.readRecord(Entry.ID, Record)) {
795 return Error(BitcodeError::InvalidValue);
796 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
797 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
798 // type list. This allows us to reserve space.
799 if (Record.size() < 1)
800 return Error(BitcodeError::InvalidRecord);
801 TypeList.resize(Record[0]);
803 case bitc::TYPE_CODE_VOID: // VOID
804 ResultTy = Type::getVoidTy(Context);
806 case bitc::TYPE_CODE_HALF: // HALF
807 ResultTy = Type::getHalfTy(Context);
809 case bitc::TYPE_CODE_FLOAT: // FLOAT
810 ResultTy = Type::getFloatTy(Context);
812 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
813 ResultTy = Type::getDoubleTy(Context);
815 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
816 ResultTy = Type::getX86_FP80Ty(Context);
818 case bitc::TYPE_CODE_FP128: // FP128
819 ResultTy = Type::getFP128Ty(Context);
821 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
822 ResultTy = Type::getPPC_FP128Ty(Context);
824 case bitc::TYPE_CODE_LABEL: // LABEL
825 ResultTy = Type::getLabelTy(Context);
827 case bitc::TYPE_CODE_METADATA: // METADATA
828 ResultTy = Type::getMetadataTy(Context);
830 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
831 ResultTy = Type::getX86_MMXTy(Context);
833 case bitc::TYPE_CODE_INTEGER: // INTEGER: [width]
834 if (Record.size() < 1)
835 return Error(BitcodeError::InvalidRecord);
837 ResultTy = IntegerType::get(Context, Record[0]);
839 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
840 // [pointee type, address space]
841 if (Record.size() < 1)
842 return Error(BitcodeError::InvalidRecord);
843 unsigned AddressSpace = 0;
844 if (Record.size() == 2)
845 AddressSpace = Record[1];
846 ResultTy = getTypeByID(Record[0]);
848 return Error(BitcodeError::InvalidType);
849 ResultTy = PointerType::get(ResultTy, AddressSpace);
852 case bitc::TYPE_CODE_FUNCTION_OLD: {
853 // FIXME: attrid is dead, remove it in LLVM 4.0
854 // FUNCTION: [vararg, attrid, retty, paramty x N]
855 if (Record.size() < 3)
856 return Error(BitcodeError::InvalidRecord);
857 SmallVector<Type*, 8> ArgTys;
858 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
859 if (Type *T = getTypeByID(Record[i]))
865 ResultTy = getTypeByID(Record[2]);
866 if (!ResultTy || ArgTys.size() < Record.size()-3)
867 return Error(BitcodeError::InvalidType);
869 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
872 case bitc::TYPE_CODE_FUNCTION: {
873 // FUNCTION: [vararg, retty, paramty x N]
874 if (Record.size() < 2)
875 return Error(BitcodeError::InvalidRecord);
876 SmallVector<Type*, 8> ArgTys;
877 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
878 if (Type *T = getTypeByID(Record[i]))
884 ResultTy = getTypeByID(Record[1]);
885 if (!ResultTy || ArgTys.size() < Record.size()-2)
886 return Error(BitcodeError::InvalidType);
888 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
891 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
892 if (Record.size() < 1)
893 return Error(BitcodeError::InvalidRecord);
894 SmallVector<Type*, 8> EltTys;
895 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
896 if (Type *T = getTypeByID(Record[i]))
901 if (EltTys.size() != Record.size()-1)
902 return Error(BitcodeError::InvalidType);
903 ResultTy = StructType::get(Context, EltTys, Record[0]);
906 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
907 if (ConvertToString(Record, 0, TypeName))
908 return Error(BitcodeError::InvalidRecord);
911 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
912 if (Record.size() < 1)
913 return Error(BitcodeError::InvalidRecord);
915 if (NumRecords >= TypeList.size())
916 return Error(BitcodeError::InvalidTYPETable);
918 // Check to see if this was forward referenced, if so fill in the temp.
919 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
921 Res->setName(TypeName);
922 TypeList[NumRecords] = nullptr;
923 } else // Otherwise, create a new struct.
924 Res = StructType::create(Context, TypeName);
927 SmallVector<Type*, 8> EltTys;
928 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
929 if (Type *T = getTypeByID(Record[i]))
934 if (EltTys.size() != Record.size()-1)
935 return Error(BitcodeError::InvalidRecord);
936 Res->setBody(EltTys, Record[0]);
940 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
941 if (Record.size() != 1)
942 return Error(BitcodeError::InvalidRecord);
944 if (NumRecords >= TypeList.size())
945 return Error(BitcodeError::InvalidTYPETable);
947 // Check to see if this was forward referenced, if so fill in the temp.
948 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
950 Res->setName(TypeName);
951 TypeList[NumRecords] = nullptr;
952 } else // Otherwise, create a new struct with no body.
953 Res = StructType::create(Context, TypeName);
958 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
959 if (Record.size() < 2)
960 return Error(BitcodeError::InvalidRecord);
961 if ((ResultTy = getTypeByID(Record[1])))
962 ResultTy = ArrayType::get(ResultTy, Record[0]);
964 return Error(BitcodeError::InvalidType);
966 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
967 if (Record.size() < 2)
968 return Error(BitcodeError::InvalidRecord);
969 if ((ResultTy = getTypeByID(Record[1])))
970 ResultTy = VectorType::get(ResultTy, Record[0]);
972 return Error(BitcodeError::InvalidType);
976 if (NumRecords >= TypeList.size())
977 return Error(BitcodeError::InvalidTYPETable);
978 assert(ResultTy && "Didn't read a type?");
979 assert(!TypeList[NumRecords] && "Already read type?");
980 TypeList[NumRecords++] = ResultTy;
984 std::error_code BitcodeReader::ParseValueSymbolTable() {
985 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
986 return Error(BitcodeError::InvalidRecord);
988 SmallVector<uint64_t, 64> Record;
990 // Read all the records for this value table.
991 SmallString<128> ValueName;
993 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
995 switch (Entry.Kind) {
996 case BitstreamEntry::SubBlock: // Handled for us already.
997 case BitstreamEntry::Error:
998 return Error(BitcodeError::MalformedBlock);
999 case BitstreamEntry::EndBlock:
1000 return std::error_code();
1001 case BitstreamEntry::Record:
1002 // The interesting case.
1008 switch (Stream.readRecord(Entry.ID, Record)) {
1009 default: // Default behavior: unknown type.
1011 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
1012 if (ConvertToString(Record, 1, ValueName))
1013 return Error(BitcodeError::InvalidRecord);
1014 unsigned ValueID = Record[0];
1015 if (ValueID >= ValueList.size() || !ValueList[ValueID])
1016 return Error(BitcodeError::InvalidRecord);
1017 Value *V = ValueList[ValueID];
1019 V->setName(StringRef(ValueName.data(), ValueName.size()));
1023 case bitc::VST_CODE_BBENTRY: {
1024 if (ConvertToString(Record, 1, ValueName))
1025 return Error(BitcodeError::InvalidRecord);
1026 BasicBlock *BB = getBasicBlock(Record[0]);
1028 return Error(BitcodeError::InvalidRecord);
1030 BB->setName(StringRef(ValueName.data(), ValueName.size()));
1038 std::error_code BitcodeReader::ParseMetadata() {
1039 unsigned NextMDValueNo = MDValueList.size();
1041 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1042 return Error(BitcodeError::InvalidRecord);
1044 SmallVector<uint64_t, 64> Record;
1046 // Read all the records.
1048 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1050 switch (Entry.Kind) {
1051 case BitstreamEntry::SubBlock: // Handled for us already.
1052 case BitstreamEntry::Error:
1053 return Error(BitcodeError::MalformedBlock);
1054 case BitstreamEntry::EndBlock:
1055 return std::error_code();
1056 case BitstreamEntry::Record:
1057 // The interesting case.
1061 bool IsFunctionLocal = false;
1064 unsigned Code = Stream.readRecord(Entry.ID, Record);
1066 default: // Default behavior: ignore.
1068 case bitc::METADATA_NAME: {
1069 // Read name of the named metadata.
1070 SmallString<8> Name(Record.begin(), Record.end());
1072 Code = Stream.ReadCode();
1074 // METADATA_NAME is always followed by METADATA_NAMED_NODE.
1075 unsigned NextBitCode = Stream.readRecord(Code, Record);
1076 assert(NextBitCode == bitc::METADATA_NAMED_NODE); (void)NextBitCode;
1078 // Read named metadata elements.
1079 unsigned Size = Record.size();
1080 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1081 for (unsigned i = 0; i != Size; ++i) {
1082 MDNode *MD = dyn_cast_or_null<MDNode>(MDValueList.getValueFwdRef(Record[i]));
1084 return Error(BitcodeError::InvalidRecord);
1085 NMD->addOperand(MD);
1089 case bitc::METADATA_FN_NODE:
1090 IsFunctionLocal = true;
1092 case bitc::METADATA_NODE: {
1093 if (Record.size() % 2 == 1)
1094 return Error(BitcodeError::InvalidRecord);
1096 unsigned Size = Record.size();
1097 SmallVector<Value*, 8> Elts;
1098 for (unsigned i = 0; i != Size; i += 2) {
1099 Type *Ty = getTypeByID(Record[i]);
1101 return Error(BitcodeError::InvalidRecord);
1102 if (Ty->isMetadataTy())
1103 Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
1104 else if (!Ty->isVoidTy())
1105 Elts.push_back(ValueList.getValueFwdRef(Record[i+1], Ty));
1107 Elts.push_back(nullptr);
1109 Value *V = MDNode::getWhenValsUnresolved(Context, Elts, IsFunctionLocal);
1110 IsFunctionLocal = false;
1111 MDValueList.AssignValue(V, NextMDValueNo++);
1114 case bitc::METADATA_STRING: {
1115 std::string String(Record.begin(), Record.end());
1116 llvm::UpgradeMDStringConstant(String);
1117 Value *V = MDString::get(Context, String);
1118 MDValueList.AssignValue(V, NextMDValueNo++);
1121 case bitc::METADATA_KIND: {
1122 if (Record.size() < 2)
1123 return Error(BitcodeError::InvalidRecord);
1125 unsigned Kind = Record[0];
1126 SmallString<8> Name(Record.begin()+1, Record.end());
1128 unsigned NewKind = TheModule->getMDKindID(Name.str());
1129 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1130 return Error(BitcodeError::ConflictingMETADATA_KINDRecords);
1137 /// decodeSignRotatedValue - Decode a signed value stored with the sign bit in
1138 /// the LSB for dense VBR encoding.
1139 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
1144 // There is no such thing as -0 with integers. "-0" really means MININT.
1148 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
1149 /// values and aliases that we can.
1150 std::error_code BitcodeReader::ResolveGlobalAndAliasInits() {
1151 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
1152 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
1153 std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
1155 GlobalInitWorklist.swap(GlobalInits);
1156 AliasInitWorklist.swap(AliasInits);
1157 FunctionPrefixWorklist.swap(FunctionPrefixes);
1159 while (!GlobalInitWorklist.empty()) {
1160 unsigned ValID = GlobalInitWorklist.back().second;
1161 if (ValID >= ValueList.size()) {
1162 // Not ready to resolve this yet, it requires something later in the file.
1163 GlobalInits.push_back(GlobalInitWorklist.back());
1165 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1166 GlobalInitWorklist.back().first->setInitializer(C);
1168 return Error(BitcodeError::ExpectedConstant);
1170 GlobalInitWorklist.pop_back();
1173 while (!AliasInitWorklist.empty()) {
1174 unsigned ValID = AliasInitWorklist.back().second;
1175 if (ValID >= ValueList.size()) {
1176 AliasInits.push_back(AliasInitWorklist.back());
1178 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1179 AliasInitWorklist.back().first->setAliasee(C);
1181 return Error(BitcodeError::ExpectedConstant);
1183 AliasInitWorklist.pop_back();
1186 while (!FunctionPrefixWorklist.empty()) {
1187 unsigned ValID = FunctionPrefixWorklist.back().second;
1188 if (ValID >= ValueList.size()) {
1189 FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
1191 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1192 FunctionPrefixWorklist.back().first->setPrefixData(C);
1194 return Error(BitcodeError::ExpectedConstant);
1196 FunctionPrefixWorklist.pop_back();
1199 return std::error_code();
1202 static APInt ReadWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
1203 SmallVector<uint64_t, 8> Words(Vals.size());
1204 std::transform(Vals.begin(), Vals.end(), Words.begin(),
1205 BitcodeReader::decodeSignRotatedValue);
1207 return APInt(TypeBits, Words);
1210 std::error_code BitcodeReader::ParseConstants() {
1211 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
1212 return Error(BitcodeError::InvalidRecord);
1214 SmallVector<uint64_t, 64> Record;
1216 // Read all the records for this value table.
1217 Type *CurTy = Type::getInt32Ty(Context);
1218 unsigned NextCstNo = ValueList.size();
1220 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1222 switch (Entry.Kind) {
1223 case BitstreamEntry::SubBlock: // Handled for us already.
1224 case BitstreamEntry::Error:
1225 return Error(BitcodeError::MalformedBlock);
1226 case BitstreamEntry::EndBlock:
1227 if (NextCstNo != ValueList.size())
1228 return Error(BitcodeError::InvalidConstantReference);
1230 // Once all the constants have been read, go through and resolve forward
1232 ValueList.ResolveConstantForwardRefs();
1233 return std::error_code();
1234 case BitstreamEntry::Record:
1235 // The interesting case.
1242 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
1244 default: // Default behavior: unknown constant
1245 case bitc::CST_CODE_UNDEF: // UNDEF
1246 V = UndefValue::get(CurTy);
1248 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
1250 return Error(BitcodeError::InvalidRecord);
1251 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
1252 return Error(BitcodeError::InvalidRecord);
1253 CurTy = TypeList[Record[0]];
1254 continue; // Skip the ValueList manipulation.
1255 case bitc::CST_CODE_NULL: // NULL
1256 V = Constant::getNullValue(CurTy);
1258 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
1259 if (!CurTy->isIntegerTy() || Record.empty())
1260 return Error(BitcodeError::InvalidRecord);
1261 V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
1263 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
1264 if (!CurTy->isIntegerTy() || Record.empty())
1265 return Error(BitcodeError::InvalidRecord);
1267 APInt VInt = ReadWideAPInt(Record,
1268 cast<IntegerType>(CurTy)->getBitWidth());
1269 V = ConstantInt::get(Context, VInt);
1273 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
1275 return Error(BitcodeError::InvalidRecord);
1276 if (CurTy->isHalfTy())
1277 V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
1278 APInt(16, (uint16_t)Record[0])));
1279 else if (CurTy->isFloatTy())
1280 V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
1281 APInt(32, (uint32_t)Record[0])));
1282 else if (CurTy->isDoubleTy())
1283 V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
1284 APInt(64, Record[0])));
1285 else if (CurTy->isX86_FP80Ty()) {
1286 // Bits are not stored the same way as a normal i80 APInt, compensate.
1287 uint64_t Rearrange[2];
1288 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
1289 Rearrange[1] = Record[0] >> 48;
1290 V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
1291 APInt(80, Rearrange)));
1292 } else if (CurTy->isFP128Ty())
1293 V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
1294 APInt(128, Record)));
1295 else if (CurTy->isPPC_FP128Ty())
1296 V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
1297 APInt(128, Record)));
1299 V = UndefValue::get(CurTy);
1303 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
1305 return Error(BitcodeError::InvalidRecord);
1307 unsigned Size = Record.size();
1308 SmallVector<Constant*, 16> Elts;
1310 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
1311 for (unsigned i = 0; i != Size; ++i)
1312 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
1313 STy->getElementType(i)));
1314 V = ConstantStruct::get(STy, Elts);
1315 } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
1316 Type *EltTy = ATy->getElementType();
1317 for (unsigned i = 0; i != Size; ++i)
1318 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1319 V = ConstantArray::get(ATy, Elts);
1320 } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
1321 Type *EltTy = VTy->getElementType();
1322 for (unsigned i = 0; i != Size; ++i)
1323 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1324 V = ConstantVector::get(Elts);
1326 V = UndefValue::get(CurTy);
1330 case bitc::CST_CODE_STRING: // STRING: [values]
1331 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
1333 return Error(BitcodeError::InvalidRecord);
1335 SmallString<16> Elts(Record.begin(), Record.end());
1336 V = ConstantDataArray::getString(Context, Elts,
1337 BitCode == bitc::CST_CODE_CSTRING);
1340 case bitc::CST_CODE_DATA: {// DATA: [n x value]
1342 return Error(BitcodeError::InvalidRecord);
1344 Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
1345 unsigned Size = Record.size();
1347 if (EltTy->isIntegerTy(8)) {
1348 SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
1349 if (isa<VectorType>(CurTy))
1350 V = ConstantDataVector::get(Context, Elts);
1352 V = ConstantDataArray::get(Context, Elts);
1353 } else if (EltTy->isIntegerTy(16)) {
1354 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
1355 if (isa<VectorType>(CurTy))
1356 V = ConstantDataVector::get(Context, Elts);
1358 V = ConstantDataArray::get(Context, Elts);
1359 } else if (EltTy->isIntegerTy(32)) {
1360 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
1361 if (isa<VectorType>(CurTy))
1362 V = ConstantDataVector::get(Context, Elts);
1364 V = ConstantDataArray::get(Context, Elts);
1365 } else if (EltTy->isIntegerTy(64)) {
1366 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
1367 if (isa<VectorType>(CurTy))
1368 V = ConstantDataVector::get(Context, Elts);
1370 V = ConstantDataArray::get(Context, Elts);
1371 } else if (EltTy->isFloatTy()) {
1372 SmallVector<float, 16> Elts(Size);
1373 std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
1374 if (isa<VectorType>(CurTy))
1375 V = ConstantDataVector::get(Context, Elts);
1377 V = ConstantDataArray::get(Context, Elts);
1378 } else if (EltTy->isDoubleTy()) {
1379 SmallVector<double, 16> Elts(Size);
1380 std::transform(Record.begin(), Record.end(), Elts.begin(),
1382 if (isa<VectorType>(CurTy))
1383 V = ConstantDataVector::get(Context, Elts);
1385 V = ConstantDataArray::get(Context, Elts);
1387 return Error(BitcodeError::InvalidTypeForValue);
1392 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
1393 if (Record.size() < 3)
1394 return Error(BitcodeError::InvalidRecord);
1395 int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
1397 V = UndefValue::get(CurTy); // Unknown binop.
1399 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
1400 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
1402 if (Record.size() >= 4) {
1403 if (Opc == Instruction::Add ||
1404 Opc == Instruction::Sub ||
1405 Opc == Instruction::Mul ||
1406 Opc == Instruction::Shl) {
1407 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1408 Flags |= OverflowingBinaryOperator::NoSignedWrap;
1409 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1410 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
1411 } else if (Opc == Instruction::SDiv ||
1412 Opc == Instruction::UDiv ||
1413 Opc == Instruction::LShr ||
1414 Opc == Instruction::AShr) {
1415 if (Record[3] & (1 << bitc::PEO_EXACT))
1416 Flags |= SDivOperator::IsExact;
1419 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
1423 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
1424 if (Record.size() < 3)
1425 return Error(BitcodeError::InvalidRecord);
1426 int Opc = GetDecodedCastOpcode(Record[0]);
1428 V = UndefValue::get(CurTy); // Unknown cast.
1430 Type *OpTy = getTypeByID(Record[1]);
1432 return Error(BitcodeError::InvalidRecord);
1433 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
1434 V = UpgradeBitCastExpr(Opc, Op, CurTy);
1435 if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
1439 case bitc::CST_CODE_CE_INBOUNDS_GEP:
1440 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
1441 if (Record.size() & 1)
1442 return Error(BitcodeError::InvalidRecord);
1443 SmallVector<Constant*, 16> Elts;
1444 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1445 Type *ElTy = getTypeByID(Record[i]);
1447 return Error(BitcodeError::InvalidRecord);
1448 Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
1450 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
1451 V = ConstantExpr::getGetElementPtr(Elts[0], Indices,
1453 bitc::CST_CODE_CE_INBOUNDS_GEP);
1456 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
1457 if (Record.size() < 3)
1458 return Error(BitcodeError::InvalidRecord);
1460 Type *SelectorTy = Type::getInt1Ty(Context);
1462 // If CurTy is a vector of length n, then Record[0] must be a <n x i1>
1463 // vector. Otherwise, it must be a single bit.
1464 if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
1465 SelectorTy = VectorType::get(Type::getInt1Ty(Context),
1466 VTy->getNumElements());
1468 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
1470 ValueList.getConstantFwdRef(Record[1],CurTy),
1471 ValueList.getConstantFwdRef(Record[2],CurTy));
1474 case bitc::CST_CODE_CE_EXTRACTELT
1475 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
1476 if (Record.size() < 3)
1477 return Error(BitcodeError::InvalidRecord);
1479 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1481 return Error(BitcodeError::InvalidRecord);
1482 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1483 Constant *Op1 = nullptr;
1484 if (Record.size() == 4) {
1485 Type *IdxTy = getTypeByID(Record[2]);
1487 return Error(BitcodeError::InvalidRecord);
1488 Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
1489 } else // TODO: Remove with llvm 4.0
1490 Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1492 return Error(BitcodeError::InvalidRecord);
1493 V = ConstantExpr::getExtractElement(Op0, Op1);
1496 case bitc::CST_CODE_CE_INSERTELT
1497 : { // CE_INSERTELT: [opval, opval, opty, opval]
1498 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1499 if (Record.size() < 3 || !OpTy)
1500 return Error(BitcodeError::InvalidRecord);
1501 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1502 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
1503 OpTy->getElementType());
1504 Constant *Op2 = nullptr;
1505 if (Record.size() == 4) {
1506 Type *IdxTy = getTypeByID(Record[2]);
1508 return Error(BitcodeError::InvalidRecord);
1509 Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
1510 } else // TODO: Remove with llvm 4.0
1511 Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1513 return Error(BitcodeError::InvalidRecord);
1514 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
1517 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
1518 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1519 if (Record.size() < 3 || !OpTy)
1520 return Error(BitcodeError::InvalidRecord);
1521 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1522 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
1523 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1524 OpTy->getNumElements());
1525 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
1526 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1529 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
1530 VectorType *RTy = dyn_cast<VectorType>(CurTy);
1532 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1533 if (Record.size() < 4 || !RTy || !OpTy)
1534 return Error(BitcodeError::InvalidRecord);
1535 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1536 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1537 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1538 RTy->getNumElements());
1539 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
1540 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1543 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
1544 if (Record.size() < 4)
1545 return Error(BitcodeError::InvalidRecord);
1546 Type *OpTy = getTypeByID(Record[0]);
1548 return Error(BitcodeError::InvalidRecord);
1549 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1550 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1552 if (OpTy->isFPOrFPVectorTy())
1553 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
1555 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
1558 // This maintains backward compatibility, pre-asm dialect keywords.
1559 // FIXME: Remove with the 4.0 release.
1560 case bitc::CST_CODE_INLINEASM_OLD: {
1561 if (Record.size() < 2)
1562 return Error(BitcodeError::InvalidRecord);
1563 std::string AsmStr, ConstrStr;
1564 bool HasSideEffects = Record[0] & 1;
1565 bool IsAlignStack = Record[0] >> 1;
1566 unsigned AsmStrSize = Record[1];
1567 if (2+AsmStrSize >= Record.size())
1568 return Error(BitcodeError::InvalidRecord);
1569 unsigned ConstStrSize = Record[2+AsmStrSize];
1570 if (3+AsmStrSize+ConstStrSize > Record.size())
1571 return Error(BitcodeError::InvalidRecord);
1573 for (unsigned i = 0; i != AsmStrSize; ++i)
1574 AsmStr += (char)Record[2+i];
1575 for (unsigned i = 0; i != ConstStrSize; ++i)
1576 ConstrStr += (char)Record[3+AsmStrSize+i];
1577 PointerType *PTy = cast<PointerType>(CurTy);
1578 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1579 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
1582 // This version adds support for the asm dialect keywords (e.g.,
1584 case bitc::CST_CODE_INLINEASM: {
1585 if (Record.size() < 2)
1586 return Error(BitcodeError::InvalidRecord);
1587 std::string AsmStr, ConstrStr;
1588 bool HasSideEffects = Record[0] & 1;
1589 bool IsAlignStack = (Record[0] >> 1) & 1;
1590 unsigned AsmDialect = Record[0] >> 2;
1591 unsigned AsmStrSize = Record[1];
1592 if (2+AsmStrSize >= Record.size())
1593 return Error(BitcodeError::InvalidRecord);
1594 unsigned ConstStrSize = Record[2+AsmStrSize];
1595 if (3+AsmStrSize+ConstStrSize > Record.size())
1596 return Error(BitcodeError::InvalidRecord);
1598 for (unsigned i = 0; i != AsmStrSize; ++i)
1599 AsmStr += (char)Record[2+i];
1600 for (unsigned i = 0; i != ConstStrSize; ++i)
1601 ConstrStr += (char)Record[3+AsmStrSize+i];
1602 PointerType *PTy = cast<PointerType>(CurTy);
1603 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1604 AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
1605 InlineAsm::AsmDialect(AsmDialect));
1608 case bitc::CST_CODE_BLOCKADDRESS:{
1609 if (Record.size() < 3)
1610 return Error(BitcodeError::InvalidRecord);
1611 Type *FnTy = getTypeByID(Record[0]);
1613 return Error(BitcodeError::InvalidRecord);
1615 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
1617 return Error(BitcodeError::InvalidRecord);
1619 // Don't let Fn get dematerialized.
1620 BlockAddressesTaken.insert(Fn);
1622 // If the function is already parsed we can insert the block address right
1625 unsigned BBID = Record[2];
1627 // Invalid reference to entry block.
1628 return Error(BitcodeError::InvalidID);
1630 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
1631 for (size_t I = 0, E = BBID; I != E; ++I) {
1633 return Error(BitcodeError::InvalidID);
1638 // Otherwise insert a placeholder and remember it so it can be inserted
1639 // when the function is parsed.
1640 auto &FwdBBs = BasicBlockFwdRefs[Fn];
1642 BasicBlockFwdRefQueue.push_back(Fn);
1643 if (FwdBBs.size() < BBID + 1)
1644 FwdBBs.resize(BBID + 1);
1646 FwdBBs[BBID] = BasicBlock::Create(Context);
1649 V = BlockAddress::get(Fn, BB);
1654 ValueList.AssignValue(V, NextCstNo);
1659 std::error_code BitcodeReader::ParseUseLists() {
1660 if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
1661 return Error(BitcodeError::InvalidRecord);
1663 // Read all the records.
1664 SmallVector<uint64_t, 64> Record;
1666 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1668 switch (Entry.Kind) {
1669 case BitstreamEntry::SubBlock: // Handled for us already.
1670 case BitstreamEntry::Error:
1671 return Error(BitcodeError::MalformedBlock);
1672 case BitstreamEntry::EndBlock:
1673 return std::error_code();
1674 case BitstreamEntry::Record:
1675 // The interesting case.
1679 // Read a use list record.
1682 switch (Stream.readRecord(Entry.ID, Record)) {
1683 default: // Default behavior: unknown type.
1685 case bitc::USELIST_CODE_BB:
1688 case bitc::USELIST_CODE_DEFAULT: {
1689 unsigned RecordLength = Record.size();
1690 if (RecordLength < 3)
1691 // Records should have at least an ID and two indexes.
1692 return Error(BitcodeError::InvalidRecord);
1693 unsigned ID = Record.back();
1698 assert(ID < FunctionBBs.size() && "Basic block not found");
1699 V = FunctionBBs[ID];
1702 unsigned NumUses = 0;
1703 SmallDenseMap<const Use *, unsigned, 16> Order;
1704 for (const Use &U : V->uses()) {
1705 if (++NumUses > Record.size())
1707 Order[&U] = Record[NumUses - 1];
1709 if (Order.size() != Record.size() || NumUses > Record.size())
1710 // Mismatches can happen if the functions are being materialized lazily
1711 // (out-of-order), or a value has been upgraded.
1714 V->sortUseList([&](const Use &L, const Use &R) {
1715 return Order.lookup(&L) < Order.lookup(&R);
1723 /// RememberAndSkipFunctionBody - When we see the block for a function body,
1724 /// remember where it is and then skip it. This lets us lazily deserialize the
1726 std::error_code BitcodeReader::RememberAndSkipFunctionBody() {
1727 // Get the function we are talking about.
1728 if (FunctionsWithBodies.empty())
1729 return Error(BitcodeError::InsufficientFunctionProtos);
1731 Function *Fn = FunctionsWithBodies.back();
1732 FunctionsWithBodies.pop_back();
1734 // Save the current stream state.
1735 uint64_t CurBit = Stream.GetCurrentBitNo();
1736 DeferredFunctionInfo[Fn] = CurBit;
1738 // Skip over the function block for now.
1739 if (Stream.SkipBlock())
1740 return Error(BitcodeError::InvalidRecord);
1741 return std::error_code();
1744 std::error_code BitcodeReader::GlobalCleanup() {
1745 // Patch the initializers for globals and aliases up.
1746 ResolveGlobalAndAliasInits();
1747 if (!GlobalInits.empty() || !AliasInits.empty())
1748 return Error(BitcodeError::MalformedGlobalInitializerSet);
1750 // Look for intrinsic functions which need to be upgraded at some point
1751 for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
1754 if (UpgradeIntrinsicFunction(FI, NewFn))
1755 UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
1758 // Look for global variables which need to be renamed.
1759 for (Module::global_iterator
1760 GI = TheModule->global_begin(), GE = TheModule->global_end();
1762 GlobalVariable *GV = GI++;
1763 UpgradeGlobalVariable(GV);
1766 // Force deallocation of memory for these vectors to favor the client that
1767 // want lazy deserialization.
1768 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
1769 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
1770 return std::error_code();
1773 std::error_code BitcodeReader::ParseModule(bool Resume) {
1775 Stream.JumpToBit(NextUnreadBit);
1776 else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
1777 return Error(BitcodeError::InvalidRecord);
1779 SmallVector<uint64_t, 64> Record;
1780 std::vector<std::string> SectionTable;
1781 std::vector<std::string> GCTable;
1783 // Read all the records for this module.
1785 BitstreamEntry Entry = Stream.advance();
1787 switch (Entry.Kind) {
1788 case BitstreamEntry::Error:
1789 return Error(BitcodeError::MalformedBlock);
1790 case BitstreamEntry::EndBlock:
1791 return GlobalCleanup();
1793 case BitstreamEntry::SubBlock:
1795 default: // Skip unknown content.
1796 if (Stream.SkipBlock())
1797 return Error(BitcodeError::InvalidRecord);
1799 case bitc::BLOCKINFO_BLOCK_ID:
1800 if (Stream.ReadBlockInfoBlock())
1801 return Error(BitcodeError::MalformedBlock);
1803 case bitc::PARAMATTR_BLOCK_ID:
1804 if (std::error_code EC = ParseAttributeBlock())
1807 case bitc::PARAMATTR_GROUP_BLOCK_ID:
1808 if (std::error_code EC = ParseAttributeGroupBlock())
1811 case bitc::TYPE_BLOCK_ID_NEW:
1812 if (std::error_code EC = ParseTypeTable())
1815 case bitc::VALUE_SYMTAB_BLOCK_ID:
1816 if (std::error_code EC = ParseValueSymbolTable())
1818 SeenValueSymbolTable = true;
1820 case bitc::CONSTANTS_BLOCK_ID:
1821 if (std::error_code EC = ParseConstants())
1823 if (std::error_code EC = ResolveGlobalAndAliasInits())
1826 case bitc::METADATA_BLOCK_ID:
1827 if (std::error_code EC = ParseMetadata())
1830 case bitc::FUNCTION_BLOCK_ID:
1831 // If this is the first function body we've seen, reverse the
1832 // FunctionsWithBodies list.
1833 if (!SeenFirstFunctionBody) {
1834 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
1835 if (std::error_code EC = GlobalCleanup())
1837 SeenFirstFunctionBody = true;
1840 if (std::error_code EC = RememberAndSkipFunctionBody())
1842 // For streaming bitcode, suspend parsing when we reach the function
1843 // bodies. Subsequent materialization calls will resume it when
1844 // necessary. For streaming, the function bodies must be at the end of
1845 // the bitcode. If the bitcode file is old, the symbol table will be
1846 // at the end instead and will not have been seen yet. In this case,
1847 // just finish the parse now.
1848 if (LazyStreamer && SeenValueSymbolTable) {
1849 NextUnreadBit = Stream.GetCurrentBitNo();
1850 return std::error_code();
1853 case bitc::USELIST_BLOCK_ID:
1854 if (std::error_code EC = ParseUseLists())
1860 case BitstreamEntry::Record:
1861 // The interesting case.
1867 switch (Stream.readRecord(Entry.ID, Record)) {
1868 default: break; // Default behavior, ignore unknown content.
1869 case bitc::MODULE_CODE_VERSION: { // VERSION: [version#]
1870 if (Record.size() < 1)
1871 return Error(BitcodeError::InvalidRecord);
1872 // Only version #0 and #1 are supported so far.
1873 unsigned module_version = Record[0];
1874 switch (module_version) {
1876 return Error(BitcodeError::InvalidValue);
1878 UseRelativeIDs = false;
1881 UseRelativeIDs = true;
1886 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
1888 if (ConvertToString(Record, 0, S))
1889 return Error(BitcodeError::InvalidRecord);
1890 TheModule->setTargetTriple(S);
1893 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
1895 if (ConvertToString(Record, 0, S))
1896 return Error(BitcodeError::InvalidRecord);
1897 TheModule->setDataLayout(S);
1900 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
1902 if (ConvertToString(Record, 0, S))
1903 return Error(BitcodeError::InvalidRecord);
1904 TheModule->setModuleInlineAsm(S);
1907 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
1908 // FIXME: Remove in 4.0.
1910 if (ConvertToString(Record, 0, S))
1911 return Error(BitcodeError::InvalidRecord);
1915 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
1917 if (ConvertToString(Record, 0, S))
1918 return Error(BitcodeError::InvalidRecord);
1919 SectionTable.push_back(S);
1922 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
1924 if (ConvertToString(Record, 0, S))
1925 return Error(BitcodeError::InvalidRecord);
1926 GCTable.push_back(S);
1929 case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
1930 if (Record.size() < 2)
1931 return Error(BitcodeError::InvalidRecord);
1932 Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
1933 unsigned ComdatNameSize = Record[1];
1934 std::string ComdatName;
1935 ComdatName.reserve(ComdatNameSize);
1936 for (unsigned i = 0; i != ComdatNameSize; ++i)
1937 ComdatName += (char)Record[2 + i];
1938 Comdat *C = TheModule->getOrInsertComdat(ComdatName);
1939 C->setSelectionKind(SK);
1940 ComdatList.push_back(C);
1943 // GLOBALVAR: [pointer type, isconst, initid,
1944 // linkage, alignment, section, visibility, threadlocal,
1945 // unnamed_addr, dllstorageclass]
1946 case bitc::MODULE_CODE_GLOBALVAR: {
1947 if (Record.size() < 6)
1948 return Error(BitcodeError::InvalidRecord);
1949 Type *Ty = getTypeByID(Record[0]);
1951 return Error(BitcodeError::InvalidRecord);
1952 if (!Ty->isPointerTy())
1953 return Error(BitcodeError::InvalidTypeForValue);
1954 unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
1955 Ty = cast<PointerType>(Ty)->getElementType();
1957 bool isConstant = Record[1];
1958 GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
1959 unsigned Alignment = (1 << Record[4]) >> 1;
1960 std::string Section;
1962 if (Record[5]-1 >= SectionTable.size())
1963 return Error(BitcodeError::InvalidID);
1964 Section = SectionTable[Record[5]-1];
1966 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
1967 // Local linkage must have default visibility.
1968 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
1969 // FIXME: Change to an error if non-default in 4.0.
1970 Visibility = GetDecodedVisibility(Record[6]);
1972 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
1973 if (Record.size() > 7)
1974 TLM = GetDecodedThreadLocalMode(Record[7]);
1976 bool UnnamedAddr = false;
1977 if (Record.size() > 8)
1978 UnnamedAddr = Record[8];
1980 bool ExternallyInitialized = false;
1981 if (Record.size() > 9)
1982 ExternallyInitialized = Record[9];
1984 GlobalVariable *NewGV =
1985 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
1986 TLM, AddressSpace, ExternallyInitialized);
1987 NewGV->setAlignment(Alignment);
1988 if (!Section.empty())
1989 NewGV->setSection(Section);
1990 NewGV->setVisibility(Visibility);
1991 NewGV->setUnnamedAddr(UnnamedAddr);
1993 if (Record.size() > 10)
1994 NewGV->setDLLStorageClass(GetDecodedDLLStorageClass(Record[10]));
1996 UpgradeDLLImportExportLinkage(NewGV, Record[3]);
1998 ValueList.push_back(NewGV);
2000 // Remember which value to use for the global initializer.
2001 if (unsigned InitID = Record[2])
2002 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
2004 if (Record.size() > 11)
2005 if (unsigned ComdatID = Record[11]) {
2006 assert(ComdatID <= ComdatList.size());
2007 NewGV->setComdat(ComdatList[ComdatID - 1]);
2011 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
2012 // alignment, section, visibility, gc, unnamed_addr,
2014 case bitc::MODULE_CODE_FUNCTION: {
2015 if (Record.size() < 8)
2016 return Error(BitcodeError::InvalidRecord);
2017 Type *Ty = getTypeByID(Record[0]);
2019 return Error(BitcodeError::InvalidRecord);
2020 if (!Ty->isPointerTy())
2021 return Error(BitcodeError::InvalidTypeForValue);
2023 dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
2025 return Error(BitcodeError::InvalidTypeForValue);
2027 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
2030 Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
2031 bool isProto = Record[2];
2032 Func->setLinkage(GetDecodedLinkage(Record[3]));
2033 Func->setAttributes(getAttributes(Record[4]));
2035 Func->setAlignment((1 << Record[5]) >> 1);
2037 if (Record[6]-1 >= SectionTable.size())
2038 return Error(BitcodeError::InvalidID);
2039 Func->setSection(SectionTable[Record[6]-1]);
2041 // Local linkage must have default visibility.
2042 if (!Func->hasLocalLinkage())
2043 // FIXME: Change to an error if non-default in 4.0.
2044 Func->setVisibility(GetDecodedVisibility(Record[7]));
2045 if (Record.size() > 8 && Record[8]) {
2046 if (Record[8]-1 > GCTable.size())
2047 return Error(BitcodeError::InvalidID);
2048 Func->setGC(GCTable[Record[8]-1].c_str());
2050 bool UnnamedAddr = false;
2051 if (Record.size() > 9)
2052 UnnamedAddr = Record[9];
2053 Func->setUnnamedAddr(UnnamedAddr);
2054 if (Record.size() > 10 && Record[10] != 0)
2055 FunctionPrefixes.push_back(std::make_pair(Func, Record[10]-1));
2057 if (Record.size() > 11)
2058 Func->setDLLStorageClass(GetDecodedDLLStorageClass(Record[11]));
2060 UpgradeDLLImportExportLinkage(Func, Record[3]);
2062 if (Record.size() > 12)
2063 if (unsigned ComdatID = Record[12]) {
2064 assert(ComdatID <= ComdatList.size());
2065 Func->setComdat(ComdatList[ComdatID - 1]);
2068 ValueList.push_back(Func);
2070 // If this is a function with a body, remember the prototype we are
2071 // creating now, so that we can match up the body with them later.
2073 FunctionsWithBodies.push_back(Func);
2075 DeferredFunctionInfo[Func] = 0;
2079 // ALIAS: [alias type, aliasee val#, linkage]
2080 // ALIAS: [alias type, aliasee val#, linkage, visibility, dllstorageclass]
2081 case bitc::MODULE_CODE_ALIAS: {
2082 if (Record.size() < 3)
2083 return Error(BitcodeError::InvalidRecord);
2084 Type *Ty = getTypeByID(Record[0]);
2086 return Error(BitcodeError::InvalidRecord);
2087 auto *PTy = dyn_cast<PointerType>(Ty);
2089 return Error(BitcodeError::InvalidTypeForValue);
2092 GlobalAlias::create(PTy->getElementType(), PTy->getAddressSpace(),
2093 GetDecodedLinkage(Record[2]), "", TheModule);
2094 // Old bitcode files didn't have visibility field.
2095 // Local linkage must have default visibility.
2096 if (Record.size() > 3 && !NewGA->hasLocalLinkage())
2097 // FIXME: Change to an error if non-default in 4.0.
2098 NewGA->setVisibility(GetDecodedVisibility(Record[3]));
2099 if (Record.size() > 4)
2100 NewGA->setDLLStorageClass(GetDecodedDLLStorageClass(Record[4]));
2102 UpgradeDLLImportExportLinkage(NewGA, Record[2]);
2103 if (Record.size() > 5)
2104 NewGA->setThreadLocalMode(GetDecodedThreadLocalMode(Record[5]));
2105 if (Record.size() > 6)
2106 NewGA->setUnnamedAddr(Record[6]);
2107 ValueList.push_back(NewGA);
2108 AliasInits.push_back(std::make_pair(NewGA, Record[1]));
2111 /// MODULE_CODE_PURGEVALS: [numvals]
2112 case bitc::MODULE_CODE_PURGEVALS:
2113 // Trim down the value list to the specified size.
2114 if (Record.size() < 1 || Record[0] > ValueList.size())
2115 return Error(BitcodeError::InvalidRecord);
2116 ValueList.shrinkTo(Record[0]);
2123 std::error_code BitcodeReader::ParseBitcodeInto(Module *M) {
2124 TheModule = nullptr;
2126 if (std::error_code EC = InitStream())
2129 // Sniff for the signature.
2130 if (Stream.Read(8) != 'B' ||
2131 Stream.Read(8) != 'C' ||
2132 Stream.Read(4) != 0x0 ||
2133 Stream.Read(4) != 0xC ||
2134 Stream.Read(4) != 0xE ||
2135 Stream.Read(4) != 0xD)
2136 return Error(BitcodeError::InvalidBitcodeSignature);
2138 // We expect a number of well-defined blocks, though we don't necessarily
2139 // need to understand them all.
2141 if (Stream.AtEndOfStream())
2142 return std::error_code();
2144 BitstreamEntry Entry =
2145 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
2147 switch (Entry.Kind) {
2148 case BitstreamEntry::Error:
2149 return Error(BitcodeError::MalformedBlock);
2150 case BitstreamEntry::EndBlock:
2151 return std::error_code();
2153 case BitstreamEntry::SubBlock:
2155 case bitc::BLOCKINFO_BLOCK_ID:
2156 if (Stream.ReadBlockInfoBlock())
2157 return Error(BitcodeError::MalformedBlock);
2159 case bitc::MODULE_BLOCK_ID:
2160 // Reject multiple MODULE_BLOCK's in a single bitstream.
2162 return Error(BitcodeError::InvalidMultipleBlocks);
2164 if (std::error_code EC = ParseModule(false))
2167 return std::error_code();
2170 if (Stream.SkipBlock())
2171 return Error(BitcodeError::InvalidRecord);
2175 case BitstreamEntry::Record:
2176 // There should be no records in the top-level of blocks.
2178 // The ranlib in Xcode 4 will align archive members by appending newlines
2179 // to the end of them. If this file size is a multiple of 4 but not 8, we
2180 // have to read and ignore these final 4 bytes :-(
2181 if (Stream.getAbbrevIDWidth() == 2 && Entry.ID == 2 &&
2182 Stream.Read(6) == 2 && Stream.Read(24) == 0xa0a0a &&
2183 Stream.AtEndOfStream())
2184 return std::error_code();
2186 return Error(BitcodeError::InvalidRecord);
2191 ErrorOr<std::string> BitcodeReader::parseModuleTriple() {
2192 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
2193 return Error(BitcodeError::InvalidRecord);
2195 SmallVector<uint64_t, 64> Record;
2198 // Read all the records for this module.
2200 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2202 switch (Entry.Kind) {
2203 case BitstreamEntry::SubBlock: // Handled for us already.
2204 case BitstreamEntry::Error:
2205 return Error(BitcodeError::MalformedBlock);
2206 case BitstreamEntry::EndBlock:
2208 case BitstreamEntry::Record:
2209 // The interesting case.
2214 switch (Stream.readRecord(Entry.ID, Record)) {
2215 default: break; // Default behavior, ignore unknown content.
2216 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
2218 if (ConvertToString(Record, 0, S))
2219 return Error(BitcodeError::InvalidRecord);
2226 llvm_unreachable("Exit infinite loop");
2229 ErrorOr<std::string> BitcodeReader::parseTriple() {
2230 if (std::error_code EC = InitStream())
2233 // Sniff for the signature.
2234 if (Stream.Read(8) != 'B' ||
2235 Stream.Read(8) != 'C' ||
2236 Stream.Read(4) != 0x0 ||
2237 Stream.Read(4) != 0xC ||
2238 Stream.Read(4) != 0xE ||
2239 Stream.Read(4) != 0xD)
2240 return Error(BitcodeError::InvalidBitcodeSignature);
2242 // We expect a number of well-defined blocks, though we don't necessarily
2243 // need to understand them all.
2245 BitstreamEntry Entry = Stream.advance();
2247 switch (Entry.Kind) {
2248 case BitstreamEntry::Error:
2249 return Error(BitcodeError::MalformedBlock);
2250 case BitstreamEntry::EndBlock:
2251 return std::error_code();
2253 case BitstreamEntry::SubBlock:
2254 if (Entry.ID == bitc::MODULE_BLOCK_ID)
2255 return parseModuleTriple();
2257 // Ignore other sub-blocks.
2258 if (Stream.SkipBlock())
2259 return Error(BitcodeError::MalformedBlock);
2262 case BitstreamEntry::Record:
2263 Stream.skipRecord(Entry.ID);
2269 /// ParseMetadataAttachment - Parse metadata attachments.
2270 std::error_code BitcodeReader::ParseMetadataAttachment() {
2271 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
2272 return Error(BitcodeError::InvalidRecord);
2274 SmallVector<uint64_t, 64> Record;
2276 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2278 switch (Entry.Kind) {
2279 case BitstreamEntry::SubBlock: // Handled for us already.
2280 case BitstreamEntry::Error:
2281 return Error(BitcodeError::MalformedBlock);
2282 case BitstreamEntry::EndBlock:
2283 return std::error_code();
2284 case BitstreamEntry::Record:
2285 // The interesting case.
2289 // Read a metadata attachment record.
2291 switch (Stream.readRecord(Entry.ID, Record)) {
2292 default: // Default behavior: ignore.
2294 case bitc::METADATA_ATTACHMENT: {
2295 unsigned RecordLength = Record.size();
2296 if (Record.empty() || (RecordLength - 1) % 2 == 1)
2297 return Error(BitcodeError::InvalidRecord);
2298 Instruction *Inst = InstructionList[Record[0]];
2299 for (unsigned i = 1; i != RecordLength; i = i+2) {
2300 unsigned Kind = Record[i];
2301 DenseMap<unsigned, unsigned>::iterator I =
2302 MDKindMap.find(Kind);
2303 if (I == MDKindMap.end())
2304 return Error(BitcodeError::InvalidID);
2305 Value *Node = MDValueList.getValueFwdRef(Record[i+1]);
2306 Inst->setMetadata(I->second, cast<MDNode>(Node));
2307 if (I->second == LLVMContext::MD_tbaa)
2308 InstsWithTBAATag.push_back(Inst);
2316 /// ParseFunctionBody - Lazily parse the specified function body block.
2317 std::error_code BitcodeReader::ParseFunctionBody(Function *F) {
2318 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
2319 return Error(BitcodeError::InvalidRecord);
2321 InstructionList.clear();
2322 unsigned ModuleValueListSize = ValueList.size();
2323 unsigned ModuleMDValueListSize = MDValueList.size();
2325 // Add all the function arguments to the value table.
2326 for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
2327 ValueList.push_back(I);
2329 unsigned NextValueNo = ValueList.size();
2330 BasicBlock *CurBB = nullptr;
2331 unsigned CurBBNo = 0;
2335 // Read all the records.
2336 SmallVector<uint64_t, 64> Record;
2338 BitstreamEntry Entry = Stream.advance();
2340 switch (Entry.Kind) {
2341 case BitstreamEntry::Error:
2342 return Error(BitcodeError::MalformedBlock);
2343 case BitstreamEntry::EndBlock:
2344 goto OutOfRecordLoop;
2346 case BitstreamEntry::SubBlock:
2348 default: // Skip unknown content.
2349 if (Stream.SkipBlock())
2350 return Error(BitcodeError::InvalidRecord);
2352 case bitc::CONSTANTS_BLOCK_ID:
2353 if (std::error_code EC = ParseConstants())
2355 NextValueNo = ValueList.size();
2357 case bitc::VALUE_SYMTAB_BLOCK_ID:
2358 if (std::error_code EC = ParseValueSymbolTable())
2361 case bitc::METADATA_ATTACHMENT_ID:
2362 if (std::error_code EC = ParseMetadataAttachment())
2365 case bitc::METADATA_BLOCK_ID:
2366 if (std::error_code EC = ParseMetadata())
2369 case bitc::USELIST_BLOCK_ID:
2370 if (std::error_code EC = ParseUseLists())
2376 case BitstreamEntry::Record:
2377 // The interesting case.
2383 Instruction *I = nullptr;
2384 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2386 default: // Default behavior: reject
2387 return Error(BitcodeError::InvalidValue);
2388 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
2389 if (Record.size() < 1 || Record[0] == 0)
2390 return Error(BitcodeError::InvalidRecord);
2391 // Create all the basic blocks for the function.
2392 FunctionBBs.resize(Record[0]);
2394 // See if anything took the address of blocks in this function.
2395 auto BBFRI = BasicBlockFwdRefs.find(F);
2396 if (BBFRI == BasicBlockFwdRefs.end()) {
2397 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
2398 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
2400 auto &BBRefs = BBFRI->second;
2401 // Check for invalid basic block references.
2402 if (BBRefs.size() > FunctionBBs.size())
2403 return Error(BitcodeError::InvalidID);
2404 assert(!BBRefs.empty() && "Unexpected empty array");
2405 assert(!BBRefs.front() && "Invalid reference to entry block");
2406 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
2408 if (I < RE && BBRefs[I]) {
2409 BBRefs[I]->insertInto(F);
2410 FunctionBBs[I] = BBRefs[I];
2412 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
2415 // Erase from the table.
2416 BasicBlockFwdRefs.erase(BBFRI);
2419 CurBB = FunctionBBs[0];
2423 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
2424 // This record indicates that the last instruction is at the same
2425 // location as the previous instruction with a location.
2428 // Get the last instruction emitted.
2429 if (CurBB && !CurBB->empty())
2431 else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
2432 !FunctionBBs[CurBBNo-1]->empty())
2433 I = &FunctionBBs[CurBBNo-1]->back();
2436 return Error(BitcodeError::InvalidRecord);
2437 I->setDebugLoc(LastLoc);
2441 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
2442 I = nullptr; // Get the last instruction emitted.
2443 if (CurBB && !CurBB->empty())
2445 else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
2446 !FunctionBBs[CurBBNo-1]->empty())
2447 I = &FunctionBBs[CurBBNo-1]->back();
2448 if (!I || Record.size() < 4)
2449 return Error(BitcodeError::InvalidRecord);
2451 unsigned Line = Record[0], Col = Record[1];
2452 unsigned ScopeID = Record[2], IAID = Record[3];
2454 MDNode *Scope = nullptr, *IA = nullptr;
2455 if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
2456 if (IAID) IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
2457 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
2458 I->setDebugLoc(LastLoc);
2463 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
2466 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
2467 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
2468 OpNum+1 > Record.size())
2469 return Error(BitcodeError::InvalidRecord);
2471 int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
2473 return Error(BitcodeError::InvalidRecord);
2474 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
2475 InstructionList.push_back(I);
2476 if (OpNum < Record.size()) {
2477 if (Opc == Instruction::Add ||
2478 Opc == Instruction::Sub ||
2479 Opc == Instruction::Mul ||
2480 Opc == Instruction::Shl) {
2481 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2482 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
2483 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2484 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
2485 } else if (Opc == Instruction::SDiv ||
2486 Opc == Instruction::UDiv ||
2487 Opc == Instruction::LShr ||
2488 Opc == Instruction::AShr) {
2489 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
2490 cast<BinaryOperator>(I)->setIsExact(true);
2491 } else if (isa<FPMathOperator>(I)) {
2493 if (0 != (Record[OpNum] & FastMathFlags::UnsafeAlgebra))
2494 FMF.setUnsafeAlgebra();
2495 if (0 != (Record[OpNum] & FastMathFlags::NoNaNs))
2497 if (0 != (Record[OpNum] & FastMathFlags::NoInfs))
2499 if (0 != (Record[OpNum] & FastMathFlags::NoSignedZeros))
2500 FMF.setNoSignedZeros();
2501 if (0 != (Record[OpNum] & FastMathFlags::AllowReciprocal))
2502 FMF.setAllowReciprocal();
2504 I->setFastMathFlags(FMF);
2510 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
2513 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2514 OpNum+2 != Record.size())
2515 return Error(BitcodeError::InvalidRecord);
2517 Type *ResTy = getTypeByID(Record[OpNum]);
2518 int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
2519 if (Opc == -1 || !ResTy)
2520 return Error(BitcodeError::InvalidRecord);
2521 Instruction *Temp = nullptr;
2522 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
2524 InstructionList.push_back(Temp);
2525 CurBB->getInstList().push_back(Temp);
2528 I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
2530 InstructionList.push_back(I);
2533 case bitc::FUNC_CODE_INST_INBOUNDS_GEP:
2534 case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
2537 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
2538 return Error(BitcodeError::InvalidRecord);
2540 SmallVector<Value*, 16> GEPIdx;
2541 while (OpNum != Record.size()) {
2543 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2544 return Error(BitcodeError::InvalidRecord);
2545 GEPIdx.push_back(Op);
2548 I = GetElementPtrInst::Create(BasePtr, GEPIdx);
2549 InstructionList.push_back(I);
2550 if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP)
2551 cast<GetElementPtrInst>(I)->setIsInBounds(true);
2555 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
2556 // EXTRACTVAL: [opty, opval, n x indices]
2559 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
2560 return Error(BitcodeError::InvalidRecord);
2562 SmallVector<unsigned, 4> EXTRACTVALIdx;
2563 for (unsigned RecSize = Record.size();
2564 OpNum != RecSize; ++OpNum) {
2565 uint64_t Index = Record[OpNum];
2566 if ((unsigned)Index != Index)
2567 return Error(BitcodeError::InvalidValue);
2568 EXTRACTVALIdx.push_back((unsigned)Index);
2571 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
2572 InstructionList.push_back(I);
2576 case bitc::FUNC_CODE_INST_INSERTVAL: {
2577 // INSERTVAL: [opty, opval, opty, opval, n x indices]
2580 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
2581 return Error(BitcodeError::InvalidRecord);
2583 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
2584 return Error(BitcodeError::InvalidRecord);
2586 SmallVector<unsigned, 4> INSERTVALIdx;
2587 for (unsigned RecSize = Record.size();
2588 OpNum != RecSize; ++OpNum) {
2589 uint64_t Index = Record[OpNum];
2590 if ((unsigned)Index != Index)
2591 return Error(BitcodeError::InvalidValue);
2592 INSERTVALIdx.push_back((unsigned)Index);
2595 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
2596 InstructionList.push_back(I);
2600 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
2601 // obsolete form of select
2602 // handles select i1 ... in old bitcode
2604 Value *TrueVal, *FalseVal, *Cond;
2605 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
2606 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
2607 popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
2608 return Error(BitcodeError::InvalidRecord);
2610 I = SelectInst::Create(Cond, TrueVal, FalseVal);
2611 InstructionList.push_back(I);
2615 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
2616 // new form of select
2617 // handles select i1 or select [N x i1]
2619 Value *TrueVal, *FalseVal, *Cond;
2620 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
2621 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
2622 getValueTypePair(Record, OpNum, NextValueNo, Cond))
2623 return Error(BitcodeError::InvalidRecord);
2625 // select condition can be either i1 or [N x i1]
2626 if (VectorType* vector_type =
2627 dyn_cast<VectorType>(Cond->getType())) {
2629 if (vector_type->getElementType() != Type::getInt1Ty(Context))
2630 return Error(BitcodeError::InvalidTypeForValue);
2633 if (Cond->getType() != Type::getInt1Ty(Context))
2634 return Error(BitcodeError::InvalidTypeForValue);
2637 I = SelectInst::Create(Cond, TrueVal, FalseVal);
2638 InstructionList.push_back(I);
2642 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
2645 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
2646 getValueTypePair(Record, OpNum, NextValueNo, Idx))
2647 return Error(BitcodeError::InvalidRecord);
2648 I = ExtractElementInst::Create(Vec, Idx);
2649 InstructionList.push_back(I);
2653 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
2655 Value *Vec, *Elt, *Idx;
2656 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
2657 popValue(Record, OpNum, NextValueNo,
2658 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
2659 getValueTypePair(Record, OpNum, NextValueNo, Idx))
2660 return Error(BitcodeError::InvalidRecord);
2661 I = InsertElementInst::Create(Vec, Elt, Idx);
2662 InstructionList.push_back(I);
2666 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
2668 Value *Vec1, *Vec2, *Mask;
2669 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
2670 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
2671 return Error(BitcodeError::InvalidRecord);
2673 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
2674 return Error(BitcodeError::InvalidRecord);
2675 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
2676 InstructionList.push_back(I);
2680 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
2681 // Old form of ICmp/FCmp returning bool
2682 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
2683 // both legal on vectors but had different behaviour.
2684 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
2685 // FCmp/ICmp returning bool or vector of bool
2689 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
2690 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
2691 OpNum+1 != Record.size())
2692 return Error(BitcodeError::InvalidRecord);
2694 if (LHS->getType()->isFPOrFPVectorTy())
2695 I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
2697 I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
2698 InstructionList.push_back(I);
2702 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
2704 unsigned Size = Record.size();
2706 I = ReturnInst::Create(Context);
2707 InstructionList.push_back(I);
2712 Value *Op = nullptr;
2713 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2714 return Error(BitcodeError::InvalidRecord);
2715 if (OpNum != Record.size())
2716 return Error(BitcodeError::InvalidRecord);
2718 I = ReturnInst::Create(Context, Op);
2719 InstructionList.push_back(I);
2722 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
2723 if (Record.size() != 1 && Record.size() != 3)
2724 return Error(BitcodeError::InvalidRecord);
2725 BasicBlock *TrueDest = getBasicBlock(Record[0]);
2727 return Error(BitcodeError::InvalidRecord);
2729 if (Record.size() == 1) {
2730 I = BranchInst::Create(TrueDest);
2731 InstructionList.push_back(I);
2734 BasicBlock *FalseDest = getBasicBlock(Record[1]);
2735 Value *Cond = getValue(Record, 2, NextValueNo,
2736 Type::getInt1Ty(Context));
2737 if (!FalseDest || !Cond)
2738 return Error(BitcodeError::InvalidRecord);
2739 I = BranchInst::Create(TrueDest, FalseDest, Cond);
2740 InstructionList.push_back(I);
2744 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
2746 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
2747 // "New" SwitchInst format with case ranges. The changes to write this
2748 // format were reverted but we still recognize bitcode that uses it.
2749 // Hopefully someday we will have support for case ranges and can use
2750 // this format again.
2752 Type *OpTy = getTypeByID(Record[1]);
2753 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
2755 Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
2756 BasicBlock *Default = getBasicBlock(Record[3]);
2757 if (!OpTy || !Cond || !Default)
2758 return Error(BitcodeError::InvalidRecord);
2760 unsigned NumCases = Record[4];
2762 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
2763 InstructionList.push_back(SI);
2765 unsigned CurIdx = 5;
2766 for (unsigned i = 0; i != NumCases; ++i) {
2767 SmallVector<ConstantInt*, 1> CaseVals;
2768 unsigned NumItems = Record[CurIdx++];
2769 for (unsigned ci = 0; ci != NumItems; ++ci) {
2770 bool isSingleNumber = Record[CurIdx++];
2773 unsigned ActiveWords = 1;
2774 if (ValueBitWidth > 64)
2775 ActiveWords = Record[CurIdx++];
2776 Low = ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
2778 CurIdx += ActiveWords;
2780 if (!isSingleNumber) {
2782 if (ValueBitWidth > 64)
2783 ActiveWords = Record[CurIdx++];
2785 ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
2787 CurIdx += ActiveWords;
2789 // FIXME: It is not clear whether values in the range should be
2790 // compared as signed or unsigned values. The partially
2791 // implemented changes that used this format in the past used
2792 // unsigned comparisons.
2793 for ( ; Low.ule(High); ++Low)
2794 CaseVals.push_back(ConstantInt::get(Context, Low));
2796 CaseVals.push_back(ConstantInt::get(Context, Low));
2798 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
2799 for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
2800 cve = CaseVals.end(); cvi != cve; ++cvi)
2801 SI->addCase(*cvi, DestBB);
2807 // Old SwitchInst format without case ranges.
2809 if (Record.size() < 3 || (Record.size() & 1) == 0)
2810 return Error(BitcodeError::InvalidRecord);
2811 Type *OpTy = getTypeByID(Record[0]);
2812 Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
2813 BasicBlock *Default = getBasicBlock(Record[2]);
2814 if (!OpTy || !Cond || !Default)
2815 return Error(BitcodeError::InvalidRecord);
2816 unsigned NumCases = (Record.size()-3)/2;
2817 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
2818 InstructionList.push_back(SI);
2819 for (unsigned i = 0, e = NumCases; i != e; ++i) {
2820 ConstantInt *CaseVal =
2821 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
2822 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
2823 if (!CaseVal || !DestBB) {
2825 return Error(BitcodeError::InvalidRecord);
2827 SI->addCase(CaseVal, DestBB);
2832 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
2833 if (Record.size() < 2)
2834 return Error(BitcodeError::InvalidRecord);
2835 Type *OpTy = getTypeByID(Record[0]);
2836 Value *Address = getValue(Record, 1, NextValueNo, OpTy);
2837 if (!OpTy || !Address)
2838 return Error(BitcodeError::InvalidRecord);
2839 unsigned NumDests = Record.size()-2;
2840 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
2841 InstructionList.push_back(IBI);
2842 for (unsigned i = 0, e = NumDests; i != e; ++i) {
2843 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
2844 IBI->addDestination(DestBB);
2847 return Error(BitcodeError::InvalidRecord);
2854 case bitc::FUNC_CODE_INST_INVOKE: {
2855 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
2856 if (Record.size() < 4)
2857 return Error(BitcodeError::InvalidRecord);
2858 AttributeSet PAL = getAttributes(Record[0]);
2859 unsigned CCInfo = Record[1];
2860 BasicBlock *NormalBB = getBasicBlock(Record[2]);
2861 BasicBlock *UnwindBB = getBasicBlock(Record[3]);
2865 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2866 return Error(BitcodeError::InvalidRecord);
2868 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
2869 FunctionType *FTy = !CalleeTy ? nullptr :
2870 dyn_cast<FunctionType>(CalleeTy->getElementType());
2872 // Check that the right number of fixed parameters are here.
2873 if (!FTy || !NormalBB || !UnwindBB ||
2874 Record.size() < OpNum+FTy->getNumParams())
2875 return Error(BitcodeError::InvalidRecord);
2877 SmallVector<Value*, 16> Ops;
2878 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2879 Ops.push_back(getValue(Record, OpNum, NextValueNo,
2880 FTy->getParamType(i)));
2882 return Error(BitcodeError::InvalidRecord);
2885 if (!FTy->isVarArg()) {
2886 if (Record.size() != OpNum)
2887 return Error(BitcodeError::InvalidRecord);
2889 // Read type/value pairs for varargs params.
2890 while (OpNum != Record.size()) {
2892 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2893 return Error(BitcodeError::InvalidRecord);
2898 I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops);
2899 InstructionList.push_back(I);
2900 cast<InvokeInst>(I)->setCallingConv(
2901 static_cast<CallingConv::ID>(CCInfo));
2902 cast<InvokeInst>(I)->setAttributes(PAL);
2905 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
2907 Value *Val = nullptr;
2908 if (getValueTypePair(Record, Idx, NextValueNo, Val))
2909 return Error(BitcodeError::InvalidRecord);
2910 I = ResumeInst::Create(Val);
2911 InstructionList.push_back(I);
2914 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
2915 I = new UnreachableInst(Context);
2916 InstructionList.push_back(I);
2918 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
2919 if (Record.size() < 1 || ((Record.size()-1)&1))
2920 return Error(BitcodeError::InvalidRecord);
2921 Type *Ty = getTypeByID(Record[0]);
2923 return Error(BitcodeError::InvalidRecord);
2925 PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
2926 InstructionList.push_back(PN);
2928 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
2930 // With the new function encoding, it is possible that operands have
2931 // negative IDs (for forward references). Use a signed VBR
2932 // representation to keep the encoding small.
2934 V = getValueSigned(Record, 1+i, NextValueNo, Ty);
2936 V = getValue(Record, 1+i, NextValueNo, Ty);
2937 BasicBlock *BB = getBasicBlock(Record[2+i]);
2939 return Error(BitcodeError::InvalidRecord);
2940 PN->addIncoming(V, BB);
2946 case bitc::FUNC_CODE_INST_LANDINGPAD: {
2947 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
2949 if (Record.size() < 4)
2950 return Error(BitcodeError::InvalidRecord);
2951 Type *Ty = getTypeByID(Record[Idx++]);
2953 return Error(BitcodeError::InvalidRecord);
2954 Value *PersFn = nullptr;
2955 if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
2956 return Error(BitcodeError::InvalidRecord);
2958 bool IsCleanup = !!Record[Idx++];
2959 unsigned NumClauses = Record[Idx++];
2960 LandingPadInst *LP = LandingPadInst::Create(Ty, PersFn, NumClauses);
2961 LP->setCleanup(IsCleanup);
2962 for (unsigned J = 0; J != NumClauses; ++J) {
2963 LandingPadInst::ClauseType CT =
2964 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
2967 if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
2969 return Error(BitcodeError::InvalidRecord);
2972 assert((CT != LandingPadInst::Catch ||
2973 !isa<ArrayType>(Val->getType())) &&
2974 "Catch clause has a invalid type!");
2975 assert((CT != LandingPadInst::Filter ||
2976 isa<ArrayType>(Val->getType())) &&
2977 "Filter clause has invalid type!");
2978 LP->addClause(cast<Constant>(Val));
2982 InstructionList.push_back(I);
2986 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
2987 if (Record.size() != 4)
2988 return Error(BitcodeError::InvalidRecord);
2990 dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
2991 Type *OpTy = getTypeByID(Record[1]);
2992 Value *Size = getFnValueByID(Record[2], OpTy);
2993 unsigned AlignRecord = Record[3];
2994 bool InAlloca = AlignRecord & (1 << 5);
2995 unsigned Align = AlignRecord & ((1 << 5) - 1);
2997 return Error(BitcodeError::InvalidRecord);
2998 AllocaInst *AI = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
2999 AI->setUsedWithInAlloca(InAlloca);
3001 InstructionList.push_back(I);
3004 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
3007 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3008 OpNum+2 != Record.size())
3009 return Error(BitcodeError::InvalidRecord);
3011 I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
3012 InstructionList.push_back(I);
3015 case bitc::FUNC_CODE_INST_LOADATOMIC: {
3016 // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
3019 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3020 OpNum+4 != Record.size())
3021 return Error(BitcodeError::InvalidRecord);
3023 AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
3024 if (Ordering == NotAtomic || Ordering == Release ||
3025 Ordering == AcquireRelease)
3026 return Error(BitcodeError::InvalidRecord);
3027 if (Ordering != NotAtomic && Record[OpNum] == 0)
3028 return Error(BitcodeError::InvalidRecord);
3029 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
3031 I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1,
3032 Ordering, SynchScope);
3033 InstructionList.push_back(I);
3036 case bitc::FUNC_CODE_INST_STORE: { // STORE2:[ptrty, ptr, val, align, vol]
3039 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3040 popValue(Record, OpNum, NextValueNo,
3041 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
3042 OpNum+2 != Record.size())
3043 return Error(BitcodeError::InvalidRecord);
3045 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
3046 InstructionList.push_back(I);
3049 case bitc::FUNC_CODE_INST_STOREATOMIC: {
3050 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
3053 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3054 popValue(Record, OpNum, NextValueNo,
3055 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
3056 OpNum+4 != Record.size())
3057 return Error(BitcodeError::InvalidRecord);
3059 AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
3060 if (Ordering == NotAtomic || Ordering == Acquire ||
3061 Ordering == AcquireRelease)
3062 return Error(BitcodeError::InvalidRecord);
3063 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
3064 if (Ordering != NotAtomic && Record[OpNum] == 0)
3065 return Error(BitcodeError::InvalidRecord);
3067 I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1,
3068 Ordering, SynchScope);
3069 InstructionList.push_back(I);
3072 case bitc::FUNC_CODE_INST_CMPXCHG: {
3073 // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
3074 // failureordering?, isweak?]
3076 Value *Ptr, *Cmp, *New;
3077 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3078 popValue(Record, OpNum, NextValueNo,
3079 cast<PointerType>(Ptr->getType())->getElementType(), Cmp) ||
3080 popValue(Record, OpNum, NextValueNo,
3081 cast<PointerType>(Ptr->getType())->getElementType(), New) ||
3082 (Record.size() < OpNum + 3 || Record.size() > OpNum + 5))
3083 return Error(BitcodeError::InvalidRecord);
3084 AtomicOrdering SuccessOrdering = GetDecodedOrdering(Record[OpNum+1]);
3085 if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
3086 return Error(BitcodeError::InvalidRecord);
3087 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+2]);
3089 AtomicOrdering FailureOrdering;
3090 if (Record.size() < 7)
3092 AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
3094 FailureOrdering = GetDecodedOrdering(Record[OpNum+3]);
3096 I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
3098 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
3100 if (Record.size() < 8) {
3101 // Before weak cmpxchgs existed, the instruction simply returned the
3102 // value loaded from memory, so bitcode files from that era will be
3103 // expecting the first component of a modern cmpxchg.
3104 CurBB->getInstList().push_back(I);
3105 I = ExtractValueInst::Create(I, 0);
3107 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
3110 InstructionList.push_back(I);
3113 case bitc::FUNC_CODE_INST_ATOMICRMW: {
3114 // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
3117 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3118 popValue(Record, OpNum, NextValueNo,
3119 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
3120 OpNum+4 != Record.size())
3121 return Error(BitcodeError::InvalidRecord);
3122 AtomicRMWInst::BinOp Operation = GetDecodedRMWOperation(Record[OpNum]);
3123 if (Operation < AtomicRMWInst::FIRST_BINOP ||
3124 Operation > AtomicRMWInst::LAST_BINOP)
3125 return Error(BitcodeError::InvalidRecord);
3126 AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
3127 if (Ordering == NotAtomic || Ordering == Unordered)
3128 return Error(BitcodeError::InvalidRecord);
3129 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
3130 I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
3131 cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
3132 InstructionList.push_back(I);
3135 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
3136 if (2 != Record.size())
3137 return Error(BitcodeError::InvalidRecord);
3138 AtomicOrdering Ordering = GetDecodedOrdering(Record[0]);
3139 if (Ordering == NotAtomic || Ordering == Unordered ||
3140 Ordering == Monotonic)
3141 return Error(BitcodeError::InvalidRecord);
3142 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[1]);
3143 I = new FenceInst(Context, Ordering, SynchScope);
3144 InstructionList.push_back(I);
3147 case bitc::FUNC_CODE_INST_CALL: {
3148 // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
3149 if (Record.size() < 3)
3150 return Error(BitcodeError::InvalidRecord);
3152 AttributeSet PAL = getAttributes(Record[0]);
3153 unsigned CCInfo = Record[1];
3157 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
3158 return Error(BitcodeError::InvalidRecord);
3160 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
3161 FunctionType *FTy = nullptr;
3162 if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
3163 if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
3164 return Error(BitcodeError::InvalidRecord);
3166 SmallVector<Value*, 16> Args;
3167 // Read the fixed params.
3168 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
3169 if (FTy->getParamType(i)->isLabelTy())
3170 Args.push_back(getBasicBlock(Record[OpNum]));
3172 Args.push_back(getValue(Record, OpNum, NextValueNo,
3173 FTy->getParamType(i)));
3175 return Error(BitcodeError::InvalidRecord);
3178 // Read type/value pairs for varargs params.
3179 if (!FTy->isVarArg()) {
3180 if (OpNum != Record.size())
3181 return Error(BitcodeError::InvalidRecord);
3183 while (OpNum != Record.size()) {
3185 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3186 return Error(BitcodeError::InvalidRecord);
3191 I = CallInst::Create(Callee, Args);
3192 InstructionList.push_back(I);
3193 cast<CallInst>(I)->setCallingConv(
3194 static_cast<CallingConv::ID>((~(1U << 14) & CCInfo) >> 1));
3195 CallInst::TailCallKind TCK = CallInst::TCK_None;
3197 TCK = CallInst::TCK_Tail;
3198 if (CCInfo & (1 << 14))
3199 TCK = CallInst::TCK_MustTail;
3200 cast<CallInst>(I)->setTailCallKind(TCK);
3201 cast<CallInst>(I)->setAttributes(PAL);
3204 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
3205 if (Record.size() < 3)
3206 return Error(BitcodeError::InvalidRecord);
3207 Type *OpTy = getTypeByID(Record[0]);
3208 Value *Op = getValue(Record, 1, NextValueNo, OpTy);
3209 Type *ResTy = getTypeByID(Record[2]);
3210 if (!OpTy || !Op || !ResTy)
3211 return Error(BitcodeError::InvalidRecord);
3212 I = new VAArgInst(Op, ResTy);
3213 InstructionList.push_back(I);
3218 // Add instruction to end of current BB. If there is no current BB, reject
3222 return Error(BitcodeError::InvalidInstructionWithNoBB);
3224 CurBB->getInstList().push_back(I);
3226 // If this was a terminator instruction, move to the next block.
3227 if (isa<TerminatorInst>(I)) {
3229 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
3232 // Non-void values get registered in the value table for future use.
3233 if (I && !I->getType()->isVoidTy())
3234 ValueList.AssignValue(I, NextValueNo++);
3239 // Check the function list for unresolved values.
3240 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
3241 if (!A->getParent()) {
3242 // We found at least one unresolved value. Nuke them all to avoid leaks.
3243 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
3244 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
3245 A->replaceAllUsesWith(UndefValue::get(A->getType()));
3249 return Error(BitcodeError::NeverResolvedValueFoundInFunction);
3253 // FIXME: Check for unresolved forward-declared metadata references
3254 // and clean up leaks.
3256 // Trim the value list down to the size it was before we parsed this function.
3257 ValueList.shrinkTo(ModuleValueListSize);
3258 MDValueList.shrinkTo(ModuleMDValueListSize);
3259 std::vector<BasicBlock*>().swap(FunctionBBs);
3260 return std::error_code();
3263 /// Find the function body in the bitcode stream
3264 std::error_code BitcodeReader::FindFunctionInStream(
3266 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
3267 while (DeferredFunctionInfoIterator->second == 0) {
3268 if (Stream.AtEndOfStream())
3269 return Error(BitcodeError::CouldNotFindFunctionInStream);
3270 // ParseModule will parse the next body in the stream and set its
3271 // position in the DeferredFunctionInfo map.
3272 if (std::error_code EC = ParseModule(true))
3275 return std::error_code();
3278 //===----------------------------------------------------------------------===//
3279 // GVMaterializer implementation
3280 //===----------------------------------------------------------------------===//
3282 void BitcodeReader::releaseBuffer() { Buffer.release(); }
3284 bool BitcodeReader::isMaterializable(const GlobalValue *GV) const {
3285 if (const Function *F = dyn_cast<Function>(GV)) {
3286 return F->isDeclaration() &&
3287 DeferredFunctionInfo.count(const_cast<Function*>(F));
3292 std::error_code BitcodeReader::Materialize(GlobalValue *GV) {
3293 Function *F = dyn_cast<Function>(GV);
3294 // If it's not a function or is already material, ignore the request.
3295 if (!F || !F->isMaterializable())
3296 return std::error_code();
3298 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
3299 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
3300 // If its position is recorded as 0, its body is somewhere in the stream
3301 // but we haven't seen it yet.
3302 if (DFII->second == 0 && LazyStreamer)
3303 if (std::error_code EC = FindFunctionInStream(F, DFII))
3306 // Move the bit stream to the saved position of the deferred function body.
3307 Stream.JumpToBit(DFII->second);
3309 if (std::error_code EC = ParseFunctionBody(F))
3312 // Upgrade any old intrinsic calls in the function.
3313 for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
3314 E = UpgradedIntrinsics.end(); I != E; ++I) {
3315 if (I->first != I->second) {
3316 for (auto UI = I->first->user_begin(), UE = I->first->user_end();
3318 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
3319 UpgradeIntrinsicCall(CI, I->second);
3324 // Bring in any functions that this function forward-referenced via
3326 return materializeForwardReferencedFunctions();
3329 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
3330 const Function *F = dyn_cast<Function>(GV);
3331 if (!F || F->isDeclaration())
3334 // Dematerializing F would leave dangling references that wouldn't be
3335 // reconnected on re-materialization.
3336 if (BlockAddressesTaken.count(F))
3339 return DeferredFunctionInfo.count(const_cast<Function*>(F));
3342 void BitcodeReader::Dematerialize(GlobalValue *GV) {
3343 Function *F = dyn_cast<Function>(GV);
3344 // If this function isn't dematerializable, this is a noop.
3345 if (!F || !isDematerializable(F))
3348 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
3350 // Just forget the function body, we can remat it later.
3351 F->dropAllReferences();
3354 std::error_code BitcodeReader::MaterializeModule(Module *M) {
3355 assert(M == TheModule &&
3356 "Can only Materialize the Module this BitcodeReader is attached to.");
3358 // Promise to materialize all forward references.
3359 WillMaterializeAllForwardRefs = true;
3361 // Iterate over the module, deserializing any functions that are still on
3363 for (Module::iterator F = TheModule->begin(), E = TheModule->end();
3365 if (F->isMaterializable()) {
3366 if (std::error_code EC = Materialize(F))
3370 // At this point, if there are any function bodies, the current bit is
3371 // pointing to the END_BLOCK record after them. Now make sure the rest
3372 // of the bits in the module have been read.
3376 // Check that all block address forward references got resolved (as we
3378 if (!BasicBlockFwdRefs.empty())
3379 return Error(BitcodeError::NeverResolvedFunctionFromBlockAddress);
3381 // Upgrade any intrinsic calls that slipped through (should not happen!) and
3382 // delete the old functions to clean up. We can't do this unless the entire
3383 // module is materialized because there could always be another function body
3384 // with calls to the old function.
3385 for (std::vector<std::pair<Function*, Function*> >::iterator I =
3386 UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
3387 if (I->first != I->second) {
3388 for (auto UI = I->first->user_begin(), UE = I->first->user_end();
3390 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
3391 UpgradeIntrinsicCall(CI, I->second);
3393 if (!I->first->use_empty())
3394 I->first->replaceAllUsesWith(I->second);
3395 I->first->eraseFromParent();
3398 std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
3400 for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
3401 UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
3403 UpgradeDebugInfo(*M);
3404 return std::error_code();
3407 std::error_code BitcodeReader::InitStream() {
3409 return InitLazyStream();
3410 return InitStreamFromBuffer();
3413 std::error_code BitcodeReader::InitStreamFromBuffer() {
3414 const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
3415 const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
3417 if (Buffer->getBufferSize() & 3)
3418 return Error(BitcodeError::InvalidBitcodeSignature);
3420 // If we have a wrapper header, parse it and ignore the non-bc file contents.
3421 // The magic number is 0x0B17C0DE stored in little endian.
3422 if (isBitcodeWrapper(BufPtr, BufEnd))
3423 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
3424 return Error(BitcodeError::InvalidBitcodeWrapperHeader);
3426 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
3427 Stream.init(*StreamFile);
3429 return std::error_code();
3432 std::error_code BitcodeReader::InitLazyStream() {
3433 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
3435 StreamingMemoryObject *Bytes = new StreamingMemoryObject(LazyStreamer);
3436 StreamFile.reset(new BitstreamReader(Bytes));
3437 Stream.init(*StreamFile);
3439 unsigned char buf[16];
3440 if (Bytes->readBytes(0, 16, buf) == -1)
3441 return Error(BitcodeError::InvalidBitcodeSignature);
3443 if (!isBitcode(buf, buf + 16))
3444 return Error(BitcodeError::InvalidBitcodeSignature);
3446 if (isBitcodeWrapper(buf, buf + 4)) {
3447 const unsigned char *bitcodeStart = buf;
3448 const unsigned char *bitcodeEnd = buf + 16;
3449 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
3450 Bytes->dropLeadingBytes(bitcodeStart - buf);
3451 Bytes->setKnownObjectSize(bitcodeEnd - bitcodeStart);
3453 return std::error_code();
3457 class BitcodeErrorCategoryType : public std::error_category {
3458 const char *name() const LLVM_NOEXCEPT override {
3459 return "llvm.bitcode";
3461 std::string message(int IE) const override {
3462 BitcodeError E = static_cast<BitcodeError>(IE);
3464 case BitcodeError::ConflictingMETADATA_KINDRecords:
3465 return "Conflicting METADATA_KIND records";
3466 case BitcodeError::CouldNotFindFunctionInStream:
3467 return "Could not find function in stream";
3468 case BitcodeError::ExpectedConstant:
3469 return "Expected a constant";
3470 case BitcodeError::InsufficientFunctionProtos:
3471 return "Insufficient function protos";
3472 case BitcodeError::InvalidBitcodeSignature:
3473 return "Invalid bitcode signature";
3474 case BitcodeError::InvalidBitcodeWrapperHeader:
3475 return "Invalid bitcode wrapper header";
3476 case BitcodeError::InvalidConstantReference:
3477 return "Invalid ronstant reference";
3478 case BitcodeError::InvalidID:
3479 return "Invalid ID";
3480 case BitcodeError::InvalidInstructionWithNoBB:
3481 return "Invalid instruction with no BB";
3482 case BitcodeError::InvalidRecord:
3483 return "Invalid record";
3484 case BitcodeError::InvalidTypeForValue:
3485 return "Invalid type for value";
3486 case BitcodeError::InvalidTYPETable:
3487 return "Invalid TYPE table";
3488 case BitcodeError::InvalidType:
3489 return "Invalid type";
3490 case BitcodeError::MalformedBlock:
3491 return "Malformed block";
3492 case BitcodeError::MalformedGlobalInitializerSet:
3493 return "Malformed global initializer set";
3494 case BitcodeError::InvalidMultipleBlocks:
3495 return "Invalid multiple blocks";
3496 case BitcodeError::NeverResolvedValueFoundInFunction:
3497 return "Never resolved value found in function";
3498 case BitcodeError::NeverResolvedFunctionFromBlockAddress:
3499 return "Never resolved function from blockaddress";
3500 case BitcodeError::InvalidValue:
3501 return "Invalid value";
3503 llvm_unreachable("Unknown error type!");
3508 static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
3510 const std::error_category &llvm::BitcodeErrorCategory() {
3511 return *ErrorCategory;
3514 //===----------------------------------------------------------------------===//
3515 // External interface
3516 //===----------------------------------------------------------------------===//
3518 /// \brief Get a lazy one-at-time loading module from bitcode.
3520 /// This isn't always used in a lazy context. In particular, it's also used by
3521 /// \a parseBitcodeFile(). If this is truly lazy, then we need to eagerly pull
3522 /// in forward-referenced functions from block address references.
3524 /// \param[in] WillMaterializeAll Set to \c true if the caller promises to
3525 /// materialize everything -- in particular, if this isn't truly lazy.
3526 static ErrorOr<Module *>
3527 getLazyBitcodeModuleImpl(std::unique_ptr<MemoryBuffer> &&Buffer,
3528 LLVMContext &Context, bool WillMaterializeAll) {
3529 Module *M = new Module(Buffer->getBufferIdentifier(), Context);
3530 BitcodeReader *R = new BitcodeReader(Buffer.get(), Context);
3531 M->setMaterializer(R);
3533 auto cleanupOnError = [&](std::error_code EC) {
3534 R->releaseBuffer(); // Never take ownership on error.
3535 delete M; // Also deletes R.
3539 if (std::error_code EC = R->ParseBitcodeInto(M))
3540 return cleanupOnError(EC);
3542 if (!WillMaterializeAll)
3543 // Resolve forward references from blockaddresses.
3544 if (std::error_code EC = R->materializeForwardReferencedFunctions())
3545 return cleanupOnError(EC);
3547 Buffer.release(); // The BitcodeReader owns it now.
3552 llvm::getLazyBitcodeModule(std::unique_ptr<MemoryBuffer> &&Buffer,
3553 LLVMContext &Context) {
3554 return getLazyBitcodeModuleImpl(std::move(Buffer), Context, false);
3557 Module *llvm::getStreamedBitcodeModule(const std::string &name,
3558 DataStreamer *streamer,
3559 LLVMContext &Context,
3560 std::string *ErrMsg) {
3561 Module *M = new Module(name, Context);
3562 BitcodeReader *R = new BitcodeReader(streamer, Context);
3563 M->setMaterializer(R);
3564 if (std::error_code EC = R->ParseBitcodeInto(M)) {
3566 *ErrMsg = EC.message();
3567 delete M; // Also deletes R.
3573 ErrorOr<Module *> llvm::parseBitcodeFile(MemoryBufferRef Buffer,
3574 LLVMContext &Context) {
3575 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
3576 ErrorOr<Module *> ModuleOrErr =
3577 getLazyBitcodeModuleImpl(std::move(Buf), Context, true);
3580 Module *M = ModuleOrErr.get();
3581 // Read in the entire module, and destroy the BitcodeReader.
3582 if (std::error_code EC = M->materializeAllPermanently()) {
3587 // TODO: Restore the use-lists to the in-memory state when the bitcode was
3588 // written. We must defer until the Module has been fully materialized.
3593 std::string llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer,
3594 LLVMContext &Context) {
3595 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
3596 auto R = llvm::make_unique<BitcodeReader>(Buf.release(), Context);
3597 ErrorOr<std::string> Triple = R->parseTriple();
3598 if (Triple.getError())
3600 return Triple.get();