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 "llvm/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/Triple.h"
15 #include "llvm/Bitcode/BitstreamReader.h"
16 #include "llvm/Bitcode/LLVMBitCodes.h"
17 #include "llvm/IR/AutoUpgrade.h"
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DebugInfo.h"
20 #include "llvm/IR/DebugInfoMetadata.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/DiagnosticPrinter.h"
23 #include "llvm/IR/GVMaterializer.h"
24 #include "llvm/IR/InlineAsm.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/OperandTraits.h"
29 #include "llvm/IR/Operator.h"
30 #include "llvm/IR/ValueHandle.h"
31 #include "llvm/Support/DataStream.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/MemoryBuffer.h"
35 #include "llvm/Support/raw_ostream.h"
41 SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
44 class BitcodeReaderValueList {
45 std::vector<WeakVH> ValuePtrs;
47 /// As we resolve forward-referenced constants, we add information about them
48 /// to this vector. This allows us to resolve them in bulk instead of
49 /// resolving each reference at a time. See the code in
50 /// ResolveConstantForwardRefs for more information about this.
52 /// The key of this vector is the placeholder constant, the value is the slot
53 /// number that holds the resolved value.
54 typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy;
55 ResolveConstantsTy ResolveConstants;
58 BitcodeReaderValueList(LLVMContext &C) : Context(C) {}
59 ~BitcodeReaderValueList() {
60 assert(ResolveConstants.empty() && "Constants not resolved?");
63 // vector compatibility methods
64 unsigned size() const { return ValuePtrs.size(); }
65 void resize(unsigned N) { ValuePtrs.resize(N); }
66 void push_back(Value *V) { ValuePtrs.emplace_back(V); }
69 assert(ResolveConstants.empty() && "Constants not resolved?");
73 Value *operator[](unsigned i) const {
74 assert(i < ValuePtrs.size());
78 Value *back() const { return ValuePtrs.back(); }
79 void pop_back() { ValuePtrs.pop_back(); }
80 bool empty() const { return ValuePtrs.empty(); }
81 void shrinkTo(unsigned N) {
82 assert(N <= size() && "Invalid shrinkTo request!");
86 Constant *getConstantFwdRef(unsigned Idx, Type *Ty);
87 Value *getValueFwdRef(unsigned Idx, Type *Ty);
89 void assignValue(Value *V, unsigned Idx);
91 /// Once all constants are read, this method bulk resolves any forward
93 void resolveConstantForwardRefs();
96 class BitcodeReaderMDValueList {
101 std::vector<TrackingMDRef> MDValuePtrs;
103 LLVMContext &Context;
105 BitcodeReaderMDValueList(LLVMContext &C)
106 : NumFwdRefs(0), AnyFwdRefs(false), Context(C) {}
108 // vector compatibility methods
109 unsigned size() const { return MDValuePtrs.size(); }
110 void resize(unsigned N) { MDValuePtrs.resize(N); }
111 void push_back(Metadata *MD) { MDValuePtrs.emplace_back(MD); }
112 void clear() { MDValuePtrs.clear(); }
113 Metadata *back() const { return MDValuePtrs.back(); }
114 void pop_back() { MDValuePtrs.pop_back(); }
115 bool empty() const { return MDValuePtrs.empty(); }
117 Metadata *operator[](unsigned i) const {
118 assert(i < MDValuePtrs.size());
119 return MDValuePtrs[i];
122 void shrinkTo(unsigned N) {
123 assert(N <= size() && "Invalid shrinkTo request!");
124 MDValuePtrs.resize(N);
127 Metadata *getValueFwdRef(unsigned Idx);
128 void assignValue(Metadata *MD, unsigned Idx);
129 void tryToResolveCycles();
132 class BitcodeReader : public GVMaterializer {
133 LLVMContext &Context;
134 DiagnosticHandlerFunction DiagnosticHandler;
135 Module *TheModule = nullptr;
136 std::unique_ptr<MemoryBuffer> Buffer;
137 std::unique_ptr<BitstreamReader> StreamFile;
138 BitstreamCursor Stream;
139 uint64_t NextUnreadBit = 0;
140 bool SeenValueSymbolTable = false;
142 std::vector<Type*> TypeList;
143 BitcodeReaderValueList ValueList;
144 BitcodeReaderMDValueList MDValueList;
145 std::vector<Comdat *> ComdatList;
146 SmallVector<Instruction *, 64> InstructionList;
148 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
149 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits;
150 std::vector<std::pair<Function*, unsigned> > FunctionPrefixes;
151 std::vector<std::pair<Function*, unsigned> > FunctionPrologues;
152 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFns;
154 SmallVector<Instruction*, 64> InstsWithTBAATag;
156 /// The set of attributes by index. Index zero in the file is for null, and
157 /// is thus not represented here. As such all indices are off by one.
158 std::vector<AttributeSet> MAttributes;
160 /// \brief The set of attribute groups.
161 std::map<unsigned, AttributeSet> MAttributeGroups;
163 /// While parsing a function body, this is a list of the basic blocks for the
165 std::vector<BasicBlock*> FunctionBBs;
167 // When reading the module header, this list is populated with functions that
168 // have bodies later in the file.
169 std::vector<Function*> FunctionsWithBodies;
171 // When intrinsic functions are encountered which require upgrading they are
172 // stored here with their replacement function.
173 typedef DenseMap<Function*, Function*> UpgradedIntrinsicMap;
174 UpgradedIntrinsicMap UpgradedIntrinsics;
176 // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
177 DenseMap<unsigned, unsigned> MDKindMap;
179 // Several operations happen after the module header has been read, but
180 // before function bodies are processed. This keeps track of whether
181 // we've done this yet.
182 bool SeenFirstFunctionBody = false;
184 /// When function bodies are initially scanned, this map contains info about
185 /// where to find deferred function body in the stream.
186 DenseMap<Function*, uint64_t> DeferredFunctionInfo;
188 /// When Metadata block is initially scanned when parsing the module, we may
189 /// choose to defer parsing of the metadata. This vector contains info about
190 /// which Metadata blocks are deferred.
191 std::vector<uint64_t> DeferredMetadataInfo;
193 /// These are basic blocks forward-referenced by block addresses. They are
194 /// inserted lazily into functions when they're loaded. The basic block ID is
195 /// its index into the vector.
196 DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
197 std::deque<Function *> BasicBlockFwdRefQueue;
199 /// Indicates that we are using a new encoding for instruction operands where
200 /// most operands in the current FUNCTION_BLOCK are encoded relative to the
201 /// instruction number, for a more compact encoding. Some instruction
202 /// operands are not relative to the instruction ID: basic block numbers, and
203 /// types. Once the old style function blocks have been phased out, we would
204 /// not need this flag.
205 bool UseRelativeIDs = false;
207 /// True if all functions will be materialized, negating the need to process
208 /// (e.g.) blockaddress forward references.
209 bool WillMaterializeAllForwardRefs = false;
211 /// Functions that have block addresses taken. This is usually empty.
212 SmallPtrSet<const Function *, 4> BlockAddressesTaken;
214 /// True if any Metadata block has been materialized.
215 bool IsMetadataMaterialized = false;
217 bool StripDebugInfo = false;
220 std::error_code error(BitcodeError E, const Twine &Message);
221 std::error_code error(BitcodeError E);
222 std::error_code error(const Twine &Message);
224 BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context,
225 DiagnosticHandlerFunction DiagnosticHandler);
226 BitcodeReader(LLVMContext &Context,
227 DiagnosticHandlerFunction DiagnosticHandler);
228 ~BitcodeReader() override { freeState(); }
230 std::error_code materializeForwardReferencedFunctions();
234 void releaseBuffer();
236 bool isDematerializable(const GlobalValue *GV) const override;
237 std::error_code materialize(GlobalValue *GV) override;
238 std::error_code materializeModule(Module *M) override;
239 std::vector<StructType *> getIdentifiedStructTypes() const override;
240 void dematerialize(GlobalValue *GV) override;
242 /// \brief Main interface to parsing a bitcode buffer.
243 /// \returns true if an error occurred.
244 std::error_code parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
246 bool ShouldLazyLoadMetadata = false);
248 /// \brief Cheap mechanism to just extract module triple
249 /// \returns true if an error occurred.
250 ErrorOr<std::string> parseTriple();
252 static uint64_t decodeSignRotatedValue(uint64_t V);
254 /// Materialize any deferred Metadata block.
255 std::error_code materializeMetadata() override;
257 void setStripDebugInfo() override;
260 std::vector<StructType *> IdentifiedStructTypes;
261 StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
262 StructType *createIdentifiedStructType(LLVMContext &Context);
264 Type *getTypeByID(unsigned ID);
265 Value *getFnValueByID(unsigned ID, Type *Ty) {
266 if (Ty && Ty->isMetadataTy())
267 return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
268 return ValueList.getValueFwdRef(ID, Ty);
270 Metadata *getFnMetadataByID(unsigned ID) {
271 return MDValueList.getValueFwdRef(ID);
273 BasicBlock *getBasicBlock(unsigned ID) const {
274 if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
275 return FunctionBBs[ID];
277 AttributeSet getAttributes(unsigned i) const {
278 if (i-1 < MAttributes.size())
279 return MAttributes[i-1];
280 return AttributeSet();
283 /// Read a value/type pair out of the specified record from slot 'Slot'.
284 /// Increment Slot past the number of slots used in the record. Return true on
286 bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
287 unsigned InstNum, Value *&ResVal) {
288 if (Slot == Record.size()) return true;
289 unsigned ValNo = (unsigned)Record[Slot++];
290 // Adjust the ValNo, if it was encoded relative to the InstNum.
292 ValNo = InstNum - ValNo;
293 if (ValNo < InstNum) {
294 // If this is not a forward reference, just return the value we already
296 ResVal = getFnValueByID(ValNo, nullptr);
297 return ResVal == nullptr;
299 if (Slot == Record.size())
302 unsigned TypeNo = (unsigned)Record[Slot++];
303 ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
304 return ResVal == nullptr;
307 /// Read a value out of the specified record from slot 'Slot'. Increment Slot
308 /// past the number of slots used by the value in the record. Return true if
309 /// there is an error.
310 bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
311 unsigned InstNum, Type *Ty, Value *&ResVal) {
312 if (getValue(Record, Slot, InstNum, Ty, ResVal))
314 // All values currently take a single record slot.
319 /// Like popValue, but does not increment the Slot number.
320 bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
321 unsigned InstNum, Type *Ty, Value *&ResVal) {
322 ResVal = getValue(Record, Slot, InstNum, Ty);
323 return ResVal == nullptr;
326 /// Version of getValue that returns ResVal directly, or 0 if there is an
328 Value *getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
329 unsigned InstNum, Type *Ty) {
330 if (Slot == Record.size()) return nullptr;
331 unsigned ValNo = (unsigned)Record[Slot];
332 // Adjust the ValNo, if it was encoded relative to the InstNum.
334 ValNo = InstNum - ValNo;
335 return getFnValueByID(ValNo, Ty);
338 /// Like getValue, but decodes signed VBRs.
339 Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
340 unsigned InstNum, Type *Ty) {
341 if (Slot == Record.size()) return nullptr;
342 unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
343 // Adjust the ValNo, if it was encoded relative to the InstNum.
345 ValNo = InstNum - ValNo;
346 return getFnValueByID(ValNo, Ty);
349 /// Converts alignment exponent (i.e. power of two (or zero)) to the
350 /// corresponding alignment to use. If alignment is too large, returns
351 /// a corresponding error code.
352 std::error_code parseAlignmentValue(uint64_t Exponent, unsigned &Alignment);
353 std::error_code parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
354 std::error_code parseModule(bool Resume, bool ShouldLazyLoadMetadata = false);
355 std::error_code parseAttributeBlock();
356 std::error_code parseAttributeGroupBlock();
357 std::error_code parseTypeTable();
358 std::error_code parseTypeTableBody();
360 std::error_code parseValueSymbolTable();
361 std::error_code parseConstants();
362 std::error_code rememberAndSkipFunctionBody();
363 /// Save the positions of the Metadata blocks and skip parsing the blocks.
364 std::error_code rememberAndSkipMetadata();
365 std::error_code parseFunctionBody(Function *F);
366 std::error_code globalCleanup();
367 std::error_code resolveGlobalAndAliasInits();
368 std::error_code parseMetadata();
369 std::error_code parseMetadataAttachment(Function &F);
370 ErrorOr<std::string> parseModuleTriple();
371 std::error_code parseUseLists();
372 std::error_code initStream(std::unique_ptr<DataStreamer> Streamer);
373 std::error_code initStreamFromBuffer();
374 std::error_code initLazyStream(std::unique_ptr<DataStreamer> Streamer);
375 std::error_code findFunctionInStream(
377 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
381 BitcodeDiagnosticInfo::BitcodeDiagnosticInfo(std::error_code EC,
382 DiagnosticSeverity Severity,
384 : DiagnosticInfo(DK_Bitcode, Severity), Msg(Msg), EC(EC) {}
386 void BitcodeDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
388 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
389 std::error_code EC, const Twine &Message) {
390 BitcodeDiagnosticInfo DI(EC, DS_Error, Message);
391 DiagnosticHandler(DI);
395 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
396 std::error_code EC) {
397 return error(DiagnosticHandler, EC, EC.message());
400 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
401 const Twine &Message) {
402 return error(DiagnosticHandler,
403 make_error_code(BitcodeError::CorruptedBitcode), Message);
406 std::error_code BitcodeReader::error(BitcodeError E, const Twine &Message) {
407 return ::error(DiagnosticHandler, make_error_code(E), Message);
410 std::error_code BitcodeReader::error(const Twine &Message) {
411 return ::error(DiagnosticHandler,
412 make_error_code(BitcodeError::CorruptedBitcode), Message);
415 std::error_code BitcodeReader::error(BitcodeError E) {
416 return ::error(DiagnosticHandler, make_error_code(E));
419 static DiagnosticHandlerFunction getDiagHandler(DiagnosticHandlerFunction F,
423 return [&C](const DiagnosticInfo &DI) { C.diagnose(DI); };
426 BitcodeReader::BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context,
427 DiagnosticHandlerFunction DiagnosticHandler)
429 DiagnosticHandler(getDiagHandler(DiagnosticHandler, Context)),
430 Buffer(Buffer), ValueList(Context), MDValueList(Context) {}
432 BitcodeReader::BitcodeReader(LLVMContext &Context,
433 DiagnosticHandlerFunction DiagnosticHandler)
435 DiagnosticHandler(getDiagHandler(DiagnosticHandler, Context)),
436 Buffer(nullptr), ValueList(Context), MDValueList(Context) {}
438 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
439 if (WillMaterializeAllForwardRefs)
440 return std::error_code();
442 // Prevent recursion.
443 WillMaterializeAllForwardRefs = true;
445 while (!BasicBlockFwdRefQueue.empty()) {
446 Function *F = BasicBlockFwdRefQueue.front();
447 BasicBlockFwdRefQueue.pop_front();
448 assert(F && "Expected valid function");
449 if (!BasicBlockFwdRefs.count(F))
450 // Already materialized.
453 // Check for a function that isn't materializable to prevent an infinite
454 // loop. When parsing a blockaddress stored in a global variable, there
455 // isn't a trivial way to check if a function will have a body without a
456 // linear search through FunctionsWithBodies, so just check it here.
457 if (!F->isMaterializable())
458 return error("Never resolved function from blockaddress");
460 // Try to materialize F.
461 if (std::error_code EC = materialize(F))
464 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
467 WillMaterializeAllForwardRefs = false;
468 return std::error_code();
471 void BitcodeReader::freeState() {
473 std::vector<Type*>().swap(TypeList);
476 std::vector<Comdat *>().swap(ComdatList);
478 std::vector<AttributeSet>().swap(MAttributes);
479 std::vector<BasicBlock*>().swap(FunctionBBs);
480 std::vector<Function*>().swap(FunctionsWithBodies);
481 DeferredFunctionInfo.clear();
482 DeferredMetadataInfo.clear();
485 assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
486 BasicBlockFwdRefQueue.clear();
489 //===----------------------------------------------------------------------===//
490 // Helper functions to implement forward reference resolution, etc.
491 //===----------------------------------------------------------------------===//
493 /// Convert a string from a record into an std::string, return true on failure.
494 template <typename StrTy>
495 static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
497 if (Idx > Record.size())
500 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
501 Result += (char)Record[i];
505 static bool hasImplicitComdat(size_t Val) {
509 case 1: // Old WeakAnyLinkage
510 case 4: // Old LinkOnceAnyLinkage
511 case 10: // Old WeakODRLinkage
512 case 11: // Old LinkOnceODRLinkage
517 static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
519 default: // Map unknown/new linkages to external
521 return GlobalValue::ExternalLinkage;
523 return GlobalValue::AppendingLinkage;
525 return GlobalValue::InternalLinkage;
527 return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
529 return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
531 return GlobalValue::ExternalWeakLinkage;
533 return GlobalValue::CommonLinkage;
535 return GlobalValue::PrivateLinkage;
537 return GlobalValue::AvailableExternallyLinkage;
539 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
541 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
543 return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
544 case 1: // Old value with implicit comdat.
546 return GlobalValue::WeakAnyLinkage;
547 case 10: // Old value with implicit comdat.
549 return GlobalValue::WeakODRLinkage;
550 case 4: // Old value with implicit comdat.
552 return GlobalValue::LinkOnceAnyLinkage;
553 case 11: // Old value with implicit comdat.
555 return GlobalValue::LinkOnceODRLinkage;
559 static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {
561 default: // Map unknown visibilities to default.
562 case 0: return GlobalValue::DefaultVisibility;
563 case 1: return GlobalValue::HiddenVisibility;
564 case 2: return GlobalValue::ProtectedVisibility;
568 static GlobalValue::DLLStorageClassTypes
569 getDecodedDLLStorageClass(unsigned Val) {
571 default: // Map unknown values to default.
572 case 0: return GlobalValue::DefaultStorageClass;
573 case 1: return GlobalValue::DLLImportStorageClass;
574 case 2: return GlobalValue::DLLExportStorageClass;
578 static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {
580 case 0: return GlobalVariable::NotThreadLocal;
581 default: // Map unknown non-zero value to general dynamic.
582 case 1: return GlobalVariable::GeneralDynamicTLSModel;
583 case 2: return GlobalVariable::LocalDynamicTLSModel;
584 case 3: return GlobalVariable::InitialExecTLSModel;
585 case 4: return GlobalVariable::LocalExecTLSModel;
589 static int getDecodedCastOpcode(unsigned Val) {
592 case bitc::CAST_TRUNC : return Instruction::Trunc;
593 case bitc::CAST_ZEXT : return Instruction::ZExt;
594 case bitc::CAST_SEXT : return Instruction::SExt;
595 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
596 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
597 case bitc::CAST_UITOFP : return Instruction::UIToFP;
598 case bitc::CAST_SITOFP : return Instruction::SIToFP;
599 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
600 case bitc::CAST_FPEXT : return Instruction::FPExt;
601 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
602 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
603 case bitc::CAST_BITCAST : return Instruction::BitCast;
604 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
608 static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
609 bool IsFP = Ty->isFPOrFPVectorTy();
610 // BinOps are only valid for int/fp or vector of int/fp types
611 if (!IsFP && !Ty->isIntOrIntVectorTy())
617 case bitc::BINOP_ADD:
618 return IsFP ? Instruction::FAdd : Instruction::Add;
619 case bitc::BINOP_SUB:
620 return IsFP ? Instruction::FSub : Instruction::Sub;
621 case bitc::BINOP_MUL:
622 return IsFP ? Instruction::FMul : Instruction::Mul;
623 case bitc::BINOP_UDIV:
624 return IsFP ? -1 : Instruction::UDiv;
625 case bitc::BINOP_SDIV:
626 return IsFP ? Instruction::FDiv : Instruction::SDiv;
627 case bitc::BINOP_UREM:
628 return IsFP ? -1 : Instruction::URem;
629 case bitc::BINOP_SREM:
630 return IsFP ? Instruction::FRem : Instruction::SRem;
631 case bitc::BINOP_SHL:
632 return IsFP ? -1 : Instruction::Shl;
633 case bitc::BINOP_LSHR:
634 return IsFP ? -1 : Instruction::LShr;
635 case bitc::BINOP_ASHR:
636 return IsFP ? -1 : Instruction::AShr;
637 case bitc::BINOP_AND:
638 return IsFP ? -1 : Instruction::And;
640 return IsFP ? -1 : Instruction::Or;
641 case bitc::BINOP_XOR:
642 return IsFP ? -1 : Instruction::Xor;
646 static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {
648 default: return AtomicRMWInst::BAD_BINOP;
649 case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
650 case bitc::RMW_ADD: return AtomicRMWInst::Add;
651 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
652 case bitc::RMW_AND: return AtomicRMWInst::And;
653 case bitc::RMW_NAND: return AtomicRMWInst::Nand;
654 case bitc::RMW_OR: return AtomicRMWInst::Or;
655 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
656 case bitc::RMW_MAX: return AtomicRMWInst::Max;
657 case bitc::RMW_MIN: return AtomicRMWInst::Min;
658 case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
659 case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
663 static AtomicOrdering getDecodedOrdering(unsigned Val) {
665 case bitc::ORDERING_NOTATOMIC: return NotAtomic;
666 case bitc::ORDERING_UNORDERED: return Unordered;
667 case bitc::ORDERING_MONOTONIC: return Monotonic;
668 case bitc::ORDERING_ACQUIRE: return Acquire;
669 case bitc::ORDERING_RELEASE: return Release;
670 case bitc::ORDERING_ACQREL: return AcquireRelease;
671 default: // Map unknown orderings to sequentially-consistent.
672 case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
676 static SynchronizationScope getDecodedSynchScope(unsigned Val) {
678 case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
679 default: // Map unknown scopes to cross-thread.
680 case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
684 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
686 default: // Map unknown selection kinds to any.
687 case bitc::COMDAT_SELECTION_KIND_ANY:
689 case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
690 return Comdat::ExactMatch;
691 case bitc::COMDAT_SELECTION_KIND_LARGEST:
692 return Comdat::Largest;
693 case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
694 return Comdat::NoDuplicates;
695 case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
696 return Comdat::SameSize;
700 static FastMathFlags getDecodedFastMathFlags(unsigned Val) {
702 if (0 != (Val & FastMathFlags::UnsafeAlgebra))
703 FMF.setUnsafeAlgebra();
704 if (0 != (Val & FastMathFlags::NoNaNs))
706 if (0 != (Val & FastMathFlags::NoInfs))
708 if (0 != (Val & FastMathFlags::NoSignedZeros))
709 FMF.setNoSignedZeros();
710 if (0 != (Val & FastMathFlags::AllowReciprocal))
711 FMF.setAllowReciprocal();
715 static void upgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
717 case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
718 case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
724 /// \brief A class for maintaining the slot number definition
725 /// as a placeholder for the actual definition for forward constants defs.
726 class ConstantPlaceHolder : public ConstantExpr {
727 void operator=(const ConstantPlaceHolder &) = delete;
730 // allocate space for exactly one operand
731 void *operator new(size_t s) { return User::operator new(s, 1); }
732 explicit ConstantPlaceHolder(Type *Ty, LLVMContext &Context)
733 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
734 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
737 /// \brief Methods to support type inquiry through isa, cast, and dyn_cast.
738 static bool classof(const Value *V) {
739 return isa<ConstantExpr>(V) &&
740 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
743 /// Provide fast operand accessors
744 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
748 // FIXME: can we inherit this from ConstantExpr?
750 struct OperandTraits<ConstantPlaceHolder> :
751 public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
753 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantPlaceHolder, Value)
756 void BitcodeReaderValueList::assignValue(Value *V, unsigned Idx) {
765 WeakVH &OldV = ValuePtrs[Idx];
771 // Handle constants and non-constants (e.g. instrs) differently for
773 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
774 ResolveConstants.push_back(std::make_pair(PHC, Idx));
777 // If there was a forward reference to this value, replace it.
778 Value *PrevVal = OldV;
779 OldV->replaceAllUsesWith(V);
785 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
790 if (Value *V = ValuePtrs[Idx]) {
791 if (Ty != V->getType())
792 report_fatal_error("Type mismatch in constant table!");
793 return cast<Constant>(V);
796 // Create and return a placeholder, which will later be RAUW'd.
797 Constant *C = new ConstantPlaceHolder(Ty, Context);
802 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty) {
803 // Bail out for a clearly invalid value. This would make us call resize(0)
810 if (Value *V = ValuePtrs[Idx]) {
811 // If the types don't match, it's invalid.
812 if (Ty && Ty != V->getType())
817 // No type specified, must be invalid reference.
818 if (!Ty) return nullptr;
820 // Create and return a placeholder, which will later be RAUW'd.
821 Value *V = new Argument(Ty);
826 /// Once all constants are read, this method bulk resolves any forward
827 /// references. The idea behind this is that we sometimes get constants (such
828 /// as large arrays) which reference *many* forward ref constants. Replacing
829 /// each of these causes a lot of thrashing when building/reuniquing the
830 /// constant. Instead of doing this, we look at all the uses and rewrite all
831 /// the place holders at once for any constant that uses a placeholder.
832 void BitcodeReaderValueList::resolveConstantForwardRefs() {
833 // Sort the values by-pointer so that they are efficient to look up with a
835 std::sort(ResolveConstants.begin(), ResolveConstants.end());
837 SmallVector<Constant*, 64> NewOps;
839 while (!ResolveConstants.empty()) {
840 Value *RealVal = operator[](ResolveConstants.back().second);
841 Constant *Placeholder = ResolveConstants.back().first;
842 ResolveConstants.pop_back();
844 // Loop over all users of the placeholder, updating them to reference the
845 // new value. If they reference more than one placeholder, update them all
847 while (!Placeholder->use_empty()) {
848 auto UI = Placeholder->user_begin();
851 // If the using object isn't uniqued, just update the operands. This
852 // handles instructions and initializers for global variables.
853 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
854 UI.getUse().set(RealVal);
858 // Otherwise, we have a constant that uses the placeholder. Replace that
859 // constant with a new constant that has *all* placeholder uses updated.
860 Constant *UserC = cast<Constant>(U);
861 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
864 if (!isa<ConstantPlaceHolder>(*I)) {
865 // Not a placeholder reference.
867 } else if (*I == Placeholder) {
868 // Common case is that it just references this one placeholder.
871 // Otherwise, look up the placeholder in ResolveConstants.
872 ResolveConstantsTy::iterator It =
873 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
874 std::pair<Constant*, unsigned>(cast<Constant>(*I),
876 assert(It != ResolveConstants.end() && It->first == *I);
877 NewOp = operator[](It->second);
880 NewOps.push_back(cast<Constant>(NewOp));
883 // Make the new constant.
885 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
886 NewC = ConstantArray::get(UserCA->getType(), NewOps);
887 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
888 NewC = ConstantStruct::get(UserCS->getType(), NewOps);
889 } else if (isa<ConstantVector>(UserC)) {
890 NewC = ConstantVector::get(NewOps);
892 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
893 NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
896 UserC->replaceAllUsesWith(NewC);
897 UserC->destroyConstant();
901 // Update all ValueHandles, they should be the only users at this point.
902 Placeholder->replaceAllUsesWith(RealVal);
907 void BitcodeReaderMDValueList::assignValue(Metadata *MD, unsigned Idx) {
916 TrackingMDRef &OldMD = MDValuePtrs[Idx];
922 // If there was a forward reference to this value, replace it.
923 TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
924 PrevMD->replaceAllUsesWith(MD);
928 Metadata *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
932 if (Metadata *MD = MDValuePtrs[Idx])
935 // Track forward refs to be resolved later.
937 MinFwdRef = std::min(MinFwdRef, Idx);
938 MaxFwdRef = std::max(MaxFwdRef, Idx);
941 MinFwdRef = MaxFwdRef = Idx;
945 // Create and return a placeholder, which will later be RAUW'd.
946 Metadata *MD = MDNode::getTemporary(Context, None).release();
947 MDValuePtrs[Idx].reset(MD);
951 void BitcodeReaderMDValueList::tryToResolveCycles() {
957 // Still forward references... can't resolve cycles.
960 // Resolve any cycles.
961 for (unsigned I = MinFwdRef, E = MaxFwdRef + 1; I != E; ++I) {
962 auto &MD = MDValuePtrs[I];
963 auto *N = dyn_cast_or_null<MDNode>(MD);
967 assert(!N->isTemporary() && "Unexpected forward reference");
971 // Make sure we return early again until there's another forward ref.
975 Type *BitcodeReader::getTypeByID(unsigned ID) {
976 // The type table size is always specified correctly.
977 if (ID >= TypeList.size())
980 if (Type *Ty = TypeList[ID])
983 // If we have a forward reference, the only possible case is when it is to a
984 // named struct. Just create a placeholder for now.
985 return TypeList[ID] = createIdentifiedStructType(Context);
988 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
990 auto *Ret = StructType::create(Context, Name);
991 IdentifiedStructTypes.push_back(Ret);
995 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
996 auto *Ret = StructType::create(Context);
997 IdentifiedStructTypes.push_back(Ret);
1002 //===----------------------------------------------------------------------===//
1003 // Functions for parsing blocks from the bitcode file
1004 //===----------------------------------------------------------------------===//
1007 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
1008 /// been decoded from the given integer. This function must stay in sync with
1009 /// 'encodeLLVMAttributesForBitcode'.
1010 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1011 uint64_t EncodedAttrs) {
1012 // FIXME: Remove in 4.0.
1014 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
1015 // the bits above 31 down by 11 bits.
1016 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1017 assert((!Alignment || isPowerOf2_32(Alignment)) &&
1018 "Alignment must be a power of two.");
1021 B.addAlignmentAttr(Alignment);
1022 B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1023 (EncodedAttrs & 0xffff));
1026 std::error_code BitcodeReader::parseAttributeBlock() {
1027 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
1028 return error("Invalid record");
1030 if (!MAttributes.empty())
1031 return error("Invalid multiple blocks");
1033 SmallVector<uint64_t, 64> Record;
1035 SmallVector<AttributeSet, 8> Attrs;
1037 // Read all the records.
1039 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1041 switch (Entry.Kind) {
1042 case BitstreamEntry::SubBlock: // Handled for us already.
1043 case BitstreamEntry::Error:
1044 return error("Malformed block");
1045 case BitstreamEntry::EndBlock:
1046 return std::error_code();
1047 case BitstreamEntry::Record:
1048 // The interesting case.
1054 switch (Stream.readRecord(Entry.ID, Record)) {
1055 default: // Default behavior: ignore.
1057 case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
1058 // FIXME: Remove in 4.0.
1059 if (Record.size() & 1)
1060 return error("Invalid record");
1062 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1064 decodeLLVMAttributesForBitcode(B, Record[i+1]);
1065 Attrs.push_back(AttributeSet::get(Context, Record[i], B));
1068 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1072 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
1073 for (unsigned i = 0, e = Record.size(); i != e; ++i)
1074 Attrs.push_back(MAttributeGroups[Record[i]]);
1076 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1084 // Returns Attribute::None on unrecognized codes.
1085 static Attribute::AttrKind getAttrFromCode(uint64_t Code) {
1088 return Attribute::None;
1089 case bitc::ATTR_KIND_ALIGNMENT:
1090 return Attribute::Alignment;
1091 case bitc::ATTR_KIND_ALWAYS_INLINE:
1092 return Attribute::AlwaysInline;
1093 case bitc::ATTR_KIND_ARGMEMONLY:
1094 return Attribute::ArgMemOnly;
1095 case bitc::ATTR_KIND_BUILTIN:
1096 return Attribute::Builtin;
1097 case bitc::ATTR_KIND_BY_VAL:
1098 return Attribute::ByVal;
1099 case bitc::ATTR_KIND_IN_ALLOCA:
1100 return Attribute::InAlloca;
1101 case bitc::ATTR_KIND_COLD:
1102 return Attribute::Cold;
1103 case bitc::ATTR_KIND_CONVERGENT:
1104 return Attribute::Convergent;
1105 case bitc::ATTR_KIND_INLINE_HINT:
1106 return Attribute::InlineHint;
1107 case bitc::ATTR_KIND_IN_REG:
1108 return Attribute::InReg;
1109 case bitc::ATTR_KIND_JUMP_TABLE:
1110 return Attribute::JumpTable;
1111 case bitc::ATTR_KIND_MIN_SIZE:
1112 return Attribute::MinSize;
1113 case bitc::ATTR_KIND_NAKED:
1114 return Attribute::Naked;
1115 case bitc::ATTR_KIND_NEST:
1116 return Attribute::Nest;
1117 case bitc::ATTR_KIND_NO_ALIAS:
1118 return Attribute::NoAlias;
1119 case bitc::ATTR_KIND_NO_BUILTIN:
1120 return Attribute::NoBuiltin;
1121 case bitc::ATTR_KIND_NO_CAPTURE:
1122 return Attribute::NoCapture;
1123 case bitc::ATTR_KIND_NO_DUPLICATE:
1124 return Attribute::NoDuplicate;
1125 case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1126 return Attribute::NoImplicitFloat;
1127 case bitc::ATTR_KIND_NO_INLINE:
1128 return Attribute::NoInline;
1129 case bitc::ATTR_KIND_NON_LAZY_BIND:
1130 return Attribute::NonLazyBind;
1131 case bitc::ATTR_KIND_NON_NULL:
1132 return Attribute::NonNull;
1133 case bitc::ATTR_KIND_DEREFERENCEABLE:
1134 return Attribute::Dereferenceable;
1135 case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:
1136 return Attribute::DereferenceableOrNull;
1137 case bitc::ATTR_KIND_NO_RED_ZONE:
1138 return Attribute::NoRedZone;
1139 case bitc::ATTR_KIND_NO_RETURN:
1140 return Attribute::NoReturn;
1141 case bitc::ATTR_KIND_NO_UNWIND:
1142 return Attribute::NoUnwind;
1143 case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1144 return Attribute::OptimizeForSize;
1145 case bitc::ATTR_KIND_OPTIMIZE_NONE:
1146 return Attribute::OptimizeNone;
1147 case bitc::ATTR_KIND_READ_NONE:
1148 return Attribute::ReadNone;
1149 case bitc::ATTR_KIND_READ_ONLY:
1150 return Attribute::ReadOnly;
1151 case bitc::ATTR_KIND_RETURNED:
1152 return Attribute::Returned;
1153 case bitc::ATTR_KIND_RETURNS_TWICE:
1154 return Attribute::ReturnsTwice;
1155 case bitc::ATTR_KIND_S_EXT:
1156 return Attribute::SExt;
1157 case bitc::ATTR_KIND_STACK_ALIGNMENT:
1158 return Attribute::StackAlignment;
1159 case bitc::ATTR_KIND_STACK_PROTECT:
1160 return Attribute::StackProtect;
1161 case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1162 return Attribute::StackProtectReq;
1163 case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1164 return Attribute::StackProtectStrong;
1165 case bitc::ATTR_KIND_SAFESTACK:
1166 return Attribute::SafeStack;
1167 case bitc::ATTR_KIND_STRUCT_RET:
1168 return Attribute::StructRet;
1169 case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1170 return Attribute::SanitizeAddress;
1171 case bitc::ATTR_KIND_SANITIZE_THREAD:
1172 return Attribute::SanitizeThread;
1173 case bitc::ATTR_KIND_SANITIZE_MEMORY:
1174 return Attribute::SanitizeMemory;
1175 case bitc::ATTR_KIND_UW_TABLE:
1176 return Attribute::UWTable;
1177 case bitc::ATTR_KIND_Z_EXT:
1178 return Attribute::ZExt;
1182 std::error_code BitcodeReader::parseAlignmentValue(uint64_t Exponent,
1183 unsigned &Alignment) {
1184 // Note: Alignment in bitcode files is incremented by 1, so that zero
1185 // can be used for default alignment.
1186 if (Exponent > Value::MaxAlignmentExponent + 1)
1187 return error("Invalid alignment value");
1188 Alignment = (1 << static_cast<unsigned>(Exponent)) >> 1;
1189 return std::error_code();
1192 std::error_code BitcodeReader::parseAttrKind(uint64_t Code,
1193 Attribute::AttrKind *Kind) {
1194 *Kind = getAttrFromCode(Code);
1195 if (*Kind == Attribute::None)
1196 return error(BitcodeError::CorruptedBitcode,
1197 "Unknown attribute kind (" + Twine(Code) + ")");
1198 return std::error_code();
1201 std::error_code BitcodeReader::parseAttributeGroupBlock() {
1202 if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
1203 return error("Invalid record");
1205 if (!MAttributeGroups.empty())
1206 return error("Invalid multiple blocks");
1208 SmallVector<uint64_t, 64> Record;
1210 // Read all the records.
1212 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1214 switch (Entry.Kind) {
1215 case BitstreamEntry::SubBlock: // Handled for us already.
1216 case BitstreamEntry::Error:
1217 return error("Malformed block");
1218 case BitstreamEntry::EndBlock:
1219 return std::error_code();
1220 case BitstreamEntry::Record:
1221 // The interesting case.
1227 switch (Stream.readRecord(Entry.ID, Record)) {
1228 default: // Default behavior: ignore.
1230 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1231 if (Record.size() < 3)
1232 return error("Invalid record");
1234 uint64_t GrpID = Record[0];
1235 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1238 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1239 if (Record[i] == 0) { // Enum attribute
1240 Attribute::AttrKind Kind;
1241 if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1244 B.addAttribute(Kind);
1245 } else if (Record[i] == 1) { // Integer attribute
1246 Attribute::AttrKind Kind;
1247 if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1249 if (Kind == Attribute::Alignment)
1250 B.addAlignmentAttr(Record[++i]);
1251 else if (Kind == Attribute::StackAlignment)
1252 B.addStackAlignmentAttr(Record[++i]);
1253 else if (Kind == Attribute::Dereferenceable)
1254 B.addDereferenceableAttr(Record[++i]);
1255 else if (Kind == Attribute::DereferenceableOrNull)
1256 B.addDereferenceableOrNullAttr(Record[++i]);
1257 } else { // String attribute
1258 assert((Record[i] == 3 || Record[i] == 4) &&
1259 "Invalid attribute group entry");
1260 bool HasValue = (Record[i++] == 4);
1261 SmallString<64> KindStr;
1262 SmallString<64> ValStr;
1264 while (Record[i] != 0 && i != e)
1265 KindStr += Record[i++];
1266 assert(Record[i] == 0 && "Kind string not null terminated");
1269 // Has a value associated with it.
1270 ++i; // Skip the '0' that terminates the "kind" string.
1271 while (Record[i] != 0 && i != e)
1272 ValStr += Record[i++];
1273 assert(Record[i] == 0 && "Value string not null terminated");
1276 B.addAttribute(KindStr.str(), ValStr.str());
1280 MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
1287 std::error_code BitcodeReader::parseTypeTable() {
1288 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
1289 return error("Invalid record");
1291 return parseTypeTableBody();
1294 std::error_code BitcodeReader::parseTypeTableBody() {
1295 if (!TypeList.empty())
1296 return error("Invalid multiple blocks");
1298 SmallVector<uint64_t, 64> Record;
1299 unsigned NumRecords = 0;
1301 SmallString<64> TypeName;
1303 // Read all the records for this type table.
1305 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1307 switch (Entry.Kind) {
1308 case BitstreamEntry::SubBlock: // Handled for us already.
1309 case BitstreamEntry::Error:
1310 return error("Malformed block");
1311 case BitstreamEntry::EndBlock:
1312 if (NumRecords != TypeList.size())
1313 return error("Malformed block");
1314 return std::error_code();
1315 case BitstreamEntry::Record:
1316 // The interesting case.
1322 Type *ResultTy = nullptr;
1323 switch (Stream.readRecord(Entry.ID, Record)) {
1325 return error("Invalid value");
1326 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1327 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1328 // type list. This allows us to reserve space.
1329 if (Record.size() < 1)
1330 return error("Invalid record");
1331 TypeList.resize(Record[0]);
1333 case bitc::TYPE_CODE_VOID: // VOID
1334 ResultTy = Type::getVoidTy(Context);
1336 case bitc::TYPE_CODE_HALF: // HALF
1337 ResultTy = Type::getHalfTy(Context);
1339 case bitc::TYPE_CODE_FLOAT: // FLOAT
1340 ResultTy = Type::getFloatTy(Context);
1342 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
1343 ResultTy = Type::getDoubleTy(Context);
1345 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
1346 ResultTy = Type::getX86_FP80Ty(Context);
1348 case bitc::TYPE_CODE_FP128: // FP128
1349 ResultTy = Type::getFP128Ty(Context);
1351 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
1352 ResultTy = Type::getPPC_FP128Ty(Context);
1354 case bitc::TYPE_CODE_LABEL: // LABEL
1355 ResultTy = Type::getLabelTy(Context);
1357 case bitc::TYPE_CODE_METADATA: // METADATA
1358 ResultTy = Type::getMetadataTy(Context);
1360 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
1361 ResultTy = Type::getX86_MMXTy(Context);
1363 case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
1364 if (Record.size() < 1)
1365 return error("Invalid record");
1367 uint64_t NumBits = Record[0];
1368 if (NumBits < IntegerType::MIN_INT_BITS ||
1369 NumBits > IntegerType::MAX_INT_BITS)
1370 return error("Bitwidth for integer type out of range");
1371 ResultTy = IntegerType::get(Context, NumBits);
1374 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
1375 // [pointee type, address space]
1376 if (Record.size() < 1)
1377 return error("Invalid record");
1378 unsigned AddressSpace = 0;
1379 if (Record.size() == 2)
1380 AddressSpace = Record[1];
1381 ResultTy = getTypeByID(Record[0]);
1383 !PointerType::isValidElementType(ResultTy))
1384 return error("Invalid type");
1385 ResultTy = PointerType::get(ResultTy, AddressSpace);
1388 case bitc::TYPE_CODE_FUNCTION_OLD: {
1389 // FIXME: attrid is dead, remove it in LLVM 4.0
1390 // FUNCTION: [vararg, attrid, retty, paramty x N]
1391 if (Record.size() < 3)
1392 return error("Invalid record");
1393 SmallVector<Type*, 8> ArgTys;
1394 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1395 if (Type *T = getTypeByID(Record[i]))
1396 ArgTys.push_back(T);
1401 ResultTy = getTypeByID(Record[2]);
1402 if (!ResultTy || ArgTys.size() < Record.size()-3)
1403 return error("Invalid type");
1405 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1408 case bitc::TYPE_CODE_FUNCTION: {
1409 // FUNCTION: [vararg, retty, paramty x N]
1410 if (Record.size() < 2)
1411 return error("Invalid record");
1412 SmallVector<Type*, 8> ArgTys;
1413 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1414 if (Type *T = getTypeByID(Record[i])) {
1415 if (!FunctionType::isValidArgumentType(T))
1416 return error("Invalid function argument type");
1417 ArgTys.push_back(T);
1423 ResultTy = getTypeByID(Record[1]);
1424 if (!ResultTy || ArgTys.size() < Record.size()-2)
1425 return error("Invalid type");
1427 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1430 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
1431 if (Record.size() < 1)
1432 return error("Invalid record");
1433 SmallVector<Type*, 8> EltTys;
1434 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1435 if (Type *T = getTypeByID(Record[i]))
1436 EltTys.push_back(T);
1440 if (EltTys.size() != Record.size()-1)
1441 return error("Invalid type");
1442 ResultTy = StructType::get(Context, EltTys, Record[0]);
1445 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
1446 if (convertToString(Record, 0, TypeName))
1447 return error("Invalid record");
1450 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1451 if (Record.size() < 1)
1452 return error("Invalid record");
1454 if (NumRecords >= TypeList.size())
1455 return error("Invalid TYPE table");
1457 // Check to see if this was forward referenced, if so fill in the temp.
1458 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1460 Res->setName(TypeName);
1461 TypeList[NumRecords] = nullptr;
1462 } else // Otherwise, create a new struct.
1463 Res = createIdentifiedStructType(Context, TypeName);
1466 SmallVector<Type*, 8> EltTys;
1467 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1468 if (Type *T = getTypeByID(Record[i]))
1469 EltTys.push_back(T);
1473 if (EltTys.size() != Record.size()-1)
1474 return error("Invalid record");
1475 Res->setBody(EltTys, Record[0]);
1479 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
1480 if (Record.size() != 1)
1481 return error("Invalid record");
1483 if (NumRecords >= TypeList.size())
1484 return error("Invalid TYPE table");
1486 // Check to see if this was forward referenced, if so fill in the temp.
1487 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1489 Res->setName(TypeName);
1490 TypeList[NumRecords] = nullptr;
1491 } else // Otherwise, create a new struct with no body.
1492 Res = createIdentifiedStructType(Context, TypeName);
1497 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
1498 if (Record.size() < 2)
1499 return error("Invalid record");
1500 ResultTy = getTypeByID(Record[1]);
1501 if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
1502 return error("Invalid type");
1503 ResultTy = ArrayType::get(ResultTy, Record[0]);
1505 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
1506 if (Record.size() < 2)
1507 return error("Invalid record");
1509 return error("Invalid vector length");
1510 ResultTy = getTypeByID(Record[1]);
1511 if (!ResultTy || !StructType::isValidElementType(ResultTy))
1512 return error("Invalid type");
1513 ResultTy = VectorType::get(ResultTy, Record[0]);
1517 if (NumRecords >= TypeList.size())
1518 return error("Invalid TYPE table");
1519 if (TypeList[NumRecords])
1521 "Invalid TYPE table: Only named structs can be forward referenced");
1522 assert(ResultTy && "Didn't read a type?");
1523 TypeList[NumRecords++] = ResultTy;
1527 std::error_code BitcodeReader::parseValueSymbolTable() {
1528 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1529 return error("Invalid record");
1531 SmallVector<uint64_t, 64> Record;
1533 Triple TT(TheModule->getTargetTriple());
1535 // Read all the records for this value table.
1536 SmallString<128> ValueName;
1538 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1540 switch (Entry.Kind) {
1541 case BitstreamEntry::SubBlock: // Handled for us already.
1542 case BitstreamEntry::Error:
1543 return error("Malformed block");
1544 case BitstreamEntry::EndBlock:
1545 return std::error_code();
1546 case BitstreamEntry::Record:
1547 // The interesting case.
1553 switch (Stream.readRecord(Entry.ID, Record)) {
1554 default: // Default behavior: unknown type.
1556 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
1557 if (convertToString(Record, 1, ValueName))
1558 return error("Invalid record");
1559 unsigned ValueID = Record[0];
1560 if (ValueID >= ValueList.size() || !ValueList[ValueID])
1561 return error("Invalid record");
1562 Value *V = ValueList[ValueID];
1564 V->setName(StringRef(ValueName.data(), ValueName.size()));
1565 if (auto *GO = dyn_cast<GlobalObject>(V)) {
1566 if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1567 if (TT.isOSBinFormatMachO())
1568 GO->setComdat(nullptr);
1570 GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1576 case bitc::VST_CODE_BBENTRY: {
1577 if (convertToString(Record, 1, ValueName))
1578 return error("Invalid record");
1579 BasicBlock *BB = getBasicBlock(Record[0]);
1581 return error("Invalid record");
1583 BB->setName(StringRef(ValueName.data(), ValueName.size()));
1591 static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
1593 std::error_code BitcodeReader::parseMetadata() {
1594 IsMetadataMaterialized = true;
1595 unsigned NextMDValueNo = MDValueList.size();
1597 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1598 return error("Invalid record");
1600 SmallVector<uint64_t, 64> Record;
1603 [&](unsigned ID) -> Metadata *{ return MDValueList.getValueFwdRef(ID); };
1604 auto getMDOrNull = [&](unsigned ID) -> Metadata *{
1606 return getMD(ID - 1);
1609 auto getMDString = [&](unsigned ID) -> MDString *{
1610 // This requires that the ID is not really a forward reference. In
1611 // particular, the MDString must already have been resolved.
1612 return cast_or_null<MDString>(getMDOrNull(ID));
1615 #define GET_OR_DISTINCT(CLASS, DISTINCT, ARGS) \
1616 (DISTINCT ? CLASS::getDistinct ARGS : CLASS::get ARGS)
1618 // Read all the records.
1620 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1622 switch (Entry.Kind) {
1623 case BitstreamEntry::SubBlock: // Handled for us already.
1624 case BitstreamEntry::Error:
1625 return error("Malformed block");
1626 case BitstreamEntry::EndBlock:
1627 MDValueList.tryToResolveCycles();
1628 return std::error_code();
1629 case BitstreamEntry::Record:
1630 // The interesting case.
1636 unsigned Code = Stream.readRecord(Entry.ID, Record);
1637 bool IsDistinct = false;
1639 default: // Default behavior: ignore.
1641 case bitc::METADATA_NAME: {
1642 // Read name of the named metadata.
1643 SmallString<8> Name(Record.begin(), Record.end());
1645 Code = Stream.ReadCode();
1647 unsigned NextBitCode = Stream.readRecord(Code, Record);
1648 if (NextBitCode != bitc::METADATA_NAMED_NODE)
1649 return error("METADATA_NAME not followed by METADATA_NAMED_NODE");
1651 // Read named metadata elements.
1652 unsigned Size = Record.size();
1653 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1654 for (unsigned i = 0; i != Size; ++i) {
1655 MDNode *MD = dyn_cast_or_null<MDNode>(MDValueList.getValueFwdRef(Record[i]));
1657 return error("Invalid record");
1658 NMD->addOperand(MD);
1662 case bitc::METADATA_OLD_FN_NODE: {
1663 // FIXME: Remove in 4.0.
1664 // This is a LocalAsMetadata record, the only type of function-local
1666 if (Record.size() % 2 == 1)
1667 return error("Invalid record");
1669 // If this isn't a LocalAsMetadata record, we're dropping it. This used
1670 // to be legal, but there's no upgrade path.
1671 auto dropRecord = [&] {
1672 MDValueList.assignValue(MDNode::get(Context, None), NextMDValueNo++);
1674 if (Record.size() != 2) {
1679 Type *Ty = getTypeByID(Record[0]);
1680 if (Ty->isMetadataTy() || Ty->isVoidTy()) {
1685 MDValueList.assignValue(
1686 LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1690 case bitc::METADATA_OLD_NODE: {
1691 // FIXME: Remove in 4.0.
1692 if (Record.size() % 2 == 1)
1693 return error("Invalid record");
1695 unsigned Size = Record.size();
1696 SmallVector<Metadata *, 8> Elts;
1697 for (unsigned i = 0; i != Size; i += 2) {
1698 Type *Ty = getTypeByID(Record[i]);
1700 return error("Invalid record");
1701 if (Ty->isMetadataTy())
1702 Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
1703 else if (!Ty->isVoidTy()) {
1705 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
1706 assert(isa<ConstantAsMetadata>(MD) &&
1707 "Expected non-function-local metadata");
1710 Elts.push_back(nullptr);
1712 MDValueList.assignValue(MDNode::get(Context, Elts), NextMDValueNo++);
1715 case bitc::METADATA_VALUE: {
1716 if (Record.size() != 2)
1717 return error("Invalid record");
1719 Type *Ty = getTypeByID(Record[0]);
1720 if (Ty->isMetadataTy() || Ty->isVoidTy())
1721 return error("Invalid record");
1723 MDValueList.assignValue(
1724 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1728 case bitc::METADATA_DISTINCT_NODE:
1731 case bitc::METADATA_NODE: {
1732 SmallVector<Metadata *, 8> Elts;
1733 Elts.reserve(Record.size());
1734 for (unsigned ID : Record)
1735 Elts.push_back(ID ? MDValueList.getValueFwdRef(ID - 1) : nullptr);
1736 MDValueList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
1737 : MDNode::get(Context, Elts),
1741 case bitc::METADATA_LOCATION: {
1742 if (Record.size() != 5)
1743 return error("Invalid record");
1745 unsigned Line = Record[1];
1746 unsigned Column = Record[2];
1747 MDNode *Scope = cast<MDNode>(MDValueList.getValueFwdRef(Record[3]));
1748 Metadata *InlinedAt =
1749 Record[4] ? MDValueList.getValueFwdRef(Record[4] - 1) : nullptr;
1750 MDValueList.assignValue(
1751 GET_OR_DISTINCT(DILocation, Record[0],
1752 (Context, Line, Column, Scope, InlinedAt)),
1756 case bitc::METADATA_GENERIC_DEBUG: {
1757 if (Record.size() < 4)
1758 return error("Invalid record");
1760 unsigned Tag = Record[1];
1761 unsigned Version = Record[2];
1763 if (Tag >= 1u << 16 || Version != 0)
1764 return error("Invalid record");
1766 auto *Header = getMDString(Record[3]);
1767 SmallVector<Metadata *, 8> DwarfOps;
1768 for (unsigned I = 4, E = Record.size(); I != E; ++I)
1769 DwarfOps.push_back(Record[I] ? MDValueList.getValueFwdRef(Record[I] - 1)
1771 MDValueList.assignValue(GET_OR_DISTINCT(GenericDINode, Record[0],
1772 (Context, Tag, Header, DwarfOps)),
1776 case bitc::METADATA_SUBRANGE: {
1777 if (Record.size() != 3)
1778 return error("Invalid record");
1780 MDValueList.assignValue(
1781 GET_OR_DISTINCT(DISubrange, Record[0],
1782 (Context, Record[1], unrotateSign(Record[2]))),
1786 case bitc::METADATA_ENUMERATOR: {
1787 if (Record.size() != 3)
1788 return error("Invalid record");
1790 MDValueList.assignValue(GET_OR_DISTINCT(DIEnumerator, Record[0],
1791 (Context, unrotateSign(Record[1]),
1792 getMDString(Record[2]))),
1796 case bitc::METADATA_BASIC_TYPE: {
1797 if (Record.size() != 6)
1798 return error("Invalid record");
1800 MDValueList.assignValue(
1801 GET_OR_DISTINCT(DIBasicType, Record[0],
1802 (Context, Record[1], getMDString(Record[2]),
1803 Record[3], Record[4], Record[5])),
1807 case bitc::METADATA_DERIVED_TYPE: {
1808 if (Record.size() != 12)
1809 return error("Invalid record");
1811 MDValueList.assignValue(
1812 GET_OR_DISTINCT(DIDerivedType, Record[0],
1813 (Context, Record[1], getMDString(Record[2]),
1814 getMDOrNull(Record[3]), Record[4],
1815 getMDOrNull(Record[5]), getMDOrNull(Record[6]),
1816 Record[7], Record[8], Record[9], Record[10],
1817 getMDOrNull(Record[11]))),
1821 case bitc::METADATA_COMPOSITE_TYPE: {
1822 if (Record.size() != 16)
1823 return error("Invalid record");
1825 MDValueList.assignValue(
1826 GET_OR_DISTINCT(DICompositeType, Record[0],
1827 (Context, Record[1], getMDString(Record[2]),
1828 getMDOrNull(Record[3]), Record[4],
1829 getMDOrNull(Record[5]), getMDOrNull(Record[6]),
1830 Record[7], Record[8], Record[9], Record[10],
1831 getMDOrNull(Record[11]), Record[12],
1832 getMDOrNull(Record[13]), getMDOrNull(Record[14]),
1833 getMDString(Record[15]))),
1837 case bitc::METADATA_SUBROUTINE_TYPE: {
1838 if (Record.size() != 3)
1839 return error("Invalid record");
1841 MDValueList.assignValue(
1842 GET_OR_DISTINCT(DISubroutineType, Record[0],
1843 (Context, Record[1], getMDOrNull(Record[2]))),
1848 case bitc::METADATA_MODULE: {
1849 if (Record.size() != 6)
1850 return error("Invalid record");
1852 MDValueList.assignValue(
1853 GET_OR_DISTINCT(DIModule, Record[0],
1854 (Context, getMDOrNull(Record[1]),
1855 getMDString(Record[2]), getMDString(Record[3]),
1856 getMDString(Record[4]), getMDString(Record[5]))),
1861 case bitc::METADATA_FILE: {
1862 if (Record.size() != 3)
1863 return error("Invalid record");
1865 MDValueList.assignValue(
1866 GET_OR_DISTINCT(DIFile, Record[0], (Context, getMDString(Record[1]),
1867 getMDString(Record[2]))),
1871 case bitc::METADATA_COMPILE_UNIT: {
1872 if (Record.size() < 14 || Record.size() > 15)
1873 return error("Invalid record");
1875 MDValueList.assignValue(
1877 DICompileUnit, Record[0],
1878 (Context, Record[1], getMDOrNull(Record[2]),
1879 getMDString(Record[3]), Record[4], getMDString(Record[5]),
1880 Record[6], getMDString(Record[7]), Record[8],
1881 getMDOrNull(Record[9]), getMDOrNull(Record[10]),
1882 getMDOrNull(Record[11]), getMDOrNull(Record[12]),
1883 getMDOrNull(Record[13]), Record.size() == 14 ? 0 : Record[14])),
1887 case bitc::METADATA_SUBPROGRAM: {
1888 if (Record.size() != 19)
1889 return error("Invalid record");
1891 MDValueList.assignValue(
1893 DISubprogram, Record[0],
1894 (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
1895 getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
1896 getMDOrNull(Record[6]), Record[7], Record[8], Record[9],
1897 getMDOrNull(Record[10]), Record[11], Record[12], Record[13],
1898 Record[14], getMDOrNull(Record[15]), getMDOrNull(Record[16]),
1899 getMDOrNull(Record[17]), getMDOrNull(Record[18]))),
1903 case bitc::METADATA_LEXICAL_BLOCK: {
1904 if (Record.size() != 5)
1905 return error("Invalid record");
1907 MDValueList.assignValue(
1908 GET_OR_DISTINCT(DILexicalBlock, Record[0],
1909 (Context, getMDOrNull(Record[1]),
1910 getMDOrNull(Record[2]), Record[3], Record[4])),
1914 case bitc::METADATA_LEXICAL_BLOCK_FILE: {
1915 if (Record.size() != 4)
1916 return error("Invalid record");
1918 MDValueList.assignValue(
1919 GET_OR_DISTINCT(DILexicalBlockFile, Record[0],
1920 (Context, getMDOrNull(Record[1]),
1921 getMDOrNull(Record[2]), Record[3])),
1925 case bitc::METADATA_NAMESPACE: {
1926 if (Record.size() != 5)
1927 return error("Invalid record");
1929 MDValueList.assignValue(
1930 GET_OR_DISTINCT(DINamespace, Record[0],
1931 (Context, getMDOrNull(Record[1]),
1932 getMDOrNull(Record[2]), getMDString(Record[3]),
1937 case bitc::METADATA_TEMPLATE_TYPE: {
1938 if (Record.size() != 3)
1939 return error("Invalid record");
1941 MDValueList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter,
1943 (Context, getMDString(Record[1]),
1944 getMDOrNull(Record[2]))),
1948 case bitc::METADATA_TEMPLATE_VALUE: {
1949 if (Record.size() != 5)
1950 return error("Invalid record");
1952 MDValueList.assignValue(
1953 GET_OR_DISTINCT(DITemplateValueParameter, Record[0],
1954 (Context, Record[1], getMDString(Record[2]),
1955 getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
1959 case bitc::METADATA_GLOBAL_VAR: {
1960 if (Record.size() != 11)
1961 return error("Invalid record");
1963 MDValueList.assignValue(
1964 GET_OR_DISTINCT(DIGlobalVariable, Record[0],
1965 (Context, getMDOrNull(Record[1]),
1966 getMDString(Record[2]), getMDString(Record[3]),
1967 getMDOrNull(Record[4]), Record[5],
1968 getMDOrNull(Record[6]), Record[7], Record[8],
1969 getMDOrNull(Record[9]), getMDOrNull(Record[10]))),
1973 case bitc::METADATA_LOCAL_VAR: {
1974 // 10th field is for the obseleted 'inlinedAt:' field.
1975 if (Record.size() < 8 || Record.size() > 10)
1976 return error("Invalid record");
1978 // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or
1979 // DW_TAG_arg_variable.
1980 bool HasTag = Record.size() > 8;
1981 MDValueList.assignValue(
1982 GET_OR_DISTINCT(DILocalVariable, Record[0],
1983 (Context, getMDOrNull(Record[1 + HasTag]),
1984 getMDString(Record[2 + HasTag]),
1985 getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag],
1986 getMDOrNull(Record[5 + HasTag]), Record[6 + HasTag],
1987 Record[7 + HasTag])),
1991 case bitc::METADATA_EXPRESSION: {
1992 if (Record.size() < 1)
1993 return error("Invalid record");
1995 MDValueList.assignValue(
1996 GET_OR_DISTINCT(DIExpression, Record[0],
1997 (Context, makeArrayRef(Record).slice(1))),
2001 case bitc::METADATA_OBJC_PROPERTY: {
2002 if (Record.size() != 8)
2003 return error("Invalid record");
2005 MDValueList.assignValue(
2006 GET_OR_DISTINCT(DIObjCProperty, Record[0],
2007 (Context, getMDString(Record[1]),
2008 getMDOrNull(Record[2]), Record[3],
2009 getMDString(Record[4]), getMDString(Record[5]),
2010 Record[6], getMDOrNull(Record[7]))),
2014 case bitc::METADATA_IMPORTED_ENTITY: {
2015 if (Record.size() != 6)
2016 return error("Invalid record");
2018 MDValueList.assignValue(
2019 GET_OR_DISTINCT(DIImportedEntity, Record[0],
2020 (Context, Record[1], getMDOrNull(Record[2]),
2021 getMDOrNull(Record[3]), Record[4],
2022 getMDString(Record[5]))),
2026 case bitc::METADATA_STRING: {
2027 std::string String(Record.begin(), Record.end());
2028 llvm::UpgradeMDStringConstant(String);
2029 Metadata *MD = MDString::get(Context, String);
2030 MDValueList.assignValue(MD, NextMDValueNo++);
2033 case bitc::METADATA_KIND: {
2034 if (Record.size() < 2)
2035 return error("Invalid record");
2037 unsigned Kind = Record[0];
2038 SmallString<8> Name(Record.begin()+1, Record.end());
2040 unsigned NewKind = TheModule->getMDKindID(Name.str());
2041 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
2042 return error("Conflicting METADATA_KIND records");
2047 #undef GET_OR_DISTINCT
2050 /// Decode a signed value stored with the sign bit in the LSB for dense VBR
2052 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
2057 // There is no such thing as -0 with integers. "-0" really means MININT.
2061 /// Resolve all of the initializers for global values and aliases that we can.
2062 std::error_code BitcodeReader::resolveGlobalAndAliasInits() {
2063 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
2064 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
2065 std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
2066 std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
2067 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFnWorklist;
2069 GlobalInitWorklist.swap(GlobalInits);
2070 AliasInitWorklist.swap(AliasInits);
2071 FunctionPrefixWorklist.swap(FunctionPrefixes);
2072 FunctionPrologueWorklist.swap(FunctionPrologues);
2073 FunctionPersonalityFnWorklist.swap(FunctionPersonalityFns);
2075 while (!GlobalInitWorklist.empty()) {
2076 unsigned ValID = GlobalInitWorklist.back().second;
2077 if (ValID >= ValueList.size()) {
2078 // Not ready to resolve this yet, it requires something later in the file.
2079 GlobalInits.push_back(GlobalInitWorklist.back());
2081 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2082 GlobalInitWorklist.back().first->setInitializer(C);
2084 return error("Expected a constant");
2086 GlobalInitWorklist.pop_back();
2089 while (!AliasInitWorklist.empty()) {
2090 unsigned ValID = AliasInitWorklist.back().second;
2091 if (ValID >= ValueList.size()) {
2092 AliasInits.push_back(AliasInitWorklist.back());
2094 Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]);
2096 return error("Expected a constant");
2097 GlobalAlias *Alias = AliasInitWorklist.back().first;
2098 if (C->getType() != Alias->getType())
2099 return error("Alias and aliasee types don't match");
2100 Alias->setAliasee(C);
2102 AliasInitWorklist.pop_back();
2105 while (!FunctionPrefixWorklist.empty()) {
2106 unsigned ValID = FunctionPrefixWorklist.back().second;
2107 if (ValID >= ValueList.size()) {
2108 FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2110 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2111 FunctionPrefixWorklist.back().first->setPrefixData(C);
2113 return error("Expected a constant");
2115 FunctionPrefixWorklist.pop_back();
2118 while (!FunctionPrologueWorklist.empty()) {
2119 unsigned ValID = FunctionPrologueWorklist.back().second;
2120 if (ValID >= ValueList.size()) {
2121 FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2123 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2124 FunctionPrologueWorklist.back().first->setPrologueData(C);
2126 return error("Expected a constant");
2128 FunctionPrologueWorklist.pop_back();
2131 while (!FunctionPersonalityFnWorklist.empty()) {
2132 unsigned ValID = FunctionPersonalityFnWorklist.back().second;
2133 if (ValID >= ValueList.size()) {
2134 FunctionPersonalityFns.push_back(FunctionPersonalityFnWorklist.back());
2136 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2137 FunctionPersonalityFnWorklist.back().first->setPersonalityFn(C);
2139 return error("Expected a constant");
2141 FunctionPersonalityFnWorklist.pop_back();
2144 return std::error_code();
2147 static APInt readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
2148 SmallVector<uint64_t, 8> Words(Vals.size());
2149 std::transform(Vals.begin(), Vals.end(), Words.begin(),
2150 BitcodeReader::decodeSignRotatedValue);
2152 return APInt(TypeBits, Words);
2155 std::error_code BitcodeReader::parseConstants() {
2156 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
2157 return error("Invalid record");
2159 SmallVector<uint64_t, 64> Record;
2161 // Read all the records for this value table.
2162 Type *CurTy = Type::getInt32Ty(Context);
2163 unsigned NextCstNo = ValueList.size();
2165 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2167 switch (Entry.Kind) {
2168 case BitstreamEntry::SubBlock: // Handled for us already.
2169 case BitstreamEntry::Error:
2170 return error("Malformed block");
2171 case BitstreamEntry::EndBlock:
2172 if (NextCstNo != ValueList.size())
2173 return error("Invalid ronstant reference");
2175 // Once all the constants have been read, go through and resolve forward
2177 ValueList.resolveConstantForwardRefs();
2178 return std::error_code();
2179 case BitstreamEntry::Record:
2180 // The interesting case.
2187 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2189 default: // Default behavior: unknown constant
2190 case bitc::CST_CODE_UNDEF: // UNDEF
2191 V = UndefValue::get(CurTy);
2193 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
2195 return error("Invalid record");
2196 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
2197 return error("Invalid record");
2198 CurTy = TypeList[Record[0]];
2199 continue; // Skip the ValueList manipulation.
2200 case bitc::CST_CODE_NULL: // NULL
2201 V = Constant::getNullValue(CurTy);
2203 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
2204 if (!CurTy->isIntegerTy() || Record.empty())
2205 return error("Invalid record");
2206 V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
2208 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
2209 if (!CurTy->isIntegerTy() || Record.empty())
2210 return error("Invalid record");
2213 readWideAPInt(Record, cast<IntegerType>(CurTy)->getBitWidth());
2214 V = ConstantInt::get(Context, VInt);
2218 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
2220 return error("Invalid record");
2221 if (CurTy->isHalfTy())
2222 V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
2223 APInt(16, (uint16_t)Record[0])));
2224 else if (CurTy->isFloatTy())
2225 V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
2226 APInt(32, (uint32_t)Record[0])));
2227 else if (CurTy->isDoubleTy())
2228 V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
2229 APInt(64, Record[0])));
2230 else if (CurTy->isX86_FP80Ty()) {
2231 // Bits are not stored the same way as a normal i80 APInt, compensate.
2232 uint64_t Rearrange[2];
2233 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2234 Rearrange[1] = Record[0] >> 48;
2235 V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
2236 APInt(80, Rearrange)));
2237 } else if (CurTy->isFP128Ty())
2238 V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
2239 APInt(128, Record)));
2240 else if (CurTy->isPPC_FP128Ty())
2241 V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
2242 APInt(128, Record)));
2244 V = UndefValue::get(CurTy);
2248 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2250 return error("Invalid record");
2252 unsigned Size = Record.size();
2253 SmallVector<Constant*, 16> Elts;
2255 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2256 for (unsigned i = 0; i != Size; ++i)
2257 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
2258 STy->getElementType(i)));
2259 V = ConstantStruct::get(STy, Elts);
2260 } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2261 Type *EltTy = ATy->getElementType();
2262 for (unsigned i = 0; i != Size; ++i)
2263 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2264 V = ConstantArray::get(ATy, Elts);
2265 } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2266 Type *EltTy = VTy->getElementType();
2267 for (unsigned i = 0; i != Size; ++i)
2268 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2269 V = ConstantVector::get(Elts);
2271 V = UndefValue::get(CurTy);
2275 case bitc::CST_CODE_STRING: // STRING: [values]
2276 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2278 return error("Invalid record");
2280 SmallString<16> Elts(Record.begin(), Record.end());
2281 V = ConstantDataArray::getString(Context, Elts,
2282 BitCode == bitc::CST_CODE_CSTRING);
2285 case bitc::CST_CODE_DATA: {// DATA: [n x value]
2287 return error("Invalid record");
2289 Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
2290 unsigned Size = Record.size();
2292 if (EltTy->isIntegerTy(8)) {
2293 SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2294 if (isa<VectorType>(CurTy))
2295 V = ConstantDataVector::get(Context, Elts);
2297 V = ConstantDataArray::get(Context, Elts);
2298 } else if (EltTy->isIntegerTy(16)) {
2299 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2300 if (isa<VectorType>(CurTy))
2301 V = ConstantDataVector::get(Context, Elts);
2303 V = ConstantDataArray::get(Context, Elts);
2304 } else if (EltTy->isIntegerTy(32)) {
2305 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2306 if (isa<VectorType>(CurTy))
2307 V = ConstantDataVector::get(Context, Elts);
2309 V = ConstantDataArray::get(Context, Elts);
2310 } else if (EltTy->isIntegerTy(64)) {
2311 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2312 if (isa<VectorType>(CurTy))
2313 V = ConstantDataVector::get(Context, Elts);
2315 V = ConstantDataArray::get(Context, Elts);
2316 } else if (EltTy->isFloatTy()) {
2317 SmallVector<float, 16> Elts(Size);
2318 std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
2319 if (isa<VectorType>(CurTy))
2320 V = ConstantDataVector::get(Context, Elts);
2322 V = ConstantDataArray::get(Context, Elts);
2323 } else if (EltTy->isDoubleTy()) {
2324 SmallVector<double, 16> Elts(Size);
2325 std::transform(Record.begin(), Record.end(), Elts.begin(),
2327 if (isa<VectorType>(CurTy))
2328 V = ConstantDataVector::get(Context, Elts);
2330 V = ConstantDataArray::get(Context, Elts);
2332 return error("Invalid type for value");
2337 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
2338 if (Record.size() < 3)
2339 return error("Invalid record");
2340 int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
2342 V = UndefValue::get(CurTy); // Unknown binop.
2344 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2345 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
2347 if (Record.size() >= 4) {
2348 if (Opc == Instruction::Add ||
2349 Opc == Instruction::Sub ||
2350 Opc == Instruction::Mul ||
2351 Opc == Instruction::Shl) {
2352 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2353 Flags |= OverflowingBinaryOperator::NoSignedWrap;
2354 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2355 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2356 } else if (Opc == Instruction::SDiv ||
2357 Opc == Instruction::UDiv ||
2358 Opc == Instruction::LShr ||
2359 Opc == Instruction::AShr) {
2360 if (Record[3] & (1 << bitc::PEO_EXACT))
2361 Flags |= SDivOperator::IsExact;
2364 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
2368 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
2369 if (Record.size() < 3)
2370 return error("Invalid record");
2371 int Opc = getDecodedCastOpcode(Record[0]);
2373 V = UndefValue::get(CurTy); // Unknown cast.
2375 Type *OpTy = getTypeByID(Record[1]);
2377 return error("Invalid record");
2378 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
2379 V = UpgradeBitCastExpr(Opc, Op, CurTy);
2380 if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
2384 case bitc::CST_CODE_CE_INBOUNDS_GEP:
2385 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
2387 Type *PointeeType = nullptr;
2388 if (Record.size() % 2)
2389 PointeeType = getTypeByID(Record[OpNum++]);
2390 SmallVector<Constant*, 16> Elts;
2391 while (OpNum != Record.size()) {
2392 Type *ElTy = getTypeByID(Record[OpNum++]);
2394 return error("Invalid record");
2395 Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
2400 cast<SequentialType>(Elts[0]->getType()->getScalarType())
2402 return error("Explicit gep operator type does not match pointee type "
2403 "of pointer operand");
2405 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2406 V = ConstantExpr::getGetElementPtr(PointeeType, Elts[0], Indices,
2408 bitc::CST_CODE_CE_INBOUNDS_GEP);
2411 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
2412 if (Record.size() < 3)
2413 return error("Invalid record");
2415 Type *SelectorTy = Type::getInt1Ty(Context);
2417 // If CurTy is a vector of length n, then Record[0] must be a <n x i1>
2418 // vector. Otherwise, it must be a single bit.
2419 if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
2420 SelectorTy = VectorType::get(Type::getInt1Ty(Context),
2421 VTy->getNumElements());
2423 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2425 ValueList.getConstantFwdRef(Record[1],CurTy),
2426 ValueList.getConstantFwdRef(Record[2],CurTy));
2429 case bitc::CST_CODE_CE_EXTRACTELT
2430 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
2431 if (Record.size() < 3)
2432 return error("Invalid record");
2434 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2436 return error("Invalid record");
2437 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2438 Constant *Op1 = nullptr;
2439 if (Record.size() == 4) {
2440 Type *IdxTy = getTypeByID(Record[2]);
2442 return error("Invalid record");
2443 Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2444 } else // TODO: Remove with llvm 4.0
2445 Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2447 return error("Invalid record");
2448 V = ConstantExpr::getExtractElement(Op0, Op1);
2451 case bitc::CST_CODE_CE_INSERTELT
2452 : { // CE_INSERTELT: [opval, opval, opty, opval]
2453 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2454 if (Record.size() < 3 || !OpTy)
2455 return error("Invalid record");
2456 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2457 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2458 OpTy->getElementType());
2459 Constant *Op2 = nullptr;
2460 if (Record.size() == 4) {
2461 Type *IdxTy = getTypeByID(Record[2]);
2463 return error("Invalid record");
2464 Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2465 } else // TODO: Remove with llvm 4.0
2466 Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2468 return error("Invalid record");
2469 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
2472 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
2473 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2474 if (Record.size() < 3 || !OpTy)
2475 return error("Invalid record");
2476 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2477 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
2478 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2479 OpTy->getNumElements());
2480 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
2481 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2484 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
2485 VectorType *RTy = dyn_cast<VectorType>(CurTy);
2487 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2488 if (Record.size() < 4 || !RTy || !OpTy)
2489 return error("Invalid record");
2490 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2491 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2492 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2493 RTy->getNumElements());
2494 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
2495 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2498 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
2499 if (Record.size() < 4)
2500 return error("Invalid record");
2501 Type *OpTy = getTypeByID(Record[0]);
2503 return error("Invalid record");
2504 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2505 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2507 if (OpTy->isFPOrFPVectorTy())
2508 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
2510 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
2513 // This maintains backward compatibility, pre-asm dialect keywords.
2514 // FIXME: Remove with the 4.0 release.
2515 case bitc::CST_CODE_INLINEASM_OLD: {
2516 if (Record.size() < 2)
2517 return error("Invalid record");
2518 std::string AsmStr, ConstrStr;
2519 bool HasSideEffects = Record[0] & 1;
2520 bool IsAlignStack = Record[0] >> 1;
2521 unsigned AsmStrSize = Record[1];
2522 if (2+AsmStrSize >= Record.size())
2523 return error("Invalid record");
2524 unsigned ConstStrSize = Record[2+AsmStrSize];
2525 if (3+AsmStrSize+ConstStrSize > Record.size())
2526 return error("Invalid record");
2528 for (unsigned i = 0; i != AsmStrSize; ++i)
2529 AsmStr += (char)Record[2+i];
2530 for (unsigned i = 0; i != ConstStrSize; ++i)
2531 ConstrStr += (char)Record[3+AsmStrSize+i];
2532 PointerType *PTy = cast<PointerType>(CurTy);
2533 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2534 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
2537 // This version adds support for the asm dialect keywords (e.g.,
2539 case bitc::CST_CODE_INLINEASM: {
2540 if (Record.size() < 2)
2541 return error("Invalid record");
2542 std::string AsmStr, ConstrStr;
2543 bool HasSideEffects = Record[0] & 1;
2544 bool IsAlignStack = (Record[0] >> 1) & 1;
2545 unsigned AsmDialect = Record[0] >> 2;
2546 unsigned AsmStrSize = Record[1];
2547 if (2+AsmStrSize >= Record.size())
2548 return error("Invalid record");
2549 unsigned ConstStrSize = Record[2+AsmStrSize];
2550 if (3+AsmStrSize+ConstStrSize > Record.size())
2551 return error("Invalid record");
2553 for (unsigned i = 0; i != AsmStrSize; ++i)
2554 AsmStr += (char)Record[2+i];
2555 for (unsigned i = 0; i != ConstStrSize; ++i)
2556 ConstrStr += (char)Record[3+AsmStrSize+i];
2557 PointerType *PTy = cast<PointerType>(CurTy);
2558 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2559 AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
2560 InlineAsm::AsmDialect(AsmDialect));
2563 case bitc::CST_CODE_BLOCKADDRESS:{
2564 if (Record.size() < 3)
2565 return error("Invalid record");
2566 Type *FnTy = getTypeByID(Record[0]);
2568 return error("Invalid record");
2570 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
2572 return error("Invalid record");
2574 // Don't let Fn get dematerialized.
2575 BlockAddressesTaken.insert(Fn);
2577 // If the function is already parsed we can insert the block address right
2580 unsigned BBID = Record[2];
2582 // Invalid reference to entry block.
2583 return error("Invalid ID");
2585 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
2586 for (size_t I = 0, E = BBID; I != E; ++I) {
2588 return error("Invalid ID");
2593 // Otherwise insert a placeholder and remember it so it can be inserted
2594 // when the function is parsed.
2595 auto &FwdBBs = BasicBlockFwdRefs[Fn];
2597 BasicBlockFwdRefQueue.push_back(Fn);
2598 if (FwdBBs.size() < BBID + 1)
2599 FwdBBs.resize(BBID + 1);
2601 FwdBBs[BBID] = BasicBlock::Create(Context);
2604 V = BlockAddress::get(Fn, BB);
2609 ValueList.assignValue(V, NextCstNo);
2614 std::error_code BitcodeReader::parseUseLists() {
2615 if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
2616 return error("Invalid record");
2618 // Read all the records.
2619 SmallVector<uint64_t, 64> Record;
2621 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2623 switch (Entry.Kind) {
2624 case BitstreamEntry::SubBlock: // Handled for us already.
2625 case BitstreamEntry::Error:
2626 return error("Malformed block");
2627 case BitstreamEntry::EndBlock:
2628 return std::error_code();
2629 case BitstreamEntry::Record:
2630 // The interesting case.
2634 // Read a use list record.
2637 switch (Stream.readRecord(Entry.ID, Record)) {
2638 default: // Default behavior: unknown type.
2640 case bitc::USELIST_CODE_BB:
2643 case bitc::USELIST_CODE_DEFAULT: {
2644 unsigned RecordLength = Record.size();
2645 if (RecordLength < 3)
2646 // Records should have at least an ID and two indexes.
2647 return error("Invalid record");
2648 unsigned ID = Record.back();
2653 assert(ID < FunctionBBs.size() && "Basic block not found");
2654 V = FunctionBBs[ID];
2657 unsigned NumUses = 0;
2658 SmallDenseMap<const Use *, unsigned, 16> Order;
2659 for (const Use &U : V->uses()) {
2660 if (++NumUses > Record.size())
2662 Order[&U] = Record[NumUses - 1];
2664 if (Order.size() != Record.size() || NumUses > Record.size())
2665 // Mismatches can happen if the functions are being materialized lazily
2666 // (out-of-order), or a value has been upgraded.
2669 V->sortUseList([&](const Use &L, const Use &R) {
2670 return Order.lookup(&L) < Order.lookup(&R);
2678 /// When we see the block for metadata, remember where it is and then skip it.
2679 /// This lets us lazily deserialize the metadata.
2680 std::error_code BitcodeReader::rememberAndSkipMetadata() {
2681 // Save the current stream state.
2682 uint64_t CurBit = Stream.GetCurrentBitNo();
2683 DeferredMetadataInfo.push_back(CurBit);
2685 // Skip over the block for now.
2686 if (Stream.SkipBlock())
2687 return error("Invalid record");
2688 return std::error_code();
2691 std::error_code BitcodeReader::materializeMetadata() {
2692 for (uint64_t BitPos : DeferredMetadataInfo) {
2693 // Move the bit stream to the saved position.
2694 Stream.JumpToBit(BitPos);
2695 if (std::error_code EC = parseMetadata())
2698 DeferredMetadataInfo.clear();
2699 return std::error_code();
2702 void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
2704 /// When we see the block for a function body, remember where it is and then
2705 /// skip it. This lets us lazily deserialize the functions.
2706 std::error_code BitcodeReader::rememberAndSkipFunctionBody() {
2707 // Get the function we are talking about.
2708 if (FunctionsWithBodies.empty())
2709 return error("Insufficient function protos");
2711 Function *Fn = FunctionsWithBodies.back();
2712 FunctionsWithBodies.pop_back();
2714 // Save the current stream state.
2715 uint64_t CurBit = Stream.GetCurrentBitNo();
2716 DeferredFunctionInfo[Fn] = CurBit;
2718 // Skip over the function block for now.
2719 if (Stream.SkipBlock())
2720 return error("Invalid record");
2721 return std::error_code();
2724 std::error_code BitcodeReader::globalCleanup() {
2725 // Patch the initializers for globals and aliases up.
2726 resolveGlobalAndAliasInits();
2727 if (!GlobalInits.empty() || !AliasInits.empty())
2728 return error("Malformed global initializer set");
2730 // Look for intrinsic functions which need to be upgraded at some point
2731 for (Function &F : *TheModule) {
2733 if (UpgradeIntrinsicFunction(&F, NewFn))
2734 UpgradedIntrinsics[&F] = NewFn;
2737 // Look for global variables which need to be renamed.
2738 for (GlobalVariable &GV : TheModule->globals())
2739 UpgradeGlobalVariable(&GV);
2741 // Force deallocation of memory for these vectors to favor the client that
2742 // want lazy deserialization.
2743 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
2744 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
2745 return std::error_code();
2748 std::error_code BitcodeReader::parseModule(bool Resume,
2749 bool ShouldLazyLoadMetadata) {
2751 Stream.JumpToBit(NextUnreadBit);
2752 else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
2753 return error("Invalid record");
2755 SmallVector<uint64_t, 64> Record;
2756 std::vector<std::string> SectionTable;
2757 std::vector<std::string> GCTable;
2759 // Read all the records for this module.
2761 BitstreamEntry Entry = Stream.advance();
2763 switch (Entry.Kind) {
2764 case BitstreamEntry::Error:
2765 return error("Malformed block");
2766 case BitstreamEntry::EndBlock:
2767 return globalCleanup();
2769 case BitstreamEntry::SubBlock:
2771 default: // Skip unknown content.
2772 if (Stream.SkipBlock())
2773 return error("Invalid record");
2775 case bitc::BLOCKINFO_BLOCK_ID:
2776 if (Stream.ReadBlockInfoBlock())
2777 return error("Malformed block");
2779 case bitc::PARAMATTR_BLOCK_ID:
2780 if (std::error_code EC = parseAttributeBlock())
2783 case bitc::PARAMATTR_GROUP_BLOCK_ID:
2784 if (std::error_code EC = parseAttributeGroupBlock())
2787 case bitc::TYPE_BLOCK_ID_NEW:
2788 if (std::error_code EC = parseTypeTable())
2791 case bitc::VALUE_SYMTAB_BLOCK_ID:
2792 if (std::error_code EC = parseValueSymbolTable())
2794 SeenValueSymbolTable = true;
2796 case bitc::CONSTANTS_BLOCK_ID:
2797 if (std::error_code EC = parseConstants())
2799 if (std::error_code EC = resolveGlobalAndAliasInits())
2802 case bitc::METADATA_BLOCK_ID:
2803 if (ShouldLazyLoadMetadata && !IsMetadataMaterialized) {
2804 if (std::error_code EC = rememberAndSkipMetadata())
2808 assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
2809 if (std::error_code EC = parseMetadata())
2812 case bitc::FUNCTION_BLOCK_ID:
2813 // If this is the first function body we've seen, reverse the
2814 // FunctionsWithBodies list.
2815 if (!SeenFirstFunctionBody) {
2816 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
2817 if (std::error_code EC = globalCleanup())
2819 SeenFirstFunctionBody = true;
2822 if (std::error_code EC = rememberAndSkipFunctionBody())
2824 // Suspend parsing when we reach the function bodies. Subsequent
2825 // materialization calls will resume it when necessary. If the bitcode
2826 // file is old, the symbol table will be at the end instead and will not
2827 // have been seen yet. In this case, just finish the parse now.
2828 if (SeenValueSymbolTable) {
2829 NextUnreadBit = Stream.GetCurrentBitNo();
2830 return std::error_code();
2833 case bitc::USELIST_BLOCK_ID:
2834 if (std::error_code EC = parseUseLists())
2840 case BitstreamEntry::Record:
2841 // The interesting case.
2847 switch (Stream.readRecord(Entry.ID, Record)) {
2848 default: break; // Default behavior, ignore unknown content.
2849 case bitc::MODULE_CODE_VERSION: { // VERSION: [version#]
2850 if (Record.size() < 1)
2851 return error("Invalid record");
2852 // Only version #0 and #1 are supported so far.
2853 unsigned module_version = Record[0];
2854 switch (module_version) {
2856 return error("Invalid value");
2858 UseRelativeIDs = false;
2861 UseRelativeIDs = true;
2866 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
2868 if (convertToString(Record, 0, S))
2869 return error("Invalid record");
2870 TheModule->setTargetTriple(S);
2873 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
2875 if (convertToString(Record, 0, S))
2876 return error("Invalid record");
2877 TheModule->setDataLayout(S);
2880 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
2882 if (convertToString(Record, 0, S))
2883 return error("Invalid record");
2884 TheModule->setModuleInlineAsm(S);
2887 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
2888 // FIXME: Remove in 4.0.
2890 if (convertToString(Record, 0, S))
2891 return error("Invalid record");
2895 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
2897 if (convertToString(Record, 0, S))
2898 return error("Invalid record");
2899 SectionTable.push_back(S);
2902 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
2904 if (convertToString(Record, 0, S))
2905 return error("Invalid record");
2906 GCTable.push_back(S);
2909 case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
2910 if (Record.size() < 2)
2911 return error("Invalid record");
2912 Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
2913 unsigned ComdatNameSize = Record[1];
2914 std::string ComdatName;
2915 ComdatName.reserve(ComdatNameSize);
2916 for (unsigned i = 0; i != ComdatNameSize; ++i)
2917 ComdatName += (char)Record[2 + i];
2918 Comdat *C = TheModule->getOrInsertComdat(ComdatName);
2919 C->setSelectionKind(SK);
2920 ComdatList.push_back(C);
2923 // GLOBALVAR: [pointer type, isconst, initid,
2924 // linkage, alignment, section, visibility, threadlocal,
2925 // unnamed_addr, externally_initialized, dllstorageclass,
2927 case bitc::MODULE_CODE_GLOBALVAR: {
2928 if (Record.size() < 6)
2929 return error("Invalid record");
2930 Type *Ty = getTypeByID(Record[0]);
2932 return error("Invalid record");
2933 bool isConstant = Record[1] & 1;
2934 bool explicitType = Record[1] & 2;
2935 unsigned AddressSpace;
2937 AddressSpace = Record[1] >> 2;
2939 if (!Ty->isPointerTy())
2940 return error("Invalid type for value");
2941 AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
2942 Ty = cast<PointerType>(Ty)->getElementType();
2945 uint64_t RawLinkage = Record[3];
2946 GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
2948 if (std::error_code EC = parseAlignmentValue(Record[4], Alignment))
2950 std::string Section;
2952 if (Record[5]-1 >= SectionTable.size())
2953 return error("Invalid ID");
2954 Section = SectionTable[Record[5]-1];
2956 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
2957 // Local linkage must have default visibility.
2958 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
2959 // FIXME: Change to an error if non-default in 4.0.
2960 Visibility = getDecodedVisibility(Record[6]);
2962 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
2963 if (Record.size() > 7)
2964 TLM = getDecodedThreadLocalMode(Record[7]);
2966 bool UnnamedAddr = false;
2967 if (Record.size() > 8)
2968 UnnamedAddr = Record[8];
2970 bool ExternallyInitialized = false;
2971 if (Record.size() > 9)
2972 ExternallyInitialized = Record[9];
2974 GlobalVariable *NewGV =
2975 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
2976 TLM, AddressSpace, ExternallyInitialized);
2977 NewGV->setAlignment(Alignment);
2978 if (!Section.empty())
2979 NewGV->setSection(Section);
2980 NewGV->setVisibility(Visibility);
2981 NewGV->setUnnamedAddr(UnnamedAddr);
2983 if (Record.size() > 10)
2984 NewGV->setDLLStorageClass(getDecodedDLLStorageClass(Record[10]));
2986 upgradeDLLImportExportLinkage(NewGV, RawLinkage);
2988 ValueList.push_back(NewGV);
2990 // Remember which value to use for the global initializer.
2991 if (unsigned InitID = Record[2])
2992 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
2994 if (Record.size() > 11) {
2995 if (unsigned ComdatID = Record[11]) {
2996 if (ComdatID > ComdatList.size())
2997 return error("Invalid global variable comdat ID");
2998 NewGV->setComdat(ComdatList[ComdatID - 1]);
3000 } else if (hasImplicitComdat(RawLinkage)) {
3001 NewGV->setComdat(reinterpret_cast<Comdat *>(1));
3005 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
3006 // alignment, section, visibility, gc, unnamed_addr,
3007 // prologuedata, dllstorageclass, comdat, prefixdata]
3008 case bitc::MODULE_CODE_FUNCTION: {
3009 if (Record.size() < 8)
3010 return error("Invalid record");
3011 Type *Ty = getTypeByID(Record[0]);
3013 return error("Invalid record");
3014 if (auto *PTy = dyn_cast<PointerType>(Ty))
3015 Ty = PTy->getElementType();
3016 auto *FTy = dyn_cast<FunctionType>(Ty);
3018 return error("Invalid type for value");
3020 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
3023 Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
3024 bool isProto = Record[2];
3025 uint64_t RawLinkage = Record[3];
3026 Func->setLinkage(getDecodedLinkage(RawLinkage));
3027 Func->setAttributes(getAttributes(Record[4]));
3030 if (std::error_code EC = parseAlignmentValue(Record[5], Alignment))
3032 Func->setAlignment(Alignment);
3034 if (Record[6]-1 >= SectionTable.size())
3035 return error("Invalid ID");
3036 Func->setSection(SectionTable[Record[6]-1]);
3038 // Local linkage must have default visibility.
3039 if (!Func->hasLocalLinkage())
3040 // FIXME: Change to an error if non-default in 4.0.
3041 Func->setVisibility(getDecodedVisibility(Record[7]));
3042 if (Record.size() > 8 && Record[8]) {
3043 if (Record[8]-1 >= GCTable.size())
3044 return error("Invalid ID");
3045 Func->setGC(GCTable[Record[8]-1].c_str());
3047 bool UnnamedAddr = false;
3048 if (Record.size() > 9)
3049 UnnamedAddr = Record[9];
3050 Func->setUnnamedAddr(UnnamedAddr);
3051 if (Record.size() > 10 && Record[10] != 0)
3052 FunctionPrologues.push_back(std::make_pair(Func, Record[10]-1));
3054 if (Record.size() > 11)
3055 Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));
3057 upgradeDLLImportExportLinkage(Func, RawLinkage);
3059 if (Record.size() > 12) {
3060 if (unsigned ComdatID = Record[12]) {
3061 if (ComdatID > ComdatList.size())
3062 return error("Invalid function comdat ID");
3063 Func->setComdat(ComdatList[ComdatID - 1]);
3065 } else if (hasImplicitComdat(RawLinkage)) {
3066 Func->setComdat(reinterpret_cast<Comdat *>(1));
3069 if (Record.size() > 13 && Record[13] != 0)
3070 FunctionPrefixes.push_back(std::make_pair(Func, Record[13]-1));
3072 if (Record.size() > 14 && Record[14] != 0)
3073 FunctionPersonalityFns.push_back(std::make_pair(Func, Record[14] - 1));
3075 ValueList.push_back(Func);
3077 // If this is a function with a body, remember the prototype we are
3078 // creating now, so that we can match up the body with them later.
3080 Func->setIsMaterializable(true);
3081 FunctionsWithBodies.push_back(Func);
3082 DeferredFunctionInfo[Func] = 0;
3086 // ALIAS: [alias type, aliasee val#, linkage]
3087 // ALIAS: [alias type, aliasee val#, linkage, visibility, dllstorageclass]
3088 case bitc::MODULE_CODE_ALIAS: {
3089 if (Record.size() < 3)
3090 return error("Invalid record");
3091 Type *Ty = getTypeByID(Record[0]);
3093 return error("Invalid record");
3094 auto *PTy = dyn_cast<PointerType>(Ty);
3096 return error("Invalid type for value");
3099 GlobalAlias::create(PTy, getDecodedLinkage(Record[2]), "", TheModule);
3100 // Old bitcode files didn't have visibility field.
3101 // Local linkage must have default visibility.
3102 if (Record.size() > 3 && !NewGA->hasLocalLinkage())
3103 // FIXME: Change to an error if non-default in 4.0.
3104 NewGA->setVisibility(getDecodedVisibility(Record[3]));
3105 if (Record.size() > 4)
3106 NewGA->setDLLStorageClass(getDecodedDLLStorageClass(Record[4]));
3108 upgradeDLLImportExportLinkage(NewGA, Record[2]);
3109 if (Record.size() > 5)
3110 NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[5]));
3111 if (Record.size() > 6)
3112 NewGA->setUnnamedAddr(Record[6]);
3113 ValueList.push_back(NewGA);
3114 AliasInits.push_back(std::make_pair(NewGA, Record[1]));
3117 /// MODULE_CODE_PURGEVALS: [numvals]
3118 case bitc::MODULE_CODE_PURGEVALS:
3119 // Trim down the value list to the specified size.
3120 if (Record.size() < 1 || Record[0] > ValueList.size())
3121 return error("Invalid record");
3122 ValueList.shrinkTo(Record[0]);
3130 BitcodeReader::parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
3131 Module *M, bool ShouldLazyLoadMetadata) {
3134 if (std::error_code EC = initStream(std::move(Streamer)))
3137 // Sniff for the signature.
3138 if (Stream.Read(8) != 'B' ||
3139 Stream.Read(8) != 'C' ||
3140 Stream.Read(4) != 0x0 ||
3141 Stream.Read(4) != 0xC ||
3142 Stream.Read(4) != 0xE ||
3143 Stream.Read(4) != 0xD)
3144 return error("Invalid bitcode signature");
3146 // We expect a number of well-defined blocks, though we don't necessarily
3147 // need to understand them all.
3149 if (Stream.AtEndOfStream()) {
3150 // We didn't really read a proper Module.
3151 return error("Malformed IR file");
3154 BitstreamEntry Entry =
3155 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
3157 if (Entry.Kind != BitstreamEntry::SubBlock)
3158 return error("Malformed block");
3160 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3161 return parseModule(false, ShouldLazyLoadMetadata);
3163 if (Stream.SkipBlock())
3164 return error("Invalid record");
3168 ErrorOr<std::string> BitcodeReader::parseModuleTriple() {
3169 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3170 return error("Invalid record");
3172 SmallVector<uint64_t, 64> Record;
3175 // Read all the records for this module.
3177 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3179 switch (Entry.Kind) {
3180 case BitstreamEntry::SubBlock: // Handled for us already.
3181 case BitstreamEntry::Error:
3182 return error("Malformed block");
3183 case BitstreamEntry::EndBlock:
3185 case BitstreamEntry::Record:
3186 // The interesting case.
3191 switch (Stream.readRecord(Entry.ID, Record)) {
3192 default: break; // Default behavior, ignore unknown content.
3193 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
3195 if (convertToString(Record, 0, S))
3196 return error("Invalid record");
3203 llvm_unreachable("Exit infinite loop");
3206 ErrorOr<std::string> BitcodeReader::parseTriple() {
3207 if (std::error_code EC = initStream(nullptr))
3210 // Sniff for the signature.
3211 if (Stream.Read(8) != 'B' ||
3212 Stream.Read(8) != 'C' ||
3213 Stream.Read(4) != 0x0 ||
3214 Stream.Read(4) != 0xC ||
3215 Stream.Read(4) != 0xE ||
3216 Stream.Read(4) != 0xD)
3217 return error("Invalid bitcode signature");
3219 // We expect a number of well-defined blocks, though we don't necessarily
3220 // need to understand them all.
3222 BitstreamEntry Entry = Stream.advance();
3224 switch (Entry.Kind) {
3225 case BitstreamEntry::Error:
3226 return error("Malformed block");
3227 case BitstreamEntry::EndBlock:
3228 return std::error_code();
3230 case BitstreamEntry::SubBlock:
3231 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3232 return parseModuleTriple();
3234 // Ignore other sub-blocks.
3235 if (Stream.SkipBlock())
3236 return error("Malformed block");
3239 case BitstreamEntry::Record:
3240 Stream.skipRecord(Entry.ID);
3246 /// Parse metadata attachments.
3247 std::error_code BitcodeReader::parseMetadataAttachment(Function &F) {
3248 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
3249 return error("Invalid record");
3251 SmallVector<uint64_t, 64> Record;
3253 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3255 switch (Entry.Kind) {
3256 case BitstreamEntry::SubBlock: // Handled for us already.
3257 case BitstreamEntry::Error:
3258 return error("Malformed block");
3259 case BitstreamEntry::EndBlock:
3260 return std::error_code();
3261 case BitstreamEntry::Record:
3262 // The interesting case.
3266 // Read a metadata attachment record.
3268 switch (Stream.readRecord(Entry.ID, Record)) {
3269 default: // Default behavior: ignore.
3271 case bitc::METADATA_ATTACHMENT: {
3272 unsigned RecordLength = Record.size();
3274 return error("Invalid record");
3275 if (RecordLength % 2 == 0) {
3276 // A function attachment.
3277 for (unsigned I = 0; I != RecordLength; I += 2) {
3278 auto K = MDKindMap.find(Record[I]);
3279 if (K == MDKindMap.end())
3280 return error("Invalid ID");
3281 Metadata *MD = MDValueList.getValueFwdRef(Record[I + 1]);
3282 F.setMetadata(K->second, cast<MDNode>(MD));
3287 // An instruction attachment.
3288 Instruction *Inst = InstructionList[Record[0]];
3289 for (unsigned i = 1; i != RecordLength; i = i+2) {
3290 unsigned Kind = Record[i];
3291 DenseMap<unsigned, unsigned>::iterator I =
3292 MDKindMap.find(Kind);
3293 if (I == MDKindMap.end())
3294 return error("Invalid ID");
3295 Metadata *Node = MDValueList.getValueFwdRef(Record[i + 1]);
3296 if (isa<LocalAsMetadata>(Node))
3297 // Drop the attachment. This used to be legal, but there's no
3300 Inst->setMetadata(I->second, cast<MDNode>(Node));
3301 if (I->second == LLVMContext::MD_tbaa)
3302 InstsWithTBAATag.push_back(Inst);
3310 static std::error_code typeCheckLoadStoreInst(DiagnosticHandlerFunction DH,
3311 Type *ValType, Type *PtrType) {
3312 if (!isa<PointerType>(PtrType))
3313 return error(DH, "Load/Store operand is not a pointer type");
3314 Type *ElemType = cast<PointerType>(PtrType)->getElementType();
3316 if (ValType && ValType != ElemType)
3317 return error(DH, "Explicit load/store type does not match pointee type of "
3319 if (!PointerType::isLoadableOrStorableType(ElemType))
3320 return error(DH, "Cannot load/store from pointer");
3321 return std::error_code();
3324 /// Lazily parse the specified function body block.
3325 std::error_code BitcodeReader::parseFunctionBody(Function *F) {
3326 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
3327 return error("Invalid record");
3329 InstructionList.clear();
3330 unsigned ModuleValueListSize = ValueList.size();
3331 unsigned ModuleMDValueListSize = MDValueList.size();
3333 // Add all the function arguments to the value table.
3334 for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
3335 ValueList.push_back(I);
3337 unsigned NextValueNo = ValueList.size();
3338 BasicBlock *CurBB = nullptr;
3339 unsigned CurBBNo = 0;
3342 auto getLastInstruction = [&]() -> Instruction * {
3343 if (CurBB && !CurBB->empty())
3344 return &CurBB->back();
3345 else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
3346 !FunctionBBs[CurBBNo - 1]->empty())
3347 return &FunctionBBs[CurBBNo - 1]->back();
3351 // Read all the records.
3352 SmallVector<uint64_t, 64> Record;
3354 BitstreamEntry Entry = Stream.advance();
3356 switch (Entry.Kind) {
3357 case BitstreamEntry::Error:
3358 return error("Malformed block");
3359 case BitstreamEntry::EndBlock:
3360 goto OutOfRecordLoop;
3362 case BitstreamEntry::SubBlock:
3364 default: // Skip unknown content.
3365 if (Stream.SkipBlock())
3366 return error("Invalid record");
3368 case bitc::CONSTANTS_BLOCK_ID:
3369 if (std::error_code EC = parseConstants())
3371 NextValueNo = ValueList.size();
3373 case bitc::VALUE_SYMTAB_BLOCK_ID:
3374 if (std::error_code EC = parseValueSymbolTable())
3377 case bitc::METADATA_ATTACHMENT_ID:
3378 if (std::error_code EC = parseMetadataAttachment(*F))
3381 case bitc::METADATA_BLOCK_ID:
3382 if (std::error_code EC = parseMetadata())
3385 case bitc::USELIST_BLOCK_ID:
3386 if (std::error_code EC = parseUseLists())
3392 case BitstreamEntry::Record:
3393 // The interesting case.
3399 Instruction *I = nullptr;
3400 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
3402 default: // Default behavior: reject
3403 return error("Invalid value");
3404 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
3405 if (Record.size() < 1 || Record[0] == 0)
3406 return error("Invalid record");
3407 // Create all the basic blocks for the function.
3408 FunctionBBs.resize(Record[0]);
3410 // See if anything took the address of blocks in this function.
3411 auto BBFRI = BasicBlockFwdRefs.find(F);
3412 if (BBFRI == BasicBlockFwdRefs.end()) {
3413 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
3414 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
3416 auto &BBRefs = BBFRI->second;
3417 // Check for invalid basic block references.
3418 if (BBRefs.size() > FunctionBBs.size())
3419 return error("Invalid ID");
3420 assert(!BBRefs.empty() && "Unexpected empty array");
3421 assert(!BBRefs.front() && "Invalid reference to entry block");
3422 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
3424 if (I < RE && BBRefs[I]) {
3425 BBRefs[I]->insertInto(F);
3426 FunctionBBs[I] = BBRefs[I];
3428 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
3431 // Erase from the table.
3432 BasicBlockFwdRefs.erase(BBFRI);
3435 CurBB = FunctionBBs[0];
3439 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
3440 // This record indicates that the last instruction is at the same
3441 // location as the previous instruction with a location.
3442 I = getLastInstruction();
3445 return error("Invalid record");
3446 I->setDebugLoc(LastLoc);
3450 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
3451 I = getLastInstruction();
3452 if (!I || Record.size() < 4)
3453 return error("Invalid record");
3455 unsigned Line = Record[0], Col = Record[1];
3456 unsigned ScopeID = Record[2], IAID = Record[3];
3458 MDNode *Scope = nullptr, *IA = nullptr;
3459 if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
3460 if (IAID) IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
3461 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
3462 I->setDebugLoc(LastLoc);
3467 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
3470 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3471 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
3472 OpNum+1 > Record.size())
3473 return error("Invalid record");
3475 int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
3477 return error("Invalid record");
3478 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
3479 InstructionList.push_back(I);
3480 if (OpNum < Record.size()) {
3481 if (Opc == Instruction::Add ||
3482 Opc == Instruction::Sub ||
3483 Opc == Instruction::Mul ||
3484 Opc == Instruction::Shl) {
3485 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
3486 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
3487 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
3488 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
3489 } else if (Opc == Instruction::SDiv ||
3490 Opc == Instruction::UDiv ||
3491 Opc == Instruction::LShr ||
3492 Opc == Instruction::AShr) {
3493 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
3494 cast<BinaryOperator>(I)->setIsExact(true);
3495 } else if (isa<FPMathOperator>(I)) {
3496 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
3498 I->setFastMathFlags(FMF);
3504 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
3507 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3508 OpNum+2 != Record.size())
3509 return error("Invalid record");
3511 Type *ResTy = getTypeByID(Record[OpNum]);
3512 int Opc = getDecodedCastOpcode(Record[OpNum + 1]);
3513 if (Opc == -1 || !ResTy)
3514 return error("Invalid record");
3515 Instruction *Temp = nullptr;
3516 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
3518 InstructionList.push_back(Temp);
3519 CurBB->getInstList().push_back(Temp);
3522 I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
3524 InstructionList.push_back(I);
3527 case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:
3528 case bitc::FUNC_CODE_INST_GEP_OLD:
3529 case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
3535 if (BitCode == bitc::FUNC_CODE_INST_GEP) {
3536 InBounds = Record[OpNum++];
3537 Ty = getTypeByID(Record[OpNum++]);
3539 InBounds = BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD;
3544 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
3545 return error("Invalid record");
3548 Ty = cast<SequentialType>(BasePtr->getType()->getScalarType())
3551 cast<SequentialType>(BasePtr->getType()->getScalarType())
3554 "Explicit gep type does not match pointee type of pointer operand");
3556 SmallVector<Value*, 16> GEPIdx;
3557 while (OpNum != Record.size()) {
3559 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3560 return error("Invalid record");
3561 GEPIdx.push_back(Op);
3564 I = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
3566 InstructionList.push_back(I);
3568 cast<GetElementPtrInst>(I)->setIsInBounds(true);
3572 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
3573 // EXTRACTVAL: [opty, opval, n x indices]
3576 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
3577 return error("Invalid record");
3579 unsigned RecSize = Record.size();
3580 if (OpNum == RecSize)
3581 return error("EXTRACTVAL: Invalid instruction with 0 indices");
3583 SmallVector<unsigned, 4> EXTRACTVALIdx;
3584 Type *CurTy = Agg->getType();
3585 for (; OpNum != RecSize; ++OpNum) {
3586 bool IsArray = CurTy->isArrayTy();
3587 bool IsStruct = CurTy->isStructTy();
3588 uint64_t Index = Record[OpNum];
3590 if (!IsStruct && !IsArray)
3591 return error("EXTRACTVAL: Invalid type");
3592 if ((unsigned)Index != Index)
3593 return error("Invalid value");
3594 if (IsStruct && Index >= CurTy->subtypes().size())
3595 return error("EXTRACTVAL: Invalid struct index");
3596 if (IsArray && Index >= CurTy->getArrayNumElements())
3597 return error("EXTRACTVAL: Invalid array index");
3598 EXTRACTVALIdx.push_back((unsigned)Index);
3601 CurTy = CurTy->subtypes()[Index];
3603 CurTy = CurTy->subtypes()[0];
3606 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
3607 InstructionList.push_back(I);
3611 case bitc::FUNC_CODE_INST_INSERTVAL: {
3612 // INSERTVAL: [opty, opval, opty, opval, n x indices]
3615 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
3616 return error("Invalid record");
3618 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
3619 return error("Invalid record");
3621 unsigned RecSize = Record.size();
3622 if (OpNum == RecSize)
3623 return error("INSERTVAL: Invalid instruction with 0 indices");
3625 SmallVector<unsigned, 4> INSERTVALIdx;
3626 Type *CurTy = Agg->getType();
3627 for (; OpNum != RecSize; ++OpNum) {
3628 bool IsArray = CurTy->isArrayTy();
3629 bool IsStruct = CurTy->isStructTy();
3630 uint64_t Index = Record[OpNum];
3632 if (!IsStruct && !IsArray)
3633 return error("INSERTVAL: Invalid type");
3634 if ((unsigned)Index != Index)
3635 return error("Invalid value");
3636 if (IsStruct && Index >= CurTy->subtypes().size())
3637 return error("INSERTVAL: Invalid struct index");
3638 if (IsArray && Index >= CurTy->getArrayNumElements())
3639 return error("INSERTVAL: Invalid array index");
3641 INSERTVALIdx.push_back((unsigned)Index);
3643 CurTy = CurTy->subtypes()[Index];
3645 CurTy = CurTy->subtypes()[0];
3648 if (CurTy != Val->getType())
3649 return error("Inserted value type doesn't match aggregate type");
3651 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
3652 InstructionList.push_back(I);
3656 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
3657 // obsolete form of select
3658 // handles select i1 ... in old bitcode
3660 Value *TrueVal, *FalseVal, *Cond;
3661 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
3662 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
3663 popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
3664 return error("Invalid record");
3666 I = SelectInst::Create(Cond, TrueVal, FalseVal);
3667 InstructionList.push_back(I);
3671 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
3672 // new form of select
3673 // handles select i1 or select [N x i1]
3675 Value *TrueVal, *FalseVal, *Cond;
3676 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
3677 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
3678 getValueTypePair(Record, OpNum, NextValueNo, Cond))
3679 return error("Invalid record");
3681 // select condition can be either i1 or [N x i1]
3682 if (VectorType* vector_type =
3683 dyn_cast<VectorType>(Cond->getType())) {
3685 if (vector_type->getElementType() != Type::getInt1Ty(Context))
3686 return error("Invalid type for value");
3689 if (Cond->getType() != Type::getInt1Ty(Context))
3690 return error("Invalid type for value");
3693 I = SelectInst::Create(Cond, TrueVal, FalseVal);
3694 InstructionList.push_back(I);
3698 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
3701 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
3702 getValueTypePair(Record, OpNum, NextValueNo, Idx))
3703 return error("Invalid record");
3704 if (!Vec->getType()->isVectorTy())
3705 return error("Invalid type for value");
3706 I = ExtractElementInst::Create(Vec, Idx);
3707 InstructionList.push_back(I);
3711 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
3713 Value *Vec, *Elt, *Idx;
3714 if (getValueTypePair(Record, OpNum, NextValueNo, Vec))
3715 return error("Invalid record");
3716 if (!Vec->getType()->isVectorTy())
3717 return error("Invalid type for value");
3718 if (popValue(Record, OpNum, NextValueNo,
3719 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
3720 getValueTypePair(Record, OpNum, NextValueNo, Idx))
3721 return error("Invalid record");
3722 I = InsertElementInst::Create(Vec, Elt, Idx);
3723 InstructionList.push_back(I);
3727 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
3729 Value *Vec1, *Vec2, *Mask;
3730 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
3731 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
3732 return error("Invalid record");
3734 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
3735 return error("Invalid record");
3736 if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())
3737 return error("Invalid type for value");
3738 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
3739 InstructionList.push_back(I);
3743 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
3744 // Old form of ICmp/FCmp returning bool
3745 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
3746 // both legal on vectors but had different behaviour.
3747 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
3748 // FCmp/ICmp returning bool or vector of bool
3752 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3753 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS))
3754 return error("Invalid record");
3756 unsigned PredVal = Record[OpNum];
3757 bool IsFP = LHS->getType()->isFPOrFPVectorTy();
3759 if (IsFP && Record.size() > OpNum+1)
3760 FMF = getDecodedFastMathFlags(Record[++OpNum]);
3762 if (OpNum+1 != Record.size())
3763 return error("Invalid record");
3765 if (LHS->getType()->isFPOrFPVectorTy())
3766 I = new FCmpInst((FCmpInst::Predicate)PredVal, LHS, RHS);
3768 I = new ICmpInst((ICmpInst::Predicate)PredVal, LHS, RHS);
3771 I->setFastMathFlags(FMF);
3772 InstructionList.push_back(I);
3776 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
3778 unsigned Size = Record.size();
3780 I = ReturnInst::Create(Context);
3781 InstructionList.push_back(I);
3786 Value *Op = nullptr;
3787 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3788 return error("Invalid record");
3789 if (OpNum != Record.size())
3790 return error("Invalid record");
3792 I = ReturnInst::Create(Context, Op);
3793 InstructionList.push_back(I);
3796 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
3797 if (Record.size() != 1 && Record.size() != 3)
3798 return error("Invalid record");
3799 BasicBlock *TrueDest = getBasicBlock(Record[0]);
3801 return error("Invalid record");
3803 if (Record.size() == 1) {
3804 I = BranchInst::Create(TrueDest);
3805 InstructionList.push_back(I);
3808 BasicBlock *FalseDest = getBasicBlock(Record[1]);
3809 Value *Cond = getValue(Record, 2, NextValueNo,
3810 Type::getInt1Ty(Context));
3811 if (!FalseDest || !Cond)
3812 return error("Invalid record");
3813 I = BranchInst::Create(TrueDest, FalseDest, Cond);
3814 InstructionList.push_back(I);
3818 // CLEANUPRET: [] or [ty,val] or [bb#] or [ty,val,bb#]
3819 case bitc::FUNC_CODE_INST_CLEANUPRET: {
3820 if (Record.size() < 2)
3821 return error("Invalid record");
3823 bool HasReturnValue = !!Record[Idx++];
3824 bool HasUnwindDest = !!Record[Idx++];
3825 Value *RetVal = nullptr;
3826 BasicBlock *UnwindDest = nullptr;
3828 if (HasReturnValue && getValueTypePair(Record, Idx, NextValueNo, RetVal))
3829 return error("Invalid record");
3830 if (HasUnwindDest) {
3831 if (Idx == Record.size())
3832 return error("Invalid record");
3833 UnwindDest = getBasicBlock(Record[Idx++]);
3835 return error("Invalid record");
3838 if (Record.size() != Idx)
3839 return error("Invalid record");
3841 I = CleanupReturnInst::Create(Context, RetVal, UnwindDest);
3842 InstructionList.push_back(I);
3845 case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [bb#]
3846 if (Record.size() != 1)
3847 return error("Invalid record");
3848 BasicBlock *BB = getBasicBlock(Record[0]);
3850 return error("Invalid record");
3851 I = CatchReturnInst::Create(BB);
3852 InstructionList.push_back(I);
3855 case bitc::FUNC_CODE_INST_CATCHPAD: { // CATCHPAD: [ty,bb#,bb#,num,(ty,val)*]
3856 if (Record.size() < 4)
3857 return error("Invalid record");
3859 Type *Ty = getTypeByID(Record[Idx++]);
3861 return error("Invalid record");
3862 BasicBlock *NormalBB = getBasicBlock(Record[Idx++]);
3864 return error("Invalid record");
3865 BasicBlock *UnwindBB = getBasicBlock(Record[Idx++]);
3867 return error("Invalid record");
3868 unsigned NumArgOperands = Record[Idx++];
3869 SmallVector<Value *, 2> Args;
3870 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
3872 if (getValueTypePair(Record, Idx, NextValueNo, Val))
3873 return error("Invalid record");
3874 Args.push_back(Val);
3876 if (Record.size() != Idx)
3877 return error("Invalid record");
3879 I = CatchPadInst::Create(Ty, NormalBB, UnwindBB, Args);
3880 InstructionList.push_back(I);
3883 case bitc::FUNC_CODE_INST_TERMINATEPAD: { // TERMINATEPAD: [bb#,num,(ty,val)*]
3884 if (Record.size() < 1)
3885 return error("Invalid record");
3887 bool HasUnwindDest = !!Record[Idx++];
3888 BasicBlock *UnwindDest = nullptr;
3889 if (HasUnwindDest) {
3890 if (Idx == Record.size())
3891 return error("Invalid record");
3892 UnwindDest = getBasicBlock(Record[Idx++]);
3894 return error("Invalid record");
3896 unsigned NumArgOperands = Record[Idx++];
3897 SmallVector<Value *, 2> Args;
3898 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
3900 if (getValueTypePair(Record, Idx, NextValueNo, Val))
3901 return error("Invalid record");
3902 Args.push_back(Val);
3904 if (Record.size() != Idx)
3905 return error("Invalid record");
3907 I = TerminatePadInst::Create(Context, UnwindDest, Args);
3908 InstructionList.push_back(I);
3911 case bitc::FUNC_CODE_INST_CLEANUPPAD: { // CLEANUPPAD: [ty, num,(ty,val)*]
3912 if (Record.size() < 2)
3913 return error("Invalid record");
3915 Type *Ty = getTypeByID(Record[Idx++]);
3917 return error("Invalid record");
3918 unsigned NumArgOperands = Record[Idx++];
3919 SmallVector<Value *, 2> Args;
3920 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
3922 if (getValueTypePair(Record, Idx, NextValueNo, Val))
3923 return error("Invalid record");
3924 Args.push_back(Val);
3926 if (Record.size() != Idx)
3927 return error("Invalid record");
3929 I = CleanupPadInst::Create(Ty, Args);
3930 InstructionList.push_back(I);
3933 case bitc::FUNC_CODE_INST_CATCHENDPAD: { // CATCHENDPADINST: [bb#] or []
3934 if (Record.size() > 1)
3935 return error("Invalid record");
3936 BasicBlock *BB = nullptr;
3937 if (Record.size() == 1) {
3938 BB = getBasicBlock(Record[0]);
3940 return error("Invalid record");
3942 I = CatchEndPadInst::Create(Context, BB);
3943 InstructionList.push_back(I);
3946 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
3948 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
3949 // "New" SwitchInst format with case ranges. The changes to write this
3950 // format were reverted but we still recognize bitcode that uses it.
3951 // Hopefully someday we will have support for case ranges and can use
3952 // this format again.
3954 Type *OpTy = getTypeByID(Record[1]);
3955 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
3957 Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
3958 BasicBlock *Default = getBasicBlock(Record[3]);
3959 if (!OpTy || !Cond || !Default)
3960 return error("Invalid record");
3962 unsigned NumCases = Record[4];
3964 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
3965 InstructionList.push_back(SI);
3967 unsigned CurIdx = 5;
3968 for (unsigned i = 0; i != NumCases; ++i) {
3969 SmallVector<ConstantInt*, 1> CaseVals;
3970 unsigned NumItems = Record[CurIdx++];
3971 for (unsigned ci = 0; ci != NumItems; ++ci) {
3972 bool isSingleNumber = Record[CurIdx++];
3975 unsigned ActiveWords = 1;
3976 if (ValueBitWidth > 64)
3977 ActiveWords = Record[CurIdx++];
3978 Low = readWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
3980 CurIdx += ActiveWords;
3982 if (!isSingleNumber) {
3984 if (ValueBitWidth > 64)
3985 ActiveWords = Record[CurIdx++];
3986 APInt High = readWideAPInt(
3987 makeArrayRef(&Record[CurIdx], ActiveWords), ValueBitWidth);
3988 CurIdx += ActiveWords;
3990 // FIXME: It is not clear whether values in the range should be
3991 // compared as signed or unsigned values. The partially
3992 // implemented changes that used this format in the past used
3993 // unsigned comparisons.
3994 for ( ; Low.ule(High); ++Low)
3995 CaseVals.push_back(ConstantInt::get(Context, Low));
3997 CaseVals.push_back(ConstantInt::get(Context, Low));
3999 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
4000 for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
4001 cve = CaseVals.end(); cvi != cve; ++cvi)
4002 SI->addCase(*cvi, DestBB);
4008 // Old SwitchInst format without case ranges.
4010 if (Record.size() < 3 || (Record.size() & 1) == 0)
4011 return error("Invalid record");
4012 Type *OpTy = getTypeByID(Record[0]);
4013 Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
4014 BasicBlock *Default = getBasicBlock(Record[2]);
4015 if (!OpTy || !Cond || !Default)
4016 return error("Invalid record");
4017 unsigned NumCases = (Record.size()-3)/2;
4018 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4019 InstructionList.push_back(SI);
4020 for (unsigned i = 0, e = NumCases; i != e; ++i) {
4021 ConstantInt *CaseVal =
4022 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
4023 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
4024 if (!CaseVal || !DestBB) {
4026 return error("Invalid record");
4028 SI->addCase(CaseVal, DestBB);
4033 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
4034 if (Record.size() < 2)
4035 return error("Invalid record");
4036 Type *OpTy = getTypeByID(Record[0]);
4037 Value *Address = getValue(Record, 1, NextValueNo, OpTy);
4038 if (!OpTy || !Address)
4039 return error("Invalid record");
4040 unsigned NumDests = Record.size()-2;
4041 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
4042 InstructionList.push_back(IBI);
4043 for (unsigned i = 0, e = NumDests; i != e; ++i) {
4044 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
4045 IBI->addDestination(DestBB);
4048 return error("Invalid record");
4055 case bitc::FUNC_CODE_INST_INVOKE: {
4056 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
4057 if (Record.size() < 4)
4058 return error("Invalid record");
4060 AttributeSet PAL = getAttributes(Record[OpNum++]);
4061 unsigned CCInfo = Record[OpNum++];
4062 BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);
4063 BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);
4065 FunctionType *FTy = nullptr;
4066 if (CCInfo >> 13 & 1 &&
4067 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
4068 return error("Explicit invoke type is not a function type");
4071 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
4072 return error("Invalid record");
4074 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
4076 return error("Callee is not a pointer");
4078 FTy = dyn_cast<FunctionType>(CalleeTy->getElementType());
4080 return error("Callee is not of pointer to function type");
4081 } else if (CalleeTy->getElementType() != FTy)
4082 return error("Explicit invoke type does not match pointee type of "
4084 if (Record.size() < FTy->getNumParams() + OpNum)
4085 return error("Insufficient operands to call");
4087 SmallVector<Value*, 16> Ops;
4088 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4089 Ops.push_back(getValue(Record, OpNum, NextValueNo,
4090 FTy->getParamType(i)));
4092 return error("Invalid record");
4095 if (!FTy->isVarArg()) {
4096 if (Record.size() != OpNum)
4097 return error("Invalid record");
4099 // Read type/value pairs for varargs params.
4100 while (OpNum != Record.size()) {
4102 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4103 return error("Invalid record");
4108 I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops);
4109 InstructionList.push_back(I);
4111 ->setCallingConv(static_cast<CallingConv::ID>(~(1U << 13) & CCInfo));
4112 cast<InvokeInst>(I)->setAttributes(PAL);
4115 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
4117 Value *Val = nullptr;
4118 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4119 return error("Invalid record");
4120 I = ResumeInst::Create(Val);
4121 InstructionList.push_back(I);
4124 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
4125 I = new UnreachableInst(Context);
4126 InstructionList.push_back(I);
4128 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
4129 if (Record.size() < 1 || ((Record.size()-1)&1))
4130 return error("Invalid record");
4131 Type *Ty = getTypeByID(Record[0]);
4133 return error("Invalid record");
4135 PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
4136 InstructionList.push_back(PN);
4138 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
4140 // With the new function encoding, it is possible that operands have
4141 // negative IDs (for forward references). Use a signed VBR
4142 // representation to keep the encoding small.
4144 V = getValueSigned(Record, 1+i, NextValueNo, Ty);
4146 V = getValue(Record, 1+i, NextValueNo, Ty);
4147 BasicBlock *BB = getBasicBlock(Record[2+i]);
4149 return error("Invalid record");
4150 PN->addIncoming(V, BB);
4156 case bitc::FUNC_CODE_INST_LANDINGPAD:
4157 case bitc::FUNC_CODE_INST_LANDINGPAD_OLD: {
4158 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
4160 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {
4161 if (Record.size() < 3)
4162 return error("Invalid record");
4164 assert(BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD);
4165 if (Record.size() < 4)
4166 return error("Invalid record");
4168 Type *Ty = getTypeByID(Record[Idx++]);
4170 return error("Invalid record");
4171 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {
4172 Value *PersFn = nullptr;
4173 if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
4174 return error("Invalid record");
4176 if (!F->hasPersonalityFn())
4177 F->setPersonalityFn(cast<Constant>(PersFn));
4178 else if (F->getPersonalityFn() != cast<Constant>(PersFn))
4179 return error("Personality function mismatch");
4182 bool IsCleanup = !!Record[Idx++];
4183 unsigned NumClauses = Record[Idx++];
4184 LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);
4185 LP->setCleanup(IsCleanup);
4186 for (unsigned J = 0; J != NumClauses; ++J) {
4187 LandingPadInst::ClauseType CT =
4188 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
4191 if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
4193 return error("Invalid record");
4196 assert((CT != LandingPadInst::Catch ||
4197 !isa<ArrayType>(Val->getType())) &&
4198 "Catch clause has a invalid type!");
4199 assert((CT != LandingPadInst::Filter ||
4200 isa<ArrayType>(Val->getType())) &&
4201 "Filter clause has invalid type!");
4202 LP->addClause(cast<Constant>(Val));
4206 InstructionList.push_back(I);
4210 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
4211 if (Record.size() != 4)
4212 return error("Invalid record");
4213 uint64_t AlignRecord = Record[3];
4214 const uint64_t InAllocaMask = uint64_t(1) << 5;
4215 const uint64_t ExplicitTypeMask = uint64_t(1) << 6;
4216 // Reserve bit 7 for SwiftError flag.
4217 // const uint64_t SwiftErrorMask = uint64_t(1) << 7;
4218 const uint64_t FlagMask = InAllocaMask | ExplicitTypeMask;
4219 bool InAlloca = AlignRecord & InAllocaMask;
4220 Type *Ty = getTypeByID(Record[0]);
4221 if ((AlignRecord & ExplicitTypeMask) == 0) {
4222 auto *PTy = dyn_cast_or_null<PointerType>(Ty);
4224 return error("Old-style alloca with a non-pointer type");
4225 Ty = PTy->getElementType();
4227 Type *OpTy = getTypeByID(Record[1]);
4228 Value *Size = getFnValueByID(Record[2], OpTy);
4230 if (std::error_code EC =
4231 parseAlignmentValue(AlignRecord & ~FlagMask, Align)) {
4235 return error("Invalid record");
4236 AllocaInst *AI = new AllocaInst(Ty, Size, Align);
4237 AI->setUsedWithInAlloca(InAlloca);
4239 InstructionList.push_back(I);
4242 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
4245 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4246 (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
4247 return error("Invalid record");
4250 if (OpNum + 3 == Record.size())
4251 Ty = getTypeByID(Record[OpNum++]);
4252 if (std::error_code EC =
4253 typeCheckLoadStoreInst(DiagnosticHandler, Ty, Op->getType()))
4256 Ty = cast<PointerType>(Op->getType())->getElementType();
4259 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4261 I = new LoadInst(Ty, Op, "", Record[OpNum + 1], Align);
4263 InstructionList.push_back(I);
4266 case bitc::FUNC_CODE_INST_LOADATOMIC: {
4267 // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
4270 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4271 (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
4272 return error("Invalid record");
4275 if (OpNum + 5 == Record.size())
4276 Ty = getTypeByID(Record[OpNum++]);
4277 if (std::error_code EC =
4278 typeCheckLoadStoreInst(DiagnosticHandler, Ty, Op->getType()))
4281 Ty = cast<PointerType>(Op->getType())->getElementType();
4283 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4284 if (Ordering == NotAtomic || Ordering == Release ||
4285 Ordering == AcquireRelease)
4286 return error("Invalid record");
4287 if (Ordering != NotAtomic && Record[OpNum] == 0)
4288 return error("Invalid record");
4289 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4292 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4294 I = new LoadInst(Op, "", Record[OpNum+1], Align, Ordering, SynchScope);
4296 InstructionList.push_back(I);
4299 case bitc::FUNC_CODE_INST_STORE:
4300 case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]
4303 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4304 (BitCode == bitc::FUNC_CODE_INST_STORE
4305 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4306 : popValue(Record, OpNum, NextValueNo,
4307 cast<PointerType>(Ptr->getType())->getElementType(),
4309 OpNum + 2 != Record.size())
4310 return error("Invalid record");
4312 if (std::error_code EC = typeCheckLoadStoreInst(
4313 DiagnosticHandler, Val->getType(), Ptr->getType()))
4316 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4318 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align);
4319 InstructionList.push_back(I);
4322 case bitc::FUNC_CODE_INST_STOREATOMIC:
4323 case bitc::FUNC_CODE_INST_STOREATOMIC_OLD: {
4324 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
4327 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4328 (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC
4329 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4330 : popValue(Record, OpNum, NextValueNo,
4331 cast<PointerType>(Ptr->getType())->getElementType(),
4333 OpNum + 4 != Record.size())
4334 return error("Invalid record");
4336 if (std::error_code EC = typeCheckLoadStoreInst(
4337 DiagnosticHandler, Val->getType(), Ptr->getType()))
4339 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4340 if (Ordering == NotAtomic || Ordering == Acquire ||
4341 Ordering == AcquireRelease)
4342 return error("Invalid record");
4343 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4344 if (Ordering != NotAtomic && Record[OpNum] == 0)
4345 return error("Invalid record");
4348 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4350 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align, Ordering, SynchScope);
4351 InstructionList.push_back(I);
4354 case bitc::FUNC_CODE_INST_CMPXCHG_OLD:
4355 case bitc::FUNC_CODE_INST_CMPXCHG: {
4356 // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
4357 // failureordering?, isweak?]
4359 Value *Ptr, *Cmp, *New;
4360 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4361 (BitCode == bitc::FUNC_CODE_INST_CMPXCHG
4362 ? getValueTypePair(Record, OpNum, NextValueNo, Cmp)
4363 : popValue(Record, OpNum, NextValueNo,
4364 cast<PointerType>(Ptr->getType())->getElementType(),
4366 popValue(Record, OpNum, NextValueNo, Cmp->getType(), New) ||
4367 Record.size() < OpNum + 3 || Record.size() > OpNum + 5)
4368 return error("Invalid record");
4369 AtomicOrdering SuccessOrdering = getDecodedOrdering(Record[OpNum + 1]);
4370 if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
4371 return error("Invalid record");
4372 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 2]);
4374 if (std::error_code EC = typeCheckLoadStoreInst(
4375 DiagnosticHandler, Cmp->getType(), Ptr->getType()))
4377 AtomicOrdering FailureOrdering;
4378 if (Record.size() < 7)
4380 AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
4382 FailureOrdering = getDecodedOrdering(Record[OpNum + 3]);
4384 I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
4386 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
4388 if (Record.size() < 8) {
4389 // Before weak cmpxchgs existed, the instruction simply returned the
4390 // value loaded from memory, so bitcode files from that era will be
4391 // expecting the first component of a modern cmpxchg.
4392 CurBB->getInstList().push_back(I);
4393 I = ExtractValueInst::Create(I, 0);
4395 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
4398 InstructionList.push_back(I);
4401 case bitc::FUNC_CODE_INST_ATOMICRMW: {
4402 // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
4405 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4406 popValue(Record, OpNum, NextValueNo,
4407 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
4408 OpNum+4 != Record.size())
4409 return error("Invalid record");
4410 AtomicRMWInst::BinOp Operation = getDecodedRMWOperation(Record[OpNum]);
4411 if (Operation < AtomicRMWInst::FIRST_BINOP ||
4412 Operation > AtomicRMWInst::LAST_BINOP)
4413 return error("Invalid record");
4414 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4415 if (Ordering == NotAtomic || Ordering == Unordered)
4416 return error("Invalid record");
4417 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4418 I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
4419 cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
4420 InstructionList.push_back(I);
4423 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
4424 if (2 != Record.size())
4425 return error("Invalid record");
4426 AtomicOrdering Ordering = getDecodedOrdering(Record[0]);
4427 if (Ordering == NotAtomic || Ordering == Unordered ||
4428 Ordering == Monotonic)
4429 return error("Invalid record");
4430 SynchronizationScope SynchScope = getDecodedSynchScope(Record[1]);
4431 I = new FenceInst(Context, Ordering, SynchScope);
4432 InstructionList.push_back(I);
4435 case bitc::FUNC_CODE_INST_CALL: {
4436 // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
4437 if (Record.size() < 3)
4438 return error("Invalid record");
4441 AttributeSet PAL = getAttributes(Record[OpNum++]);
4442 unsigned CCInfo = Record[OpNum++];
4444 FunctionType *FTy = nullptr;
4445 if (CCInfo >> 15 & 1 &&
4446 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
4447 return error("Explicit call type is not a function type");
4450 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
4451 return error("Invalid record");
4453 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
4455 return error("Callee is not a pointer type");
4457 FTy = dyn_cast<FunctionType>(OpTy->getElementType());
4459 return error("Callee is not of pointer to function type");
4460 } else if (OpTy->getElementType() != FTy)
4461 return error("Explicit call type does not match pointee type of "
4463 if (Record.size() < FTy->getNumParams() + OpNum)
4464 return error("Insufficient operands to call");
4466 SmallVector<Value*, 16> Args;
4467 // Read the fixed params.
4468 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4469 if (FTy->getParamType(i)->isLabelTy())
4470 Args.push_back(getBasicBlock(Record[OpNum]));
4472 Args.push_back(getValue(Record, OpNum, NextValueNo,
4473 FTy->getParamType(i)));
4475 return error("Invalid record");
4478 // Read type/value pairs for varargs params.
4479 if (!FTy->isVarArg()) {
4480 if (OpNum != Record.size())
4481 return error("Invalid record");
4483 while (OpNum != Record.size()) {
4485 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4486 return error("Invalid record");
4491 I = CallInst::Create(FTy, Callee, Args);
4492 InstructionList.push_back(I);
4493 cast<CallInst>(I)->setCallingConv(
4494 static_cast<CallingConv::ID>((~(1U << 14) & CCInfo) >> 1));
4495 CallInst::TailCallKind TCK = CallInst::TCK_None;
4497 TCK = CallInst::TCK_Tail;
4498 if (CCInfo & (1 << 14))
4499 TCK = CallInst::TCK_MustTail;
4500 cast<CallInst>(I)->setTailCallKind(TCK);
4501 cast<CallInst>(I)->setAttributes(PAL);
4504 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
4505 if (Record.size() < 3)
4506 return error("Invalid record");
4507 Type *OpTy = getTypeByID(Record[0]);
4508 Value *Op = getValue(Record, 1, NextValueNo, OpTy);
4509 Type *ResTy = getTypeByID(Record[2]);
4510 if (!OpTy || !Op || !ResTy)
4511 return error("Invalid record");
4512 I = new VAArgInst(Op, ResTy);
4513 InstructionList.push_back(I);
4518 // Add instruction to end of current BB. If there is no current BB, reject
4522 return error("Invalid instruction with no BB");
4524 CurBB->getInstList().push_back(I);
4526 // If this was a terminator instruction, move to the next block.
4527 if (isa<TerminatorInst>(I)) {
4529 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
4532 // Non-void values get registered in the value table for future use.
4533 if (I && !I->getType()->isVoidTy())
4534 ValueList.assignValue(I, NextValueNo++);
4539 // Check the function list for unresolved values.
4540 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
4541 if (!A->getParent()) {
4542 // We found at least one unresolved value. Nuke them all to avoid leaks.
4543 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
4544 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
4545 A->replaceAllUsesWith(UndefValue::get(A->getType()));
4549 return error("Never resolved value found in function");
4553 // FIXME: Check for unresolved forward-declared metadata references
4554 // and clean up leaks.
4556 // Trim the value list down to the size it was before we parsed this function.
4557 ValueList.shrinkTo(ModuleValueListSize);
4558 MDValueList.shrinkTo(ModuleMDValueListSize);
4559 std::vector<BasicBlock*>().swap(FunctionBBs);
4560 return std::error_code();
4563 /// Find the function body in the bitcode stream
4564 std::error_code BitcodeReader::findFunctionInStream(
4566 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
4567 while (DeferredFunctionInfoIterator->second == 0) {
4568 if (Stream.AtEndOfStream())
4569 return error("Could not find function in stream");
4570 // ParseModule will parse the next body in the stream and set its
4571 // position in the DeferredFunctionInfo map.
4572 if (std::error_code EC = parseModule(true))
4575 return std::error_code();
4578 //===----------------------------------------------------------------------===//
4579 // GVMaterializer implementation
4580 //===----------------------------------------------------------------------===//
4582 void BitcodeReader::releaseBuffer() { Buffer.release(); }
4584 std::error_code BitcodeReader::materialize(GlobalValue *GV) {
4585 if (std::error_code EC = materializeMetadata())
4588 Function *F = dyn_cast<Function>(GV);
4589 // If it's not a function or is already material, ignore the request.
4590 if (!F || !F->isMaterializable())
4591 return std::error_code();
4593 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
4594 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
4595 // If its position is recorded as 0, its body is somewhere in the stream
4596 // but we haven't seen it yet.
4597 if (DFII->second == 0)
4598 if (std::error_code EC = findFunctionInStream(F, DFII))
4601 // Move the bit stream to the saved position of the deferred function body.
4602 Stream.JumpToBit(DFII->second);
4604 if (std::error_code EC = parseFunctionBody(F))
4606 F->setIsMaterializable(false);
4611 // Upgrade any old intrinsic calls in the function.
4612 for (auto &I : UpgradedIntrinsics) {
4613 for (auto UI = I.first->user_begin(), UE = I.first->user_end(); UI != UE;) {
4616 if (CallInst *CI = dyn_cast<CallInst>(U))
4617 UpgradeIntrinsicCall(CI, I.second);
4621 // Bring in any functions that this function forward-referenced via
4623 return materializeForwardReferencedFunctions();
4626 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
4627 const Function *F = dyn_cast<Function>(GV);
4628 if (!F || F->isDeclaration())
4631 // Dematerializing F would leave dangling references that wouldn't be
4632 // reconnected on re-materialization.
4633 if (BlockAddressesTaken.count(F))
4636 return DeferredFunctionInfo.count(const_cast<Function*>(F));
4639 void BitcodeReader::dematerialize(GlobalValue *GV) {
4640 Function *F = dyn_cast<Function>(GV);
4641 // If this function isn't dematerializable, this is a noop.
4642 if (!F || !isDematerializable(F))
4645 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
4647 // Just forget the function body, we can remat it later.
4648 F->dropAllReferences();
4649 F->setIsMaterializable(true);
4652 std::error_code BitcodeReader::materializeModule(Module *M) {
4653 assert(M == TheModule &&
4654 "Can only Materialize the Module this BitcodeReader is attached to.");
4656 if (std::error_code EC = materializeMetadata())
4659 // Promise to materialize all forward references.
4660 WillMaterializeAllForwardRefs = true;
4662 // Iterate over the module, deserializing any functions that are still on
4664 for (Module::iterator F = TheModule->begin(), E = TheModule->end();
4666 if (std::error_code EC = materialize(F))
4669 // At this point, if there are any function bodies, the current bit is
4670 // pointing to the END_BLOCK record after them. Now make sure the rest
4671 // of the bits in the module have been read.
4675 // Check that all block address forward references got resolved (as we
4677 if (!BasicBlockFwdRefs.empty())
4678 return error("Never resolved function from blockaddress");
4680 // Upgrade any intrinsic calls that slipped through (should not happen!) and
4681 // delete the old functions to clean up. We can't do this unless the entire
4682 // module is materialized because there could always be another function body
4683 // with calls to the old function.
4684 for (auto &I : UpgradedIntrinsics) {
4685 for (auto *U : I.first->users()) {
4686 if (CallInst *CI = dyn_cast<CallInst>(U))
4687 UpgradeIntrinsicCall(CI, I.second);
4689 if (!I.first->use_empty())
4690 I.first->replaceAllUsesWith(I.second);
4691 I.first->eraseFromParent();
4693 UpgradedIntrinsics.clear();
4695 for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
4696 UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
4698 UpgradeDebugInfo(*M);
4699 return std::error_code();
4702 std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
4703 return IdentifiedStructTypes;
4707 BitcodeReader::initStream(std::unique_ptr<DataStreamer> Streamer) {
4709 return initLazyStream(std::move(Streamer));
4710 return initStreamFromBuffer();
4713 std::error_code BitcodeReader::initStreamFromBuffer() {
4714 const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
4715 const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
4717 if (Buffer->getBufferSize() & 3)
4718 return error("Invalid bitcode signature");
4720 // If we have a wrapper header, parse it and ignore the non-bc file contents.
4721 // The magic number is 0x0B17C0DE stored in little endian.
4722 if (isBitcodeWrapper(BufPtr, BufEnd))
4723 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
4724 return error("Invalid bitcode wrapper header");
4726 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
4727 Stream.init(&*StreamFile);
4729 return std::error_code();
4733 BitcodeReader::initLazyStream(std::unique_ptr<DataStreamer> Streamer) {
4734 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
4737 llvm::make_unique<StreamingMemoryObject>(std::move(Streamer));
4738 StreamingMemoryObject &Bytes = *OwnedBytes;
4739 StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
4740 Stream.init(&*StreamFile);
4742 unsigned char buf[16];
4743 if (Bytes.readBytes(buf, 16, 0) != 16)
4744 return error("Invalid bitcode signature");
4746 if (!isBitcode(buf, buf + 16))
4747 return error("Invalid bitcode signature");
4749 if (isBitcodeWrapper(buf, buf + 4)) {
4750 const unsigned char *bitcodeStart = buf;
4751 const unsigned char *bitcodeEnd = buf + 16;
4752 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
4753 Bytes.dropLeadingBytes(bitcodeStart - buf);
4754 Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
4756 return std::error_code();
4760 class BitcodeErrorCategoryType : public std::error_category {
4761 const char *name() const LLVM_NOEXCEPT override {
4762 return "llvm.bitcode";
4764 std::string message(int IE) const override {
4765 BitcodeError E = static_cast<BitcodeError>(IE);
4767 case BitcodeError::InvalidBitcodeSignature:
4768 return "Invalid bitcode signature";
4769 case BitcodeError::CorruptedBitcode:
4770 return "Corrupted bitcode";
4772 llvm_unreachable("Unknown error type!");
4777 static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
4779 const std::error_category &llvm::BitcodeErrorCategory() {
4780 return *ErrorCategory;
4783 //===----------------------------------------------------------------------===//
4784 // External interface
4785 //===----------------------------------------------------------------------===//
4787 static ErrorOr<std::unique_ptr<Module>>
4788 getBitcodeModuleImpl(std::unique_ptr<DataStreamer> Streamer, StringRef Name,
4789 BitcodeReader *R, LLVMContext &Context,
4790 bool MaterializeAll, bool ShouldLazyLoadMetadata) {
4791 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
4792 M->setMaterializer(R);
4794 auto cleanupOnError = [&](std::error_code EC) {
4795 R->releaseBuffer(); // Never take ownership on error.
4799 // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
4800 if (std::error_code EC = R->parseBitcodeInto(std::move(Streamer), M.get(),
4801 ShouldLazyLoadMetadata))
4802 return cleanupOnError(EC);
4804 if (MaterializeAll) {
4805 // Read in the entire module, and destroy the BitcodeReader.
4806 if (std::error_code EC = M->materializeAllPermanently())
4807 return cleanupOnError(EC);
4809 // Resolve forward references from blockaddresses.
4810 if (std::error_code EC = R->materializeForwardReferencedFunctions())
4811 return cleanupOnError(EC);
4813 return std::move(M);
4816 /// \brief Get a lazy one-at-time loading module from bitcode.
4818 /// This isn't always used in a lazy context. In particular, it's also used by
4819 /// \a parseBitcodeFile(). If this is truly lazy, then we need to eagerly pull
4820 /// in forward-referenced functions from block address references.
4822 /// \param[in] MaterializeAll Set to \c true if we should materialize
4824 static ErrorOr<std::unique_ptr<Module>>
4825 getLazyBitcodeModuleImpl(std::unique_ptr<MemoryBuffer> &&Buffer,
4826 LLVMContext &Context, bool MaterializeAll,
4827 DiagnosticHandlerFunction DiagnosticHandler,
4828 bool ShouldLazyLoadMetadata = false) {
4830 new BitcodeReader(Buffer.get(), Context, DiagnosticHandler);
4832 ErrorOr<std::unique_ptr<Module>> Ret =
4833 getBitcodeModuleImpl(nullptr, Buffer->getBufferIdentifier(), R, Context,
4834 MaterializeAll, ShouldLazyLoadMetadata);
4838 Buffer.release(); // The BitcodeReader owns it now.
4842 ErrorOr<std::unique_ptr<Module>> llvm::getLazyBitcodeModule(
4843 std::unique_ptr<MemoryBuffer> &&Buffer, LLVMContext &Context,
4844 DiagnosticHandlerFunction DiagnosticHandler, bool ShouldLazyLoadMetadata) {
4845 return getLazyBitcodeModuleImpl(std::move(Buffer), Context, false,
4846 DiagnosticHandler, ShouldLazyLoadMetadata);
4849 ErrorOr<std::unique_ptr<Module>> llvm::getStreamedBitcodeModule(
4850 StringRef Name, std::unique_ptr<DataStreamer> Streamer,
4851 LLVMContext &Context, DiagnosticHandlerFunction DiagnosticHandler) {
4852 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
4853 BitcodeReader *R = new BitcodeReader(Context, DiagnosticHandler);
4855 return getBitcodeModuleImpl(std::move(Streamer), Name, R, Context, false,
4859 ErrorOr<std::unique_ptr<Module>>
4860 llvm::parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context,
4861 DiagnosticHandlerFunction DiagnosticHandler) {
4862 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
4863 return getLazyBitcodeModuleImpl(std::move(Buf), Context, true,
4865 // TODO: Restore the use-lists to the in-memory state when the bitcode was
4866 // written. We must defer until the Module has been fully materialized.
4870 llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer, LLVMContext &Context,
4871 DiagnosticHandlerFunction DiagnosticHandler) {
4872 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
4873 auto R = llvm::make_unique<BitcodeReader>(Buf.release(), Context,
4875 ErrorOr<std::string> Triple = R->parseTriple();
4876 if (Triple.getError())
4878 return Triple.get();