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/FunctionInfo.h"
31 #include "llvm/IR/ValueHandle.h"
32 #include "llvm/Support/DataStream.h"
33 #include "llvm/Support/ManagedStatic.h"
34 #include "llvm/Support/MathExtras.h"
35 #include "llvm/Support/MemoryBuffer.h"
36 #include "llvm/Support/raw_ostream.h"
42 SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
45 /// Indicates which operator an operand allows (for the few operands that may
46 /// only reference a certain operator).
47 enum OperatorConstraint {
48 OC_None = 0, // No constraint
49 OC_CatchPad, // Must be CatchPadInst
50 OC_CleanupPad // Must be CleanupPadInst
53 class BitcodeReaderValueList {
54 std::vector<WeakVH> ValuePtrs;
56 /// As we resolve forward-referenced constants, we add information about them
57 /// to this vector. This allows us to resolve them in bulk instead of
58 /// resolving each reference at a time. See the code in
59 /// ResolveConstantForwardRefs for more information about this.
61 /// The key of this vector is the placeholder constant, the value is the slot
62 /// number that holds the resolved value.
63 typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy;
64 ResolveConstantsTy ResolveConstants;
67 BitcodeReaderValueList(LLVMContext &C) : Context(C) {}
68 ~BitcodeReaderValueList() {
69 assert(ResolveConstants.empty() && "Constants not resolved?");
72 // vector compatibility methods
73 unsigned size() const { return ValuePtrs.size(); }
74 void resize(unsigned N) { ValuePtrs.resize(N); }
75 void push_back(Value *V) { ValuePtrs.emplace_back(V); }
78 assert(ResolveConstants.empty() && "Constants not resolved?");
82 Value *operator[](unsigned i) const {
83 assert(i < ValuePtrs.size());
87 Value *back() const { return ValuePtrs.back(); }
88 void pop_back() { ValuePtrs.pop_back(); }
89 bool empty() const { return ValuePtrs.empty(); }
90 void shrinkTo(unsigned N) {
91 assert(N <= size() && "Invalid shrinkTo request!");
95 Constant *getConstantFwdRef(unsigned Idx, Type *Ty);
96 Value *getValueFwdRef(unsigned Idx, Type *Ty,
97 OperatorConstraint OC = OC_None);
99 bool assignValue(Value *V, unsigned Idx);
101 /// Once all constants are read, this method bulk resolves any forward
103 void resolveConstantForwardRefs();
106 class BitcodeReaderMDValueList {
111 std::vector<TrackingMDRef> MDValuePtrs;
113 LLVMContext &Context;
115 BitcodeReaderMDValueList(LLVMContext &C)
116 : NumFwdRefs(0), AnyFwdRefs(false), Context(C) {}
118 // vector compatibility methods
119 unsigned size() const { return MDValuePtrs.size(); }
120 void resize(unsigned N) { MDValuePtrs.resize(N); }
121 void push_back(Metadata *MD) { MDValuePtrs.emplace_back(MD); }
122 void clear() { MDValuePtrs.clear(); }
123 Metadata *back() const { return MDValuePtrs.back(); }
124 void pop_back() { MDValuePtrs.pop_back(); }
125 bool empty() const { return MDValuePtrs.empty(); }
127 Metadata *operator[](unsigned i) const {
128 assert(i < MDValuePtrs.size());
129 return MDValuePtrs[i];
132 void shrinkTo(unsigned N) {
133 assert(N <= size() && "Invalid shrinkTo request!");
134 MDValuePtrs.resize(N);
137 Metadata *getValueFwdRef(unsigned Idx);
138 void assignValue(Metadata *MD, unsigned Idx);
139 void tryToResolveCycles();
142 class BitcodeReader : public GVMaterializer {
143 LLVMContext &Context;
144 DiagnosticHandlerFunction DiagnosticHandler;
145 Module *TheModule = nullptr;
146 std::unique_ptr<MemoryBuffer> Buffer;
147 std::unique_ptr<BitstreamReader> StreamFile;
148 BitstreamCursor Stream;
149 // Next offset to start scanning for lazy parsing of function bodies.
150 uint64_t NextUnreadBit = 0;
151 // Last function offset found in the VST.
152 uint64_t LastFunctionBlockBit = 0;
153 bool SeenValueSymbolTable = false;
154 uint64_t VSTOffset = 0;
155 // Contains an arbitrary and optional string identifying the bitcode producer
156 std::string ProducerIdentification;
158 std::vector<Type*> TypeList;
159 BitcodeReaderValueList ValueList;
160 BitcodeReaderMDValueList MDValueList;
161 std::vector<Comdat *> ComdatList;
162 SmallVector<Instruction *, 64> InstructionList;
164 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
165 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits;
166 std::vector<std::pair<Function*, unsigned> > FunctionPrefixes;
167 std::vector<std::pair<Function*, unsigned> > FunctionPrologues;
168 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFns;
170 SmallVector<Instruction*, 64> InstsWithTBAATag;
172 /// The set of attributes by index. Index zero in the file is for null, and
173 /// is thus not represented here. As such all indices are off by one.
174 std::vector<AttributeSet> MAttributes;
176 /// The set of attribute groups.
177 std::map<unsigned, AttributeSet> MAttributeGroups;
179 /// While parsing a function body, this is a list of the basic blocks for the
181 std::vector<BasicBlock*> FunctionBBs;
183 // When reading the module header, this list is populated with functions that
184 // have bodies later in the file.
185 std::vector<Function*> FunctionsWithBodies;
187 // When intrinsic functions are encountered which require upgrading they are
188 // stored here with their replacement function.
189 typedef DenseMap<Function*, Function*> UpgradedIntrinsicMap;
190 UpgradedIntrinsicMap UpgradedIntrinsics;
192 // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
193 DenseMap<unsigned, unsigned> MDKindMap;
195 // Several operations happen after the module header has been read, but
196 // before function bodies are processed. This keeps track of whether
197 // we've done this yet.
198 bool SeenFirstFunctionBody = false;
200 /// When function bodies are initially scanned, this map contains info about
201 /// where to find deferred function body in the stream.
202 DenseMap<Function*, uint64_t> DeferredFunctionInfo;
204 /// When Metadata block is initially scanned when parsing the module, we may
205 /// choose to defer parsing of the metadata. This vector contains info about
206 /// which Metadata blocks are deferred.
207 std::vector<uint64_t> DeferredMetadataInfo;
209 /// These are basic blocks forward-referenced by block addresses. They are
210 /// inserted lazily into functions when they're loaded. The basic block ID is
211 /// its index into the vector.
212 DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
213 std::deque<Function *> BasicBlockFwdRefQueue;
215 /// Indicates that we are using a new encoding for instruction operands where
216 /// most operands in the current FUNCTION_BLOCK are encoded relative to the
217 /// instruction number, for a more compact encoding. Some instruction
218 /// operands are not relative to the instruction ID: basic block numbers, and
219 /// types. Once the old style function blocks have been phased out, we would
220 /// not need this flag.
221 bool UseRelativeIDs = false;
223 /// True if all functions will be materialized, negating the need to process
224 /// (e.g.) blockaddress forward references.
225 bool WillMaterializeAllForwardRefs = false;
227 /// Functions that have block addresses taken. This is usually empty.
228 SmallPtrSet<const Function *, 4> BlockAddressesTaken;
230 /// True if any Metadata block has been materialized.
231 bool IsMetadataMaterialized = false;
233 bool StripDebugInfo = false;
235 std::vector<std::string> BundleTags;
238 std::error_code error(BitcodeError E, const Twine &Message);
239 std::error_code error(BitcodeError E);
240 std::error_code error(const Twine &Message);
242 BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context,
243 DiagnosticHandlerFunction DiagnosticHandler);
244 BitcodeReader(LLVMContext &Context,
245 DiagnosticHandlerFunction DiagnosticHandler);
246 ~BitcodeReader() override { freeState(); }
248 std::error_code materializeForwardReferencedFunctions();
252 void releaseBuffer();
254 bool isDematerializable(const GlobalValue *GV) const override;
255 std::error_code materialize(GlobalValue *GV) override;
256 std::error_code materializeModule(Module *M) override;
257 std::vector<StructType *> getIdentifiedStructTypes() const override;
258 void dematerialize(GlobalValue *GV) override;
260 /// \brief Main interface to parsing a bitcode buffer.
261 /// \returns true if an error occurred.
262 std::error_code parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
264 bool ShouldLazyLoadMetadata = false);
266 /// \brief Cheap mechanism to just extract module triple
267 /// \returns true if an error occurred.
268 ErrorOr<std::string> parseTriple();
270 static uint64_t decodeSignRotatedValue(uint64_t V);
272 /// Materialize any deferred Metadata block.
273 std::error_code materializeMetadata() override;
275 void setStripDebugInfo() override;
278 /// Parse the "IDENTIFICATION_BLOCK_ID" block, populate the
279 // ProducerIdentification data member, and do some basic enforcement on the
280 // "epoch" encoded in the bitcode.
281 std::error_code parseBitcodeVersion();
283 std::vector<StructType *> IdentifiedStructTypes;
284 StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
285 StructType *createIdentifiedStructType(LLVMContext &Context);
287 Type *getTypeByID(unsigned ID);
288 Value *getFnValueByID(unsigned ID, Type *Ty,
289 OperatorConstraint OC = OC_None) {
290 if (Ty && Ty->isMetadataTy())
291 return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
292 return ValueList.getValueFwdRef(ID, Ty, OC);
294 Metadata *getFnMetadataByID(unsigned ID) {
295 return MDValueList.getValueFwdRef(ID);
297 BasicBlock *getBasicBlock(unsigned ID) const {
298 if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
299 return FunctionBBs[ID];
301 AttributeSet getAttributes(unsigned i) const {
302 if (i-1 < MAttributes.size())
303 return MAttributes[i-1];
304 return AttributeSet();
307 /// Read a value/type pair out of the specified record from slot 'Slot'.
308 /// Increment Slot past the number of slots used in the record. Return true on
310 bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
311 unsigned InstNum, Value *&ResVal) {
312 if (Slot == Record.size()) return true;
313 unsigned ValNo = (unsigned)Record[Slot++];
314 // Adjust the ValNo, if it was encoded relative to the InstNum.
316 ValNo = InstNum - ValNo;
317 if (ValNo < InstNum) {
318 // If this is not a forward reference, just return the value we already
320 ResVal = getFnValueByID(ValNo, nullptr);
321 return ResVal == nullptr;
323 if (Slot == Record.size())
326 unsigned TypeNo = (unsigned)Record[Slot++];
327 ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
328 return ResVal == nullptr;
331 /// Read a value out of the specified record from slot 'Slot'. Increment Slot
332 /// past the number of slots used by the value in the record. Return true if
333 /// there is an error.
334 bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
335 unsigned InstNum, Type *Ty, Value *&ResVal,
336 OperatorConstraint OC = OC_None) {
337 if (getValue(Record, Slot, InstNum, Ty, ResVal, OC))
339 // All values currently take a single record slot.
344 /// Like popValue, but does not increment the Slot number.
345 bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
346 unsigned InstNum, Type *Ty, Value *&ResVal,
347 OperatorConstraint OC = OC_None) {
348 ResVal = getValue(Record, Slot, InstNum, Ty, OC);
349 return ResVal == nullptr;
352 /// Version of getValue that returns ResVal directly, or 0 if there is an
354 Value *getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
355 unsigned InstNum, Type *Ty, OperatorConstraint OC = OC_None) {
356 if (Slot == Record.size()) return nullptr;
357 unsigned ValNo = (unsigned)Record[Slot];
358 // Adjust the ValNo, if it was encoded relative to the InstNum.
360 ValNo = InstNum - ValNo;
361 return getFnValueByID(ValNo, Ty, OC);
364 /// Like getValue, but decodes signed VBRs.
365 Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
366 unsigned InstNum, Type *Ty,
367 OperatorConstraint OC = OC_None) {
368 if (Slot == Record.size()) return nullptr;
369 unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
370 // Adjust the ValNo, if it was encoded relative to the InstNum.
372 ValNo = InstNum - ValNo;
373 return getFnValueByID(ValNo, Ty, OC);
376 /// Converts alignment exponent (i.e. power of two (or zero)) to the
377 /// corresponding alignment to use. If alignment is too large, returns
378 /// a corresponding error code.
379 std::error_code parseAlignmentValue(uint64_t Exponent, unsigned &Alignment);
380 std::error_code parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
381 std::error_code parseModule(uint64_t ResumeBit,
382 bool ShouldLazyLoadMetadata = false);
383 std::error_code parseAttributeBlock();
384 std::error_code parseAttributeGroupBlock();
385 std::error_code parseTypeTable();
386 std::error_code parseTypeTableBody();
387 std::error_code parseOperandBundleTags();
389 ErrorOr<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,
390 unsigned NameIndex, Triple &TT);
391 std::error_code parseValueSymbolTable(uint64_t Offset = 0);
392 std::error_code parseConstants();
393 std::error_code rememberAndSkipFunctionBodies();
394 std::error_code rememberAndSkipFunctionBody();
395 /// Save the positions of the Metadata blocks and skip parsing the blocks.
396 std::error_code rememberAndSkipMetadata();
397 std::error_code parseFunctionBody(Function *F);
398 std::error_code globalCleanup();
399 std::error_code resolveGlobalAndAliasInits();
400 std::error_code parseMetadata();
401 std::error_code parseMetadataAttachment(Function &F);
402 ErrorOr<std::string> parseModuleTriple();
403 std::error_code parseUseLists();
404 std::error_code initStream(std::unique_ptr<DataStreamer> Streamer);
405 std::error_code initStreamFromBuffer();
406 std::error_code initLazyStream(std::unique_ptr<DataStreamer> Streamer);
407 std::error_code findFunctionInStream(
409 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
412 /// Class to manage reading and parsing function summary index bitcode
414 class FunctionIndexBitcodeReader {
415 DiagnosticHandlerFunction DiagnosticHandler;
417 /// Eventually points to the function index built during parsing.
418 FunctionInfoIndex *TheIndex = nullptr;
420 std::unique_ptr<MemoryBuffer> Buffer;
421 std::unique_ptr<BitstreamReader> StreamFile;
422 BitstreamCursor Stream;
424 /// \brief Used to indicate whether we are doing lazy parsing of summary data.
426 /// If false, the summary section is fully parsed into the index during
427 /// the initial parse. Otherwise, if true, the caller is expected to
428 /// invoke \a readFunctionSummary for each summary needed, and the summary
429 /// section is thus parsed lazily.
432 /// Used to indicate whether caller only wants to check for the presence
433 /// of the function summary bitcode section. All blocks are skipped,
434 /// but the SeenFuncSummary boolean is set.
435 bool CheckFuncSummaryPresenceOnly = false;
437 /// Indicates whether we have encountered a function summary section
438 /// yet during parsing, used when checking if file contains function
440 bool SeenFuncSummary = false;
442 /// \brief Map populated during function summary section parsing, and
443 /// consumed during ValueSymbolTable parsing.
445 /// Used to correlate summary records with VST entries. For the per-module
446 /// index this maps the ValueID to the parsed function summary, and
447 /// for the combined index this maps the summary record's bitcode
448 /// offset to the function summary (since in the combined index the
449 /// VST records do not hold value IDs but rather hold the function
450 /// summary record offset).
451 DenseMap<uint64_t, std::unique_ptr<FunctionSummary>> SummaryMap;
453 /// Map populated during module path string table parsing, from the
454 /// module ID to a string reference owned by the index's module
455 /// path string table, used to correlate with combined index function
457 DenseMap<uint64_t, StringRef> ModuleIdMap;
460 std::error_code error(BitcodeError E, const Twine &Message);
461 std::error_code error(BitcodeError E);
462 std::error_code error(const Twine &Message);
464 FunctionIndexBitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context,
465 DiagnosticHandlerFunction DiagnosticHandler,
467 bool CheckFuncSummaryPresenceOnly = false);
468 FunctionIndexBitcodeReader(LLVMContext &Context,
469 DiagnosticHandlerFunction DiagnosticHandler,
471 bool CheckFuncSummaryPresenceOnly = false);
472 ~FunctionIndexBitcodeReader() { freeState(); }
476 void releaseBuffer();
478 /// Check if the parser has encountered a function summary section.
479 bool foundFuncSummary() { return SeenFuncSummary; }
481 /// \brief Main interface to parsing a bitcode buffer.
482 /// \returns true if an error occurred.
483 std::error_code parseSummaryIndexInto(std::unique_ptr<DataStreamer> Streamer,
484 FunctionInfoIndex *I);
486 /// \brief Interface for parsing a function summary lazily.
487 std::error_code parseFunctionSummary(std::unique_ptr<DataStreamer> Streamer,
488 FunctionInfoIndex *I,
489 size_t FunctionSummaryOffset);
492 std::error_code parseModule();
493 std::error_code parseValueSymbolTable();
494 std::error_code parseEntireSummary();
495 std::error_code parseModuleStringTable();
496 std::error_code initStream(std::unique_ptr<DataStreamer> Streamer);
497 std::error_code initStreamFromBuffer();
498 std::error_code initLazyStream(std::unique_ptr<DataStreamer> Streamer);
502 BitcodeDiagnosticInfo::BitcodeDiagnosticInfo(std::error_code EC,
503 DiagnosticSeverity Severity,
505 : DiagnosticInfo(DK_Bitcode, Severity), Msg(Msg), EC(EC) {}
507 void BitcodeDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
509 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
510 std::error_code EC, const Twine &Message) {
511 BitcodeDiagnosticInfo DI(EC, DS_Error, Message);
512 DiagnosticHandler(DI);
516 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
517 std::error_code EC) {
518 return error(DiagnosticHandler, EC, EC.message());
521 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
522 const Twine &Message) {
523 return error(DiagnosticHandler,
524 make_error_code(BitcodeError::CorruptedBitcode), Message);
527 std::error_code BitcodeReader::error(BitcodeError E, const Twine &Message) {
528 if (!ProducerIdentification.empty()) {
529 return ::error(DiagnosticHandler, make_error_code(E),
530 Message + " (Producer: '" + ProducerIdentification +
531 "' Reader: 'LLVM " + LLVM_VERSION_STRING "')");
533 return ::error(DiagnosticHandler, make_error_code(E), Message);
536 std::error_code BitcodeReader::error(const Twine &Message) {
537 if (!ProducerIdentification.empty()) {
538 return ::error(DiagnosticHandler,
539 make_error_code(BitcodeError::CorruptedBitcode),
540 Message + " (Producer: '" + ProducerIdentification +
541 "' Reader: 'LLVM " + LLVM_VERSION_STRING "')");
543 return ::error(DiagnosticHandler,
544 make_error_code(BitcodeError::CorruptedBitcode), Message);
547 std::error_code BitcodeReader::error(BitcodeError E) {
548 return ::error(DiagnosticHandler, make_error_code(E));
551 static DiagnosticHandlerFunction getDiagHandler(DiagnosticHandlerFunction F,
555 return [&C](const DiagnosticInfo &DI) { C.diagnose(DI); };
558 BitcodeReader::BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context,
559 DiagnosticHandlerFunction DiagnosticHandler)
561 DiagnosticHandler(getDiagHandler(DiagnosticHandler, Context)),
562 Buffer(Buffer), ValueList(Context), MDValueList(Context) {}
564 BitcodeReader::BitcodeReader(LLVMContext &Context,
565 DiagnosticHandlerFunction DiagnosticHandler)
567 DiagnosticHandler(getDiagHandler(DiagnosticHandler, Context)),
568 Buffer(nullptr), ValueList(Context), MDValueList(Context) {}
570 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
571 if (WillMaterializeAllForwardRefs)
572 return std::error_code();
574 // Prevent recursion.
575 WillMaterializeAllForwardRefs = true;
577 while (!BasicBlockFwdRefQueue.empty()) {
578 Function *F = BasicBlockFwdRefQueue.front();
579 BasicBlockFwdRefQueue.pop_front();
580 assert(F && "Expected valid function");
581 if (!BasicBlockFwdRefs.count(F))
582 // Already materialized.
585 // Check for a function that isn't materializable to prevent an infinite
586 // loop. When parsing a blockaddress stored in a global variable, there
587 // isn't a trivial way to check if a function will have a body without a
588 // linear search through FunctionsWithBodies, so just check it here.
589 if (!F->isMaterializable())
590 return error("Never resolved function from blockaddress");
592 // Try to materialize F.
593 if (std::error_code EC = materialize(F))
596 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
599 WillMaterializeAllForwardRefs = false;
600 return std::error_code();
603 void BitcodeReader::freeState() {
605 std::vector<Type*>().swap(TypeList);
608 std::vector<Comdat *>().swap(ComdatList);
610 std::vector<AttributeSet>().swap(MAttributes);
611 std::vector<BasicBlock*>().swap(FunctionBBs);
612 std::vector<Function*>().swap(FunctionsWithBodies);
613 DeferredFunctionInfo.clear();
614 DeferredMetadataInfo.clear();
617 assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
618 BasicBlockFwdRefQueue.clear();
621 //===----------------------------------------------------------------------===//
622 // Helper functions to implement forward reference resolution, etc.
623 //===----------------------------------------------------------------------===//
625 /// Convert a string from a record into an std::string, return true on failure.
626 template <typename StrTy>
627 static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
629 if (Idx > Record.size())
632 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
633 Result += (char)Record[i];
637 static bool hasImplicitComdat(size_t Val) {
641 case 1: // Old WeakAnyLinkage
642 case 4: // Old LinkOnceAnyLinkage
643 case 10: // Old WeakODRLinkage
644 case 11: // Old LinkOnceODRLinkage
649 static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
651 default: // Map unknown/new linkages to external
653 return GlobalValue::ExternalLinkage;
655 return GlobalValue::AppendingLinkage;
657 return GlobalValue::InternalLinkage;
659 return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
661 return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
663 return GlobalValue::ExternalWeakLinkage;
665 return GlobalValue::CommonLinkage;
667 return GlobalValue::PrivateLinkage;
669 return GlobalValue::AvailableExternallyLinkage;
671 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
673 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
675 return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
676 case 1: // Old value with implicit comdat.
678 return GlobalValue::WeakAnyLinkage;
679 case 10: // Old value with implicit comdat.
681 return GlobalValue::WeakODRLinkage;
682 case 4: // Old value with implicit comdat.
684 return GlobalValue::LinkOnceAnyLinkage;
685 case 11: // Old value with implicit comdat.
687 return GlobalValue::LinkOnceODRLinkage;
691 static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {
693 default: // Map unknown visibilities to default.
694 case 0: return GlobalValue::DefaultVisibility;
695 case 1: return GlobalValue::HiddenVisibility;
696 case 2: return GlobalValue::ProtectedVisibility;
700 static GlobalValue::DLLStorageClassTypes
701 getDecodedDLLStorageClass(unsigned Val) {
703 default: // Map unknown values to default.
704 case 0: return GlobalValue::DefaultStorageClass;
705 case 1: return GlobalValue::DLLImportStorageClass;
706 case 2: return GlobalValue::DLLExportStorageClass;
710 static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {
712 case 0: return GlobalVariable::NotThreadLocal;
713 default: // Map unknown non-zero value to general dynamic.
714 case 1: return GlobalVariable::GeneralDynamicTLSModel;
715 case 2: return GlobalVariable::LocalDynamicTLSModel;
716 case 3: return GlobalVariable::InitialExecTLSModel;
717 case 4: return GlobalVariable::LocalExecTLSModel;
721 static int getDecodedCastOpcode(unsigned Val) {
724 case bitc::CAST_TRUNC : return Instruction::Trunc;
725 case bitc::CAST_ZEXT : return Instruction::ZExt;
726 case bitc::CAST_SEXT : return Instruction::SExt;
727 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
728 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
729 case bitc::CAST_UITOFP : return Instruction::UIToFP;
730 case bitc::CAST_SITOFP : return Instruction::SIToFP;
731 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
732 case bitc::CAST_FPEXT : return Instruction::FPExt;
733 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
734 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
735 case bitc::CAST_BITCAST : return Instruction::BitCast;
736 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
740 static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
741 bool IsFP = Ty->isFPOrFPVectorTy();
742 // BinOps are only valid for int/fp or vector of int/fp types
743 if (!IsFP && !Ty->isIntOrIntVectorTy())
749 case bitc::BINOP_ADD:
750 return IsFP ? Instruction::FAdd : Instruction::Add;
751 case bitc::BINOP_SUB:
752 return IsFP ? Instruction::FSub : Instruction::Sub;
753 case bitc::BINOP_MUL:
754 return IsFP ? Instruction::FMul : Instruction::Mul;
755 case bitc::BINOP_UDIV:
756 return IsFP ? -1 : Instruction::UDiv;
757 case bitc::BINOP_SDIV:
758 return IsFP ? Instruction::FDiv : Instruction::SDiv;
759 case bitc::BINOP_UREM:
760 return IsFP ? -1 : Instruction::URem;
761 case bitc::BINOP_SREM:
762 return IsFP ? Instruction::FRem : Instruction::SRem;
763 case bitc::BINOP_SHL:
764 return IsFP ? -1 : Instruction::Shl;
765 case bitc::BINOP_LSHR:
766 return IsFP ? -1 : Instruction::LShr;
767 case bitc::BINOP_ASHR:
768 return IsFP ? -1 : Instruction::AShr;
769 case bitc::BINOP_AND:
770 return IsFP ? -1 : Instruction::And;
772 return IsFP ? -1 : Instruction::Or;
773 case bitc::BINOP_XOR:
774 return IsFP ? -1 : Instruction::Xor;
778 static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {
780 default: return AtomicRMWInst::BAD_BINOP;
781 case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
782 case bitc::RMW_ADD: return AtomicRMWInst::Add;
783 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
784 case bitc::RMW_AND: return AtomicRMWInst::And;
785 case bitc::RMW_NAND: return AtomicRMWInst::Nand;
786 case bitc::RMW_OR: return AtomicRMWInst::Or;
787 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
788 case bitc::RMW_MAX: return AtomicRMWInst::Max;
789 case bitc::RMW_MIN: return AtomicRMWInst::Min;
790 case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
791 case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
795 static AtomicOrdering getDecodedOrdering(unsigned Val) {
797 case bitc::ORDERING_NOTATOMIC: return NotAtomic;
798 case bitc::ORDERING_UNORDERED: return Unordered;
799 case bitc::ORDERING_MONOTONIC: return Monotonic;
800 case bitc::ORDERING_ACQUIRE: return Acquire;
801 case bitc::ORDERING_RELEASE: return Release;
802 case bitc::ORDERING_ACQREL: return AcquireRelease;
803 default: // Map unknown orderings to sequentially-consistent.
804 case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
808 static SynchronizationScope getDecodedSynchScope(unsigned Val) {
810 case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
811 default: // Map unknown scopes to cross-thread.
812 case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
816 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
818 default: // Map unknown selection kinds to any.
819 case bitc::COMDAT_SELECTION_KIND_ANY:
821 case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
822 return Comdat::ExactMatch;
823 case bitc::COMDAT_SELECTION_KIND_LARGEST:
824 return Comdat::Largest;
825 case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
826 return Comdat::NoDuplicates;
827 case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
828 return Comdat::SameSize;
832 static FastMathFlags getDecodedFastMathFlags(unsigned Val) {
834 if (0 != (Val & FastMathFlags::UnsafeAlgebra))
835 FMF.setUnsafeAlgebra();
836 if (0 != (Val & FastMathFlags::NoNaNs))
838 if (0 != (Val & FastMathFlags::NoInfs))
840 if (0 != (Val & FastMathFlags::NoSignedZeros))
841 FMF.setNoSignedZeros();
842 if (0 != (Val & FastMathFlags::AllowReciprocal))
843 FMF.setAllowReciprocal();
847 static void upgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
849 case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
850 case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
856 /// \brief A class for maintaining the slot number definition
857 /// as a placeholder for the actual definition for forward constants defs.
858 class ConstantPlaceHolder : public ConstantExpr {
859 void operator=(const ConstantPlaceHolder &) = delete;
862 // allocate space for exactly one operand
863 void *operator new(size_t s) { return User::operator new(s, 1); }
864 explicit ConstantPlaceHolder(Type *Ty, LLVMContext &Context)
865 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
866 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
869 /// \brief Methods to support type inquiry through isa, cast, and dyn_cast.
870 static bool classof(const Value *V) {
871 return isa<ConstantExpr>(V) &&
872 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
875 /// Provide fast operand accessors
876 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
880 // FIXME: can we inherit this from ConstantExpr?
882 struct OperandTraits<ConstantPlaceHolder> :
883 public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
885 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantPlaceHolder, Value)
888 bool BitcodeReaderValueList::assignValue(Value *V, unsigned Idx) {
897 WeakVH &OldV = ValuePtrs[Idx];
903 // Handle constants and non-constants (e.g. instrs) differently for
905 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
906 ResolveConstants.push_back(std::make_pair(PHC, Idx));
909 // If there was a forward reference to this value, replace it.
910 Value *PrevVal = OldV;
911 // Check operator constraints. We only put cleanuppads or catchpads in
912 // the forward value map if the value is constrained to match.
913 if (CatchPadInst *CatchPad = dyn_cast<CatchPadInst>(PrevVal)) {
914 if (!isa<CatchPadInst>(V))
916 // Delete the dummy basic block that was created with the sentinel
918 BasicBlock *DummyBlock = CatchPad->getUnwindDest();
919 assert(DummyBlock == CatchPad->getNormalDest());
920 CatchPad->dropAllReferences();
922 } else if (isa<CleanupPadInst>(PrevVal)) {
923 if (!isa<CleanupPadInst>(V))
926 OldV->replaceAllUsesWith(V);
934 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
939 if (Value *V = ValuePtrs[Idx]) {
940 if (Ty != V->getType())
941 report_fatal_error("Type mismatch in constant table!");
942 return cast<Constant>(V);
945 // Create and return a placeholder, which will later be RAUW'd.
946 Constant *C = new ConstantPlaceHolder(Ty, Context);
951 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty,
952 OperatorConstraint OC) {
953 // Bail out for a clearly invalid value. This would make us call resize(0)
960 if (Value *V = ValuePtrs[Idx]) {
961 // If the types don't match, it's invalid.
962 if (Ty && Ty != V->getType())
966 // Use dyn_cast to enforce operator constraints
969 return dyn_cast<CatchPadInst>(V);
971 return dyn_cast<CleanupPadInst>(V);
973 llvm_unreachable("Unexpected operator constraint");
977 // No type specified, must be invalid reference.
978 if (!Ty) return nullptr;
980 // Create and return a placeholder, which will later be RAUW'd.
984 V = new Argument(Ty);
987 BasicBlock *BB = BasicBlock::Create(Context);
988 V = CatchPadInst::Create(BB, BB, {});
992 assert(OC == OC_CleanupPad && "unexpected operator constraint");
993 V = CleanupPadInst::Create(Context, {});
1001 /// Once all constants are read, this method bulk resolves any forward
1002 /// references. The idea behind this is that we sometimes get constants (such
1003 /// as large arrays) which reference *many* forward ref constants. Replacing
1004 /// each of these causes a lot of thrashing when building/reuniquing the
1005 /// constant. Instead of doing this, we look at all the uses and rewrite all
1006 /// the place holders at once for any constant that uses a placeholder.
1007 void BitcodeReaderValueList::resolveConstantForwardRefs() {
1008 // Sort the values by-pointer so that they are efficient to look up with a
1010 std::sort(ResolveConstants.begin(), ResolveConstants.end());
1012 SmallVector<Constant*, 64> NewOps;
1014 while (!ResolveConstants.empty()) {
1015 Value *RealVal = operator[](ResolveConstants.back().second);
1016 Constant *Placeholder = ResolveConstants.back().first;
1017 ResolveConstants.pop_back();
1019 // Loop over all users of the placeholder, updating them to reference the
1020 // new value. If they reference more than one placeholder, update them all
1022 while (!Placeholder->use_empty()) {
1023 auto UI = Placeholder->user_begin();
1026 // If the using object isn't uniqued, just update the operands. This
1027 // handles instructions and initializers for global variables.
1028 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
1029 UI.getUse().set(RealVal);
1033 // Otherwise, we have a constant that uses the placeholder. Replace that
1034 // constant with a new constant that has *all* placeholder uses updated.
1035 Constant *UserC = cast<Constant>(U);
1036 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
1039 if (!isa<ConstantPlaceHolder>(*I)) {
1040 // Not a placeholder reference.
1042 } else if (*I == Placeholder) {
1043 // Common case is that it just references this one placeholder.
1046 // Otherwise, look up the placeholder in ResolveConstants.
1047 ResolveConstantsTy::iterator It =
1048 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
1049 std::pair<Constant*, unsigned>(cast<Constant>(*I),
1051 assert(It != ResolveConstants.end() && It->first == *I);
1052 NewOp = operator[](It->second);
1055 NewOps.push_back(cast<Constant>(NewOp));
1058 // Make the new constant.
1060 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
1061 NewC = ConstantArray::get(UserCA->getType(), NewOps);
1062 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
1063 NewC = ConstantStruct::get(UserCS->getType(), NewOps);
1064 } else if (isa<ConstantVector>(UserC)) {
1065 NewC = ConstantVector::get(NewOps);
1067 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
1068 NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
1071 UserC->replaceAllUsesWith(NewC);
1072 UserC->destroyConstant();
1076 // Update all ValueHandles, they should be the only users at this point.
1077 Placeholder->replaceAllUsesWith(RealVal);
1082 void BitcodeReaderMDValueList::assignValue(Metadata *MD, unsigned Idx) {
1083 if (Idx == size()) {
1091 TrackingMDRef &OldMD = MDValuePtrs[Idx];
1097 // If there was a forward reference to this value, replace it.
1098 TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
1099 PrevMD->replaceAllUsesWith(MD);
1103 Metadata *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
1107 if (Metadata *MD = MDValuePtrs[Idx])
1110 // Track forward refs to be resolved later.
1112 MinFwdRef = std::min(MinFwdRef, Idx);
1113 MaxFwdRef = std::max(MaxFwdRef, Idx);
1116 MinFwdRef = MaxFwdRef = Idx;
1120 // Create and return a placeholder, which will later be RAUW'd.
1121 Metadata *MD = MDNode::getTemporary(Context, None).release();
1122 MDValuePtrs[Idx].reset(MD);
1126 void BitcodeReaderMDValueList::tryToResolveCycles() {
1132 // Still forward references... can't resolve cycles.
1135 // Resolve any cycles.
1136 for (unsigned I = MinFwdRef, E = MaxFwdRef + 1; I != E; ++I) {
1137 auto &MD = MDValuePtrs[I];
1138 auto *N = dyn_cast_or_null<MDNode>(MD);
1142 assert(!N->isTemporary() && "Unexpected forward reference");
1146 // Make sure we return early again until there's another forward ref.
1150 Type *BitcodeReader::getTypeByID(unsigned ID) {
1151 // The type table size is always specified correctly.
1152 if (ID >= TypeList.size())
1155 if (Type *Ty = TypeList[ID])
1158 // If we have a forward reference, the only possible case is when it is to a
1159 // named struct. Just create a placeholder for now.
1160 return TypeList[ID] = createIdentifiedStructType(Context);
1163 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
1165 auto *Ret = StructType::create(Context, Name);
1166 IdentifiedStructTypes.push_back(Ret);
1170 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
1171 auto *Ret = StructType::create(Context);
1172 IdentifiedStructTypes.push_back(Ret);
1177 //===----------------------------------------------------------------------===//
1178 // Functions for parsing blocks from the bitcode file
1179 //===----------------------------------------------------------------------===//
1182 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
1183 /// been decoded from the given integer. This function must stay in sync with
1184 /// 'encodeLLVMAttributesForBitcode'.
1185 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1186 uint64_t EncodedAttrs) {
1187 // FIXME: Remove in 4.0.
1189 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
1190 // the bits above 31 down by 11 bits.
1191 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1192 assert((!Alignment || isPowerOf2_32(Alignment)) &&
1193 "Alignment must be a power of two.");
1196 B.addAlignmentAttr(Alignment);
1197 B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1198 (EncodedAttrs & 0xffff));
1201 std::error_code BitcodeReader::parseAttributeBlock() {
1202 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
1203 return error("Invalid record");
1205 if (!MAttributes.empty())
1206 return error("Invalid multiple blocks");
1208 SmallVector<uint64_t, 64> Record;
1210 SmallVector<AttributeSet, 8> Attrs;
1212 // Read all the records.
1214 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1216 switch (Entry.Kind) {
1217 case BitstreamEntry::SubBlock: // Handled for us already.
1218 case BitstreamEntry::Error:
1219 return error("Malformed block");
1220 case BitstreamEntry::EndBlock:
1221 return std::error_code();
1222 case BitstreamEntry::Record:
1223 // The interesting case.
1229 switch (Stream.readRecord(Entry.ID, Record)) {
1230 default: // Default behavior: ignore.
1232 case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
1233 // FIXME: Remove in 4.0.
1234 if (Record.size() & 1)
1235 return error("Invalid record");
1237 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1239 decodeLLVMAttributesForBitcode(B, Record[i+1]);
1240 Attrs.push_back(AttributeSet::get(Context, Record[i], B));
1243 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1247 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
1248 for (unsigned i = 0, e = Record.size(); i != e; ++i)
1249 Attrs.push_back(MAttributeGroups[Record[i]]);
1251 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1259 // Returns Attribute::None on unrecognized codes.
1260 static Attribute::AttrKind getAttrFromCode(uint64_t Code) {
1263 return Attribute::None;
1264 case bitc::ATTR_KIND_ALIGNMENT:
1265 return Attribute::Alignment;
1266 case bitc::ATTR_KIND_ALWAYS_INLINE:
1267 return Attribute::AlwaysInline;
1268 case bitc::ATTR_KIND_ARGMEMONLY:
1269 return Attribute::ArgMemOnly;
1270 case bitc::ATTR_KIND_BUILTIN:
1271 return Attribute::Builtin;
1272 case bitc::ATTR_KIND_BY_VAL:
1273 return Attribute::ByVal;
1274 case bitc::ATTR_KIND_IN_ALLOCA:
1275 return Attribute::InAlloca;
1276 case bitc::ATTR_KIND_COLD:
1277 return Attribute::Cold;
1278 case bitc::ATTR_KIND_CONVERGENT:
1279 return Attribute::Convergent;
1280 case bitc::ATTR_KIND_INLINE_HINT:
1281 return Attribute::InlineHint;
1282 case bitc::ATTR_KIND_IN_REG:
1283 return Attribute::InReg;
1284 case bitc::ATTR_KIND_JUMP_TABLE:
1285 return Attribute::JumpTable;
1286 case bitc::ATTR_KIND_MIN_SIZE:
1287 return Attribute::MinSize;
1288 case bitc::ATTR_KIND_NAKED:
1289 return Attribute::Naked;
1290 case bitc::ATTR_KIND_NEST:
1291 return Attribute::Nest;
1292 case bitc::ATTR_KIND_NO_ALIAS:
1293 return Attribute::NoAlias;
1294 case bitc::ATTR_KIND_NO_BUILTIN:
1295 return Attribute::NoBuiltin;
1296 case bitc::ATTR_KIND_NO_CAPTURE:
1297 return Attribute::NoCapture;
1298 case bitc::ATTR_KIND_NO_DUPLICATE:
1299 return Attribute::NoDuplicate;
1300 case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1301 return Attribute::NoImplicitFloat;
1302 case bitc::ATTR_KIND_NO_INLINE:
1303 return Attribute::NoInline;
1304 case bitc::ATTR_KIND_NON_LAZY_BIND:
1305 return Attribute::NonLazyBind;
1306 case bitc::ATTR_KIND_NON_NULL:
1307 return Attribute::NonNull;
1308 case bitc::ATTR_KIND_DEREFERENCEABLE:
1309 return Attribute::Dereferenceable;
1310 case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:
1311 return Attribute::DereferenceableOrNull;
1312 case bitc::ATTR_KIND_NO_RED_ZONE:
1313 return Attribute::NoRedZone;
1314 case bitc::ATTR_KIND_NO_RETURN:
1315 return Attribute::NoReturn;
1316 case bitc::ATTR_KIND_NO_UNWIND:
1317 return Attribute::NoUnwind;
1318 case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1319 return Attribute::OptimizeForSize;
1320 case bitc::ATTR_KIND_OPTIMIZE_NONE:
1321 return Attribute::OptimizeNone;
1322 case bitc::ATTR_KIND_READ_NONE:
1323 return Attribute::ReadNone;
1324 case bitc::ATTR_KIND_READ_ONLY:
1325 return Attribute::ReadOnly;
1326 case bitc::ATTR_KIND_RETURNED:
1327 return Attribute::Returned;
1328 case bitc::ATTR_KIND_RETURNS_TWICE:
1329 return Attribute::ReturnsTwice;
1330 case bitc::ATTR_KIND_S_EXT:
1331 return Attribute::SExt;
1332 case bitc::ATTR_KIND_STACK_ALIGNMENT:
1333 return Attribute::StackAlignment;
1334 case bitc::ATTR_KIND_STACK_PROTECT:
1335 return Attribute::StackProtect;
1336 case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1337 return Attribute::StackProtectReq;
1338 case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1339 return Attribute::StackProtectStrong;
1340 case bitc::ATTR_KIND_SAFESTACK:
1341 return Attribute::SafeStack;
1342 case bitc::ATTR_KIND_STRUCT_RET:
1343 return Attribute::StructRet;
1344 case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1345 return Attribute::SanitizeAddress;
1346 case bitc::ATTR_KIND_SANITIZE_THREAD:
1347 return Attribute::SanitizeThread;
1348 case bitc::ATTR_KIND_SANITIZE_MEMORY:
1349 return Attribute::SanitizeMemory;
1350 case bitc::ATTR_KIND_UW_TABLE:
1351 return Attribute::UWTable;
1352 case bitc::ATTR_KIND_Z_EXT:
1353 return Attribute::ZExt;
1357 std::error_code BitcodeReader::parseAlignmentValue(uint64_t Exponent,
1358 unsigned &Alignment) {
1359 // Note: Alignment in bitcode files is incremented by 1, so that zero
1360 // can be used for default alignment.
1361 if (Exponent > Value::MaxAlignmentExponent + 1)
1362 return error("Invalid alignment value");
1363 Alignment = (1 << static_cast<unsigned>(Exponent)) >> 1;
1364 return std::error_code();
1367 std::error_code BitcodeReader::parseAttrKind(uint64_t Code,
1368 Attribute::AttrKind *Kind) {
1369 *Kind = getAttrFromCode(Code);
1370 if (*Kind == Attribute::None)
1371 return error(BitcodeError::CorruptedBitcode,
1372 "Unknown attribute kind (" + Twine(Code) + ")");
1373 return std::error_code();
1376 std::error_code BitcodeReader::parseAttributeGroupBlock() {
1377 if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
1378 return error("Invalid record");
1380 if (!MAttributeGroups.empty())
1381 return error("Invalid multiple blocks");
1383 SmallVector<uint64_t, 64> Record;
1385 // Read all the records.
1387 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1389 switch (Entry.Kind) {
1390 case BitstreamEntry::SubBlock: // Handled for us already.
1391 case BitstreamEntry::Error:
1392 return error("Malformed block");
1393 case BitstreamEntry::EndBlock:
1394 return std::error_code();
1395 case BitstreamEntry::Record:
1396 // The interesting case.
1402 switch (Stream.readRecord(Entry.ID, Record)) {
1403 default: // Default behavior: ignore.
1405 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1406 if (Record.size() < 3)
1407 return error("Invalid record");
1409 uint64_t GrpID = Record[0];
1410 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1413 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1414 if (Record[i] == 0) { // Enum attribute
1415 Attribute::AttrKind Kind;
1416 if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1419 B.addAttribute(Kind);
1420 } else if (Record[i] == 1) { // Integer attribute
1421 Attribute::AttrKind Kind;
1422 if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1424 if (Kind == Attribute::Alignment)
1425 B.addAlignmentAttr(Record[++i]);
1426 else if (Kind == Attribute::StackAlignment)
1427 B.addStackAlignmentAttr(Record[++i]);
1428 else if (Kind == Attribute::Dereferenceable)
1429 B.addDereferenceableAttr(Record[++i]);
1430 else if (Kind == Attribute::DereferenceableOrNull)
1431 B.addDereferenceableOrNullAttr(Record[++i]);
1432 } else { // String attribute
1433 assert((Record[i] == 3 || Record[i] == 4) &&
1434 "Invalid attribute group entry");
1435 bool HasValue = (Record[i++] == 4);
1436 SmallString<64> KindStr;
1437 SmallString<64> ValStr;
1439 while (Record[i] != 0 && i != e)
1440 KindStr += Record[i++];
1441 assert(Record[i] == 0 && "Kind string not null terminated");
1444 // Has a value associated with it.
1445 ++i; // Skip the '0' that terminates the "kind" string.
1446 while (Record[i] != 0 && i != e)
1447 ValStr += Record[i++];
1448 assert(Record[i] == 0 && "Value string not null terminated");
1451 B.addAttribute(KindStr.str(), ValStr.str());
1455 MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
1462 std::error_code BitcodeReader::parseTypeTable() {
1463 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
1464 return error("Invalid record");
1466 return parseTypeTableBody();
1469 std::error_code BitcodeReader::parseTypeTableBody() {
1470 if (!TypeList.empty())
1471 return error("Invalid multiple blocks");
1473 SmallVector<uint64_t, 64> Record;
1474 unsigned NumRecords = 0;
1476 SmallString<64> TypeName;
1478 // Read all the records for this type table.
1480 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1482 switch (Entry.Kind) {
1483 case BitstreamEntry::SubBlock: // Handled for us already.
1484 case BitstreamEntry::Error:
1485 return error("Malformed block");
1486 case BitstreamEntry::EndBlock:
1487 if (NumRecords != TypeList.size())
1488 return error("Malformed block");
1489 return std::error_code();
1490 case BitstreamEntry::Record:
1491 // The interesting case.
1497 Type *ResultTy = nullptr;
1498 switch (Stream.readRecord(Entry.ID, Record)) {
1500 return error("Invalid value");
1501 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1502 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1503 // type list. This allows us to reserve space.
1504 if (Record.size() < 1)
1505 return error("Invalid record");
1506 TypeList.resize(Record[0]);
1508 case bitc::TYPE_CODE_VOID: // VOID
1509 ResultTy = Type::getVoidTy(Context);
1511 case bitc::TYPE_CODE_HALF: // HALF
1512 ResultTy = Type::getHalfTy(Context);
1514 case bitc::TYPE_CODE_FLOAT: // FLOAT
1515 ResultTy = Type::getFloatTy(Context);
1517 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
1518 ResultTy = Type::getDoubleTy(Context);
1520 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
1521 ResultTy = Type::getX86_FP80Ty(Context);
1523 case bitc::TYPE_CODE_FP128: // FP128
1524 ResultTy = Type::getFP128Ty(Context);
1526 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
1527 ResultTy = Type::getPPC_FP128Ty(Context);
1529 case bitc::TYPE_CODE_LABEL: // LABEL
1530 ResultTy = Type::getLabelTy(Context);
1532 case bitc::TYPE_CODE_METADATA: // METADATA
1533 ResultTy = Type::getMetadataTy(Context);
1535 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
1536 ResultTy = Type::getX86_MMXTy(Context);
1538 case bitc::TYPE_CODE_TOKEN: // TOKEN
1539 ResultTy = Type::getTokenTy(Context);
1541 case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
1542 if (Record.size() < 1)
1543 return error("Invalid record");
1545 uint64_t NumBits = Record[0];
1546 if (NumBits < IntegerType::MIN_INT_BITS ||
1547 NumBits > IntegerType::MAX_INT_BITS)
1548 return error("Bitwidth for integer type out of range");
1549 ResultTy = IntegerType::get(Context, NumBits);
1552 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
1553 // [pointee type, address space]
1554 if (Record.size() < 1)
1555 return error("Invalid record");
1556 unsigned AddressSpace = 0;
1557 if (Record.size() == 2)
1558 AddressSpace = Record[1];
1559 ResultTy = getTypeByID(Record[0]);
1561 !PointerType::isValidElementType(ResultTy))
1562 return error("Invalid type");
1563 ResultTy = PointerType::get(ResultTy, AddressSpace);
1566 case bitc::TYPE_CODE_FUNCTION_OLD: {
1567 // FIXME: attrid is dead, remove it in LLVM 4.0
1568 // FUNCTION: [vararg, attrid, retty, paramty x N]
1569 if (Record.size() < 3)
1570 return error("Invalid record");
1571 SmallVector<Type*, 8> ArgTys;
1572 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1573 if (Type *T = getTypeByID(Record[i]))
1574 ArgTys.push_back(T);
1579 ResultTy = getTypeByID(Record[2]);
1580 if (!ResultTy || ArgTys.size() < Record.size()-3)
1581 return error("Invalid type");
1583 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1586 case bitc::TYPE_CODE_FUNCTION: {
1587 // FUNCTION: [vararg, retty, paramty x N]
1588 if (Record.size() < 2)
1589 return error("Invalid record");
1590 SmallVector<Type*, 8> ArgTys;
1591 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1592 if (Type *T = getTypeByID(Record[i])) {
1593 if (!FunctionType::isValidArgumentType(T))
1594 return error("Invalid function argument type");
1595 ArgTys.push_back(T);
1601 ResultTy = getTypeByID(Record[1]);
1602 if (!ResultTy || ArgTys.size() < Record.size()-2)
1603 return error("Invalid type");
1605 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1608 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
1609 if (Record.size() < 1)
1610 return error("Invalid record");
1611 SmallVector<Type*, 8> EltTys;
1612 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1613 if (Type *T = getTypeByID(Record[i]))
1614 EltTys.push_back(T);
1618 if (EltTys.size() != Record.size()-1)
1619 return error("Invalid type");
1620 ResultTy = StructType::get(Context, EltTys, Record[0]);
1623 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
1624 if (convertToString(Record, 0, TypeName))
1625 return error("Invalid record");
1628 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1629 if (Record.size() < 1)
1630 return error("Invalid record");
1632 if (NumRecords >= TypeList.size())
1633 return error("Invalid TYPE table");
1635 // Check to see if this was forward referenced, if so fill in the temp.
1636 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1638 Res->setName(TypeName);
1639 TypeList[NumRecords] = nullptr;
1640 } else // Otherwise, create a new struct.
1641 Res = createIdentifiedStructType(Context, TypeName);
1644 SmallVector<Type*, 8> EltTys;
1645 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1646 if (Type *T = getTypeByID(Record[i]))
1647 EltTys.push_back(T);
1651 if (EltTys.size() != Record.size()-1)
1652 return error("Invalid record");
1653 Res->setBody(EltTys, Record[0]);
1657 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
1658 if (Record.size() != 1)
1659 return error("Invalid record");
1661 if (NumRecords >= TypeList.size())
1662 return error("Invalid TYPE table");
1664 // Check to see if this was forward referenced, if so fill in the temp.
1665 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1667 Res->setName(TypeName);
1668 TypeList[NumRecords] = nullptr;
1669 } else // Otherwise, create a new struct with no body.
1670 Res = createIdentifiedStructType(Context, TypeName);
1675 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
1676 if (Record.size() < 2)
1677 return error("Invalid record");
1678 ResultTy = getTypeByID(Record[1]);
1679 if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
1680 return error("Invalid type");
1681 ResultTy = ArrayType::get(ResultTy, Record[0]);
1683 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
1684 if (Record.size() < 2)
1685 return error("Invalid record");
1687 return error("Invalid vector length");
1688 ResultTy = getTypeByID(Record[1]);
1689 if (!ResultTy || !StructType::isValidElementType(ResultTy))
1690 return error("Invalid type");
1691 ResultTy = VectorType::get(ResultTy, Record[0]);
1695 if (NumRecords >= TypeList.size())
1696 return error("Invalid TYPE table");
1697 if (TypeList[NumRecords])
1699 "Invalid TYPE table: Only named structs can be forward referenced");
1700 assert(ResultTy && "Didn't read a type?");
1701 TypeList[NumRecords++] = ResultTy;
1705 std::error_code BitcodeReader::parseOperandBundleTags() {
1706 if (Stream.EnterSubBlock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID))
1707 return error("Invalid record");
1709 if (!BundleTags.empty())
1710 return error("Invalid multiple blocks");
1712 SmallVector<uint64_t, 64> Record;
1715 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1717 switch (Entry.Kind) {
1718 case BitstreamEntry::SubBlock: // Handled for us already.
1719 case BitstreamEntry::Error:
1720 return error("Malformed block");
1721 case BitstreamEntry::EndBlock:
1722 return std::error_code();
1723 case BitstreamEntry::Record:
1724 // The interesting case.
1728 // Tags are implicitly mapped to integers by their order.
1730 if (Stream.readRecord(Entry.ID, Record) != bitc::OPERAND_BUNDLE_TAG)
1731 return error("Invalid record");
1733 // OPERAND_BUNDLE_TAG: [strchr x N]
1734 BundleTags.emplace_back();
1735 if (convertToString(Record, 0, BundleTags.back()))
1736 return error("Invalid record");
1741 /// Associate a value with its name from the given index in the provided record.
1742 ErrorOr<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,
1743 unsigned NameIndex, Triple &TT) {
1744 SmallString<128> ValueName;
1745 if (convertToString(Record, NameIndex, ValueName))
1746 return error("Invalid record");
1747 unsigned ValueID = Record[0];
1748 if (ValueID >= ValueList.size() || !ValueList[ValueID])
1749 return error("Invalid record");
1750 Value *V = ValueList[ValueID];
1752 StringRef NameStr(ValueName.data(), ValueName.size());
1753 if (NameStr.find_first_of(0) != StringRef::npos)
1754 return error("Invalid value name");
1755 V->setName(NameStr);
1756 auto *GO = dyn_cast<GlobalObject>(V);
1758 if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1759 if (TT.isOSBinFormatMachO())
1760 GO->setComdat(nullptr);
1762 GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1768 /// Parse the value symbol table at either the current parsing location or
1769 /// at the given bit offset if provided.
1770 std::error_code BitcodeReader::parseValueSymbolTable(uint64_t Offset) {
1771 uint64_t CurrentBit;
1772 // Pass in the Offset to distinguish between calling for the module-level
1773 // VST (where we want to jump to the VST offset) and the function-level
1774 // VST (where we don't).
1776 // Save the current parsing location so we can jump back at the end
1778 CurrentBit = Stream.GetCurrentBitNo();
1779 Stream.JumpToBit(Offset * 32);
1781 // Do some checking if we are in debug mode.
1782 BitstreamEntry Entry = Stream.advance();
1783 assert(Entry.Kind == BitstreamEntry::SubBlock);
1784 assert(Entry.ID == bitc::VALUE_SYMTAB_BLOCK_ID);
1786 // In NDEBUG mode ignore the output so we don't get an unused variable
1792 // Compute the delta between the bitcode indices in the VST (the word offset
1793 // to the word-aligned ENTER_SUBBLOCK for the function block, and that
1794 // expected by the lazy reader. The reader's EnterSubBlock expects to have
1795 // already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID
1796 // (size BlockIDWidth). Note that we access the stream's AbbrevID width here
1797 // just before entering the VST subblock because: 1) the EnterSubBlock
1798 // changes the AbbrevID width; 2) the VST block is nested within the same
1799 // outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same
1800 // AbbrevID width before calling EnterSubBlock; and 3) when we want to
1801 // jump to the FUNCTION_BLOCK using this offset later, we don't want
1802 // to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.
1803 unsigned FuncBitcodeOffsetDelta =
1804 Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
1806 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1807 return error("Invalid record");
1809 SmallVector<uint64_t, 64> Record;
1811 Triple TT(TheModule->getTargetTriple());
1813 // Read all the records for this value table.
1814 SmallString<128> ValueName;
1816 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1818 switch (Entry.Kind) {
1819 case BitstreamEntry::SubBlock: // Handled for us already.
1820 case BitstreamEntry::Error:
1821 return error("Malformed block");
1822 case BitstreamEntry::EndBlock:
1824 Stream.JumpToBit(CurrentBit);
1825 return std::error_code();
1826 case BitstreamEntry::Record:
1827 // The interesting case.
1833 switch (Stream.readRecord(Entry.ID, Record)) {
1834 default: // Default behavior: unknown type.
1836 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
1837 ErrorOr<Value *> ValOrErr = recordValue(Record, 1, TT);
1838 if (std::error_code EC = ValOrErr.getError())
1843 case bitc::VST_CODE_FNENTRY: {
1844 // VST_FNENTRY: [valueid, offset, namechar x N]
1845 ErrorOr<Value *> ValOrErr = recordValue(Record, 2, TT);
1846 if (std::error_code EC = ValOrErr.getError())
1848 Value *V = ValOrErr.get();
1850 auto *GO = dyn_cast<GlobalObject>(V);
1852 // If this is an alias, need to get the actual Function object
1853 // it aliases, in order to set up the DeferredFunctionInfo entry below.
1854 auto *GA = dyn_cast<GlobalAlias>(V);
1856 GO = GA->getBaseObject();
1860 uint64_t FuncWordOffset = Record[1];
1861 Function *F = dyn_cast<Function>(GO);
1863 uint64_t FuncBitOffset = FuncWordOffset * 32;
1864 DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;
1865 // Set the LastFunctionBlockBit to point to the last function block.
1866 // Later when parsing is resumed after function materialization,
1867 // we can simply skip that last function block.
1868 if (FuncBitOffset > LastFunctionBlockBit)
1869 LastFunctionBlockBit = FuncBitOffset;
1872 case bitc::VST_CODE_BBENTRY: {
1873 if (convertToString(Record, 1, ValueName))
1874 return error("Invalid record");
1875 BasicBlock *BB = getBasicBlock(Record[0]);
1877 return error("Invalid record");
1879 BB->setName(StringRef(ValueName.data(), ValueName.size()));
1887 static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
1889 std::error_code BitcodeReader::parseMetadata() {
1890 IsMetadataMaterialized = true;
1891 unsigned NextMDValueNo = MDValueList.size();
1893 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1894 return error("Invalid record");
1896 SmallVector<uint64_t, 64> Record;
1899 [&](unsigned ID) -> Metadata *{ return MDValueList.getValueFwdRef(ID); };
1900 auto getMDOrNull = [&](unsigned ID) -> Metadata *{
1902 return getMD(ID - 1);
1905 auto getMDString = [&](unsigned ID) -> MDString *{
1906 // This requires that the ID is not really a forward reference. In
1907 // particular, the MDString must already have been resolved.
1908 return cast_or_null<MDString>(getMDOrNull(ID));
1911 #define GET_OR_DISTINCT(CLASS, DISTINCT, ARGS) \
1912 (DISTINCT ? CLASS::getDistinct ARGS : CLASS::get ARGS)
1914 // Read all the records.
1916 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1918 switch (Entry.Kind) {
1919 case BitstreamEntry::SubBlock: // Handled for us already.
1920 case BitstreamEntry::Error:
1921 return error("Malformed block");
1922 case BitstreamEntry::EndBlock:
1923 MDValueList.tryToResolveCycles();
1924 return std::error_code();
1925 case BitstreamEntry::Record:
1926 // The interesting case.
1932 unsigned Code = Stream.readRecord(Entry.ID, Record);
1933 bool IsDistinct = false;
1935 default: // Default behavior: ignore.
1937 case bitc::METADATA_NAME: {
1938 // Read name of the named metadata.
1939 SmallString<8> Name(Record.begin(), Record.end());
1941 Code = Stream.ReadCode();
1943 unsigned NextBitCode = Stream.readRecord(Code, Record);
1944 if (NextBitCode != bitc::METADATA_NAMED_NODE)
1945 return error("METADATA_NAME not followed by METADATA_NAMED_NODE");
1947 // Read named metadata elements.
1948 unsigned Size = Record.size();
1949 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1950 for (unsigned i = 0; i != Size; ++i) {
1951 MDNode *MD = dyn_cast_or_null<MDNode>(MDValueList.getValueFwdRef(Record[i]));
1953 return error("Invalid record");
1954 NMD->addOperand(MD);
1958 case bitc::METADATA_OLD_FN_NODE: {
1959 // FIXME: Remove in 4.0.
1960 // This is a LocalAsMetadata record, the only type of function-local
1962 if (Record.size() % 2 == 1)
1963 return error("Invalid record");
1965 // If this isn't a LocalAsMetadata record, we're dropping it. This used
1966 // to be legal, but there's no upgrade path.
1967 auto dropRecord = [&] {
1968 MDValueList.assignValue(MDNode::get(Context, None), NextMDValueNo++);
1970 if (Record.size() != 2) {
1975 Type *Ty = getTypeByID(Record[0]);
1976 if (Ty->isMetadataTy() || Ty->isVoidTy()) {
1981 MDValueList.assignValue(
1982 LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1986 case bitc::METADATA_OLD_NODE: {
1987 // FIXME: Remove in 4.0.
1988 if (Record.size() % 2 == 1)
1989 return error("Invalid record");
1991 unsigned Size = Record.size();
1992 SmallVector<Metadata *, 8> Elts;
1993 for (unsigned i = 0; i != Size; i += 2) {
1994 Type *Ty = getTypeByID(Record[i]);
1996 return error("Invalid record");
1997 if (Ty->isMetadataTy())
1998 Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
1999 else if (!Ty->isVoidTy()) {
2001 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
2002 assert(isa<ConstantAsMetadata>(MD) &&
2003 "Expected non-function-local metadata");
2006 Elts.push_back(nullptr);
2008 MDValueList.assignValue(MDNode::get(Context, Elts), NextMDValueNo++);
2011 case bitc::METADATA_VALUE: {
2012 if (Record.size() != 2)
2013 return error("Invalid record");
2015 Type *Ty = getTypeByID(Record[0]);
2016 if (Ty->isMetadataTy() || Ty->isVoidTy())
2017 return error("Invalid record");
2019 MDValueList.assignValue(
2020 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
2024 case bitc::METADATA_DISTINCT_NODE:
2027 case bitc::METADATA_NODE: {
2028 SmallVector<Metadata *, 8> Elts;
2029 Elts.reserve(Record.size());
2030 for (unsigned ID : Record)
2031 Elts.push_back(ID ? MDValueList.getValueFwdRef(ID - 1) : nullptr);
2032 MDValueList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
2033 : MDNode::get(Context, Elts),
2037 case bitc::METADATA_LOCATION: {
2038 if (Record.size() != 5)
2039 return error("Invalid record");
2041 unsigned Line = Record[1];
2042 unsigned Column = Record[2];
2043 MDNode *Scope = cast<MDNode>(MDValueList.getValueFwdRef(Record[3]));
2044 Metadata *InlinedAt =
2045 Record[4] ? MDValueList.getValueFwdRef(Record[4] - 1) : nullptr;
2046 MDValueList.assignValue(
2047 GET_OR_DISTINCT(DILocation, Record[0],
2048 (Context, Line, Column, Scope, InlinedAt)),
2052 case bitc::METADATA_GENERIC_DEBUG: {
2053 if (Record.size() < 4)
2054 return error("Invalid record");
2056 unsigned Tag = Record[1];
2057 unsigned Version = Record[2];
2059 if (Tag >= 1u << 16 || Version != 0)
2060 return error("Invalid record");
2062 auto *Header = getMDString(Record[3]);
2063 SmallVector<Metadata *, 8> DwarfOps;
2064 for (unsigned I = 4, E = Record.size(); I != E; ++I)
2065 DwarfOps.push_back(Record[I] ? MDValueList.getValueFwdRef(Record[I] - 1)
2067 MDValueList.assignValue(GET_OR_DISTINCT(GenericDINode, Record[0],
2068 (Context, Tag, Header, DwarfOps)),
2072 case bitc::METADATA_SUBRANGE: {
2073 if (Record.size() != 3)
2074 return error("Invalid record");
2076 MDValueList.assignValue(
2077 GET_OR_DISTINCT(DISubrange, Record[0],
2078 (Context, Record[1], unrotateSign(Record[2]))),
2082 case bitc::METADATA_ENUMERATOR: {
2083 if (Record.size() != 3)
2084 return error("Invalid record");
2086 MDValueList.assignValue(GET_OR_DISTINCT(DIEnumerator, Record[0],
2087 (Context, unrotateSign(Record[1]),
2088 getMDString(Record[2]))),
2092 case bitc::METADATA_BASIC_TYPE: {
2093 if (Record.size() != 6)
2094 return error("Invalid record");
2096 MDValueList.assignValue(
2097 GET_OR_DISTINCT(DIBasicType, Record[0],
2098 (Context, Record[1], getMDString(Record[2]),
2099 Record[3], Record[4], Record[5])),
2103 case bitc::METADATA_DERIVED_TYPE: {
2104 if (Record.size() != 12)
2105 return error("Invalid record");
2107 MDValueList.assignValue(
2108 GET_OR_DISTINCT(DIDerivedType, Record[0],
2109 (Context, Record[1], getMDString(Record[2]),
2110 getMDOrNull(Record[3]), Record[4],
2111 getMDOrNull(Record[5]), getMDOrNull(Record[6]),
2112 Record[7], Record[8], Record[9], Record[10],
2113 getMDOrNull(Record[11]))),
2117 case bitc::METADATA_COMPOSITE_TYPE: {
2118 if (Record.size() != 16)
2119 return error("Invalid record");
2121 MDValueList.assignValue(
2122 GET_OR_DISTINCT(DICompositeType, Record[0],
2123 (Context, Record[1], getMDString(Record[2]),
2124 getMDOrNull(Record[3]), Record[4],
2125 getMDOrNull(Record[5]), getMDOrNull(Record[6]),
2126 Record[7], Record[8], Record[9], Record[10],
2127 getMDOrNull(Record[11]), Record[12],
2128 getMDOrNull(Record[13]), getMDOrNull(Record[14]),
2129 getMDString(Record[15]))),
2133 case bitc::METADATA_SUBROUTINE_TYPE: {
2134 if (Record.size() != 3)
2135 return error("Invalid record");
2137 MDValueList.assignValue(
2138 GET_OR_DISTINCT(DISubroutineType, Record[0],
2139 (Context, Record[1], getMDOrNull(Record[2]))),
2144 case bitc::METADATA_MODULE: {
2145 if (Record.size() != 6)
2146 return error("Invalid record");
2148 MDValueList.assignValue(
2149 GET_OR_DISTINCT(DIModule, Record[0],
2150 (Context, getMDOrNull(Record[1]),
2151 getMDString(Record[2]), getMDString(Record[3]),
2152 getMDString(Record[4]), getMDString(Record[5]))),
2157 case bitc::METADATA_FILE: {
2158 if (Record.size() != 3)
2159 return error("Invalid record");
2161 MDValueList.assignValue(
2162 GET_OR_DISTINCT(DIFile, Record[0], (Context, getMDString(Record[1]),
2163 getMDString(Record[2]))),
2167 case bitc::METADATA_COMPILE_UNIT: {
2168 if (Record.size() < 14 || Record.size() > 15)
2169 return error("Invalid record");
2171 // Ignore Record[1], which indicates whether this compile unit is
2172 // distinct. It's always distinct.
2173 MDValueList.assignValue(
2174 DICompileUnit::getDistinct(
2175 Context, Record[1], getMDOrNull(Record[2]),
2176 getMDString(Record[3]), Record[4], getMDString(Record[5]),
2177 Record[6], getMDString(Record[7]), Record[8],
2178 getMDOrNull(Record[9]), getMDOrNull(Record[10]),
2179 getMDOrNull(Record[11]), getMDOrNull(Record[12]),
2180 getMDOrNull(Record[13]), Record.size() == 14 ? 0 : Record[14]),
2184 case bitc::METADATA_SUBPROGRAM: {
2185 if (Record.size() != 19)
2186 return error("Invalid record");
2188 MDValueList.assignValue(
2191 Record[0] || Record[8], // All definitions should be distinct.
2192 (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
2193 getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
2194 getMDOrNull(Record[6]), Record[7], Record[8], Record[9],
2195 getMDOrNull(Record[10]), Record[11], Record[12], Record[13],
2196 Record[14], getMDOrNull(Record[15]), getMDOrNull(Record[16]),
2197 getMDOrNull(Record[17]), getMDOrNull(Record[18]))),
2201 case bitc::METADATA_LEXICAL_BLOCK: {
2202 if (Record.size() != 5)
2203 return error("Invalid record");
2205 MDValueList.assignValue(
2206 GET_OR_DISTINCT(DILexicalBlock, Record[0],
2207 (Context, getMDOrNull(Record[1]),
2208 getMDOrNull(Record[2]), Record[3], Record[4])),
2212 case bitc::METADATA_LEXICAL_BLOCK_FILE: {
2213 if (Record.size() != 4)
2214 return error("Invalid record");
2216 MDValueList.assignValue(
2217 GET_OR_DISTINCT(DILexicalBlockFile, Record[0],
2218 (Context, getMDOrNull(Record[1]),
2219 getMDOrNull(Record[2]), Record[3])),
2223 case bitc::METADATA_NAMESPACE: {
2224 if (Record.size() != 5)
2225 return error("Invalid record");
2227 MDValueList.assignValue(
2228 GET_OR_DISTINCT(DINamespace, Record[0],
2229 (Context, getMDOrNull(Record[1]),
2230 getMDOrNull(Record[2]), getMDString(Record[3]),
2235 case bitc::METADATA_TEMPLATE_TYPE: {
2236 if (Record.size() != 3)
2237 return error("Invalid record");
2239 MDValueList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter,
2241 (Context, getMDString(Record[1]),
2242 getMDOrNull(Record[2]))),
2246 case bitc::METADATA_TEMPLATE_VALUE: {
2247 if (Record.size() != 5)
2248 return error("Invalid record");
2250 MDValueList.assignValue(
2251 GET_OR_DISTINCT(DITemplateValueParameter, Record[0],
2252 (Context, Record[1], getMDString(Record[2]),
2253 getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
2257 case bitc::METADATA_GLOBAL_VAR: {
2258 if (Record.size() != 11)
2259 return error("Invalid record");
2261 MDValueList.assignValue(
2262 GET_OR_DISTINCT(DIGlobalVariable, Record[0],
2263 (Context, getMDOrNull(Record[1]),
2264 getMDString(Record[2]), getMDString(Record[3]),
2265 getMDOrNull(Record[4]), Record[5],
2266 getMDOrNull(Record[6]), Record[7], Record[8],
2267 getMDOrNull(Record[9]), getMDOrNull(Record[10]))),
2271 case bitc::METADATA_LOCAL_VAR: {
2272 // 10th field is for the obseleted 'inlinedAt:' field.
2273 if (Record.size() < 8 || Record.size() > 10)
2274 return error("Invalid record");
2276 // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or
2277 // DW_TAG_arg_variable.
2278 bool HasTag = Record.size() > 8;
2279 MDValueList.assignValue(
2280 GET_OR_DISTINCT(DILocalVariable, Record[0],
2281 (Context, getMDOrNull(Record[1 + HasTag]),
2282 getMDString(Record[2 + HasTag]),
2283 getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag],
2284 getMDOrNull(Record[5 + HasTag]), Record[6 + HasTag],
2285 Record[7 + HasTag])),
2289 case bitc::METADATA_EXPRESSION: {
2290 if (Record.size() < 1)
2291 return error("Invalid record");
2293 MDValueList.assignValue(
2294 GET_OR_DISTINCT(DIExpression, Record[0],
2295 (Context, makeArrayRef(Record).slice(1))),
2299 case bitc::METADATA_OBJC_PROPERTY: {
2300 if (Record.size() != 8)
2301 return error("Invalid record");
2303 MDValueList.assignValue(
2304 GET_OR_DISTINCT(DIObjCProperty, Record[0],
2305 (Context, getMDString(Record[1]),
2306 getMDOrNull(Record[2]), Record[3],
2307 getMDString(Record[4]), getMDString(Record[5]),
2308 Record[6], getMDOrNull(Record[7]))),
2312 case bitc::METADATA_IMPORTED_ENTITY: {
2313 if (Record.size() != 6)
2314 return error("Invalid record");
2316 MDValueList.assignValue(
2317 GET_OR_DISTINCT(DIImportedEntity, Record[0],
2318 (Context, Record[1], getMDOrNull(Record[2]),
2319 getMDOrNull(Record[3]), Record[4],
2320 getMDString(Record[5]))),
2324 case bitc::METADATA_STRING: {
2325 std::string String(Record.begin(), Record.end());
2326 llvm::UpgradeMDStringConstant(String);
2327 Metadata *MD = MDString::get(Context, String);
2328 MDValueList.assignValue(MD, NextMDValueNo++);
2331 case bitc::METADATA_KIND: {
2332 if (Record.size() < 2)
2333 return error("Invalid record");
2335 unsigned Kind = Record[0];
2336 SmallString<8> Name(Record.begin()+1, Record.end());
2338 unsigned NewKind = TheModule->getMDKindID(Name.str());
2339 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
2340 return error("Conflicting METADATA_KIND records");
2345 #undef GET_OR_DISTINCT
2348 /// Decode a signed value stored with the sign bit in the LSB for dense VBR
2350 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
2355 // There is no such thing as -0 with integers. "-0" really means MININT.
2359 /// Resolve all of the initializers for global values and aliases that we can.
2360 std::error_code BitcodeReader::resolveGlobalAndAliasInits() {
2361 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
2362 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
2363 std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
2364 std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
2365 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFnWorklist;
2367 GlobalInitWorklist.swap(GlobalInits);
2368 AliasInitWorklist.swap(AliasInits);
2369 FunctionPrefixWorklist.swap(FunctionPrefixes);
2370 FunctionPrologueWorklist.swap(FunctionPrologues);
2371 FunctionPersonalityFnWorklist.swap(FunctionPersonalityFns);
2373 while (!GlobalInitWorklist.empty()) {
2374 unsigned ValID = GlobalInitWorklist.back().second;
2375 if (ValID >= ValueList.size()) {
2376 // Not ready to resolve this yet, it requires something later in the file.
2377 GlobalInits.push_back(GlobalInitWorklist.back());
2379 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2380 GlobalInitWorklist.back().first->setInitializer(C);
2382 return error("Expected a constant");
2384 GlobalInitWorklist.pop_back();
2387 while (!AliasInitWorklist.empty()) {
2388 unsigned ValID = AliasInitWorklist.back().second;
2389 if (ValID >= ValueList.size()) {
2390 AliasInits.push_back(AliasInitWorklist.back());
2392 Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]);
2394 return error("Expected a constant");
2395 GlobalAlias *Alias = AliasInitWorklist.back().first;
2396 if (C->getType() != Alias->getType())
2397 return error("Alias and aliasee types don't match");
2398 Alias->setAliasee(C);
2400 AliasInitWorklist.pop_back();
2403 while (!FunctionPrefixWorklist.empty()) {
2404 unsigned ValID = FunctionPrefixWorklist.back().second;
2405 if (ValID >= ValueList.size()) {
2406 FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2408 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2409 FunctionPrefixWorklist.back().first->setPrefixData(C);
2411 return error("Expected a constant");
2413 FunctionPrefixWorklist.pop_back();
2416 while (!FunctionPrologueWorklist.empty()) {
2417 unsigned ValID = FunctionPrologueWorklist.back().second;
2418 if (ValID >= ValueList.size()) {
2419 FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2421 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2422 FunctionPrologueWorklist.back().first->setPrologueData(C);
2424 return error("Expected a constant");
2426 FunctionPrologueWorklist.pop_back();
2429 while (!FunctionPersonalityFnWorklist.empty()) {
2430 unsigned ValID = FunctionPersonalityFnWorklist.back().second;
2431 if (ValID >= ValueList.size()) {
2432 FunctionPersonalityFns.push_back(FunctionPersonalityFnWorklist.back());
2434 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2435 FunctionPersonalityFnWorklist.back().first->setPersonalityFn(C);
2437 return error("Expected a constant");
2439 FunctionPersonalityFnWorklist.pop_back();
2442 return std::error_code();
2445 static APInt readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
2446 SmallVector<uint64_t, 8> Words(Vals.size());
2447 std::transform(Vals.begin(), Vals.end(), Words.begin(),
2448 BitcodeReader::decodeSignRotatedValue);
2450 return APInt(TypeBits, Words);
2453 std::error_code BitcodeReader::parseConstants() {
2454 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
2455 return error("Invalid record");
2457 SmallVector<uint64_t, 64> Record;
2459 // Read all the records for this value table.
2460 Type *CurTy = Type::getInt32Ty(Context);
2461 unsigned NextCstNo = ValueList.size();
2463 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2465 switch (Entry.Kind) {
2466 case BitstreamEntry::SubBlock: // Handled for us already.
2467 case BitstreamEntry::Error:
2468 return error("Malformed block");
2469 case BitstreamEntry::EndBlock:
2470 if (NextCstNo != ValueList.size())
2471 return error("Invalid ronstant reference");
2473 // Once all the constants have been read, go through and resolve forward
2475 ValueList.resolveConstantForwardRefs();
2476 return std::error_code();
2477 case BitstreamEntry::Record:
2478 // The interesting case.
2485 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2487 default: // Default behavior: unknown constant
2488 case bitc::CST_CODE_UNDEF: // UNDEF
2489 V = UndefValue::get(CurTy);
2491 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
2493 return error("Invalid record");
2494 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
2495 return error("Invalid record");
2496 CurTy = TypeList[Record[0]];
2497 continue; // Skip the ValueList manipulation.
2498 case bitc::CST_CODE_NULL: // NULL
2499 V = Constant::getNullValue(CurTy);
2501 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
2502 if (!CurTy->isIntegerTy() || Record.empty())
2503 return error("Invalid record");
2504 V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
2506 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
2507 if (!CurTy->isIntegerTy() || Record.empty())
2508 return error("Invalid record");
2511 readWideAPInt(Record, cast<IntegerType>(CurTy)->getBitWidth());
2512 V = ConstantInt::get(Context, VInt);
2516 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
2518 return error("Invalid record");
2519 if (CurTy->isHalfTy())
2520 V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
2521 APInt(16, (uint16_t)Record[0])));
2522 else if (CurTy->isFloatTy())
2523 V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
2524 APInt(32, (uint32_t)Record[0])));
2525 else if (CurTy->isDoubleTy())
2526 V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
2527 APInt(64, Record[0])));
2528 else if (CurTy->isX86_FP80Ty()) {
2529 // Bits are not stored the same way as a normal i80 APInt, compensate.
2530 uint64_t Rearrange[2];
2531 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2532 Rearrange[1] = Record[0] >> 48;
2533 V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
2534 APInt(80, Rearrange)));
2535 } else if (CurTy->isFP128Ty())
2536 V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
2537 APInt(128, Record)));
2538 else if (CurTy->isPPC_FP128Ty())
2539 V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
2540 APInt(128, Record)));
2542 V = UndefValue::get(CurTy);
2546 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2548 return error("Invalid record");
2550 unsigned Size = Record.size();
2551 SmallVector<Constant*, 16> Elts;
2553 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2554 for (unsigned i = 0; i != Size; ++i)
2555 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
2556 STy->getElementType(i)));
2557 V = ConstantStruct::get(STy, Elts);
2558 } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2559 Type *EltTy = ATy->getElementType();
2560 for (unsigned i = 0; i != Size; ++i)
2561 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2562 V = ConstantArray::get(ATy, Elts);
2563 } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2564 Type *EltTy = VTy->getElementType();
2565 for (unsigned i = 0; i != Size; ++i)
2566 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2567 V = ConstantVector::get(Elts);
2569 V = UndefValue::get(CurTy);
2573 case bitc::CST_CODE_STRING: // STRING: [values]
2574 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2576 return error("Invalid record");
2578 SmallString<16> Elts(Record.begin(), Record.end());
2579 V = ConstantDataArray::getString(Context, Elts,
2580 BitCode == bitc::CST_CODE_CSTRING);
2583 case bitc::CST_CODE_DATA: {// DATA: [n x value]
2585 return error("Invalid record");
2587 Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
2588 unsigned Size = Record.size();
2590 if (EltTy->isIntegerTy(8)) {
2591 SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2592 if (isa<VectorType>(CurTy))
2593 V = ConstantDataVector::get(Context, Elts);
2595 V = ConstantDataArray::get(Context, Elts);
2596 } else if (EltTy->isIntegerTy(16)) {
2597 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2598 if (isa<VectorType>(CurTy))
2599 V = ConstantDataVector::get(Context, Elts);
2601 V = ConstantDataArray::get(Context, Elts);
2602 } else if (EltTy->isIntegerTy(32)) {
2603 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2604 if (isa<VectorType>(CurTy))
2605 V = ConstantDataVector::get(Context, Elts);
2607 V = ConstantDataArray::get(Context, Elts);
2608 } else if (EltTy->isIntegerTy(64)) {
2609 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2610 if (isa<VectorType>(CurTy))
2611 V = ConstantDataVector::get(Context, Elts);
2613 V = ConstantDataArray::get(Context, Elts);
2614 } else if (EltTy->isFloatTy()) {
2615 SmallVector<float, 16> Elts(Size);
2616 std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
2617 if (isa<VectorType>(CurTy))
2618 V = ConstantDataVector::get(Context, Elts);
2620 V = ConstantDataArray::get(Context, Elts);
2621 } else if (EltTy->isDoubleTy()) {
2622 SmallVector<double, 16> Elts(Size);
2623 std::transform(Record.begin(), Record.end(), Elts.begin(),
2625 if (isa<VectorType>(CurTy))
2626 V = ConstantDataVector::get(Context, Elts);
2628 V = ConstantDataArray::get(Context, Elts);
2630 return error("Invalid type for value");
2635 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
2636 if (Record.size() < 3)
2637 return error("Invalid record");
2638 int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
2640 V = UndefValue::get(CurTy); // Unknown binop.
2642 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2643 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
2645 if (Record.size() >= 4) {
2646 if (Opc == Instruction::Add ||
2647 Opc == Instruction::Sub ||
2648 Opc == Instruction::Mul ||
2649 Opc == Instruction::Shl) {
2650 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2651 Flags |= OverflowingBinaryOperator::NoSignedWrap;
2652 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2653 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2654 } else if (Opc == Instruction::SDiv ||
2655 Opc == Instruction::UDiv ||
2656 Opc == Instruction::LShr ||
2657 Opc == Instruction::AShr) {
2658 if (Record[3] & (1 << bitc::PEO_EXACT))
2659 Flags |= SDivOperator::IsExact;
2662 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
2666 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
2667 if (Record.size() < 3)
2668 return error("Invalid record");
2669 int Opc = getDecodedCastOpcode(Record[0]);
2671 V = UndefValue::get(CurTy); // Unknown cast.
2673 Type *OpTy = getTypeByID(Record[1]);
2675 return error("Invalid record");
2676 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
2677 V = UpgradeBitCastExpr(Opc, Op, CurTy);
2678 if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
2682 case bitc::CST_CODE_CE_INBOUNDS_GEP:
2683 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
2685 Type *PointeeType = nullptr;
2686 if (Record.size() % 2)
2687 PointeeType = getTypeByID(Record[OpNum++]);
2688 SmallVector<Constant*, 16> Elts;
2689 while (OpNum != Record.size()) {
2690 Type *ElTy = getTypeByID(Record[OpNum++]);
2692 return error("Invalid record");
2693 Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
2698 cast<SequentialType>(Elts[0]->getType()->getScalarType())
2700 return error("Explicit gep operator type does not match pointee type "
2701 "of pointer operand");
2703 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2704 V = ConstantExpr::getGetElementPtr(PointeeType, Elts[0], Indices,
2706 bitc::CST_CODE_CE_INBOUNDS_GEP);
2709 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
2710 if (Record.size() < 3)
2711 return error("Invalid record");
2713 Type *SelectorTy = Type::getInt1Ty(Context);
2715 // The selector might be an i1 or an <n x i1>
2716 // Get the type from the ValueList before getting a forward ref.
2717 if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
2718 if (Value *V = ValueList[Record[0]])
2719 if (SelectorTy != V->getType())
2720 SelectorTy = VectorType::get(SelectorTy, VTy->getNumElements());
2722 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2724 ValueList.getConstantFwdRef(Record[1],CurTy),
2725 ValueList.getConstantFwdRef(Record[2],CurTy));
2728 case bitc::CST_CODE_CE_EXTRACTELT
2729 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
2730 if (Record.size() < 3)
2731 return error("Invalid record");
2733 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2735 return error("Invalid record");
2736 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2737 Constant *Op1 = nullptr;
2738 if (Record.size() == 4) {
2739 Type *IdxTy = getTypeByID(Record[2]);
2741 return error("Invalid record");
2742 Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2743 } else // TODO: Remove with llvm 4.0
2744 Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2746 return error("Invalid record");
2747 V = ConstantExpr::getExtractElement(Op0, Op1);
2750 case bitc::CST_CODE_CE_INSERTELT
2751 : { // CE_INSERTELT: [opval, opval, opty, opval]
2752 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2753 if (Record.size() < 3 || !OpTy)
2754 return error("Invalid record");
2755 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2756 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2757 OpTy->getElementType());
2758 Constant *Op2 = nullptr;
2759 if (Record.size() == 4) {
2760 Type *IdxTy = getTypeByID(Record[2]);
2762 return error("Invalid record");
2763 Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2764 } else // TODO: Remove with llvm 4.0
2765 Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2767 return error("Invalid record");
2768 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
2771 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
2772 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2773 if (Record.size() < 3 || !OpTy)
2774 return error("Invalid record");
2775 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2776 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
2777 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2778 OpTy->getNumElements());
2779 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
2780 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2783 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
2784 VectorType *RTy = dyn_cast<VectorType>(CurTy);
2786 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2787 if (Record.size() < 4 || !RTy || !OpTy)
2788 return error("Invalid record");
2789 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2790 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2791 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2792 RTy->getNumElements());
2793 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
2794 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2797 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
2798 if (Record.size() < 4)
2799 return error("Invalid record");
2800 Type *OpTy = getTypeByID(Record[0]);
2802 return error("Invalid record");
2803 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2804 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2806 if (OpTy->isFPOrFPVectorTy())
2807 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
2809 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
2812 // This maintains backward compatibility, pre-asm dialect keywords.
2813 // FIXME: Remove with the 4.0 release.
2814 case bitc::CST_CODE_INLINEASM_OLD: {
2815 if (Record.size() < 2)
2816 return error("Invalid record");
2817 std::string AsmStr, ConstrStr;
2818 bool HasSideEffects = Record[0] & 1;
2819 bool IsAlignStack = Record[0] >> 1;
2820 unsigned AsmStrSize = Record[1];
2821 if (2+AsmStrSize >= Record.size())
2822 return error("Invalid record");
2823 unsigned ConstStrSize = Record[2+AsmStrSize];
2824 if (3+AsmStrSize+ConstStrSize > Record.size())
2825 return error("Invalid record");
2827 for (unsigned i = 0; i != AsmStrSize; ++i)
2828 AsmStr += (char)Record[2+i];
2829 for (unsigned i = 0; i != ConstStrSize; ++i)
2830 ConstrStr += (char)Record[3+AsmStrSize+i];
2831 PointerType *PTy = cast<PointerType>(CurTy);
2832 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2833 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
2836 // This version adds support for the asm dialect keywords (e.g.,
2838 case bitc::CST_CODE_INLINEASM: {
2839 if (Record.size() < 2)
2840 return error("Invalid record");
2841 std::string AsmStr, ConstrStr;
2842 bool HasSideEffects = Record[0] & 1;
2843 bool IsAlignStack = (Record[0] >> 1) & 1;
2844 unsigned AsmDialect = Record[0] >> 2;
2845 unsigned AsmStrSize = Record[1];
2846 if (2+AsmStrSize >= Record.size())
2847 return error("Invalid record");
2848 unsigned ConstStrSize = Record[2+AsmStrSize];
2849 if (3+AsmStrSize+ConstStrSize > Record.size())
2850 return error("Invalid record");
2852 for (unsigned i = 0; i != AsmStrSize; ++i)
2853 AsmStr += (char)Record[2+i];
2854 for (unsigned i = 0; i != ConstStrSize; ++i)
2855 ConstrStr += (char)Record[3+AsmStrSize+i];
2856 PointerType *PTy = cast<PointerType>(CurTy);
2857 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2858 AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
2859 InlineAsm::AsmDialect(AsmDialect));
2862 case bitc::CST_CODE_BLOCKADDRESS:{
2863 if (Record.size() < 3)
2864 return error("Invalid record");
2865 Type *FnTy = getTypeByID(Record[0]);
2867 return error("Invalid record");
2869 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
2871 return error("Invalid record");
2873 // Don't let Fn get dematerialized.
2874 BlockAddressesTaken.insert(Fn);
2876 // If the function is already parsed we can insert the block address right
2879 unsigned BBID = Record[2];
2881 // Invalid reference to entry block.
2882 return error("Invalid ID");
2884 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
2885 for (size_t I = 0, E = BBID; I != E; ++I) {
2887 return error("Invalid ID");
2892 // Otherwise insert a placeholder and remember it so it can be inserted
2893 // when the function is parsed.
2894 auto &FwdBBs = BasicBlockFwdRefs[Fn];
2896 BasicBlockFwdRefQueue.push_back(Fn);
2897 if (FwdBBs.size() < BBID + 1)
2898 FwdBBs.resize(BBID + 1);
2900 FwdBBs[BBID] = BasicBlock::Create(Context);
2903 V = BlockAddress::get(Fn, BB);
2908 if (ValueList.assignValue(V, NextCstNo))
2909 return error("Invalid forward reference");
2914 std::error_code BitcodeReader::parseUseLists() {
2915 if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
2916 return error("Invalid record");
2918 // Read all the records.
2919 SmallVector<uint64_t, 64> Record;
2921 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2923 switch (Entry.Kind) {
2924 case BitstreamEntry::SubBlock: // Handled for us already.
2925 case BitstreamEntry::Error:
2926 return error("Malformed block");
2927 case BitstreamEntry::EndBlock:
2928 return std::error_code();
2929 case BitstreamEntry::Record:
2930 // The interesting case.
2934 // Read a use list record.
2937 switch (Stream.readRecord(Entry.ID, Record)) {
2938 default: // Default behavior: unknown type.
2940 case bitc::USELIST_CODE_BB:
2943 case bitc::USELIST_CODE_DEFAULT: {
2944 unsigned RecordLength = Record.size();
2945 if (RecordLength < 3)
2946 // Records should have at least an ID and two indexes.
2947 return error("Invalid record");
2948 unsigned ID = Record.back();
2953 assert(ID < FunctionBBs.size() && "Basic block not found");
2954 V = FunctionBBs[ID];
2957 unsigned NumUses = 0;
2958 SmallDenseMap<const Use *, unsigned, 16> Order;
2959 for (const Use &U : V->uses()) {
2960 if (++NumUses > Record.size())
2962 Order[&U] = Record[NumUses - 1];
2964 if (Order.size() != Record.size() || NumUses > Record.size())
2965 // Mismatches can happen if the functions are being materialized lazily
2966 // (out-of-order), or a value has been upgraded.
2969 V->sortUseList([&](const Use &L, const Use &R) {
2970 return Order.lookup(&L) < Order.lookup(&R);
2978 /// When we see the block for metadata, remember where it is and then skip it.
2979 /// This lets us lazily deserialize the metadata.
2980 std::error_code BitcodeReader::rememberAndSkipMetadata() {
2981 // Save the current stream state.
2982 uint64_t CurBit = Stream.GetCurrentBitNo();
2983 DeferredMetadataInfo.push_back(CurBit);
2985 // Skip over the block for now.
2986 if (Stream.SkipBlock())
2987 return error("Invalid record");
2988 return std::error_code();
2991 std::error_code BitcodeReader::materializeMetadata() {
2992 for (uint64_t BitPos : DeferredMetadataInfo) {
2993 // Move the bit stream to the saved position.
2994 Stream.JumpToBit(BitPos);
2995 if (std::error_code EC = parseMetadata())
2998 DeferredMetadataInfo.clear();
2999 return std::error_code();
3002 void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
3004 /// When we see the block for a function body, remember where it is and then
3005 /// skip it. This lets us lazily deserialize the functions.
3006 std::error_code BitcodeReader::rememberAndSkipFunctionBody() {
3007 // Get the function we are talking about.
3008 if (FunctionsWithBodies.empty())
3009 return error("Insufficient function protos");
3011 Function *Fn = FunctionsWithBodies.back();
3012 FunctionsWithBodies.pop_back();
3014 // Save the current stream state.
3015 uint64_t CurBit = Stream.GetCurrentBitNo();
3017 (DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&
3018 "Mismatch between VST and scanned function offsets");
3019 DeferredFunctionInfo[Fn] = CurBit;
3021 // Skip over the function block for now.
3022 if (Stream.SkipBlock())
3023 return error("Invalid record");
3024 return std::error_code();
3027 std::error_code BitcodeReader::globalCleanup() {
3028 // Patch the initializers for globals and aliases up.
3029 resolveGlobalAndAliasInits();
3030 if (!GlobalInits.empty() || !AliasInits.empty())
3031 return error("Malformed global initializer set");
3033 // Look for intrinsic functions which need to be upgraded at some point
3034 for (Function &F : *TheModule) {
3036 if (UpgradeIntrinsicFunction(&F, NewFn))
3037 UpgradedIntrinsics[&F] = NewFn;
3040 // Look for global variables which need to be renamed.
3041 for (GlobalVariable &GV : TheModule->globals())
3042 UpgradeGlobalVariable(&GV);
3044 // Force deallocation of memory for these vectors to favor the client that
3045 // want lazy deserialization.
3046 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
3047 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
3048 return std::error_code();
3051 /// Support for lazy parsing of function bodies. This is required if we
3052 /// either have an old bitcode file without a VST forward declaration record,
3053 /// or if we have an anonymous function being materialized, since anonymous
3054 /// functions do not have a name and are therefore not in the VST.
3055 std::error_code BitcodeReader::rememberAndSkipFunctionBodies() {
3056 Stream.JumpToBit(NextUnreadBit);
3058 if (Stream.AtEndOfStream())
3059 return error("Could not find function in stream");
3061 if (!SeenFirstFunctionBody)
3062 return error("Trying to materialize functions before seeing function blocks");
3064 // An old bitcode file with the symbol table at the end would have
3065 // finished the parse greedily.
3066 assert(SeenValueSymbolTable);
3068 SmallVector<uint64_t, 64> Record;
3071 BitstreamEntry Entry = Stream.advance();
3072 switch (Entry.Kind) {
3074 return error("Expect SubBlock");
3075 case BitstreamEntry::SubBlock:
3078 return error("Expect function block");
3079 case bitc::FUNCTION_BLOCK_ID:
3080 if (std::error_code EC = rememberAndSkipFunctionBody())
3082 NextUnreadBit = Stream.GetCurrentBitNo();
3083 return std::error_code();
3089 std::error_code BitcodeReader::parseBitcodeVersion() {
3090 if (Stream.EnterSubBlock(bitc::IDENTIFICATION_BLOCK_ID))
3091 return error("Invalid record");
3093 // Read all the records.
3094 SmallVector<uint64_t, 64> Record;
3096 BitstreamEntry Entry = Stream.advance();
3098 switch (Entry.Kind) {
3100 case BitstreamEntry::Error:
3101 return error("Malformed block");
3102 case BitstreamEntry::EndBlock:
3103 return std::error_code();
3104 case BitstreamEntry::Record:
3105 // The interesting case.
3111 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
3113 default: // Default behavior: reject
3114 return error("Invalid value");
3115 case bitc::IDENTIFICATION_CODE_STRING: { // IDENTIFICATION: [strchr x
3117 convertToString(Record, 0, ProducerIdentification);
3120 case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH: [epoch#]
3121 unsigned epoch = (unsigned)Record[0];
3122 if (epoch != bitc::BITCODE_CURRENT_EPOCH) {
3124 Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +
3125 "' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");
3132 std::error_code BitcodeReader::parseModule(uint64_t ResumeBit,
3133 bool ShouldLazyLoadMetadata) {
3135 Stream.JumpToBit(ResumeBit);
3136 else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3137 return error("Invalid record");
3139 SmallVector<uint64_t, 64> Record;
3140 std::vector<std::string> SectionTable;
3141 std::vector<std::string> GCTable;
3143 // Read all the records for this module.
3145 BitstreamEntry Entry = Stream.advance();
3147 switch (Entry.Kind) {
3148 case BitstreamEntry::Error:
3149 return error("Malformed block");
3150 case BitstreamEntry::EndBlock:
3151 return globalCleanup();
3153 case BitstreamEntry::SubBlock:
3155 default: // Skip unknown content.
3156 if (Stream.SkipBlock())
3157 return error("Invalid record");
3159 case bitc::BLOCKINFO_BLOCK_ID:
3160 if (Stream.ReadBlockInfoBlock())
3161 return error("Malformed block");
3163 case bitc::PARAMATTR_BLOCK_ID:
3164 if (std::error_code EC = parseAttributeBlock())
3167 case bitc::PARAMATTR_GROUP_BLOCK_ID:
3168 if (std::error_code EC = parseAttributeGroupBlock())
3171 case bitc::TYPE_BLOCK_ID_NEW:
3172 if (std::error_code EC = parseTypeTable())
3175 case bitc::VALUE_SYMTAB_BLOCK_ID:
3176 if (!SeenValueSymbolTable) {
3177 // Either this is an old form VST without function index and an
3178 // associated VST forward declaration record (which would have caused
3179 // the VST to be jumped to and parsed before it was encountered
3180 // normally in the stream), or there were no function blocks to
3181 // trigger an earlier parsing of the VST.
3182 assert(VSTOffset == 0 || FunctionsWithBodies.empty());
3183 if (std::error_code EC = parseValueSymbolTable())
3185 SeenValueSymbolTable = true;
3187 // We must have had a VST forward declaration record, which caused
3188 // the parser to jump to and parse the VST earlier.
3189 assert(VSTOffset > 0);
3190 if (Stream.SkipBlock())
3191 return error("Invalid record");
3194 case bitc::CONSTANTS_BLOCK_ID:
3195 if (std::error_code EC = parseConstants())
3197 if (std::error_code EC = resolveGlobalAndAliasInits())
3200 case bitc::METADATA_BLOCK_ID:
3201 if (ShouldLazyLoadMetadata && !IsMetadataMaterialized) {
3202 if (std::error_code EC = rememberAndSkipMetadata())
3206 assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
3207 if (std::error_code EC = parseMetadata())
3210 case bitc::FUNCTION_BLOCK_ID:
3211 // If this is the first function body we've seen, reverse the
3212 // FunctionsWithBodies list.
3213 if (!SeenFirstFunctionBody) {
3214 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
3215 if (std::error_code EC = globalCleanup())
3217 SeenFirstFunctionBody = true;
3220 if (VSTOffset > 0) {
3221 // If we have a VST forward declaration record, make sure we
3222 // parse the VST now if we haven't already. It is needed to
3223 // set up the DeferredFunctionInfo vector for lazy reading.
3224 if (!SeenValueSymbolTable) {
3225 if (std::error_code EC =
3226 BitcodeReader::parseValueSymbolTable(VSTOffset))
3228 SeenValueSymbolTable = true;
3229 // Fall through so that we record the NextUnreadBit below.
3230 // This is necessary in case we have an anonymous function that
3231 // is later materialized. Since it will not have a VST entry we
3232 // need to fall back to the lazy parse to find its offset.
3234 // If we have a VST forward declaration record, but have already
3235 // parsed the VST (just above, when the first function body was
3236 // encountered here), then we are resuming the parse after
3237 // materializing functions. The ResumeBit points to the
3238 // start of the last function block recorded in the
3239 // DeferredFunctionInfo map. Skip it.
3240 if (Stream.SkipBlock())
3241 return error("Invalid record");
3246 // Support older bitcode files that did not have the function
3247 // index in the VST, nor a VST forward declaration record, as
3248 // well as anonymous functions that do not have VST entries.
3249 // Build the DeferredFunctionInfo vector on the fly.
3250 if (std::error_code EC = rememberAndSkipFunctionBody())
3253 // Suspend parsing when we reach the function bodies. Subsequent
3254 // materialization calls will resume it when necessary. If the bitcode
3255 // file is old, the symbol table will be at the end instead and will not
3256 // have been seen yet. In this case, just finish the parse now.
3257 if (SeenValueSymbolTable) {
3258 NextUnreadBit = Stream.GetCurrentBitNo();
3259 return std::error_code();
3262 case bitc::USELIST_BLOCK_ID:
3263 if (std::error_code EC = parseUseLists())
3266 case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
3267 if (std::error_code EC = parseOperandBundleTags())
3273 case BitstreamEntry::Record:
3274 // The interesting case.
3280 auto BitCode = Stream.readRecord(Entry.ID, Record);
3282 default: break; // Default behavior, ignore unknown content.
3283 case bitc::MODULE_CODE_VERSION: { // VERSION: [version#]
3284 if (Record.size() < 1)
3285 return error("Invalid record");
3286 // Only version #0 and #1 are supported so far.
3287 unsigned module_version = Record[0];
3288 switch (module_version) {
3290 return error("Invalid value");
3292 UseRelativeIDs = false;
3295 UseRelativeIDs = true;
3300 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
3302 if (convertToString(Record, 0, S))
3303 return error("Invalid record");
3304 TheModule->setTargetTriple(S);
3307 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
3309 if (convertToString(Record, 0, S))
3310 return error("Invalid record");
3311 TheModule->setDataLayout(S);
3314 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
3316 if (convertToString(Record, 0, S))
3317 return error("Invalid record");
3318 TheModule->setModuleInlineAsm(S);
3321 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
3322 // FIXME: Remove in 4.0.
3324 if (convertToString(Record, 0, S))
3325 return error("Invalid record");
3329 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
3331 if (convertToString(Record, 0, S))
3332 return error("Invalid record");
3333 SectionTable.push_back(S);
3336 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
3338 if (convertToString(Record, 0, S))
3339 return error("Invalid record");
3340 GCTable.push_back(S);
3343 case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
3344 if (Record.size() < 2)
3345 return error("Invalid record");
3346 Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
3347 unsigned ComdatNameSize = Record[1];
3348 std::string ComdatName;
3349 ComdatName.reserve(ComdatNameSize);
3350 for (unsigned i = 0; i != ComdatNameSize; ++i)
3351 ComdatName += (char)Record[2 + i];
3352 Comdat *C = TheModule->getOrInsertComdat(ComdatName);
3353 C->setSelectionKind(SK);
3354 ComdatList.push_back(C);
3357 // GLOBALVAR: [pointer type, isconst, initid,
3358 // linkage, alignment, section, visibility, threadlocal,
3359 // unnamed_addr, externally_initialized, dllstorageclass,
3361 case bitc::MODULE_CODE_GLOBALVAR: {
3362 if (Record.size() < 6)
3363 return error("Invalid record");
3364 Type *Ty = getTypeByID(Record[0]);
3366 return error("Invalid record");
3367 bool isConstant = Record[1] & 1;
3368 bool explicitType = Record[1] & 2;
3369 unsigned AddressSpace;
3371 AddressSpace = Record[1] >> 2;
3373 if (!Ty->isPointerTy())
3374 return error("Invalid type for value");
3375 AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
3376 Ty = cast<PointerType>(Ty)->getElementType();
3379 uint64_t RawLinkage = Record[3];
3380 GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
3382 if (std::error_code EC = parseAlignmentValue(Record[4], Alignment))
3384 std::string Section;
3386 if (Record[5]-1 >= SectionTable.size())
3387 return error("Invalid ID");
3388 Section = SectionTable[Record[5]-1];
3390 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
3391 // Local linkage must have default visibility.
3392 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
3393 // FIXME: Change to an error if non-default in 4.0.
3394 Visibility = getDecodedVisibility(Record[6]);
3396 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
3397 if (Record.size() > 7)
3398 TLM = getDecodedThreadLocalMode(Record[7]);
3400 bool UnnamedAddr = false;
3401 if (Record.size() > 8)
3402 UnnamedAddr = Record[8];
3404 bool ExternallyInitialized = false;
3405 if (Record.size() > 9)
3406 ExternallyInitialized = Record[9];
3408 GlobalVariable *NewGV =
3409 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
3410 TLM, AddressSpace, ExternallyInitialized);
3411 NewGV->setAlignment(Alignment);
3412 if (!Section.empty())
3413 NewGV->setSection(Section);
3414 NewGV->setVisibility(Visibility);
3415 NewGV->setUnnamedAddr(UnnamedAddr);
3417 if (Record.size() > 10)
3418 NewGV->setDLLStorageClass(getDecodedDLLStorageClass(Record[10]));
3420 upgradeDLLImportExportLinkage(NewGV, RawLinkage);
3422 ValueList.push_back(NewGV);
3424 // Remember which value to use for the global initializer.
3425 if (unsigned InitID = Record[2])
3426 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
3428 if (Record.size() > 11) {
3429 if (unsigned ComdatID = Record[11]) {
3430 if (ComdatID > ComdatList.size())
3431 return error("Invalid global variable comdat ID");
3432 NewGV->setComdat(ComdatList[ComdatID - 1]);
3434 } else if (hasImplicitComdat(RawLinkage)) {
3435 NewGV->setComdat(reinterpret_cast<Comdat *>(1));
3439 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
3440 // alignment, section, visibility, gc, unnamed_addr,
3441 // prologuedata, dllstorageclass, comdat, prefixdata]
3442 case bitc::MODULE_CODE_FUNCTION: {
3443 if (Record.size() < 8)
3444 return error("Invalid record");
3445 Type *Ty = getTypeByID(Record[0]);
3447 return error("Invalid record");
3448 if (auto *PTy = dyn_cast<PointerType>(Ty))
3449 Ty = PTy->getElementType();
3450 auto *FTy = dyn_cast<FunctionType>(Ty);
3452 return error("Invalid type for value");
3453 auto CC = static_cast<CallingConv::ID>(Record[1]);
3454 if (CC & ~CallingConv::MaxID)
3455 return error("Invalid calling convention ID");
3457 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
3460 Func->setCallingConv(CC);
3461 bool isProto = Record[2];
3462 uint64_t RawLinkage = Record[3];
3463 Func->setLinkage(getDecodedLinkage(RawLinkage));
3464 Func->setAttributes(getAttributes(Record[4]));
3467 if (std::error_code EC = parseAlignmentValue(Record[5], Alignment))
3469 Func->setAlignment(Alignment);
3471 if (Record[6]-1 >= SectionTable.size())
3472 return error("Invalid ID");
3473 Func->setSection(SectionTable[Record[6]-1]);
3475 // Local linkage must have default visibility.
3476 if (!Func->hasLocalLinkage())
3477 // FIXME: Change to an error if non-default in 4.0.
3478 Func->setVisibility(getDecodedVisibility(Record[7]));
3479 if (Record.size() > 8 && Record[8]) {
3480 if (Record[8]-1 >= GCTable.size())
3481 return error("Invalid ID");
3482 Func->setGC(GCTable[Record[8]-1].c_str());
3484 bool UnnamedAddr = false;
3485 if (Record.size() > 9)
3486 UnnamedAddr = Record[9];
3487 Func->setUnnamedAddr(UnnamedAddr);
3488 if (Record.size() > 10 && Record[10] != 0)
3489 FunctionPrologues.push_back(std::make_pair(Func, Record[10]-1));
3491 if (Record.size() > 11)
3492 Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));
3494 upgradeDLLImportExportLinkage(Func, RawLinkage);
3496 if (Record.size() > 12) {
3497 if (unsigned ComdatID = Record[12]) {
3498 if (ComdatID > ComdatList.size())
3499 return error("Invalid function comdat ID");
3500 Func->setComdat(ComdatList[ComdatID - 1]);
3502 } else if (hasImplicitComdat(RawLinkage)) {
3503 Func->setComdat(reinterpret_cast<Comdat *>(1));
3506 if (Record.size() > 13 && Record[13] != 0)
3507 FunctionPrefixes.push_back(std::make_pair(Func, Record[13]-1));
3509 if (Record.size() > 14 && Record[14] != 0)
3510 FunctionPersonalityFns.push_back(std::make_pair(Func, Record[14] - 1));
3512 ValueList.push_back(Func);
3514 // If this is a function with a body, remember the prototype we are
3515 // creating now, so that we can match up the body with them later.
3517 Func->setIsMaterializable(true);
3518 FunctionsWithBodies.push_back(Func);
3519 DeferredFunctionInfo[Func] = 0;
3523 // ALIAS: [alias type, addrspace, aliasee val#, linkage]
3524 // ALIAS: [alias type, addrspace, aliasee val#, linkage, visibility, dllstorageclass]
3525 case bitc::MODULE_CODE_ALIAS:
3526 case bitc::MODULE_CODE_ALIAS_OLD: {
3527 bool NewRecord = BitCode == bitc::MODULE_CODE_ALIAS;
3528 if (Record.size() < (3 + (unsigned)NewRecord))
3529 return error("Invalid record");
3531 Type *Ty = getTypeByID(Record[OpNum++]);
3533 return error("Invalid record");
3537 auto *PTy = dyn_cast<PointerType>(Ty);
3539 return error("Invalid type for value");
3540 Ty = PTy->getElementType();
3541 AddrSpace = PTy->getAddressSpace();
3543 AddrSpace = Record[OpNum++];
3546 auto Val = Record[OpNum++];
3547 auto Linkage = Record[OpNum++];
3548 auto *NewGA = GlobalAlias::create(
3549 Ty, AddrSpace, getDecodedLinkage(Linkage), "", TheModule);
3550 // Old bitcode files didn't have visibility field.
3551 // Local linkage must have default visibility.
3552 if (OpNum != Record.size()) {
3553 auto VisInd = OpNum++;
3554 if (!NewGA->hasLocalLinkage())
3555 // FIXME: Change to an error if non-default in 4.0.
3556 NewGA->setVisibility(getDecodedVisibility(Record[VisInd]));
3558 if (OpNum != Record.size())
3559 NewGA->setDLLStorageClass(getDecodedDLLStorageClass(Record[OpNum++]));
3561 upgradeDLLImportExportLinkage(NewGA, Linkage);
3562 if (OpNum != Record.size())
3563 NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[OpNum++]));
3564 if (OpNum != Record.size())
3565 NewGA->setUnnamedAddr(Record[OpNum++]);
3566 ValueList.push_back(NewGA);
3567 AliasInits.push_back(std::make_pair(NewGA, Val));
3570 /// MODULE_CODE_PURGEVALS: [numvals]
3571 case bitc::MODULE_CODE_PURGEVALS:
3572 // Trim down the value list to the specified size.
3573 if (Record.size() < 1 || Record[0] > ValueList.size())
3574 return error("Invalid record");
3575 ValueList.shrinkTo(Record[0]);
3577 /// MODULE_CODE_VSTOFFSET: [offset]
3578 case bitc::MODULE_CODE_VSTOFFSET:
3579 if (Record.size() < 1)
3580 return error("Invalid record");
3581 VSTOffset = Record[0];
3588 /// Helper to read the header common to all bitcode files.
3589 static bool hasValidBitcodeHeader(BitstreamCursor &Stream) {
3590 // Sniff for the signature.
3591 if (Stream.Read(8) != 'B' ||
3592 Stream.Read(8) != 'C' ||
3593 Stream.Read(4) != 0x0 ||
3594 Stream.Read(4) != 0xC ||
3595 Stream.Read(4) != 0xE ||
3596 Stream.Read(4) != 0xD)
3602 BitcodeReader::parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
3603 Module *M, bool ShouldLazyLoadMetadata) {
3606 if (std::error_code EC = initStream(std::move(Streamer)))
3609 // Sniff for the signature.
3610 if (!hasValidBitcodeHeader(Stream))
3611 return error("Invalid bitcode signature");
3613 // We expect a number of well-defined blocks, though we don't necessarily
3614 // need to understand them all.
3616 if (Stream.AtEndOfStream()) {
3617 // We didn't really read a proper Module.
3618 return error("Malformed IR file");
3621 BitstreamEntry Entry =
3622 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
3624 if (Entry.Kind != BitstreamEntry::SubBlock)
3625 return error("Malformed block");
3627 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {
3628 parseBitcodeVersion();
3632 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3633 return parseModule(0, ShouldLazyLoadMetadata);
3635 if (Stream.SkipBlock())
3636 return error("Invalid record");
3640 ErrorOr<std::string> BitcodeReader::parseModuleTriple() {
3641 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3642 return error("Invalid record");
3644 SmallVector<uint64_t, 64> Record;
3647 // Read all the records for this module.
3649 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3651 switch (Entry.Kind) {
3652 case BitstreamEntry::SubBlock: // Handled for us already.
3653 case BitstreamEntry::Error:
3654 return error("Malformed block");
3655 case BitstreamEntry::EndBlock:
3657 case BitstreamEntry::Record:
3658 // The interesting case.
3663 switch (Stream.readRecord(Entry.ID, Record)) {
3664 default: break; // Default behavior, ignore unknown content.
3665 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
3667 if (convertToString(Record, 0, S))
3668 return error("Invalid record");
3675 llvm_unreachable("Exit infinite loop");
3678 ErrorOr<std::string> BitcodeReader::parseTriple() {
3679 if (std::error_code EC = initStream(nullptr))
3682 // Sniff for the signature.
3683 if (!hasValidBitcodeHeader(Stream))
3684 return error("Invalid bitcode signature");
3686 // We expect a number of well-defined blocks, though we don't necessarily
3687 // need to understand them all.
3689 BitstreamEntry Entry = Stream.advance();
3691 switch (Entry.Kind) {
3692 case BitstreamEntry::Error:
3693 return error("Malformed block");
3694 case BitstreamEntry::EndBlock:
3695 return std::error_code();
3697 case BitstreamEntry::SubBlock:
3698 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3699 return parseModuleTriple();
3701 // Ignore other sub-blocks.
3702 if (Stream.SkipBlock())
3703 return error("Malformed block");
3706 case BitstreamEntry::Record:
3707 Stream.skipRecord(Entry.ID);
3713 /// Parse metadata attachments.
3714 std::error_code BitcodeReader::parseMetadataAttachment(Function &F) {
3715 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
3716 return error("Invalid record");
3718 SmallVector<uint64_t, 64> Record;
3720 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3722 switch (Entry.Kind) {
3723 case BitstreamEntry::SubBlock: // Handled for us already.
3724 case BitstreamEntry::Error:
3725 return error("Malformed block");
3726 case BitstreamEntry::EndBlock:
3727 return std::error_code();
3728 case BitstreamEntry::Record:
3729 // The interesting case.
3733 // Read a metadata attachment record.
3735 switch (Stream.readRecord(Entry.ID, Record)) {
3736 default: // Default behavior: ignore.
3738 case bitc::METADATA_ATTACHMENT: {
3739 unsigned RecordLength = Record.size();
3741 return error("Invalid record");
3742 if (RecordLength % 2 == 0) {
3743 // A function attachment.
3744 for (unsigned I = 0; I != RecordLength; I += 2) {
3745 auto K = MDKindMap.find(Record[I]);
3746 if (K == MDKindMap.end())
3747 return error("Invalid ID");
3748 Metadata *MD = MDValueList.getValueFwdRef(Record[I + 1]);
3749 F.setMetadata(K->second, cast<MDNode>(MD));
3754 // An instruction attachment.
3755 Instruction *Inst = InstructionList[Record[0]];
3756 for (unsigned i = 1; i != RecordLength; i = i+2) {
3757 unsigned Kind = Record[i];
3758 DenseMap<unsigned, unsigned>::iterator I =
3759 MDKindMap.find(Kind);
3760 if (I == MDKindMap.end())
3761 return error("Invalid ID");
3762 Metadata *Node = MDValueList.getValueFwdRef(Record[i + 1]);
3763 if (isa<LocalAsMetadata>(Node))
3764 // Drop the attachment. This used to be legal, but there's no
3767 Inst->setMetadata(I->second, cast<MDNode>(Node));
3768 if (I->second == LLVMContext::MD_tbaa)
3769 InstsWithTBAATag.push_back(Inst);
3777 static std::error_code typeCheckLoadStoreInst(DiagnosticHandlerFunction DH,
3778 Type *ValType, Type *PtrType) {
3779 if (!isa<PointerType>(PtrType))
3780 return error(DH, "Load/Store operand is not a pointer type");
3781 Type *ElemType = cast<PointerType>(PtrType)->getElementType();
3783 if (ValType && ValType != ElemType)
3784 return error(DH, "Explicit load/store type does not match pointee type of "
3786 if (!PointerType::isLoadableOrStorableType(ElemType))
3787 return error(DH, "Cannot load/store from pointer");
3788 return std::error_code();
3791 /// Lazily parse the specified function body block.
3792 std::error_code BitcodeReader::parseFunctionBody(Function *F) {
3793 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
3794 return error("Invalid record");
3796 InstructionList.clear();
3797 unsigned ModuleValueListSize = ValueList.size();
3798 unsigned ModuleMDValueListSize = MDValueList.size();
3800 // Add all the function arguments to the value table.
3801 for (Argument &I : F->args())
3802 ValueList.push_back(&I);
3804 unsigned NextValueNo = ValueList.size();
3805 BasicBlock *CurBB = nullptr;
3806 unsigned CurBBNo = 0;
3809 auto getLastInstruction = [&]() -> Instruction * {
3810 if (CurBB && !CurBB->empty())
3811 return &CurBB->back();
3812 else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
3813 !FunctionBBs[CurBBNo - 1]->empty())
3814 return &FunctionBBs[CurBBNo - 1]->back();
3818 std::vector<OperandBundleDef> OperandBundles;
3820 // Read all the records.
3821 SmallVector<uint64_t, 64> Record;
3823 BitstreamEntry Entry = Stream.advance();
3825 switch (Entry.Kind) {
3826 case BitstreamEntry::Error:
3827 return error("Malformed block");
3828 case BitstreamEntry::EndBlock:
3829 goto OutOfRecordLoop;
3831 case BitstreamEntry::SubBlock:
3833 default: // Skip unknown content.
3834 if (Stream.SkipBlock())
3835 return error("Invalid record");
3837 case bitc::CONSTANTS_BLOCK_ID:
3838 if (std::error_code EC = parseConstants())
3840 NextValueNo = ValueList.size();
3842 case bitc::VALUE_SYMTAB_BLOCK_ID:
3843 if (std::error_code EC = parseValueSymbolTable())
3846 case bitc::METADATA_ATTACHMENT_ID:
3847 if (std::error_code EC = parseMetadataAttachment(*F))
3850 case bitc::METADATA_BLOCK_ID:
3851 if (std::error_code EC = parseMetadata())
3854 case bitc::USELIST_BLOCK_ID:
3855 if (std::error_code EC = parseUseLists())
3861 case BitstreamEntry::Record:
3862 // The interesting case.
3868 Instruction *I = nullptr;
3869 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
3871 default: // Default behavior: reject
3872 return error("Invalid value");
3873 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
3874 if (Record.size() < 1 || Record[0] == 0)
3875 return error("Invalid record");
3876 // Create all the basic blocks for the function.
3877 FunctionBBs.resize(Record[0]);
3879 // See if anything took the address of blocks in this function.
3880 auto BBFRI = BasicBlockFwdRefs.find(F);
3881 if (BBFRI == BasicBlockFwdRefs.end()) {
3882 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
3883 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
3885 auto &BBRefs = BBFRI->second;
3886 // Check for invalid basic block references.
3887 if (BBRefs.size() > FunctionBBs.size())
3888 return error("Invalid ID");
3889 assert(!BBRefs.empty() && "Unexpected empty array");
3890 assert(!BBRefs.front() && "Invalid reference to entry block");
3891 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
3893 if (I < RE && BBRefs[I]) {
3894 BBRefs[I]->insertInto(F);
3895 FunctionBBs[I] = BBRefs[I];
3897 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
3900 // Erase from the table.
3901 BasicBlockFwdRefs.erase(BBFRI);
3904 CurBB = FunctionBBs[0];
3908 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
3909 // This record indicates that the last instruction is at the same
3910 // location as the previous instruction with a location.
3911 I = getLastInstruction();
3914 return error("Invalid record");
3915 I->setDebugLoc(LastLoc);
3919 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
3920 I = getLastInstruction();
3921 if (!I || Record.size() < 4)
3922 return error("Invalid record");
3924 unsigned Line = Record[0], Col = Record[1];
3925 unsigned ScopeID = Record[2], IAID = Record[3];
3927 MDNode *Scope = nullptr, *IA = nullptr;
3928 if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
3929 if (IAID) IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
3930 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
3931 I->setDebugLoc(LastLoc);
3936 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
3939 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3940 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
3941 OpNum+1 > Record.size())
3942 return error("Invalid record");
3944 int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
3946 return error("Invalid record");
3947 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
3948 InstructionList.push_back(I);
3949 if (OpNum < Record.size()) {
3950 if (Opc == Instruction::Add ||
3951 Opc == Instruction::Sub ||
3952 Opc == Instruction::Mul ||
3953 Opc == Instruction::Shl) {
3954 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
3955 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
3956 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
3957 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
3958 } else if (Opc == Instruction::SDiv ||
3959 Opc == Instruction::UDiv ||
3960 Opc == Instruction::LShr ||
3961 Opc == Instruction::AShr) {
3962 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
3963 cast<BinaryOperator>(I)->setIsExact(true);
3964 } else if (isa<FPMathOperator>(I)) {
3965 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
3967 I->setFastMathFlags(FMF);
3973 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
3976 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3977 OpNum+2 != Record.size())
3978 return error("Invalid record");
3980 Type *ResTy = getTypeByID(Record[OpNum]);
3981 int Opc = getDecodedCastOpcode(Record[OpNum + 1]);
3982 if (Opc == -1 || !ResTy)
3983 return error("Invalid record");
3984 Instruction *Temp = nullptr;
3985 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
3987 InstructionList.push_back(Temp);
3988 CurBB->getInstList().push_back(Temp);
3991 auto CastOp = (Instruction::CastOps)Opc;
3992 if (!CastInst::castIsValid(CastOp, Op, ResTy))
3993 return error("Invalid cast");
3994 I = CastInst::Create(CastOp, Op, ResTy);
3996 InstructionList.push_back(I);
3999 case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:
4000 case bitc::FUNC_CODE_INST_GEP_OLD:
4001 case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
4007 if (BitCode == bitc::FUNC_CODE_INST_GEP) {
4008 InBounds = Record[OpNum++];
4009 Ty = getTypeByID(Record[OpNum++]);
4011 InBounds = BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD;
4016 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
4017 return error("Invalid record");
4020 Ty = cast<SequentialType>(BasePtr->getType()->getScalarType())
4023 cast<SequentialType>(BasePtr->getType()->getScalarType())
4026 "Explicit gep type does not match pointee type of pointer operand");
4028 SmallVector<Value*, 16> GEPIdx;
4029 while (OpNum != Record.size()) {
4031 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4032 return error("Invalid record");
4033 GEPIdx.push_back(Op);
4036 I = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
4038 InstructionList.push_back(I);
4040 cast<GetElementPtrInst>(I)->setIsInBounds(true);
4044 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
4045 // EXTRACTVAL: [opty, opval, n x indices]
4048 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
4049 return error("Invalid record");
4051 unsigned RecSize = Record.size();
4052 if (OpNum == RecSize)
4053 return error("EXTRACTVAL: Invalid instruction with 0 indices");
4055 SmallVector<unsigned, 4> EXTRACTVALIdx;
4056 Type *CurTy = Agg->getType();
4057 for (; OpNum != RecSize; ++OpNum) {
4058 bool IsArray = CurTy->isArrayTy();
4059 bool IsStruct = CurTy->isStructTy();
4060 uint64_t Index = Record[OpNum];
4062 if (!IsStruct && !IsArray)
4063 return error("EXTRACTVAL: Invalid type");
4064 if ((unsigned)Index != Index)
4065 return error("Invalid value");
4066 if (IsStruct && Index >= CurTy->subtypes().size())
4067 return error("EXTRACTVAL: Invalid struct index");
4068 if (IsArray && Index >= CurTy->getArrayNumElements())
4069 return error("EXTRACTVAL: Invalid array index");
4070 EXTRACTVALIdx.push_back((unsigned)Index);
4073 CurTy = CurTy->subtypes()[Index];
4075 CurTy = CurTy->subtypes()[0];
4078 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
4079 InstructionList.push_back(I);
4083 case bitc::FUNC_CODE_INST_INSERTVAL: {
4084 // INSERTVAL: [opty, opval, opty, opval, n x indices]
4087 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
4088 return error("Invalid record");
4090 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
4091 return error("Invalid record");
4093 unsigned RecSize = Record.size();
4094 if (OpNum == RecSize)
4095 return error("INSERTVAL: Invalid instruction with 0 indices");
4097 SmallVector<unsigned, 4> INSERTVALIdx;
4098 Type *CurTy = Agg->getType();
4099 for (; OpNum != RecSize; ++OpNum) {
4100 bool IsArray = CurTy->isArrayTy();
4101 bool IsStruct = CurTy->isStructTy();
4102 uint64_t Index = Record[OpNum];
4104 if (!IsStruct && !IsArray)
4105 return error("INSERTVAL: Invalid type");
4106 if ((unsigned)Index != Index)
4107 return error("Invalid value");
4108 if (IsStruct && Index >= CurTy->subtypes().size())
4109 return error("INSERTVAL: Invalid struct index");
4110 if (IsArray && Index >= CurTy->getArrayNumElements())
4111 return error("INSERTVAL: Invalid array index");
4113 INSERTVALIdx.push_back((unsigned)Index);
4115 CurTy = CurTy->subtypes()[Index];
4117 CurTy = CurTy->subtypes()[0];
4120 if (CurTy != Val->getType())
4121 return error("Inserted value type doesn't match aggregate type");
4123 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
4124 InstructionList.push_back(I);
4128 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
4129 // obsolete form of select
4130 // handles select i1 ... in old bitcode
4132 Value *TrueVal, *FalseVal, *Cond;
4133 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
4134 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
4135 popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
4136 return error("Invalid record");
4138 I = SelectInst::Create(Cond, TrueVal, FalseVal);
4139 InstructionList.push_back(I);
4143 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
4144 // new form of select
4145 // handles select i1 or select [N x i1]
4147 Value *TrueVal, *FalseVal, *Cond;
4148 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
4149 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
4150 getValueTypePair(Record, OpNum, NextValueNo, Cond))
4151 return error("Invalid record");
4153 // select condition can be either i1 or [N x i1]
4154 if (VectorType* vector_type =
4155 dyn_cast<VectorType>(Cond->getType())) {
4157 if (vector_type->getElementType() != Type::getInt1Ty(Context))
4158 return error("Invalid type for value");
4161 if (Cond->getType() != Type::getInt1Ty(Context))
4162 return error("Invalid type for value");
4165 I = SelectInst::Create(Cond, TrueVal, FalseVal);
4166 InstructionList.push_back(I);
4170 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
4173 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
4174 getValueTypePair(Record, OpNum, NextValueNo, Idx))
4175 return error("Invalid record");
4176 if (!Vec->getType()->isVectorTy())
4177 return error("Invalid type for value");
4178 I = ExtractElementInst::Create(Vec, Idx);
4179 InstructionList.push_back(I);
4183 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
4185 Value *Vec, *Elt, *Idx;
4186 if (getValueTypePair(Record, OpNum, NextValueNo, Vec))
4187 return error("Invalid record");
4188 if (!Vec->getType()->isVectorTy())
4189 return error("Invalid type for value");
4190 if (popValue(Record, OpNum, NextValueNo,
4191 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
4192 getValueTypePair(Record, OpNum, NextValueNo, Idx))
4193 return error("Invalid record");
4194 I = InsertElementInst::Create(Vec, Elt, Idx);
4195 InstructionList.push_back(I);
4199 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
4201 Value *Vec1, *Vec2, *Mask;
4202 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
4203 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
4204 return error("Invalid record");
4206 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
4207 return error("Invalid record");
4208 if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())
4209 return error("Invalid type for value");
4210 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
4211 InstructionList.push_back(I);
4215 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
4216 // Old form of ICmp/FCmp returning bool
4217 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
4218 // both legal on vectors but had different behaviour.
4219 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
4220 // FCmp/ICmp returning bool or vector of bool
4224 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
4225 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS))
4226 return error("Invalid record");
4228 unsigned PredVal = Record[OpNum];
4229 bool IsFP = LHS->getType()->isFPOrFPVectorTy();
4231 if (IsFP && Record.size() > OpNum+1)
4232 FMF = getDecodedFastMathFlags(Record[++OpNum]);
4234 if (OpNum+1 != Record.size())
4235 return error("Invalid record");
4237 if (LHS->getType()->isFPOrFPVectorTy())
4238 I = new FCmpInst((FCmpInst::Predicate)PredVal, LHS, RHS);
4240 I = new ICmpInst((ICmpInst::Predicate)PredVal, LHS, RHS);
4243 I->setFastMathFlags(FMF);
4244 InstructionList.push_back(I);
4248 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
4250 unsigned Size = Record.size();
4252 I = ReturnInst::Create(Context);
4253 InstructionList.push_back(I);
4258 Value *Op = nullptr;
4259 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4260 return error("Invalid record");
4261 if (OpNum != Record.size())
4262 return error("Invalid record");
4264 I = ReturnInst::Create(Context, Op);
4265 InstructionList.push_back(I);
4268 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
4269 if (Record.size() != 1 && Record.size() != 3)
4270 return error("Invalid record");
4271 BasicBlock *TrueDest = getBasicBlock(Record[0]);
4273 return error("Invalid record");
4275 if (Record.size() == 1) {
4276 I = BranchInst::Create(TrueDest);
4277 InstructionList.push_back(I);
4280 BasicBlock *FalseDest = getBasicBlock(Record[1]);
4281 Value *Cond = getValue(Record, 2, NextValueNo,
4282 Type::getInt1Ty(Context));
4283 if (!FalseDest || !Cond)
4284 return error("Invalid record");
4285 I = BranchInst::Create(TrueDest, FalseDest, Cond);
4286 InstructionList.push_back(I);
4290 case bitc::FUNC_CODE_INST_CLEANUPRET: { // CLEANUPRET: [val] or [val,bb#]
4291 if (Record.size() != 1 && Record.size() != 2)
4292 return error("Invalid record");
4294 Value *CleanupPad = getValue(Record, Idx++, NextValueNo,
4295 Type::getTokenTy(Context), OC_CleanupPad);
4297 return error("Invalid record");
4298 BasicBlock *UnwindDest = nullptr;
4299 if (Record.size() == 2) {
4300 UnwindDest = getBasicBlock(Record[Idx++]);
4302 return error("Invalid record");
4305 I = CleanupReturnInst::Create(cast<CleanupPadInst>(CleanupPad),
4307 InstructionList.push_back(I);
4310 case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [val,bb#]
4311 if (Record.size() != 2)
4312 return error("Invalid record");
4314 Value *CatchPad = getValue(Record, Idx++, NextValueNo,
4315 Type::getTokenTy(Context), OC_CatchPad);
4317 return error("Invalid record");
4318 BasicBlock *BB = getBasicBlock(Record[Idx++]);
4320 return error("Invalid record");
4322 I = CatchReturnInst::Create(cast<CatchPadInst>(CatchPad), BB);
4323 InstructionList.push_back(I);
4326 case bitc::FUNC_CODE_INST_CATCHPAD: { // CATCHPAD: [bb#,bb#,num,(ty,val)*]
4327 if (Record.size() < 3)
4328 return error("Invalid record");
4330 BasicBlock *NormalBB = getBasicBlock(Record[Idx++]);
4332 return error("Invalid record");
4333 BasicBlock *UnwindBB = getBasicBlock(Record[Idx++]);
4335 return error("Invalid record");
4336 unsigned NumArgOperands = Record[Idx++];
4337 SmallVector<Value *, 2> Args;
4338 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
4340 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4341 return error("Invalid record");
4342 Args.push_back(Val);
4344 if (Record.size() != Idx)
4345 return error("Invalid record");
4347 I = CatchPadInst::Create(NormalBB, UnwindBB, Args);
4348 InstructionList.push_back(I);
4351 case bitc::FUNC_CODE_INST_TERMINATEPAD: { // TERMINATEPAD: [bb#,num,(ty,val)*]
4352 if (Record.size() < 1)
4353 return error("Invalid record");
4355 bool HasUnwindDest = !!Record[Idx++];
4356 BasicBlock *UnwindDest = nullptr;
4357 if (HasUnwindDest) {
4358 if (Idx == Record.size())
4359 return error("Invalid record");
4360 UnwindDest = getBasicBlock(Record[Idx++]);
4362 return error("Invalid record");
4364 unsigned NumArgOperands = Record[Idx++];
4365 SmallVector<Value *, 2> Args;
4366 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
4368 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4369 return error("Invalid record");
4370 Args.push_back(Val);
4372 if (Record.size() != Idx)
4373 return error("Invalid record");
4375 I = TerminatePadInst::Create(Context, UnwindDest, Args);
4376 InstructionList.push_back(I);
4379 case bitc::FUNC_CODE_INST_CLEANUPPAD: { // CLEANUPPAD: [num,(ty,val)*]
4380 if (Record.size() < 1)
4381 return error("Invalid record");
4383 unsigned NumArgOperands = Record[Idx++];
4384 SmallVector<Value *, 2> Args;
4385 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
4387 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4388 return error("Invalid record");
4389 Args.push_back(Val);
4391 if (Record.size() != Idx)
4392 return error("Invalid record");
4394 I = CleanupPadInst::Create(Context, Args);
4395 InstructionList.push_back(I);
4398 case bitc::FUNC_CODE_INST_CATCHENDPAD: { // CATCHENDPADINST: [bb#] or []
4399 if (Record.size() > 1)
4400 return error("Invalid record");
4401 BasicBlock *BB = nullptr;
4402 if (Record.size() == 1) {
4403 BB = getBasicBlock(Record[0]);
4405 return error("Invalid record");
4407 I = CatchEndPadInst::Create(Context, BB);
4408 InstructionList.push_back(I);
4411 case bitc::FUNC_CODE_INST_CLEANUPENDPAD: { // CLEANUPENDPADINST: [val] or [val,bb#]
4412 if (Record.size() != 1 && Record.size() != 2)
4413 return error("Invalid record");
4415 Value *CleanupPad = getValue(Record, Idx++, NextValueNo,
4416 Type::getTokenTy(Context), OC_CleanupPad);
4418 return error("Invalid record");
4420 BasicBlock *BB = nullptr;
4421 if (Record.size() == 2) {
4422 BB = getBasicBlock(Record[Idx++]);
4424 return error("Invalid record");
4426 I = CleanupEndPadInst::Create(cast<CleanupPadInst>(CleanupPad), BB);
4427 InstructionList.push_back(I);
4430 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
4432 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
4433 // "New" SwitchInst format with case ranges. The changes to write this
4434 // format were reverted but we still recognize bitcode that uses it.
4435 // Hopefully someday we will have support for case ranges and can use
4436 // this format again.
4438 Type *OpTy = getTypeByID(Record[1]);
4439 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
4441 Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
4442 BasicBlock *Default = getBasicBlock(Record[3]);
4443 if (!OpTy || !Cond || !Default)
4444 return error("Invalid record");
4446 unsigned NumCases = Record[4];
4448 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4449 InstructionList.push_back(SI);
4451 unsigned CurIdx = 5;
4452 for (unsigned i = 0; i != NumCases; ++i) {
4453 SmallVector<ConstantInt*, 1> CaseVals;
4454 unsigned NumItems = Record[CurIdx++];
4455 for (unsigned ci = 0; ci != NumItems; ++ci) {
4456 bool isSingleNumber = Record[CurIdx++];
4459 unsigned ActiveWords = 1;
4460 if (ValueBitWidth > 64)
4461 ActiveWords = Record[CurIdx++];
4462 Low = readWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
4464 CurIdx += ActiveWords;
4466 if (!isSingleNumber) {
4468 if (ValueBitWidth > 64)
4469 ActiveWords = Record[CurIdx++];
4470 APInt High = readWideAPInt(
4471 makeArrayRef(&Record[CurIdx], ActiveWords), ValueBitWidth);
4472 CurIdx += ActiveWords;
4474 // FIXME: It is not clear whether values in the range should be
4475 // compared as signed or unsigned values. The partially
4476 // implemented changes that used this format in the past used
4477 // unsigned comparisons.
4478 for ( ; Low.ule(High); ++Low)
4479 CaseVals.push_back(ConstantInt::get(Context, Low));
4481 CaseVals.push_back(ConstantInt::get(Context, Low));
4483 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
4484 for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
4485 cve = CaseVals.end(); cvi != cve; ++cvi)
4486 SI->addCase(*cvi, DestBB);
4492 // Old SwitchInst format without case ranges.
4494 if (Record.size() < 3 || (Record.size() & 1) == 0)
4495 return error("Invalid record");
4496 Type *OpTy = getTypeByID(Record[0]);
4497 Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
4498 BasicBlock *Default = getBasicBlock(Record[2]);
4499 if (!OpTy || !Cond || !Default)
4500 return error("Invalid record");
4501 unsigned NumCases = (Record.size()-3)/2;
4502 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4503 InstructionList.push_back(SI);
4504 for (unsigned i = 0, e = NumCases; i != e; ++i) {
4505 ConstantInt *CaseVal =
4506 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
4507 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
4508 if (!CaseVal || !DestBB) {
4510 return error("Invalid record");
4512 SI->addCase(CaseVal, DestBB);
4517 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
4518 if (Record.size() < 2)
4519 return error("Invalid record");
4520 Type *OpTy = getTypeByID(Record[0]);
4521 Value *Address = getValue(Record, 1, NextValueNo, OpTy);
4522 if (!OpTy || !Address)
4523 return error("Invalid record");
4524 unsigned NumDests = Record.size()-2;
4525 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
4526 InstructionList.push_back(IBI);
4527 for (unsigned i = 0, e = NumDests; i != e; ++i) {
4528 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
4529 IBI->addDestination(DestBB);
4532 return error("Invalid record");
4539 case bitc::FUNC_CODE_INST_INVOKE: {
4540 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
4541 if (Record.size() < 4)
4542 return error("Invalid record");
4544 AttributeSet PAL = getAttributes(Record[OpNum++]);
4545 unsigned CCInfo = Record[OpNum++];
4546 BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);
4547 BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);
4549 FunctionType *FTy = nullptr;
4550 if (CCInfo >> 13 & 1 &&
4551 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
4552 return error("Explicit invoke type is not a function type");
4555 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
4556 return error("Invalid record");
4558 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
4560 return error("Callee is not a pointer");
4562 FTy = dyn_cast<FunctionType>(CalleeTy->getElementType());
4564 return error("Callee is not of pointer to function type");
4565 } else if (CalleeTy->getElementType() != FTy)
4566 return error("Explicit invoke type does not match pointee type of "
4568 if (Record.size() < FTy->getNumParams() + OpNum)
4569 return error("Insufficient operands to call");
4571 SmallVector<Value*, 16> Ops;
4572 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4573 Ops.push_back(getValue(Record, OpNum, NextValueNo,
4574 FTy->getParamType(i)));
4576 return error("Invalid record");
4579 if (!FTy->isVarArg()) {
4580 if (Record.size() != OpNum)
4581 return error("Invalid record");
4583 // Read type/value pairs for varargs params.
4584 while (OpNum != Record.size()) {
4586 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4587 return error("Invalid record");
4592 I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops, OperandBundles);
4593 OperandBundles.clear();
4594 InstructionList.push_back(I);
4595 cast<InvokeInst>(I)->setCallingConv(
4596 static_cast<CallingConv::ID>(CallingConv::MaxID & CCInfo));
4597 cast<InvokeInst>(I)->setAttributes(PAL);
4600 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
4602 Value *Val = nullptr;
4603 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4604 return error("Invalid record");
4605 I = ResumeInst::Create(Val);
4606 InstructionList.push_back(I);
4609 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
4610 I = new UnreachableInst(Context);
4611 InstructionList.push_back(I);
4613 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
4614 if (Record.size() < 1 || ((Record.size()-1)&1))
4615 return error("Invalid record");
4616 Type *Ty = getTypeByID(Record[0]);
4618 return error("Invalid record");
4620 PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
4621 InstructionList.push_back(PN);
4623 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
4625 // With the new function encoding, it is possible that operands have
4626 // negative IDs (for forward references). Use a signed VBR
4627 // representation to keep the encoding small.
4629 V = getValueSigned(Record, 1+i, NextValueNo, Ty);
4631 V = getValue(Record, 1+i, NextValueNo, Ty);
4632 BasicBlock *BB = getBasicBlock(Record[2+i]);
4634 return error("Invalid record");
4635 PN->addIncoming(V, BB);
4641 case bitc::FUNC_CODE_INST_LANDINGPAD:
4642 case bitc::FUNC_CODE_INST_LANDINGPAD_OLD: {
4643 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
4645 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {
4646 if (Record.size() < 3)
4647 return error("Invalid record");
4649 assert(BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD);
4650 if (Record.size() < 4)
4651 return error("Invalid record");
4653 Type *Ty = getTypeByID(Record[Idx++]);
4655 return error("Invalid record");
4656 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {
4657 Value *PersFn = nullptr;
4658 if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
4659 return error("Invalid record");
4661 if (!F->hasPersonalityFn())
4662 F->setPersonalityFn(cast<Constant>(PersFn));
4663 else if (F->getPersonalityFn() != cast<Constant>(PersFn))
4664 return error("Personality function mismatch");
4667 bool IsCleanup = !!Record[Idx++];
4668 unsigned NumClauses = Record[Idx++];
4669 LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);
4670 LP->setCleanup(IsCleanup);
4671 for (unsigned J = 0; J != NumClauses; ++J) {
4672 LandingPadInst::ClauseType CT =
4673 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
4676 if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
4678 return error("Invalid record");
4681 assert((CT != LandingPadInst::Catch ||
4682 !isa<ArrayType>(Val->getType())) &&
4683 "Catch clause has a invalid type!");
4684 assert((CT != LandingPadInst::Filter ||
4685 isa<ArrayType>(Val->getType())) &&
4686 "Filter clause has invalid type!");
4687 LP->addClause(cast<Constant>(Val));
4691 InstructionList.push_back(I);
4695 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
4696 if (Record.size() != 4)
4697 return error("Invalid record");
4698 uint64_t AlignRecord = Record[3];
4699 const uint64_t InAllocaMask = uint64_t(1) << 5;
4700 const uint64_t ExplicitTypeMask = uint64_t(1) << 6;
4701 // Reserve bit 7 for SwiftError flag.
4702 // const uint64_t SwiftErrorMask = uint64_t(1) << 7;
4703 const uint64_t FlagMask = InAllocaMask | ExplicitTypeMask;
4704 bool InAlloca = AlignRecord & InAllocaMask;
4705 Type *Ty = getTypeByID(Record[0]);
4706 if ((AlignRecord & ExplicitTypeMask) == 0) {
4707 auto *PTy = dyn_cast_or_null<PointerType>(Ty);
4709 return error("Old-style alloca with a non-pointer type");
4710 Ty = PTy->getElementType();
4712 Type *OpTy = getTypeByID(Record[1]);
4713 Value *Size = getFnValueByID(Record[2], OpTy);
4715 if (std::error_code EC =
4716 parseAlignmentValue(AlignRecord & ~FlagMask, Align)) {
4720 return error("Invalid record");
4721 AllocaInst *AI = new AllocaInst(Ty, Size, Align);
4722 AI->setUsedWithInAlloca(InAlloca);
4724 InstructionList.push_back(I);
4727 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
4730 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4731 (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
4732 return error("Invalid record");
4735 if (OpNum + 3 == Record.size())
4736 Ty = getTypeByID(Record[OpNum++]);
4737 if (std::error_code EC =
4738 typeCheckLoadStoreInst(DiagnosticHandler, Ty, Op->getType()))
4741 Ty = cast<PointerType>(Op->getType())->getElementType();
4744 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4746 I = new LoadInst(Ty, Op, "", Record[OpNum + 1], Align);
4748 InstructionList.push_back(I);
4751 case bitc::FUNC_CODE_INST_LOADATOMIC: {
4752 // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
4755 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4756 (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
4757 return error("Invalid record");
4760 if (OpNum + 5 == Record.size())
4761 Ty = getTypeByID(Record[OpNum++]);
4762 if (std::error_code EC =
4763 typeCheckLoadStoreInst(DiagnosticHandler, Ty, Op->getType()))
4766 Ty = cast<PointerType>(Op->getType())->getElementType();
4768 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4769 if (Ordering == NotAtomic || Ordering == Release ||
4770 Ordering == AcquireRelease)
4771 return error("Invalid record");
4772 if (Ordering != NotAtomic && Record[OpNum] == 0)
4773 return error("Invalid record");
4774 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4777 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4779 I = new LoadInst(Op, "", Record[OpNum+1], Align, Ordering, SynchScope);
4781 InstructionList.push_back(I);
4784 case bitc::FUNC_CODE_INST_STORE:
4785 case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]
4788 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4789 (BitCode == bitc::FUNC_CODE_INST_STORE
4790 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4791 : popValue(Record, OpNum, NextValueNo,
4792 cast<PointerType>(Ptr->getType())->getElementType(),
4794 OpNum + 2 != Record.size())
4795 return error("Invalid record");
4797 if (std::error_code EC = typeCheckLoadStoreInst(
4798 DiagnosticHandler, Val->getType(), Ptr->getType()))
4801 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4803 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align);
4804 InstructionList.push_back(I);
4807 case bitc::FUNC_CODE_INST_STOREATOMIC:
4808 case bitc::FUNC_CODE_INST_STOREATOMIC_OLD: {
4809 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
4812 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4813 (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC
4814 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4815 : popValue(Record, OpNum, NextValueNo,
4816 cast<PointerType>(Ptr->getType())->getElementType(),
4818 OpNum + 4 != Record.size())
4819 return error("Invalid record");
4821 if (std::error_code EC = typeCheckLoadStoreInst(
4822 DiagnosticHandler, Val->getType(), Ptr->getType()))
4824 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4825 if (Ordering == NotAtomic || Ordering == Acquire ||
4826 Ordering == AcquireRelease)
4827 return error("Invalid record");
4828 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4829 if (Ordering != NotAtomic && Record[OpNum] == 0)
4830 return error("Invalid record");
4833 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4835 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align, Ordering, SynchScope);
4836 InstructionList.push_back(I);
4839 case bitc::FUNC_CODE_INST_CMPXCHG_OLD:
4840 case bitc::FUNC_CODE_INST_CMPXCHG: {
4841 // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
4842 // failureordering?, isweak?]
4844 Value *Ptr, *Cmp, *New;
4845 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4846 (BitCode == bitc::FUNC_CODE_INST_CMPXCHG
4847 ? getValueTypePair(Record, OpNum, NextValueNo, Cmp)
4848 : popValue(Record, OpNum, NextValueNo,
4849 cast<PointerType>(Ptr->getType())->getElementType(),
4851 popValue(Record, OpNum, NextValueNo, Cmp->getType(), New) ||
4852 Record.size() < OpNum + 3 || Record.size() > OpNum + 5)
4853 return error("Invalid record");
4854 AtomicOrdering SuccessOrdering = getDecodedOrdering(Record[OpNum + 1]);
4855 if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
4856 return error("Invalid record");
4857 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 2]);
4859 if (std::error_code EC = typeCheckLoadStoreInst(
4860 DiagnosticHandler, Cmp->getType(), Ptr->getType()))
4862 AtomicOrdering FailureOrdering;
4863 if (Record.size() < 7)
4865 AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
4867 FailureOrdering = getDecodedOrdering(Record[OpNum + 3]);
4869 I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
4871 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
4873 if (Record.size() < 8) {
4874 // Before weak cmpxchgs existed, the instruction simply returned the
4875 // value loaded from memory, so bitcode files from that era will be
4876 // expecting the first component of a modern cmpxchg.
4877 CurBB->getInstList().push_back(I);
4878 I = ExtractValueInst::Create(I, 0);
4880 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
4883 InstructionList.push_back(I);
4886 case bitc::FUNC_CODE_INST_ATOMICRMW: {
4887 // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
4890 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4891 popValue(Record, OpNum, NextValueNo,
4892 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
4893 OpNum+4 != Record.size())
4894 return error("Invalid record");
4895 AtomicRMWInst::BinOp Operation = getDecodedRMWOperation(Record[OpNum]);
4896 if (Operation < AtomicRMWInst::FIRST_BINOP ||
4897 Operation > AtomicRMWInst::LAST_BINOP)
4898 return error("Invalid record");
4899 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4900 if (Ordering == NotAtomic || Ordering == Unordered)
4901 return error("Invalid record");
4902 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4903 I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
4904 cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
4905 InstructionList.push_back(I);
4908 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
4909 if (2 != Record.size())
4910 return error("Invalid record");
4911 AtomicOrdering Ordering = getDecodedOrdering(Record[0]);
4912 if (Ordering == NotAtomic || Ordering == Unordered ||
4913 Ordering == Monotonic)
4914 return error("Invalid record");
4915 SynchronizationScope SynchScope = getDecodedSynchScope(Record[1]);
4916 I = new FenceInst(Context, Ordering, SynchScope);
4917 InstructionList.push_back(I);
4920 case bitc::FUNC_CODE_INST_CALL: {
4921 // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
4922 if (Record.size() < 3)
4923 return error("Invalid record");
4926 AttributeSet PAL = getAttributes(Record[OpNum++]);
4927 unsigned CCInfo = Record[OpNum++];
4929 FunctionType *FTy = nullptr;
4930 if (CCInfo >> 15 & 1 &&
4931 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
4932 return error("Explicit call type is not a function type");
4935 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
4936 return error("Invalid record");
4938 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
4940 return error("Callee is not a pointer type");
4942 FTy = dyn_cast<FunctionType>(OpTy->getElementType());
4944 return error("Callee is not of pointer to function type");
4945 } else if (OpTy->getElementType() != FTy)
4946 return error("Explicit call type does not match pointee type of "
4948 if (Record.size() < FTy->getNumParams() + OpNum)
4949 return error("Insufficient operands to call");
4951 SmallVector<Value*, 16> Args;
4952 // Read the fixed params.
4953 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4954 if (FTy->getParamType(i)->isLabelTy())
4955 Args.push_back(getBasicBlock(Record[OpNum]));
4957 Args.push_back(getValue(Record, OpNum, NextValueNo,
4958 FTy->getParamType(i)));
4960 return error("Invalid record");
4963 // Read type/value pairs for varargs params.
4964 if (!FTy->isVarArg()) {
4965 if (OpNum != Record.size())
4966 return error("Invalid record");
4968 while (OpNum != Record.size()) {
4970 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4971 return error("Invalid record");
4976 I = CallInst::Create(FTy, Callee, Args, OperandBundles);
4977 OperandBundles.clear();
4978 InstructionList.push_back(I);
4979 cast<CallInst>(I)->setCallingConv(
4980 static_cast<CallingConv::ID>((0x7ff & CCInfo) >> 1));
4981 CallInst::TailCallKind TCK = CallInst::TCK_None;
4983 TCK = CallInst::TCK_Tail;
4984 if (CCInfo & (1 << 14))
4985 TCK = CallInst::TCK_MustTail;
4986 cast<CallInst>(I)->setTailCallKind(TCK);
4987 cast<CallInst>(I)->setAttributes(PAL);
4990 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
4991 if (Record.size() < 3)
4992 return error("Invalid record");
4993 Type *OpTy = getTypeByID(Record[0]);
4994 Value *Op = getValue(Record, 1, NextValueNo, OpTy);
4995 Type *ResTy = getTypeByID(Record[2]);
4996 if (!OpTy || !Op || !ResTy)
4997 return error("Invalid record");
4998 I = new VAArgInst(Op, ResTy);
4999 InstructionList.push_back(I);
5003 case bitc::FUNC_CODE_OPERAND_BUNDLE: {
5004 // A call or an invoke can be optionally prefixed with some variable
5005 // number of operand bundle blocks. These blocks are read into
5006 // OperandBundles and consumed at the next call or invoke instruction.
5008 if (Record.size() < 1 || Record[0] >= BundleTags.size())
5009 return error("Invalid record");
5011 OperandBundles.emplace_back();
5012 OperandBundles.back().Tag = BundleTags[Record[0]];
5014 std::vector<Value *> &Inputs = OperandBundles.back().Inputs;
5017 while (OpNum != Record.size()) {
5019 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
5020 return error("Invalid record");
5021 Inputs.push_back(Op);
5028 // Add instruction to end of current BB. If there is no current BB, reject
5032 return error("Invalid instruction with no BB");
5034 if (!OperandBundles.empty()) {
5036 return error("Operand bundles found with no consumer");
5038 CurBB->getInstList().push_back(I);
5040 // If this was a terminator instruction, move to the next block.
5041 if (isa<TerminatorInst>(I)) {
5043 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
5046 // Non-void values get registered in the value table for future use.
5047 if (I && !I->getType()->isVoidTy())
5048 if (ValueList.assignValue(I, NextValueNo++))
5049 return error("Invalid forward reference");
5054 if (!OperandBundles.empty())
5055 return error("Operand bundles found with no consumer");
5057 // Check the function list for unresolved values.
5058 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
5059 if (!A->getParent()) {
5060 // We found at least one unresolved value. Nuke them all to avoid leaks.
5061 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
5062 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
5063 A->replaceAllUsesWith(UndefValue::get(A->getType()));
5067 return error("Never resolved value found in function");
5071 // FIXME: Check for unresolved forward-declared metadata references
5072 // and clean up leaks.
5074 // Trim the value list down to the size it was before we parsed this function.
5075 ValueList.shrinkTo(ModuleValueListSize);
5076 MDValueList.shrinkTo(ModuleMDValueListSize);
5077 std::vector<BasicBlock*>().swap(FunctionBBs);
5078 return std::error_code();
5081 /// Find the function body in the bitcode stream
5082 std::error_code BitcodeReader::findFunctionInStream(
5084 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
5085 while (DeferredFunctionInfoIterator->second == 0) {
5086 // This is the fallback handling for the old format bitcode that
5087 // didn't contain the function index in the VST, or when we have
5088 // an anonymous function which would not have a VST entry.
5089 // Assert that we have one of those two cases.
5090 assert(VSTOffset == 0 || !F->hasName());
5091 // Parse the next body in the stream and set its position in the
5092 // DeferredFunctionInfo map.
5093 if (std::error_code EC = rememberAndSkipFunctionBodies())
5096 return std::error_code();
5099 //===----------------------------------------------------------------------===//
5100 // GVMaterializer implementation
5101 //===----------------------------------------------------------------------===//
5103 void BitcodeReader::releaseBuffer() { Buffer.release(); }
5105 std::error_code BitcodeReader::materialize(GlobalValue *GV) {
5106 if (std::error_code EC = materializeMetadata())
5109 Function *F = dyn_cast<Function>(GV);
5110 // If it's not a function or is already material, ignore the request.
5111 if (!F || !F->isMaterializable())
5112 return std::error_code();
5114 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
5115 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
5116 // If its position is recorded as 0, its body is somewhere in the stream
5117 // but we haven't seen it yet.
5118 if (DFII->second == 0)
5119 if (std::error_code EC = findFunctionInStream(F, DFII))
5122 // Move the bit stream to the saved position of the deferred function body.
5123 Stream.JumpToBit(DFII->second);
5125 if (std::error_code EC = parseFunctionBody(F))
5127 F->setIsMaterializable(false);
5132 // Upgrade any old intrinsic calls in the function.
5133 for (auto &I : UpgradedIntrinsics) {
5134 for (auto UI = I.first->user_begin(), UE = I.first->user_end(); UI != UE;) {
5137 if (CallInst *CI = dyn_cast<CallInst>(U))
5138 UpgradeIntrinsicCall(CI, I.second);
5142 // Bring in any functions that this function forward-referenced via
5144 return materializeForwardReferencedFunctions();
5147 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
5148 const Function *F = dyn_cast<Function>(GV);
5149 if (!F || F->isDeclaration())
5152 // Dematerializing F would leave dangling references that wouldn't be
5153 // reconnected on re-materialization.
5154 if (BlockAddressesTaken.count(F))
5157 return DeferredFunctionInfo.count(const_cast<Function*>(F));
5160 void BitcodeReader::dematerialize(GlobalValue *GV) {
5161 Function *F = dyn_cast<Function>(GV);
5162 // If this function isn't dematerializable, this is a noop.
5163 if (!F || !isDematerializable(F))
5166 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
5168 // Just forget the function body, we can remat it later.
5169 F->dropAllReferences();
5170 F->setIsMaterializable(true);
5173 std::error_code BitcodeReader::materializeModule(Module *M) {
5174 assert(M == TheModule &&
5175 "Can only Materialize the Module this BitcodeReader is attached to.");
5177 if (std::error_code EC = materializeMetadata())
5180 // Promise to materialize all forward references.
5181 WillMaterializeAllForwardRefs = true;
5183 // Iterate over the module, deserializing any functions that are still on
5185 for (Function &F : *TheModule) {
5186 if (std::error_code EC = materialize(&F))
5189 // At this point, if there are any function bodies, parse the rest of
5190 // the bits in the module past the last function block we have recorded
5191 // through either lazy scanning or the VST.
5192 if (LastFunctionBlockBit || NextUnreadBit)
5193 parseModule(LastFunctionBlockBit > NextUnreadBit ? LastFunctionBlockBit
5196 // Check that all block address forward references got resolved (as we
5198 if (!BasicBlockFwdRefs.empty())
5199 return error("Never resolved function from blockaddress");
5201 // Upgrade any intrinsic calls that slipped through (should not happen!) and
5202 // delete the old functions to clean up. We can't do this unless the entire
5203 // module is materialized because there could always be another function body
5204 // with calls to the old function.
5205 for (auto &I : UpgradedIntrinsics) {
5206 for (auto *U : I.first->users()) {
5207 if (CallInst *CI = dyn_cast<CallInst>(U))
5208 UpgradeIntrinsicCall(CI, I.second);
5210 if (!I.first->use_empty())
5211 I.first->replaceAllUsesWith(I.second);
5212 I.first->eraseFromParent();
5214 UpgradedIntrinsics.clear();
5216 for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
5217 UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
5219 UpgradeDebugInfo(*M);
5220 return std::error_code();
5223 std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
5224 return IdentifiedStructTypes;
5228 BitcodeReader::initStream(std::unique_ptr<DataStreamer> Streamer) {
5230 return initLazyStream(std::move(Streamer));
5231 return initStreamFromBuffer();
5234 std::error_code BitcodeReader::initStreamFromBuffer() {
5235 const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
5236 const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
5238 if (Buffer->getBufferSize() & 3)
5239 return error("Invalid bitcode signature");
5241 // If we have a wrapper header, parse it and ignore the non-bc file contents.
5242 // The magic number is 0x0B17C0DE stored in little endian.
5243 if (isBitcodeWrapper(BufPtr, BufEnd))
5244 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
5245 return error("Invalid bitcode wrapper header");
5247 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
5248 Stream.init(&*StreamFile);
5250 return std::error_code();
5254 BitcodeReader::initLazyStream(std::unique_ptr<DataStreamer> Streamer) {
5255 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
5258 llvm::make_unique<StreamingMemoryObject>(std::move(Streamer));
5259 StreamingMemoryObject &Bytes = *OwnedBytes;
5260 StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
5261 Stream.init(&*StreamFile);
5263 unsigned char buf[16];
5264 if (Bytes.readBytes(buf, 16, 0) != 16)
5265 return error("Invalid bitcode signature");
5267 if (!isBitcode(buf, buf + 16))
5268 return error("Invalid bitcode signature");
5270 if (isBitcodeWrapper(buf, buf + 4)) {
5271 const unsigned char *bitcodeStart = buf;
5272 const unsigned char *bitcodeEnd = buf + 16;
5273 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
5274 Bytes.dropLeadingBytes(bitcodeStart - buf);
5275 Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
5277 return std::error_code();
5280 std::error_code FunctionIndexBitcodeReader::error(BitcodeError E,
5281 const Twine &Message) {
5282 return ::error(DiagnosticHandler, make_error_code(E), Message);
5285 std::error_code FunctionIndexBitcodeReader::error(const Twine &Message) {
5286 return ::error(DiagnosticHandler,
5287 make_error_code(BitcodeError::CorruptedBitcode), Message);
5290 std::error_code FunctionIndexBitcodeReader::error(BitcodeError E) {
5291 return ::error(DiagnosticHandler, make_error_code(E));
5294 FunctionIndexBitcodeReader::FunctionIndexBitcodeReader(
5295 MemoryBuffer *Buffer, LLVMContext &Context,
5296 DiagnosticHandlerFunction DiagnosticHandler, bool IsLazy,
5297 bool CheckFuncSummaryPresenceOnly)
5298 : DiagnosticHandler(getDiagHandler(DiagnosticHandler, Context)),
5299 Buffer(Buffer), IsLazy(IsLazy),
5300 CheckFuncSummaryPresenceOnly(CheckFuncSummaryPresenceOnly) {}
5302 FunctionIndexBitcodeReader::FunctionIndexBitcodeReader(
5303 LLVMContext &Context, DiagnosticHandlerFunction DiagnosticHandler,
5304 bool IsLazy, bool CheckFuncSummaryPresenceOnly)
5305 : DiagnosticHandler(getDiagHandler(DiagnosticHandler, Context)),
5306 Buffer(nullptr), IsLazy(IsLazy),
5307 CheckFuncSummaryPresenceOnly(CheckFuncSummaryPresenceOnly) {}
5309 void FunctionIndexBitcodeReader::freeState() { Buffer = nullptr; }
5311 void FunctionIndexBitcodeReader::releaseBuffer() { Buffer.release(); }
5313 // Specialized value symbol table parser used when reading function index
5314 // blocks where we don't actually create global values.
5315 // At the end of this routine the function index is populated with a map
5316 // from function name to FunctionInfo. The function info contains
5317 // the function block's bitcode offset as well as the offset into the
5318 // function summary section.
5319 std::error_code FunctionIndexBitcodeReader::parseValueSymbolTable() {
5320 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
5321 return error("Invalid record");
5323 SmallVector<uint64_t, 64> Record;
5325 // Read all the records for this value table.
5326 SmallString<128> ValueName;
5328 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5330 switch (Entry.Kind) {
5331 case BitstreamEntry::SubBlock: // Handled for us already.
5332 case BitstreamEntry::Error:
5333 return error("Malformed block");
5334 case BitstreamEntry::EndBlock:
5335 return std::error_code();
5336 case BitstreamEntry::Record:
5337 // The interesting case.
5343 switch (Stream.readRecord(Entry.ID, Record)) {
5344 default: // Default behavior: ignore (e.g. VST_CODE_BBENTRY records).
5346 case bitc::VST_CODE_FNENTRY: {
5347 // VST_FNENTRY: [valueid, offset, namechar x N]
5348 if (convertToString(Record, 2, ValueName))
5349 return error("Invalid record");
5350 unsigned ValueID = Record[0];
5351 uint64_t FuncOffset = Record[1];
5352 std::unique_ptr<FunctionInfo> FuncInfo =
5353 llvm::make_unique<FunctionInfo>(FuncOffset);
5354 if (foundFuncSummary() && !IsLazy) {
5355 DenseMap<uint64_t, std::unique_ptr<FunctionSummary>>::iterator SMI =
5356 SummaryMap.find(ValueID);
5357 assert(SMI != SummaryMap.end() && "Summary info not found");
5358 FuncInfo->setFunctionSummary(std::move(SMI->second));
5360 TheIndex->addFunctionInfo(ValueName, std::move(FuncInfo));
5365 case bitc::VST_CODE_COMBINED_FNENTRY: {
5366 // VST_FNENTRY: [offset, namechar x N]
5367 if (convertToString(Record, 1, ValueName))
5368 return error("Invalid record");
5369 uint64_t FuncSummaryOffset = Record[0];
5370 std::unique_ptr<FunctionInfo> FuncInfo =
5371 llvm::make_unique<FunctionInfo>(FuncSummaryOffset);
5372 if (foundFuncSummary() && !IsLazy) {
5373 DenseMap<uint64_t, std::unique_ptr<FunctionSummary>>::iterator SMI =
5374 SummaryMap.find(FuncSummaryOffset);
5375 assert(SMI != SummaryMap.end() && "Summary info not found");
5376 FuncInfo->setFunctionSummary(std::move(SMI->second));
5378 TheIndex->addFunctionInfo(ValueName, std::move(FuncInfo));
5387 // Parse just the blocks needed for function index building out of the module.
5388 // At the end of this routine the function Index is populated with a map
5389 // from function name to FunctionInfo. The function info contains
5390 // either the parsed function summary information (when parsing summaries
5391 // eagerly), or just to the function summary record's offset
5392 // if parsing lazily (IsLazy).
5393 std::error_code FunctionIndexBitcodeReader::parseModule() {
5394 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
5395 return error("Invalid record");
5397 // Read the function index for this module.
5399 BitstreamEntry Entry = Stream.advance();
5401 switch (Entry.Kind) {
5402 case BitstreamEntry::Error:
5403 return error("Malformed block");
5404 case BitstreamEntry::EndBlock:
5405 return std::error_code();
5407 case BitstreamEntry::SubBlock:
5408 if (CheckFuncSummaryPresenceOnly) {
5409 if (Entry.ID == bitc::FUNCTION_SUMMARY_BLOCK_ID)
5410 SeenFuncSummary = true;
5411 if (Stream.SkipBlock())
5412 return error("Invalid record");
5413 // No need to parse the rest since we found the summary.
5414 return std::error_code();
5417 default: // Skip unknown content.
5418 if (Stream.SkipBlock())
5419 return error("Invalid record");
5421 case bitc::BLOCKINFO_BLOCK_ID:
5422 // Need to parse these to get abbrev ids (e.g. for VST)
5423 if (Stream.ReadBlockInfoBlock())
5424 return error("Malformed block");
5426 case bitc::VALUE_SYMTAB_BLOCK_ID:
5427 if (std::error_code EC = parseValueSymbolTable())
5430 case bitc::FUNCTION_SUMMARY_BLOCK_ID:
5431 SeenFuncSummary = true;
5433 // Lazy parsing of summary info, skip it.
5434 if (Stream.SkipBlock())
5435 return error("Invalid record");
5436 } else if (std::error_code EC = parseEntireSummary())
5439 case bitc::MODULE_STRTAB_BLOCK_ID:
5440 if (std::error_code EC = parseModuleStringTable())
5446 case BitstreamEntry::Record:
5447 Stream.skipRecord(Entry.ID);
5453 // Eagerly parse the entire function summary block (i.e. for all functions
5454 // in the index). This populates the FunctionSummary objects in
5456 std::error_code FunctionIndexBitcodeReader::parseEntireSummary() {
5457 if (Stream.EnterSubBlock(bitc::FUNCTION_SUMMARY_BLOCK_ID))
5458 return error("Invalid record");
5460 SmallVector<uint64_t, 64> Record;
5463 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5465 switch (Entry.Kind) {
5466 case BitstreamEntry::SubBlock: // Handled for us already.
5467 case BitstreamEntry::Error:
5468 return error("Malformed block");
5469 case BitstreamEntry::EndBlock:
5470 return std::error_code();
5471 case BitstreamEntry::Record:
5472 // The interesting case.
5476 // Read a record. The record format depends on whether this
5477 // is a per-module index or a combined index file. In the per-module
5478 // case the records contain the associated value's ID for correlation
5479 // with VST entries. In the combined index the correlation is done
5480 // via the bitcode offset of the summary records (which were saved
5481 // in the combined index VST entries). The records also contain
5482 // information used for ThinLTO renaming and importing.
5484 uint64_t CurRecordBit = Stream.GetCurrentBitNo();
5485 switch (Stream.readRecord(Entry.ID, Record)) {
5486 default: // Default behavior: ignore.
5488 // FS_PERMODULE_ENTRY: [valueid, islocal, instcount]
5489 case bitc::FS_CODE_PERMODULE_ENTRY: {
5490 unsigned ValueID = Record[0];
5491 bool IsLocal = Record[1];
5492 unsigned InstCount = Record[2];
5493 std::unique_ptr<FunctionSummary> FS =
5494 llvm::make_unique<FunctionSummary>(InstCount);
5495 FS->setLocalFunction(IsLocal);
5496 // The module path string ref set in the summary must be owned by the
5497 // index's module string table. Since we don't have a module path
5498 // string table section in the per-module index, we create a single
5499 // module path string table entry with an empty (0) ID to take
5502 TheIndex->addModulePath(Buffer->getBufferIdentifier(), 0));
5503 SummaryMap[ValueID] = std::move(FS);
5505 // FS_COMBINED_ENTRY: [modid, instcount]
5506 case bitc::FS_CODE_COMBINED_ENTRY: {
5507 uint64_t ModuleId = Record[0];
5508 unsigned InstCount = Record[1];
5509 std::unique_ptr<FunctionSummary> FS =
5510 llvm::make_unique<FunctionSummary>(InstCount);
5511 FS->setModulePath(ModuleIdMap[ModuleId]);
5512 SummaryMap[CurRecordBit] = std::move(FS);
5516 llvm_unreachable("Exit infinite loop");
5519 // Parse the module string table block into the Index.
5520 // This populates the ModulePathStringTable map in the index.
5521 std::error_code FunctionIndexBitcodeReader::parseModuleStringTable() {
5522 if (Stream.EnterSubBlock(bitc::MODULE_STRTAB_BLOCK_ID))
5523 return error("Invalid record");
5525 SmallVector<uint64_t, 64> Record;
5527 SmallString<128> ModulePath;
5529 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5531 switch (Entry.Kind) {
5532 case BitstreamEntry::SubBlock: // Handled for us already.
5533 case BitstreamEntry::Error:
5534 return error("Malformed block");
5535 case BitstreamEntry::EndBlock:
5536 return std::error_code();
5537 case BitstreamEntry::Record:
5538 // The interesting case.
5543 switch (Stream.readRecord(Entry.ID, Record)) {
5544 default: // Default behavior: ignore.
5546 case bitc::MST_CODE_ENTRY: {
5547 // MST_ENTRY: [modid, namechar x N]
5548 if (convertToString(Record, 1, ModulePath))
5549 return error("Invalid record");
5550 uint64_t ModuleId = Record[0];
5551 StringRef ModulePathInMap = TheIndex->addModulePath(ModulePath, ModuleId);
5552 ModuleIdMap[ModuleId] = ModulePathInMap;
5558 llvm_unreachable("Exit infinite loop");
5561 // Parse the function info index from the bitcode streamer into the given index.
5562 std::error_code FunctionIndexBitcodeReader::parseSummaryIndexInto(
5563 std::unique_ptr<DataStreamer> Streamer, FunctionInfoIndex *I) {
5566 if (std::error_code EC = initStream(std::move(Streamer)))
5569 // Sniff for the signature.
5570 if (!hasValidBitcodeHeader(Stream))
5571 return error("Invalid bitcode signature");
5573 // We expect a number of well-defined blocks, though we don't necessarily
5574 // need to understand them all.
5576 if (Stream.AtEndOfStream()) {
5577 // We didn't really read a proper Module block.
5578 return error("Malformed block");
5581 BitstreamEntry Entry =
5582 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
5584 if (Entry.Kind != BitstreamEntry::SubBlock)
5585 return error("Malformed block");
5587 // If we see a MODULE_BLOCK, parse it to find the blocks needed for
5588 // building the function summary index.
5589 if (Entry.ID == bitc::MODULE_BLOCK_ID)
5590 return parseModule();
5592 if (Stream.SkipBlock())
5593 return error("Invalid record");
5597 // Parse the function information at the given offset in the buffer into
5598 // the index. Used to support lazy parsing of function summaries from the
5599 // combined index during importing.
5600 // TODO: This function is not yet complete as it won't have a consumer
5601 // until ThinLTO function importing is added.
5602 std::error_code FunctionIndexBitcodeReader::parseFunctionSummary(
5603 std::unique_ptr<DataStreamer> Streamer, FunctionInfoIndex *I,
5604 size_t FunctionSummaryOffset) {
5607 if (std::error_code EC = initStream(std::move(Streamer)))
5610 // Sniff for the signature.
5611 if (!hasValidBitcodeHeader(Stream))
5612 return error("Invalid bitcode signature");
5614 Stream.JumpToBit(FunctionSummaryOffset);
5616 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5618 switch (Entry.Kind) {
5620 return error("Malformed block");
5621 case BitstreamEntry::Record:
5622 // The expected case.
5626 // TODO: Read a record. This interface will be completed when ThinLTO
5627 // importing is added so that it can be tested.
5628 SmallVector<uint64_t, 64> Record;
5629 switch (Stream.readRecord(Entry.ID, Record)) {
5630 case bitc::FS_CODE_COMBINED_ENTRY:
5632 return error("Invalid record");
5635 return std::error_code();
5639 FunctionIndexBitcodeReader::initStream(std::unique_ptr<DataStreamer> Streamer) {
5641 return initLazyStream(std::move(Streamer));
5642 return initStreamFromBuffer();
5645 std::error_code FunctionIndexBitcodeReader::initStreamFromBuffer() {
5646 const unsigned char *BufPtr = (const unsigned char *)Buffer->getBufferStart();
5647 const unsigned char *BufEnd = BufPtr + Buffer->getBufferSize();
5649 if (Buffer->getBufferSize() & 3)
5650 return error("Invalid bitcode signature");
5652 // If we have a wrapper header, parse it and ignore the non-bc file contents.
5653 // The magic number is 0x0B17C0DE stored in little endian.
5654 if (isBitcodeWrapper(BufPtr, BufEnd))
5655 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
5656 return error("Invalid bitcode wrapper header");
5658 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
5659 Stream.init(&*StreamFile);
5661 return std::error_code();
5664 std::error_code FunctionIndexBitcodeReader::initLazyStream(
5665 std::unique_ptr<DataStreamer> Streamer) {
5666 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
5669 llvm::make_unique<StreamingMemoryObject>(std::move(Streamer));
5670 StreamingMemoryObject &Bytes = *OwnedBytes;
5671 StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
5672 Stream.init(&*StreamFile);
5674 unsigned char buf[16];
5675 if (Bytes.readBytes(buf, 16, 0) != 16)
5676 return error("Invalid bitcode signature");
5678 if (!isBitcode(buf, buf + 16))
5679 return error("Invalid bitcode signature");
5681 if (isBitcodeWrapper(buf, buf + 4)) {
5682 const unsigned char *bitcodeStart = buf;
5683 const unsigned char *bitcodeEnd = buf + 16;
5684 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
5685 Bytes.dropLeadingBytes(bitcodeStart - buf);
5686 Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
5688 return std::error_code();
5692 class BitcodeErrorCategoryType : public std::error_category {
5693 const char *name() const LLVM_NOEXCEPT override {
5694 return "llvm.bitcode";
5696 std::string message(int IE) const override {
5697 BitcodeError E = static_cast<BitcodeError>(IE);
5699 case BitcodeError::InvalidBitcodeSignature:
5700 return "Invalid bitcode signature";
5701 case BitcodeError::CorruptedBitcode:
5702 return "Corrupted bitcode";
5704 llvm_unreachable("Unknown error type!");
5709 static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
5711 const std::error_category &llvm::BitcodeErrorCategory() {
5712 return *ErrorCategory;
5715 //===----------------------------------------------------------------------===//
5716 // External interface
5717 //===----------------------------------------------------------------------===//
5719 static ErrorOr<std::unique_ptr<Module>>
5720 getBitcodeModuleImpl(std::unique_ptr<DataStreamer> Streamer, StringRef Name,
5721 BitcodeReader *R, LLVMContext &Context,
5722 bool MaterializeAll, bool ShouldLazyLoadMetadata) {
5723 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
5724 M->setMaterializer(R);
5726 auto cleanupOnError = [&](std::error_code EC) {
5727 R->releaseBuffer(); // Never take ownership on error.
5731 // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
5732 if (std::error_code EC = R->parseBitcodeInto(std::move(Streamer), M.get(),
5733 ShouldLazyLoadMetadata))
5734 return cleanupOnError(EC);
5736 if (MaterializeAll) {
5737 // Read in the entire module, and destroy the BitcodeReader.
5738 if (std::error_code EC = M->materializeAllPermanently())
5739 return cleanupOnError(EC);
5741 // Resolve forward references from blockaddresses.
5742 if (std::error_code EC = R->materializeForwardReferencedFunctions())
5743 return cleanupOnError(EC);
5745 return std::move(M);
5748 /// \brief Get a lazy one-at-time loading module from bitcode.
5750 /// This isn't always used in a lazy context. In particular, it's also used by
5751 /// \a parseBitcodeFile(). If this is truly lazy, then we need to eagerly pull
5752 /// in forward-referenced functions from block address references.
5754 /// \param[in] MaterializeAll Set to \c true if we should materialize
5756 static ErrorOr<std::unique_ptr<Module>>
5757 getLazyBitcodeModuleImpl(std::unique_ptr<MemoryBuffer> &&Buffer,
5758 LLVMContext &Context, bool MaterializeAll,
5759 DiagnosticHandlerFunction DiagnosticHandler,
5760 bool ShouldLazyLoadMetadata = false) {
5762 new BitcodeReader(Buffer.get(), Context, DiagnosticHandler);
5764 ErrorOr<std::unique_ptr<Module>> Ret =
5765 getBitcodeModuleImpl(nullptr, Buffer->getBufferIdentifier(), R, Context,
5766 MaterializeAll, ShouldLazyLoadMetadata);
5770 Buffer.release(); // The BitcodeReader owns it now.
5774 ErrorOr<std::unique_ptr<Module>> llvm::getLazyBitcodeModule(
5775 std::unique_ptr<MemoryBuffer> &&Buffer, LLVMContext &Context,
5776 DiagnosticHandlerFunction DiagnosticHandler, bool ShouldLazyLoadMetadata) {
5777 return getLazyBitcodeModuleImpl(std::move(Buffer), Context, false,
5778 DiagnosticHandler, ShouldLazyLoadMetadata);
5781 ErrorOr<std::unique_ptr<Module>> llvm::getStreamedBitcodeModule(
5782 StringRef Name, std::unique_ptr<DataStreamer> Streamer,
5783 LLVMContext &Context, DiagnosticHandlerFunction DiagnosticHandler) {
5784 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
5785 BitcodeReader *R = new BitcodeReader(Context, DiagnosticHandler);
5787 return getBitcodeModuleImpl(std::move(Streamer), Name, R, Context, false,
5791 ErrorOr<std::unique_ptr<Module>>
5792 llvm::parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context,
5793 DiagnosticHandlerFunction DiagnosticHandler) {
5794 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5795 return getLazyBitcodeModuleImpl(std::move(Buf), Context, true,
5797 // TODO: Restore the use-lists to the in-memory state when the bitcode was
5798 // written. We must defer until the Module has been fully materialized.
5802 llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer, LLVMContext &Context,
5803 DiagnosticHandlerFunction DiagnosticHandler) {
5804 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5805 auto R = llvm::make_unique<BitcodeReader>(Buf.release(), Context,
5807 ErrorOr<std::string> Triple = R->parseTriple();
5808 if (Triple.getError())
5810 return Triple.get();
5813 // Parse the specified bitcode buffer, returning the function info index.
5814 // If IsLazy is false, parse the entire function summary into
5815 // the index. Otherwise skip the function summary section, and only create
5816 // an index object with a map from function name to function summary offset.
5817 // The index is used to perform lazy function summary reading later.
5818 ErrorOr<std::unique_ptr<FunctionInfoIndex>>
5819 llvm::getFunctionInfoIndex(MemoryBufferRef Buffer, LLVMContext &Context,
5820 DiagnosticHandlerFunction DiagnosticHandler,
5821 const Module *ExportingModule, bool IsLazy) {
5822 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5823 FunctionIndexBitcodeReader R(Buf.get(), Context, DiagnosticHandler, IsLazy);
5825 std::unique_ptr<FunctionInfoIndex> Index =
5826 llvm::make_unique<FunctionInfoIndex>(ExportingModule);
5828 auto cleanupOnError = [&](std::error_code EC) {
5829 R.releaseBuffer(); // Never take ownership on error.
5833 if (std::error_code EC = R.parseSummaryIndexInto(nullptr, Index.get()))
5834 return cleanupOnError(EC);
5836 Buf.release(); // The FunctionIndexBitcodeReader owns it now.
5837 return std::move(Index);
5840 // Check if the given bitcode buffer contains a function summary block.
5841 bool llvm::hasFunctionSummary(MemoryBufferRef Buffer, LLVMContext &Context,
5842 DiagnosticHandlerFunction DiagnosticHandler) {
5843 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5844 FunctionIndexBitcodeReader R(Buf.get(), Context, DiagnosticHandler, false,
5847 auto cleanupOnError = [&](std::error_code EC) {
5848 R.releaseBuffer(); // Never take ownership on error.
5852 if (std::error_code EC = R.parseSummaryIndexInto(nullptr, nullptr))
5853 return cleanupOnError(EC);
5855 Buf.release(); // The FunctionIndexBitcodeReader owns it now.
5856 return R.foundFuncSummary();
5859 // This method supports lazy reading of function summary data from the combined
5860 // index during ThinLTO function importing. When reading the combined index
5861 // file, getFunctionInfoIndex is first invoked with IsLazy=true.
5862 // Then this method is called for each function considered for importing,
5863 // to parse the summary information for the given function name into
5866 llvm::readFunctionSummary(MemoryBufferRef Buffer, LLVMContext &Context,
5867 DiagnosticHandlerFunction DiagnosticHandler,
5868 StringRef FunctionName,
5869 std::unique_ptr<FunctionInfoIndex> Index) {
5870 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5871 FunctionIndexBitcodeReader R(Buf.get(), Context, DiagnosticHandler);
5873 auto cleanupOnError = [&](std::error_code EC) {
5874 R.releaseBuffer(); // Never take ownership on error.
5878 // Lookup the given function name in the FunctionMap, which may
5879 // contain a list of function infos in the case of a COMDAT. Walk through
5880 // and parse each function summary info at the function summary offset
5881 // recorded when parsing the value symbol table.
5882 for (const auto &FI : Index->getFunctionInfoList(FunctionName)) {
5883 size_t FunctionSummaryOffset = FI->bitcodeIndex();
5884 if (std::error_code EC =
5885 R.parseFunctionSummary(nullptr, Index.get(), FunctionSummaryOffset))
5886 return cleanupOnError(EC);
5889 Buf.release(); // The FunctionIndexBitcodeReader owns it now.
5890 return std::error_code();