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 class BitcodeReaderValueList {
46 std::vector<WeakVH> ValuePtrs;
48 /// As we resolve forward-referenced constants, we add information about them
49 /// to this vector. This allows us to resolve them in bulk instead of
50 /// resolving each reference at a time. See the code in
51 /// ResolveConstantForwardRefs for more information about this.
53 /// The key of this vector is the placeholder constant, the value is the slot
54 /// number that holds the resolved value.
55 typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy;
56 ResolveConstantsTy ResolveConstants;
59 BitcodeReaderValueList(LLVMContext &C) : Context(C) {}
60 ~BitcodeReaderValueList() {
61 assert(ResolveConstants.empty() && "Constants not resolved?");
64 // vector compatibility methods
65 unsigned size() const { return ValuePtrs.size(); }
66 void resize(unsigned N) { ValuePtrs.resize(N); }
67 void push_back(Value *V) { ValuePtrs.emplace_back(V); }
70 assert(ResolveConstants.empty() && "Constants not resolved?");
74 Value *operator[](unsigned i) const {
75 assert(i < ValuePtrs.size());
79 Value *back() const { return ValuePtrs.back(); }
80 void pop_back() { ValuePtrs.pop_back(); }
81 bool empty() const { return ValuePtrs.empty(); }
82 void shrinkTo(unsigned N) {
83 assert(N <= size() && "Invalid shrinkTo request!");
87 Constant *getConstantFwdRef(unsigned Idx, Type *Ty);
88 Value *getValueFwdRef(unsigned Idx, Type *Ty);
90 void assignValue(Value *V, unsigned Idx);
92 /// Once all constants are read, this method bulk resolves any forward
94 void resolveConstantForwardRefs();
97 class BitcodeReaderMetadataList {
102 std::vector<TrackingMDRef> MetadataPtrs;
104 LLVMContext &Context;
106 BitcodeReaderMetadataList(LLVMContext &C)
107 : NumFwdRefs(0), AnyFwdRefs(false), Context(C) {}
109 // vector compatibility methods
110 unsigned size() const { return MetadataPtrs.size(); }
111 void resize(unsigned N) { MetadataPtrs.resize(N); }
112 void push_back(Metadata *MD) { MetadataPtrs.emplace_back(MD); }
113 void clear() { MetadataPtrs.clear(); }
114 Metadata *back() const { return MetadataPtrs.back(); }
115 void pop_back() { MetadataPtrs.pop_back(); }
116 bool empty() const { return MetadataPtrs.empty(); }
118 Metadata *operator[](unsigned i) const {
119 assert(i < MetadataPtrs.size());
120 return MetadataPtrs[i];
123 void shrinkTo(unsigned N) {
124 assert(N <= size() && "Invalid shrinkTo request!");
125 MetadataPtrs.resize(N);
128 Metadata *getValueFwdRef(unsigned Idx);
129 void assignValue(Metadata *MD, unsigned Idx);
130 void tryToResolveCycles();
133 class BitcodeReader : public GVMaterializer {
134 LLVMContext &Context;
135 Module *TheModule = nullptr;
136 std::unique_ptr<MemoryBuffer> Buffer;
137 std::unique_ptr<BitstreamReader> StreamFile;
138 BitstreamCursor Stream;
139 // Next offset to start scanning for lazy parsing of function bodies.
140 uint64_t NextUnreadBit = 0;
141 // Last function offset found in the VST.
142 uint64_t LastFunctionBlockBit = 0;
143 bool SeenValueSymbolTable = false;
144 uint64_t VSTOffset = 0;
145 // Contains an arbitrary and optional string identifying the bitcode producer
146 std::string ProducerIdentification;
147 // Number of module level metadata records specified by the
148 // MODULE_CODE_METADATA_VALUES record.
149 unsigned NumModuleMDs = 0;
150 // Support older bitcode without the MODULE_CODE_METADATA_VALUES record.
151 bool SeenModuleValuesRecord = false;
153 std::vector<Type*> TypeList;
154 BitcodeReaderValueList ValueList;
155 BitcodeReaderMetadataList MetadataList;
156 std::vector<Comdat *> ComdatList;
157 SmallVector<Instruction *, 64> InstructionList;
159 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
160 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits;
161 std::vector<std::pair<Function*, unsigned> > FunctionPrefixes;
162 std::vector<std::pair<Function*, unsigned> > FunctionPrologues;
163 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFns;
165 SmallVector<Instruction*, 64> InstsWithTBAATag;
167 /// The set of attributes by index. Index zero in the file is for null, and
168 /// is thus not represented here. As such all indices are off by one.
169 std::vector<AttributeSet> MAttributes;
171 /// The set of attribute groups.
172 std::map<unsigned, AttributeSet> MAttributeGroups;
174 /// While parsing a function body, this is a list of the basic blocks for the
176 std::vector<BasicBlock*> FunctionBBs;
178 // When reading the module header, this list is populated with functions that
179 // have bodies later in the file.
180 std::vector<Function*> FunctionsWithBodies;
182 // When intrinsic functions are encountered which require upgrading they are
183 // stored here with their replacement function.
184 typedef DenseMap<Function*, Function*> UpgradedIntrinsicMap;
185 UpgradedIntrinsicMap UpgradedIntrinsics;
187 // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
188 DenseMap<unsigned, unsigned> MDKindMap;
190 // Several operations happen after the module header has been read, but
191 // before function bodies are processed. This keeps track of whether
192 // we've done this yet.
193 bool SeenFirstFunctionBody = false;
195 /// When function bodies are initially scanned, this map contains info about
196 /// where to find deferred function body in the stream.
197 DenseMap<Function*, uint64_t> DeferredFunctionInfo;
199 /// When Metadata block is initially scanned when parsing the module, we may
200 /// choose to defer parsing of the metadata. This vector contains info about
201 /// which Metadata blocks are deferred.
202 std::vector<uint64_t> DeferredMetadataInfo;
204 /// These are basic blocks forward-referenced by block addresses. They are
205 /// inserted lazily into functions when they're loaded. The basic block ID is
206 /// its index into the vector.
207 DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
208 std::deque<Function *> BasicBlockFwdRefQueue;
210 /// Indicates that we are using a new encoding for instruction operands where
211 /// most operands in the current FUNCTION_BLOCK are encoded relative to the
212 /// instruction number, for a more compact encoding. Some instruction
213 /// operands are not relative to the instruction ID: basic block numbers, and
214 /// types. Once the old style function blocks have been phased out, we would
215 /// not need this flag.
216 bool UseRelativeIDs = false;
218 /// True if all functions will be materialized, negating the need to process
219 /// (e.g.) blockaddress forward references.
220 bool WillMaterializeAllForwardRefs = false;
222 /// True if any Metadata block has been materialized.
223 bool IsMetadataMaterialized = false;
225 bool StripDebugInfo = false;
227 /// Functions that need to be matched with subprograms when upgrading old
229 SmallDenseMap<Function *, DISubprogram *, 16> FunctionsWithSPs;
231 std::vector<std::string> BundleTags;
234 std::error_code error(BitcodeError E, const Twine &Message);
235 std::error_code error(BitcodeError E);
236 std::error_code error(const Twine &Message);
238 BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context);
239 BitcodeReader(LLVMContext &Context);
240 ~BitcodeReader() override { freeState(); }
242 std::error_code materializeForwardReferencedFunctions();
246 void releaseBuffer();
248 std::error_code materialize(GlobalValue *GV) override;
249 std::error_code materializeModule() override;
250 std::vector<StructType *> getIdentifiedStructTypes() const override;
252 /// \brief Main interface to parsing a bitcode buffer.
253 /// \returns true if an error occurred.
254 std::error_code parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
256 bool ShouldLazyLoadMetadata = false);
258 /// \brief Cheap mechanism to just extract module triple
259 /// \returns true if an error occurred.
260 ErrorOr<std::string> parseTriple();
262 /// Cheap mechanism to just extract the identification block out of bitcode.
263 ErrorOr<std::string> parseIdentificationBlock();
265 static uint64_t decodeSignRotatedValue(uint64_t V);
267 /// Materialize any deferred Metadata block.
268 std::error_code materializeMetadata() override;
270 void setStripDebugInfo() override;
272 /// Save the mapping between the metadata values and the corresponding
273 /// value id that were recorded in the MetadataList during parsing. If
274 /// OnlyTempMD is true, then only record those entries that are still
275 /// temporary metadata. This interface is used when metadata linking is
276 /// performed as a postpass, such as during function importing.
277 void saveMetadataList(DenseMap<const Metadata *, unsigned> &MetadataToIDs,
278 bool OnlyTempMD) override;
281 /// Parse the "IDENTIFICATION_BLOCK_ID" block, populate the
282 // ProducerIdentification data member, and do some basic enforcement on the
283 // "epoch" encoded in the bitcode.
284 std::error_code parseBitcodeVersion();
286 std::vector<StructType *> IdentifiedStructTypes;
287 StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
288 StructType *createIdentifiedStructType(LLVMContext &Context);
290 Type *getTypeByID(unsigned ID);
291 Value *getFnValueByID(unsigned ID, Type *Ty) {
292 if (Ty && Ty->isMetadataTy())
293 return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
294 return ValueList.getValueFwdRef(ID, Ty);
296 Metadata *getFnMetadataByID(unsigned ID) {
297 return MetadataList.getValueFwdRef(ID);
299 BasicBlock *getBasicBlock(unsigned ID) const {
300 if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
301 return FunctionBBs[ID];
303 AttributeSet getAttributes(unsigned i) const {
304 if (i-1 < MAttributes.size())
305 return MAttributes[i-1];
306 return AttributeSet();
309 /// Read a value/type pair out of the specified record from slot 'Slot'.
310 /// Increment Slot past the number of slots used in the record. Return true on
312 bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
313 unsigned InstNum, Value *&ResVal) {
314 if (Slot == Record.size()) return true;
315 unsigned ValNo = (unsigned)Record[Slot++];
316 // Adjust the ValNo, if it was encoded relative to the InstNum.
318 ValNo = InstNum - ValNo;
319 if (ValNo < InstNum) {
320 // If this is not a forward reference, just return the value we already
322 ResVal = getFnValueByID(ValNo, nullptr);
323 return ResVal == nullptr;
325 if (Slot == Record.size())
328 unsigned TypeNo = (unsigned)Record[Slot++];
329 ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
330 return ResVal == nullptr;
333 /// Read a value out of the specified record from slot 'Slot'. Increment Slot
334 /// past the number of slots used by the value in the record. Return true if
335 /// there is an error.
336 bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
337 unsigned InstNum, Type *Ty, Value *&ResVal) {
338 if (getValue(Record, Slot, InstNum, Ty, ResVal))
340 // All values currently take a single record slot.
345 /// Like popValue, but does not increment the Slot number.
346 bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
347 unsigned InstNum, Type *Ty, Value *&ResVal) {
348 ResVal = getValue(Record, Slot, InstNum, Ty);
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) {
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);
364 /// Like getValue, but decodes signed VBRs.
365 Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
366 unsigned InstNum, Type *Ty) {
367 if (Slot == Record.size()) return nullptr;
368 unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
369 // Adjust the ValNo, if it was encoded relative to the InstNum.
371 ValNo = InstNum - ValNo;
372 return getFnValueByID(ValNo, Ty);
375 /// Converts alignment exponent (i.e. power of two (or zero)) to the
376 /// corresponding alignment to use. If alignment is too large, returns
377 /// a corresponding error code.
378 std::error_code parseAlignmentValue(uint64_t Exponent, unsigned &Alignment);
379 std::error_code parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
380 std::error_code parseModule(uint64_t ResumeBit,
381 bool ShouldLazyLoadMetadata = false);
382 std::error_code parseAttributeBlock();
383 std::error_code parseAttributeGroupBlock();
384 std::error_code parseTypeTable();
385 std::error_code parseTypeTableBody();
386 std::error_code parseOperandBundleTags();
388 ErrorOr<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,
389 unsigned NameIndex, Triple &TT);
390 std::error_code parseValueSymbolTable(uint64_t Offset = 0);
391 std::error_code parseConstants();
392 std::error_code rememberAndSkipFunctionBodies();
393 std::error_code rememberAndSkipFunctionBody();
394 /// Save the positions of the Metadata blocks and skip parsing the blocks.
395 std::error_code rememberAndSkipMetadata();
396 std::error_code parseFunctionBody(Function *F);
397 std::error_code globalCleanup();
398 std::error_code resolveGlobalAndAliasInits();
399 std::error_code parseMetadata(bool ModuleLevel = false);
400 std::error_code parseMetadataKinds();
401 std::error_code parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record);
402 std::error_code parseMetadataAttachment(Function &F);
403 ErrorOr<std::string> parseModuleTriple();
404 std::error_code parseUseLists();
405 std::error_code initStream(std::unique_ptr<DataStreamer> Streamer);
406 std::error_code initStreamFromBuffer();
407 std::error_code initLazyStream(std::unique_ptr<DataStreamer> Streamer);
408 std::error_code findFunctionInStream(
410 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
413 /// Class to manage reading and parsing function summary index bitcode
415 class FunctionIndexBitcodeReader {
416 DiagnosticHandlerFunction DiagnosticHandler;
418 /// Eventually points to the function index built during parsing.
419 FunctionInfoIndex *TheIndex = nullptr;
421 std::unique_ptr<MemoryBuffer> Buffer;
422 std::unique_ptr<BitstreamReader> StreamFile;
423 BitstreamCursor Stream;
425 /// \brief Used to indicate whether we are doing lazy parsing of summary data.
427 /// If false, the summary section is fully parsed into the index during
428 /// the initial parse. Otherwise, if true, the caller is expected to
429 /// invoke \a readFunctionSummary for each summary needed, and the summary
430 /// section is thus parsed lazily.
433 /// Used to indicate whether caller only wants to check for the presence
434 /// of the function summary bitcode section. All blocks are skipped,
435 /// but the SeenFuncSummary boolean is set.
436 bool CheckFuncSummaryPresenceOnly = false;
438 /// Indicates whether we have encountered a function summary section
439 /// yet during parsing, used when checking if file contains function
441 bool SeenFuncSummary = false;
443 /// \brief Map populated during function summary section parsing, and
444 /// consumed during ValueSymbolTable parsing.
446 /// Used to correlate summary records with VST entries. For the per-module
447 /// index this maps the ValueID to the parsed function summary, and
448 /// for the combined index this maps the summary record's bitcode
449 /// offset to the function summary (since in the combined index the
450 /// VST records do not hold value IDs but rather hold the function
451 /// summary record offset).
452 DenseMap<uint64_t, std::unique_ptr<FunctionSummary>> SummaryMap;
454 /// Map populated during module path string table parsing, from the
455 /// module ID to a string reference owned by the index's module
456 /// path string table, used to correlate with combined index function
458 DenseMap<uint64_t, StringRef> ModuleIdMap;
461 std::error_code error(BitcodeError E, const Twine &Message);
462 std::error_code error(BitcodeError E);
463 std::error_code error(const Twine &Message);
465 FunctionIndexBitcodeReader(MemoryBuffer *Buffer,
466 DiagnosticHandlerFunction DiagnosticHandler,
468 bool CheckFuncSummaryPresenceOnly = false);
469 FunctionIndexBitcodeReader(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(LLVMContext &Context, std::error_code EC,
522 const Twine &Message) {
523 return error([&](const DiagnosticInfo &DI) { Context.diagnose(DI); }, EC,
527 static std::error_code error(LLVMContext &Context, std::error_code EC) {
528 return error(Context, EC, EC.message());
531 static std::error_code error(LLVMContext &Context, const Twine &Message) {
532 return error(Context, make_error_code(BitcodeError::CorruptedBitcode),
536 std::error_code BitcodeReader::error(BitcodeError E, const Twine &Message) {
537 if (!ProducerIdentification.empty()) {
538 return ::error(Context, make_error_code(E),
539 Message + " (Producer: '" + ProducerIdentification +
540 "' Reader: 'LLVM " + LLVM_VERSION_STRING "')");
542 return ::error(Context, make_error_code(E), Message);
545 std::error_code BitcodeReader::error(const Twine &Message) {
546 if (!ProducerIdentification.empty()) {
547 return ::error(Context, make_error_code(BitcodeError::CorruptedBitcode),
548 Message + " (Producer: '" + ProducerIdentification +
549 "' Reader: 'LLVM " + LLVM_VERSION_STRING "')");
551 return ::error(Context, make_error_code(BitcodeError::CorruptedBitcode),
555 std::error_code BitcodeReader::error(BitcodeError E) {
556 return ::error(Context, make_error_code(E));
559 BitcodeReader::BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context)
560 : Context(Context), Buffer(Buffer), ValueList(Context),
561 MetadataList(Context) {}
563 BitcodeReader::BitcodeReader(LLVMContext &Context)
564 : Context(Context), Buffer(nullptr), ValueList(Context),
565 MetadataList(Context) {}
567 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
568 if (WillMaterializeAllForwardRefs)
569 return std::error_code();
571 // Prevent recursion.
572 WillMaterializeAllForwardRefs = true;
574 while (!BasicBlockFwdRefQueue.empty()) {
575 Function *F = BasicBlockFwdRefQueue.front();
576 BasicBlockFwdRefQueue.pop_front();
577 assert(F && "Expected valid function");
578 if (!BasicBlockFwdRefs.count(F))
579 // Already materialized.
582 // Check for a function that isn't materializable to prevent an infinite
583 // loop. When parsing a blockaddress stored in a global variable, there
584 // isn't a trivial way to check if a function will have a body without a
585 // linear search through FunctionsWithBodies, so just check it here.
586 if (!F->isMaterializable())
587 return error("Never resolved function from blockaddress");
589 // Try to materialize F.
590 if (std::error_code EC = materialize(F))
593 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
596 WillMaterializeAllForwardRefs = false;
597 return std::error_code();
600 void BitcodeReader::freeState() {
602 std::vector<Type*>().swap(TypeList);
604 MetadataList.clear();
605 std::vector<Comdat *>().swap(ComdatList);
607 std::vector<AttributeSet>().swap(MAttributes);
608 std::vector<BasicBlock*>().swap(FunctionBBs);
609 std::vector<Function*>().swap(FunctionsWithBodies);
610 DeferredFunctionInfo.clear();
611 DeferredMetadataInfo.clear();
614 assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
615 BasicBlockFwdRefQueue.clear();
618 //===----------------------------------------------------------------------===//
619 // Helper functions to implement forward reference resolution, etc.
620 //===----------------------------------------------------------------------===//
622 /// Convert a string from a record into an std::string, return true on failure.
623 template <typename StrTy>
624 static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
626 if (Idx > Record.size())
629 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
630 Result += (char)Record[i];
634 static bool hasImplicitComdat(size_t Val) {
638 case 1: // Old WeakAnyLinkage
639 case 4: // Old LinkOnceAnyLinkage
640 case 10: // Old WeakODRLinkage
641 case 11: // Old LinkOnceODRLinkage
646 static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
648 default: // Map unknown/new linkages to external
650 return GlobalValue::ExternalLinkage;
652 return GlobalValue::AppendingLinkage;
654 return GlobalValue::InternalLinkage;
656 return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
658 return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
660 return GlobalValue::ExternalWeakLinkage;
662 return GlobalValue::CommonLinkage;
664 return GlobalValue::PrivateLinkage;
666 return GlobalValue::AvailableExternallyLinkage;
668 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
670 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
672 return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
673 case 1: // Old value with implicit comdat.
675 return GlobalValue::WeakAnyLinkage;
676 case 10: // Old value with implicit comdat.
678 return GlobalValue::WeakODRLinkage;
679 case 4: // Old value with implicit comdat.
681 return GlobalValue::LinkOnceAnyLinkage;
682 case 11: // Old value with implicit comdat.
684 return GlobalValue::LinkOnceODRLinkage;
688 static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {
690 default: // Map unknown visibilities to default.
691 case 0: return GlobalValue::DefaultVisibility;
692 case 1: return GlobalValue::HiddenVisibility;
693 case 2: return GlobalValue::ProtectedVisibility;
697 static GlobalValue::DLLStorageClassTypes
698 getDecodedDLLStorageClass(unsigned Val) {
700 default: // Map unknown values to default.
701 case 0: return GlobalValue::DefaultStorageClass;
702 case 1: return GlobalValue::DLLImportStorageClass;
703 case 2: return GlobalValue::DLLExportStorageClass;
707 static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {
709 case 0: return GlobalVariable::NotThreadLocal;
710 default: // Map unknown non-zero value to general dynamic.
711 case 1: return GlobalVariable::GeneralDynamicTLSModel;
712 case 2: return GlobalVariable::LocalDynamicTLSModel;
713 case 3: return GlobalVariable::InitialExecTLSModel;
714 case 4: return GlobalVariable::LocalExecTLSModel;
718 static int getDecodedCastOpcode(unsigned Val) {
721 case bitc::CAST_TRUNC : return Instruction::Trunc;
722 case bitc::CAST_ZEXT : return Instruction::ZExt;
723 case bitc::CAST_SEXT : return Instruction::SExt;
724 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
725 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
726 case bitc::CAST_UITOFP : return Instruction::UIToFP;
727 case bitc::CAST_SITOFP : return Instruction::SIToFP;
728 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
729 case bitc::CAST_FPEXT : return Instruction::FPExt;
730 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
731 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
732 case bitc::CAST_BITCAST : return Instruction::BitCast;
733 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
737 static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
738 bool IsFP = Ty->isFPOrFPVectorTy();
739 // BinOps are only valid for int/fp or vector of int/fp types
740 if (!IsFP && !Ty->isIntOrIntVectorTy())
746 case bitc::BINOP_ADD:
747 return IsFP ? Instruction::FAdd : Instruction::Add;
748 case bitc::BINOP_SUB:
749 return IsFP ? Instruction::FSub : Instruction::Sub;
750 case bitc::BINOP_MUL:
751 return IsFP ? Instruction::FMul : Instruction::Mul;
752 case bitc::BINOP_UDIV:
753 return IsFP ? -1 : Instruction::UDiv;
754 case bitc::BINOP_SDIV:
755 return IsFP ? Instruction::FDiv : Instruction::SDiv;
756 case bitc::BINOP_UREM:
757 return IsFP ? -1 : Instruction::URem;
758 case bitc::BINOP_SREM:
759 return IsFP ? Instruction::FRem : Instruction::SRem;
760 case bitc::BINOP_SHL:
761 return IsFP ? -1 : Instruction::Shl;
762 case bitc::BINOP_LSHR:
763 return IsFP ? -1 : Instruction::LShr;
764 case bitc::BINOP_ASHR:
765 return IsFP ? -1 : Instruction::AShr;
766 case bitc::BINOP_AND:
767 return IsFP ? -1 : Instruction::And;
769 return IsFP ? -1 : Instruction::Or;
770 case bitc::BINOP_XOR:
771 return IsFP ? -1 : Instruction::Xor;
775 static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {
777 default: return AtomicRMWInst::BAD_BINOP;
778 case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
779 case bitc::RMW_ADD: return AtomicRMWInst::Add;
780 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
781 case bitc::RMW_AND: return AtomicRMWInst::And;
782 case bitc::RMW_NAND: return AtomicRMWInst::Nand;
783 case bitc::RMW_OR: return AtomicRMWInst::Or;
784 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
785 case bitc::RMW_MAX: return AtomicRMWInst::Max;
786 case bitc::RMW_MIN: return AtomicRMWInst::Min;
787 case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
788 case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
792 static AtomicOrdering getDecodedOrdering(unsigned Val) {
794 case bitc::ORDERING_NOTATOMIC: return NotAtomic;
795 case bitc::ORDERING_UNORDERED: return Unordered;
796 case bitc::ORDERING_MONOTONIC: return Monotonic;
797 case bitc::ORDERING_ACQUIRE: return Acquire;
798 case bitc::ORDERING_RELEASE: return Release;
799 case bitc::ORDERING_ACQREL: return AcquireRelease;
800 default: // Map unknown orderings to sequentially-consistent.
801 case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
805 static SynchronizationScope getDecodedSynchScope(unsigned Val) {
807 case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
808 default: // Map unknown scopes to cross-thread.
809 case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
813 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
815 default: // Map unknown selection kinds to any.
816 case bitc::COMDAT_SELECTION_KIND_ANY:
818 case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
819 return Comdat::ExactMatch;
820 case bitc::COMDAT_SELECTION_KIND_LARGEST:
821 return Comdat::Largest;
822 case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
823 return Comdat::NoDuplicates;
824 case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
825 return Comdat::SameSize;
829 static FastMathFlags getDecodedFastMathFlags(unsigned Val) {
831 if (0 != (Val & FastMathFlags::UnsafeAlgebra))
832 FMF.setUnsafeAlgebra();
833 if (0 != (Val & FastMathFlags::NoNaNs))
835 if (0 != (Val & FastMathFlags::NoInfs))
837 if (0 != (Val & FastMathFlags::NoSignedZeros))
838 FMF.setNoSignedZeros();
839 if (0 != (Val & FastMathFlags::AllowReciprocal))
840 FMF.setAllowReciprocal();
844 static void upgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
846 case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
847 case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
853 /// \brief A class for maintaining the slot number definition
854 /// as a placeholder for the actual definition for forward constants defs.
855 class ConstantPlaceHolder : public ConstantExpr {
856 void operator=(const ConstantPlaceHolder &) = delete;
859 // allocate space for exactly one operand
860 void *operator new(size_t s) { return User::operator new(s, 1); }
861 explicit ConstantPlaceHolder(Type *Ty, LLVMContext &Context)
862 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
863 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
866 /// \brief Methods to support type inquiry through isa, cast, and dyn_cast.
867 static bool classof(const Value *V) {
868 return isa<ConstantExpr>(V) &&
869 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
872 /// Provide fast operand accessors
873 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
877 // FIXME: can we inherit this from ConstantExpr?
879 struct OperandTraits<ConstantPlaceHolder> :
880 public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
882 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantPlaceHolder, Value)
885 void BitcodeReaderValueList::assignValue(Value *V, unsigned Idx) {
894 WeakVH &OldV = ValuePtrs[Idx];
900 // Handle constants and non-constants (e.g. instrs) differently for
902 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
903 ResolveConstants.push_back(std::make_pair(PHC, Idx));
906 // If there was a forward reference to this value, replace it.
907 Value *PrevVal = OldV;
908 OldV->replaceAllUsesWith(V);
916 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
921 if (Value *V = ValuePtrs[Idx]) {
922 if (Ty != V->getType())
923 report_fatal_error("Type mismatch in constant table!");
924 return cast<Constant>(V);
927 // Create and return a placeholder, which will later be RAUW'd.
928 Constant *C = new ConstantPlaceHolder(Ty, Context);
933 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty) {
934 // Bail out for a clearly invalid value. This would make us call resize(0)
941 if (Value *V = ValuePtrs[Idx]) {
942 // If the types don't match, it's invalid.
943 if (Ty && Ty != V->getType())
948 // No type specified, must be invalid reference.
949 if (!Ty) return nullptr;
951 // Create and return a placeholder, which will later be RAUW'd.
952 Value *V = new Argument(Ty);
957 /// Once all constants are read, this method bulk resolves any forward
958 /// references. The idea behind this is that we sometimes get constants (such
959 /// as large arrays) which reference *many* forward ref constants. Replacing
960 /// each of these causes a lot of thrashing when building/reuniquing the
961 /// constant. Instead of doing this, we look at all the uses and rewrite all
962 /// the place holders at once for any constant that uses a placeholder.
963 void BitcodeReaderValueList::resolveConstantForwardRefs() {
964 // Sort the values by-pointer so that they are efficient to look up with a
966 std::sort(ResolveConstants.begin(), ResolveConstants.end());
968 SmallVector<Constant*, 64> NewOps;
970 while (!ResolveConstants.empty()) {
971 Value *RealVal = operator[](ResolveConstants.back().second);
972 Constant *Placeholder = ResolveConstants.back().first;
973 ResolveConstants.pop_back();
975 // Loop over all users of the placeholder, updating them to reference the
976 // new value. If they reference more than one placeholder, update them all
978 while (!Placeholder->use_empty()) {
979 auto UI = Placeholder->user_begin();
982 // If the using object isn't uniqued, just update the operands. This
983 // handles instructions and initializers for global variables.
984 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
985 UI.getUse().set(RealVal);
989 // Otherwise, we have a constant that uses the placeholder. Replace that
990 // constant with a new constant that has *all* placeholder uses updated.
991 Constant *UserC = cast<Constant>(U);
992 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
995 if (!isa<ConstantPlaceHolder>(*I)) {
996 // Not a placeholder reference.
998 } else if (*I == Placeholder) {
999 // Common case is that it just references this one placeholder.
1002 // Otherwise, look up the placeholder in ResolveConstants.
1003 ResolveConstantsTy::iterator It =
1004 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
1005 std::pair<Constant*, unsigned>(cast<Constant>(*I),
1007 assert(It != ResolveConstants.end() && It->first == *I);
1008 NewOp = operator[](It->second);
1011 NewOps.push_back(cast<Constant>(NewOp));
1014 // Make the new constant.
1016 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
1017 NewC = ConstantArray::get(UserCA->getType(), NewOps);
1018 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
1019 NewC = ConstantStruct::get(UserCS->getType(), NewOps);
1020 } else if (isa<ConstantVector>(UserC)) {
1021 NewC = ConstantVector::get(NewOps);
1023 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
1024 NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
1027 UserC->replaceAllUsesWith(NewC);
1028 UserC->destroyConstant();
1032 // Update all ValueHandles, they should be the only users at this point.
1033 Placeholder->replaceAllUsesWith(RealVal);
1038 void BitcodeReaderMetadataList::assignValue(Metadata *MD, unsigned Idx) {
1039 if (Idx == size()) {
1047 TrackingMDRef &OldMD = MetadataPtrs[Idx];
1053 // If there was a forward reference to this value, replace it.
1054 TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
1055 PrevMD->replaceAllUsesWith(MD);
1059 Metadata *BitcodeReaderMetadataList::getValueFwdRef(unsigned Idx) {
1063 if (Metadata *MD = MetadataPtrs[Idx])
1066 // Track forward refs to be resolved later.
1068 MinFwdRef = std::min(MinFwdRef, Idx);
1069 MaxFwdRef = std::max(MaxFwdRef, Idx);
1072 MinFwdRef = MaxFwdRef = Idx;
1076 // Create and return a placeholder, which will later be RAUW'd.
1077 Metadata *MD = MDNode::getTemporary(Context, None).release();
1078 MetadataPtrs[Idx].reset(MD);
1082 void BitcodeReaderMetadataList::tryToResolveCycles() {
1088 // Still forward references... can't resolve cycles.
1091 // Resolve any cycles.
1092 for (unsigned I = MinFwdRef, E = MaxFwdRef + 1; I != E; ++I) {
1093 auto &MD = MetadataPtrs[I];
1094 auto *N = dyn_cast_or_null<MDNode>(MD);
1098 assert(!N->isTemporary() && "Unexpected forward reference");
1102 // Make sure we return early again until there's another forward ref.
1106 Type *BitcodeReader::getTypeByID(unsigned ID) {
1107 // The type table size is always specified correctly.
1108 if (ID >= TypeList.size())
1111 if (Type *Ty = TypeList[ID])
1114 // If we have a forward reference, the only possible case is when it is to a
1115 // named struct. Just create a placeholder for now.
1116 return TypeList[ID] = createIdentifiedStructType(Context);
1119 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
1121 auto *Ret = StructType::create(Context, Name);
1122 IdentifiedStructTypes.push_back(Ret);
1126 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
1127 auto *Ret = StructType::create(Context);
1128 IdentifiedStructTypes.push_back(Ret);
1133 //===----------------------------------------------------------------------===//
1134 // Functions for parsing blocks from the bitcode file
1135 //===----------------------------------------------------------------------===//
1138 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
1139 /// been decoded from the given integer. This function must stay in sync with
1140 /// 'encodeLLVMAttributesForBitcode'.
1141 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1142 uint64_t EncodedAttrs) {
1143 // FIXME: Remove in 4.0.
1145 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
1146 // the bits above 31 down by 11 bits.
1147 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1148 assert((!Alignment || isPowerOf2_32(Alignment)) &&
1149 "Alignment must be a power of two.");
1152 B.addAlignmentAttr(Alignment);
1153 B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1154 (EncodedAttrs & 0xffff));
1157 std::error_code BitcodeReader::parseAttributeBlock() {
1158 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
1159 return error("Invalid record");
1161 if (!MAttributes.empty())
1162 return error("Invalid multiple blocks");
1164 SmallVector<uint64_t, 64> Record;
1166 SmallVector<AttributeSet, 8> Attrs;
1168 // Read all the records.
1170 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1172 switch (Entry.Kind) {
1173 case BitstreamEntry::SubBlock: // Handled for us already.
1174 case BitstreamEntry::Error:
1175 return error("Malformed block");
1176 case BitstreamEntry::EndBlock:
1177 return std::error_code();
1178 case BitstreamEntry::Record:
1179 // The interesting case.
1185 switch (Stream.readRecord(Entry.ID, Record)) {
1186 default: // Default behavior: ignore.
1188 case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
1189 // FIXME: Remove in 4.0.
1190 if (Record.size() & 1)
1191 return error("Invalid record");
1193 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1195 decodeLLVMAttributesForBitcode(B, Record[i+1]);
1196 Attrs.push_back(AttributeSet::get(Context, Record[i], B));
1199 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1203 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
1204 for (unsigned i = 0, e = Record.size(); i != e; ++i)
1205 Attrs.push_back(MAttributeGroups[Record[i]]);
1207 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1215 // Returns Attribute::None on unrecognized codes.
1216 static Attribute::AttrKind getAttrFromCode(uint64_t Code) {
1219 return Attribute::None;
1220 case bitc::ATTR_KIND_ALIGNMENT:
1221 return Attribute::Alignment;
1222 case bitc::ATTR_KIND_ALWAYS_INLINE:
1223 return Attribute::AlwaysInline;
1224 case bitc::ATTR_KIND_ARGMEMONLY:
1225 return Attribute::ArgMemOnly;
1226 case bitc::ATTR_KIND_BUILTIN:
1227 return Attribute::Builtin;
1228 case bitc::ATTR_KIND_BY_VAL:
1229 return Attribute::ByVal;
1230 case bitc::ATTR_KIND_IN_ALLOCA:
1231 return Attribute::InAlloca;
1232 case bitc::ATTR_KIND_COLD:
1233 return Attribute::Cold;
1234 case bitc::ATTR_KIND_CONVERGENT:
1235 return Attribute::Convergent;
1236 case bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY:
1237 return Attribute::InaccessibleMemOnly;
1238 case bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY:
1239 return Attribute::InaccessibleMemOrArgMemOnly;
1240 case bitc::ATTR_KIND_INLINE_HINT:
1241 return Attribute::InlineHint;
1242 case bitc::ATTR_KIND_IN_REG:
1243 return Attribute::InReg;
1244 case bitc::ATTR_KIND_JUMP_TABLE:
1245 return Attribute::JumpTable;
1246 case bitc::ATTR_KIND_MIN_SIZE:
1247 return Attribute::MinSize;
1248 case bitc::ATTR_KIND_NAKED:
1249 return Attribute::Naked;
1250 case bitc::ATTR_KIND_NEST:
1251 return Attribute::Nest;
1252 case bitc::ATTR_KIND_NO_ALIAS:
1253 return Attribute::NoAlias;
1254 case bitc::ATTR_KIND_NO_BUILTIN:
1255 return Attribute::NoBuiltin;
1256 case bitc::ATTR_KIND_NO_CAPTURE:
1257 return Attribute::NoCapture;
1258 case bitc::ATTR_KIND_NO_DUPLICATE:
1259 return Attribute::NoDuplicate;
1260 case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1261 return Attribute::NoImplicitFloat;
1262 case bitc::ATTR_KIND_NO_INLINE:
1263 return Attribute::NoInline;
1264 case bitc::ATTR_KIND_NO_RECURSE:
1265 return Attribute::NoRecurse;
1266 case bitc::ATTR_KIND_NON_LAZY_BIND:
1267 return Attribute::NonLazyBind;
1268 case bitc::ATTR_KIND_NON_NULL:
1269 return Attribute::NonNull;
1270 case bitc::ATTR_KIND_DEREFERENCEABLE:
1271 return Attribute::Dereferenceable;
1272 case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:
1273 return Attribute::DereferenceableOrNull;
1274 case bitc::ATTR_KIND_NO_RED_ZONE:
1275 return Attribute::NoRedZone;
1276 case bitc::ATTR_KIND_NO_RETURN:
1277 return Attribute::NoReturn;
1278 case bitc::ATTR_KIND_NO_UNWIND:
1279 return Attribute::NoUnwind;
1280 case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1281 return Attribute::OptimizeForSize;
1282 case bitc::ATTR_KIND_OPTIMIZE_NONE:
1283 return Attribute::OptimizeNone;
1284 case bitc::ATTR_KIND_READ_NONE:
1285 return Attribute::ReadNone;
1286 case bitc::ATTR_KIND_READ_ONLY:
1287 return Attribute::ReadOnly;
1288 case bitc::ATTR_KIND_RETURNED:
1289 return Attribute::Returned;
1290 case bitc::ATTR_KIND_RETURNS_TWICE:
1291 return Attribute::ReturnsTwice;
1292 case bitc::ATTR_KIND_S_EXT:
1293 return Attribute::SExt;
1294 case bitc::ATTR_KIND_STACK_ALIGNMENT:
1295 return Attribute::StackAlignment;
1296 case bitc::ATTR_KIND_STACK_PROTECT:
1297 return Attribute::StackProtect;
1298 case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1299 return Attribute::StackProtectReq;
1300 case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1301 return Attribute::StackProtectStrong;
1302 case bitc::ATTR_KIND_SAFESTACK:
1303 return Attribute::SafeStack;
1304 case bitc::ATTR_KIND_STRUCT_RET:
1305 return Attribute::StructRet;
1306 case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1307 return Attribute::SanitizeAddress;
1308 case bitc::ATTR_KIND_SANITIZE_THREAD:
1309 return Attribute::SanitizeThread;
1310 case bitc::ATTR_KIND_SANITIZE_MEMORY:
1311 return Attribute::SanitizeMemory;
1312 case bitc::ATTR_KIND_UW_TABLE:
1313 return Attribute::UWTable;
1314 case bitc::ATTR_KIND_Z_EXT:
1315 return Attribute::ZExt;
1319 std::error_code BitcodeReader::parseAlignmentValue(uint64_t Exponent,
1320 unsigned &Alignment) {
1321 // Note: Alignment in bitcode files is incremented by 1, so that zero
1322 // can be used for default alignment.
1323 if (Exponent > Value::MaxAlignmentExponent + 1)
1324 return error("Invalid alignment value");
1325 Alignment = (1 << static_cast<unsigned>(Exponent)) >> 1;
1326 return std::error_code();
1329 std::error_code BitcodeReader::parseAttrKind(uint64_t Code,
1330 Attribute::AttrKind *Kind) {
1331 *Kind = getAttrFromCode(Code);
1332 if (*Kind == Attribute::None)
1333 return error(BitcodeError::CorruptedBitcode,
1334 "Unknown attribute kind (" + Twine(Code) + ")");
1335 return std::error_code();
1338 std::error_code BitcodeReader::parseAttributeGroupBlock() {
1339 if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
1340 return error("Invalid record");
1342 if (!MAttributeGroups.empty())
1343 return error("Invalid multiple blocks");
1345 SmallVector<uint64_t, 64> Record;
1347 // Read all the records.
1349 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1351 switch (Entry.Kind) {
1352 case BitstreamEntry::SubBlock: // Handled for us already.
1353 case BitstreamEntry::Error:
1354 return error("Malformed block");
1355 case BitstreamEntry::EndBlock:
1356 return std::error_code();
1357 case BitstreamEntry::Record:
1358 // The interesting case.
1364 switch (Stream.readRecord(Entry.ID, Record)) {
1365 default: // Default behavior: ignore.
1367 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1368 if (Record.size() < 3)
1369 return error("Invalid record");
1371 uint64_t GrpID = Record[0];
1372 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1375 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1376 if (Record[i] == 0) { // Enum attribute
1377 Attribute::AttrKind Kind;
1378 if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1381 B.addAttribute(Kind);
1382 } else if (Record[i] == 1) { // Integer attribute
1383 Attribute::AttrKind Kind;
1384 if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1386 if (Kind == Attribute::Alignment)
1387 B.addAlignmentAttr(Record[++i]);
1388 else if (Kind == Attribute::StackAlignment)
1389 B.addStackAlignmentAttr(Record[++i]);
1390 else if (Kind == Attribute::Dereferenceable)
1391 B.addDereferenceableAttr(Record[++i]);
1392 else if (Kind == Attribute::DereferenceableOrNull)
1393 B.addDereferenceableOrNullAttr(Record[++i]);
1394 } else { // String attribute
1395 assert((Record[i] == 3 || Record[i] == 4) &&
1396 "Invalid attribute group entry");
1397 bool HasValue = (Record[i++] == 4);
1398 SmallString<64> KindStr;
1399 SmallString<64> ValStr;
1401 while (Record[i] != 0 && i != e)
1402 KindStr += Record[i++];
1403 assert(Record[i] == 0 && "Kind string not null terminated");
1406 // Has a value associated with it.
1407 ++i; // Skip the '0' that terminates the "kind" string.
1408 while (Record[i] != 0 && i != e)
1409 ValStr += Record[i++];
1410 assert(Record[i] == 0 && "Value string not null terminated");
1413 B.addAttribute(KindStr.str(), ValStr.str());
1417 MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
1424 std::error_code BitcodeReader::parseTypeTable() {
1425 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
1426 return error("Invalid record");
1428 return parseTypeTableBody();
1431 std::error_code BitcodeReader::parseTypeTableBody() {
1432 if (!TypeList.empty())
1433 return error("Invalid multiple blocks");
1435 SmallVector<uint64_t, 64> Record;
1436 unsigned NumRecords = 0;
1438 SmallString<64> TypeName;
1440 // Read all the records for this type table.
1442 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1444 switch (Entry.Kind) {
1445 case BitstreamEntry::SubBlock: // Handled for us already.
1446 case BitstreamEntry::Error:
1447 return error("Malformed block");
1448 case BitstreamEntry::EndBlock:
1449 if (NumRecords != TypeList.size())
1450 return error("Malformed block");
1451 return std::error_code();
1452 case BitstreamEntry::Record:
1453 // The interesting case.
1459 Type *ResultTy = nullptr;
1460 switch (Stream.readRecord(Entry.ID, Record)) {
1462 return error("Invalid value");
1463 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1464 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1465 // type list. This allows us to reserve space.
1466 if (Record.size() < 1)
1467 return error("Invalid record");
1468 TypeList.resize(Record[0]);
1470 case bitc::TYPE_CODE_VOID: // VOID
1471 ResultTy = Type::getVoidTy(Context);
1473 case bitc::TYPE_CODE_HALF: // HALF
1474 ResultTy = Type::getHalfTy(Context);
1476 case bitc::TYPE_CODE_FLOAT: // FLOAT
1477 ResultTy = Type::getFloatTy(Context);
1479 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
1480 ResultTy = Type::getDoubleTy(Context);
1482 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
1483 ResultTy = Type::getX86_FP80Ty(Context);
1485 case bitc::TYPE_CODE_FP128: // FP128
1486 ResultTy = Type::getFP128Ty(Context);
1488 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
1489 ResultTy = Type::getPPC_FP128Ty(Context);
1491 case bitc::TYPE_CODE_LABEL: // LABEL
1492 ResultTy = Type::getLabelTy(Context);
1494 case bitc::TYPE_CODE_METADATA: // METADATA
1495 ResultTy = Type::getMetadataTy(Context);
1497 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
1498 ResultTy = Type::getX86_MMXTy(Context);
1500 case bitc::TYPE_CODE_TOKEN: // TOKEN
1501 ResultTy = Type::getTokenTy(Context);
1503 case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
1504 if (Record.size() < 1)
1505 return error("Invalid record");
1507 uint64_t NumBits = Record[0];
1508 if (NumBits < IntegerType::MIN_INT_BITS ||
1509 NumBits > IntegerType::MAX_INT_BITS)
1510 return error("Bitwidth for integer type out of range");
1511 ResultTy = IntegerType::get(Context, NumBits);
1514 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
1515 // [pointee type, address space]
1516 if (Record.size() < 1)
1517 return error("Invalid record");
1518 unsigned AddressSpace = 0;
1519 if (Record.size() == 2)
1520 AddressSpace = Record[1];
1521 ResultTy = getTypeByID(Record[0]);
1523 !PointerType::isValidElementType(ResultTy))
1524 return error("Invalid type");
1525 ResultTy = PointerType::get(ResultTy, AddressSpace);
1528 case bitc::TYPE_CODE_FUNCTION_OLD: {
1529 // FIXME: attrid is dead, remove it in LLVM 4.0
1530 // FUNCTION: [vararg, attrid, retty, paramty x N]
1531 if (Record.size() < 3)
1532 return error("Invalid record");
1533 SmallVector<Type*, 8> ArgTys;
1534 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1535 if (Type *T = getTypeByID(Record[i]))
1536 ArgTys.push_back(T);
1541 ResultTy = getTypeByID(Record[2]);
1542 if (!ResultTy || ArgTys.size() < Record.size()-3)
1543 return error("Invalid type");
1545 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1548 case bitc::TYPE_CODE_FUNCTION: {
1549 // FUNCTION: [vararg, retty, paramty x N]
1550 if (Record.size() < 2)
1551 return error("Invalid record");
1552 SmallVector<Type*, 8> ArgTys;
1553 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1554 if (Type *T = getTypeByID(Record[i])) {
1555 if (!FunctionType::isValidArgumentType(T))
1556 return error("Invalid function argument type");
1557 ArgTys.push_back(T);
1563 ResultTy = getTypeByID(Record[1]);
1564 if (!ResultTy || ArgTys.size() < Record.size()-2)
1565 return error("Invalid type");
1567 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1570 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
1571 if (Record.size() < 1)
1572 return error("Invalid record");
1573 SmallVector<Type*, 8> EltTys;
1574 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1575 if (Type *T = getTypeByID(Record[i]))
1576 EltTys.push_back(T);
1580 if (EltTys.size() != Record.size()-1)
1581 return error("Invalid type");
1582 ResultTy = StructType::get(Context, EltTys, Record[0]);
1585 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
1586 if (convertToString(Record, 0, TypeName))
1587 return error("Invalid record");
1590 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1591 if (Record.size() < 1)
1592 return error("Invalid record");
1594 if (NumRecords >= TypeList.size())
1595 return error("Invalid TYPE table");
1597 // Check to see if this was forward referenced, if so fill in the temp.
1598 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1600 Res->setName(TypeName);
1601 TypeList[NumRecords] = nullptr;
1602 } else // Otherwise, create a new struct.
1603 Res = createIdentifiedStructType(Context, TypeName);
1606 SmallVector<Type*, 8> EltTys;
1607 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1608 if (Type *T = getTypeByID(Record[i]))
1609 EltTys.push_back(T);
1613 if (EltTys.size() != Record.size()-1)
1614 return error("Invalid record");
1615 Res->setBody(EltTys, Record[0]);
1619 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
1620 if (Record.size() != 1)
1621 return error("Invalid record");
1623 if (NumRecords >= TypeList.size())
1624 return error("Invalid TYPE table");
1626 // Check to see if this was forward referenced, if so fill in the temp.
1627 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1629 Res->setName(TypeName);
1630 TypeList[NumRecords] = nullptr;
1631 } else // Otherwise, create a new struct with no body.
1632 Res = createIdentifiedStructType(Context, TypeName);
1637 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
1638 if (Record.size() < 2)
1639 return error("Invalid record");
1640 ResultTy = getTypeByID(Record[1]);
1641 if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
1642 return error("Invalid type");
1643 ResultTy = ArrayType::get(ResultTy, Record[0]);
1645 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
1646 if (Record.size() < 2)
1647 return error("Invalid record");
1649 return error("Invalid vector length");
1650 ResultTy = getTypeByID(Record[1]);
1651 if (!ResultTy || !StructType::isValidElementType(ResultTy))
1652 return error("Invalid type");
1653 ResultTy = VectorType::get(ResultTy, Record[0]);
1657 if (NumRecords >= TypeList.size())
1658 return error("Invalid TYPE table");
1659 if (TypeList[NumRecords])
1661 "Invalid TYPE table: Only named structs can be forward referenced");
1662 assert(ResultTy && "Didn't read a type?");
1663 TypeList[NumRecords++] = ResultTy;
1667 std::error_code BitcodeReader::parseOperandBundleTags() {
1668 if (Stream.EnterSubBlock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID))
1669 return error("Invalid record");
1671 if (!BundleTags.empty())
1672 return error("Invalid multiple blocks");
1674 SmallVector<uint64_t, 64> Record;
1677 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1679 switch (Entry.Kind) {
1680 case BitstreamEntry::SubBlock: // Handled for us already.
1681 case BitstreamEntry::Error:
1682 return error("Malformed block");
1683 case BitstreamEntry::EndBlock:
1684 return std::error_code();
1685 case BitstreamEntry::Record:
1686 // The interesting case.
1690 // Tags are implicitly mapped to integers by their order.
1692 if (Stream.readRecord(Entry.ID, Record) != bitc::OPERAND_BUNDLE_TAG)
1693 return error("Invalid record");
1695 // OPERAND_BUNDLE_TAG: [strchr x N]
1696 BundleTags.emplace_back();
1697 if (convertToString(Record, 0, BundleTags.back()))
1698 return error("Invalid record");
1703 /// Associate a value with its name from the given index in the provided record.
1704 ErrorOr<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,
1705 unsigned NameIndex, Triple &TT) {
1706 SmallString<128> ValueName;
1707 if (convertToString(Record, NameIndex, ValueName))
1708 return error("Invalid record");
1709 unsigned ValueID = Record[0];
1710 if (ValueID >= ValueList.size() || !ValueList[ValueID])
1711 return error("Invalid record");
1712 Value *V = ValueList[ValueID];
1714 StringRef NameStr(ValueName.data(), ValueName.size());
1715 if (NameStr.find_first_of(0) != StringRef::npos)
1716 return error("Invalid value name");
1717 V->setName(NameStr);
1718 auto *GO = dyn_cast<GlobalObject>(V);
1720 if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1721 if (TT.isOSBinFormatMachO())
1722 GO->setComdat(nullptr);
1724 GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1730 /// Parse the value symbol table at either the current parsing location or
1731 /// at the given bit offset if provided.
1732 std::error_code BitcodeReader::parseValueSymbolTable(uint64_t Offset) {
1733 uint64_t CurrentBit;
1734 // Pass in the Offset to distinguish between calling for the module-level
1735 // VST (where we want to jump to the VST offset) and the function-level
1736 // VST (where we don't).
1738 // Save the current parsing location so we can jump back at the end
1740 CurrentBit = Stream.GetCurrentBitNo();
1741 Stream.JumpToBit(Offset * 32);
1743 // Do some checking if we are in debug mode.
1744 BitstreamEntry Entry = Stream.advance();
1745 assert(Entry.Kind == BitstreamEntry::SubBlock);
1746 assert(Entry.ID == bitc::VALUE_SYMTAB_BLOCK_ID);
1748 // In NDEBUG mode ignore the output so we don't get an unused variable
1754 // Compute the delta between the bitcode indices in the VST (the word offset
1755 // to the word-aligned ENTER_SUBBLOCK for the function block, and that
1756 // expected by the lazy reader. The reader's EnterSubBlock expects to have
1757 // already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID
1758 // (size BlockIDWidth). Note that we access the stream's AbbrevID width here
1759 // just before entering the VST subblock because: 1) the EnterSubBlock
1760 // changes the AbbrevID width; 2) the VST block is nested within the same
1761 // outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same
1762 // AbbrevID width before calling EnterSubBlock; and 3) when we want to
1763 // jump to the FUNCTION_BLOCK using this offset later, we don't want
1764 // to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.
1765 unsigned FuncBitcodeOffsetDelta =
1766 Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
1768 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1769 return error("Invalid record");
1771 SmallVector<uint64_t, 64> Record;
1773 Triple TT(TheModule->getTargetTriple());
1775 // Read all the records for this value table.
1776 SmallString<128> ValueName;
1778 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1780 switch (Entry.Kind) {
1781 case BitstreamEntry::SubBlock: // Handled for us already.
1782 case BitstreamEntry::Error:
1783 return error("Malformed block");
1784 case BitstreamEntry::EndBlock:
1786 Stream.JumpToBit(CurrentBit);
1787 return std::error_code();
1788 case BitstreamEntry::Record:
1789 // The interesting case.
1795 switch (Stream.readRecord(Entry.ID, Record)) {
1796 default: // Default behavior: unknown type.
1798 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
1799 ErrorOr<Value *> ValOrErr = recordValue(Record, 1, TT);
1800 if (std::error_code EC = ValOrErr.getError())
1805 case bitc::VST_CODE_FNENTRY: {
1806 // VST_FNENTRY: [valueid, offset, namechar x N]
1807 ErrorOr<Value *> ValOrErr = recordValue(Record, 2, TT);
1808 if (std::error_code EC = ValOrErr.getError())
1810 Value *V = ValOrErr.get();
1812 auto *GO = dyn_cast<GlobalObject>(V);
1814 // If this is an alias, need to get the actual Function object
1815 // it aliases, in order to set up the DeferredFunctionInfo entry below.
1816 auto *GA = dyn_cast<GlobalAlias>(V);
1818 GO = GA->getBaseObject();
1822 uint64_t FuncWordOffset = Record[1];
1823 Function *F = dyn_cast<Function>(GO);
1825 uint64_t FuncBitOffset = FuncWordOffset * 32;
1826 DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;
1827 // Set the LastFunctionBlockBit to point to the last function block.
1828 // Later when parsing is resumed after function materialization,
1829 // we can simply skip that last function block.
1830 if (FuncBitOffset > LastFunctionBlockBit)
1831 LastFunctionBlockBit = FuncBitOffset;
1834 case bitc::VST_CODE_BBENTRY: {
1835 if (convertToString(Record, 1, ValueName))
1836 return error("Invalid record");
1837 BasicBlock *BB = getBasicBlock(Record[0]);
1839 return error("Invalid record");
1841 BB->setName(StringRef(ValueName.data(), ValueName.size()));
1849 /// Parse a single METADATA_KIND record, inserting result in MDKindMap.
1851 BitcodeReader::parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record) {
1852 if (Record.size() < 2)
1853 return error("Invalid record");
1855 unsigned Kind = Record[0];
1856 SmallString<8> Name(Record.begin() + 1, Record.end());
1858 unsigned NewKind = TheModule->getMDKindID(Name.str());
1859 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1860 return error("Conflicting METADATA_KIND records");
1861 return std::error_code();
1864 static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
1866 /// Parse a METADATA_BLOCK. If ModuleLevel is true then we are parsing
1867 /// module level metadata.
1868 std::error_code BitcodeReader::parseMetadata(bool ModuleLevel) {
1869 IsMetadataMaterialized = true;
1870 unsigned NextMetadataNo = MetadataList.size();
1871 if (ModuleLevel && SeenModuleValuesRecord) {
1872 // Now that we are parsing the module level metadata, we want to restart
1873 // the numbering of the MD values, and replace temp MD created earlier
1874 // with their real values. If we saw a METADATA_VALUE record then we
1875 // would have set the MetadataList size to the number specified in that
1876 // record, to support parsing function-level metadata first, and we need
1877 // to reset back to 0 to fill the MetadataList in with the parsed module
1878 // The function-level metadata parsing should have reset the MetadataList
1879 // size back to the value reported by the METADATA_VALUE record, saved in
1881 assert(NumModuleMDs == MetadataList.size() &&
1882 "Expected MetadataList to only contain module level values");
1886 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1887 return error("Invalid record");
1889 SmallVector<uint64_t, 64> Record;
1891 auto getMD = [&](unsigned ID) -> Metadata * {
1892 return MetadataList.getValueFwdRef(ID);
1894 auto getMDOrNull = [&](unsigned ID) -> Metadata *{
1896 return getMD(ID - 1);
1899 auto getMDString = [&](unsigned ID) -> MDString *{
1900 // This requires that the ID is not really a forward reference. In
1901 // particular, the MDString must already have been resolved.
1902 return cast_or_null<MDString>(getMDOrNull(ID));
1905 #define GET_OR_DISTINCT(CLASS, DISTINCT, ARGS) \
1906 (DISTINCT ? CLASS::getDistinct ARGS : CLASS::get ARGS)
1908 // Read all the records.
1910 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1912 switch (Entry.Kind) {
1913 case BitstreamEntry::SubBlock: // Handled for us already.
1914 case BitstreamEntry::Error:
1915 return error("Malformed block");
1916 case BitstreamEntry::EndBlock:
1917 MetadataList.tryToResolveCycles();
1918 assert((!(ModuleLevel && SeenModuleValuesRecord) ||
1919 NumModuleMDs == MetadataList.size()) &&
1920 "Inconsistent bitcode: METADATA_VALUES mismatch");
1921 return std::error_code();
1922 case BitstreamEntry::Record:
1923 // The interesting case.
1929 unsigned Code = Stream.readRecord(Entry.ID, Record);
1930 bool IsDistinct = false;
1932 default: // Default behavior: ignore.
1934 case bitc::METADATA_NAME: {
1935 // Read name of the named metadata.
1936 SmallString<8> Name(Record.begin(), Record.end());
1938 Code = Stream.ReadCode();
1940 unsigned NextBitCode = Stream.readRecord(Code, Record);
1941 if (NextBitCode != bitc::METADATA_NAMED_NODE)
1942 return error("METADATA_NAME not followed by METADATA_NAMED_NODE");
1944 // Read named metadata elements.
1945 unsigned Size = Record.size();
1946 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1947 for (unsigned i = 0; i != Size; ++i) {
1949 dyn_cast_or_null<MDNode>(MetadataList.getValueFwdRef(Record[i]));
1951 return error("Invalid record");
1952 NMD->addOperand(MD);
1956 case bitc::METADATA_OLD_FN_NODE: {
1957 // FIXME: Remove in 4.0.
1958 // This is a LocalAsMetadata record, the only type of function-local
1960 if (Record.size() % 2 == 1)
1961 return error("Invalid record");
1963 // If this isn't a LocalAsMetadata record, we're dropping it. This used
1964 // to be legal, but there's no upgrade path.
1965 auto dropRecord = [&] {
1966 MetadataList.assignValue(MDNode::get(Context, None), NextMetadataNo++);
1968 if (Record.size() != 2) {
1973 Type *Ty = getTypeByID(Record[0]);
1974 if (Ty->isMetadataTy() || Ty->isVoidTy()) {
1979 MetadataList.assignValue(
1980 LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1984 case bitc::METADATA_OLD_NODE: {
1985 // FIXME: Remove in 4.0.
1986 if (Record.size() % 2 == 1)
1987 return error("Invalid record");
1989 unsigned Size = Record.size();
1990 SmallVector<Metadata *, 8> Elts;
1991 for (unsigned i = 0; i != Size; i += 2) {
1992 Type *Ty = getTypeByID(Record[i]);
1994 return error("Invalid record");
1995 if (Ty->isMetadataTy())
1996 Elts.push_back(MetadataList.getValueFwdRef(Record[i + 1]));
1997 else if (!Ty->isVoidTy()) {
1999 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
2000 assert(isa<ConstantAsMetadata>(MD) &&
2001 "Expected non-function-local metadata");
2004 Elts.push_back(nullptr);
2006 MetadataList.assignValue(MDNode::get(Context, Elts), NextMetadataNo++);
2009 case bitc::METADATA_VALUE: {
2010 if (Record.size() != 2)
2011 return error("Invalid record");
2013 Type *Ty = getTypeByID(Record[0]);
2014 if (Ty->isMetadataTy() || Ty->isVoidTy())
2015 return error("Invalid record");
2017 MetadataList.assignValue(
2018 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
2022 case bitc::METADATA_DISTINCT_NODE:
2025 case bitc::METADATA_NODE: {
2026 SmallVector<Metadata *, 8> Elts;
2027 Elts.reserve(Record.size());
2028 for (unsigned ID : Record)
2029 Elts.push_back(ID ? MetadataList.getValueFwdRef(ID - 1) : nullptr);
2030 MetadataList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
2031 : MDNode::get(Context, Elts),
2035 case bitc::METADATA_LOCATION: {
2036 if (Record.size() != 5)
2037 return error("Invalid record");
2039 unsigned Line = Record[1];
2040 unsigned Column = Record[2];
2041 MDNode *Scope = cast<MDNode>(MetadataList.getValueFwdRef(Record[3]));
2042 Metadata *InlinedAt =
2043 Record[4] ? MetadataList.getValueFwdRef(Record[4] - 1) : nullptr;
2044 MetadataList.assignValue(
2045 GET_OR_DISTINCT(DILocation, Record[0],
2046 (Context, Line, Column, Scope, InlinedAt)),
2050 case bitc::METADATA_GENERIC_DEBUG: {
2051 if (Record.size() < 4)
2052 return error("Invalid record");
2054 unsigned Tag = Record[1];
2055 unsigned Version = Record[2];
2057 if (Tag >= 1u << 16 || Version != 0)
2058 return error("Invalid record");
2060 auto *Header = getMDString(Record[3]);
2061 SmallVector<Metadata *, 8> DwarfOps;
2062 for (unsigned I = 4, E = Record.size(); I != E; ++I)
2064 Record[I] ? MetadataList.getValueFwdRef(Record[I] - 1) : nullptr);
2065 MetadataList.assignValue(
2066 GET_OR_DISTINCT(GenericDINode, Record[0],
2067 (Context, Tag, Header, DwarfOps)),
2071 case bitc::METADATA_SUBRANGE: {
2072 if (Record.size() != 3)
2073 return error("Invalid record");
2075 MetadataList.assignValue(
2076 GET_OR_DISTINCT(DISubrange, Record[0],
2077 (Context, Record[1], unrotateSign(Record[2]))),
2081 case bitc::METADATA_ENUMERATOR: {
2082 if (Record.size() != 3)
2083 return error("Invalid record");
2085 MetadataList.assignValue(
2087 DIEnumerator, Record[0],
2088 (Context, unrotateSign(Record[1]), getMDString(Record[2]))),
2092 case bitc::METADATA_BASIC_TYPE: {
2093 if (Record.size() != 6)
2094 return error("Invalid record");
2096 MetadataList.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 MetadataList.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 MetadataList.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 MetadataList.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 MetadataList.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 MetadataList.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() > 16)
2169 return error("Invalid record");
2171 // Ignore Record[0], which indicates whether this compile unit is
2172 // distinct. It's always distinct.
2173 MetadataList.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]),
2181 Record.size() <= 15 ? 0 : getMDOrNull(Record[15]),
2182 Record.size() <= 14 ? 0 : Record[14]),
2186 case bitc::METADATA_SUBPROGRAM: {
2187 if (Record.size() != 18 && Record.size() != 19)
2188 return error("Invalid record");
2190 bool HasFn = Record.size() == 19;
2191 DISubprogram *SP = GET_OR_DISTINCT(
2193 Record[0] || Record[8], // All definitions should be distinct.
2194 (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
2195 getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
2196 getMDOrNull(Record[6]), Record[7], Record[8], Record[9],
2197 getMDOrNull(Record[10]), Record[11], Record[12], Record[13],
2198 Record[14], getMDOrNull(Record[15 + HasFn]),
2199 getMDOrNull(Record[16 + HasFn]), getMDOrNull(Record[17 + HasFn])));
2200 MetadataList.assignValue(SP, NextMetadataNo++);
2202 // Upgrade sp->function mapping to function->sp mapping.
2203 if (HasFn && Record[15]) {
2204 if (auto *CMD = dyn_cast<ConstantAsMetadata>(getMDOrNull(Record[15])))
2205 if (auto *F = dyn_cast<Function>(CMD->getValue())) {
2206 if (F->isMaterializable())
2207 // Defer until materialized; unmaterialized functions may not have
2209 FunctionsWithSPs[F] = SP;
2210 else if (!F->empty())
2211 F->setSubprogram(SP);
2216 case bitc::METADATA_LEXICAL_BLOCK: {
2217 if (Record.size() != 5)
2218 return error("Invalid record");
2220 MetadataList.assignValue(
2221 GET_OR_DISTINCT(DILexicalBlock, Record[0],
2222 (Context, getMDOrNull(Record[1]),
2223 getMDOrNull(Record[2]), Record[3], Record[4])),
2227 case bitc::METADATA_LEXICAL_BLOCK_FILE: {
2228 if (Record.size() != 4)
2229 return error("Invalid record");
2231 MetadataList.assignValue(
2232 GET_OR_DISTINCT(DILexicalBlockFile, Record[0],
2233 (Context, getMDOrNull(Record[1]),
2234 getMDOrNull(Record[2]), Record[3])),
2238 case bitc::METADATA_NAMESPACE: {
2239 if (Record.size() != 5)
2240 return error("Invalid record");
2242 MetadataList.assignValue(
2243 GET_OR_DISTINCT(DINamespace, Record[0],
2244 (Context, getMDOrNull(Record[1]),
2245 getMDOrNull(Record[2]), getMDString(Record[3]),
2250 case bitc::METADATA_MACRO: {
2251 if (Record.size() != 5)
2252 return error("Invalid record");
2254 MetadataList.assignValue(
2255 GET_OR_DISTINCT(DIMacro, Record[0],
2256 (Context, Record[1], Record[2],
2257 getMDString(Record[3]), getMDString(Record[4]))),
2261 case bitc::METADATA_MACRO_FILE: {
2262 if (Record.size() != 5)
2263 return error("Invalid record");
2265 MetadataList.assignValue(
2266 GET_OR_DISTINCT(DIMacroFile, Record[0],
2267 (Context, Record[1], Record[2],
2268 getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
2272 case bitc::METADATA_TEMPLATE_TYPE: {
2273 if (Record.size() != 3)
2274 return error("Invalid record");
2276 MetadataList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter,
2278 (Context, getMDString(Record[1]),
2279 getMDOrNull(Record[2]))),
2283 case bitc::METADATA_TEMPLATE_VALUE: {
2284 if (Record.size() != 5)
2285 return error("Invalid record");
2287 MetadataList.assignValue(
2288 GET_OR_DISTINCT(DITemplateValueParameter, Record[0],
2289 (Context, Record[1], getMDString(Record[2]),
2290 getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
2294 case bitc::METADATA_GLOBAL_VAR: {
2295 if (Record.size() != 11)
2296 return error("Invalid record");
2298 MetadataList.assignValue(
2299 GET_OR_DISTINCT(DIGlobalVariable, Record[0],
2300 (Context, getMDOrNull(Record[1]),
2301 getMDString(Record[2]), getMDString(Record[3]),
2302 getMDOrNull(Record[4]), Record[5],
2303 getMDOrNull(Record[6]), Record[7], Record[8],
2304 getMDOrNull(Record[9]), getMDOrNull(Record[10]))),
2308 case bitc::METADATA_LOCAL_VAR: {
2309 // 10th field is for the obseleted 'inlinedAt:' field.
2310 if (Record.size() < 8 || Record.size() > 10)
2311 return error("Invalid record");
2313 // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or
2314 // DW_TAG_arg_variable.
2315 bool HasTag = Record.size() > 8;
2316 MetadataList.assignValue(
2317 GET_OR_DISTINCT(DILocalVariable, Record[0],
2318 (Context, getMDOrNull(Record[1 + HasTag]),
2319 getMDString(Record[2 + HasTag]),
2320 getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag],
2321 getMDOrNull(Record[5 + HasTag]), Record[6 + HasTag],
2322 Record[7 + HasTag])),
2326 case bitc::METADATA_EXPRESSION: {
2327 if (Record.size() < 1)
2328 return error("Invalid record");
2330 MetadataList.assignValue(
2331 GET_OR_DISTINCT(DIExpression, Record[0],
2332 (Context, makeArrayRef(Record).slice(1))),
2336 case bitc::METADATA_OBJC_PROPERTY: {
2337 if (Record.size() != 8)
2338 return error("Invalid record");
2340 MetadataList.assignValue(
2341 GET_OR_DISTINCT(DIObjCProperty, Record[0],
2342 (Context, getMDString(Record[1]),
2343 getMDOrNull(Record[2]), Record[3],
2344 getMDString(Record[4]), getMDString(Record[5]),
2345 Record[6], getMDOrNull(Record[7]))),
2349 case bitc::METADATA_IMPORTED_ENTITY: {
2350 if (Record.size() != 6)
2351 return error("Invalid record");
2353 MetadataList.assignValue(
2354 GET_OR_DISTINCT(DIImportedEntity, Record[0],
2355 (Context, Record[1], getMDOrNull(Record[2]),
2356 getMDOrNull(Record[3]), Record[4],
2357 getMDString(Record[5]))),
2361 case bitc::METADATA_STRING: {
2362 std::string String(Record.begin(), Record.end());
2363 llvm::UpgradeMDStringConstant(String);
2364 Metadata *MD = MDString::get(Context, String);
2365 MetadataList.assignValue(MD, NextMetadataNo++);
2368 case bitc::METADATA_KIND: {
2369 // Support older bitcode files that had METADATA_KIND records in a
2370 // block with METADATA_BLOCK_ID.
2371 if (std::error_code EC = parseMetadataKindRecord(Record))
2377 #undef GET_OR_DISTINCT
2380 /// Parse the metadata kinds out of the METADATA_KIND_BLOCK.
2381 std::error_code BitcodeReader::parseMetadataKinds() {
2382 if (Stream.EnterSubBlock(bitc::METADATA_KIND_BLOCK_ID))
2383 return error("Invalid record");
2385 SmallVector<uint64_t, 64> Record;
2387 // Read all the records.
2389 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2391 switch (Entry.Kind) {
2392 case BitstreamEntry::SubBlock: // Handled for us already.
2393 case BitstreamEntry::Error:
2394 return error("Malformed block");
2395 case BitstreamEntry::EndBlock:
2396 return std::error_code();
2397 case BitstreamEntry::Record:
2398 // The interesting case.
2404 unsigned Code = Stream.readRecord(Entry.ID, Record);
2406 default: // Default behavior: ignore.
2408 case bitc::METADATA_KIND: {
2409 if (std::error_code EC = parseMetadataKindRecord(Record))
2417 /// Decode a signed value stored with the sign bit in the LSB for dense VBR
2419 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
2424 // There is no such thing as -0 with integers. "-0" really means MININT.
2428 /// Resolve all of the initializers for global values and aliases that we can.
2429 std::error_code BitcodeReader::resolveGlobalAndAliasInits() {
2430 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
2431 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
2432 std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
2433 std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
2434 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFnWorklist;
2436 GlobalInitWorklist.swap(GlobalInits);
2437 AliasInitWorklist.swap(AliasInits);
2438 FunctionPrefixWorklist.swap(FunctionPrefixes);
2439 FunctionPrologueWorklist.swap(FunctionPrologues);
2440 FunctionPersonalityFnWorklist.swap(FunctionPersonalityFns);
2442 while (!GlobalInitWorklist.empty()) {
2443 unsigned ValID = GlobalInitWorklist.back().second;
2444 if (ValID >= ValueList.size()) {
2445 // Not ready to resolve this yet, it requires something later in the file.
2446 GlobalInits.push_back(GlobalInitWorklist.back());
2448 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2449 GlobalInitWorklist.back().first->setInitializer(C);
2451 return error("Expected a constant");
2453 GlobalInitWorklist.pop_back();
2456 while (!AliasInitWorklist.empty()) {
2457 unsigned ValID = AliasInitWorklist.back().second;
2458 if (ValID >= ValueList.size()) {
2459 AliasInits.push_back(AliasInitWorklist.back());
2461 Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]);
2463 return error("Expected a constant");
2464 GlobalAlias *Alias = AliasInitWorklist.back().first;
2465 if (C->getType() != Alias->getType())
2466 return error("Alias and aliasee types don't match");
2467 Alias->setAliasee(C);
2469 AliasInitWorklist.pop_back();
2472 while (!FunctionPrefixWorklist.empty()) {
2473 unsigned ValID = FunctionPrefixWorklist.back().second;
2474 if (ValID >= ValueList.size()) {
2475 FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2477 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2478 FunctionPrefixWorklist.back().first->setPrefixData(C);
2480 return error("Expected a constant");
2482 FunctionPrefixWorklist.pop_back();
2485 while (!FunctionPrologueWorklist.empty()) {
2486 unsigned ValID = FunctionPrologueWorklist.back().second;
2487 if (ValID >= ValueList.size()) {
2488 FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2490 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2491 FunctionPrologueWorklist.back().first->setPrologueData(C);
2493 return error("Expected a constant");
2495 FunctionPrologueWorklist.pop_back();
2498 while (!FunctionPersonalityFnWorklist.empty()) {
2499 unsigned ValID = FunctionPersonalityFnWorklist.back().second;
2500 if (ValID >= ValueList.size()) {
2501 FunctionPersonalityFns.push_back(FunctionPersonalityFnWorklist.back());
2503 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2504 FunctionPersonalityFnWorklist.back().first->setPersonalityFn(C);
2506 return error("Expected a constant");
2508 FunctionPersonalityFnWorklist.pop_back();
2511 return std::error_code();
2514 static APInt readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
2515 SmallVector<uint64_t, 8> Words(Vals.size());
2516 std::transform(Vals.begin(), Vals.end(), Words.begin(),
2517 BitcodeReader::decodeSignRotatedValue);
2519 return APInt(TypeBits, Words);
2522 std::error_code BitcodeReader::parseConstants() {
2523 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
2524 return error("Invalid record");
2526 SmallVector<uint64_t, 64> Record;
2528 // Read all the records for this value table.
2529 Type *CurTy = Type::getInt32Ty(Context);
2530 unsigned NextCstNo = ValueList.size();
2532 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2534 switch (Entry.Kind) {
2535 case BitstreamEntry::SubBlock: // Handled for us already.
2536 case BitstreamEntry::Error:
2537 return error("Malformed block");
2538 case BitstreamEntry::EndBlock:
2539 if (NextCstNo != ValueList.size())
2540 return error("Invalid ronstant reference");
2542 // Once all the constants have been read, go through and resolve forward
2544 ValueList.resolveConstantForwardRefs();
2545 return std::error_code();
2546 case BitstreamEntry::Record:
2547 // The interesting case.
2554 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2556 default: // Default behavior: unknown constant
2557 case bitc::CST_CODE_UNDEF: // UNDEF
2558 V = UndefValue::get(CurTy);
2560 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
2562 return error("Invalid record");
2563 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
2564 return error("Invalid record");
2565 CurTy = TypeList[Record[0]];
2566 continue; // Skip the ValueList manipulation.
2567 case bitc::CST_CODE_NULL: // NULL
2568 V = Constant::getNullValue(CurTy);
2570 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
2571 if (!CurTy->isIntegerTy() || Record.empty())
2572 return error("Invalid record");
2573 V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
2575 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
2576 if (!CurTy->isIntegerTy() || Record.empty())
2577 return error("Invalid record");
2580 readWideAPInt(Record, cast<IntegerType>(CurTy)->getBitWidth());
2581 V = ConstantInt::get(Context, VInt);
2585 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
2587 return error("Invalid record");
2588 if (CurTy->isHalfTy())
2589 V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
2590 APInt(16, (uint16_t)Record[0])));
2591 else if (CurTy->isFloatTy())
2592 V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
2593 APInt(32, (uint32_t)Record[0])));
2594 else if (CurTy->isDoubleTy())
2595 V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
2596 APInt(64, Record[0])));
2597 else if (CurTy->isX86_FP80Ty()) {
2598 // Bits are not stored the same way as a normal i80 APInt, compensate.
2599 uint64_t Rearrange[2];
2600 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2601 Rearrange[1] = Record[0] >> 48;
2602 V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
2603 APInt(80, Rearrange)));
2604 } else if (CurTy->isFP128Ty())
2605 V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
2606 APInt(128, Record)));
2607 else if (CurTy->isPPC_FP128Ty())
2608 V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
2609 APInt(128, Record)));
2611 V = UndefValue::get(CurTy);
2615 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2617 return error("Invalid record");
2619 unsigned Size = Record.size();
2620 SmallVector<Constant*, 16> Elts;
2622 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2623 for (unsigned i = 0; i != Size; ++i)
2624 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
2625 STy->getElementType(i)));
2626 V = ConstantStruct::get(STy, Elts);
2627 } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2628 Type *EltTy = ATy->getElementType();
2629 for (unsigned i = 0; i != Size; ++i)
2630 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2631 V = ConstantArray::get(ATy, Elts);
2632 } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2633 Type *EltTy = VTy->getElementType();
2634 for (unsigned i = 0; i != Size; ++i)
2635 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2636 V = ConstantVector::get(Elts);
2638 V = UndefValue::get(CurTy);
2642 case bitc::CST_CODE_STRING: // STRING: [values]
2643 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2645 return error("Invalid record");
2647 SmallString<16> Elts(Record.begin(), Record.end());
2648 V = ConstantDataArray::getString(Context, Elts,
2649 BitCode == bitc::CST_CODE_CSTRING);
2652 case bitc::CST_CODE_DATA: {// DATA: [n x value]
2654 return error("Invalid record");
2656 Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
2657 unsigned Size = Record.size();
2659 if (EltTy->isIntegerTy(8)) {
2660 SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2661 if (isa<VectorType>(CurTy))
2662 V = ConstantDataVector::get(Context, Elts);
2664 V = ConstantDataArray::get(Context, Elts);
2665 } else if (EltTy->isIntegerTy(16)) {
2666 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2667 if (isa<VectorType>(CurTy))
2668 V = ConstantDataVector::get(Context, Elts);
2670 V = ConstantDataArray::get(Context, Elts);
2671 } else if (EltTy->isIntegerTy(32)) {
2672 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2673 if (isa<VectorType>(CurTy))
2674 V = ConstantDataVector::get(Context, Elts);
2676 V = ConstantDataArray::get(Context, Elts);
2677 } else if (EltTy->isIntegerTy(64)) {
2678 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2679 if (isa<VectorType>(CurTy))
2680 V = ConstantDataVector::get(Context, Elts);
2682 V = ConstantDataArray::get(Context, Elts);
2683 } else if (EltTy->isFloatTy()) {
2684 SmallVector<float, 16> Elts(Size);
2685 std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
2686 if (isa<VectorType>(CurTy))
2687 V = ConstantDataVector::get(Context, Elts);
2689 V = ConstantDataArray::get(Context, Elts);
2690 } else if (EltTy->isDoubleTy()) {
2691 SmallVector<double, 16> Elts(Size);
2692 std::transform(Record.begin(), Record.end(), Elts.begin(),
2694 if (isa<VectorType>(CurTy))
2695 V = ConstantDataVector::get(Context, Elts);
2697 V = ConstantDataArray::get(Context, Elts);
2699 return error("Invalid type for value");
2704 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
2705 if (Record.size() < 3)
2706 return error("Invalid record");
2707 int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
2709 V = UndefValue::get(CurTy); // Unknown binop.
2711 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2712 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
2714 if (Record.size() >= 4) {
2715 if (Opc == Instruction::Add ||
2716 Opc == Instruction::Sub ||
2717 Opc == Instruction::Mul ||
2718 Opc == Instruction::Shl) {
2719 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2720 Flags |= OverflowingBinaryOperator::NoSignedWrap;
2721 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2722 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2723 } else if (Opc == Instruction::SDiv ||
2724 Opc == Instruction::UDiv ||
2725 Opc == Instruction::LShr ||
2726 Opc == Instruction::AShr) {
2727 if (Record[3] & (1 << bitc::PEO_EXACT))
2728 Flags |= SDivOperator::IsExact;
2731 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
2735 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
2736 if (Record.size() < 3)
2737 return error("Invalid record");
2738 int Opc = getDecodedCastOpcode(Record[0]);
2740 V = UndefValue::get(CurTy); // Unknown cast.
2742 Type *OpTy = getTypeByID(Record[1]);
2744 return error("Invalid record");
2745 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
2746 V = UpgradeBitCastExpr(Opc, Op, CurTy);
2747 if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
2751 case bitc::CST_CODE_CE_INBOUNDS_GEP:
2752 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
2754 Type *PointeeType = nullptr;
2755 if (Record.size() % 2)
2756 PointeeType = getTypeByID(Record[OpNum++]);
2757 SmallVector<Constant*, 16> Elts;
2758 while (OpNum != Record.size()) {
2759 Type *ElTy = getTypeByID(Record[OpNum++]);
2761 return error("Invalid record");
2762 Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
2767 cast<SequentialType>(Elts[0]->getType()->getScalarType())
2769 return error("Explicit gep operator type does not match pointee type "
2770 "of pointer operand");
2772 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2773 V = ConstantExpr::getGetElementPtr(PointeeType, Elts[0], Indices,
2775 bitc::CST_CODE_CE_INBOUNDS_GEP);
2778 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
2779 if (Record.size() < 3)
2780 return error("Invalid record");
2782 Type *SelectorTy = Type::getInt1Ty(Context);
2784 // The selector might be an i1 or an <n x i1>
2785 // Get the type from the ValueList before getting a forward ref.
2786 if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
2787 if (Value *V = ValueList[Record[0]])
2788 if (SelectorTy != V->getType())
2789 SelectorTy = VectorType::get(SelectorTy, VTy->getNumElements());
2791 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2793 ValueList.getConstantFwdRef(Record[1],CurTy),
2794 ValueList.getConstantFwdRef(Record[2],CurTy));
2797 case bitc::CST_CODE_CE_EXTRACTELT
2798 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
2799 if (Record.size() < 3)
2800 return error("Invalid record");
2802 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2804 return error("Invalid record");
2805 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2806 Constant *Op1 = nullptr;
2807 if (Record.size() == 4) {
2808 Type *IdxTy = getTypeByID(Record[2]);
2810 return error("Invalid record");
2811 Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2812 } else // TODO: Remove with llvm 4.0
2813 Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2815 return error("Invalid record");
2816 V = ConstantExpr::getExtractElement(Op0, Op1);
2819 case bitc::CST_CODE_CE_INSERTELT
2820 : { // CE_INSERTELT: [opval, opval, opty, opval]
2821 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2822 if (Record.size() < 3 || !OpTy)
2823 return error("Invalid record");
2824 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2825 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2826 OpTy->getElementType());
2827 Constant *Op2 = nullptr;
2828 if (Record.size() == 4) {
2829 Type *IdxTy = getTypeByID(Record[2]);
2831 return error("Invalid record");
2832 Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2833 } else // TODO: Remove with llvm 4.0
2834 Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2836 return error("Invalid record");
2837 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
2840 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
2841 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2842 if (Record.size() < 3 || !OpTy)
2843 return error("Invalid record");
2844 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2845 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
2846 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2847 OpTy->getNumElements());
2848 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
2849 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2852 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
2853 VectorType *RTy = dyn_cast<VectorType>(CurTy);
2855 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2856 if (Record.size() < 4 || !RTy || !OpTy)
2857 return error("Invalid record");
2858 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2859 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2860 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2861 RTy->getNumElements());
2862 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
2863 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2866 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
2867 if (Record.size() < 4)
2868 return error("Invalid record");
2869 Type *OpTy = getTypeByID(Record[0]);
2871 return error("Invalid record");
2872 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2873 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2875 if (OpTy->isFPOrFPVectorTy())
2876 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
2878 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
2881 // This maintains backward compatibility, pre-asm dialect keywords.
2882 // FIXME: Remove with the 4.0 release.
2883 case bitc::CST_CODE_INLINEASM_OLD: {
2884 if (Record.size() < 2)
2885 return error("Invalid record");
2886 std::string AsmStr, ConstrStr;
2887 bool HasSideEffects = Record[0] & 1;
2888 bool IsAlignStack = Record[0] >> 1;
2889 unsigned AsmStrSize = Record[1];
2890 if (2+AsmStrSize >= Record.size())
2891 return error("Invalid record");
2892 unsigned ConstStrSize = Record[2+AsmStrSize];
2893 if (3+AsmStrSize+ConstStrSize > Record.size())
2894 return error("Invalid record");
2896 for (unsigned i = 0; i != AsmStrSize; ++i)
2897 AsmStr += (char)Record[2+i];
2898 for (unsigned i = 0; i != ConstStrSize; ++i)
2899 ConstrStr += (char)Record[3+AsmStrSize+i];
2900 PointerType *PTy = cast<PointerType>(CurTy);
2901 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2902 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
2905 // This version adds support for the asm dialect keywords (e.g.,
2907 case bitc::CST_CODE_INLINEASM: {
2908 if (Record.size() < 2)
2909 return error("Invalid record");
2910 std::string AsmStr, ConstrStr;
2911 bool HasSideEffects = Record[0] & 1;
2912 bool IsAlignStack = (Record[0] >> 1) & 1;
2913 unsigned AsmDialect = Record[0] >> 2;
2914 unsigned AsmStrSize = Record[1];
2915 if (2+AsmStrSize >= Record.size())
2916 return error("Invalid record");
2917 unsigned ConstStrSize = Record[2+AsmStrSize];
2918 if (3+AsmStrSize+ConstStrSize > Record.size())
2919 return error("Invalid record");
2921 for (unsigned i = 0; i != AsmStrSize; ++i)
2922 AsmStr += (char)Record[2+i];
2923 for (unsigned i = 0; i != ConstStrSize; ++i)
2924 ConstrStr += (char)Record[3+AsmStrSize+i];
2925 PointerType *PTy = cast<PointerType>(CurTy);
2926 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2927 AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
2928 InlineAsm::AsmDialect(AsmDialect));
2931 case bitc::CST_CODE_BLOCKADDRESS:{
2932 if (Record.size() < 3)
2933 return error("Invalid record");
2934 Type *FnTy = getTypeByID(Record[0]);
2936 return error("Invalid record");
2938 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
2940 return error("Invalid record");
2942 // If the function is already parsed we can insert the block address right
2945 unsigned BBID = Record[2];
2947 // Invalid reference to entry block.
2948 return error("Invalid ID");
2950 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
2951 for (size_t I = 0, E = BBID; I != E; ++I) {
2953 return error("Invalid ID");
2958 // Otherwise insert a placeholder and remember it so it can be inserted
2959 // when the function is parsed.
2960 auto &FwdBBs = BasicBlockFwdRefs[Fn];
2962 BasicBlockFwdRefQueue.push_back(Fn);
2963 if (FwdBBs.size() < BBID + 1)
2964 FwdBBs.resize(BBID + 1);
2966 FwdBBs[BBID] = BasicBlock::Create(Context);
2969 V = BlockAddress::get(Fn, BB);
2974 ValueList.assignValue(V, NextCstNo);
2979 std::error_code BitcodeReader::parseUseLists() {
2980 if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
2981 return error("Invalid record");
2983 // Read all the records.
2984 SmallVector<uint64_t, 64> Record;
2986 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2988 switch (Entry.Kind) {
2989 case BitstreamEntry::SubBlock: // Handled for us already.
2990 case BitstreamEntry::Error:
2991 return error("Malformed block");
2992 case BitstreamEntry::EndBlock:
2993 return std::error_code();
2994 case BitstreamEntry::Record:
2995 // The interesting case.
2999 // Read a use list record.
3002 switch (Stream.readRecord(Entry.ID, Record)) {
3003 default: // Default behavior: unknown type.
3005 case bitc::USELIST_CODE_BB:
3008 case bitc::USELIST_CODE_DEFAULT: {
3009 unsigned RecordLength = Record.size();
3010 if (RecordLength < 3)
3011 // Records should have at least an ID and two indexes.
3012 return error("Invalid record");
3013 unsigned ID = Record.back();
3018 assert(ID < FunctionBBs.size() && "Basic block not found");
3019 V = FunctionBBs[ID];
3022 unsigned NumUses = 0;
3023 SmallDenseMap<const Use *, unsigned, 16> Order;
3024 for (const Use &U : V->materialized_uses()) {
3025 if (++NumUses > Record.size())
3027 Order[&U] = Record[NumUses - 1];
3029 if (Order.size() != Record.size() || NumUses > Record.size())
3030 // Mismatches can happen if the functions are being materialized lazily
3031 // (out-of-order), or a value has been upgraded.
3034 V->sortUseList([&](const Use &L, const Use &R) {
3035 return Order.lookup(&L) < Order.lookup(&R);
3043 /// When we see the block for metadata, remember where it is and then skip it.
3044 /// This lets us lazily deserialize the metadata.
3045 std::error_code BitcodeReader::rememberAndSkipMetadata() {
3046 // Save the current stream state.
3047 uint64_t CurBit = Stream.GetCurrentBitNo();
3048 DeferredMetadataInfo.push_back(CurBit);
3050 // Skip over the block for now.
3051 if (Stream.SkipBlock())
3052 return error("Invalid record");
3053 return std::error_code();
3056 std::error_code BitcodeReader::materializeMetadata() {
3057 for (uint64_t BitPos : DeferredMetadataInfo) {
3058 // Move the bit stream to the saved position.
3059 Stream.JumpToBit(BitPos);
3060 if (std::error_code EC = parseMetadata(true))
3063 DeferredMetadataInfo.clear();
3064 return std::error_code();
3067 void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
3069 void BitcodeReader::saveMetadataList(
3070 DenseMap<const Metadata *, unsigned> &MetadataToIDs, bool OnlyTempMD) {
3071 for (unsigned ID = 0; ID < MetadataList.size(); ++ID) {
3072 Metadata *MD = MetadataList[ID];
3073 auto *N = dyn_cast_or_null<MDNode>(MD);
3074 assert((!N || (N->isResolved() || N->isTemporary())) &&
3075 "Found non-resolved non-temp MDNode while saving metadata");
3076 // Save all values if !OnlyTempMD, otherwise just the temporary metadata.
3077 // Note that in the !OnlyTempMD case we need to save all Metadata, not
3078 // just MDNode, as we may have references to other types of module-level
3079 // metadata (e.g. ValueAsMetadata) from instructions.
3080 if (!OnlyTempMD || (N && N->isTemporary())) {
3081 // Will call this after materializing each function, in order to
3082 // handle remapping of the function's instructions/metadata.
3083 // See if we already have an entry in that case.
3084 if (OnlyTempMD && MetadataToIDs.count(MD)) {
3085 assert(MetadataToIDs[MD] == ID && "Inconsistent metadata value id");
3088 MetadataToIDs[MD] = ID;
3093 /// When we see the block for a function body, remember where it is and then
3094 /// skip it. This lets us lazily deserialize the functions.
3095 std::error_code BitcodeReader::rememberAndSkipFunctionBody() {
3096 // Get the function we are talking about.
3097 if (FunctionsWithBodies.empty())
3098 return error("Insufficient function protos");
3100 Function *Fn = FunctionsWithBodies.back();
3101 FunctionsWithBodies.pop_back();
3103 // Save the current stream state.
3104 uint64_t CurBit = Stream.GetCurrentBitNo();
3106 (DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&
3107 "Mismatch between VST and scanned function offsets");
3108 DeferredFunctionInfo[Fn] = CurBit;
3110 // Skip over the function block for now.
3111 if (Stream.SkipBlock())
3112 return error("Invalid record");
3113 return std::error_code();
3116 std::error_code BitcodeReader::globalCleanup() {
3117 // Patch the initializers for globals and aliases up.
3118 resolveGlobalAndAliasInits();
3119 if (!GlobalInits.empty() || !AliasInits.empty())
3120 return error("Malformed global initializer set");
3122 // Look for intrinsic functions which need to be upgraded at some point
3123 for (Function &F : *TheModule) {
3125 if (UpgradeIntrinsicFunction(&F, NewFn))
3126 UpgradedIntrinsics[&F] = NewFn;
3129 // Look for global variables which need to be renamed.
3130 for (GlobalVariable &GV : TheModule->globals())
3131 UpgradeGlobalVariable(&GV);
3133 // Force deallocation of memory for these vectors to favor the client that
3134 // want lazy deserialization.
3135 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
3136 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
3137 return std::error_code();
3140 /// Support for lazy parsing of function bodies. This is required if we
3141 /// either have an old bitcode file without a VST forward declaration record,
3142 /// or if we have an anonymous function being materialized, since anonymous
3143 /// functions do not have a name and are therefore not in the VST.
3144 std::error_code BitcodeReader::rememberAndSkipFunctionBodies() {
3145 Stream.JumpToBit(NextUnreadBit);
3147 if (Stream.AtEndOfStream())
3148 return error("Could not find function in stream");
3150 if (!SeenFirstFunctionBody)
3151 return error("Trying to materialize functions before seeing function blocks");
3153 // An old bitcode file with the symbol table at the end would have
3154 // finished the parse greedily.
3155 assert(SeenValueSymbolTable);
3157 SmallVector<uint64_t, 64> Record;
3160 BitstreamEntry Entry = Stream.advance();
3161 switch (Entry.Kind) {
3163 return error("Expect SubBlock");
3164 case BitstreamEntry::SubBlock:
3167 return error("Expect function block");
3168 case bitc::FUNCTION_BLOCK_ID:
3169 if (std::error_code EC = rememberAndSkipFunctionBody())
3171 NextUnreadBit = Stream.GetCurrentBitNo();
3172 return std::error_code();
3178 std::error_code BitcodeReader::parseBitcodeVersion() {
3179 if (Stream.EnterSubBlock(bitc::IDENTIFICATION_BLOCK_ID))
3180 return error("Invalid record");
3182 // Read all the records.
3183 SmallVector<uint64_t, 64> Record;
3185 BitstreamEntry Entry = Stream.advance();
3187 switch (Entry.Kind) {
3189 case BitstreamEntry::Error:
3190 return error("Malformed block");
3191 case BitstreamEntry::EndBlock:
3192 return std::error_code();
3193 case BitstreamEntry::Record:
3194 // The interesting case.
3200 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
3202 default: // Default behavior: reject
3203 return error("Invalid value");
3204 case bitc::IDENTIFICATION_CODE_STRING: { // IDENTIFICATION: [strchr x
3206 convertToString(Record, 0, ProducerIdentification);
3209 case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH: [epoch#]
3210 unsigned epoch = (unsigned)Record[0];
3211 if (epoch != bitc::BITCODE_CURRENT_EPOCH) {
3213 Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +
3214 "' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");
3221 std::error_code BitcodeReader::parseModule(uint64_t ResumeBit,
3222 bool ShouldLazyLoadMetadata) {
3224 Stream.JumpToBit(ResumeBit);
3225 else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3226 return error("Invalid record");
3228 SmallVector<uint64_t, 64> Record;
3229 std::vector<std::string> SectionTable;
3230 std::vector<std::string> GCTable;
3232 // Read all the records for this module.
3234 BitstreamEntry Entry = Stream.advance();
3236 switch (Entry.Kind) {
3237 case BitstreamEntry::Error:
3238 return error("Malformed block");
3239 case BitstreamEntry::EndBlock:
3240 return globalCleanup();
3242 case BitstreamEntry::SubBlock:
3244 default: // Skip unknown content.
3245 if (Stream.SkipBlock())
3246 return error("Invalid record");
3248 case bitc::BLOCKINFO_BLOCK_ID:
3249 if (Stream.ReadBlockInfoBlock())
3250 return error("Malformed block");
3252 case bitc::PARAMATTR_BLOCK_ID:
3253 if (std::error_code EC = parseAttributeBlock())
3256 case bitc::PARAMATTR_GROUP_BLOCK_ID:
3257 if (std::error_code EC = parseAttributeGroupBlock())
3260 case bitc::TYPE_BLOCK_ID_NEW:
3261 if (std::error_code EC = parseTypeTable())
3264 case bitc::VALUE_SYMTAB_BLOCK_ID:
3265 if (!SeenValueSymbolTable) {
3266 // Either this is an old form VST without function index and an
3267 // associated VST forward declaration record (which would have caused
3268 // the VST to be jumped to and parsed before it was encountered
3269 // normally in the stream), or there were no function blocks to
3270 // trigger an earlier parsing of the VST.
3271 assert(VSTOffset == 0 || FunctionsWithBodies.empty());
3272 if (std::error_code EC = parseValueSymbolTable())
3274 SeenValueSymbolTable = true;
3276 // We must have had a VST forward declaration record, which caused
3277 // the parser to jump to and parse the VST earlier.
3278 assert(VSTOffset > 0);
3279 if (Stream.SkipBlock())
3280 return error("Invalid record");
3283 case bitc::CONSTANTS_BLOCK_ID:
3284 if (std::error_code EC = parseConstants())
3286 if (std::error_code EC = resolveGlobalAndAliasInits())
3289 case bitc::METADATA_BLOCK_ID:
3290 if (ShouldLazyLoadMetadata && !IsMetadataMaterialized) {
3291 if (std::error_code EC = rememberAndSkipMetadata())
3295 assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
3296 if (std::error_code EC = parseMetadata(true))
3299 case bitc::METADATA_KIND_BLOCK_ID:
3300 if (std::error_code EC = parseMetadataKinds())
3303 case bitc::FUNCTION_BLOCK_ID:
3304 // If this is the first function body we've seen, reverse the
3305 // FunctionsWithBodies list.
3306 if (!SeenFirstFunctionBody) {
3307 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
3308 if (std::error_code EC = globalCleanup())
3310 SeenFirstFunctionBody = true;
3313 if (VSTOffset > 0) {
3314 // If we have a VST forward declaration record, make sure we
3315 // parse the VST now if we haven't already. It is needed to
3316 // set up the DeferredFunctionInfo vector for lazy reading.
3317 if (!SeenValueSymbolTable) {
3318 if (std::error_code EC =
3319 BitcodeReader::parseValueSymbolTable(VSTOffset))
3321 SeenValueSymbolTable = true;
3322 // Fall through so that we record the NextUnreadBit below.
3323 // This is necessary in case we have an anonymous function that
3324 // is later materialized. Since it will not have a VST entry we
3325 // need to fall back to the lazy parse to find its offset.
3327 // If we have a VST forward declaration record, but have already
3328 // parsed the VST (just above, when the first function body was
3329 // encountered here), then we are resuming the parse after
3330 // materializing functions. The ResumeBit points to the
3331 // start of the last function block recorded in the
3332 // DeferredFunctionInfo map. Skip it.
3333 if (Stream.SkipBlock())
3334 return error("Invalid record");
3339 // Support older bitcode files that did not have the function
3340 // index in the VST, nor a VST forward declaration record, as
3341 // well as anonymous functions that do not have VST entries.
3342 // Build the DeferredFunctionInfo vector on the fly.
3343 if (std::error_code EC = rememberAndSkipFunctionBody())
3346 // Suspend parsing when we reach the function bodies. Subsequent
3347 // materialization calls will resume it when necessary. If the bitcode
3348 // file is old, the symbol table will be at the end instead and will not
3349 // have been seen yet. In this case, just finish the parse now.
3350 if (SeenValueSymbolTable) {
3351 NextUnreadBit = Stream.GetCurrentBitNo();
3352 return std::error_code();
3355 case bitc::USELIST_BLOCK_ID:
3356 if (std::error_code EC = parseUseLists())
3359 case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
3360 if (std::error_code EC = parseOperandBundleTags())
3366 case BitstreamEntry::Record:
3367 // The interesting case.
3373 auto BitCode = Stream.readRecord(Entry.ID, Record);
3375 default: break; // Default behavior, ignore unknown content.
3376 case bitc::MODULE_CODE_VERSION: { // VERSION: [version#]
3377 if (Record.size() < 1)
3378 return error("Invalid record");
3379 // Only version #0 and #1 are supported so far.
3380 unsigned module_version = Record[0];
3381 switch (module_version) {
3383 return error("Invalid value");
3385 UseRelativeIDs = false;
3388 UseRelativeIDs = true;
3393 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
3395 if (convertToString(Record, 0, S))
3396 return error("Invalid record");
3397 TheModule->setTargetTriple(S);
3400 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
3402 if (convertToString(Record, 0, S))
3403 return error("Invalid record");
3404 TheModule->setDataLayout(S);
3407 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
3409 if (convertToString(Record, 0, S))
3410 return error("Invalid record");
3411 TheModule->setModuleInlineAsm(S);
3414 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
3415 // FIXME: Remove in 4.0.
3417 if (convertToString(Record, 0, S))
3418 return error("Invalid record");
3422 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
3424 if (convertToString(Record, 0, S))
3425 return error("Invalid record");
3426 SectionTable.push_back(S);
3429 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
3431 if (convertToString(Record, 0, S))
3432 return error("Invalid record");
3433 GCTable.push_back(S);
3436 case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
3437 if (Record.size() < 2)
3438 return error("Invalid record");
3439 Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
3440 unsigned ComdatNameSize = Record[1];
3441 std::string ComdatName;
3442 ComdatName.reserve(ComdatNameSize);
3443 for (unsigned i = 0; i != ComdatNameSize; ++i)
3444 ComdatName += (char)Record[2 + i];
3445 Comdat *C = TheModule->getOrInsertComdat(ComdatName);
3446 C->setSelectionKind(SK);
3447 ComdatList.push_back(C);
3450 // GLOBALVAR: [pointer type, isconst, initid,
3451 // linkage, alignment, section, visibility, threadlocal,
3452 // unnamed_addr, externally_initialized, dllstorageclass,
3454 case bitc::MODULE_CODE_GLOBALVAR: {
3455 if (Record.size() < 6)
3456 return error("Invalid record");
3457 Type *Ty = getTypeByID(Record[0]);
3459 return error("Invalid record");
3460 bool isConstant = Record[1] & 1;
3461 bool explicitType = Record[1] & 2;
3462 unsigned AddressSpace;
3464 AddressSpace = Record[1] >> 2;
3466 if (!Ty->isPointerTy())
3467 return error("Invalid type for value");
3468 AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
3469 Ty = cast<PointerType>(Ty)->getElementType();
3472 uint64_t RawLinkage = Record[3];
3473 GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
3475 if (std::error_code EC = parseAlignmentValue(Record[4], Alignment))
3477 std::string Section;
3479 if (Record[5]-1 >= SectionTable.size())
3480 return error("Invalid ID");
3481 Section = SectionTable[Record[5]-1];
3483 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
3484 // Local linkage must have default visibility.
3485 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
3486 // FIXME: Change to an error if non-default in 4.0.
3487 Visibility = getDecodedVisibility(Record[6]);
3489 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
3490 if (Record.size() > 7)
3491 TLM = getDecodedThreadLocalMode(Record[7]);
3493 bool UnnamedAddr = false;
3494 if (Record.size() > 8)
3495 UnnamedAddr = Record[8];
3497 bool ExternallyInitialized = false;
3498 if (Record.size() > 9)
3499 ExternallyInitialized = Record[9];
3501 GlobalVariable *NewGV =
3502 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
3503 TLM, AddressSpace, ExternallyInitialized);
3504 NewGV->setAlignment(Alignment);
3505 if (!Section.empty())
3506 NewGV->setSection(Section);
3507 NewGV->setVisibility(Visibility);
3508 NewGV->setUnnamedAddr(UnnamedAddr);
3510 if (Record.size() > 10)
3511 NewGV->setDLLStorageClass(getDecodedDLLStorageClass(Record[10]));
3513 upgradeDLLImportExportLinkage(NewGV, RawLinkage);
3515 ValueList.push_back(NewGV);
3517 // Remember which value to use for the global initializer.
3518 if (unsigned InitID = Record[2])
3519 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
3521 if (Record.size() > 11) {
3522 if (unsigned ComdatID = Record[11]) {
3523 if (ComdatID > ComdatList.size())
3524 return error("Invalid global variable comdat ID");
3525 NewGV->setComdat(ComdatList[ComdatID - 1]);
3527 } else if (hasImplicitComdat(RawLinkage)) {
3528 NewGV->setComdat(reinterpret_cast<Comdat *>(1));
3532 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
3533 // alignment, section, visibility, gc, unnamed_addr,
3534 // prologuedata, dllstorageclass, comdat, prefixdata]
3535 case bitc::MODULE_CODE_FUNCTION: {
3536 if (Record.size() < 8)
3537 return error("Invalid record");
3538 Type *Ty = getTypeByID(Record[0]);
3540 return error("Invalid record");
3541 if (auto *PTy = dyn_cast<PointerType>(Ty))
3542 Ty = PTy->getElementType();
3543 auto *FTy = dyn_cast<FunctionType>(Ty);
3545 return error("Invalid type for value");
3546 auto CC = static_cast<CallingConv::ID>(Record[1]);
3547 if (CC & ~CallingConv::MaxID)
3548 return error("Invalid calling convention ID");
3550 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
3553 Func->setCallingConv(CC);
3554 bool isProto = Record[2];
3555 uint64_t RawLinkage = Record[3];
3556 Func->setLinkage(getDecodedLinkage(RawLinkage));
3557 Func->setAttributes(getAttributes(Record[4]));
3560 if (std::error_code EC = parseAlignmentValue(Record[5], Alignment))
3562 Func->setAlignment(Alignment);
3564 if (Record[6]-1 >= SectionTable.size())
3565 return error("Invalid ID");
3566 Func->setSection(SectionTable[Record[6]-1]);
3568 // Local linkage must have default visibility.
3569 if (!Func->hasLocalLinkage())
3570 // FIXME: Change to an error if non-default in 4.0.
3571 Func->setVisibility(getDecodedVisibility(Record[7]));
3572 if (Record.size() > 8 && Record[8]) {
3573 if (Record[8]-1 >= GCTable.size())
3574 return error("Invalid ID");
3575 Func->setGC(GCTable[Record[8]-1].c_str());
3577 bool UnnamedAddr = false;
3578 if (Record.size() > 9)
3579 UnnamedAddr = Record[9];
3580 Func->setUnnamedAddr(UnnamedAddr);
3581 if (Record.size() > 10 && Record[10] != 0)
3582 FunctionPrologues.push_back(std::make_pair(Func, Record[10]-1));
3584 if (Record.size() > 11)
3585 Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));
3587 upgradeDLLImportExportLinkage(Func, RawLinkage);
3589 if (Record.size() > 12) {
3590 if (unsigned ComdatID = Record[12]) {
3591 if (ComdatID > ComdatList.size())
3592 return error("Invalid function comdat ID");
3593 Func->setComdat(ComdatList[ComdatID - 1]);
3595 } else if (hasImplicitComdat(RawLinkage)) {
3596 Func->setComdat(reinterpret_cast<Comdat *>(1));
3599 if (Record.size() > 13 && Record[13] != 0)
3600 FunctionPrefixes.push_back(std::make_pair(Func, Record[13]-1));
3602 if (Record.size() > 14 && Record[14] != 0)
3603 FunctionPersonalityFns.push_back(std::make_pair(Func, Record[14] - 1));
3605 ValueList.push_back(Func);
3607 // If this is a function with a body, remember the prototype we are
3608 // creating now, so that we can match up the body with them later.
3610 Func->setIsMaterializable(true);
3611 FunctionsWithBodies.push_back(Func);
3612 DeferredFunctionInfo[Func] = 0;
3616 // ALIAS: [alias type, addrspace, aliasee val#, linkage]
3617 // ALIAS: [alias type, addrspace, aliasee val#, linkage, visibility, dllstorageclass]
3618 case bitc::MODULE_CODE_ALIAS:
3619 case bitc::MODULE_CODE_ALIAS_OLD: {
3620 bool NewRecord = BitCode == bitc::MODULE_CODE_ALIAS;
3621 if (Record.size() < (3 + (unsigned)NewRecord))
3622 return error("Invalid record");
3624 Type *Ty = getTypeByID(Record[OpNum++]);
3626 return error("Invalid record");
3630 auto *PTy = dyn_cast<PointerType>(Ty);
3632 return error("Invalid type for value");
3633 Ty = PTy->getElementType();
3634 AddrSpace = PTy->getAddressSpace();
3636 AddrSpace = Record[OpNum++];
3639 auto Val = Record[OpNum++];
3640 auto Linkage = Record[OpNum++];
3641 auto *NewGA = GlobalAlias::create(
3642 Ty, AddrSpace, getDecodedLinkage(Linkage), "", TheModule);
3643 // Old bitcode files didn't have visibility field.
3644 // Local linkage must have default visibility.
3645 if (OpNum != Record.size()) {
3646 auto VisInd = OpNum++;
3647 if (!NewGA->hasLocalLinkage())
3648 // FIXME: Change to an error if non-default in 4.0.
3649 NewGA->setVisibility(getDecodedVisibility(Record[VisInd]));
3651 if (OpNum != Record.size())
3652 NewGA->setDLLStorageClass(getDecodedDLLStorageClass(Record[OpNum++]));
3654 upgradeDLLImportExportLinkage(NewGA, Linkage);
3655 if (OpNum != Record.size())
3656 NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[OpNum++]));
3657 if (OpNum != Record.size())
3658 NewGA->setUnnamedAddr(Record[OpNum++]);
3659 ValueList.push_back(NewGA);
3660 AliasInits.push_back(std::make_pair(NewGA, Val));
3663 /// MODULE_CODE_PURGEVALS: [numvals]
3664 case bitc::MODULE_CODE_PURGEVALS:
3665 // Trim down the value list to the specified size.
3666 if (Record.size() < 1 || Record[0] > ValueList.size())
3667 return error("Invalid record");
3668 ValueList.shrinkTo(Record[0]);
3670 /// MODULE_CODE_VSTOFFSET: [offset]
3671 case bitc::MODULE_CODE_VSTOFFSET:
3672 if (Record.size() < 1)
3673 return error("Invalid record");
3674 VSTOffset = Record[0];
3676 /// MODULE_CODE_METADATA_VALUES: [numvals]
3677 case bitc::MODULE_CODE_METADATA_VALUES:
3678 if (Record.size() < 1)
3679 return error("Invalid record");
3680 assert(!IsMetadataMaterialized);
3681 // This record contains the number of metadata values in the module-level
3682 // METADATA_BLOCK. It is used to support lazy parsing of metadata as
3683 // a postpass, where we will parse function-level metadata first.
3684 // This is needed because the ids of metadata are assigned implicitly
3685 // based on their ordering in the bitcode, with the function-level
3686 // metadata ids starting after the module-level metadata ids. Otherwise,
3687 // we would have to parse the module-level metadata block to prime the
3688 // MetadataList when we are lazy loading metadata during function
3689 // importing. Initialize the MetadataList size here based on the
3690 // record value, regardless of whether we are doing lazy metadata
3691 // loading, so that we have consistent handling and assertion
3692 // checking in parseMetadata for module-level metadata.
3693 NumModuleMDs = Record[0];
3694 SeenModuleValuesRecord = true;
3695 assert(MetadataList.size() == 0);
3696 MetadataList.resize(NumModuleMDs);
3703 /// Helper to read the header common to all bitcode files.
3704 static bool hasValidBitcodeHeader(BitstreamCursor &Stream) {
3705 // Sniff for the signature.
3706 if (Stream.Read(8) != 'B' ||
3707 Stream.Read(8) != 'C' ||
3708 Stream.Read(4) != 0x0 ||
3709 Stream.Read(4) != 0xC ||
3710 Stream.Read(4) != 0xE ||
3711 Stream.Read(4) != 0xD)
3717 BitcodeReader::parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
3718 Module *M, bool ShouldLazyLoadMetadata) {
3721 if (std::error_code EC = initStream(std::move(Streamer)))
3724 // Sniff for the signature.
3725 if (!hasValidBitcodeHeader(Stream))
3726 return error("Invalid bitcode signature");
3728 // We expect a number of well-defined blocks, though we don't necessarily
3729 // need to understand them all.
3731 if (Stream.AtEndOfStream()) {
3732 // We didn't really read a proper Module.
3733 return error("Malformed IR file");
3736 BitstreamEntry Entry =
3737 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
3739 if (Entry.Kind != BitstreamEntry::SubBlock)
3740 return error("Malformed block");
3742 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {
3743 parseBitcodeVersion();
3747 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3748 return parseModule(0, ShouldLazyLoadMetadata);
3750 if (Stream.SkipBlock())
3751 return error("Invalid record");
3755 ErrorOr<std::string> BitcodeReader::parseModuleTriple() {
3756 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3757 return error("Invalid record");
3759 SmallVector<uint64_t, 64> Record;
3762 // Read all the records for this module.
3764 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3766 switch (Entry.Kind) {
3767 case BitstreamEntry::SubBlock: // Handled for us already.
3768 case BitstreamEntry::Error:
3769 return error("Malformed block");
3770 case BitstreamEntry::EndBlock:
3772 case BitstreamEntry::Record:
3773 // The interesting case.
3778 switch (Stream.readRecord(Entry.ID, Record)) {
3779 default: break; // Default behavior, ignore unknown content.
3780 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
3782 if (convertToString(Record, 0, S))
3783 return error("Invalid record");
3790 llvm_unreachable("Exit infinite loop");
3793 ErrorOr<std::string> BitcodeReader::parseTriple() {
3794 if (std::error_code EC = initStream(nullptr))
3797 // Sniff for the signature.
3798 if (!hasValidBitcodeHeader(Stream))
3799 return error("Invalid bitcode signature");
3801 // We expect a number of well-defined blocks, though we don't necessarily
3802 // need to understand them all.
3804 BitstreamEntry Entry = Stream.advance();
3806 switch (Entry.Kind) {
3807 case BitstreamEntry::Error:
3808 return error("Malformed block");
3809 case BitstreamEntry::EndBlock:
3810 return std::error_code();
3812 case BitstreamEntry::SubBlock:
3813 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3814 return parseModuleTriple();
3816 // Ignore other sub-blocks.
3817 if (Stream.SkipBlock())
3818 return error("Malformed block");
3821 case BitstreamEntry::Record:
3822 Stream.skipRecord(Entry.ID);
3828 ErrorOr<std::string> BitcodeReader::parseIdentificationBlock() {
3829 if (std::error_code EC = initStream(nullptr))
3832 // Sniff for the signature.
3833 if (!hasValidBitcodeHeader(Stream))
3834 return error("Invalid bitcode signature");
3836 // We expect a number of well-defined blocks, though we don't necessarily
3837 // need to understand them all.
3839 BitstreamEntry Entry = Stream.advance();
3840 switch (Entry.Kind) {
3841 case BitstreamEntry::Error:
3842 return error("Malformed block");
3843 case BitstreamEntry::EndBlock:
3844 return std::error_code();
3846 case BitstreamEntry::SubBlock:
3847 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {
3848 if (std::error_code EC = parseBitcodeVersion())
3850 return ProducerIdentification;
3852 // Ignore other sub-blocks.
3853 if (Stream.SkipBlock())
3854 return error("Malformed block");
3856 case BitstreamEntry::Record:
3857 Stream.skipRecord(Entry.ID);
3863 /// Parse metadata attachments.
3864 std::error_code BitcodeReader::parseMetadataAttachment(Function &F) {
3865 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
3866 return error("Invalid record");
3868 SmallVector<uint64_t, 64> Record;
3870 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3872 switch (Entry.Kind) {
3873 case BitstreamEntry::SubBlock: // Handled for us already.
3874 case BitstreamEntry::Error:
3875 return error("Malformed block");
3876 case BitstreamEntry::EndBlock:
3877 return std::error_code();
3878 case BitstreamEntry::Record:
3879 // The interesting case.
3883 // Read a metadata attachment record.
3885 switch (Stream.readRecord(Entry.ID, Record)) {
3886 default: // Default behavior: ignore.
3888 case bitc::METADATA_ATTACHMENT: {
3889 unsigned RecordLength = Record.size();
3891 return error("Invalid record");
3892 if (RecordLength % 2 == 0) {
3893 // A function attachment.
3894 for (unsigned I = 0; I != RecordLength; I += 2) {
3895 auto K = MDKindMap.find(Record[I]);
3896 if (K == MDKindMap.end())
3897 return error("Invalid ID");
3898 Metadata *MD = MetadataList.getValueFwdRef(Record[I + 1]);
3899 F.setMetadata(K->second, cast<MDNode>(MD));
3904 // An instruction attachment.
3905 Instruction *Inst = InstructionList[Record[0]];
3906 for (unsigned i = 1; i != RecordLength; i = i+2) {
3907 unsigned Kind = Record[i];
3908 DenseMap<unsigned, unsigned>::iterator I =
3909 MDKindMap.find(Kind);
3910 if (I == MDKindMap.end())
3911 return error("Invalid ID");
3912 Metadata *Node = MetadataList.getValueFwdRef(Record[i + 1]);
3913 if (isa<LocalAsMetadata>(Node))
3914 // Drop the attachment. This used to be legal, but there's no
3917 Inst->setMetadata(I->second, cast<MDNode>(Node));
3918 if (I->second == LLVMContext::MD_tbaa)
3919 InstsWithTBAATag.push_back(Inst);
3927 static std::error_code typeCheckLoadStoreInst(Type *ValType, Type *PtrType) {
3928 LLVMContext &Context = PtrType->getContext();
3929 if (!isa<PointerType>(PtrType))
3930 return error(Context, "Load/Store operand is not a pointer type");
3931 Type *ElemType = cast<PointerType>(PtrType)->getElementType();
3933 if (ValType && ValType != ElemType)
3934 return error(Context, "Explicit load/store type does not match pointee "
3935 "type of pointer operand");
3936 if (!PointerType::isLoadableOrStorableType(ElemType))
3937 return error(Context, "Cannot load/store from pointer");
3938 return std::error_code();
3941 /// Lazily parse the specified function body block.
3942 std::error_code BitcodeReader::parseFunctionBody(Function *F) {
3943 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
3944 return error("Invalid record");
3946 InstructionList.clear();
3947 unsigned ModuleValueListSize = ValueList.size();
3948 unsigned ModuleMetadataListSize = MetadataList.size();
3950 // Add all the function arguments to the value table.
3951 for (Argument &I : F->args())
3952 ValueList.push_back(&I);
3954 unsigned NextValueNo = ValueList.size();
3955 BasicBlock *CurBB = nullptr;
3956 unsigned CurBBNo = 0;
3959 auto getLastInstruction = [&]() -> Instruction * {
3960 if (CurBB && !CurBB->empty())
3961 return &CurBB->back();
3962 else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
3963 !FunctionBBs[CurBBNo - 1]->empty())
3964 return &FunctionBBs[CurBBNo - 1]->back();
3968 std::vector<OperandBundleDef> OperandBundles;
3970 // Read all the records.
3971 SmallVector<uint64_t, 64> Record;
3973 BitstreamEntry Entry = Stream.advance();
3975 switch (Entry.Kind) {
3976 case BitstreamEntry::Error:
3977 return error("Malformed block");
3978 case BitstreamEntry::EndBlock:
3979 goto OutOfRecordLoop;
3981 case BitstreamEntry::SubBlock:
3983 default: // Skip unknown content.
3984 if (Stream.SkipBlock())
3985 return error("Invalid record");
3987 case bitc::CONSTANTS_BLOCK_ID:
3988 if (std::error_code EC = parseConstants())
3990 NextValueNo = ValueList.size();
3992 case bitc::VALUE_SYMTAB_BLOCK_ID:
3993 if (std::error_code EC = parseValueSymbolTable())
3996 case bitc::METADATA_ATTACHMENT_ID:
3997 if (std::error_code EC = parseMetadataAttachment(*F))
4000 case bitc::METADATA_BLOCK_ID:
4001 if (std::error_code EC = parseMetadata())
4004 case bitc::USELIST_BLOCK_ID:
4005 if (std::error_code EC = parseUseLists())
4011 case BitstreamEntry::Record:
4012 // The interesting case.
4018 Instruction *I = nullptr;
4019 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
4021 default: // Default behavior: reject
4022 return error("Invalid value");
4023 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
4024 if (Record.size() < 1 || Record[0] == 0)
4025 return error("Invalid record");
4026 // Create all the basic blocks for the function.
4027 FunctionBBs.resize(Record[0]);
4029 // See if anything took the address of blocks in this function.
4030 auto BBFRI = BasicBlockFwdRefs.find(F);
4031 if (BBFRI == BasicBlockFwdRefs.end()) {
4032 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
4033 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
4035 auto &BBRefs = BBFRI->second;
4036 // Check for invalid basic block references.
4037 if (BBRefs.size() > FunctionBBs.size())
4038 return error("Invalid ID");
4039 assert(!BBRefs.empty() && "Unexpected empty array");
4040 assert(!BBRefs.front() && "Invalid reference to entry block");
4041 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
4043 if (I < RE && BBRefs[I]) {
4044 BBRefs[I]->insertInto(F);
4045 FunctionBBs[I] = BBRefs[I];
4047 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
4050 // Erase from the table.
4051 BasicBlockFwdRefs.erase(BBFRI);
4054 CurBB = FunctionBBs[0];
4058 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
4059 // This record indicates that the last instruction is at the same
4060 // location as the previous instruction with a location.
4061 I = getLastInstruction();
4064 return error("Invalid record");
4065 I->setDebugLoc(LastLoc);
4069 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
4070 I = getLastInstruction();
4071 if (!I || Record.size() < 4)
4072 return error("Invalid record");
4074 unsigned Line = Record[0], Col = Record[1];
4075 unsigned ScopeID = Record[2], IAID = Record[3];
4077 MDNode *Scope = nullptr, *IA = nullptr;
4079 Scope = cast<MDNode>(MetadataList.getValueFwdRef(ScopeID - 1));
4081 IA = cast<MDNode>(MetadataList.getValueFwdRef(IAID - 1));
4082 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
4083 I->setDebugLoc(LastLoc);
4088 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
4091 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
4092 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
4093 OpNum+1 > Record.size())
4094 return error("Invalid record");
4096 int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
4098 return error("Invalid record");
4099 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4100 InstructionList.push_back(I);
4101 if (OpNum < Record.size()) {
4102 if (Opc == Instruction::Add ||
4103 Opc == Instruction::Sub ||
4104 Opc == Instruction::Mul ||
4105 Opc == Instruction::Shl) {
4106 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
4107 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
4108 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
4109 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
4110 } else if (Opc == Instruction::SDiv ||
4111 Opc == Instruction::UDiv ||
4112 Opc == Instruction::LShr ||
4113 Opc == Instruction::AShr) {
4114 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
4115 cast<BinaryOperator>(I)->setIsExact(true);
4116 } else if (isa<FPMathOperator>(I)) {
4117 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
4119 I->setFastMathFlags(FMF);
4125 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
4128 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4129 OpNum+2 != Record.size())
4130 return error("Invalid record");
4132 Type *ResTy = getTypeByID(Record[OpNum]);
4133 int Opc = getDecodedCastOpcode(Record[OpNum + 1]);
4134 if (Opc == -1 || !ResTy)
4135 return error("Invalid record");
4136 Instruction *Temp = nullptr;
4137 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
4139 InstructionList.push_back(Temp);
4140 CurBB->getInstList().push_back(Temp);
4143 auto CastOp = (Instruction::CastOps)Opc;
4144 if (!CastInst::castIsValid(CastOp, Op, ResTy))
4145 return error("Invalid cast");
4146 I = CastInst::Create(CastOp, Op, ResTy);
4148 InstructionList.push_back(I);
4151 case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:
4152 case bitc::FUNC_CODE_INST_GEP_OLD:
4153 case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
4159 if (BitCode == bitc::FUNC_CODE_INST_GEP) {
4160 InBounds = Record[OpNum++];
4161 Ty = getTypeByID(Record[OpNum++]);
4163 InBounds = BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD;
4168 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
4169 return error("Invalid record");
4172 Ty = cast<SequentialType>(BasePtr->getType()->getScalarType())
4175 cast<SequentialType>(BasePtr->getType()->getScalarType())
4178 "Explicit gep type does not match pointee type of pointer operand");
4180 SmallVector<Value*, 16> GEPIdx;
4181 while (OpNum != Record.size()) {
4183 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4184 return error("Invalid record");
4185 GEPIdx.push_back(Op);
4188 I = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
4190 InstructionList.push_back(I);
4192 cast<GetElementPtrInst>(I)->setIsInBounds(true);
4196 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
4197 // EXTRACTVAL: [opty, opval, n x indices]
4200 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
4201 return error("Invalid record");
4203 unsigned RecSize = Record.size();
4204 if (OpNum == RecSize)
4205 return error("EXTRACTVAL: Invalid instruction with 0 indices");
4207 SmallVector<unsigned, 4> EXTRACTVALIdx;
4208 Type *CurTy = Agg->getType();
4209 for (; OpNum != RecSize; ++OpNum) {
4210 bool IsArray = CurTy->isArrayTy();
4211 bool IsStruct = CurTy->isStructTy();
4212 uint64_t Index = Record[OpNum];
4214 if (!IsStruct && !IsArray)
4215 return error("EXTRACTVAL: Invalid type");
4216 if ((unsigned)Index != Index)
4217 return error("Invalid value");
4218 if (IsStruct && Index >= CurTy->subtypes().size())
4219 return error("EXTRACTVAL: Invalid struct index");
4220 if (IsArray && Index >= CurTy->getArrayNumElements())
4221 return error("EXTRACTVAL: Invalid array index");
4222 EXTRACTVALIdx.push_back((unsigned)Index);
4225 CurTy = CurTy->subtypes()[Index];
4227 CurTy = CurTy->subtypes()[0];
4230 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
4231 InstructionList.push_back(I);
4235 case bitc::FUNC_CODE_INST_INSERTVAL: {
4236 // INSERTVAL: [opty, opval, opty, opval, n x indices]
4239 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
4240 return error("Invalid record");
4242 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
4243 return error("Invalid record");
4245 unsigned RecSize = Record.size();
4246 if (OpNum == RecSize)
4247 return error("INSERTVAL: Invalid instruction with 0 indices");
4249 SmallVector<unsigned, 4> INSERTVALIdx;
4250 Type *CurTy = Agg->getType();
4251 for (; OpNum != RecSize; ++OpNum) {
4252 bool IsArray = CurTy->isArrayTy();
4253 bool IsStruct = CurTy->isStructTy();
4254 uint64_t Index = Record[OpNum];
4256 if (!IsStruct && !IsArray)
4257 return error("INSERTVAL: Invalid type");
4258 if ((unsigned)Index != Index)
4259 return error("Invalid value");
4260 if (IsStruct && Index >= CurTy->subtypes().size())
4261 return error("INSERTVAL: Invalid struct index");
4262 if (IsArray && Index >= CurTy->getArrayNumElements())
4263 return error("INSERTVAL: Invalid array index");
4265 INSERTVALIdx.push_back((unsigned)Index);
4267 CurTy = CurTy->subtypes()[Index];
4269 CurTy = CurTy->subtypes()[0];
4272 if (CurTy != Val->getType())
4273 return error("Inserted value type doesn't match aggregate type");
4275 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
4276 InstructionList.push_back(I);
4280 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
4281 // obsolete form of select
4282 // handles select i1 ... in old bitcode
4284 Value *TrueVal, *FalseVal, *Cond;
4285 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
4286 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
4287 popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
4288 return error("Invalid record");
4290 I = SelectInst::Create(Cond, TrueVal, FalseVal);
4291 InstructionList.push_back(I);
4295 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
4296 // new form of select
4297 // handles select i1 or select [N x i1]
4299 Value *TrueVal, *FalseVal, *Cond;
4300 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
4301 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
4302 getValueTypePair(Record, OpNum, NextValueNo, Cond))
4303 return error("Invalid record");
4305 // select condition can be either i1 or [N x i1]
4306 if (VectorType* vector_type =
4307 dyn_cast<VectorType>(Cond->getType())) {
4309 if (vector_type->getElementType() != Type::getInt1Ty(Context))
4310 return error("Invalid type for value");
4313 if (Cond->getType() != Type::getInt1Ty(Context))
4314 return error("Invalid type for value");
4317 I = SelectInst::Create(Cond, TrueVal, FalseVal);
4318 InstructionList.push_back(I);
4322 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
4325 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
4326 getValueTypePair(Record, OpNum, NextValueNo, Idx))
4327 return error("Invalid record");
4328 if (!Vec->getType()->isVectorTy())
4329 return error("Invalid type for value");
4330 I = ExtractElementInst::Create(Vec, Idx);
4331 InstructionList.push_back(I);
4335 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
4337 Value *Vec, *Elt, *Idx;
4338 if (getValueTypePair(Record, OpNum, NextValueNo, Vec))
4339 return error("Invalid record");
4340 if (!Vec->getType()->isVectorTy())
4341 return error("Invalid type for value");
4342 if (popValue(Record, OpNum, NextValueNo,
4343 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
4344 getValueTypePair(Record, OpNum, NextValueNo, Idx))
4345 return error("Invalid record");
4346 I = InsertElementInst::Create(Vec, Elt, Idx);
4347 InstructionList.push_back(I);
4351 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
4353 Value *Vec1, *Vec2, *Mask;
4354 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
4355 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
4356 return error("Invalid record");
4358 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
4359 return error("Invalid record");
4360 if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())
4361 return error("Invalid type for value");
4362 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
4363 InstructionList.push_back(I);
4367 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
4368 // Old form of ICmp/FCmp returning bool
4369 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
4370 // both legal on vectors but had different behaviour.
4371 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
4372 // FCmp/ICmp returning bool or vector of bool
4376 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
4377 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS))
4378 return error("Invalid record");
4380 unsigned PredVal = Record[OpNum];
4381 bool IsFP = LHS->getType()->isFPOrFPVectorTy();
4383 if (IsFP && Record.size() > OpNum+1)
4384 FMF = getDecodedFastMathFlags(Record[++OpNum]);
4386 if (OpNum+1 != Record.size())
4387 return error("Invalid record");
4389 if (LHS->getType()->isFPOrFPVectorTy())
4390 I = new FCmpInst((FCmpInst::Predicate)PredVal, LHS, RHS);
4392 I = new ICmpInst((ICmpInst::Predicate)PredVal, LHS, RHS);
4395 I->setFastMathFlags(FMF);
4396 InstructionList.push_back(I);
4400 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
4402 unsigned Size = Record.size();
4404 I = ReturnInst::Create(Context);
4405 InstructionList.push_back(I);
4410 Value *Op = nullptr;
4411 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4412 return error("Invalid record");
4413 if (OpNum != Record.size())
4414 return error("Invalid record");
4416 I = ReturnInst::Create(Context, Op);
4417 InstructionList.push_back(I);
4420 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
4421 if (Record.size() != 1 && Record.size() != 3)
4422 return error("Invalid record");
4423 BasicBlock *TrueDest = getBasicBlock(Record[0]);
4425 return error("Invalid record");
4427 if (Record.size() == 1) {
4428 I = BranchInst::Create(TrueDest);
4429 InstructionList.push_back(I);
4432 BasicBlock *FalseDest = getBasicBlock(Record[1]);
4433 Value *Cond = getValue(Record, 2, NextValueNo,
4434 Type::getInt1Ty(Context));
4435 if (!FalseDest || !Cond)
4436 return error("Invalid record");
4437 I = BranchInst::Create(TrueDest, FalseDest, Cond);
4438 InstructionList.push_back(I);
4442 case bitc::FUNC_CODE_INST_CLEANUPRET: { // CLEANUPRET: [val] or [val,bb#]
4443 if (Record.size() != 1 && Record.size() != 2)
4444 return error("Invalid record");
4447 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4449 return error("Invalid record");
4450 BasicBlock *UnwindDest = nullptr;
4451 if (Record.size() == 2) {
4452 UnwindDest = getBasicBlock(Record[Idx++]);
4454 return error("Invalid record");
4457 I = CleanupReturnInst::Create(CleanupPad, UnwindDest);
4458 InstructionList.push_back(I);
4461 case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [val,bb#]
4462 if (Record.size() != 2)
4463 return error("Invalid record");
4466 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4468 return error("Invalid record");
4469 BasicBlock *BB = getBasicBlock(Record[Idx++]);
4471 return error("Invalid record");
4473 I = CatchReturnInst::Create(CatchPad, BB);
4474 InstructionList.push_back(I);
4477 case bitc::FUNC_CODE_INST_CATCHSWITCH: { // CATCHSWITCH: [tok,num,(bb)*,bb?]
4478 // We must have, at minimum, the outer scope and the number of arguments.
4479 if (Record.size() < 2)
4480 return error("Invalid record");
4485 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4487 unsigned NumHandlers = Record[Idx++];
4489 SmallVector<BasicBlock *, 2> Handlers;
4490 for (unsigned Op = 0; Op != NumHandlers; ++Op) {
4491 BasicBlock *BB = getBasicBlock(Record[Idx++]);
4493 return error("Invalid record");
4494 Handlers.push_back(BB);
4497 BasicBlock *UnwindDest = nullptr;
4498 if (Idx + 1 == Record.size()) {
4499 UnwindDest = getBasicBlock(Record[Idx++]);
4501 return error("Invalid record");
4504 if (Record.size() != Idx)
4505 return error("Invalid record");
4508 CatchSwitchInst::Create(ParentPad, UnwindDest, NumHandlers);
4509 for (BasicBlock *Handler : Handlers)
4510 CatchSwitch->addHandler(Handler);
4512 InstructionList.push_back(I);
4515 case bitc::FUNC_CODE_INST_CATCHPAD:
4516 case bitc::FUNC_CODE_INST_CLEANUPPAD: { // [tok,num,(ty,val)*]
4517 // We must have, at minimum, the outer scope and the number of arguments.
4518 if (Record.size() < 2)
4519 return error("Invalid record");
4524 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4526 unsigned NumArgOperands = Record[Idx++];
4528 SmallVector<Value *, 2> Args;
4529 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
4531 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4532 return error("Invalid record");
4533 Args.push_back(Val);
4536 if (Record.size() != Idx)
4537 return error("Invalid record");
4539 if (BitCode == bitc::FUNC_CODE_INST_CLEANUPPAD)
4540 I = CleanupPadInst::Create(ParentPad, Args);
4542 I = CatchPadInst::Create(ParentPad, Args);
4543 InstructionList.push_back(I);
4546 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
4548 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
4549 // "New" SwitchInst format with case ranges. The changes to write this
4550 // format were reverted but we still recognize bitcode that uses it.
4551 // Hopefully someday we will have support for case ranges and can use
4552 // this format again.
4554 Type *OpTy = getTypeByID(Record[1]);
4555 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
4557 Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
4558 BasicBlock *Default = getBasicBlock(Record[3]);
4559 if (!OpTy || !Cond || !Default)
4560 return error("Invalid record");
4562 unsigned NumCases = Record[4];
4564 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4565 InstructionList.push_back(SI);
4567 unsigned CurIdx = 5;
4568 for (unsigned i = 0; i != NumCases; ++i) {
4569 SmallVector<ConstantInt*, 1> CaseVals;
4570 unsigned NumItems = Record[CurIdx++];
4571 for (unsigned ci = 0; ci != NumItems; ++ci) {
4572 bool isSingleNumber = Record[CurIdx++];
4575 unsigned ActiveWords = 1;
4576 if (ValueBitWidth > 64)
4577 ActiveWords = Record[CurIdx++];
4578 Low = readWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
4580 CurIdx += ActiveWords;
4582 if (!isSingleNumber) {
4584 if (ValueBitWidth > 64)
4585 ActiveWords = Record[CurIdx++];
4586 APInt High = readWideAPInt(
4587 makeArrayRef(&Record[CurIdx], ActiveWords), ValueBitWidth);
4588 CurIdx += ActiveWords;
4590 // FIXME: It is not clear whether values in the range should be
4591 // compared as signed or unsigned values. The partially
4592 // implemented changes that used this format in the past used
4593 // unsigned comparisons.
4594 for ( ; Low.ule(High); ++Low)
4595 CaseVals.push_back(ConstantInt::get(Context, Low));
4597 CaseVals.push_back(ConstantInt::get(Context, Low));
4599 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
4600 for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
4601 cve = CaseVals.end(); cvi != cve; ++cvi)
4602 SI->addCase(*cvi, DestBB);
4608 // Old SwitchInst format without case ranges.
4610 if (Record.size() < 3 || (Record.size() & 1) == 0)
4611 return error("Invalid record");
4612 Type *OpTy = getTypeByID(Record[0]);
4613 Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
4614 BasicBlock *Default = getBasicBlock(Record[2]);
4615 if (!OpTy || !Cond || !Default)
4616 return error("Invalid record");
4617 unsigned NumCases = (Record.size()-3)/2;
4618 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4619 InstructionList.push_back(SI);
4620 for (unsigned i = 0, e = NumCases; i != e; ++i) {
4621 ConstantInt *CaseVal =
4622 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
4623 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
4624 if (!CaseVal || !DestBB) {
4626 return error("Invalid record");
4628 SI->addCase(CaseVal, DestBB);
4633 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
4634 if (Record.size() < 2)
4635 return error("Invalid record");
4636 Type *OpTy = getTypeByID(Record[0]);
4637 Value *Address = getValue(Record, 1, NextValueNo, OpTy);
4638 if (!OpTy || !Address)
4639 return error("Invalid record");
4640 unsigned NumDests = Record.size()-2;
4641 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
4642 InstructionList.push_back(IBI);
4643 for (unsigned i = 0, e = NumDests; i != e; ++i) {
4644 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
4645 IBI->addDestination(DestBB);
4648 return error("Invalid record");
4655 case bitc::FUNC_CODE_INST_INVOKE: {
4656 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
4657 if (Record.size() < 4)
4658 return error("Invalid record");
4660 AttributeSet PAL = getAttributes(Record[OpNum++]);
4661 unsigned CCInfo = Record[OpNum++];
4662 BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);
4663 BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);
4665 FunctionType *FTy = nullptr;
4666 if (CCInfo >> 13 & 1 &&
4667 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
4668 return error("Explicit invoke type is not a function type");
4671 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
4672 return error("Invalid record");
4674 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
4676 return error("Callee is not a pointer");
4678 FTy = dyn_cast<FunctionType>(CalleeTy->getElementType());
4680 return error("Callee is not of pointer to function type");
4681 } else if (CalleeTy->getElementType() != FTy)
4682 return error("Explicit invoke type does not match pointee type of "
4684 if (Record.size() < FTy->getNumParams() + OpNum)
4685 return error("Insufficient operands to call");
4687 SmallVector<Value*, 16> Ops;
4688 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4689 Ops.push_back(getValue(Record, OpNum, NextValueNo,
4690 FTy->getParamType(i)));
4692 return error("Invalid record");
4695 if (!FTy->isVarArg()) {
4696 if (Record.size() != OpNum)
4697 return error("Invalid record");
4699 // Read type/value pairs for varargs params.
4700 while (OpNum != Record.size()) {
4702 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4703 return error("Invalid record");
4708 I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops, OperandBundles);
4709 OperandBundles.clear();
4710 InstructionList.push_back(I);
4711 cast<InvokeInst>(I)->setCallingConv(
4712 static_cast<CallingConv::ID>(CallingConv::MaxID & CCInfo));
4713 cast<InvokeInst>(I)->setAttributes(PAL);
4716 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
4718 Value *Val = nullptr;
4719 if (getValueTypePair(Record, Idx, NextValueNo, Val))
4720 return error("Invalid record");
4721 I = ResumeInst::Create(Val);
4722 InstructionList.push_back(I);
4725 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
4726 I = new UnreachableInst(Context);
4727 InstructionList.push_back(I);
4729 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
4730 if (Record.size() < 1 || ((Record.size()-1)&1))
4731 return error("Invalid record");
4732 Type *Ty = getTypeByID(Record[0]);
4734 return error("Invalid record");
4736 PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
4737 InstructionList.push_back(PN);
4739 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
4741 // With the new function encoding, it is possible that operands have
4742 // negative IDs (for forward references). Use a signed VBR
4743 // representation to keep the encoding small.
4745 V = getValueSigned(Record, 1+i, NextValueNo, Ty);
4747 V = getValue(Record, 1+i, NextValueNo, Ty);
4748 BasicBlock *BB = getBasicBlock(Record[2+i]);
4750 return error("Invalid record");
4751 PN->addIncoming(V, BB);
4757 case bitc::FUNC_CODE_INST_LANDINGPAD:
4758 case bitc::FUNC_CODE_INST_LANDINGPAD_OLD: {
4759 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
4761 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {
4762 if (Record.size() < 3)
4763 return error("Invalid record");
4765 assert(BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD);
4766 if (Record.size() < 4)
4767 return error("Invalid record");
4769 Type *Ty = getTypeByID(Record[Idx++]);
4771 return error("Invalid record");
4772 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {
4773 Value *PersFn = nullptr;
4774 if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
4775 return error("Invalid record");
4777 if (!F->hasPersonalityFn())
4778 F->setPersonalityFn(cast<Constant>(PersFn));
4779 else if (F->getPersonalityFn() != cast<Constant>(PersFn))
4780 return error("Personality function mismatch");
4783 bool IsCleanup = !!Record[Idx++];
4784 unsigned NumClauses = Record[Idx++];
4785 LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);
4786 LP->setCleanup(IsCleanup);
4787 for (unsigned J = 0; J != NumClauses; ++J) {
4788 LandingPadInst::ClauseType CT =
4789 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
4792 if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
4794 return error("Invalid record");
4797 assert((CT != LandingPadInst::Catch ||
4798 !isa<ArrayType>(Val->getType())) &&
4799 "Catch clause has a invalid type!");
4800 assert((CT != LandingPadInst::Filter ||
4801 isa<ArrayType>(Val->getType())) &&
4802 "Filter clause has invalid type!");
4803 LP->addClause(cast<Constant>(Val));
4807 InstructionList.push_back(I);
4811 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
4812 if (Record.size() != 4)
4813 return error("Invalid record");
4814 uint64_t AlignRecord = Record[3];
4815 const uint64_t InAllocaMask = uint64_t(1) << 5;
4816 const uint64_t ExplicitTypeMask = uint64_t(1) << 6;
4817 // Reserve bit 7 for SwiftError flag.
4818 // const uint64_t SwiftErrorMask = uint64_t(1) << 7;
4819 const uint64_t FlagMask = InAllocaMask | ExplicitTypeMask;
4820 bool InAlloca = AlignRecord & InAllocaMask;
4821 Type *Ty = getTypeByID(Record[0]);
4822 if ((AlignRecord & ExplicitTypeMask) == 0) {
4823 auto *PTy = dyn_cast_or_null<PointerType>(Ty);
4825 return error("Old-style alloca with a non-pointer type");
4826 Ty = PTy->getElementType();
4828 Type *OpTy = getTypeByID(Record[1]);
4829 Value *Size = getFnValueByID(Record[2], OpTy);
4831 if (std::error_code EC =
4832 parseAlignmentValue(AlignRecord & ~FlagMask, Align)) {
4836 return error("Invalid record");
4837 AllocaInst *AI = new AllocaInst(Ty, Size, Align);
4838 AI->setUsedWithInAlloca(InAlloca);
4840 InstructionList.push_back(I);
4843 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
4846 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4847 (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
4848 return error("Invalid record");
4851 if (OpNum + 3 == Record.size())
4852 Ty = getTypeByID(Record[OpNum++]);
4853 if (std::error_code EC = typeCheckLoadStoreInst(Ty, Op->getType()))
4856 Ty = cast<PointerType>(Op->getType())->getElementType();
4859 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4861 I = new LoadInst(Ty, Op, "", Record[OpNum + 1], Align);
4863 InstructionList.push_back(I);
4866 case bitc::FUNC_CODE_INST_LOADATOMIC: {
4867 // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
4870 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4871 (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
4872 return error("Invalid record");
4875 if (OpNum + 5 == Record.size())
4876 Ty = getTypeByID(Record[OpNum++]);
4877 if (std::error_code EC = typeCheckLoadStoreInst(Ty, Op->getType()))
4880 Ty = cast<PointerType>(Op->getType())->getElementType();
4882 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4883 if (Ordering == NotAtomic || Ordering == Release ||
4884 Ordering == AcquireRelease)
4885 return error("Invalid record");
4886 if (Ordering != NotAtomic && Record[OpNum] == 0)
4887 return error("Invalid record");
4888 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4891 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4893 I = new LoadInst(Op, "", Record[OpNum+1], Align, Ordering, SynchScope);
4895 InstructionList.push_back(I);
4898 case bitc::FUNC_CODE_INST_STORE:
4899 case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]
4902 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4903 (BitCode == bitc::FUNC_CODE_INST_STORE
4904 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4905 : popValue(Record, OpNum, NextValueNo,
4906 cast<PointerType>(Ptr->getType())->getElementType(),
4908 OpNum + 2 != Record.size())
4909 return error("Invalid record");
4911 if (std::error_code EC =
4912 typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
4915 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4917 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align);
4918 InstructionList.push_back(I);
4921 case bitc::FUNC_CODE_INST_STOREATOMIC:
4922 case bitc::FUNC_CODE_INST_STOREATOMIC_OLD: {
4923 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
4926 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4927 (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC
4928 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4929 : popValue(Record, OpNum, NextValueNo,
4930 cast<PointerType>(Ptr->getType())->getElementType(),
4932 OpNum + 4 != Record.size())
4933 return error("Invalid record");
4935 if (std::error_code EC =
4936 typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
4938 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4939 if (Ordering == NotAtomic || Ordering == Acquire ||
4940 Ordering == AcquireRelease)
4941 return error("Invalid record");
4942 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
4943 if (Ordering != NotAtomic && Record[OpNum] == 0)
4944 return error("Invalid record");
4947 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4949 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align, Ordering, SynchScope);
4950 InstructionList.push_back(I);
4953 case bitc::FUNC_CODE_INST_CMPXCHG_OLD:
4954 case bitc::FUNC_CODE_INST_CMPXCHG: {
4955 // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
4956 // failureordering?, isweak?]
4958 Value *Ptr, *Cmp, *New;
4959 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4960 (BitCode == bitc::FUNC_CODE_INST_CMPXCHG
4961 ? getValueTypePair(Record, OpNum, NextValueNo, Cmp)
4962 : popValue(Record, OpNum, NextValueNo,
4963 cast<PointerType>(Ptr->getType())->getElementType(),
4965 popValue(Record, OpNum, NextValueNo, Cmp->getType(), New) ||
4966 Record.size() < OpNum + 3 || Record.size() > OpNum + 5)
4967 return error("Invalid record");
4968 AtomicOrdering SuccessOrdering = getDecodedOrdering(Record[OpNum + 1]);
4969 if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
4970 return error("Invalid record");
4971 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 2]);
4973 if (std::error_code EC =
4974 typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))
4976 AtomicOrdering FailureOrdering;
4977 if (Record.size() < 7)
4979 AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
4981 FailureOrdering = getDecodedOrdering(Record[OpNum + 3]);
4983 I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
4985 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
4987 if (Record.size() < 8) {
4988 // Before weak cmpxchgs existed, the instruction simply returned the
4989 // value loaded from memory, so bitcode files from that era will be
4990 // expecting the first component of a modern cmpxchg.
4991 CurBB->getInstList().push_back(I);
4992 I = ExtractValueInst::Create(I, 0);
4994 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
4997 InstructionList.push_back(I);
5000 case bitc::FUNC_CODE_INST_ATOMICRMW: {
5001 // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
5004 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
5005 popValue(Record, OpNum, NextValueNo,
5006 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
5007 OpNum+4 != Record.size())
5008 return error("Invalid record");
5009 AtomicRMWInst::BinOp Operation = getDecodedRMWOperation(Record[OpNum]);
5010 if (Operation < AtomicRMWInst::FIRST_BINOP ||
5011 Operation > AtomicRMWInst::LAST_BINOP)
5012 return error("Invalid record");
5013 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
5014 if (Ordering == NotAtomic || Ordering == Unordered)
5015 return error("Invalid record");
5016 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
5017 I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
5018 cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
5019 InstructionList.push_back(I);
5022 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
5023 if (2 != Record.size())
5024 return error("Invalid record");
5025 AtomicOrdering Ordering = getDecodedOrdering(Record[0]);
5026 if (Ordering == NotAtomic || Ordering == Unordered ||
5027 Ordering == Monotonic)
5028 return error("Invalid record");
5029 SynchronizationScope SynchScope = getDecodedSynchScope(Record[1]);
5030 I = new FenceInst(Context, Ordering, SynchScope);
5031 InstructionList.push_back(I);
5034 case bitc::FUNC_CODE_INST_CALL: {
5035 // CALL: [paramattrs, cc, fmf, fnty, fnid, arg0, arg1...]
5036 if (Record.size() < 3)
5037 return error("Invalid record");
5040 AttributeSet PAL = getAttributes(Record[OpNum++]);
5041 unsigned CCInfo = Record[OpNum++];
5044 if ((CCInfo >> bitc::CALL_FMF) & 1) {
5045 FMF = getDecodedFastMathFlags(Record[OpNum++]);
5047 return error("Fast math flags indicator set for call with no FMF");
5050 FunctionType *FTy = nullptr;
5051 if (CCInfo >> bitc::CALL_EXPLICIT_TYPE & 1 &&
5052 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
5053 return error("Explicit call type is not a function type");
5056 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
5057 return error("Invalid record");
5059 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
5061 return error("Callee is not a pointer type");
5063 FTy = dyn_cast<FunctionType>(OpTy->getElementType());
5065 return error("Callee is not of pointer to function type");
5066 } else if (OpTy->getElementType() != FTy)
5067 return error("Explicit call type does not match pointee type of "
5069 if (Record.size() < FTy->getNumParams() + OpNum)
5070 return error("Insufficient operands to call");
5072 SmallVector<Value*, 16> Args;
5073 // Read the fixed params.
5074 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
5075 if (FTy->getParamType(i)->isLabelTy())
5076 Args.push_back(getBasicBlock(Record[OpNum]));
5078 Args.push_back(getValue(Record, OpNum, NextValueNo,
5079 FTy->getParamType(i)));
5081 return error("Invalid record");
5084 // Read type/value pairs for varargs params.
5085 if (!FTy->isVarArg()) {
5086 if (OpNum != Record.size())
5087 return error("Invalid record");
5089 while (OpNum != Record.size()) {
5091 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
5092 return error("Invalid record");
5097 I = CallInst::Create(FTy, Callee, Args, OperandBundles);
5098 OperandBundles.clear();
5099 InstructionList.push_back(I);
5100 cast<CallInst>(I)->setCallingConv(
5101 static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));
5102 CallInst::TailCallKind TCK = CallInst::TCK_None;
5103 if (CCInfo & 1 << bitc::CALL_TAIL)
5104 TCK = CallInst::TCK_Tail;
5105 if (CCInfo & (1 << bitc::CALL_MUSTTAIL))
5106 TCK = CallInst::TCK_MustTail;
5107 if (CCInfo & (1 << bitc::CALL_NOTAIL))
5108 TCK = CallInst::TCK_NoTail;
5109 cast<CallInst>(I)->setTailCallKind(TCK);
5110 cast<CallInst>(I)->setAttributes(PAL);
5112 if (!isa<FPMathOperator>(I))
5113 return error("Fast-math-flags specified for call without "
5114 "floating-point scalar or vector return type");
5115 I->setFastMathFlags(FMF);
5119 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
5120 if (Record.size() < 3)
5121 return error("Invalid record");
5122 Type *OpTy = getTypeByID(Record[0]);
5123 Value *Op = getValue(Record, 1, NextValueNo, OpTy);
5124 Type *ResTy = getTypeByID(Record[2]);
5125 if (!OpTy || !Op || !ResTy)
5126 return error("Invalid record");
5127 I = new VAArgInst(Op, ResTy);
5128 InstructionList.push_back(I);
5132 case bitc::FUNC_CODE_OPERAND_BUNDLE: {
5133 // A call or an invoke can be optionally prefixed with some variable
5134 // number of operand bundle blocks. These blocks are read into
5135 // OperandBundles and consumed at the next call or invoke instruction.
5137 if (Record.size() < 1 || Record[0] >= BundleTags.size())
5138 return error("Invalid record");
5140 std::vector<Value *> Inputs;
5143 while (OpNum != Record.size()) {
5145 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
5146 return error("Invalid record");
5147 Inputs.push_back(Op);
5150 OperandBundles.emplace_back(BundleTags[Record[0]], std::move(Inputs));
5155 // Add instruction to end of current BB. If there is no current BB, reject
5159 return error("Invalid instruction with no BB");
5161 if (!OperandBundles.empty()) {
5163 return error("Operand bundles found with no consumer");
5165 CurBB->getInstList().push_back(I);
5167 // If this was a terminator instruction, move to the next block.
5168 if (isa<TerminatorInst>(I)) {
5170 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
5173 // Non-void values get registered in the value table for future use.
5174 if (I && !I->getType()->isVoidTy())
5175 ValueList.assignValue(I, NextValueNo++);
5180 if (!OperandBundles.empty())
5181 return error("Operand bundles found with no consumer");
5183 // Check the function list for unresolved values.
5184 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
5185 if (!A->getParent()) {
5186 // We found at least one unresolved value. Nuke them all to avoid leaks.
5187 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
5188 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
5189 A->replaceAllUsesWith(UndefValue::get(A->getType()));
5193 return error("Never resolved value found in function");
5197 // FIXME: Check for unresolved forward-declared metadata references
5198 // and clean up leaks.
5200 // Trim the value list down to the size it was before we parsed this function.
5201 ValueList.shrinkTo(ModuleValueListSize);
5202 MetadataList.shrinkTo(ModuleMetadataListSize);
5203 std::vector<BasicBlock*>().swap(FunctionBBs);
5204 return std::error_code();
5207 /// Find the function body in the bitcode stream
5208 std::error_code BitcodeReader::findFunctionInStream(
5210 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
5211 while (DeferredFunctionInfoIterator->second == 0) {
5212 // This is the fallback handling for the old format bitcode that
5213 // didn't contain the function index in the VST, or when we have
5214 // an anonymous function which would not have a VST entry.
5215 // Assert that we have one of those two cases.
5216 assert(VSTOffset == 0 || !F->hasName());
5217 // Parse the next body in the stream and set its position in the
5218 // DeferredFunctionInfo map.
5219 if (std::error_code EC = rememberAndSkipFunctionBodies())
5222 return std::error_code();
5225 //===----------------------------------------------------------------------===//
5226 // GVMaterializer implementation
5227 //===----------------------------------------------------------------------===//
5229 void BitcodeReader::releaseBuffer() { Buffer.release(); }
5231 std::error_code BitcodeReader::materialize(GlobalValue *GV) {
5232 // In older bitcode we must materialize the metadata before parsing
5233 // any functions, in order to set up the MetadataList properly.
5234 if (!SeenModuleValuesRecord) {
5235 if (std::error_code EC = materializeMetadata())
5239 Function *F = dyn_cast<Function>(GV);
5240 // If it's not a function or is already material, ignore the request.
5241 if (!F || !F->isMaterializable())
5242 return std::error_code();
5244 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
5245 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
5246 // If its position is recorded as 0, its body is somewhere in the stream
5247 // but we haven't seen it yet.
5248 if (DFII->second == 0)
5249 if (std::error_code EC = findFunctionInStream(F, DFII))
5252 // Move the bit stream to the saved position of the deferred function body.
5253 Stream.JumpToBit(DFII->second);
5255 if (std::error_code EC = parseFunctionBody(F))
5257 F->setIsMaterializable(false);
5262 // Upgrade any old intrinsic calls in the function.
5263 for (auto &I : UpgradedIntrinsics) {
5264 for (auto UI = I.first->materialized_user_begin(), UE = I.first->user_end();
5268 if (CallInst *CI = dyn_cast<CallInst>(U))
5269 UpgradeIntrinsicCall(CI, I.second);
5273 // Finish fn->subprogram upgrade for materialized functions.
5274 if (DISubprogram *SP = FunctionsWithSPs.lookup(F))
5275 F->setSubprogram(SP);
5277 // Bring in any functions that this function forward-referenced via
5279 return materializeForwardReferencedFunctions();
5282 std::error_code BitcodeReader::materializeModule() {
5283 if (std::error_code EC = materializeMetadata())
5286 // Promise to materialize all forward references.
5287 WillMaterializeAllForwardRefs = true;
5289 // Iterate over the module, deserializing any functions that are still on
5291 for (Function &F : *TheModule) {
5292 if (std::error_code EC = materialize(&F))
5295 // At this point, if there are any function bodies, parse the rest of
5296 // the bits in the module past the last function block we have recorded
5297 // through either lazy scanning or the VST.
5298 if (LastFunctionBlockBit || NextUnreadBit)
5299 parseModule(LastFunctionBlockBit > NextUnreadBit ? LastFunctionBlockBit
5302 // Check that all block address forward references got resolved (as we
5304 if (!BasicBlockFwdRefs.empty())
5305 return error("Never resolved function from blockaddress");
5307 // Upgrade any intrinsic calls that slipped through (should not happen!) and
5308 // delete the old functions to clean up. We can't do this unless the entire
5309 // module is materialized because there could always be another function body
5310 // with calls to the old function.
5311 for (auto &I : UpgradedIntrinsics) {
5312 for (auto *U : I.first->users()) {
5313 if (CallInst *CI = dyn_cast<CallInst>(U))
5314 UpgradeIntrinsicCall(CI, I.second);
5316 if (!I.first->use_empty())
5317 I.first->replaceAllUsesWith(I.second);
5318 I.first->eraseFromParent();
5320 UpgradedIntrinsics.clear();
5322 for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
5323 UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
5325 UpgradeDebugInfo(*TheModule);
5326 return std::error_code();
5329 std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
5330 return IdentifiedStructTypes;
5334 BitcodeReader::initStream(std::unique_ptr<DataStreamer> Streamer) {
5336 return initLazyStream(std::move(Streamer));
5337 return initStreamFromBuffer();
5340 std::error_code BitcodeReader::initStreamFromBuffer() {
5341 const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
5342 const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
5344 if (Buffer->getBufferSize() & 3)
5345 return error("Invalid bitcode signature");
5347 // If we have a wrapper header, parse it and ignore the non-bc file contents.
5348 // The magic number is 0x0B17C0DE stored in little endian.
5349 if (isBitcodeWrapper(BufPtr, BufEnd))
5350 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
5351 return error("Invalid bitcode wrapper header");
5353 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
5354 Stream.init(&*StreamFile);
5356 return std::error_code();
5360 BitcodeReader::initLazyStream(std::unique_ptr<DataStreamer> Streamer) {
5361 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
5364 llvm::make_unique<StreamingMemoryObject>(std::move(Streamer));
5365 StreamingMemoryObject &Bytes = *OwnedBytes;
5366 StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
5367 Stream.init(&*StreamFile);
5369 unsigned char buf[16];
5370 if (Bytes.readBytes(buf, 16, 0) != 16)
5371 return error("Invalid bitcode signature");
5373 if (!isBitcode(buf, buf + 16))
5374 return error("Invalid bitcode signature");
5376 if (isBitcodeWrapper(buf, buf + 4)) {
5377 const unsigned char *bitcodeStart = buf;
5378 const unsigned char *bitcodeEnd = buf + 16;
5379 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
5380 Bytes.dropLeadingBytes(bitcodeStart - buf);
5381 Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
5383 return std::error_code();
5386 std::error_code FunctionIndexBitcodeReader::error(BitcodeError E,
5387 const Twine &Message) {
5388 return ::error(DiagnosticHandler, make_error_code(E), Message);
5391 std::error_code FunctionIndexBitcodeReader::error(const Twine &Message) {
5392 return ::error(DiagnosticHandler,
5393 make_error_code(BitcodeError::CorruptedBitcode), Message);
5396 std::error_code FunctionIndexBitcodeReader::error(BitcodeError E) {
5397 return ::error(DiagnosticHandler, make_error_code(E));
5400 FunctionIndexBitcodeReader::FunctionIndexBitcodeReader(
5401 MemoryBuffer *Buffer, DiagnosticHandlerFunction DiagnosticHandler,
5402 bool IsLazy, bool CheckFuncSummaryPresenceOnly)
5403 : DiagnosticHandler(DiagnosticHandler), Buffer(Buffer), IsLazy(IsLazy),
5404 CheckFuncSummaryPresenceOnly(CheckFuncSummaryPresenceOnly) {}
5406 FunctionIndexBitcodeReader::FunctionIndexBitcodeReader(
5407 DiagnosticHandlerFunction DiagnosticHandler, bool IsLazy,
5408 bool CheckFuncSummaryPresenceOnly)
5409 : DiagnosticHandler(DiagnosticHandler), Buffer(nullptr), IsLazy(IsLazy),
5410 CheckFuncSummaryPresenceOnly(CheckFuncSummaryPresenceOnly) {}
5412 void FunctionIndexBitcodeReader::freeState() { Buffer = nullptr; }
5414 void FunctionIndexBitcodeReader::releaseBuffer() { Buffer.release(); }
5416 // Specialized value symbol table parser used when reading function index
5417 // blocks where we don't actually create global values.
5418 // At the end of this routine the function index is populated with a map
5419 // from function name to FunctionInfo. The function info contains
5420 // the function block's bitcode offset as well as the offset into the
5421 // function summary section.
5422 std::error_code FunctionIndexBitcodeReader::parseValueSymbolTable() {
5423 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
5424 return error("Invalid record");
5426 SmallVector<uint64_t, 64> Record;
5428 // Read all the records for this value table.
5429 SmallString<128> ValueName;
5431 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5433 switch (Entry.Kind) {
5434 case BitstreamEntry::SubBlock: // Handled for us already.
5435 case BitstreamEntry::Error:
5436 return error("Malformed block");
5437 case BitstreamEntry::EndBlock:
5438 return std::error_code();
5439 case BitstreamEntry::Record:
5440 // The interesting case.
5446 switch (Stream.readRecord(Entry.ID, Record)) {
5447 default: // Default behavior: ignore (e.g. VST_CODE_BBENTRY records).
5449 case bitc::VST_CODE_FNENTRY: {
5450 // VST_FNENTRY: [valueid, offset, namechar x N]
5451 if (convertToString(Record, 2, ValueName))
5452 return error("Invalid record");
5453 unsigned ValueID = Record[0];
5454 uint64_t FuncOffset = Record[1];
5455 std::unique_ptr<FunctionInfo> FuncInfo =
5456 llvm::make_unique<FunctionInfo>(FuncOffset);
5457 if (foundFuncSummary() && !IsLazy) {
5458 DenseMap<uint64_t, std::unique_ptr<FunctionSummary>>::iterator SMI =
5459 SummaryMap.find(ValueID);
5460 assert(SMI != SummaryMap.end() && "Summary info not found");
5461 FuncInfo->setFunctionSummary(std::move(SMI->second));
5463 TheIndex->addFunctionInfo(ValueName, std::move(FuncInfo));
5468 case bitc::VST_CODE_COMBINED_FNENTRY: {
5469 // VST_FNENTRY: [offset, namechar x N]
5470 if (convertToString(Record, 1, ValueName))
5471 return error("Invalid record");
5472 uint64_t FuncSummaryOffset = Record[0];
5473 std::unique_ptr<FunctionInfo> FuncInfo =
5474 llvm::make_unique<FunctionInfo>(FuncSummaryOffset);
5475 if (foundFuncSummary() && !IsLazy) {
5476 DenseMap<uint64_t, std::unique_ptr<FunctionSummary>>::iterator SMI =
5477 SummaryMap.find(FuncSummaryOffset);
5478 assert(SMI != SummaryMap.end() && "Summary info not found");
5479 FuncInfo->setFunctionSummary(std::move(SMI->second));
5481 TheIndex->addFunctionInfo(ValueName, std::move(FuncInfo));
5490 // Parse just the blocks needed for function index building out of the module.
5491 // At the end of this routine the function Index is populated with a map
5492 // from function name to FunctionInfo. The function info contains
5493 // either the parsed function summary information (when parsing summaries
5494 // eagerly), or just to the function summary record's offset
5495 // if parsing lazily (IsLazy).
5496 std::error_code FunctionIndexBitcodeReader::parseModule() {
5497 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
5498 return error("Invalid record");
5500 // Read the function index for this module.
5502 BitstreamEntry Entry = Stream.advance();
5504 switch (Entry.Kind) {
5505 case BitstreamEntry::Error:
5506 return error("Malformed block");
5507 case BitstreamEntry::EndBlock:
5508 return std::error_code();
5510 case BitstreamEntry::SubBlock:
5511 if (CheckFuncSummaryPresenceOnly) {
5512 if (Entry.ID == bitc::FUNCTION_SUMMARY_BLOCK_ID) {
5513 SeenFuncSummary = true;
5514 // No need to parse the rest since we found the summary.
5515 return std::error_code();
5517 if (Stream.SkipBlock())
5518 return error("Invalid record");
5522 default: // Skip unknown content.
5523 if (Stream.SkipBlock())
5524 return error("Invalid record");
5526 case bitc::BLOCKINFO_BLOCK_ID:
5527 // Need to parse these to get abbrev ids (e.g. for VST)
5528 if (Stream.ReadBlockInfoBlock())
5529 return error("Malformed block");
5531 case bitc::VALUE_SYMTAB_BLOCK_ID:
5532 if (std::error_code EC = parseValueSymbolTable())
5535 case bitc::FUNCTION_SUMMARY_BLOCK_ID:
5536 SeenFuncSummary = true;
5538 // Lazy parsing of summary info, skip it.
5539 if (Stream.SkipBlock())
5540 return error("Invalid record");
5541 } else if (std::error_code EC = parseEntireSummary())
5544 case bitc::MODULE_STRTAB_BLOCK_ID:
5545 if (std::error_code EC = parseModuleStringTable())
5551 case BitstreamEntry::Record:
5552 Stream.skipRecord(Entry.ID);
5558 // Eagerly parse the entire function summary block (i.e. for all functions
5559 // in the index). This populates the FunctionSummary objects in
5561 std::error_code FunctionIndexBitcodeReader::parseEntireSummary() {
5562 if (Stream.EnterSubBlock(bitc::FUNCTION_SUMMARY_BLOCK_ID))
5563 return error("Invalid record");
5565 SmallVector<uint64_t, 64> Record;
5568 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5570 switch (Entry.Kind) {
5571 case BitstreamEntry::SubBlock: // Handled for us already.
5572 case BitstreamEntry::Error:
5573 return error("Malformed block");
5574 case BitstreamEntry::EndBlock:
5575 return std::error_code();
5576 case BitstreamEntry::Record:
5577 // The interesting case.
5581 // Read a record. The record format depends on whether this
5582 // is a per-module index or a combined index file. In the per-module
5583 // case the records contain the associated value's ID for correlation
5584 // with VST entries. In the combined index the correlation is done
5585 // via the bitcode offset of the summary records (which were saved
5586 // in the combined index VST entries). The records also contain
5587 // information used for ThinLTO renaming and importing.
5589 uint64_t CurRecordBit = Stream.GetCurrentBitNo();
5590 switch (Stream.readRecord(Entry.ID, Record)) {
5591 default: // Default behavior: ignore.
5593 // FS_PERMODULE_ENTRY: [valueid, islocal, instcount]
5594 case bitc::FS_CODE_PERMODULE_ENTRY: {
5595 unsigned ValueID = Record[0];
5596 bool IsLocal = Record[1];
5597 unsigned InstCount = Record[2];
5598 std::unique_ptr<FunctionSummary> FS =
5599 llvm::make_unique<FunctionSummary>(InstCount);
5600 FS->setLocalFunction(IsLocal);
5601 // The module path string ref set in the summary must be owned by the
5602 // index's module string table. Since we don't have a module path
5603 // string table section in the per-module index, we create a single
5604 // module path string table entry with an empty (0) ID to take
5607 TheIndex->addModulePath(Buffer->getBufferIdentifier(), 0));
5608 SummaryMap[ValueID] = std::move(FS);
5610 // FS_COMBINED_ENTRY: [modid, instcount]
5611 case bitc::FS_CODE_COMBINED_ENTRY: {
5612 uint64_t ModuleId = Record[0];
5613 unsigned InstCount = Record[1];
5614 std::unique_ptr<FunctionSummary> FS =
5615 llvm::make_unique<FunctionSummary>(InstCount);
5616 FS->setModulePath(ModuleIdMap[ModuleId]);
5617 SummaryMap[CurRecordBit] = std::move(FS);
5621 llvm_unreachable("Exit infinite loop");
5624 // Parse the module string table block into the Index.
5625 // This populates the ModulePathStringTable map in the index.
5626 std::error_code FunctionIndexBitcodeReader::parseModuleStringTable() {
5627 if (Stream.EnterSubBlock(bitc::MODULE_STRTAB_BLOCK_ID))
5628 return error("Invalid record");
5630 SmallVector<uint64_t, 64> Record;
5632 SmallString<128> ModulePath;
5634 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5636 switch (Entry.Kind) {
5637 case BitstreamEntry::SubBlock: // Handled for us already.
5638 case BitstreamEntry::Error:
5639 return error("Malformed block");
5640 case BitstreamEntry::EndBlock:
5641 return std::error_code();
5642 case BitstreamEntry::Record:
5643 // The interesting case.
5648 switch (Stream.readRecord(Entry.ID, Record)) {
5649 default: // Default behavior: ignore.
5651 case bitc::MST_CODE_ENTRY: {
5652 // MST_ENTRY: [modid, namechar x N]
5653 if (convertToString(Record, 1, ModulePath))
5654 return error("Invalid record");
5655 uint64_t ModuleId = Record[0];
5656 StringRef ModulePathInMap = TheIndex->addModulePath(ModulePath, ModuleId);
5657 ModuleIdMap[ModuleId] = ModulePathInMap;
5663 llvm_unreachable("Exit infinite loop");
5666 // Parse the function info index from the bitcode streamer into the given index.
5667 std::error_code FunctionIndexBitcodeReader::parseSummaryIndexInto(
5668 std::unique_ptr<DataStreamer> Streamer, FunctionInfoIndex *I) {
5671 if (std::error_code EC = initStream(std::move(Streamer)))
5674 // Sniff for the signature.
5675 if (!hasValidBitcodeHeader(Stream))
5676 return error("Invalid bitcode signature");
5678 // We expect a number of well-defined blocks, though we don't necessarily
5679 // need to understand them all.
5681 if (Stream.AtEndOfStream()) {
5682 // We didn't really read a proper Module block.
5683 return error("Malformed block");
5686 BitstreamEntry Entry =
5687 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
5689 if (Entry.Kind != BitstreamEntry::SubBlock)
5690 return error("Malformed block");
5692 // If we see a MODULE_BLOCK, parse it to find the blocks needed for
5693 // building the function summary index.
5694 if (Entry.ID == bitc::MODULE_BLOCK_ID)
5695 return parseModule();
5697 if (Stream.SkipBlock())
5698 return error("Invalid record");
5702 // Parse the function information at the given offset in the buffer into
5703 // the index. Used to support lazy parsing of function summaries from the
5704 // combined index during importing.
5705 // TODO: This function is not yet complete as it won't have a consumer
5706 // until ThinLTO function importing is added.
5707 std::error_code FunctionIndexBitcodeReader::parseFunctionSummary(
5708 std::unique_ptr<DataStreamer> Streamer, FunctionInfoIndex *I,
5709 size_t FunctionSummaryOffset) {
5712 if (std::error_code EC = initStream(std::move(Streamer)))
5715 // Sniff for the signature.
5716 if (!hasValidBitcodeHeader(Stream))
5717 return error("Invalid bitcode signature");
5719 Stream.JumpToBit(FunctionSummaryOffset);
5721 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5723 switch (Entry.Kind) {
5725 return error("Malformed block");
5726 case BitstreamEntry::Record:
5727 // The expected case.
5731 // TODO: Read a record. This interface will be completed when ThinLTO
5732 // importing is added so that it can be tested.
5733 SmallVector<uint64_t, 64> Record;
5734 switch (Stream.readRecord(Entry.ID, Record)) {
5735 case bitc::FS_CODE_COMBINED_ENTRY:
5737 return error("Invalid record");
5740 return std::error_code();
5744 FunctionIndexBitcodeReader::initStream(std::unique_ptr<DataStreamer> Streamer) {
5746 return initLazyStream(std::move(Streamer));
5747 return initStreamFromBuffer();
5750 std::error_code FunctionIndexBitcodeReader::initStreamFromBuffer() {
5751 const unsigned char *BufPtr = (const unsigned char *)Buffer->getBufferStart();
5752 const unsigned char *BufEnd = BufPtr + Buffer->getBufferSize();
5754 if (Buffer->getBufferSize() & 3)
5755 return error("Invalid bitcode signature");
5757 // If we have a wrapper header, parse it and ignore the non-bc file contents.
5758 // The magic number is 0x0B17C0DE stored in little endian.
5759 if (isBitcodeWrapper(BufPtr, BufEnd))
5760 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
5761 return error("Invalid bitcode wrapper header");
5763 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
5764 Stream.init(&*StreamFile);
5766 return std::error_code();
5769 std::error_code FunctionIndexBitcodeReader::initLazyStream(
5770 std::unique_ptr<DataStreamer> Streamer) {
5771 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
5774 llvm::make_unique<StreamingMemoryObject>(std::move(Streamer));
5775 StreamingMemoryObject &Bytes = *OwnedBytes;
5776 StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
5777 Stream.init(&*StreamFile);
5779 unsigned char buf[16];
5780 if (Bytes.readBytes(buf, 16, 0) != 16)
5781 return error("Invalid bitcode signature");
5783 if (!isBitcode(buf, buf + 16))
5784 return error("Invalid bitcode signature");
5786 if (isBitcodeWrapper(buf, buf + 4)) {
5787 const unsigned char *bitcodeStart = buf;
5788 const unsigned char *bitcodeEnd = buf + 16;
5789 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
5790 Bytes.dropLeadingBytes(bitcodeStart - buf);
5791 Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
5793 return std::error_code();
5797 class BitcodeErrorCategoryType : public std::error_category {
5798 const char *name() const LLVM_NOEXCEPT override {
5799 return "llvm.bitcode";
5801 std::string message(int IE) const override {
5802 BitcodeError E = static_cast<BitcodeError>(IE);
5804 case BitcodeError::InvalidBitcodeSignature:
5805 return "Invalid bitcode signature";
5806 case BitcodeError::CorruptedBitcode:
5807 return "Corrupted bitcode";
5809 llvm_unreachable("Unknown error type!");
5814 static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
5816 const std::error_category &llvm::BitcodeErrorCategory() {
5817 return *ErrorCategory;
5820 //===----------------------------------------------------------------------===//
5821 // External interface
5822 //===----------------------------------------------------------------------===//
5824 static ErrorOr<std::unique_ptr<Module>>
5825 getBitcodeModuleImpl(std::unique_ptr<DataStreamer> Streamer, StringRef Name,
5826 BitcodeReader *R, LLVMContext &Context,
5827 bool MaterializeAll, bool ShouldLazyLoadMetadata) {
5828 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
5829 M->setMaterializer(R);
5831 auto cleanupOnError = [&](std::error_code EC) {
5832 R->releaseBuffer(); // Never take ownership on error.
5836 // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
5837 if (std::error_code EC = R->parseBitcodeInto(std::move(Streamer), M.get(),
5838 ShouldLazyLoadMetadata))
5839 return cleanupOnError(EC);
5841 if (MaterializeAll) {
5842 // Read in the entire module, and destroy the BitcodeReader.
5843 if (std::error_code EC = M->materializeAll())
5844 return cleanupOnError(EC);
5846 // Resolve forward references from blockaddresses.
5847 if (std::error_code EC = R->materializeForwardReferencedFunctions())
5848 return cleanupOnError(EC);
5850 return std::move(M);
5853 /// \brief Get a lazy one-at-time loading module from bitcode.
5855 /// This isn't always used in a lazy context. In particular, it's also used by
5856 /// \a parseBitcodeFile(). If this is truly lazy, then we need to eagerly pull
5857 /// in forward-referenced functions from block address references.
5859 /// \param[in] MaterializeAll Set to \c true if we should materialize
5861 static ErrorOr<std::unique_ptr<Module>>
5862 getLazyBitcodeModuleImpl(std::unique_ptr<MemoryBuffer> &&Buffer,
5863 LLVMContext &Context, bool MaterializeAll,
5864 bool ShouldLazyLoadMetadata = false) {
5865 BitcodeReader *R = new BitcodeReader(Buffer.get(), Context);
5867 ErrorOr<std::unique_ptr<Module>> Ret =
5868 getBitcodeModuleImpl(nullptr, Buffer->getBufferIdentifier(), R, Context,
5869 MaterializeAll, ShouldLazyLoadMetadata);
5873 Buffer.release(); // The BitcodeReader owns it now.
5877 ErrorOr<std::unique_ptr<Module>>
5878 llvm::getLazyBitcodeModule(std::unique_ptr<MemoryBuffer> &&Buffer,
5879 LLVMContext &Context, bool ShouldLazyLoadMetadata) {
5880 return getLazyBitcodeModuleImpl(std::move(Buffer), Context, false,
5881 ShouldLazyLoadMetadata);
5884 ErrorOr<std::unique_ptr<Module>>
5885 llvm::getStreamedBitcodeModule(StringRef Name,
5886 std::unique_ptr<DataStreamer> Streamer,
5887 LLVMContext &Context) {
5888 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
5889 BitcodeReader *R = new BitcodeReader(Context);
5891 return getBitcodeModuleImpl(std::move(Streamer), Name, R, Context, false,
5895 ErrorOr<std::unique_ptr<Module>> llvm::parseBitcodeFile(MemoryBufferRef Buffer,
5896 LLVMContext &Context) {
5897 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5898 return getLazyBitcodeModuleImpl(std::move(Buf), Context, true);
5899 // TODO: Restore the use-lists to the in-memory state when the bitcode was
5900 // written. We must defer until the Module has been fully materialized.
5903 std::string llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer,
5904 LLVMContext &Context) {
5905 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5906 auto R = llvm::make_unique<BitcodeReader>(Buf.release(), Context);
5907 ErrorOr<std::string> Triple = R->parseTriple();
5908 if (Triple.getError())
5910 return Triple.get();
5913 std::string llvm::getBitcodeProducerString(MemoryBufferRef Buffer,
5914 LLVMContext &Context) {
5915 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5916 BitcodeReader R(Buf.release(), Context);
5917 ErrorOr<std::string> ProducerString = R.parseIdentificationBlock();
5918 if (ProducerString.getError())
5920 return ProducerString.get();
5923 // Parse the specified bitcode buffer, returning the function info index.
5924 // If IsLazy is false, parse the entire function summary into
5925 // the index. Otherwise skip the function summary section, and only create
5926 // an index object with a map from function name to function summary offset.
5927 // The index is used to perform lazy function summary reading later.
5928 ErrorOr<std::unique_ptr<FunctionInfoIndex>>
5929 llvm::getFunctionInfoIndex(MemoryBufferRef Buffer,
5930 DiagnosticHandlerFunction DiagnosticHandler,
5932 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5933 FunctionIndexBitcodeReader R(Buf.get(), DiagnosticHandler, IsLazy);
5935 auto Index = llvm::make_unique<FunctionInfoIndex>();
5937 auto cleanupOnError = [&](std::error_code EC) {
5938 R.releaseBuffer(); // Never take ownership on error.
5942 if (std::error_code EC = R.parseSummaryIndexInto(nullptr, Index.get()))
5943 return cleanupOnError(EC);
5945 Buf.release(); // The FunctionIndexBitcodeReader owns it now.
5946 return std::move(Index);
5949 // Check if the given bitcode buffer contains a function summary block.
5950 bool llvm::hasFunctionSummary(MemoryBufferRef Buffer,
5951 DiagnosticHandlerFunction DiagnosticHandler) {
5952 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5953 FunctionIndexBitcodeReader R(Buf.get(), DiagnosticHandler, false, true);
5955 auto cleanupOnError = [&](std::error_code EC) {
5956 R.releaseBuffer(); // Never take ownership on error.
5960 if (std::error_code EC = R.parseSummaryIndexInto(nullptr, nullptr))
5961 return cleanupOnError(EC);
5963 Buf.release(); // The FunctionIndexBitcodeReader owns it now.
5964 return R.foundFuncSummary();
5967 // This method supports lazy reading of function summary data from the combined
5968 // index during ThinLTO function importing. When reading the combined index
5969 // file, getFunctionInfoIndex is first invoked with IsLazy=true.
5970 // Then this method is called for each function considered for importing,
5971 // to parse the summary information for the given function name into
5973 std::error_code llvm::readFunctionSummary(
5974 MemoryBufferRef Buffer, DiagnosticHandlerFunction DiagnosticHandler,
5975 StringRef FunctionName, std::unique_ptr<FunctionInfoIndex> Index) {
5976 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
5977 FunctionIndexBitcodeReader R(Buf.get(), DiagnosticHandler);
5979 auto cleanupOnError = [&](std::error_code EC) {
5980 R.releaseBuffer(); // Never take ownership on error.
5984 // Lookup the given function name in the FunctionMap, which may
5985 // contain a list of function infos in the case of a COMDAT. Walk through
5986 // and parse each function summary info at the function summary offset
5987 // recorded when parsing the value symbol table.
5988 for (const auto &FI : Index->getFunctionInfoList(FunctionName)) {
5989 size_t FunctionSummaryOffset = FI->bitcodeIndex();
5990 if (std::error_code EC =
5991 R.parseFunctionSummary(nullptr, Index.get(), FunctionSummaryOffset))
5992 return cleanupOnError(EC);
5995 Buf.release(); // The FunctionIndexBitcodeReader owns it now.
5996 return std::error_code();