1 //===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Bitcode/ReaderWriter.h"
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/Triple.h"
15 #include "llvm/Bitcode/BitstreamReader.h"
16 #include "llvm/Bitcode/LLVMBitCodes.h"
17 #include "llvm/IR/AutoUpgrade.h"
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DebugInfo.h"
20 #include "llvm/IR/DebugInfoMetadata.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/DiagnosticPrinter.h"
23 #include "llvm/IR/GVMaterializer.h"
24 #include "llvm/IR/InlineAsm.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/OperandTraits.h"
29 #include "llvm/IR/Operator.h"
30 #include "llvm/IR/ValueHandle.h"
31 #include "llvm/Support/DataStream.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/MemoryBuffer.h"
35 #include "llvm/Support/raw_ostream.h"
41 SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
44 class BitcodeReaderValueList {
45 std::vector<WeakVH> ValuePtrs;
47 /// ResolveConstants - As we resolve forward-referenced constants, we add
48 /// information about them to this vector. This allows us to resolve them in
49 /// bulk instead of resolving each reference at a time. See the code in
50 /// ResolveConstantForwardRefs for more information about this.
52 /// The key of this vector is the placeholder constant, the value is the slot
53 /// number that holds the resolved value.
54 typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy;
55 ResolveConstantsTy ResolveConstants;
58 BitcodeReaderValueList(LLVMContext &C) : Context(C) {}
59 ~BitcodeReaderValueList() {
60 assert(ResolveConstants.empty() && "Constants not resolved?");
63 // vector compatibility methods
64 unsigned size() const { return ValuePtrs.size(); }
65 void resize(unsigned N) { ValuePtrs.resize(N); }
66 void push_back(Value *V) {
67 ValuePtrs.push_back(V);
71 assert(ResolveConstants.empty() && "Constants not resolved?");
75 Value *operator[](unsigned i) const {
76 assert(i < ValuePtrs.size());
80 Value *back() const { return ValuePtrs.back(); }
81 void pop_back() { ValuePtrs.pop_back(); }
82 bool empty() const { return ValuePtrs.empty(); }
83 void shrinkTo(unsigned N) {
84 assert(N <= size() && "Invalid shrinkTo request!");
88 Constant *getConstantFwdRef(unsigned Idx, Type *Ty);
89 Value *getValueFwdRef(unsigned Idx, Type *Ty);
91 void AssignValue(Value *V, unsigned Idx);
93 /// ResolveConstantForwardRefs - Once all constants are read, this method bulk
94 /// resolves any forward references.
95 void ResolveConstantForwardRefs();
98 class BitcodeReaderMDValueList {
103 std::vector<TrackingMDRef> MDValuePtrs;
105 LLVMContext &Context;
107 BitcodeReaderMDValueList(LLVMContext &C)
108 : NumFwdRefs(0), AnyFwdRefs(false), Context(C) {}
110 // vector compatibility methods
111 unsigned size() const { return MDValuePtrs.size(); }
112 void resize(unsigned N) { MDValuePtrs.resize(N); }
113 void push_back(Metadata *MD) { MDValuePtrs.emplace_back(MD); }
114 void clear() { MDValuePtrs.clear(); }
115 Metadata *back() const { return MDValuePtrs.back(); }
116 void pop_back() { MDValuePtrs.pop_back(); }
117 bool empty() const { return MDValuePtrs.empty(); }
119 Metadata *operator[](unsigned i) const {
120 assert(i < MDValuePtrs.size());
121 return MDValuePtrs[i];
124 void shrinkTo(unsigned N) {
125 assert(N <= size() && "Invalid shrinkTo request!");
126 MDValuePtrs.resize(N);
129 Metadata *getValueFwdRef(unsigned Idx);
130 void AssignValue(Metadata *MD, unsigned Idx);
131 void tryToResolveCycles();
134 class BitcodeReader : public GVMaterializer {
135 LLVMContext &Context;
136 DiagnosticHandlerFunction DiagnosticHandler;
138 std::unique_ptr<MemoryBuffer> Buffer;
139 std::unique_ptr<BitstreamReader> StreamFile;
140 BitstreamCursor Stream;
141 DataStreamer *LazyStreamer;
142 uint64_t NextUnreadBit;
143 bool SeenValueSymbolTable;
145 std::vector<Type*> TypeList;
146 BitcodeReaderValueList ValueList;
147 BitcodeReaderMDValueList MDValueList;
148 std::vector<Comdat *> ComdatList;
149 SmallVector<Instruction *, 64> InstructionList;
151 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
152 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits;
153 std::vector<std::pair<Function*, unsigned> > FunctionPrefixes;
154 std::vector<std::pair<Function*, unsigned> > FunctionPrologues;
156 SmallVector<Instruction*, 64> InstsWithTBAATag;
158 /// MAttributes - The set of attributes by index. Index zero in the
159 /// file is for null, and is thus not represented here. As such all indices
161 std::vector<AttributeSet> MAttributes;
163 /// \brief The set of attribute groups.
164 std::map<unsigned, AttributeSet> MAttributeGroups;
166 /// FunctionBBs - While parsing a function body, this is a list of the basic
167 /// blocks for the function.
168 std::vector<BasicBlock*> FunctionBBs;
170 // When reading the module header, this list is populated with functions that
171 // have bodies later in the file.
172 std::vector<Function*> FunctionsWithBodies;
174 // When intrinsic functions are encountered which require upgrading they are
175 // stored here with their replacement function.
176 typedef std::vector<std::pair<Function*, Function*> > UpgradedIntrinsicMap;
177 UpgradedIntrinsicMap UpgradedIntrinsics;
179 // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
180 DenseMap<unsigned, unsigned> MDKindMap;
182 // Several operations happen after the module header has been read, but
183 // before function bodies are processed. This keeps track of whether
184 // we've done this yet.
185 bool SeenFirstFunctionBody;
187 /// DeferredFunctionInfo - When function bodies are initially scanned, this
188 /// map contains info about where to find deferred function body in the
190 DenseMap<Function*, uint64_t> DeferredFunctionInfo;
192 /// When Metadata block is initially scanned when parsing the module, we may
193 /// choose to defer parsing of the metadata. This vector contains info about
194 /// which Metadata blocks are deferred.
195 std::vector<uint64_t> DeferredMetadataInfo;
197 /// These are basic blocks forward-referenced by block addresses. They are
198 /// inserted lazily into functions when they're loaded. The basic block ID is
199 /// its index into the vector.
200 DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
201 std::deque<Function *> BasicBlockFwdRefQueue;
203 /// UseRelativeIDs - Indicates that we are using a new encoding for
204 /// instruction operands where most operands in the current
205 /// FUNCTION_BLOCK are encoded relative to the instruction number,
206 /// for a more compact encoding. Some instruction operands are not
207 /// relative to the instruction ID: basic block numbers, and types.
208 /// Once the old style function blocks have been phased out, we would
209 /// not need this flag.
212 /// True if all functions will be materialized, negating the need to process
213 /// (e.g.) blockaddress forward references.
214 bool WillMaterializeAllForwardRefs;
216 /// Functions that have block addresses taken. This is usually empty.
217 SmallPtrSet<const Function *, 4> BlockAddressesTaken;
219 /// True if any Metadata block has been materialized.
220 bool IsMetadataMaterialized;
222 bool StripDebugInfo = false;
225 std::error_code Error(BitcodeError E, const Twine &Message);
226 std::error_code Error(BitcodeError E);
227 std::error_code Error(const Twine &Message);
229 explicit BitcodeReader(MemoryBuffer *buffer, LLVMContext &C,
230 DiagnosticHandlerFunction DiagnosticHandler);
231 explicit BitcodeReader(DataStreamer *streamer, LLVMContext &C,
232 DiagnosticHandlerFunction DiagnosticHandler);
233 ~BitcodeReader() { FreeState(); }
235 std::error_code materializeForwardReferencedFunctions();
239 void releaseBuffer();
241 bool isDematerializable(const GlobalValue *GV) const override;
242 std::error_code materialize(GlobalValue *GV) override;
243 std::error_code MaterializeModule(Module *M) override;
244 std::vector<StructType *> getIdentifiedStructTypes() const override;
245 void Dematerialize(GlobalValue *GV) override;
247 /// @brief Main interface to parsing a bitcode buffer.
248 /// @returns true if an error occurred.
249 std::error_code ParseBitcodeInto(Module *M,
250 bool ShouldLazyLoadMetadata = false);
252 /// @brief Cheap mechanism to just extract module triple
253 /// @returns true if an error occurred.
254 ErrorOr<std::string> parseTriple();
256 static uint64_t decodeSignRotatedValue(uint64_t V);
258 /// Materialize any deferred Metadata block.
259 std::error_code materializeMetadata() override;
261 void setStripDebugInfo() override;
264 std::vector<StructType *> IdentifiedStructTypes;
265 StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
266 StructType *createIdentifiedStructType(LLVMContext &Context);
268 Type *getTypeByID(unsigned ID);
269 Value *getFnValueByID(unsigned ID, Type *Ty) {
270 if (Ty && Ty->isMetadataTy())
271 return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
272 return ValueList.getValueFwdRef(ID, Ty);
274 Metadata *getFnMetadataByID(unsigned ID) {
275 return MDValueList.getValueFwdRef(ID);
277 BasicBlock *getBasicBlock(unsigned ID) const {
278 if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
279 return FunctionBBs[ID];
281 AttributeSet getAttributes(unsigned i) const {
282 if (i-1 < MAttributes.size())
283 return MAttributes[i-1];
284 return AttributeSet();
287 /// getValueTypePair - Read a value/type pair out of the specified record from
288 /// slot 'Slot'. Increment Slot past the number of slots used in the record.
289 /// Return true on failure.
290 bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
291 unsigned InstNum, Value *&ResVal) {
292 if (Slot == Record.size()) return true;
293 unsigned ValNo = (unsigned)Record[Slot++];
294 // Adjust the ValNo, if it was encoded relative to the InstNum.
296 ValNo = InstNum - ValNo;
297 if (ValNo < InstNum) {
298 // If this is not a forward reference, just return the value we already
300 ResVal = getFnValueByID(ValNo, nullptr);
301 return ResVal == nullptr;
302 } else if (Slot == Record.size()) {
306 unsigned TypeNo = (unsigned)Record[Slot++];
307 ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
308 return ResVal == nullptr;
311 /// popValue - Read a value out of the specified record from slot 'Slot'.
312 /// Increment Slot past the number of slots used by the value in the record.
313 /// Return true if there is an error.
314 bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
315 unsigned InstNum, Type *Ty, Value *&ResVal) {
316 if (getValue(Record, Slot, InstNum, Ty, ResVal))
318 // All values currently take a single record slot.
323 /// getValue -- Like popValue, but does not increment the Slot number.
324 bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
325 unsigned InstNum, Type *Ty, Value *&ResVal) {
326 ResVal = getValue(Record, Slot, InstNum, Ty);
327 return ResVal == nullptr;
330 /// getValue -- Version of getValue that returns ResVal directly,
331 /// or 0 if there is an error.
332 Value *getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
333 unsigned InstNum, Type *Ty) {
334 if (Slot == Record.size()) return nullptr;
335 unsigned ValNo = (unsigned)Record[Slot];
336 // Adjust the ValNo, if it was encoded relative to the InstNum.
338 ValNo = InstNum - ValNo;
339 return getFnValueByID(ValNo, Ty);
342 /// getValueSigned -- Like getValue, but decodes signed VBRs.
343 Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
344 unsigned InstNum, Type *Ty) {
345 if (Slot == Record.size()) return nullptr;
346 unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
347 // Adjust the ValNo, if it was encoded relative to the InstNum.
349 ValNo = InstNum - ValNo;
350 return getFnValueByID(ValNo, Ty);
353 /// Converts alignment exponent (i.e. power of two (or zero)) to the
354 /// corresponding alignment to use. If alignment is too large, returns
355 /// a corresponding error code.
356 std::error_code parseAlignmentValue(uint64_t Exponent, unsigned &Alignment);
357 std::error_code ParseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
358 std::error_code ParseModule(bool Resume, bool ShouldLazyLoadMetadata = false);
359 std::error_code ParseAttributeBlock();
360 std::error_code ParseAttributeGroupBlock();
361 std::error_code ParseTypeTable();
362 std::error_code ParseTypeTableBody();
364 std::error_code ParseValueSymbolTable();
365 std::error_code ParseConstants();
366 std::error_code RememberAndSkipFunctionBody();
367 /// Save the positions of the Metadata blocks and skip parsing the blocks.
368 std::error_code rememberAndSkipMetadata();
369 std::error_code ParseFunctionBody(Function *F);
370 std::error_code GlobalCleanup();
371 std::error_code ResolveGlobalAndAliasInits();
372 std::error_code ParseMetadata();
373 std::error_code ParseMetadataAttachment();
374 ErrorOr<std::string> parseModuleTriple();
375 std::error_code ParseUseLists();
376 std::error_code InitStream();
377 std::error_code InitStreamFromBuffer();
378 std::error_code InitLazyStream();
379 std::error_code FindFunctionInStream(
381 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
385 BitcodeDiagnosticInfo::BitcodeDiagnosticInfo(std::error_code EC,
386 DiagnosticSeverity Severity,
388 : DiagnosticInfo(DK_Bitcode, Severity), Msg(Msg), EC(EC) {}
390 void BitcodeDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
392 static std::error_code Error(DiagnosticHandlerFunction DiagnosticHandler,
393 std::error_code EC, const Twine &Message) {
394 BitcodeDiagnosticInfo DI(EC, DS_Error, Message);
395 DiagnosticHandler(DI);
399 static std::error_code Error(DiagnosticHandlerFunction DiagnosticHandler,
400 std::error_code EC) {
401 return Error(DiagnosticHandler, EC, EC.message());
404 std::error_code BitcodeReader::Error(BitcodeError E, const Twine &Message) {
405 return ::Error(DiagnosticHandler, make_error_code(E), Message);
408 std::error_code BitcodeReader::Error(const Twine &Message) {
409 return ::Error(DiagnosticHandler,
410 make_error_code(BitcodeError::CorruptedBitcode), Message);
413 std::error_code BitcodeReader::Error(BitcodeError E) {
414 return ::Error(DiagnosticHandler, make_error_code(E));
417 static DiagnosticHandlerFunction getDiagHandler(DiagnosticHandlerFunction F,
421 return [&C](const DiagnosticInfo &DI) { C.diagnose(DI); };
424 BitcodeReader::BitcodeReader(MemoryBuffer *buffer, LLVMContext &C,
425 DiagnosticHandlerFunction DiagnosticHandler)
426 : Context(C), DiagnosticHandler(getDiagHandler(DiagnosticHandler, C)),
427 TheModule(nullptr), Buffer(buffer), LazyStreamer(nullptr),
428 NextUnreadBit(0), SeenValueSymbolTable(false), ValueList(C),
429 MDValueList(C), SeenFirstFunctionBody(false), UseRelativeIDs(false),
430 WillMaterializeAllForwardRefs(false), IsMetadataMaterialized(false) {}
432 BitcodeReader::BitcodeReader(DataStreamer *streamer, LLVMContext &C,
433 DiagnosticHandlerFunction DiagnosticHandler)
434 : Context(C), DiagnosticHandler(getDiagHandler(DiagnosticHandler, C)),
435 TheModule(nullptr), Buffer(nullptr), LazyStreamer(streamer),
436 NextUnreadBit(0), SeenValueSymbolTable(false), ValueList(C),
437 MDValueList(C), SeenFirstFunctionBody(false), UseRelativeIDs(false),
438 WillMaterializeAllForwardRefs(false), IsMetadataMaterialized(false) {}
440 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
441 if (WillMaterializeAllForwardRefs)
442 return std::error_code();
444 // Prevent recursion.
445 WillMaterializeAllForwardRefs = true;
447 while (!BasicBlockFwdRefQueue.empty()) {
448 Function *F = BasicBlockFwdRefQueue.front();
449 BasicBlockFwdRefQueue.pop_front();
450 assert(F && "Expected valid function");
451 if (!BasicBlockFwdRefs.count(F))
452 // Already materialized.
455 // Check for a function that isn't materializable to prevent an infinite
456 // loop. When parsing a blockaddress stored in a global variable, there
457 // isn't a trivial way to check if a function will have a body without a
458 // linear search through FunctionsWithBodies, so just check it here.
459 if (!F->isMaterializable())
460 return Error("Never resolved function from blockaddress");
462 // Try to materialize F.
463 if (std::error_code EC = materialize(F))
466 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
469 WillMaterializeAllForwardRefs = false;
470 return std::error_code();
473 void BitcodeReader::FreeState() {
475 std::vector<Type*>().swap(TypeList);
478 std::vector<Comdat *>().swap(ComdatList);
480 std::vector<AttributeSet>().swap(MAttributes);
481 std::vector<BasicBlock*>().swap(FunctionBBs);
482 std::vector<Function*>().swap(FunctionsWithBodies);
483 DeferredFunctionInfo.clear();
484 DeferredMetadataInfo.clear();
487 assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
488 BasicBlockFwdRefQueue.clear();
491 //===----------------------------------------------------------------------===//
492 // Helper functions to implement forward reference resolution, etc.
493 //===----------------------------------------------------------------------===//
495 /// ConvertToString - Convert a string from a record into an std::string, return
497 template<typename StrTy>
498 static bool ConvertToString(ArrayRef<uint64_t> Record, unsigned Idx,
500 if (Idx > Record.size())
503 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
504 Result += (char)Record[i];
508 static bool hasImplicitComdat(size_t Val) {
512 case 1: // Old WeakAnyLinkage
513 case 4: // Old LinkOnceAnyLinkage
514 case 10: // Old WeakODRLinkage
515 case 11: // Old LinkOnceODRLinkage
520 static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
522 default: // Map unknown/new linkages to external
524 return GlobalValue::ExternalLinkage;
526 return GlobalValue::AppendingLinkage;
528 return GlobalValue::InternalLinkage;
530 return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
532 return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
534 return GlobalValue::ExternalWeakLinkage;
536 return GlobalValue::CommonLinkage;
538 return GlobalValue::PrivateLinkage;
540 return GlobalValue::AvailableExternallyLinkage;
542 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
544 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
546 return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
547 case 1: // Old value with implicit comdat.
549 return GlobalValue::WeakAnyLinkage;
550 case 10: // Old value with implicit comdat.
552 return GlobalValue::WeakODRLinkage;
553 case 4: // Old value with implicit comdat.
555 return GlobalValue::LinkOnceAnyLinkage;
556 case 11: // Old value with implicit comdat.
558 return GlobalValue::LinkOnceODRLinkage;
562 static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
564 default: // Map unknown visibilities to default.
565 case 0: return GlobalValue::DefaultVisibility;
566 case 1: return GlobalValue::HiddenVisibility;
567 case 2: return GlobalValue::ProtectedVisibility;
571 static GlobalValue::DLLStorageClassTypes
572 GetDecodedDLLStorageClass(unsigned Val) {
574 default: // Map unknown values to default.
575 case 0: return GlobalValue::DefaultStorageClass;
576 case 1: return GlobalValue::DLLImportStorageClass;
577 case 2: return GlobalValue::DLLExportStorageClass;
581 static GlobalVariable::ThreadLocalMode GetDecodedThreadLocalMode(unsigned Val) {
583 case 0: return GlobalVariable::NotThreadLocal;
584 default: // Map unknown non-zero value to general dynamic.
585 case 1: return GlobalVariable::GeneralDynamicTLSModel;
586 case 2: return GlobalVariable::LocalDynamicTLSModel;
587 case 3: return GlobalVariable::InitialExecTLSModel;
588 case 4: return GlobalVariable::LocalExecTLSModel;
592 static int GetDecodedCastOpcode(unsigned Val) {
595 case bitc::CAST_TRUNC : return Instruction::Trunc;
596 case bitc::CAST_ZEXT : return Instruction::ZExt;
597 case bitc::CAST_SEXT : return Instruction::SExt;
598 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
599 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
600 case bitc::CAST_UITOFP : return Instruction::UIToFP;
601 case bitc::CAST_SITOFP : return Instruction::SIToFP;
602 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
603 case bitc::CAST_FPEXT : return Instruction::FPExt;
604 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
605 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
606 case bitc::CAST_BITCAST : return Instruction::BitCast;
607 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
610 static int GetDecodedBinaryOpcode(unsigned Val, Type *Ty) {
613 case bitc::BINOP_ADD:
614 return Ty->isFPOrFPVectorTy() ? Instruction::FAdd : Instruction::Add;
615 case bitc::BINOP_SUB:
616 return Ty->isFPOrFPVectorTy() ? Instruction::FSub : Instruction::Sub;
617 case bitc::BINOP_MUL:
618 return Ty->isFPOrFPVectorTy() ? Instruction::FMul : Instruction::Mul;
619 case bitc::BINOP_UDIV: return Instruction::UDiv;
620 case bitc::BINOP_SDIV:
621 return Ty->isFPOrFPVectorTy() ? Instruction::FDiv : Instruction::SDiv;
622 case bitc::BINOP_UREM: return Instruction::URem;
623 case bitc::BINOP_SREM:
624 return Ty->isFPOrFPVectorTy() ? Instruction::FRem : Instruction::SRem;
625 case bitc::BINOP_SHL: return Instruction::Shl;
626 case bitc::BINOP_LSHR: return Instruction::LShr;
627 case bitc::BINOP_ASHR: return Instruction::AShr;
628 case bitc::BINOP_AND: return Instruction::And;
629 case bitc::BINOP_OR: return Instruction::Or;
630 case bitc::BINOP_XOR: return Instruction::Xor;
634 static AtomicRMWInst::BinOp GetDecodedRMWOperation(unsigned Val) {
636 default: return AtomicRMWInst::BAD_BINOP;
637 case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
638 case bitc::RMW_ADD: return AtomicRMWInst::Add;
639 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
640 case bitc::RMW_AND: return AtomicRMWInst::And;
641 case bitc::RMW_NAND: return AtomicRMWInst::Nand;
642 case bitc::RMW_OR: return AtomicRMWInst::Or;
643 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
644 case bitc::RMW_MAX: return AtomicRMWInst::Max;
645 case bitc::RMW_MIN: return AtomicRMWInst::Min;
646 case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
647 case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
651 static AtomicOrdering GetDecodedOrdering(unsigned Val) {
653 case bitc::ORDERING_NOTATOMIC: return NotAtomic;
654 case bitc::ORDERING_UNORDERED: return Unordered;
655 case bitc::ORDERING_MONOTONIC: return Monotonic;
656 case bitc::ORDERING_ACQUIRE: return Acquire;
657 case bitc::ORDERING_RELEASE: return Release;
658 case bitc::ORDERING_ACQREL: return AcquireRelease;
659 default: // Map unknown orderings to sequentially-consistent.
660 case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
664 static SynchronizationScope GetDecodedSynchScope(unsigned Val) {
666 case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
667 default: // Map unknown scopes to cross-thread.
668 case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
672 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
674 default: // Map unknown selection kinds to any.
675 case bitc::COMDAT_SELECTION_KIND_ANY:
677 case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
678 return Comdat::ExactMatch;
679 case bitc::COMDAT_SELECTION_KIND_LARGEST:
680 return Comdat::Largest;
681 case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
682 return Comdat::NoDuplicates;
683 case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
684 return Comdat::SameSize;
688 static void UpgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
690 case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
691 case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
697 /// @brief A class for maintaining the slot number definition
698 /// as a placeholder for the actual definition for forward constants defs.
699 class ConstantPlaceHolder : public ConstantExpr {
700 void operator=(const ConstantPlaceHolder &) = delete;
702 // allocate space for exactly one operand
703 void *operator new(size_t s) {
704 return User::operator new(s, 1);
706 explicit ConstantPlaceHolder(Type *Ty, LLVMContext& Context)
707 : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
708 Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
711 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
712 static bool classof(const Value *V) {
713 return isa<ConstantExpr>(V) &&
714 cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
718 /// Provide fast operand accessors
719 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
723 // FIXME: can we inherit this from ConstantExpr?
725 struct OperandTraits<ConstantPlaceHolder> :
726 public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
728 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantPlaceHolder, Value)
732 void BitcodeReaderValueList::AssignValue(Value *V, unsigned Idx) {
741 WeakVH &OldV = ValuePtrs[Idx];
747 // Handle constants and non-constants (e.g. instrs) differently for
749 if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
750 ResolveConstants.push_back(std::make_pair(PHC, Idx));
753 // If there was a forward reference to this value, replace it.
754 Value *PrevVal = OldV;
755 OldV->replaceAllUsesWith(V);
761 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
766 if (Value *V = ValuePtrs[Idx]) {
767 assert(Ty == V->getType() && "Type mismatch in constant table!");
768 return cast<Constant>(V);
771 // Create and return a placeholder, which will later be RAUW'd.
772 Constant *C = new ConstantPlaceHolder(Ty, Context);
777 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty) {
781 if (Value *V = ValuePtrs[Idx]) {
782 assert((!Ty || Ty == V->getType()) && "Type mismatch in value table!");
786 // No type specified, must be invalid reference.
787 if (!Ty) return nullptr;
789 // Create and return a placeholder, which will later be RAUW'd.
790 Value *V = new Argument(Ty);
795 /// ResolveConstantForwardRefs - Once all constants are read, this method bulk
796 /// resolves any forward references. The idea behind this is that we sometimes
797 /// get constants (such as large arrays) which reference *many* forward ref
798 /// constants. Replacing each of these causes a lot of thrashing when
799 /// building/reuniquing the constant. Instead of doing this, we look at all the
800 /// uses and rewrite all the place holders at once for any constant that uses
802 void BitcodeReaderValueList::ResolveConstantForwardRefs() {
803 // Sort the values by-pointer so that they are efficient to look up with a
805 std::sort(ResolveConstants.begin(), ResolveConstants.end());
807 SmallVector<Constant*, 64> NewOps;
809 while (!ResolveConstants.empty()) {
810 Value *RealVal = operator[](ResolveConstants.back().second);
811 Constant *Placeholder = ResolveConstants.back().first;
812 ResolveConstants.pop_back();
814 // Loop over all users of the placeholder, updating them to reference the
815 // new value. If they reference more than one placeholder, update them all
817 while (!Placeholder->use_empty()) {
818 auto UI = Placeholder->user_begin();
821 // If the using object isn't uniqued, just update the operands. This
822 // handles instructions and initializers for global variables.
823 if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
824 UI.getUse().set(RealVal);
828 // Otherwise, we have a constant that uses the placeholder. Replace that
829 // constant with a new constant that has *all* placeholder uses updated.
830 Constant *UserC = cast<Constant>(U);
831 for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
834 if (!isa<ConstantPlaceHolder>(*I)) {
835 // Not a placeholder reference.
837 } else if (*I == Placeholder) {
838 // Common case is that it just references this one placeholder.
841 // Otherwise, look up the placeholder in ResolveConstants.
842 ResolveConstantsTy::iterator It =
843 std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
844 std::pair<Constant*, unsigned>(cast<Constant>(*I),
846 assert(It != ResolveConstants.end() && It->first == *I);
847 NewOp = operator[](It->second);
850 NewOps.push_back(cast<Constant>(NewOp));
853 // Make the new constant.
855 if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
856 NewC = ConstantArray::get(UserCA->getType(), NewOps);
857 } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
858 NewC = ConstantStruct::get(UserCS->getType(), NewOps);
859 } else if (isa<ConstantVector>(UserC)) {
860 NewC = ConstantVector::get(NewOps);
862 assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
863 NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
866 UserC->replaceAllUsesWith(NewC);
867 UserC->destroyConstant();
871 // Update all ValueHandles, they should be the only users at this point.
872 Placeholder->replaceAllUsesWith(RealVal);
877 void BitcodeReaderMDValueList::AssignValue(Metadata *MD, unsigned Idx) {
886 TrackingMDRef &OldMD = MDValuePtrs[Idx];
892 // If there was a forward reference to this value, replace it.
893 TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
894 PrevMD->replaceAllUsesWith(MD);
898 Metadata *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
902 if (Metadata *MD = MDValuePtrs[Idx])
905 // Track forward refs to be resolved later.
907 MinFwdRef = std::min(MinFwdRef, Idx);
908 MaxFwdRef = std::max(MaxFwdRef, Idx);
911 MinFwdRef = MaxFwdRef = Idx;
915 // Create and return a placeholder, which will later be RAUW'd.
916 Metadata *MD = MDNode::getTemporary(Context, None).release();
917 MDValuePtrs[Idx].reset(MD);
921 void BitcodeReaderMDValueList::tryToResolveCycles() {
927 // Still forward references... can't resolve cycles.
930 // Resolve any cycles.
931 for (unsigned I = MinFwdRef, E = MaxFwdRef + 1; I != E; ++I) {
932 auto &MD = MDValuePtrs[I];
933 auto *N = dyn_cast_or_null<MDNode>(MD);
937 assert(!N->isTemporary() && "Unexpected forward reference");
941 // Make sure we return early again until there's another forward ref.
945 Type *BitcodeReader::getTypeByID(unsigned ID) {
946 // The type table size is always specified correctly.
947 if (ID >= TypeList.size())
950 if (Type *Ty = TypeList[ID])
953 // If we have a forward reference, the only possible case is when it is to a
954 // named struct. Just create a placeholder for now.
955 return TypeList[ID] = createIdentifiedStructType(Context);
958 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
960 auto *Ret = StructType::create(Context, Name);
961 IdentifiedStructTypes.push_back(Ret);
965 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
966 auto *Ret = StructType::create(Context);
967 IdentifiedStructTypes.push_back(Ret);
972 //===----------------------------------------------------------------------===//
973 // Functions for parsing blocks from the bitcode file
974 //===----------------------------------------------------------------------===//
977 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
978 /// been decoded from the given integer. This function must stay in sync with
979 /// 'encodeLLVMAttributesForBitcode'.
980 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
981 uint64_t EncodedAttrs) {
982 // FIXME: Remove in 4.0.
984 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
985 // the bits above 31 down by 11 bits.
986 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
987 assert((!Alignment || isPowerOf2_32(Alignment)) &&
988 "Alignment must be a power of two.");
991 B.addAlignmentAttr(Alignment);
992 B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
993 (EncodedAttrs & 0xffff));
996 std::error_code BitcodeReader::ParseAttributeBlock() {
997 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
998 return Error("Invalid record");
1000 if (!MAttributes.empty())
1001 return Error("Invalid multiple blocks");
1003 SmallVector<uint64_t, 64> Record;
1005 SmallVector<AttributeSet, 8> Attrs;
1007 // Read all the records.
1009 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1011 switch (Entry.Kind) {
1012 case BitstreamEntry::SubBlock: // Handled for us already.
1013 case BitstreamEntry::Error:
1014 return Error("Malformed block");
1015 case BitstreamEntry::EndBlock:
1016 return std::error_code();
1017 case BitstreamEntry::Record:
1018 // The interesting case.
1024 switch (Stream.readRecord(Entry.ID, Record)) {
1025 default: // Default behavior: ignore.
1027 case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
1028 // FIXME: Remove in 4.0.
1029 if (Record.size() & 1)
1030 return Error("Invalid record");
1032 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1034 decodeLLVMAttributesForBitcode(B, Record[i+1]);
1035 Attrs.push_back(AttributeSet::get(Context, Record[i], B));
1038 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1042 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
1043 for (unsigned i = 0, e = Record.size(); i != e; ++i)
1044 Attrs.push_back(MAttributeGroups[Record[i]]);
1046 MAttributes.push_back(AttributeSet::get(Context, Attrs));
1054 // Returns Attribute::None on unrecognized codes.
1055 static Attribute::AttrKind GetAttrFromCode(uint64_t Code) {
1058 return Attribute::None;
1059 case bitc::ATTR_KIND_ALIGNMENT:
1060 return Attribute::Alignment;
1061 case bitc::ATTR_KIND_ALWAYS_INLINE:
1062 return Attribute::AlwaysInline;
1063 case bitc::ATTR_KIND_BUILTIN:
1064 return Attribute::Builtin;
1065 case bitc::ATTR_KIND_BY_VAL:
1066 return Attribute::ByVal;
1067 case bitc::ATTR_KIND_IN_ALLOCA:
1068 return Attribute::InAlloca;
1069 case bitc::ATTR_KIND_COLD:
1070 return Attribute::Cold;
1071 case bitc::ATTR_KIND_INLINE_HINT:
1072 return Attribute::InlineHint;
1073 case bitc::ATTR_KIND_IN_REG:
1074 return Attribute::InReg;
1075 case bitc::ATTR_KIND_JUMP_TABLE:
1076 return Attribute::JumpTable;
1077 case bitc::ATTR_KIND_MIN_SIZE:
1078 return Attribute::MinSize;
1079 case bitc::ATTR_KIND_NAKED:
1080 return Attribute::Naked;
1081 case bitc::ATTR_KIND_NEST:
1082 return Attribute::Nest;
1083 case bitc::ATTR_KIND_NO_ALIAS:
1084 return Attribute::NoAlias;
1085 case bitc::ATTR_KIND_NO_BUILTIN:
1086 return Attribute::NoBuiltin;
1087 case bitc::ATTR_KIND_NO_CAPTURE:
1088 return Attribute::NoCapture;
1089 case bitc::ATTR_KIND_NO_DUPLICATE:
1090 return Attribute::NoDuplicate;
1091 case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1092 return Attribute::NoImplicitFloat;
1093 case bitc::ATTR_KIND_NO_INLINE:
1094 return Attribute::NoInline;
1095 case bitc::ATTR_KIND_NON_LAZY_BIND:
1096 return Attribute::NonLazyBind;
1097 case bitc::ATTR_KIND_NON_NULL:
1098 return Attribute::NonNull;
1099 case bitc::ATTR_KIND_DEREFERENCEABLE:
1100 return Attribute::Dereferenceable;
1101 case bitc::ATTR_KIND_NO_RED_ZONE:
1102 return Attribute::NoRedZone;
1103 case bitc::ATTR_KIND_NO_RETURN:
1104 return Attribute::NoReturn;
1105 case bitc::ATTR_KIND_NO_UNWIND:
1106 return Attribute::NoUnwind;
1107 case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1108 return Attribute::OptimizeForSize;
1109 case bitc::ATTR_KIND_OPTIMIZE_NONE:
1110 return Attribute::OptimizeNone;
1111 case bitc::ATTR_KIND_READ_NONE:
1112 return Attribute::ReadNone;
1113 case bitc::ATTR_KIND_READ_ONLY:
1114 return Attribute::ReadOnly;
1115 case bitc::ATTR_KIND_RETURNED:
1116 return Attribute::Returned;
1117 case bitc::ATTR_KIND_RETURNS_TWICE:
1118 return Attribute::ReturnsTwice;
1119 case bitc::ATTR_KIND_S_EXT:
1120 return Attribute::SExt;
1121 case bitc::ATTR_KIND_STACK_ALIGNMENT:
1122 return Attribute::StackAlignment;
1123 case bitc::ATTR_KIND_STACK_PROTECT:
1124 return Attribute::StackProtect;
1125 case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1126 return Attribute::StackProtectReq;
1127 case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1128 return Attribute::StackProtectStrong;
1129 case bitc::ATTR_KIND_STRUCT_RET:
1130 return Attribute::StructRet;
1131 case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1132 return Attribute::SanitizeAddress;
1133 case bitc::ATTR_KIND_SANITIZE_THREAD:
1134 return Attribute::SanitizeThread;
1135 case bitc::ATTR_KIND_SANITIZE_MEMORY:
1136 return Attribute::SanitizeMemory;
1137 case bitc::ATTR_KIND_UW_TABLE:
1138 return Attribute::UWTable;
1139 case bitc::ATTR_KIND_Z_EXT:
1140 return Attribute::ZExt;
1144 std::error_code BitcodeReader::parseAlignmentValue(uint64_t Exponent,
1145 unsigned &Alignment) {
1146 // Note: Alignment in bitcode files is incremented by 1, so that zero
1147 // can be used for default alignment.
1148 if (Exponent > Value::MaxAlignmentExponent + 1)
1149 return Error("Invalid alignment value");
1150 Alignment = (1 << static_cast<unsigned>(Exponent)) >> 1;
1151 return std::error_code();
1154 std::error_code BitcodeReader::ParseAttrKind(uint64_t Code,
1155 Attribute::AttrKind *Kind) {
1156 *Kind = GetAttrFromCode(Code);
1157 if (*Kind == Attribute::None)
1158 return Error(BitcodeError::CorruptedBitcode,
1159 "Unknown attribute kind (" + Twine(Code) + ")");
1160 return std::error_code();
1163 std::error_code BitcodeReader::ParseAttributeGroupBlock() {
1164 if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
1165 return Error("Invalid record");
1167 if (!MAttributeGroups.empty())
1168 return Error("Invalid multiple blocks");
1170 SmallVector<uint64_t, 64> Record;
1172 // Read all the records.
1174 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1176 switch (Entry.Kind) {
1177 case BitstreamEntry::SubBlock: // Handled for us already.
1178 case BitstreamEntry::Error:
1179 return Error("Malformed block");
1180 case BitstreamEntry::EndBlock:
1181 return std::error_code();
1182 case BitstreamEntry::Record:
1183 // The interesting case.
1189 switch (Stream.readRecord(Entry.ID, Record)) {
1190 default: // Default behavior: ignore.
1192 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1193 if (Record.size() < 3)
1194 return Error("Invalid record");
1196 uint64_t GrpID = Record[0];
1197 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1200 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1201 if (Record[i] == 0) { // Enum attribute
1202 Attribute::AttrKind Kind;
1203 if (std::error_code EC = ParseAttrKind(Record[++i], &Kind))
1206 B.addAttribute(Kind);
1207 } else if (Record[i] == 1) { // Integer attribute
1208 Attribute::AttrKind Kind;
1209 if (std::error_code EC = ParseAttrKind(Record[++i], &Kind))
1211 if (Kind == Attribute::Alignment)
1212 B.addAlignmentAttr(Record[++i]);
1213 else if (Kind == Attribute::StackAlignment)
1214 B.addStackAlignmentAttr(Record[++i]);
1215 else if (Kind == Attribute::Dereferenceable)
1216 B.addDereferenceableAttr(Record[++i]);
1217 } else { // String attribute
1218 assert((Record[i] == 3 || Record[i] == 4) &&
1219 "Invalid attribute group entry");
1220 bool HasValue = (Record[i++] == 4);
1221 SmallString<64> KindStr;
1222 SmallString<64> ValStr;
1224 while (Record[i] != 0 && i != e)
1225 KindStr += Record[i++];
1226 assert(Record[i] == 0 && "Kind string not null terminated");
1229 // Has a value associated with it.
1230 ++i; // Skip the '0' that terminates the "kind" string.
1231 while (Record[i] != 0 && i != e)
1232 ValStr += Record[i++];
1233 assert(Record[i] == 0 && "Value string not null terminated");
1236 B.addAttribute(KindStr.str(), ValStr.str());
1240 MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
1247 std::error_code BitcodeReader::ParseTypeTable() {
1248 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
1249 return Error("Invalid record");
1251 return ParseTypeTableBody();
1254 std::error_code BitcodeReader::ParseTypeTableBody() {
1255 if (!TypeList.empty())
1256 return Error("Invalid multiple blocks");
1258 SmallVector<uint64_t, 64> Record;
1259 unsigned NumRecords = 0;
1261 SmallString<64> TypeName;
1263 // Read all the records for this type table.
1265 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1267 switch (Entry.Kind) {
1268 case BitstreamEntry::SubBlock: // Handled for us already.
1269 case BitstreamEntry::Error:
1270 return Error("Malformed block");
1271 case BitstreamEntry::EndBlock:
1272 if (NumRecords != TypeList.size())
1273 return Error("Malformed block");
1274 return std::error_code();
1275 case BitstreamEntry::Record:
1276 // The interesting case.
1282 Type *ResultTy = nullptr;
1283 switch (Stream.readRecord(Entry.ID, Record)) {
1285 return Error("Invalid value");
1286 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1287 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1288 // type list. This allows us to reserve space.
1289 if (Record.size() < 1)
1290 return Error("Invalid record");
1291 TypeList.resize(Record[0]);
1293 case bitc::TYPE_CODE_VOID: // VOID
1294 ResultTy = Type::getVoidTy(Context);
1296 case bitc::TYPE_CODE_HALF: // HALF
1297 ResultTy = Type::getHalfTy(Context);
1299 case bitc::TYPE_CODE_FLOAT: // FLOAT
1300 ResultTy = Type::getFloatTy(Context);
1302 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
1303 ResultTy = Type::getDoubleTy(Context);
1305 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
1306 ResultTy = Type::getX86_FP80Ty(Context);
1308 case bitc::TYPE_CODE_FP128: // FP128
1309 ResultTy = Type::getFP128Ty(Context);
1311 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
1312 ResultTy = Type::getPPC_FP128Ty(Context);
1314 case bitc::TYPE_CODE_LABEL: // LABEL
1315 ResultTy = Type::getLabelTy(Context);
1317 case bitc::TYPE_CODE_METADATA: // METADATA
1318 ResultTy = Type::getMetadataTy(Context);
1320 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
1321 ResultTy = Type::getX86_MMXTy(Context);
1323 case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
1324 if (Record.size() < 1)
1325 return Error("Invalid record");
1327 uint64_t NumBits = Record[0];
1328 if (NumBits < IntegerType::MIN_INT_BITS ||
1329 NumBits > IntegerType::MAX_INT_BITS)
1330 return Error("Bitwidth for integer type out of range");
1331 ResultTy = IntegerType::get(Context, NumBits);
1334 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
1335 // [pointee type, address space]
1336 if (Record.size() < 1)
1337 return Error("Invalid record");
1338 unsigned AddressSpace = 0;
1339 if (Record.size() == 2)
1340 AddressSpace = Record[1];
1341 ResultTy = getTypeByID(Record[0]);
1343 return Error("Invalid type");
1344 ResultTy = PointerType::get(ResultTy, AddressSpace);
1347 case bitc::TYPE_CODE_FUNCTION_OLD: {
1348 // FIXME: attrid is dead, remove it in LLVM 4.0
1349 // FUNCTION: [vararg, attrid, retty, paramty x N]
1350 if (Record.size() < 3)
1351 return Error("Invalid record");
1352 SmallVector<Type*, 8> ArgTys;
1353 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1354 if (Type *T = getTypeByID(Record[i]))
1355 ArgTys.push_back(T);
1360 ResultTy = getTypeByID(Record[2]);
1361 if (!ResultTy || ArgTys.size() < Record.size()-3)
1362 return Error("Invalid type");
1364 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1367 case bitc::TYPE_CODE_FUNCTION: {
1368 // FUNCTION: [vararg, retty, paramty x N]
1369 if (Record.size() < 2)
1370 return Error("Invalid record");
1371 SmallVector<Type*, 8> ArgTys;
1372 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1373 if (Type *T = getTypeByID(Record[i]))
1374 ArgTys.push_back(T);
1379 ResultTy = getTypeByID(Record[1]);
1380 if (!ResultTy || ArgTys.size() < Record.size()-2)
1381 return Error("Invalid type");
1383 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1386 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
1387 if (Record.size() < 1)
1388 return Error("Invalid record");
1389 SmallVector<Type*, 8> EltTys;
1390 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1391 if (Type *T = getTypeByID(Record[i]))
1392 EltTys.push_back(T);
1396 if (EltTys.size() != Record.size()-1)
1397 return Error("Invalid type");
1398 ResultTy = StructType::get(Context, EltTys, Record[0]);
1401 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
1402 if (ConvertToString(Record, 0, TypeName))
1403 return Error("Invalid record");
1406 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1407 if (Record.size() < 1)
1408 return Error("Invalid record");
1410 if (NumRecords >= TypeList.size())
1411 return Error("Invalid TYPE table");
1413 // Check to see if this was forward referenced, if so fill in the temp.
1414 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1416 Res->setName(TypeName);
1417 TypeList[NumRecords] = nullptr;
1418 } else // Otherwise, create a new struct.
1419 Res = createIdentifiedStructType(Context, TypeName);
1422 SmallVector<Type*, 8> EltTys;
1423 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1424 if (Type *T = getTypeByID(Record[i]))
1425 EltTys.push_back(T);
1429 if (EltTys.size() != Record.size()-1)
1430 return Error("Invalid record");
1431 Res->setBody(EltTys, Record[0]);
1435 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
1436 if (Record.size() != 1)
1437 return Error("Invalid record");
1439 if (NumRecords >= TypeList.size())
1440 return Error("Invalid TYPE table");
1442 // Check to see if this was forward referenced, if so fill in the temp.
1443 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1445 Res->setName(TypeName);
1446 TypeList[NumRecords] = nullptr;
1447 } else // Otherwise, create a new struct with no body.
1448 Res = createIdentifiedStructType(Context, TypeName);
1453 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
1454 if (Record.size() < 2)
1455 return Error("Invalid record");
1456 if ((ResultTy = getTypeByID(Record[1])))
1457 ResultTy = ArrayType::get(ResultTy, Record[0]);
1459 return Error("Invalid type");
1461 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
1462 if (Record.size() < 2)
1463 return Error("Invalid record");
1464 if ((ResultTy = getTypeByID(Record[1])))
1465 ResultTy = VectorType::get(ResultTy, Record[0]);
1467 return Error("Invalid type");
1471 if (NumRecords >= TypeList.size())
1472 return Error("Invalid TYPE table");
1473 if (TypeList[NumRecords])
1475 "Invalid TYPE table: Only named structs can be forward referenced");
1476 assert(ResultTy && "Didn't read a type?");
1477 TypeList[NumRecords++] = ResultTy;
1481 std::error_code BitcodeReader::ParseValueSymbolTable() {
1482 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1483 return Error("Invalid record");
1485 SmallVector<uint64_t, 64> Record;
1487 Triple TT(TheModule->getTargetTriple());
1489 // Read all the records for this value table.
1490 SmallString<128> ValueName;
1492 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1494 switch (Entry.Kind) {
1495 case BitstreamEntry::SubBlock: // Handled for us already.
1496 case BitstreamEntry::Error:
1497 return Error("Malformed block");
1498 case BitstreamEntry::EndBlock:
1499 return std::error_code();
1500 case BitstreamEntry::Record:
1501 // The interesting case.
1507 switch (Stream.readRecord(Entry.ID, Record)) {
1508 default: // Default behavior: unknown type.
1510 case bitc::VST_CODE_ENTRY: { // VST_ENTRY: [valueid, namechar x N]
1511 if (ConvertToString(Record, 1, ValueName))
1512 return Error("Invalid record");
1513 unsigned ValueID = Record[0];
1514 if (ValueID >= ValueList.size() || !ValueList[ValueID])
1515 return Error("Invalid record");
1516 Value *V = ValueList[ValueID];
1518 V->setName(StringRef(ValueName.data(), ValueName.size()));
1519 if (auto *GO = dyn_cast<GlobalObject>(V)) {
1520 if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1521 if (TT.isOSBinFormatMachO())
1522 GO->setComdat(nullptr);
1524 GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1530 case bitc::VST_CODE_BBENTRY: {
1531 if (ConvertToString(Record, 1, ValueName))
1532 return Error("Invalid record");
1533 BasicBlock *BB = getBasicBlock(Record[0]);
1535 return Error("Invalid record");
1537 BB->setName(StringRef(ValueName.data(), ValueName.size()));
1545 static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
1547 std::error_code BitcodeReader::ParseMetadata() {
1548 IsMetadataMaterialized = true;
1549 unsigned NextMDValueNo = MDValueList.size();
1551 if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1552 return Error("Invalid record");
1554 SmallVector<uint64_t, 64> Record;
1557 [&](unsigned ID) -> Metadata *{ return MDValueList.getValueFwdRef(ID); };
1558 auto getMDOrNull = [&](unsigned ID) -> Metadata *{
1560 return getMD(ID - 1);
1563 auto getMDString = [&](unsigned ID) -> MDString *{
1564 // This requires that the ID is not really a forward reference. In
1565 // particular, the MDString must already have been resolved.
1566 return cast_or_null<MDString>(getMDOrNull(ID));
1569 #define GET_OR_DISTINCT(CLASS, DISTINCT, ARGS) \
1570 (DISTINCT ? CLASS::getDistinct ARGS : CLASS::get ARGS)
1572 // Read all the records.
1574 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1576 switch (Entry.Kind) {
1577 case BitstreamEntry::SubBlock: // Handled for us already.
1578 case BitstreamEntry::Error:
1579 return Error("Malformed block");
1580 case BitstreamEntry::EndBlock:
1581 MDValueList.tryToResolveCycles();
1582 return std::error_code();
1583 case BitstreamEntry::Record:
1584 // The interesting case.
1590 unsigned Code = Stream.readRecord(Entry.ID, Record);
1591 bool IsDistinct = false;
1593 default: // Default behavior: ignore.
1595 case bitc::METADATA_NAME: {
1596 // Read name of the named metadata.
1597 SmallString<8> Name(Record.begin(), Record.end());
1599 Code = Stream.ReadCode();
1601 // METADATA_NAME is always followed by METADATA_NAMED_NODE.
1602 unsigned NextBitCode = Stream.readRecord(Code, Record);
1603 assert(NextBitCode == bitc::METADATA_NAMED_NODE); (void)NextBitCode;
1605 // Read named metadata elements.
1606 unsigned Size = Record.size();
1607 NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1608 for (unsigned i = 0; i != Size; ++i) {
1609 MDNode *MD = dyn_cast_or_null<MDNode>(MDValueList.getValueFwdRef(Record[i]));
1611 return Error("Invalid record");
1612 NMD->addOperand(MD);
1616 case bitc::METADATA_OLD_FN_NODE: {
1617 // FIXME: Remove in 4.0.
1618 // This is a LocalAsMetadata record, the only type of function-local
1620 if (Record.size() % 2 == 1)
1621 return Error("Invalid record");
1623 // If this isn't a LocalAsMetadata record, we're dropping it. This used
1624 // to be legal, but there's no upgrade path.
1625 auto dropRecord = [&] {
1626 MDValueList.AssignValue(MDNode::get(Context, None), NextMDValueNo++);
1628 if (Record.size() != 2) {
1633 Type *Ty = getTypeByID(Record[0]);
1634 if (Ty->isMetadataTy() || Ty->isVoidTy()) {
1639 MDValueList.AssignValue(
1640 LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1644 case bitc::METADATA_OLD_NODE: {
1645 // FIXME: Remove in 4.0.
1646 if (Record.size() % 2 == 1)
1647 return Error("Invalid record");
1649 unsigned Size = Record.size();
1650 SmallVector<Metadata *, 8> Elts;
1651 for (unsigned i = 0; i != Size; i += 2) {
1652 Type *Ty = getTypeByID(Record[i]);
1654 return Error("Invalid record");
1655 if (Ty->isMetadataTy())
1656 Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
1657 else if (!Ty->isVoidTy()) {
1659 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
1660 assert(isa<ConstantAsMetadata>(MD) &&
1661 "Expected non-function-local metadata");
1664 Elts.push_back(nullptr);
1666 MDValueList.AssignValue(MDNode::get(Context, Elts), NextMDValueNo++);
1669 case bitc::METADATA_VALUE: {
1670 if (Record.size() != 2)
1671 return Error("Invalid record");
1673 Type *Ty = getTypeByID(Record[0]);
1674 if (Ty->isMetadataTy() || Ty->isVoidTy())
1675 return Error("Invalid record");
1677 MDValueList.AssignValue(
1678 ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1682 case bitc::METADATA_DISTINCT_NODE:
1685 case bitc::METADATA_NODE: {
1686 SmallVector<Metadata *, 8> Elts;
1687 Elts.reserve(Record.size());
1688 for (unsigned ID : Record)
1689 Elts.push_back(ID ? MDValueList.getValueFwdRef(ID - 1) : nullptr);
1690 MDValueList.AssignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
1691 : MDNode::get(Context, Elts),
1695 case bitc::METADATA_LOCATION: {
1696 if (Record.size() != 5)
1697 return Error("Invalid record");
1699 unsigned Line = Record[1];
1700 unsigned Column = Record[2];
1701 MDNode *Scope = cast<MDNode>(MDValueList.getValueFwdRef(Record[3]));
1702 Metadata *InlinedAt =
1703 Record[4] ? MDValueList.getValueFwdRef(Record[4] - 1) : nullptr;
1704 MDValueList.AssignValue(
1705 GET_OR_DISTINCT(MDLocation, Record[0],
1706 (Context, Line, Column, Scope, InlinedAt)),
1710 case bitc::METADATA_GENERIC_DEBUG: {
1711 if (Record.size() < 4)
1712 return Error("Invalid record");
1714 unsigned Tag = Record[1];
1715 unsigned Version = Record[2];
1717 if (Tag >= 1u << 16 || Version != 0)
1718 return Error("Invalid record");
1720 auto *Header = getMDString(Record[3]);
1721 SmallVector<Metadata *, 8> DwarfOps;
1722 for (unsigned I = 4, E = Record.size(); I != E; ++I)
1723 DwarfOps.push_back(Record[I] ? MDValueList.getValueFwdRef(Record[I] - 1)
1725 MDValueList.AssignValue(GET_OR_DISTINCT(GenericDebugNode, Record[0],
1726 (Context, Tag, Header, DwarfOps)),
1730 case bitc::METADATA_SUBRANGE: {
1731 if (Record.size() != 3)
1732 return Error("Invalid record");
1734 MDValueList.AssignValue(
1735 GET_OR_DISTINCT(MDSubrange, Record[0],
1736 (Context, Record[1], unrotateSign(Record[2]))),
1740 case bitc::METADATA_ENUMERATOR: {
1741 if (Record.size() != 3)
1742 return Error("Invalid record");
1744 MDValueList.AssignValue(GET_OR_DISTINCT(MDEnumerator, Record[0],
1745 (Context, unrotateSign(Record[1]),
1746 getMDString(Record[2]))),
1750 case bitc::METADATA_BASIC_TYPE: {
1751 if (Record.size() != 6)
1752 return Error("Invalid record");
1754 MDValueList.AssignValue(
1755 GET_OR_DISTINCT(MDBasicType, Record[0],
1756 (Context, Record[1], getMDString(Record[2]),
1757 Record[3], Record[4], Record[5])),
1761 case bitc::METADATA_DERIVED_TYPE: {
1762 if (Record.size() != 12)
1763 return Error("Invalid record");
1765 MDValueList.AssignValue(
1766 GET_OR_DISTINCT(MDDerivedType, Record[0],
1767 (Context, Record[1], getMDString(Record[2]),
1768 getMDOrNull(Record[3]), Record[4],
1769 getMDOrNull(Record[5]), getMDOrNull(Record[6]),
1770 Record[7], Record[8], Record[9], Record[10],
1771 getMDOrNull(Record[11]))),
1775 case bitc::METADATA_COMPOSITE_TYPE: {
1776 if (Record.size() != 16)
1777 return Error("Invalid record");
1779 MDValueList.AssignValue(
1780 GET_OR_DISTINCT(MDCompositeType, Record[0],
1781 (Context, Record[1], getMDString(Record[2]),
1782 getMDOrNull(Record[3]), Record[4],
1783 getMDOrNull(Record[5]), getMDOrNull(Record[6]),
1784 Record[7], Record[8], Record[9], Record[10],
1785 getMDOrNull(Record[11]), Record[12],
1786 getMDOrNull(Record[13]), getMDOrNull(Record[14]),
1787 getMDString(Record[15]))),
1791 case bitc::METADATA_SUBROUTINE_TYPE: {
1792 if (Record.size() != 3)
1793 return Error("Invalid record");
1795 MDValueList.AssignValue(
1796 GET_OR_DISTINCT(MDSubroutineType, Record[0],
1797 (Context, Record[1], getMDOrNull(Record[2]))),
1801 case bitc::METADATA_FILE: {
1802 if (Record.size() != 3)
1803 return Error("Invalid record");
1805 MDValueList.AssignValue(
1806 GET_OR_DISTINCT(MDFile, Record[0], (Context, getMDString(Record[1]),
1807 getMDString(Record[2]))),
1811 case bitc::METADATA_COMPILE_UNIT: {
1812 if (Record.size() != 14)
1813 return Error("Invalid record");
1815 MDValueList.AssignValue(
1816 GET_OR_DISTINCT(MDCompileUnit, Record[0],
1817 (Context, Record[1], getMDOrNull(Record[2]),
1818 getMDString(Record[3]), Record[4],
1819 getMDString(Record[5]), Record[6],
1820 getMDString(Record[7]), Record[8],
1821 getMDOrNull(Record[9]), getMDOrNull(Record[10]),
1822 getMDOrNull(Record[11]), getMDOrNull(Record[12]),
1823 getMDOrNull(Record[13]))),
1827 case bitc::METADATA_SUBPROGRAM: {
1828 if (Record.size() != 19)
1829 return Error("Invalid record");
1831 MDValueList.AssignValue(
1833 MDSubprogram, Record[0],
1834 (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
1835 getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
1836 getMDOrNull(Record[6]), Record[7], Record[8], Record[9],
1837 getMDOrNull(Record[10]), Record[11], Record[12], Record[13],
1838 Record[14], getMDOrNull(Record[15]), getMDOrNull(Record[16]),
1839 getMDOrNull(Record[17]), getMDOrNull(Record[18]))),
1843 case bitc::METADATA_LEXICAL_BLOCK: {
1844 if (Record.size() != 5)
1845 return Error("Invalid record");
1847 MDValueList.AssignValue(
1848 GET_OR_DISTINCT(MDLexicalBlock, Record[0],
1849 (Context, getMDOrNull(Record[1]),
1850 getMDOrNull(Record[2]), Record[3], Record[4])),
1854 case bitc::METADATA_LEXICAL_BLOCK_FILE: {
1855 if (Record.size() != 4)
1856 return Error("Invalid record");
1858 MDValueList.AssignValue(
1859 GET_OR_DISTINCT(MDLexicalBlockFile, Record[0],
1860 (Context, getMDOrNull(Record[1]),
1861 getMDOrNull(Record[2]), Record[3])),
1865 case bitc::METADATA_NAMESPACE: {
1866 if (Record.size() != 5)
1867 return Error("Invalid record");
1869 MDValueList.AssignValue(
1870 GET_OR_DISTINCT(MDNamespace, Record[0],
1871 (Context, getMDOrNull(Record[1]),
1872 getMDOrNull(Record[2]), getMDString(Record[3]),
1877 case bitc::METADATA_TEMPLATE_TYPE: {
1878 if (Record.size() != 3)
1879 return Error("Invalid record");
1881 MDValueList.AssignValue(GET_OR_DISTINCT(MDTemplateTypeParameter,
1883 (Context, getMDString(Record[1]),
1884 getMDOrNull(Record[2]))),
1888 case bitc::METADATA_TEMPLATE_VALUE: {
1889 if (Record.size() != 5)
1890 return Error("Invalid record");
1892 MDValueList.AssignValue(
1893 GET_OR_DISTINCT(MDTemplateValueParameter, Record[0],
1894 (Context, Record[1], getMDString(Record[2]),
1895 getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
1899 case bitc::METADATA_GLOBAL_VAR: {
1900 if (Record.size() != 11)
1901 return Error("Invalid record");
1903 MDValueList.AssignValue(
1904 GET_OR_DISTINCT(MDGlobalVariable, Record[0],
1905 (Context, getMDOrNull(Record[1]),
1906 getMDString(Record[2]), getMDString(Record[3]),
1907 getMDOrNull(Record[4]), Record[5],
1908 getMDOrNull(Record[6]), Record[7], Record[8],
1909 getMDOrNull(Record[9]), getMDOrNull(Record[10]))),
1913 case bitc::METADATA_LOCAL_VAR: {
1914 if (Record.size() != 10)
1915 return Error("Invalid record");
1917 MDValueList.AssignValue(
1918 GET_OR_DISTINCT(MDLocalVariable, Record[0],
1919 (Context, Record[1], getMDOrNull(Record[2]),
1920 getMDString(Record[3]), getMDOrNull(Record[4]),
1921 Record[5], getMDOrNull(Record[6]), Record[7],
1922 Record[8], getMDOrNull(Record[9]))),
1926 case bitc::METADATA_EXPRESSION: {
1927 if (Record.size() < 1)
1928 return Error("Invalid record");
1930 MDValueList.AssignValue(
1931 GET_OR_DISTINCT(MDExpression, Record[0],
1932 (Context, makeArrayRef(Record).slice(1))),
1936 case bitc::METADATA_OBJC_PROPERTY: {
1937 if (Record.size() != 8)
1938 return Error("Invalid record");
1940 MDValueList.AssignValue(
1941 GET_OR_DISTINCT(MDObjCProperty, Record[0],
1942 (Context, getMDString(Record[1]),
1943 getMDOrNull(Record[2]), Record[3],
1944 getMDString(Record[4]), getMDString(Record[5]),
1945 Record[6], getMDOrNull(Record[7]))),
1949 case bitc::METADATA_IMPORTED_ENTITY: {
1950 if (Record.size() != 6)
1951 return Error("Invalid record");
1953 MDValueList.AssignValue(
1954 GET_OR_DISTINCT(MDImportedEntity, Record[0],
1955 (Context, Record[1], getMDOrNull(Record[2]),
1956 getMDOrNull(Record[3]), Record[4],
1957 getMDString(Record[5]))),
1961 case bitc::METADATA_STRING: {
1962 std::string String(Record.begin(), Record.end());
1963 llvm::UpgradeMDStringConstant(String);
1964 Metadata *MD = MDString::get(Context, String);
1965 MDValueList.AssignValue(MD, NextMDValueNo++);
1968 case bitc::METADATA_KIND: {
1969 if (Record.size() < 2)
1970 return Error("Invalid record");
1972 unsigned Kind = Record[0];
1973 SmallString<8> Name(Record.begin()+1, Record.end());
1975 unsigned NewKind = TheModule->getMDKindID(Name.str());
1976 if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1977 return Error("Conflicting METADATA_KIND records");
1982 #undef GET_OR_DISTINCT
1985 /// decodeSignRotatedValue - Decode a signed value stored with the sign bit in
1986 /// the LSB for dense VBR encoding.
1987 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
1992 // There is no such thing as -0 with integers. "-0" really means MININT.
1996 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
1997 /// values and aliases that we can.
1998 std::error_code BitcodeReader::ResolveGlobalAndAliasInits() {
1999 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
2000 std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
2001 std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
2002 std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
2004 GlobalInitWorklist.swap(GlobalInits);
2005 AliasInitWorklist.swap(AliasInits);
2006 FunctionPrefixWorklist.swap(FunctionPrefixes);
2007 FunctionPrologueWorklist.swap(FunctionPrologues);
2009 while (!GlobalInitWorklist.empty()) {
2010 unsigned ValID = GlobalInitWorklist.back().second;
2011 if (ValID >= ValueList.size()) {
2012 // Not ready to resolve this yet, it requires something later in the file.
2013 GlobalInits.push_back(GlobalInitWorklist.back());
2015 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2016 GlobalInitWorklist.back().first->setInitializer(C);
2018 return Error("Expected a constant");
2020 GlobalInitWorklist.pop_back();
2023 while (!AliasInitWorklist.empty()) {
2024 unsigned ValID = AliasInitWorklist.back().second;
2025 if (ValID >= ValueList.size()) {
2026 AliasInits.push_back(AliasInitWorklist.back());
2028 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2029 AliasInitWorklist.back().first->setAliasee(C);
2031 return Error("Expected a constant");
2033 AliasInitWorklist.pop_back();
2036 while (!FunctionPrefixWorklist.empty()) {
2037 unsigned ValID = FunctionPrefixWorklist.back().second;
2038 if (ValID >= ValueList.size()) {
2039 FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2041 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2042 FunctionPrefixWorklist.back().first->setPrefixData(C);
2044 return Error("Expected a constant");
2046 FunctionPrefixWorklist.pop_back();
2049 while (!FunctionPrologueWorklist.empty()) {
2050 unsigned ValID = FunctionPrologueWorklist.back().second;
2051 if (ValID >= ValueList.size()) {
2052 FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2054 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2055 FunctionPrologueWorklist.back().first->setPrologueData(C);
2057 return Error("Expected a constant");
2059 FunctionPrologueWorklist.pop_back();
2062 return std::error_code();
2065 static APInt ReadWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
2066 SmallVector<uint64_t, 8> Words(Vals.size());
2067 std::transform(Vals.begin(), Vals.end(), Words.begin(),
2068 BitcodeReader::decodeSignRotatedValue);
2070 return APInt(TypeBits, Words);
2073 std::error_code BitcodeReader::ParseConstants() {
2074 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
2075 return Error("Invalid record");
2077 SmallVector<uint64_t, 64> Record;
2079 // Read all the records for this value table.
2080 Type *CurTy = Type::getInt32Ty(Context);
2081 unsigned NextCstNo = ValueList.size();
2083 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2085 switch (Entry.Kind) {
2086 case BitstreamEntry::SubBlock: // Handled for us already.
2087 case BitstreamEntry::Error:
2088 return Error("Malformed block");
2089 case BitstreamEntry::EndBlock:
2090 if (NextCstNo != ValueList.size())
2091 return Error("Invalid ronstant reference");
2093 // Once all the constants have been read, go through and resolve forward
2095 ValueList.ResolveConstantForwardRefs();
2096 return std::error_code();
2097 case BitstreamEntry::Record:
2098 // The interesting case.
2105 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2107 default: // Default behavior: unknown constant
2108 case bitc::CST_CODE_UNDEF: // UNDEF
2109 V = UndefValue::get(CurTy);
2111 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
2113 return Error("Invalid record");
2114 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
2115 return Error("Invalid record");
2116 CurTy = TypeList[Record[0]];
2117 continue; // Skip the ValueList manipulation.
2118 case bitc::CST_CODE_NULL: // NULL
2119 V = Constant::getNullValue(CurTy);
2121 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
2122 if (!CurTy->isIntegerTy() || Record.empty())
2123 return Error("Invalid record");
2124 V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
2126 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
2127 if (!CurTy->isIntegerTy() || Record.empty())
2128 return Error("Invalid record");
2130 APInt VInt = ReadWideAPInt(Record,
2131 cast<IntegerType>(CurTy)->getBitWidth());
2132 V = ConstantInt::get(Context, VInt);
2136 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
2138 return Error("Invalid record");
2139 if (CurTy->isHalfTy())
2140 V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
2141 APInt(16, (uint16_t)Record[0])));
2142 else if (CurTy->isFloatTy())
2143 V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
2144 APInt(32, (uint32_t)Record[0])));
2145 else if (CurTy->isDoubleTy())
2146 V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
2147 APInt(64, Record[0])));
2148 else if (CurTy->isX86_FP80Ty()) {
2149 // Bits are not stored the same way as a normal i80 APInt, compensate.
2150 uint64_t Rearrange[2];
2151 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2152 Rearrange[1] = Record[0] >> 48;
2153 V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
2154 APInt(80, Rearrange)));
2155 } else if (CurTy->isFP128Ty())
2156 V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
2157 APInt(128, Record)));
2158 else if (CurTy->isPPC_FP128Ty())
2159 V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
2160 APInt(128, Record)));
2162 V = UndefValue::get(CurTy);
2166 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2168 return Error("Invalid record");
2170 unsigned Size = Record.size();
2171 SmallVector<Constant*, 16> Elts;
2173 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2174 for (unsigned i = 0; i != Size; ++i)
2175 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
2176 STy->getElementType(i)));
2177 V = ConstantStruct::get(STy, Elts);
2178 } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2179 Type *EltTy = ATy->getElementType();
2180 for (unsigned i = 0; i != Size; ++i)
2181 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2182 V = ConstantArray::get(ATy, Elts);
2183 } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2184 Type *EltTy = VTy->getElementType();
2185 for (unsigned i = 0; i != Size; ++i)
2186 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2187 V = ConstantVector::get(Elts);
2189 V = UndefValue::get(CurTy);
2193 case bitc::CST_CODE_STRING: // STRING: [values]
2194 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2196 return Error("Invalid record");
2198 SmallString<16> Elts(Record.begin(), Record.end());
2199 V = ConstantDataArray::getString(Context, Elts,
2200 BitCode == bitc::CST_CODE_CSTRING);
2203 case bitc::CST_CODE_DATA: {// DATA: [n x value]
2205 return Error("Invalid record");
2207 Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
2208 unsigned Size = Record.size();
2210 if (EltTy->isIntegerTy(8)) {
2211 SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2212 if (isa<VectorType>(CurTy))
2213 V = ConstantDataVector::get(Context, Elts);
2215 V = ConstantDataArray::get(Context, Elts);
2216 } else if (EltTy->isIntegerTy(16)) {
2217 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2218 if (isa<VectorType>(CurTy))
2219 V = ConstantDataVector::get(Context, Elts);
2221 V = ConstantDataArray::get(Context, Elts);
2222 } else if (EltTy->isIntegerTy(32)) {
2223 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2224 if (isa<VectorType>(CurTy))
2225 V = ConstantDataVector::get(Context, Elts);
2227 V = ConstantDataArray::get(Context, Elts);
2228 } else if (EltTy->isIntegerTy(64)) {
2229 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2230 if (isa<VectorType>(CurTy))
2231 V = ConstantDataVector::get(Context, Elts);
2233 V = ConstantDataArray::get(Context, Elts);
2234 } else if (EltTy->isFloatTy()) {
2235 SmallVector<float, 16> Elts(Size);
2236 std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
2237 if (isa<VectorType>(CurTy))
2238 V = ConstantDataVector::get(Context, Elts);
2240 V = ConstantDataArray::get(Context, Elts);
2241 } else if (EltTy->isDoubleTy()) {
2242 SmallVector<double, 16> Elts(Size);
2243 std::transform(Record.begin(), Record.end(), Elts.begin(),
2245 if (isa<VectorType>(CurTy))
2246 V = ConstantDataVector::get(Context, Elts);
2248 V = ConstantDataArray::get(Context, Elts);
2250 return Error("Invalid type for value");
2255 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
2256 if (Record.size() < 3)
2257 return Error("Invalid record");
2258 int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
2260 V = UndefValue::get(CurTy); // Unknown binop.
2262 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2263 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
2265 if (Record.size() >= 4) {
2266 if (Opc == Instruction::Add ||
2267 Opc == Instruction::Sub ||
2268 Opc == Instruction::Mul ||
2269 Opc == Instruction::Shl) {
2270 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2271 Flags |= OverflowingBinaryOperator::NoSignedWrap;
2272 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2273 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2274 } else if (Opc == Instruction::SDiv ||
2275 Opc == Instruction::UDiv ||
2276 Opc == Instruction::LShr ||
2277 Opc == Instruction::AShr) {
2278 if (Record[3] & (1 << bitc::PEO_EXACT))
2279 Flags |= SDivOperator::IsExact;
2282 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
2286 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
2287 if (Record.size() < 3)
2288 return Error("Invalid record");
2289 int Opc = GetDecodedCastOpcode(Record[0]);
2291 V = UndefValue::get(CurTy); // Unknown cast.
2293 Type *OpTy = getTypeByID(Record[1]);
2295 return Error("Invalid record");
2296 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
2297 V = UpgradeBitCastExpr(Opc, Op, CurTy);
2298 if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
2302 case bitc::CST_CODE_CE_INBOUNDS_GEP:
2303 case bitc::CST_CODE_CE_GEP: { // CE_GEP: [n x operands]
2305 Type *PointeeType = nullptr;
2306 if (Record.size() % 2)
2307 PointeeType = getTypeByID(Record[OpNum++]);
2308 SmallVector<Constant*, 16> Elts;
2309 while (OpNum != Record.size()) {
2310 Type *ElTy = getTypeByID(Record[OpNum++]);
2312 return Error("Invalid record");
2313 Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
2316 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2317 V = ConstantExpr::getGetElementPtr(Elts[0], Indices,
2319 bitc::CST_CODE_CE_INBOUNDS_GEP);
2321 PointeeType != cast<GEPOperator>(V)->getSourceElementType())
2322 return Error("Explicit gep operator type does not match pointee type "
2323 "of pointer operand");
2326 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
2327 if (Record.size() < 3)
2328 return Error("Invalid record");
2330 Type *SelectorTy = Type::getInt1Ty(Context);
2332 // If CurTy is a vector of length n, then Record[0] must be a <n x i1>
2333 // vector. Otherwise, it must be a single bit.
2334 if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
2335 SelectorTy = VectorType::get(Type::getInt1Ty(Context),
2336 VTy->getNumElements());
2338 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2340 ValueList.getConstantFwdRef(Record[1],CurTy),
2341 ValueList.getConstantFwdRef(Record[2],CurTy));
2344 case bitc::CST_CODE_CE_EXTRACTELT
2345 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
2346 if (Record.size() < 3)
2347 return Error("Invalid record");
2349 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2351 return Error("Invalid record");
2352 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2353 Constant *Op1 = nullptr;
2354 if (Record.size() == 4) {
2355 Type *IdxTy = getTypeByID(Record[2]);
2357 return Error("Invalid record");
2358 Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2359 } else // TODO: Remove with llvm 4.0
2360 Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2362 return Error("Invalid record");
2363 V = ConstantExpr::getExtractElement(Op0, Op1);
2366 case bitc::CST_CODE_CE_INSERTELT
2367 : { // CE_INSERTELT: [opval, opval, opty, opval]
2368 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2369 if (Record.size() < 3 || !OpTy)
2370 return Error("Invalid record");
2371 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2372 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2373 OpTy->getElementType());
2374 Constant *Op2 = nullptr;
2375 if (Record.size() == 4) {
2376 Type *IdxTy = getTypeByID(Record[2]);
2378 return Error("Invalid record");
2379 Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2380 } else // TODO: Remove with llvm 4.0
2381 Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2383 return Error("Invalid record");
2384 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
2387 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
2388 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2389 if (Record.size() < 3 || !OpTy)
2390 return Error("Invalid record");
2391 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2392 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
2393 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2394 OpTy->getNumElements());
2395 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
2396 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2399 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
2400 VectorType *RTy = dyn_cast<VectorType>(CurTy);
2402 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2403 if (Record.size() < 4 || !RTy || !OpTy)
2404 return Error("Invalid record");
2405 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2406 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2407 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2408 RTy->getNumElements());
2409 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
2410 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2413 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
2414 if (Record.size() < 4)
2415 return Error("Invalid record");
2416 Type *OpTy = getTypeByID(Record[0]);
2418 return Error("Invalid record");
2419 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2420 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2422 if (OpTy->isFPOrFPVectorTy())
2423 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
2425 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
2428 // This maintains backward compatibility, pre-asm dialect keywords.
2429 // FIXME: Remove with the 4.0 release.
2430 case bitc::CST_CODE_INLINEASM_OLD: {
2431 if (Record.size() < 2)
2432 return Error("Invalid record");
2433 std::string AsmStr, ConstrStr;
2434 bool HasSideEffects = Record[0] & 1;
2435 bool IsAlignStack = Record[0] >> 1;
2436 unsigned AsmStrSize = Record[1];
2437 if (2+AsmStrSize >= Record.size())
2438 return Error("Invalid record");
2439 unsigned ConstStrSize = Record[2+AsmStrSize];
2440 if (3+AsmStrSize+ConstStrSize > Record.size())
2441 return Error("Invalid record");
2443 for (unsigned i = 0; i != AsmStrSize; ++i)
2444 AsmStr += (char)Record[2+i];
2445 for (unsigned i = 0; i != ConstStrSize; ++i)
2446 ConstrStr += (char)Record[3+AsmStrSize+i];
2447 PointerType *PTy = cast<PointerType>(CurTy);
2448 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2449 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
2452 // This version adds support for the asm dialect keywords (e.g.,
2454 case bitc::CST_CODE_INLINEASM: {
2455 if (Record.size() < 2)
2456 return Error("Invalid record");
2457 std::string AsmStr, ConstrStr;
2458 bool HasSideEffects = Record[0] & 1;
2459 bool IsAlignStack = (Record[0] >> 1) & 1;
2460 unsigned AsmDialect = Record[0] >> 2;
2461 unsigned AsmStrSize = Record[1];
2462 if (2+AsmStrSize >= Record.size())
2463 return Error("Invalid record");
2464 unsigned ConstStrSize = Record[2+AsmStrSize];
2465 if (3+AsmStrSize+ConstStrSize > Record.size())
2466 return Error("Invalid record");
2468 for (unsigned i = 0; i != AsmStrSize; ++i)
2469 AsmStr += (char)Record[2+i];
2470 for (unsigned i = 0; i != ConstStrSize; ++i)
2471 ConstrStr += (char)Record[3+AsmStrSize+i];
2472 PointerType *PTy = cast<PointerType>(CurTy);
2473 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2474 AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
2475 InlineAsm::AsmDialect(AsmDialect));
2478 case bitc::CST_CODE_BLOCKADDRESS:{
2479 if (Record.size() < 3)
2480 return Error("Invalid record");
2481 Type *FnTy = getTypeByID(Record[0]);
2483 return Error("Invalid record");
2485 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
2487 return Error("Invalid record");
2489 // Don't let Fn get dematerialized.
2490 BlockAddressesTaken.insert(Fn);
2492 // If the function is already parsed we can insert the block address right
2495 unsigned BBID = Record[2];
2497 // Invalid reference to entry block.
2498 return Error("Invalid ID");
2500 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
2501 for (size_t I = 0, E = BBID; I != E; ++I) {
2503 return Error("Invalid ID");
2508 // Otherwise insert a placeholder and remember it so it can be inserted
2509 // when the function is parsed.
2510 auto &FwdBBs = BasicBlockFwdRefs[Fn];
2512 BasicBlockFwdRefQueue.push_back(Fn);
2513 if (FwdBBs.size() < BBID + 1)
2514 FwdBBs.resize(BBID + 1);
2516 FwdBBs[BBID] = BasicBlock::Create(Context);
2519 V = BlockAddress::get(Fn, BB);
2524 ValueList.AssignValue(V, NextCstNo);
2529 std::error_code BitcodeReader::ParseUseLists() {
2530 if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
2531 return Error("Invalid record");
2533 // Read all the records.
2534 SmallVector<uint64_t, 64> Record;
2536 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2538 switch (Entry.Kind) {
2539 case BitstreamEntry::SubBlock: // Handled for us already.
2540 case BitstreamEntry::Error:
2541 return Error("Malformed block");
2542 case BitstreamEntry::EndBlock:
2543 return std::error_code();
2544 case BitstreamEntry::Record:
2545 // The interesting case.
2549 // Read a use list record.
2552 switch (Stream.readRecord(Entry.ID, Record)) {
2553 default: // Default behavior: unknown type.
2555 case bitc::USELIST_CODE_BB:
2558 case bitc::USELIST_CODE_DEFAULT: {
2559 unsigned RecordLength = Record.size();
2560 if (RecordLength < 3)
2561 // Records should have at least an ID and two indexes.
2562 return Error("Invalid record");
2563 unsigned ID = Record.back();
2568 assert(ID < FunctionBBs.size() && "Basic block not found");
2569 V = FunctionBBs[ID];
2572 unsigned NumUses = 0;
2573 SmallDenseMap<const Use *, unsigned, 16> Order;
2574 for (const Use &U : V->uses()) {
2575 if (++NumUses > Record.size())
2577 Order[&U] = Record[NumUses - 1];
2579 if (Order.size() != Record.size() || NumUses > Record.size())
2580 // Mismatches can happen if the functions are being materialized lazily
2581 // (out-of-order), or a value has been upgraded.
2584 V->sortUseList([&](const Use &L, const Use &R) {
2585 return Order.lookup(&L) < Order.lookup(&R);
2593 /// When we see the block for metadata, remember where it is and then skip it.
2594 /// This lets us lazily deserialize the metadata.
2595 std::error_code BitcodeReader::rememberAndSkipMetadata() {
2596 // Save the current stream state.
2597 uint64_t CurBit = Stream.GetCurrentBitNo();
2598 DeferredMetadataInfo.push_back(CurBit);
2600 // Skip over the block for now.
2601 if (Stream.SkipBlock())
2602 return Error("Invalid record");
2603 return std::error_code();
2606 std::error_code BitcodeReader::materializeMetadata() {
2607 for (uint64_t BitPos : DeferredMetadataInfo) {
2608 // Move the bit stream to the saved position.
2609 Stream.JumpToBit(BitPos);
2610 if (std::error_code EC = ParseMetadata())
2613 DeferredMetadataInfo.clear();
2614 return std::error_code();
2617 void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
2619 /// RememberAndSkipFunctionBody - When we see the block for a function body,
2620 /// remember where it is and then skip it. This lets us lazily deserialize the
2622 std::error_code BitcodeReader::RememberAndSkipFunctionBody() {
2623 // Get the function we are talking about.
2624 if (FunctionsWithBodies.empty())
2625 return Error("Insufficient function protos");
2627 Function *Fn = FunctionsWithBodies.back();
2628 FunctionsWithBodies.pop_back();
2630 // Save the current stream state.
2631 uint64_t CurBit = Stream.GetCurrentBitNo();
2632 DeferredFunctionInfo[Fn] = CurBit;
2634 // Skip over the function block for now.
2635 if (Stream.SkipBlock())
2636 return Error("Invalid record");
2637 return std::error_code();
2640 std::error_code BitcodeReader::GlobalCleanup() {
2641 // Patch the initializers for globals and aliases up.
2642 ResolveGlobalAndAliasInits();
2643 if (!GlobalInits.empty() || !AliasInits.empty())
2644 return Error("Malformed global initializer set");
2646 // Look for intrinsic functions which need to be upgraded at some point
2647 for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
2650 if (UpgradeIntrinsicFunction(FI, NewFn))
2651 UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
2654 // Look for global variables which need to be renamed.
2655 for (Module::global_iterator
2656 GI = TheModule->global_begin(), GE = TheModule->global_end();
2658 GlobalVariable *GV = GI++;
2659 UpgradeGlobalVariable(GV);
2662 // Force deallocation of memory for these vectors to favor the client that
2663 // want lazy deserialization.
2664 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
2665 std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
2666 return std::error_code();
2669 std::error_code BitcodeReader::ParseModule(bool Resume,
2670 bool ShouldLazyLoadMetadata) {
2672 Stream.JumpToBit(NextUnreadBit);
2673 else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
2674 return Error("Invalid record");
2676 SmallVector<uint64_t, 64> Record;
2677 std::vector<std::string> SectionTable;
2678 std::vector<std::string> GCTable;
2680 // Read all the records for this module.
2682 BitstreamEntry Entry = Stream.advance();
2684 switch (Entry.Kind) {
2685 case BitstreamEntry::Error:
2686 return Error("Malformed block");
2687 case BitstreamEntry::EndBlock:
2688 return GlobalCleanup();
2690 case BitstreamEntry::SubBlock:
2692 default: // Skip unknown content.
2693 if (Stream.SkipBlock())
2694 return Error("Invalid record");
2696 case bitc::BLOCKINFO_BLOCK_ID:
2697 if (Stream.ReadBlockInfoBlock())
2698 return Error("Malformed block");
2700 case bitc::PARAMATTR_BLOCK_ID:
2701 if (std::error_code EC = ParseAttributeBlock())
2704 case bitc::PARAMATTR_GROUP_BLOCK_ID:
2705 if (std::error_code EC = ParseAttributeGroupBlock())
2708 case bitc::TYPE_BLOCK_ID_NEW:
2709 if (std::error_code EC = ParseTypeTable())
2712 case bitc::VALUE_SYMTAB_BLOCK_ID:
2713 if (std::error_code EC = ParseValueSymbolTable())
2715 SeenValueSymbolTable = true;
2717 case bitc::CONSTANTS_BLOCK_ID:
2718 if (std::error_code EC = ParseConstants())
2720 if (std::error_code EC = ResolveGlobalAndAliasInits())
2723 case bitc::METADATA_BLOCK_ID:
2724 if (ShouldLazyLoadMetadata && !IsMetadataMaterialized) {
2725 if (std::error_code EC = rememberAndSkipMetadata())
2729 assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
2730 if (std::error_code EC = ParseMetadata())
2733 case bitc::FUNCTION_BLOCK_ID:
2734 // If this is the first function body we've seen, reverse the
2735 // FunctionsWithBodies list.
2736 if (!SeenFirstFunctionBody) {
2737 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
2738 if (std::error_code EC = GlobalCleanup())
2740 SeenFirstFunctionBody = true;
2743 if (std::error_code EC = RememberAndSkipFunctionBody())
2745 // For streaming bitcode, suspend parsing when we reach the function
2746 // bodies. Subsequent materialization calls will resume it when
2747 // necessary. For streaming, the function bodies must be at the end of
2748 // the bitcode. If the bitcode file is old, the symbol table will be
2749 // at the end instead and will not have been seen yet. In this case,
2750 // just finish the parse now.
2751 if (LazyStreamer && SeenValueSymbolTable) {
2752 NextUnreadBit = Stream.GetCurrentBitNo();
2753 return std::error_code();
2756 case bitc::USELIST_BLOCK_ID:
2757 if (std::error_code EC = ParseUseLists())
2763 case BitstreamEntry::Record:
2764 // The interesting case.
2770 switch (Stream.readRecord(Entry.ID, Record)) {
2771 default: break; // Default behavior, ignore unknown content.
2772 case bitc::MODULE_CODE_VERSION: { // VERSION: [version#]
2773 if (Record.size() < 1)
2774 return Error("Invalid record");
2775 // Only version #0 and #1 are supported so far.
2776 unsigned module_version = Record[0];
2777 switch (module_version) {
2779 return Error("Invalid value");
2781 UseRelativeIDs = false;
2784 UseRelativeIDs = true;
2789 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
2791 if (ConvertToString(Record, 0, S))
2792 return Error("Invalid record");
2793 TheModule->setTargetTriple(S);
2796 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
2798 if (ConvertToString(Record, 0, S))
2799 return Error("Invalid record");
2800 TheModule->setDataLayout(S);
2803 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
2805 if (ConvertToString(Record, 0, S))
2806 return Error("Invalid record");
2807 TheModule->setModuleInlineAsm(S);
2810 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
2811 // FIXME: Remove in 4.0.
2813 if (ConvertToString(Record, 0, S))
2814 return Error("Invalid record");
2818 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
2820 if (ConvertToString(Record, 0, S))
2821 return Error("Invalid record");
2822 SectionTable.push_back(S);
2825 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
2827 if (ConvertToString(Record, 0, S))
2828 return Error("Invalid record");
2829 GCTable.push_back(S);
2832 case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
2833 if (Record.size() < 2)
2834 return Error("Invalid record");
2835 Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
2836 unsigned ComdatNameSize = Record[1];
2837 std::string ComdatName;
2838 ComdatName.reserve(ComdatNameSize);
2839 for (unsigned i = 0; i != ComdatNameSize; ++i)
2840 ComdatName += (char)Record[2 + i];
2841 Comdat *C = TheModule->getOrInsertComdat(ComdatName);
2842 C->setSelectionKind(SK);
2843 ComdatList.push_back(C);
2846 // GLOBALVAR: [pointer type, isconst, initid,
2847 // linkage, alignment, section, visibility, threadlocal,
2848 // unnamed_addr, externally_initialized, dllstorageclass,
2850 case bitc::MODULE_CODE_GLOBALVAR: {
2851 if (Record.size() < 6)
2852 return Error("Invalid record");
2853 Type *Ty = getTypeByID(Record[0]);
2855 return Error("Invalid record");
2856 if (!Ty->isPointerTy())
2857 return Error("Invalid type for value");
2858 unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
2859 Ty = cast<PointerType>(Ty)->getElementType();
2861 bool isConstant = Record[1];
2862 uint64_t RawLinkage = Record[3];
2863 GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
2865 if (std::error_code EC = parseAlignmentValue(Record[4], Alignment))
2867 std::string Section;
2869 if (Record[5]-1 >= SectionTable.size())
2870 return Error("Invalid ID");
2871 Section = SectionTable[Record[5]-1];
2873 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
2874 // Local linkage must have default visibility.
2875 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
2876 // FIXME: Change to an error if non-default in 4.0.
2877 Visibility = GetDecodedVisibility(Record[6]);
2879 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
2880 if (Record.size() > 7)
2881 TLM = GetDecodedThreadLocalMode(Record[7]);
2883 bool UnnamedAddr = false;
2884 if (Record.size() > 8)
2885 UnnamedAddr = Record[8];
2887 bool ExternallyInitialized = false;
2888 if (Record.size() > 9)
2889 ExternallyInitialized = Record[9];
2891 GlobalVariable *NewGV =
2892 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
2893 TLM, AddressSpace, ExternallyInitialized);
2894 NewGV->setAlignment(Alignment);
2895 if (!Section.empty())
2896 NewGV->setSection(Section);
2897 NewGV->setVisibility(Visibility);
2898 NewGV->setUnnamedAddr(UnnamedAddr);
2900 if (Record.size() > 10)
2901 NewGV->setDLLStorageClass(GetDecodedDLLStorageClass(Record[10]));
2903 UpgradeDLLImportExportLinkage(NewGV, RawLinkage);
2905 ValueList.push_back(NewGV);
2907 // Remember which value to use for the global initializer.
2908 if (unsigned InitID = Record[2])
2909 GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
2911 if (Record.size() > 11) {
2912 if (unsigned ComdatID = Record[11]) {
2913 assert(ComdatID <= ComdatList.size());
2914 NewGV->setComdat(ComdatList[ComdatID - 1]);
2916 } else if (hasImplicitComdat(RawLinkage)) {
2917 NewGV->setComdat(reinterpret_cast<Comdat *>(1));
2921 // FUNCTION: [type, callingconv, isproto, linkage, paramattr,
2922 // alignment, section, visibility, gc, unnamed_addr,
2923 // prologuedata, dllstorageclass, comdat, prefixdata]
2924 case bitc::MODULE_CODE_FUNCTION: {
2925 if (Record.size() < 8)
2926 return Error("Invalid record");
2927 Type *Ty = getTypeByID(Record[0]);
2929 return Error("Invalid record");
2930 if (!Ty->isPointerTy())
2931 return Error("Invalid type for value");
2933 dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
2935 return Error("Invalid type for value");
2937 Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
2940 Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
2941 bool isProto = Record[2];
2942 uint64_t RawLinkage = Record[3];
2943 Func->setLinkage(getDecodedLinkage(RawLinkage));
2944 Func->setAttributes(getAttributes(Record[4]));
2947 if (std::error_code EC = parseAlignmentValue(Record[5], Alignment))
2949 Func->setAlignment(Alignment);
2951 if (Record[6]-1 >= SectionTable.size())
2952 return Error("Invalid ID");
2953 Func->setSection(SectionTable[Record[6]-1]);
2955 // Local linkage must have default visibility.
2956 if (!Func->hasLocalLinkage())
2957 // FIXME: Change to an error if non-default in 4.0.
2958 Func->setVisibility(GetDecodedVisibility(Record[7]));
2959 if (Record.size() > 8 && Record[8]) {
2960 if (Record[8]-1 > GCTable.size())
2961 return Error("Invalid ID");
2962 Func->setGC(GCTable[Record[8]-1].c_str());
2964 bool UnnamedAddr = false;
2965 if (Record.size() > 9)
2966 UnnamedAddr = Record[9];
2967 Func->setUnnamedAddr(UnnamedAddr);
2968 if (Record.size() > 10 && Record[10] != 0)
2969 FunctionPrologues.push_back(std::make_pair(Func, Record[10]-1));
2971 if (Record.size() > 11)
2972 Func->setDLLStorageClass(GetDecodedDLLStorageClass(Record[11]));
2974 UpgradeDLLImportExportLinkage(Func, RawLinkage);
2976 if (Record.size() > 12) {
2977 if (unsigned ComdatID = Record[12]) {
2978 assert(ComdatID <= ComdatList.size());
2979 Func->setComdat(ComdatList[ComdatID - 1]);
2981 } else if (hasImplicitComdat(RawLinkage)) {
2982 Func->setComdat(reinterpret_cast<Comdat *>(1));
2985 if (Record.size() > 13 && Record[13] != 0)
2986 FunctionPrefixes.push_back(std::make_pair(Func, Record[13]-1));
2988 ValueList.push_back(Func);
2990 // If this is a function with a body, remember the prototype we are
2991 // creating now, so that we can match up the body with them later.
2993 Func->setIsMaterializable(true);
2994 FunctionsWithBodies.push_back(Func);
2996 DeferredFunctionInfo[Func] = 0;
3000 // ALIAS: [alias type, aliasee val#, linkage]
3001 // ALIAS: [alias type, aliasee val#, linkage, visibility, dllstorageclass]
3002 case bitc::MODULE_CODE_ALIAS: {
3003 if (Record.size() < 3)
3004 return Error("Invalid record");
3005 Type *Ty = getTypeByID(Record[0]);
3007 return Error("Invalid record");
3008 auto *PTy = dyn_cast<PointerType>(Ty);
3010 return Error("Invalid type for value");
3013 GlobalAlias::create(PTy->getElementType(), PTy->getAddressSpace(),
3014 getDecodedLinkage(Record[2]), "", TheModule);
3015 // Old bitcode files didn't have visibility field.
3016 // Local linkage must have default visibility.
3017 if (Record.size() > 3 && !NewGA->hasLocalLinkage())
3018 // FIXME: Change to an error if non-default in 4.0.
3019 NewGA->setVisibility(GetDecodedVisibility(Record[3]));
3020 if (Record.size() > 4)
3021 NewGA->setDLLStorageClass(GetDecodedDLLStorageClass(Record[4]));
3023 UpgradeDLLImportExportLinkage(NewGA, Record[2]);
3024 if (Record.size() > 5)
3025 NewGA->setThreadLocalMode(GetDecodedThreadLocalMode(Record[5]));
3026 if (Record.size() > 6)
3027 NewGA->setUnnamedAddr(Record[6]);
3028 ValueList.push_back(NewGA);
3029 AliasInits.push_back(std::make_pair(NewGA, Record[1]));
3032 /// MODULE_CODE_PURGEVALS: [numvals]
3033 case bitc::MODULE_CODE_PURGEVALS:
3034 // Trim down the value list to the specified size.
3035 if (Record.size() < 1 || Record[0] > ValueList.size())
3036 return Error("Invalid record");
3037 ValueList.shrinkTo(Record[0]);
3044 std::error_code BitcodeReader::ParseBitcodeInto(Module *M,
3045 bool ShouldLazyLoadMetadata) {
3046 TheModule = nullptr;
3048 if (std::error_code EC = InitStream())
3051 // Sniff for the signature.
3052 if (Stream.Read(8) != 'B' ||
3053 Stream.Read(8) != 'C' ||
3054 Stream.Read(4) != 0x0 ||
3055 Stream.Read(4) != 0xC ||
3056 Stream.Read(4) != 0xE ||
3057 Stream.Read(4) != 0xD)
3058 return Error("Invalid bitcode signature");
3060 // We expect a number of well-defined blocks, though we don't necessarily
3061 // need to understand them all.
3063 if (Stream.AtEndOfStream())
3064 return std::error_code();
3066 BitstreamEntry Entry =
3067 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
3069 switch (Entry.Kind) {
3070 case BitstreamEntry::Error:
3071 return Error("Malformed block");
3072 case BitstreamEntry::EndBlock:
3073 return std::error_code();
3075 case BitstreamEntry::SubBlock:
3077 case bitc::BLOCKINFO_BLOCK_ID:
3078 if (Stream.ReadBlockInfoBlock())
3079 return Error("Malformed block");
3081 case bitc::MODULE_BLOCK_ID:
3082 // Reject multiple MODULE_BLOCK's in a single bitstream.
3084 return Error("Invalid multiple blocks");
3086 if (std::error_code EC = ParseModule(false, ShouldLazyLoadMetadata))
3089 return std::error_code();
3092 if (Stream.SkipBlock())
3093 return Error("Invalid record");
3097 case BitstreamEntry::Record:
3098 // There should be no records in the top-level of blocks.
3100 // The ranlib in Xcode 4 will align archive members by appending newlines
3101 // to the end of them. If this file size is a multiple of 4 but not 8, we
3102 // have to read and ignore these final 4 bytes :-(
3103 if (Stream.getAbbrevIDWidth() == 2 && Entry.ID == 2 &&
3104 Stream.Read(6) == 2 && Stream.Read(24) == 0xa0a0a &&
3105 Stream.AtEndOfStream())
3106 return std::error_code();
3108 return Error("Invalid record");
3113 ErrorOr<std::string> BitcodeReader::parseModuleTriple() {
3114 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3115 return Error("Invalid record");
3117 SmallVector<uint64_t, 64> Record;
3120 // Read all the records for this module.
3122 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3124 switch (Entry.Kind) {
3125 case BitstreamEntry::SubBlock: // Handled for us already.
3126 case BitstreamEntry::Error:
3127 return Error("Malformed block");
3128 case BitstreamEntry::EndBlock:
3130 case BitstreamEntry::Record:
3131 // The interesting case.
3136 switch (Stream.readRecord(Entry.ID, Record)) {
3137 default: break; // Default behavior, ignore unknown content.
3138 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
3140 if (ConvertToString(Record, 0, S))
3141 return Error("Invalid record");
3148 llvm_unreachable("Exit infinite loop");
3151 ErrorOr<std::string> BitcodeReader::parseTriple() {
3152 if (std::error_code EC = InitStream())
3155 // Sniff for the signature.
3156 if (Stream.Read(8) != 'B' ||
3157 Stream.Read(8) != 'C' ||
3158 Stream.Read(4) != 0x0 ||
3159 Stream.Read(4) != 0xC ||
3160 Stream.Read(4) != 0xE ||
3161 Stream.Read(4) != 0xD)
3162 return Error("Invalid bitcode signature");
3164 // We expect a number of well-defined blocks, though we don't necessarily
3165 // need to understand them all.
3167 BitstreamEntry Entry = Stream.advance();
3169 switch (Entry.Kind) {
3170 case BitstreamEntry::Error:
3171 return Error("Malformed block");
3172 case BitstreamEntry::EndBlock:
3173 return std::error_code();
3175 case BitstreamEntry::SubBlock:
3176 if (Entry.ID == bitc::MODULE_BLOCK_ID)
3177 return parseModuleTriple();
3179 // Ignore other sub-blocks.
3180 if (Stream.SkipBlock())
3181 return Error("Malformed block");
3184 case BitstreamEntry::Record:
3185 Stream.skipRecord(Entry.ID);
3191 /// ParseMetadataAttachment - Parse metadata attachments.
3192 std::error_code BitcodeReader::ParseMetadataAttachment() {
3193 if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
3194 return Error("Invalid record");
3196 SmallVector<uint64_t, 64> Record;
3198 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
3200 switch (Entry.Kind) {
3201 case BitstreamEntry::SubBlock: // Handled for us already.
3202 case BitstreamEntry::Error:
3203 return Error("Malformed block");
3204 case BitstreamEntry::EndBlock:
3205 return std::error_code();
3206 case BitstreamEntry::Record:
3207 // The interesting case.
3211 // Read a metadata attachment record.
3213 switch (Stream.readRecord(Entry.ID, Record)) {
3214 default: // Default behavior: ignore.
3216 case bitc::METADATA_ATTACHMENT: {
3217 unsigned RecordLength = Record.size();
3218 if (Record.empty() || (RecordLength - 1) % 2 == 1)
3219 return Error("Invalid record");
3220 Instruction *Inst = InstructionList[Record[0]];
3221 for (unsigned i = 1; i != RecordLength; i = i+2) {
3222 unsigned Kind = Record[i];
3223 DenseMap<unsigned, unsigned>::iterator I =
3224 MDKindMap.find(Kind);
3225 if (I == MDKindMap.end())
3226 return Error("Invalid ID");
3227 Metadata *Node = MDValueList.getValueFwdRef(Record[i + 1]);
3228 if (isa<LocalAsMetadata>(Node))
3229 // Drop the attachment. This used to be legal, but there's no
3232 Inst->setMetadata(I->second, cast<MDNode>(Node));
3233 if (I->second == LLVMContext::MD_tbaa)
3234 InstsWithTBAATag.push_back(Inst);
3242 /// ParseFunctionBody - Lazily parse the specified function body block.
3243 std::error_code BitcodeReader::ParseFunctionBody(Function *F) {
3244 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
3245 return Error("Invalid record");
3247 InstructionList.clear();
3248 unsigned ModuleValueListSize = ValueList.size();
3249 unsigned ModuleMDValueListSize = MDValueList.size();
3251 // Add all the function arguments to the value table.
3252 for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
3253 ValueList.push_back(I);
3255 unsigned NextValueNo = ValueList.size();
3256 BasicBlock *CurBB = nullptr;
3257 unsigned CurBBNo = 0;
3260 auto getLastInstruction = [&]() -> Instruction * {
3261 if (CurBB && !CurBB->empty())
3262 return &CurBB->back();
3263 else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
3264 !FunctionBBs[CurBBNo - 1]->empty())
3265 return &FunctionBBs[CurBBNo - 1]->back();
3269 // Read all the records.
3270 SmallVector<uint64_t, 64> Record;
3272 BitstreamEntry Entry = Stream.advance();
3274 switch (Entry.Kind) {
3275 case BitstreamEntry::Error:
3276 return Error("Malformed block");
3277 case BitstreamEntry::EndBlock:
3278 goto OutOfRecordLoop;
3280 case BitstreamEntry::SubBlock:
3282 default: // Skip unknown content.
3283 if (Stream.SkipBlock())
3284 return Error("Invalid record");
3286 case bitc::CONSTANTS_BLOCK_ID:
3287 if (std::error_code EC = ParseConstants())
3289 NextValueNo = ValueList.size();
3291 case bitc::VALUE_SYMTAB_BLOCK_ID:
3292 if (std::error_code EC = ParseValueSymbolTable())
3295 case bitc::METADATA_ATTACHMENT_ID:
3296 if (std::error_code EC = ParseMetadataAttachment())
3299 case bitc::METADATA_BLOCK_ID:
3300 if (std::error_code EC = ParseMetadata())
3303 case bitc::USELIST_BLOCK_ID:
3304 if (std::error_code EC = ParseUseLists())
3310 case BitstreamEntry::Record:
3311 // The interesting case.
3317 Instruction *I = nullptr;
3318 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
3320 default: // Default behavior: reject
3321 return Error("Invalid value");
3322 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
3323 if (Record.size() < 1 || Record[0] == 0)
3324 return Error("Invalid record");
3325 // Create all the basic blocks for the function.
3326 FunctionBBs.resize(Record[0]);
3328 // See if anything took the address of blocks in this function.
3329 auto BBFRI = BasicBlockFwdRefs.find(F);
3330 if (BBFRI == BasicBlockFwdRefs.end()) {
3331 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
3332 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
3334 auto &BBRefs = BBFRI->second;
3335 // Check for invalid basic block references.
3336 if (BBRefs.size() > FunctionBBs.size())
3337 return Error("Invalid ID");
3338 assert(!BBRefs.empty() && "Unexpected empty array");
3339 assert(!BBRefs.front() && "Invalid reference to entry block");
3340 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
3342 if (I < RE && BBRefs[I]) {
3343 BBRefs[I]->insertInto(F);
3344 FunctionBBs[I] = BBRefs[I];
3346 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
3349 // Erase from the table.
3350 BasicBlockFwdRefs.erase(BBFRI);
3353 CurBB = FunctionBBs[0];
3357 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
3358 // This record indicates that the last instruction is at the same
3359 // location as the previous instruction with a location.
3360 I = getLastInstruction();
3363 return Error("Invalid record");
3364 I->setDebugLoc(LastLoc);
3368 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
3369 I = getLastInstruction();
3370 if (!I || Record.size() < 4)
3371 return Error("Invalid record");
3373 unsigned Line = Record[0], Col = Record[1];
3374 unsigned ScopeID = Record[2], IAID = Record[3];
3376 MDNode *Scope = nullptr, *IA = nullptr;
3377 if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
3378 if (IAID) IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
3379 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
3380 I->setDebugLoc(LastLoc);
3385 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
3388 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3389 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
3390 OpNum+1 > Record.size())
3391 return Error("Invalid record");
3393 int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
3395 return Error("Invalid record");
3396 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
3397 InstructionList.push_back(I);
3398 if (OpNum < Record.size()) {
3399 if (Opc == Instruction::Add ||
3400 Opc == Instruction::Sub ||
3401 Opc == Instruction::Mul ||
3402 Opc == Instruction::Shl) {
3403 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
3404 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
3405 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
3406 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
3407 } else if (Opc == Instruction::SDiv ||
3408 Opc == Instruction::UDiv ||
3409 Opc == Instruction::LShr ||
3410 Opc == Instruction::AShr) {
3411 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
3412 cast<BinaryOperator>(I)->setIsExact(true);
3413 } else if (isa<FPMathOperator>(I)) {
3415 if (0 != (Record[OpNum] & FastMathFlags::UnsafeAlgebra))
3416 FMF.setUnsafeAlgebra();
3417 if (0 != (Record[OpNum] & FastMathFlags::NoNaNs))
3419 if (0 != (Record[OpNum] & FastMathFlags::NoInfs))
3421 if (0 != (Record[OpNum] & FastMathFlags::NoSignedZeros))
3422 FMF.setNoSignedZeros();
3423 if (0 != (Record[OpNum] & FastMathFlags::AllowReciprocal))
3424 FMF.setAllowReciprocal();
3426 I->setFastMathFlags(FMF);
3432 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
3435 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3436 OpNum+2 != Record.size())
3437 return Error("Invalid record");
3439 Type *ResTy = getTypeByID(Record[OpNum]);
3440 int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
3441 if (Opc == -1 || !ResTy)
3442 return Error("Invalid record");
3443 Instruction *Temp = nullptr;
3444 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
3446 InstructionList.push_back(Temp);
3447 CurBB->getInstList().push_back(Temp);
3450 I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
3452 InstructionList.push_back(I);
3455 case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:
3456 case bitc::FUNC_CODE_INST_GEP_OLD:
3457 case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
3463 if (BitCode == bitc::FUNC_CODE_INST_GEP) {
3464 InBounds = Record[OpNum++];
3465 Ty = getTypeByID(Record[OpNum++]);
3467 InBounds = BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD;
3472 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
3473 return Error("Invalid record");
3477 cast<SequentialType>(BasePtr->getType()->getScalarType())
3480 "Explicit gep type does not match pointee type of pointer operand");
3482 SmallVector<Value*, 16> GEPIdx;
3483 while (OpNum != Record.size()) {
3485 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3486 return Error("Invalid record");
3487 GEPIdx.push_back(Op);
3490 I = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
3492 InstructionList.push_back(I);
3494 cast<GetElementPtrInst>(I)->setIsInBounds(true);
3498 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
3499 // EXTRACTVAL: [opty, opval, n x indices]
3502 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
3503 return Error("Invalid record");
3505 SmallVector<unsigned, 4> EXTRACTVALIdx;
3506 Type *CurTy = Agg->getType();
3507 for (unsigned RecSize = Record.size();
3508 OpNum != RecSize; ++OpNum) {
3509 bool IsArray = CurTy->isArrayTy();
3510 bool IsStruct = CurTy->isStructTy();
3511 uint64_t Index = Record[OpNum];
3513 if (!IsStruct && !IsArray)
3514 return Error("EXTRACTVAL: Invalid type");
3515 if ((unsigned)Index != Index)
3516 return Error("Invalid value");
3517 if (IsStruct && Index >= CurTy->subtypes().size())
3518 return Error("EXTRACTVAL: Invalid struct index");
3519 if (IsArray && Index >= CurTy->getArrayNumElements())
3520 return Error("EXTRACTVAL: Invalid array index");
3521 EXTRACTVALIdx.push_back((unsigned)Index);
3524 CurTy = CurTy->subtypes()[Index];
3526 CurTy = CurTy->subtypes()[0];
3529 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
3530 InstructionList.push_back(I);
3534 case bitc::FUNC_CODE_INST_INSERTVAL: {
3535 // INSERTVAL: [opty, opval, opty, opval, n x indices]
3538 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
3539 return Error("Invalid record");
3541 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
3542 return Error("Invalid record");
3544 SmallVector<unsigned, 4> INSERTVALIdx;
3545 Type *CurTy = Agg->getType();
3546 for (unsigned RecSize = Record.size();
3547 OpNum != RecSize; ++OpNum) {
3548 bool IsArray = CurTy->isArrayTy();
3549 bool IsStruct = CurTy->isStructTy();
3550 uint64_t Index = Record[OpNum];
3552 if (!IsStruct && !IsArray)
3553 return Error("INSERTVAL: Invalid type");
3554 if (!CurTy->isStructTy() && !CurTy->isArrayTy())
3555 return Error("Invalid type");
3556 if ((unsigned)Index != Index)
3557 return Error("Invalid value");
3558 if (IsStruct && Index >= CurTy->subtypes().size())
3559 return Error("INSERTVAL: Invalid struct index");
3560 if (IsArray && Index >= CurTy->getArrayNumElements())
3561 return Error("INSERTVAL: Invalid array index");
3563 INSERTVALIdx.push_back((unsigned)Index);
3565 CurTy = CurTy->subtypes()[Index];
3567 CurTy = CurTy->subtypes()[0];
3570 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
3571 InstructionList.push_back(I);
3575 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
3576 // obsolete form of select
3577 // handles select i1 ... in old bitcode
3579 Value *TrueVal, *FalseVal, *Cond;
3580 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
3581 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
3582 popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
3583 return Error("Invalid record");
3585 I = SelectInst::Create(Cond, TrueVal, FalseVal);
3586 InstructionList.push_back(I);
3590 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
3591 // new form of select
3592 // handles select i1 or select [N x i1]
3594 Value *TrueVal, *FalseVal, *Cond;
3595 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
3596 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
3597 getValueTypePair(Record, OpNum, NextValueNo, Cond))
3598 return Error("Invalid record");
3600 // select condition can be either i1 or [N x i1]
3601 if (VectorType* vector_type =
3602 dyn_cast<VectorType>(Cond->getType())) {
3604 if (vector_type->getElementType() != Type::getInt1Ty(Context))
3605 return Error("Invalid type for value");
3608 if (Cond->getType() != Type::getInt1Ty(Context))
3609 return Error("Invalid type for value");
3612 I = SelectInst::Create(Cond, TrueVal, FalseVal);
3613 InstructionList.push_back(I);
3617 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
3620 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
3621 getValueTypePair(Record, OpNum, NextValueNo, Idx))
3622 return Error("Invalid record");
3623 I = ExtractElementInst::Create(Vec, Idx);
3624 InstructionList.push_back(I);
3628 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
3630 Value *Vec, *Elt, *Idx;
3631 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
3632 popValue(Record, OpNum, NextValueNo,
3633 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
3634 getValueTypePair(Record, OpNum, NextValueNo, Idx))
3635 return Error("Invalid record");
3636 I = InsertElementInst::Create(Vec, Elt, Idx);
3637 InstructionList.push_back(I);
3641 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
3643 Value *Vec1, *Vec2, *Mask;
3644 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
3645 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
3646 return Error("Invalid record");
3648 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
3649 return Error("Invalid record");
3650 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
3651 InstructionList.push_back(I);
3655 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
3656 // Old form of ICmp/FCmp returning bool
3657 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
3658 // both legal on vectors but had different behaviour.
3659 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
3660 // FCmp/ICmp returning bool or vector of bool
3664 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3665 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
3666 OpNum+1 != Record.size())
3667 return Error("Invalid record");
3669 if (LHS->getType()->isFPOrFPVectorTy())
3670 I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
3672 I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
3673 InstructionList.push_back(I);
3677 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
3679 unsigned Size = Record.size();
3681 I = ReturnInst::Create(Context);
3682 InstructionList.push_back(I);
3687 Value *Op = nullptr;
3688 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3689 return Error("Invalid record");
3690 if (OpNum != Record.size())
3691 return Error("Invalid record");
3693 I = ReturnInst::Create(Context, Op);
3694 InstructionList.push_back(I);
3697 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
3698 if (Record.size() != 1 && Record.size() != 3)
3699 return Error("Invalid record");
3700 BasicBlock *TrueDest = getBasicBlock(Record[0]);
3702 return Error("Invalid record");
3704 if (Record.size() == 1) {
3705 I = BranchInst::Create(TrueDest);
3706 InstructionList.push_back(I);
3709 BasicBlock *FalseDest = getBasicBlock(Record[1]);
3710 Value *Cond = getValue(Record, 2, NextValueNo,
3711 Type::getInt1Ty(Context));
3712 if (!FalseDest || !Cond)
3713 return Error("Invalid record");
3714 I = BranchInst::Create(TrueDest, FalseDest, Cond);
3715 InstructionList.push_back(I);
3719 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
3721 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
3722 // "New" SwitchInst format with case ranges. The changes to write this
3723 // format were reverted but we still recognize bitcode that uses it.
3724 // Hopefully someday we will have support for case ranges and can use
3725 // this format again.
3727 Type *OpTy = getTypeByID(Record[1]);
3728 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
3730 Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
3731 BasicBlock *Default = getBasicBlock(Record[3]);
3732 if (!OpTy || !Cond || !Default)
3733 return Error("Invalid record");
3735 unsigned NumCases = Record[4];
3737 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
3738 InstructionList.push_back(SI);
3740 unsigned CurIdx = 5;
3741 for (unsigned i = 0; i != NumCases; ++i) {
3742 SmallVector<ConstantInt*, 1> CaseVals;
3743 unsigned NumItems = Record[CurIdx++];
3744 for (unsigned ci = 0; ci != NumItems; ++ci) {
3745 bool isSingleNumber = Record[CurIdx++];
3748 unsigned ActiveWords = 1;
3749 if (ValueBitWidth > 64)
3750 ActiveWords = Record[CurIdx++];
3751 Low = ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
3753 CurIdx += ActiveWords;
3755 if (!isSingleNumber) {
3757 if (ValueBitWidth > 64)
3758 ActiveWords = Record[CurIdx++];
3760 ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
3762 CurIdx += ActiveWords;
3764 // FIXME: It is not clear whether values in the range should be
3765 // compared as signed or unsigned values. The partially
3766 // implemented changes that used this format in the past used
3767 // unsigned comparisons.
3768 for ( ; Low.ule(High); ++Low)
3769 CaseVals.push_back(ConstantInt::get(Context, Low));
3771 CaseVals.push_back(ConstantInt::get(Context, Low));
3773 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
3774 for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
3775 cve = CaseVals.end(); cvi != cve; ++cvi)
3776 SI->addCase(*cvi, DestBB);
3782 // Old SwitchInst format without case ranges.
3784 if (Record.size() < 3 || (Record.size() & 1) == 0)
3785 return Error("Invalid record");
3786 Type *OpTy = getTypeByID(Record[0]);
3787 Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
3788 BasicBlock *Default = getBasicBlock(Record[2]);
3789 if (!OpTy || !Cond || !Default)
3790 return Error("Invalid record");
3791 unsigned NumCases = (Record.size()-3)/2;
3792 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
3793 InstructionList.push_back(SI);
3794 for (unsigned i = 0, e = NumCases; i != e; ++i) {
3795 ConstantInt *CaseVal =
3796 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
3797 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
3798 if (!CaseVal || !DestBB) {
3800 return Error("Invalid record");
3802 SI->addCase(CaseVal, DestBB);
3807 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
3808 if (Record.size() < 2)
3809 return Error("Invalid record");
3810 Type *OpTy = getTypeByID(Record[0]);
3811 Value *Address = getValue(Record, 1, NextValueNo, OpTy);
3812 if (!OpTy || !Address)
3813 return Error("Invalid record");
3814 unsigned NumDests = Record.size()-2;
3815 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
3816 InstructionList.push_back(IBI);
3817 for (unsigned i = 0, e = NumDests; i != e; ++i) {
3818 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
3819 IBI->addDestination(DestBB);
3822 return Error("Invalid record");
3829 case bitc::FUNC_CODE_INST_INVOKE: {
3830 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
3831 if (Record.size() < 4)
3832 return Error("Invalid record");
3833 AttributeSet PAL = getAttributes(Record[0]);
3834 unsigned CCInfo = Record[1];
3835 BasicBlock *NormalBB = getBasicBlock(Record[2]);
3836 BasicBlock *UnwindBB = getBasicBlock(Record[3]);
3840 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
3841 return Error("Invalid record");
3843 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
3844 FunctionType *FTy = !CalleeTy ? nullptr :
3845 dyn_cast<FunctionType>(CalleeTy->getElementType());
3847 // Check that the right number of fixed parameters are here.
3848 if (!FTy || !NormalBB || !UnwindBB ||
3849 Record.size() < OpNum+FTy->getNumParams())
3850 return Error("Invalid record");
3852 SmallVector<Value*, 16> Ops;
3853 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
3854 Ops.push_back(getValue(Record, OpNum, NextValueNo,
3855 FTy->getParamType(i)));
3857 return Error("Invalid record");
3860 if (!FTy->isVarArg()) {
3861 if (Record.size() != OpNum)
3862 return Error("Invalid record");
3864 // Read type/value pairs for varargs params.
3865 while (OpNum != Record.size()) {
3867 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3868 return Error("Invalid record");
3873 I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops);
3874 InstructionList.push_back(I);
3875 cast<InvokeInst>(I)->setCallingConv(
3876 static_cast<CallingConv::ID>(CCInfo));
3877 cast<InvokeInst>(I)->setAttributes(PAL);
3880 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
3882 Value *Val = nullptr;
3883 if (getValueTypePair(Record, Idx, NextValueNo, Val))
3884 return Error("Invalid record");
3885 I = ResumeInst::Create(Val);
3886 InstructionList.push_back(I);
3889 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
3890 I = new UnreachableInst(Context);
3891 InstructionList.push_back(I);
3893 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
3894 if (Record.size() < 1 || ((Record.size()-1)&1))
3895 return Error("Invalid record");
3896 Type *Ty = getTypeByID(Record[0]);
3898 return Error("Invalid record");
3900 PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
3901 InstructionList.push_back(PN);
3903 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
3905 // With the new function encoding, it is possible that operands have
3906 // negative IDs (for forward references). Use a signed VBR
3907 // representation to keep the encoding small.
3909 V = getValueSigned(Record, 1+i, NextValueNo, Ty);
3911 V = getValue(Record, 1+i, NextValueNo, Ty);
3912 BasicBlock *BB = getBasicBlock(Record[2+i]);
3914 return Error("Invalid record");
3915 PN->addIncoming(V, BB);
3921 case bitc::FUNC_CODE_INST_LANDINGPAD: {
3922 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
3924 if (Record.size() < 4)
3925 return Error("Invalid record");
3926 Type *Ty = getTypeByID(Record[Idx++]);
3928 return Error("Invalid record");
3929 Value *PersFn = nullptr;
3930 if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
3931 return Error("Invalid record");
3933 bool IsCleanup = !!Record[Idx++];
3934 unsigned NumClauses = Record[Idx++];
3935 LandingPadInst *LP = LandingPadInst::Create(Ty, PersFn, NumClauses);
3936 LP->setCleanup(IsCleanup);
3937 for (unsigned J = 0; J != NumClauses; ++J) {
3938 LandingPadInst::ClauseType CT =
3939 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
3942 if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
3944 return Error("Invalid record");
3947 assert((CT != LandingPadInst::Catch ||
3948 !isa<ArrayType>(Val->getType())) &&
3949 "Catch clause has a invalid type!");
3950 assert((CT != LandingPadInst::Filter ||
3951 isa<ArrayType>(Val->getType())) &&
3952 "Filter clause has invalid type!");
3953 LP->addClause(cast<Constant>(Val));
3957 InstructionList.push_back(I);
3961 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
3962 if (Record.size() != 4)
3963 return Error("Invalid record");
3965 dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
3966 Type *OpTy = getTypeByID(Record[1]);
3967 Value *Size = getFnValueByID(Record[2], OpTy);
3968 uint64_t AlignRecord = Record[3];
3969 const uint64_t InAllocaMask = uint64_t(1) << 5;
3970 bool InAlloca = AlignRecord & InAllocaMask;
3972 if (std::error_code EC =
3973 parseAlignmentValue(AlignRecord & ~InAllocaMask, Align)) {
3977 return Error("Invalid record");
3978 AllocaInst *AI = new AllocaInst(Ty->getElementType(), Size, Align);
3979 AI->setUsedWithInAlloca(InAlloca);
3981 InstructionList.push_back(I);
3984 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
3987 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3988 (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
3989 return Error("Invalid record");
3992 if (OpNum + 3 == Record.size())
3993 Ty = getTypeByID(Record[OpNum++]);
3996 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
3998 I = new LoadInst(Op, "", Record[OpNum+1], Align);
4000 if (Ty && Ty != I->getType())
4001 return Error("Explicit load type does not match pointee type of "
4004 InstructionList.push_back(I);
4007 case bitc::FUNC_CODE_INST_LOADATOMIC: {
4008 // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
4011 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
4012 (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
4013 return Error("Invalid record");
4016 if (OpNum + 5 == Record.size())
4017 Ty = getTypeByID(Record[OpNum++]);
4019 AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
4020 if (Ordering == NotAtomic || Ordering == Release ||
4021 Ordering == AcquireRelease)
4022 return Error("Invalid record");
4023 if (Ordering != NotAtomic && Record[OpNum] == 0)
4024 return Error("Invalid record");
4025 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
4028 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4030 I = new LoadInst(Op, "", Record[OpNum+1], Align, Ordering, SynchScope);
4033 assert((!Ty || Ty == I->getType()) &&
4034 "Explicit type doesn't match pointee type of the first operand");
4036 InstructionList.push_back(I);
4039 case bitc::FUNC_CODE_INST_STORE: { // STORE2:[ptrty, ptr, val, align, vol]
4042 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4043 popValue(Record, OpNum, NextValueNo,
4044 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
4045 OpNum+2 != Record.size())
4046 return Error("Invalid record");
4048 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4050 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align);
4051 InstructionList.push_back(I);
4054 case bitc::FUNC_CODE_INST_STOREATOMIC: {
4055 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
4058 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4059 popValue(Record, OpNum, NextValueNo,
4060 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
4061 OpNum+4 != Record.size())
4062 return Error("Invalid record");
4064 AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
4065 if (Ordering == NotAtomic || Ordering == Acquire ||
4066 Ordering == AcquireRelease)
4067 return Error("Invalid record");
4068 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
4069 if (Ordering != NotAtomic && Record[OpNum] == 0)
4070 return Error("Invalid record");
4073 if (std::error_code EC = parseAlignmentValue(Record[OpNum], Align))
4075 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align, Ordering, SynchScope);
4076 InstructionList.push_back(I);
4079 case bitc::FUNC_CODE_INST_CMPXCHG: {
4080 // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
4081 // failureordering?, isweak?]
4083 Value *Ptr, *Cmp, *New;
4084 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4085 popValue(Record, OpNum, NextValueNo,
4086 cast<PointerType>(Ptr->getType())->getElementType(), Cmp) ||
4087 popValue(Record, OpNum, NextValueNo,
4088 cast<PointerType>(Ptr->getType())->getElementType(), New) ||
4089 (Record.size() < OpNum + 3 || Record.size() > OpNum + 5))
4090 return Error("Invalid record");
4091 AtomicOrdering SuccessOrdering = GetDecodedOrdering(Record[OpNum+1]);
4092 if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
4093 return Error("Invalid record");
4094 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+2]);
4096 AtomicOrdering FailureOrdering;
4097 if (Record.size() < 7)
4099 AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
4101 FailureOrdering = GetDecodedOrdering(Record[OpNum+3]);
4103 I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
4105 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
4107 if (Record.size() < 8) {
4108 // Before weak cmpxchgs existed, the instruction simply returned the
4109 // value loaded from memory, so bitcode files from that era will be
4110 // expecting the first component of a modern cmpxchg.
4111 CurBB->getInstList().push_back(I);
4112 I = ExtractValueInst::Create(I, 0);
4114 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
4117 InstructionList.push_back(I);
4120 case bitc::FUNC_CODE_INST_ATOMICRMW: {
4121 // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
4124 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
4125 popValue(Record, OpNum, NextValueNo,
4126 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
4127 OpNum+4 != Record.size())
4128 return Error("Invalid record");
4129 AtomicRMWInst::BinOp Operation = GetDecodedRMWOperation(Record[OpNum]);
4130 if (Operation < AtomicRMWInst::FIRST_BINOP ||
4131 Operation > AtomicRMWInst::LAST_BINOP)
4132 return Error("Invalid record");
4133 AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
4134 if (Ordering == NotAtomic || Ordering == Unordered)
4135 return Error("Invalid record");
4136 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
4137 I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
4138 cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
4139 InstructionList.push_back(I);
4142 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
4143 if (2 != Record.size())
4144 return Error("Invalid record");
4145 AtomicOrdering Ordering = GetDecodedOrdering(Record[0]);
4146 if (Ordering == NotAtomic || Ordering == Unordered ||
4147 Ordering == Monotonic)
4148 return Error("Invalid record");
4149 SynchronizationScope SynchScope = GetDecodedSynchScope(Record[1]);
4150 I = new FenceInst(Context, Ordering, SynchScope);
4151 InstructionList.push_back(I);
4154 case bitc::FUNC_CODE_INST_CALL: {
4155 // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
4156 if (Record.size() < 3)
4157 return Error("Invalid record");
4159 AttributeSet PAL = getAttributes(Record[0]);
4160 unsigned CCInfo = Record[1];
4164 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
4165 return Error("Invalid record");
4167 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
4168 FunctionType *FTy = nullptr;
4169 if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
4170 if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
4171 return Error("Invalid record");
4173 SmallVector<Value*, 16> Args;
4174 // Read the fixed params.
4175 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4176 if (FTy->getParamType(i)->isLabelTy())
4177 Args.push_back(getBasicBlock(Record[OpNum]));
4179 Args.push_back(getValue(Record, OpNum, NextValueNo,
4180 FTy->getParamType(i)));
4182 return Error("Invalid record");
4185 // Read type/value pairs for varargs params.
4186 if (!FTy->isVarArg()) {
4187 if (OpNum != Record.size())
4188 return Error("Invalid record");
4190 while (OpNum != Record.size()) {
4192 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4193 return Error("Invalid record");
4198 I = CallInst::Create(Callee, Args);
4199 InstructionList.push_back(I);
4200 cast<CallInst>(I)->setCallingConv(
4201 static_cast<CallingConv::ID>((~(1U << 14) & CCInfo) >> 1));
4202 CallInst::TailCallKind TCK = CallInst::TCK_None;
4204 TCK = CallInst::TCK_Tail;
4205 if (CCInfo & (1 << 14))
4206 TCK = CallInst::TCK_MustTail;
4207 cast<CallInst>(I)->setTailCallKind(TCK);
4208 cast<CallInst>(I)->setAttributes(PAL);
4211 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
4212 if (Record.size() < 3)
4213 return Error("Invalid record");
4214 Type *OpTy = getTypeByID(Record[0]);
4215 Value *Op = getValue(Record, 1, NextValueNo, OpTy);
4216 Type *ResTy = getTypeByID(Record[2]);
4217 if (!OpTy || !Op || !ResTy)
4218 return Error("Invalid record");
4219 I = new VAArgInst(Op, ResTy);
4220 InstructionList.push_back(I);
4225 // Add instruction to end of current BB. If there is no current BB, reject
4229 return Error("Invalid instruction with no BB");
4231 CurBB->getInstList().push_back(I);
4233 // If this was a terminator instruction, move to the next block.
4234 if (isa<TerminatorInst>(I)) {
4236 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
4239 // Non-void values get registered in the value table for future use.
4240 if (I && !I->getType()->isVoidTy())
4241 ValueList.AssignValue(I, NextValueNo++);
4246 // Check the function list for unresolved values.
4247 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
4248 if (!A->getParent()) {
4249 // We found at least one unresolved value. Nuke them all to avoid leaks.
4250 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
4251 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
4252 A->replaceAllUsesWith(UndefValue::get(A->getType()));
4256 return Error("Never resolved value found in function");
4260 // FIXME: Check for unresolved forward-declared metadata references
4261 // and clean up leaks.
4263 // Trim the value list down to the size it was before we parsed this function.
4264 ValueList.shrinkTo(ModuleValueListSize);
4265 MDValueList.shrinkTo(ModuleMDValueListSize);
4266 std::vector<BasicBlock*>().swap(FunctionBBs);
4267 return std::error_code();
4270 /// Find the function body in the bitcode stream
4271 std::error_code BitcodeReader::FindFunctionInStream(
4273 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
4274 while (DeferredFunctionInfoIterator->second == 0) {
4275 if (Stream.AtEndOfStream())
4276 return Error("Could not find function in stream");
4277 // ParseModule will parse the next body in the stream and set its
4278 // position in the DeferredFunctionInfo map.
4279 if (std::error_code EC = ParseModule(true))
4282 return std::error_code();
4285 //===----------------------------------------------------------------------===//
4286 // GVMaterializer implementation
4287 //===----------------------------------------------------------------------===//
4289 void BitcodeReader::releaseBuffer() { Buffer.release(); }
4291 std::error_code BitcodeReader::materialize(GlobalValue *GV) {
4292 if (std::error_code EC = materializeMetadata())
4295 Function *F = dyn_cast<Function>(GV);
4296 // If it's not a function or is already material, ignore the request.
4297 if (!F || !F->isMaterializable())
4298 return std::error_code();
4300 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
4301 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
4302 // If its position is recorded as 0, its body is somewhere in the stream
4303 // but we haven't seen it yet.
4304 if (DFII->second == 0 && LazyStreamer)
4305 if (std::error_code EC = FindFunctionInStream(F, DFII))
4308 // Move the bit stream to the saved position of the deferred function body.
4309 Stream.JumpToBit(DFII->second);
4311 if (std::error_code EC = ParseFunctionBody(F))
4313 F->setIsMaterializable(false);
4318 // Upgrade any old intrinsic calls in the function.
4319 for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
4320 E = UpgradedIntrinsics.end(); I != E; ++I) {
4321 if (I->first != I->second) {
4322 for (auto UI = I->first->user_begin(), UE = I->first->user_end();
4324 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
4325 UpgradeIntrinsicCall(CI, I->second);
4330 // Bring in any functions that this function forward-referenced via
4332 return materializeForwardReferencedFunctions();
4335 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
4336 const Function *F = dyn_cast<Function>(GV);
4337 if (!F || F->isDeclaration())
4340 // Dematerializing F would leave dangling references that wouldn't be
4341 // reconnected on re-materialization.
4342 if (BlockAddressesTaken.count(F))
4345 return DeferredFunctionInfo.count(const_cast<Function*>(F));
4348 void BitcodeReader::Dematerialize(GlobalValue *GV) {
4349 Function *F = dyn_cast<Function>(GV);
4350 // If this function isn't dematerializable, this is a noop.
4351 if (!F || !isDematerializable(F))
4354 assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
4356 // Just forget the function body, we can remat it later.
4357 F->dropAllReferences();
4358 F->setIsMaterializable(true);
4361 std::error_code BitcodeReader::MaterializeModule(Module *M) {
4362 assert(M == TheModule &&
4363 "Can only Materialize the Module this BitcodeReader is attached to.");
4365 if (std::error_code EC = materializeMetadata())
4368 // Promise to materialize all forward references.
4369 WillMaterializeAllForwardRefs = true;
4371 // Iterate over the module, deserializing any functions that are still on
4373 for (Module::iterator F = TheModule->begin(), E = TheModule->end();
4375 if (std::error_code EC = materialize(F))
4378 // At this point, if there are any function bodies, the current bit is
4379 // pointing to the END_BLOCK record after them. Now make sure the rest
4380 // of the bits in the module have been read.
4384 // Check that all block address forward references got resolved (as we
4386 if (!BasicBlockFwdRefs.empty())
4387 return Error("Never resolved function from blockaddress");
4389 // Upgrade any intrinsic calls that slipped through (should not happen!) and
4390 // delete the old functions to clean up. We can't do this unless the entire
4391 // module is materialized because there could always be another function body
4392 // with calls to the old function.
4393 for (std::vector<std::pair<Function*, Function*> >::iterator I =
4394 UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
4395 if (I->first != I->second) {
4396 for (auto UI = I->first->user_begin(), UE = I->first->user_end();
4398 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
4399 UpgradeIntrinsicCall(CI, I->second);
4401 if (!I->first->use_empty())
4402 I->first->replaceAllUsesWith(I->second);
4403 I->first->eraseFromParent();
4406 std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
4408 for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
4409 UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
4411 UpgradeDebugInfo(*M);
4412 return std::error_code();
4415 std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
4416 return IdentifiedStructTypes;
4419 std::error_code BitcodeReader::InitStream() {
4421 return InitLazyStream();
4422 return InitStreamFromBuffer();
4425 std::error_code BitcodeReader::InitStreamFromBuffer() {
4426 const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
4427 const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
4429 if (Buffer->getBufferSize() & 3)
4430 return Error("Invalid bitcode signature");
4432 // If we have a wrapper header, parse it and ignore the non-bc file contents.
4433 // The magic number is 0x0B17C0DE stored in little endian.
4434 if (isBitcodeWrapper(BufPtr, BufEnd))
4435 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
4436 return Error("Invalid bitcode wrapper header");
4438 StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
4439 Stream.init(&*StreamFile);
4441 return std::error_code();
4444 std::error_code BitcodeReader::InitLazyStream() {
4445 // Check and strip off the bitcode wrapper; BitstreamReader expects never to
4447 auto OwnedBytes = llvm::make_unique<StreamingMemoryObject>(LazyStreamer);
4448 StreamingMemoryObject &Bytes = *OwnedBytes;
4449 StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
4450 Stream.init(&*StreamFile);
4452 unsigned char buf[16];
4453 if (Bytes.readBytes(buf, 16, 0) != 16)
4454 return Error("Invalid bitcode signature");
4456 if (!isBitcode(buf, buf + 16))
4457 return Error("Invalid bitcode signature");
4459 if (isBitcodeWrapper(buf, buf + 4)) {
4460 const unsigned char *bitcodeStart = buf;
4461 const unsigned char *bitcodeEnd = buf + 16;
4462 SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
4463 Bytes.dropLeadingBytes(bitcodeStart - buf);
4464 Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
4466 return std::error_code();
4470 class BitcodeErrorCategoryType : public std::error_category {
4471 const char *name() const LLVM_NOEXCEPT override {
4472 return "llvm.bitcode";
4474 std::string message(int IE) const override {
4475 BitcodeError E = static_cast<BitcodeError>(IE);
4477 case BitcodeError::InvalidBitcodeSignature:
4478 return "Invalid bitcode signature";
4479 case BitcodeError::CorruptedBitcode:
4480 return "Corrupted bitcode";
4482 llvm_unreachable("Unknown error type!");
4487 static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
4489 const std::error_category &llvm::BitcodeErrorCategory() {
4490 return *ErrorCategory;
4493 //===----------------------------------------------------------------------===//
4494 // External interface
4495 //===----------------------------------------------------------------------===//
4497 /// \brief Get a lazy one-at-time loading module from bitcode.
4499 /// This isn't always used in a lazy context. In particular, it's also used by
4500 /// \a parseBitcodeFile(). If this is truly lazy, then we need to eagerly pull
4501 /// in forward-referenced functions from block address references.
4503 /// \param[in] WillMaterializeAll Set to \c true if the caller promises to
4504 /// materialize everything -- in particular, if this isn't truly lazy.
4505 static ErrorOr<Module *>
4506 getLazyBitcodeModuleImpl(std::unique_ptr<MemoryBuffer> &&Buffer,
4507 LLVMContext &Context, bool WillMaterializeAll,
4508 DiagnosticHandlerFunction DiagnosticHandler,
4509 bool ShouldLazyLoadMetadata = false) {
4510 Module *M = new Module(Buffer->getBufferIdentifier(), Context);
4512 new BitcodeReader(Buffer.get(), Context, DiagnosticHandler);
4513 M->setMaterializer(R);
4515 auto cleanupOnError = [&](std::error_code EC) {
4516 R->releaseBuffer(); // Never take ownership on error.
4517 delete M; // Also deletes R.
4521 // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
4522 if (std::error_code EC = R->ParseBitcodeInto(M, ShouldLazyLoadMetadata))
4523 return cleanupOnError(EC);
4525 if (!WillMaterializeAll)
4526 // Resolve forward references from blockaddresses.
4527 if (std::error_code EC = R->materializeForwardReferencedFunctions())
4528 return cleanupOnError(EC);
4530 Buffer.release(); // The BitcodeReader owns it now.
4535 llvm::getLazyBitcodeModule(std::unique_ptr<MemoryBuffer> &&Buffer,
4536 LLVMContext &Context,
4537 DiagnosticHandlerFunction DiagnosticHandler,
4538 bool ShouldLazyLoadMetadata) {
4539 return getLazyBitcodeModuleImpl(std::move(Buffer), Context, false,
4540 DiagnosticHandler, ShouldLazyLoadMetadata);
4543 ErrorOr<std::unique_ptr<Module>>
4544 llvm::getStreamedBitcodeModule(StringRef Name, DataStreamer *Streamer,
4545 LLVMContext &Context,
4546 DiagnosticHandlerFunction DiagnosticHandler) {
4547 std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
4548 BitcodeReader *R = new BitcodeReader(Streamer, Context, DiagnosticHandler);
4549 M->setMaterializer(R);
4550 if (std::error_code EC = R->ParseBitcodeInto(M.get()))
4552 return std::move(M);
4556 llvm::parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context,
4557 DiagnosticHandlerFunction DiagnosticHandler) {
4558 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
4559 ErrorOr<Module *> ModuleOrErr = getLazyBitcodeModuleImpl(
4560 std::move(Buf), Context, true, DiagnosticHandler);
4563 Module *M = ModuleOrErr.get();
4564 // Read in the entire module, and destroy the BitcodeReader.
4565 if (std::error_code EC = M->materializeAllPermanently()) {
4570 // TODO: Restore the use-lists to the in-memory state when the bitcode was
4571 // written. We must defer until the Module has been fully materialized.
4577 llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer, LLVMContext &Context,
4578 DiagnosticHandlerFunction DiagnosticHandler) {
4579 std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
4580 auto R = llvm::make_unique<BitcodeReader>(Buf.release(), Context,
4582 ErrorOr<std::string> Triple = R->parseTriple();
4583 if (Triple.getError())
4585 return Triple.get();