fix formatting; NFC
[oota-llvm.git] / lib / Bitcode / Reader / BitcodeReader.cpp
1 //===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "llvm/Bitcode/ReaderWriter.h"
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/Triple.h"
15 #include "llvm/Bitcode/BitstreamReader.h"
16 #include "llvm/Bitcode/LLVMBitCodes.h"
17 #include "llvm/IR/AutoUpgrade.h"
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DebugInfo.h"
20 #include "llvm/IR/DebugInfoMetadata.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/DiagnosticPrinter.h"
23 #include "llvm/IR/GVMaterializer.h"
24 #include "llvm/IR/InlineAsm.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/OperandTraits.h"
29 #include "llvm/IR/Operator.h"
30 #include "llvm/IR/FunctionInfo.h"
31 #include "llvm/IR/ValueHandle.h"
32 #include "llvm/Support/DataStream.h"
33 #include "llvm/Support/ManagedStatic.h"
34 #include "llvm/Support/MathExtras.h"
35 #include "llvm/Support/MemoryBuffer.h"
36 #include "llvm/Support/raw_ostream.h"
37 #include <deque>
38 using namespace llvm;
39
40 namespace {
41 enum {
42   SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
43 };
44
45 class BitcodeReaderValueList {
46   std::vector<WeakVH> ValuePtrs;
47
48   /// As we resolve forward-referenced constants, we add information about them
49   /// to this vector.  This allows us to resolve them in bulk instead of
50   /// resolving each reference at a time.  See the code in
51   /// ResolveConstantForwardRefs for more information about this.
52   ///
53   /// The key of this vector is the placeholder constant, the value is the slot
54   /// number that holds the resolved value.
55   typedef std::vector<std::pair<Constant*, unsigned> > ResolveConstantsTy;
56   ResolveConstantsTy ResolveConstants;
57   LLVMContext &Context;
58 public:
59   BitcodeReaderValueList(LLVMContext &C) : Context(C) {}
60   ~BitcodeReaderValueList() {
61     assert(ResolveConstants.empty() && "Constants not resolved?");
62   }
63
64   // vector compatibility methods
65   unsigned size() const { return ValuePtrs.size(); }
66   void resize(unsigned N) { ValuePtrs.resize(N); }
67   void push_back(Value *V) { ValuePtrs.emplace_back(V); }
68
69   void clear() {
70     assert(ResolveConstants.empty() && "Constants not resolved?");
71     ValuePtrs.clear();
72   }
73
74   Value *operator[](unsigned i) const {
75     assert(i < ValuePtrs.size());
76     return ValuePtrs[i];
77   }
78
79   Value *back() const { return ValuePtrs.back(); }
80     void pop_back() { ValuePtrs.pop_back(); }
81   bool empty() const { return ValuePtrs.empty(); }
82   void shrinkTo(unsigned N) {
83     assert(N <= size() && "Invalid shrinkTo request!");
84     ValuePtrs.resize(N);
85   }
86
87   Constant *getConstantFwdRef(unsigned Idx, Type *Ty);
88   Value *getValueFwdRef(unsigned Idx, Type *Ty);
89
90   void assignValue(Value *V, unsigned Idx);
91
92   /// Once all constants are read, this method bulk resolves any forward
93   /// references.
94   void resolveConstantForwardRefs();
95 };
96
97 class BitcodeReaderMetadataList {
98   unsigned NumFwdRefs;
99   bool AnyFwdRefs;
100   unsigned MinFwdRef;
101   unsigned MaxFwdRef;
102   std::vector<TrackingMDRef> MetadataPtrs;
103
104   LLVMContext &Context;
105 public:
106   BitcodeReaderMetadataList(LLVMContext &C)
107       : NumFwdRefs(0), AnyFwdRefs(false), Context(C) {}
108
109   // vector compatibility methods
110   unsigned size() const { return MetadataPtrs.size(); }
111   void resize(unsigned N) { MetadataPtrs.resize(N); }
112   void push_back(Metadata *MD) { MetadataPtrs.emplace_back(MD); }
113   void clear() { MetadataPtrs.clear(); }
114   Metadata *back() const { return MetadataPtrs.back(); }
115   void pop_back() { MetadataPtrs.pop_back(); }
116   bool empty() const { return MetadataPtrs.empty(); }
117
118   Metadata *operator[](unsigned i) const {
119     assert(i < MetadataPtrs.size());
120     return MetadataPtrs[i];
121   }
122
123   void shrinkTo(unsigned N) {
124     assert(N <= size() && "Invalid shrinkTo request!");
125     MetadataPtrs.resize(N);
126   }
127
128   Metadata *getValueFwdRef(unsigned Idx);
129   void assignValue(Metadata *MD, unsigned Idx);
130   void tryToResolveCycles();
131 };
132
133 class BitcodeReader : public GVMaterializer {
134   LLVMContext &Context;
135   Module *TheModule = nullptr;
136   std::unique_ptr<MemoryBuffer> Buffer;
137   std::unique_ptr<BitstreamReader> StreamFile;
138   BitstreamCursor Stream;
139   // Next offset to start scanning for lazy parsing of function bodies.
140   uint64_t NextUnreadBit = 0;
141   // Last function offset found in the VST.
142   uint64_t LastFunctionBlockBit = 0;
143   bool SeenValueSymbolTable = false;
144   uint64_t VSTOffset = 0;
145   // Contains an arbitrary and optional string identifying the bitcode producer
146   std::string ProducerIdentification;
147   // Number of module level metadata records specified by the
148   // MODULE_CODE_METADATA_VALUES record.
149   unsigned NumModuleMDs = 0;
150   // Support older bitcode without the MODULE_CODE_METADATA_VALUES record.
151   bool SeenModuleValuesRecord = false;
152
153   std::vector<Type*> TypeList;
154   BitcodeReaderValueList ValueList;
155   BitcodeReaderMetadataList MetadataList;
156   std::vector<Comdat *> ComdatList;
157   SmallVector<Instruction *, 64> InstructionList;
158
159   std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
160   std::vector<std::pair<GlobalAlias*, unsigned> > AliasInits;
161   std::vector<std::pair<Function*, unsigned> > FunctionPrefixes;
162   std::vector<std::pair<Function*, unsigned> > FunctionPrologues;
163   std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFns;
164
165   SmallVector<Instruction*, 64> InstsWithTBAATag;
166
167   /// The set of attributes by index.  Index zero in the file is for null, and
168   /// is thus not represented here.  As such all indices are off by one.
169   std::vector<AttributeSet> MAttributes;
170
171   /// The set of attribute groups.
172   std::map<unsigned, AttributeSet> MAttributeGroups;
173
174   /// While parsing a function body, this is a list of the basic blocks for the
175   /// function.
176   std::vector<BasicBlock*> FunctionBBs;
177
178   // When reading the module header, this list is populated with functions that
179   // have bodies later in the file.
180   std::vector<Function*> FunctionsWithBodies;
181
182   // When intrinsic functions are encountered which require upgrading they are
183   // stored here with their replacement function.
184   typedef DenseMap<Function*, Function*> UpgradedIntrinsicMap;
185   UpgradedIntrinsicMap UpgradedIntrinsics;
186
187   // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
188   DenseMap<unsigned, unsigned> MDKindMap;
189
190   // Several operations happen after the module header has been read, but
191   // before function bodies are processed. This keeps track of whether
192   // we've done this yet.
193   bool SeenFirstFunctionBody = false;
194
195   /// When function bodies are initially scanned, this map contains info about
196   /// where to find deferred function body in the stream.
197   DenseMap<Function*, uint64_t> DeferredFunctionInfo;
198
199   /// When Metadata block is initially scanned when parsing the module, we may
200   /// choose to defer parsing of the metadata. This vector contains info about
201   /// which Metadata blocks are deferred.
202   std::vector<uint64_t> DeferredMetadataInfo;
203
204   /// These are basic blocks forward-referenced by block addresses.  They are
205   /// inserted lazily into functions when they're loaded.  The basic block ID is
206   /// its index into the vector.
207   DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
208   std::deque<Function *> BasicBlockFwdRefQueue;
209
210   /// Indicates that we are using a new encoding for instruction operands where
211   /// most operands in the current FUNCTION_BLOCK are encoded relative to the
212   /// instruction number, for a more compact encoding.  Some instruction
213   /// operands are not relative to the instruction ID: basic block numbers, and
214   /// types. Once the old style function blocks have been phased out, we would
215   /// not need this flag.
216   bool UseRelativeIDs = false;
217
218   /// True if all functions will be materialized, negating the need to process
219   /// (e.g.) blockaddress forward references.
220   bool WillMaterializeAllForwardRefs = false;
221
222   /// True if any Metadata block has been materialized.
223   bool IsMetadataMaterialized = false;
224
225   bool StripDebugInfo = false;
226
227   /// Functions that need to be matched with subprograms when upgrading old
228   /// metadata.
229   SmallDenseMap<Function *, DISubprogram *, 16> FunctionsWithSPs;
230
231   std::vector<std::string> BundleTags;
232
233 public:
234   std::error_code error(BitcodeError E, const Twine &Message);
235   std::error_code error(BitcodeError E);
236   std::error_code error(const Twine &Message);
237
238   BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context);
239   BitcodeReader(LLVMContext &Context);
240   ~BitcodeReader() override { freeState(); }
241
242   std::error_code materializeForwardReferencedFunctions();
243
244   void freeState();
245
246   void releaseBuffer();
247
248   std::error_code materialize(GlobalValue *GV) override;
249   std::error_code materializeModule() override;
250   std::vector<StructType *> getIdentifiedStructTypes() const override;
251
252   /// \brief Main interface to parsing a bitcode buffer.
253   /// \returns true if an error occurred.
254   std::error_code parseBitcodeInto(std::unique_ptr<DataStreamer> Streamer,
255                                    Module *M,
256                                    bool ShouldLazyLoadMetadata = false);
257
258   /// \brief Cheap mechanism to just extract module triple
259   /// \returns true if an error occurred.
260   ErrorOr<std::string> parseTriple();
261
262   /// Cheap mechanism to just extract the identification block out of bitcode.
263   ErrorOr<std::string> parseIdentificationBlock();
264
265   static uint64_t decodeSignRotatedValue(uint64_t V);
266
267   /// Materialize any deferred Metadata block.
268   std::error_code materializeMetadata() override;
269
270   void setStripDebugInfo() override;
271
272   /// Save the mapping between the metadata values and the corresponding
273   /// value id that were recorded in the MetadataList during parsing. If
274   /// OnlyTempMD is true, then only record those entries that are still
275   /// temporary metadata. This interface is used when metadata linking is
276   /// performed as a postpass, such as during function importing.
277   void saveMetadataList(DenseMap<const Metadata *, unsigned> &MetadataToIDs,
278                         bool OnlyTempMD) override;
279
280 private:
281   /// Parse the "IDENTIFICATION_BLOCK_ID" block, populate the
282   // ProducerIdentification data member, and do some basic enforcement on the
283   // "epoch" encoded in the bitcode.
284   std::error_code parseBitcodeVersion();
285
286   std::vector<StructType *> IdentifiedStructTypes;
287   StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
288   StructType *createIdentifiedStructType(LLVMContext &Context);
289
290   Type *getTypeByID(unsigned ID);
291   Value *getFnValueByID(unsigned ID, Type *Ty) {
292     if (Ty && Ty->isMetadataTy())
293       return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
294     return ValueList.getValueFwdRef(ID, Ty);
295   }
296   Metadata *getFnMetadataByID(unsigned ID) {
297     return MetadataList.getValueFwdRef(ID);
298   }
299   BasicBlock *getBasicBlock(unsigned ID) const {
300     if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
301     return FunctionBBs[ID];
302   }
303   AttributeSet getAttributes(unsigned i) const {
304     if (i-1 < MAttributes.size())
305       return MAttributes[i-1];
306     return AttributeSet();
307   }
308
309   /// Read a value/type pair out of the specified record from slot 'Slot'.
310   /// Increment Slot past the number of slots used in the record. Return true on
311   /// failure.
312   bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
313                         unsigned InstNum, Value *&ResVal) {
314     if (Slot == Record.size()) return true;
315     unsigned ValNo = (unsigned)Record[Slot++];
316     // Adjust the ValNo, if it was encoded relative to the InstNum.
317     if (UseRelativeIDs)
318       ValNo = InstNum - ValNo;
319     if (ValNo < InstNum) {
320       // If this is not a forward reference, just return the value we already
321       // have.
322       ResVal = getFnValueByID(ValNo, nullptr);
323       return ResVal == nullptr;
324     }
325     if (Slot == Record.size())
326       return true;
327
328     unsigned TypeNo = (unsigned)Record[Slot++];
329     ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
330     return ResVal == nullptr;
331   }
332
333   /// Read a value out of the specified record from slot 'Slot'. Increment Slot
334   /// past the number of slots used by the value in the record. Return true if
335   /// there is an error.
336   bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
337                 unsigned InstNum, Type *Ty, Value *&ResVal) {
338     if (getValue(Record, Slot, InstNum, Ty, ResVal))
339       return true;
340     // All values currently take a single record slot.
341     ++Slot;
342     return false;
343   }
344
345   /// Like popValue, but does not increment the Slot number.
346   bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
347                 unsigned InstNum, Type *Ty, Value *&ResVal) {
348     ResVal = getValue(Record, Slot, InstNum, Ty);
349     return ResVal == nullptr;
350   }
351
352   /// Version of getValue that returns ResVal directly, or 0 if there is an
353   /// error.
354   Value *getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
355                   unsigned InstNum, Type *Ty) {
356     if (Slot == Record.size()) return nullptr;
357     unsigned ValNo = (unsigned)Record[Slot];
358     // Adjust the ValNo, if it was encoded relative to the InstNum.
359     if (UseRelativeIDs)
360       ValNo = InstNum - ValNo;
361     return getFnValueByID(ValNo, Ty);
362   }
363
364   /// Like getValue, but decodes signed VBRs.
365   Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
366                         unsigned InstNum, Type *Ty) {
367     if (Slot == Record.size()) return nullptr;
368     unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
369     // Adjust the ValNo, if it was encoded relative to the InstNum.
370     if (UseRelativeIDs)
371       ValNo = InstNum - ValNo;
372     return getFnValueByID(ValNo, Ty);
373   }
374
375   /// Converts alignment exponent (i.e. power of two (or zero)) to the
376   /// corresponding alignment to use. If alignment is too large, returns
377   /// a corresponding error code.
378   std::error_code parseAlignmentValue(uint64_t Exponent, unsigned &Alignment);
379   std::error_code parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
380   std::error_code parseModule(uint64_t ResumeBit,
381                               bool ShouldLazyLoadMetadata = false);
382   std::error_code parseAttributeBlock();
383   std::error_code parseAttributeGroupBlock();
384   std::error_code parseTypeTable();
385   std::error_code parseTypeTableBody();
386   std::error_code parseOperandBundleTags();
387
388   ErrorOr<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,
389                                unsigned NameIndex, Triple &TT);
390   std::error_code parseValueSymbolTable(uint64_t Offset = 0);
391   std::error_code parseConstants();
392   std::error_code rememberAndSkipFunctionBodies();
393   std::error_code rememberAndSkipFunctionBody();
394   /// Save the positions of the Metadata blocks and skip parsing the blocks.
395   std::error_code rememberAndSkipMetadata();
396   std::error_code parseFunctionBody(Function *F);
397   std::error_code globalCleanup();
398   std::error_code resolveGlobalAndAliasInits();
399   std::error_code parseMetadata(bool ModuleLevel = false);
400   std::error_code parseMetadataKinds();
401   std::error_code parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record);
402   std::error_code parseMetadataAttachment(Function &F);
403   ErrorOr<std::string> parseModuleTriple();
404   std::error_code parseUseLists();
405   std::error_code initStream(std::unique_ptr<DataStreamer> Streamer);
406   std::error_code initStreamFromBuffer();
407   std::error_code initLazyStream(std::unique_ptr<DataStreamer> Streamer);
408   std::error_code findFunctionInStream(
409       Function *F,
410       DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
411 };
412
413 /// Class to manage reading and parsing function summary index bitcode
414 /// files/sections.
415 class FunctionIndexBitcodeReader {
416   DiagnosticHandlerFunction DiagnosticHandler;
417
418   /// Eventually points to the function index built during parsing.
419   FunctionInfoIndex *TheIndex = nullptr;
420
421   std::unique_ptr<MemoryBuffer> Buffer;
422   std::unique_ptr<BitstreamReader> StreamFile;
423   BitstreamCursor Stream;
424
425   /// \brief Used to indicate whether we are doing lazy parsing of summary data.
426   ///
427   /// If false, the summary section is fully parsed into the index during
428   /// the initial parse. Otherwise, if true, the caller is expected to
429   /// invoke \a readFunctionSummary for each summary needed, and the summary
430   /// section is thus parsed lazily.
431   bool IsLazy = false;
432
433   /// Used to indicate whether caller only wants to check for the presence
434   /// of the function summary bitcode section. All blocks are skipped,
435   /// but the SeenFuncSummary boolean is set.
436   bool CheckFuncSummaryPresenceOnly = false;
437
438   /// Indicates whether we have encountered a function summary section
439   /// yet during parsing, used when checking if file contains function
440   /// summary section.
441   bool SeenFuncSummary = false;
442
443   /// \brief Map populated during function summary section parsing, and
444   /// consumed during ValueSymbolTable parsing.
445   ///
446   /// Used to correlate summary records with VST entries. For the per-module
447   /// index this maps the ValueID to the parsed function summary, and
448   /// for the combined index this maps the summary record's bitcode
449   /// offset to the function summary (since in the combined index the
450   /// VST records do not hold value IDs but rather hold the function
451   /// summary record offset).
452   DenseMap<uint64_t, std::unique_ptr<FunctionSummary>> SummaryMap;
453
454   /// Map populated during module path string table parsing, from the
455   /// module ID to a string reference owned by the index's module
456   /// path string table, used to correlate with combined index function
457   /// summary records.
458   DenseMap<uint64_t, StringRef> ModuleIdMap;
459
460 public:
461   std::error_code error(BitcodeError E, const Twine &Message);
462   std::error_code error(BitcodeError E);
463   std::error_code error(const Twine &Message);
464
465   FunctionIndexBitcodeReader(MemoryBuffer *Buffer,
466                              DiagnosticHandlerFunction DiagnosticHandler,
467                              bool IsLazy = false,
468                              bool CheckFuncSummaryPresenceOnly = false);
469   FunctionIndexBitcodeReader(DiagnosticHandlerFunction DiagnosticHandler,
470                              bool IsLazy = false,
471                              bool CheckFuncSummaryPresenceOnly = false);
472   ~FunctionIndexBitcodeReader() { freeState(); }
473
474   void freeState();
475
476   void releaseBuffer();
477
478   /// Check if the parser has encountered a function summary section.
479   bool foundFuncSummary() { return SeenFuncSummary; }
480
481   /// \brief Main interface to parsing a bitcode buffer.
482   /// \returns true if an error occurred.
483   std::error_code parseSummaryIndexInto(std::unique_ptr<DataStreamer> Streamer,
484                                         FunctionInfoIndex *I);
485
486   /// \brief Interface for parsing a function summary lazily.
487   std::error_code parseFunctionSummary(std::unique_ptr<DataStreamer> Streamer,
488                                        FunctionInfoIndex *I,
489                                        size_t FunctionSummaryOffset);
490
491 private:
492   std::error_code parseModule();
493   std::error_code parseValueSymbolTable();
494   std::error_code parseEntireSummary();
495   std::error_code parseModuleStringTable();
496   std::error_code initStream(std::unique_ptr<DataStreamer> Streamer);
497   std::error_code initStreamFromBuffer();
498   std::error_code initLazyStream(std::unique_ptr<DataStreamer> Streamer);
499 };
500 } // namespace
501
502 BitcodeDiagnosticInfo::BitcodeDiagnosticInfo(std::error_code EC,
503                                              DiagnosticSeverity Severity,
504                                              const Twine &Msg)
505     : DiagnosticInfo(DK_Bitcode, Severity), Msg(Msg), EC(EC) {}
506
507 void BitcodeDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
508
509 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
510                              std::error_code EC, const Twine &Message) {
511   BitcodeDiagnosticInfo DI(EC, DS_Error, Message);
512   DiagnosticHandler(DI);
513   return EC;
514 }
515
516 static std::error_code error(DiagnosticHandlerFunction DiagnosticHandler,
517                              std::error_code EC) {
518   return error(DiagnosticHandler, EC, EC.message());
519 }
520
521 static std::error_code error(LLVMContext &Context, std::error_code EC,
522                              const Twine &Message) {
523   return error([&](const DiagnosticInfo &DI) { Context.diagnose(DI); }, EC,
524                Message);
525 }
526
527 static std::error_code error(LLVMContext &Context, std::error_code EC) {
528   return error(Context, EC, EC.message());
529 }
530
531 static std::error_code error(LLVMContext &Context, const Twine &Message) {
532   return error(Context, make_error_code(BitcodeError::CorruptedBitcode),
533                Message);
534 }
535
536 std::error_code BitcodeReader::error(BitcodeError E, const Twine &Message) {
537   if (!ProducerIdentification.empty()) {
538     return ::error(Context, make_error_code(E),
539                    Message + " (Producer: '" + ProducerIdentification +
540                        "' Reader: 'LLVM " + LLVM_VERSION_STRING "')");
541   }
542   return ::error(Context, make_error_code(E), Message);
543 }
544
545 std::error_code BitcodeReader::error(const Twine &Message) {
546   if (!ProducerIdentification.empty()) {
547     return ::error(Context, make_error_code(BitcodeError::CorruptedBitcode),
548                    Message + " (Producer: '" + ProducerIdentification +
549                        "' Reader: 'LLVM " + LLVM_VERSION_STRING "')");
550   }
551   return ::error(Context, make_error_code(BitcodeError::CorruptedBitcode),
552                  Message);
553 }
554
555 std::error_code BitcodeReader::error(BitcodeError E) {
556   return ::error(Context, make_error_code(E));
557 }
558
559 BitcodeReader::BitcodeReader(MemoryBuffer *Buffer, LLVMContext &Context)
560     : Context(Context), Buffer(Buffer), ValueList(Context),
561       MetadataList(Context) {}
562
563 BitcodeReader::BitcodeReader(LLVMContext &Context)
564     : Context(Context), Buffer(nullptr), ValueList(Context),
565       MetadataList(Context) {}
566
567 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
568   if (WillMaterializeAllForwardRefs)
569     return std::error_code();
570
571   // Prevent recursion.
572   WillMaterializeAllForwardRefs = true;
573
574   while (!BasicBlockFwdRefQueue.empty()) {
575     Function *F = BasicBlockFwdRefQueue.front();
576     BasicBlockFwdRefQueue.pop_front();
577     assert(F && "Expected valid function");
578     if (!BasicBlockFwdRefs.count(F))
579       // Already materialized.
580       continue;
581
582     // Check for a function that isn't materializable to prevent an infinite
583     // loop.  When parsing a blockaddress stored in a global variable, there
584     // isn't a trivial way to check if a function will have a body without a
585     // linear search through FunctionsWithBodies, so just check it here.
586     if (!F->isMaterializable())
587       return error("Never resolved function from blockaddress");
588
589     // Try to materialize F.
590     if (std::error_code EC = materialize(F))
591       return EC;
592   }
593   assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
594
595   // Reset state.
596   WillMaterializeAllForwardRefs = false;
597   return std::error_code();
598 }
599
600 void BitcodeReader::freeState() {
601   Buffer = nullptr;
602   std::vector<Type*>().swap(TypeList);
603   ValueList.clear();
604   MetadataList.clear();
605   std::vector<Comdat *>().swap(ComdatList);
606
607   std::vector<AttributeSet>().swap(MAttributes);
608   std::vector<BasicBlock*>().swap(FunctionBBs);
609   std::vector<Function*>().swap(FunctionsWithBodies);
610   DeferredFunctionInfo.clear();
611   DeferredMetadataInfo.clear();
612   MDKindMap.clear();
613
614   assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
615   BasicBlockFwdRefQueue.clear();
616 }
617
618 //===----------------------------------------------------------------------===//
619 //  Helper functions to implement forward reference resolution, etc.
620 //===----------------------------------------------------------------------===//
621
622 /// Convert a string from a record into an std::string, return true on failure.
623 template <typename StrTy>
624 static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
625                             StrTy &Result) {
626   if (Idx > Record.size())
627     return true;
628
629   for (unsigned i = Idx, e = Record.size(); i != e; ++i)
630     Result += (char)Record[i];
631   return false;
632 }
633
634 static bool hasImplicitComdat(size_t Val) {
635   switch (Val) {
636   default:
637     return false;
638   case 1:  // Old WeakAnyLinkage
639   case 4:  // Old LinkOnceAnyLinkage
640   case 10: // Old WeakODRLinkage
641   case 11: // Old LinkOnceODRLinkage
642     return true;
643   }
644 }
645
646 static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
647   switch (Val) {
648   default: // Map unknown/new linkages to external
649   case 0:
650     return GlobalValue::ExternalLinkage;
651   case 2:
652     return GlobalValue::AppendingLinkage;
653   case 3:
654     return GlobalValue::InternalLinkage;
655   case 5:
656     return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
657   case 6:
658     return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
659   case 7:
660     return GlobalValue::ExternalWeakLinkage;
661   case 8:
662     return GlobalValue::CommonLinkage;
663   case 9:
664     return GlobalValue::PrivateLinkage;
665   case 12:
666     return GlobalValue::AvailableExternallyLinkage;
667   case 13:
668     return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
669   case 14:
670     return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
671   case 15:
672     return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
673   case 1: // Old value with implicit comdat.
674   case 16:
675     return GlobalValue::WeakAnyLinkage;
676   case 10: // Old value with implicit comdat.
677   case 17:
678     return GlobalValue::WeakODRLinkage;
679   case 4: // Old value with implicit comdat.
680   case 18:
681     return GlobalValue::LinkOnceAnyLinkage;
682   case 11: // Old value with implicit comdat.
683   case 19:
684     return GlobalValue::LinkOnceODRLinkage;
685   }
686 }
687
688 static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {
689   switch (Val) {
690   default: // Map unknown visibilities to default.
691   case 0: return GlobalValue::DefaultVisibility;
692   case 1: return GlobalValue::HiddenVisibility;
693   case 2: return GlobalValue::ProtectedVisibility;
694   }
695 }
696
697 static GlobalValue::DLLStorageClassTypes
698 getDecodedDLLStorageClass(unsigned Val) {
699   switch (Val) {
700   default: // Map unknown values to default.
701   case 0: return GlobalValue::DefaultStorageClass;
702   case 1: return GlobalValue::DLLImportStorageClass;
703   case 2: return GlobalValue::DLLExportStorageClass;
704   }
705 }
706
707 static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {
708   switch (Val) {
709     case 0: return GlobalVariable::NotThreadLocal;
710     default: // Map unknown non-zero value to general dynamic.
711     case 1: return GlobalVariable::GeneralDynamicTLSModel;
712     case 2: return GlobalVariable::LocalDynamicTLSModel;
713     case 3: return GlobalVariable::InitialExecTLSModel;
714     case 4: return GlobalVariable::LocalExecTLSModel;
715   }
716 }
717
718 static int getDecodedCastOpcode(unsigned Val) {
719   switch (Val) {
720   default: return -1;
721   case bitc::CAST_TRUNC   : return Instruction::Trunc;
722   case bitc::CAST_ZEXT    : return Instruction::ZExt;
723   case bitc::CAST_SEXT    : return Instruction::SExt;
724   case bitc::CAST_FPTOUI  : return Instruction::FPToUI;
725   case bitc::CAST_FPTOSI  : return Instruction::FPToSI;
726   case bitc::CAST_UITOFP  : return Instruction::UIToFP;
727   case bitc::CAST_SITOFP  : return Instruction::SIToFP;
728   case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
729   case bitc::CAST_FPEXT   : return Instruction::FPExt;
730   case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
731   case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
732   case bitc::CAST_BITCAST : return Instruction::BitCast;
733   case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
734   }
735 }
736
737 static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
738   bool IsFP = Ty->isFPOrFPVectorTy();
739   // BinOps are only valid for int/fp or vector of int/fp types
740   if (!IsFP && !Ty->isIntOrIntVectorTy())
741     return -1;
742
743   switch (Val) {
744   default:
745     return -1;
746   case bitc::BINOP_ADD:
747     return IsFP ? Instruction::FAdd : Instruction::Add;
748   case bitc::BINOP_SUB:
749     return IsFP ? Instruction::FSub : Instruction::Sub;
750   case bitc::BINOP_MUL:
751     return IsFP ? Instruction::FMul : Instruction::Mul;
752   case bitc::BINOP_UDIV:
753     return IsFP ? -1 : Instruction::UDiv;
754   case bitc::BINOP_SDIV:
755     return IsFP ? Instruction::FDiv : Instruction::SDiv;
756   case bitc::BINOP_UREM:
757     return IsFP ? -1 : Instruction::URem;
758   case bitc::BINOP_SREM:
759     return IsFP ? Instruction::FRem : Instruction::SRem;
760   case bitc::BINOP_SHL:
761     return IsFP ? -1 : Instruction::Shl;
762   case bitc::BINOP_LSHR:
763     return IsFP ? -1 : Instruction::LShr;
764   case bitc::BINOP_ASHR:
765     return IsFP ? -1 : Instruction::AShr;
766   case bitc::BINOP_AND:
767     return IsFP ? -1 : Instruction::And;
768   case bitc::BINOP_OR:
769     return IsFP ? -1 : Instruction::Or;
770   case bitc::BINOP_XOR:
771     return IsFP ? -1 : Instruction::Xor;
772   }
773 }
774
775 static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {
776   switch (Val) {
777   default: return AtomicRMWInst::BAD_BINOP;
778   case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
779   case bitc::RMW_ADD: return AtomicRMWInst::Add;
780   case bitc::RMW_SUB: return AtomicRMWInst::Sub;
781   case bitc::RMW_AND: return AtomicRMWInst::And;
782   case bitc::RMW_NAND: return AtomicRMWInst::Nand;
783   case bitc::RMW_OR: return AtomicRMWInst::Or;
784   case bitc::RMW_XOR: return AtomicRMWInst::Xor;
785   case bitc::RMW_MAX: return AtomicRMWInst::Max;
786   case bitc::RMW_MIN: return AtomicRMWInst::Min;
787   case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
788   case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
789   }
790 }
791
792 static AtomicOrdering getDecodedOrdering(unsigned Val) {
793   switch (Val) {
794   case bitc::ORDERING_NOTATOMIC: return NotAtomic;
795   case bitc::ORDERING_UNORDERED: return Unordered;
796   case bitc::ORDERING_MONOTONIC: return Monotonic;
797   case bitc::ORDERING_ACQUIRE: return Acquire;
798   case bitc::ORDERING_RELEASE: return Release;
799   case bitc::ORDERING_ACQREL: return AcquireRelease;
800   default: // Map unknown orderings to sequentially-consistent.
801   case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
802   }
803 }
804
805 static SynchronizationScope getDecodedSynchScope(unsigned Val) {
806   switch (Val) {
807   case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
808   default: // Map unknown scopes to cross-thread.
809   case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
810   }
811 }
812
813 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
814   switch (Val) {
815   default: // Map unknown selection kinds to any.
816   case bitc::COMDAT_SELECTION_KIND_ANY:
817     return Comdat::Any;
818   case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
819     return Comdat::ExactMatch;
820   case bitc::COMDAT_SELECTION_KIND_LARGEST:
821     return Comdat::Largest;
822   case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
823     return Comdat::NoDuplicates;
824   case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
825     return Comdat::SameSize;
826   }
827 }
828
829 static FastMathFlags getDecodedFastMathFlags(unsigned Val) {
830   FastMathFlags FMF;
831   if (0 != (Val & FastMathFlags::UnsafeAlgebra))
832     FMF.setUnsafeAlgebra();
833   if (0 != (Val & FastMathFlags::NoNaNs))
834     FMF.setNoNaNs();
835   if (0 != (Val & FastMathFlags::NoInfs))
836     FMF.setNoInfs();
837   if (0 != (Val & FastMathFlags::NoSignedZeros))
838     FMF.setNoSignedZeros();
839   if (0 != (Val & FastMathFlags::AllowReciprocal))
840     FMF.setAllowReciprocal();
841   return FMF;
842 }
843
844 static void upgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
845   switch (Val) {
846   case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
847   case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
848   }
849 }
850
851 namespace llvm {
852 namespace {
853 /// \brief A class for maintaining the slot number definition
854 /// as a placeholder for the actual definition for forward constants defs.
855 class ConstantPlaceHolder : public ConstantExpr {
856   void operator=(const ConstantPlaceHolder &) = delete;
857
858 public:
859   // allocate space for exactly one operand
860   void *operator new(size_t s) { return User::operator new(s, 1); }
861   explicit ConstantPlaceHolder(Type *Ty, LLVMContext &Context)
862       : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
863     Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
864   }
865
866   /// \brief Methods to support type inquiry through isa, cast, and dyn_cast.
867   static bool classof(const Value *V) {
868     return isa<ConstantExpr>(V) &&
869            cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
870   }
871
872   /// Provide fast operand accessors
873   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
874 };
875 }
876
877 // FIXME: can we inherit this from ConstantExpr?
878 template <>
879 struct OperandTraits<ConstantPlaceHolder> :
880   public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
881 };
882 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantPlaceHolder, Value)
883 }
884
885 void BitcodeReaderValueList::assignValue(Value *V, unsigned Idx) {
886   if (Idx == size()) {
887     push_back(V);
888     return;
889   }
890
891   if (Idx >= size())
892     resize(Idx+1);
893
894   WeakVH &OldV = ValuePtrs[Idx];
895   if (!OldV) {
896     OldV = V;
897     return;
898   }
899
900   // Handle constants and non-constants (e.g. instrs) differently for
901   // efficiency.
902   if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
903     ResolveConstants.push_back(std::make_pair(PHC, Idx));
904     OldV = V;
905   } else {
906     // If there was a forward reference to this value, replace it.
907     Value *PrevVal = OldV;
908     OldV->replaceAllUsesWith(V);
909     delete PrevVal;
910   }
911
912   return;
913 }
914
915
916 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
917                                                     Type *Ty) {
918   if (Idx >= size())
919     resize(Idx + 1);
920
921   if (Value *V = ValuePtrs[Idx]) {
922     if (Ty != V->getType())
923       report_fatal_error("Type mismatch in constant table!");
924     return cast<Constant>(V);
925   }
926
927   // Create and return a placeholder, which will later be RAUW'd.
928   Constant *C = new ConstantPlaceHolder(Ty, Context);
929   ValuePtrs[Idx] = C;
930   return C;
931 }
932
933 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty) {
934   // Bail out for a clearly invalid value. This would make us call resize(0)
935   if (Idx == UINT_MAX)
936     return nullptr;
937
938   if (Idx >= size())
939     resize(Idx + 1);
940
941   if (Value *V = ValuePtrs[Idx]) {
942     // If the types don't match, it's invalid.
943     if (Ty && Ty != V->getType())
944       return nullptr;
945     return V;
946   }
947
948   // No type specified, must be invalid reference.
949   if (!Ty) return nullptr;
950
951   // Create and return a placeholder, which will later be RAUW'd.
952   Value *V = new Argument(Ty);
953   ValuePtrs[Idx] = V;
954   return V;
955 }
956
957 /// Once all constants are read, this method bulk resolves any forward
958 /// references.  The idea behind this is that we sometimes get constants (such
959 /// as large arrays) which reference *many* forward ref constants.  Replacing
960 /// each of these causes a lot of thrashing when building/reuniquing the
961 /// constant.  Instead of doing this, we look at all the uses and rewrite all
962 /// the place holders at once for any constant that uses a placeholder.
963 void BitcodeReaderValueList::resolveConstantForwardRefs() {
964   // Sort the values by-pointer so that they are efficient to look up with a
965   // binary search.
966   std::sort(ResolveConstants.begin(), ResolveConstants.end());
967
968   SmallVector<Constant*, 64> NewOps;
969
970   while (!ResolveConstants.empty()) {
971     Value *RealVal = operator[](ResolveConstants.back().second);
972     Constant *Placeholder = ResolveConstants.back().first;
973     ResolveConstants.pop_back();
974
975     // Loop over all users of the placeholder, updating them to reference the
976     // new value.  If they reference more than one placeholder, update them all
977     // at once.
978     while (!Placeholder->use_empty()) {
979       auto UI = Placeholder->user_begin();
980       User *U = *UI;
981
982       // If the using object isn't uniqued, just update the operands.  This
983       // handles instructions and initializers for global variables.
984       if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
985         UI.getUse().set(RealVal);
986         continue;
987       }
988
989       // Otherwise, we have a constant that uses the placeholder.  Replace that
990       // constant with a new constant that has *all* placeholder uses updated.
991       Constant *UserC = cast<Constant>(U);
992       for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
993            I != E; ++I) {
994         Value *NewOp;
995         if (!isa<ConstantPlaceHolder>(*I)) {
996           // Not a placeholder reference.
997           NewOp = *I;
998         } else if (*I == Placeholder) {
999           // Common case is that it just references this one placeholder.
1000           NewOp = RealVal;
1001         } else {
1002           // Otherwise, look up the placeholder in ResolveConstants.
1003           ResolveConstantsTy::iterator It =
1004             std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
1005                              std::pair<Constant*, unsigned>(cast<Constant>(*I),
1006                                                             0));
1007           assert(It != ResolveConstants.end() && It->first == *I);
1008           NewOp = operator[](It->second);
1009         }
1010
1011         NewOps.push_back(cast<Constant>(NewOp));
1012       }
1013
1014       // Make the new constant.
1015       Constant *NewC;
1016       if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
1017         NewC = ConstantArray::get(UserCA->getType(), NewOps);
1018       } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
1019         NewC = ConstantStruct::get(UserCS->getType(), NewOps);
1020       } else if (isa<ConstantVector>(UserC)) {
1021         NewC = ConstantVector::get(NewOps);
1022       } else {
1023         assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
1024         NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
1025       }
1026
1027       UserC->replaceAllUsesWith(NewC);
1028       UserC->destroyConstant();
1029       NewOps.clear();
1030     }
1031
1032     // Update all ValueHandles, they should be the only users at this point.
1033     Placeholder->replaceAllUsesWith(RealVal);
1034     delete Placeholder;
1035   }
1036 }
1037
1038 void BitcodeReaderMetadataList::assignValue(Metadata *MD, unsigned Idx) {
1039   if (Idx == size()) {
1040     push_back(MD);
1041     return;
1042   }
1043
1044   if (Idx >= size())
1045     resize(Idx+1);
1046
1047   TrackingMDRef &OldMD = MetadataPtrs[Idx];
1048   if (!OldMD) {
1049     OldMD.reset(MD);
1050     return;
1051   }
1052
1053   // If there was a forward reference to this value, replace it.
1054   TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
1055   PrevMD->replaceAllUsesWith(MD);
1056   --NumFwdRefs;
1057 }
1058
1059 Metadata *BitcodeReaderMetadataList::getValueFwdRef(unsigned Idx) {
1060   if (Idx >= size())
1061     resize(Idx + 1);
1062
1063   if (Metadata *MD = MetadataPtrs[Idx])
1064     return MD;
1065
1066   // Track forward refs to be resolved later.
1067   if (AnyFwdRefs) {
1068     MinFwdRef = std::min(MinFwdRef, Idx);
1069     MaxFwdRef = std::max(MaxFwdRef, Idx);
1070   } else {
1071     AnyFwdRefs = true;
1072     MinFwdRef = MaxFwdRef = Idx;
1073   }
1074   ++NumFwdRefs;
1075
1076   // Create and return a placeholder, which will later be RAUW'd.
1077   Metadata *MD = MDNode::getTemporary(Context, None).release();
1078   MetadataPtrs[Idx].reset(MD);
1079   return MD;
1080 }
1081
1082 void BitcodeReaderMetadataList::tryToResolveCycles() {
1083   if (!AnyFwdRefs)
1084     // Nothing to do.
1085     return;
1086
1087   if (NumFwdRefs)
1088     // Still forward references... can't resolve cycles.
1089     return;
1090
1091   // Resolve any cycles.
1092   for (unsigned I = MinFwdRef, E = MaxFwdRef + 1; I != E; ++I) {
1093     auto &MD = MetadataPtrs[I];
1094     auto *N = dyn_cast_or_null<MDNode>(MD);
1095     if (!N)
1096       continue;
1097
1098     assert(!N->isTemporary() && "Unexpected forward reference");
1099     N->resolveCycles();
1100   }
1101
1102   // Make sure we return early again until there's another forward ref.
1103   AnyFwdRefs = false;
1104 }
1105
1106 Type *BitcodeReader::getTypeByID(unsigned ID) {
1107   // The type table size is always specified correctly.
1108   if (ID >= TypeList.size())
1109     return nullptr;
1110
1111   if (Type *Ty = TypeList[ID])
1112     return Ty;
1113
1114   // If we have a forward reference, the only possible case is when it is to a
1115   // named struct.  Just create a placeholder for now.
1116   return TypeList[ID] = createIdentifiedStructType(Context);
1117 }
1118
1119 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
1120                                                       StringRef Name) {
1121   auto *Ret = StructType::create(Context, Name);
1122   IdentifiedStructTypes.push_back(Ret);
1123   return Ret;
1124 }
1125
1126 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
1127   auto *Ret = StructType::create(Context);
1128   IdentifiedStructTypes.push_back(Ret);
1129   return Ret;
1130 }
1131
1132
1133 //===----------------------------------------------------------------------===//
1134 //  Functions for parsing blocks from the bitcode file
1135 //===----------------------------------------------------------------------===//
1136
1137
1138 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
1139 /// been decoded from the given integer. This function must stay in sync with
1140 /// 'encodeLLVMAttributesForBitcode'.
1141 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1142                                            uint64_t EncodedAttrs) {
1143   // FIXME: Remove in 4.0.
1144
1145   // The alignment is stored as a 16-bit raw value from bits 31--16.  We shift
1146   // the bits above 31 down by 11 bits.
1147   unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1148   assert((!Alignment || isPowerOf2_32(Alignment)) &&
1149          "Alignment must be a power of two.");
1150
1151   if (Alignment)
1152     B.addAlignmentAttr(Alignment);
1153   B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1154                 (EncodedAttrs & 0xffff));
1155 }
1156
1157 std::error_code BitcodeReader::parseAttributeBlock() {
1158   if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
1159     return error("Invalid record");
1160
1161   if (!MAttributes.empty())
1162     return error("Invalid multiple blocks");
1163
1164   SmallVector<uint64_t, 64> Record;
1165
1166   SmallVector<AttributeSet, 8> Attrs;
1167
1168   // Read all the records.
1169   while (1) {
1170     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1171
1172     switch (Entry.Kind) {
1173     case BitstreamEntry::SubBlock: // Handled for us already.
1174     case BitstreamEntry::Error:
1175       return error("Malformed block");
1176     case BitstreamEntry::EndBlock:
1177       return std::error_code();
1178     case BitstreamEntry::Record:
1179       // The interesting case.
1180       break;
1181     }
1182
1183     // Read a record.
1184     Record.clear();
1185     switch (Stream.readRecord(Entry.ID, Record)) {
1186     default:  // Default behavior: ignore.
1187       break;
1188     case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
1189       // FIXME: Remove in 4.0.
1190       if (Record.size() & 1)
1191         return error("Invalid record");
1192
1193       for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1194         AttrBuilder B;
1195         decodeLLVMAttributesForBitcode(B, Record[i+1]);
1196         Attrs.push_back(AttributeSet::get(Context, Record[i], B));
1197       }
1198
1199       MAttributes.push_back(AttributeSet::get(Context, Attrs));
1200       Attrs.clear();
1201       break;
1202     }
1203     case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
1204       for (unsigned i = 0, e = Record.size(); i != e; ++i)
1205         Attrs.push_back(MAttributeGroups[Record[i]]);
1206
1207       MAttributes.push_back(AttributeSet::get(Context, Attrs));
1208       Attrs.clear();
1209       break;
1210     }
1211     }
1212   }
1213 }
1214
1215 // Returns Attribute::None on unrecognized codes.
1216 static Attribute::AttrKind getAttrFromCode(uint64_t Code) {
1217   switch (Code) {
1218   default:
1219     return Attribute::None;
1220   case bitc::ATTR_KIND_ALIGNMENT:
1221     return Attribute::Alignment;
1222   case bitc::ATTR_KIND_ALWAYS_INLINE:
1223     return Attribute::AlwaysInline;
1224   case bitc::ATTR_KIND_ARGMEMONLY:
1225     return Attribute::ArgMemOnly;
1226   case bitc::ATTR_KIND_BUILTIN:
1227     return Attribute::Builtin;
1228   case bitc::ATTR_KIND_BY_VAL:
1229     return Attribute::ByVal;
1230   case bitc::ATTR_KIND_IN_ALLOCA:
1231     return Attribute::InAlloca;
1232   case bitc::ATTR_KIND_COLD:
1233     return Attribute::Cold;
1234   case bitc::ATTR_KIND_CONVERGENT:
1235     return Attribute::Convergent;
1236   case bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY:
1237     return Attribute::InaccessibleMemOnly;
1238   case bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY:
1239     return Attribute::InaccessibleMemOrArgMemOnly;
1240   case bitc::ATTR_KIND_INLINE_HINT:
1241     return Attribute::InlineHint;
1242   case bitc::ATTR_KIND_IN_REG:
1243     return Attribute::InReg;
1244   case bitc::ATTR_KIND_JUMP_TABLE:
1245     return Attribute::JumpTable;
1246   case bitc::ATTR_KIND_MIN_SIZE:
1247     return Attribute::MinSize;
1248   case bitc::ATTR_KIND_NAKED:
1249     return Attribute::Naked;
1250   case bitc::ATTR_KIND_NEST:
1251     return Attribute::Nest;
1252   case bitc::ATTR_KIND_NO_ALIAS:
1253     return Attribute::NoAlias;
1254   case bitc::ATTR_KIND_NO_BUILTIN:
1255     return Attribute::NoBuiltin;
1256   case bitc::ATTR_KIND_NO_CAPTURE:
1257     return Attribute::NoCapture;
1258   case bitc::ATTR_KIND_NO_DUPLICATE:
1259     return Attribute::NoDuplicate;
1260   case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1261     return Attribute::NoImplicitFloat;
1262   case bitc::ATTR_KIND_NO_INLINE:
1263     return Attribute::NoInline;
1264   case bitc::ATTR_KIND_NO_RECURSE:
1265     return Attribute::NoRecurse;
1266   case bitc::ATTR_KIND_NON_LAZY_BIND:
1267     return Attribute::NonLazyBind;
1268   case bitc::ATTR_KIND_NON_NULL:
1269     return Attribute::NonNull;
1270   case bitc::ATTR_KIND_DEREFERENCEABLE:
1271     return Attribute::Dereferenceable;
1272   case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:
1273     return Attribute::DereferenceableOrNull;
1274   case bitc::ATTR_KIND_NO_RED_ZONE:
1275     return Attribute::NoRedZone;
1276   case bitc::ATTR_KIND_NO_RETURN:
1277     return Attribute::NoReturn;
1278   case bitc::ATTR_KIND_NO_UNWIND:
1279     return Attribute::NoUnwind;
1280   case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1281     return Attribute::OptimizeForSize;
1282   case bitc::ATTR_KIND_OPTIMIZE_NONE:
1283     return Attribute::OptimizeNone;
1284   case bitc::ATTR_KIND_READ_NONE:
1285     return Attribute::ReadNone;
1286   case bitc::ATTR_KIND_READ_ONLY:
1287     return Attribute::ReadOnly;
1288   case bitc::ATTR_KIND_RETURNED:
1289     return Attribute::Returned;
1290   case bitc::ATTR_KIND_RETURNS_TWICE:
1291     return Attribute::ReturnsTwice;
1292   case bitc::ATTR_KIND_S_EXT:
1293     return Attribute::SExt;
1294   case bitc::ATTR_KIND_STACK_ALIGNMENT:
1295     return Attribute::StackAlignment;
1296   case bitc::ATTR_KIND_STACK_PROTECT:
1297     return Attribute::StackProtect;
1298   case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1299     return Attribute::StackProtectReq;
1300   case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1301     return Attribute::StackProtectStrong;
1302   case bitc::ATTR_KIND_SAFESTACK:
1303     return Attribute::SafeStack;
1304   case bitc::ATTR_KIND_STRUCT_RET:
1305     return Attribute::StructRet;
1306   case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1307     return Attribute::SanitizeAddress;
1308   case bitc::ATTR_KIND_SANITIZE_THREAD:
1309     return Attribute::SanitizeThread;
1310   case bitc::ATTR_KIND_SANITIZE_MEMORY:
1311     return Attribute::SanitizeMemory;
1312   case bitc::ATTR_KIND_UW_TABLE:
1313     return Attribute::UWTable;
1314   case bitc::ATTR_KIND_Z_EXT:
1315     return Attribute::ZExt;
1316   }
1317 }
1318
1319 std::error_code BitcodeReader::parseAlignmentValue(uint64_t Exponent,
1320                                                    unsigned &Alignment) {
1321   // Note: Alignment in bitcode files is incremented by 1, so that zero
1322   // can be used for default alignment.
1323   if (Exponent > Value::MaxAlignmentExponent + 1)
1324     return error("Invalid alignment value");
1325   Alignment = (1 << static_cast<unsigned>(Exponent)) >> 1;
1326   return std::error_code();
1327 }
1328
1329 std::error_code BitcodeReader::parseAttrKind(uint64_t Code,
1330                                              Attribute::AttrKind *Kind) {
1331   *Kind = getAttrFromCode(Code);
1332   if (*Kind == Attribute::None)
1333     return error(BitcodeError::CorruptedBitcode,
1334                  "Unknown attribute kind (" + Twine(Code) + ")");
1335   return std::error_code();
1336 }
1337
1338 std::error_code BitcodeReader::parseAttributeGroupBlock() {
1339   if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
1340     return error("Invalid record");
1341
1342   if (!MAttributeGroups.empty())
1343     return error("Invalid multiple blocks");
1344
1345   SmallVector<uint64_t, 64> Record;
1346
1347   // Read all the records.
1348   while (1) {
1349     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1350
1351     switch (Entry.Kind) {
1352     case BitstreamEntry::SubBlock: // Handled for us already.
1353     case BitstreamEntry::Error:
1354       return error("Malformed block");
1355     case BitstreamEntry::EndBlock:
1356       return std::error_code();
1357     case BitstreamEntry::Record:
1358       // The interesting case.
1359       break;
1360     }
1361
1362     // Read a record.
1363     Record.clear();
1364     switch (Stream.readRecord(Entry.ID, Record)) {
1365     default:  // Default behavior: ignore.
1366       break;
1367     case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1368       if (Record.size() < 3)
1369         return error("Invalid record");
1370
1371       uint64_t GrpID = Record[0];
1372       uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1373
1374       AttrBuilder B;
1375       for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1376         if (Record[i] == 0) {        // Enum attribute
1377           Attribute::AttrKind Kind;
1378           if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1379             return EC;
1380
1381           B.addAttribute(Kind);
1382         } else if (Record[i] == 1) { // Integer attribute
1383           Attribute::AttrKind Kind;
1384           if (std::error_code EC = parseAttrKind(Record[++i], &Kind))
1385             return EC;
1386           if (Kind == Attribute::Alignment)
1387             B.addAlignmentAttr(Record[++i]);
1388           else if (Kind == Attribute::StackAlignment)
1389             B.addStackAlignmentAttr(Record[++i]);
1390           else if (Kind == Attribute::Dereferenceable)
1391             B.addDereferenceableAttr(Record[++i]);
1392           else if (Kind == Attribute::DereferenceableOrNull)
1393             B.addDereferenceableOrNullAttr(Record[++i]);
1394         } else {                     // String attribute
1395           assert((Record[i] == 3 || Record[i] == 4) &&
1396                  "Invalid attribute group entry");
1397           bool HasValue = (Record[i++] == 4);
1398           SmallString<64> KindStr;
1399           SmallString<64> ValStr;
1400
1401           while (Record[i] != 0 && i != e)
1402             KindStr += Record[i++];
1403           assert(Record[i] == 0 && "Kind string not null terminated");
1404
1405           if (HasValue) {
1406             // Has a value associated with it.
1407             ++i; // Skip the '0' that terminates the "kind" string.
1408             while (Record[i] != 0 && i != e)
1409               ValStr += Record[i++];
1410             assert(Record[i] == 0 && "Value string not null terminated");
1411           }
1412
1413           B.addAttribute(KindStr.str(), ValStr.str());
1414         }
1415       }
1416
1417       MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
1418       break;
1419     }
1420     }
1421   }
1422 }
1423
1424 std::error_code BitcodeReader::parseTypeTable() {
1425   if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
1426     return error("Invalid record");
1427
1428   return parseTypeTableBody();
1429 }
1430
1431 std::error_code BitcodeReader::parseTypeTableBody() {
1432   if (!TypeList.empty())
1433     return error("Invalid multiple blocks");
1434
1435   SmallVector<uint64_t, 64> Record;
1436   unsigned NumRecords = 0;
1437
1438   SmallString<64> TypeName;
1439
1440   // Read all the records for this type table.
1441   while (1) {
1442     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1443
1444     switch (Entry.Kind) {
1445     case BitstreamEntry::SubBlock: // Handled for us already.
1446     case BitstreamEntry::Error:
1447       return error("Malformed block");
1448     case BitstreamEntry::EndBlock:
1449       if (NumRecords != TypeList.size())
1450         return error("Malformed block");
1451       return std::error_code();
1452     case BitstreamEntry::Record:
1453       // The interesting case.
1454       break;
1455     }
1456
1457     // Read a record.
1458     Record.clear();
1459     Type *ResultTy = nullptr;
1460     switch (Stream.readRecord(Entry.ID, Record)) {
1461     default:
1462       return error("Invalid value");
1463     case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1464       // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1465       // type list.  This allows us to reserve space.
1466       if (Record.size() < 1)
1467         return error("Invalid record");
1468       TypeList.resize(Record[0]);
1469       continue;
1470     case bitc::TYPE_CODE_VOID:      // VOID
1471       ResultTy = Type::getVoidTy(Context);
1472       break;
1473     case bitc::TYPE_CODE_HALF:     // HALF
1474       ResultTy = Type::getHalfTy(Context);
1475       break;
1476     case bitc::TYPE_CODE_FLOAT:     // FLOAT
1477       ResultTy = Type::getFloatTy(Context);
1478       break;
1479     case bitc::TYPE_CODE_DOUBLE:    // DOUBLE
1480       ResultTy = Type::getDoubleTy(Context);
1481       break;
1482     case bitc::TYPE_CODE_X86_FP80:  // X86_FP80
1483       ResultTy = Type::getX86_FP80Ty(Context);
1484       break;
1485     case bitc::TYPE_CODE_FP128:     // FP128
1486       ResultTy = Type::getFP128Ty(Context);
1487       break;
1488     case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
1489       ResultTy = Type::getPPC_FP128Ty(Context);
1490       break;
1491     case bitc::TYPE_CODE_LABEL:     // LABEL
1492       ResultTy = Type::getLabelTy(Context);
1493       break;
1494     case bitc::TYPE_CODE_METADATA:  // METADATA
1495       ResultTy = Type::getMetadataTy(Context);
1496       break;
1497     case bitc::TYPE_CODE_X86_MMX:   // X86_MMX
1498       ResultTy = Type::getX86_MMXTy(Context);
1499       break;
1500     case bitc::TYPE_CODE_TOKEN:     // TOKEN
1501       ResultTy = Type::getTokenTy(Context);
1502       break;
1503     case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
1504       if (Record.size() < 1)
1505         return error("Invalid record");
1506
1507       uint64_t NumBits = Record[0];
1508       if (NumBits < IntegerType::MIN_INT_BITS ||
1509           NumBits > IntegerType::MAX_INT_BITS)
1510         return error("Bitwidth for integer type out of range");
1511       ResultTy = IntegerType::get(Context, NumBits);
1512       break;
1513     }
1514     case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
1515                                     //          [pointee type, address space]
1516       if (Record.size() < 1)
1517         return error("Invalid record");
1518       unsigned AddressSpace = 0;
1519       if (Record.size() == 2)
1520         AddressSpace = Record[1];
1521       ResultTy = getTypeByID(Record[0]);
1522       if (!ResultTy ||
1523           !PointerType::isValidElementType(ResultTy))
1524         return error("Invalid type");
1525       ResultTy = PointerType::get(ResultTy, AddressSpace);
1526       break;
1527     }
1528     case bitc::TYPE_CODE_FUNCTION_OLD: {
1529       // FIXME: attrid is dead, remove it in LLVM 4.0
1530       // FUNCTION: [vararg, attrid, retty, paramty x N]
1531       if (Record.size() < 3)
1532         return error("Invalid record");
1533       SmallVector<Type*, 8> ArgTys;
1534       for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1535         if (Type *T = getTypeByID(Record[i]))
1536           ArgTys.push_back(T);
1537         else
1538           break;
1539       }
1540
1541       ResultTy = getTypeByID(Record[2]);
1542       if (!ResultTy || ArgTys.size() < Record.size()-3)
1543         return error("Invalid type");
1544
1545       ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1546       break;
1547     }
1548     case bitc::TYPE_CODE_FUNCTION: {
1549       // FUNCTION: [vararg, retty, paramty x N]
1550       if (Record.size() < 2)
1551         return error("Invalid record");
1552       SmallVector<Type*, 8> ArgTys;
1553       for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1554         if (Type *T = getTypeByID(Record[i])) {
1555           if (!FunctionType::isValidArgumentType(T))
1556             return error("Invalid function argument type");
1557           ArgTys.push_back(T);
1558         }
1559         else
1560           break;
1561       }
1562
1563       ResultTy = getTypeByID(Record[1]);
1564       if (!ResultTy || ArgTys.size() < Record.size()-2)
1565         return error("Invalid type");
1566
1567       ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1568       break;
1569     }
1570     case bitc::TYPE_CODE_STRUCT_ANON: {  // STRUCT: [ispacked, eltty x N]
1571       if (Record.size() < 1)
1572         return error("Invalid record");
1573       SmallVector<Type*, 8> EltTys;
1574       for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1575         if (Type *T = getTypeByID(Record[i]))
1576           EltTys.push_back(T);
1577         else
1578           break;
1579       }
1580       if (EltTys.size() != Record.size()-1)
1581         return error("Invalid type");
1582       ResultTy = StructType::get(Context, EltTys, Record[0]);
1583       break;
1584     }
1585     case bitc::TYPE_CODE_STRUCT_NAME:   // STRUCT_NAME: [strchr x N]
1586       if (convertToString(Record, 0, TypeName))
1587         return error("Invalid record");
1588       continue;
1589
1590     case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1591       if (Record.size() < 1)
1592         return error("Invalid record");
1593
1594       if (NumRecords >= TypeList.size())
1595         return error("Invalid TYPE table");
1596
1597       // Check to see if this was forward referenced, if so fill in the temp.
1598       StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1599       if (Res) {
1600         Res->setName(TypeName);
1601         TypeList[NumRecords] = nullptr;
1602       } else  // Otherwise, create a new struct.
1603         Res = createIdentifiedStructType(Context, TypeName);
1604       TypeName.clear();
1605
1606       SmallVector<Type*, 8> EltTys;
1607       for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1608         if (Type *T = getTypeByID(Record[i]))
1609           EltTys.push_back(T);
1610         else
1611           break;
1612       }
1613       if (EltTys.size() != Record.size()-1)
1614         return error("Invalid record");
1615       Res->setBody(EltTys, Record[0]);
1616       ResultTy = Res;
1617       break;
1618     }
1619     case bitc::TYPE_CODE_OPAQUE: {       // OPAQUE: []
1620       if (Record.size() != 1)
1621         return error("Invalid record");
1622
1623       if (NumRecords >= TypeList.size())
1624         return error("Invalid TYPE table");
1625
1626       // Check to see if this was forward referenced, if so fill in the temp.
1627       StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1628       if (Res) {
1629         Res->setName(TypeName);
1630         TypeList[NumRecords] = nullptr;
1631       } else  // Otherwise, create a new struct with no body.
1632         Res = createIdentifiedStructType(Context, TypeName);
1633       TypeName.clear();
1634       ResultTy = Res;
1635       break;
1636     }
1637     case bitc::TYPE_CODE_ARRAY:     // ARRAY: [numelts, eltty]
1638       if (Record.size() < 2)
1639         return error("Invalid record");
1640       ResultTy = getTypeByID(Record[1]);
1641       if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
1642         return error("Invalid type");
1643       ResultTy = ArrayType::get(ResultTy, Record[0]);
1644       break;
1645     case bitc::TYPE_CODE_VECTOR:    // VECTOR: [numelts, eltty]
1646       if (Record.size() < 2)
1647         return error("Invalid record");
1648       if (Record[0] == 0)
1649         return error("Invalid vector length");
1650       ResultTy = getTypeByID(Record[1]);
1651       if (!ResultTy || !StructType::isValidElementType(ResultTy))
1652         return error("Invalid type");
1653       ResultTy = VectorType::get(ResultTy, Record[0]);
1654       break;
1655     }
1656
1657     if (NumRecords >= TypeList.size())
1658       return error("Invalid TYPE table");
1659     if (TypeList[NumRecords])
1660       return error(
1661           "Invalid TYPE table: Only named structs can be forward referenced");
1662     assert(ResultTy && "Didn't read a type?");
1663     TypeList[NumRecords++] = ResultTy;
1664   }
1665 }
1666
1667 std::error_code BitcodeReader::parseOperandBundleTags() {
1668   if (Stream.EnterSubBlock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID))
1669     return error("Invalid record");
1670
1671   if (!BundleTags.empty())
1672     return error("Invalid multiple blocks");
1673
1674   SmallVector<uint64_t, 64> Record;
1675
1676   while (1) {
1677     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1678
1679     switch (Entry.Kind) {
1680     case BitstreamEntry::SubBlock: // Handled for us already.
1681     case BitstreamEntry::Error:
1682       return error("Malformed block");
1683     case BitstreamEntry::EndBlock:
1684       return std::error_code();
1685     case BitstreamEntry::Record:
1686       // The interesting case.
1687       break;
1688     }
1689
1690     // Tags are implicitly mapped to integers by their order.
1691
1692     if (Stream.readRecord(Entry.ID, Record) != bitc::OPERAND_BUNDLE_TAG)
1693       return error("Invalid record");
1694
1695     // OPERAND_BUNDLE_TAG: [strchr x N]
1696     BundleTags.emplace_back();
1697     if (convertToString(Record, 0, BundleTags.back()))
1698       return error("Invalid record");
1699     Record.clear();
1700   }
1701 }
1702
1703 /// Associate a value with its name from the given index in the provided record.
1704 ErrorOr<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,
1705                                             unsigned NameIndex, Triple &TT) {
1706   SmallString<128> ValueName;
1707   if (convertToString(Record, NameIndex, ValueName))
1708     return error("Invalid record");
1709   unsigned ValueID = Record[0];
1710   if (ValueID >= ValueList.size() || !ValueList[ValueID])
1711     return error("Invalid record");
1712   Value *V = ValueList[ValueID];
1713
1714   StringRef NameStr(ValueName.data(), ValueName.size());
1715   if (NameStr.find_first_of(0) != StringRef::npos)
1716     return error("Invalid value name");
1717   V->setName(NameStr);
1718   auto *GO = dyn_cast<GlobalObject>(V);
1719   if (GO) {
1720     if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1721       if (TT.isOSBinFormatMachO())
1722         GO->setComdat(nullptr);
1723       else
1724         GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1725     }
1726   }
1727   return V;
1728 }
1729
1730 /// Parse the value symbol table at either the current parsing location or
1731 /// at the given bit offset if provided.
1732 std::error_code BitcodeReader::parseValueSymbolTable(uint64_t Offset) {
1733   uint64_t CurrentBit;
1734   // Pass in the Offset to distinguish between calling for the module-level
1735   // VST (where we want to jump to the VST offset) and the function-level
1736   // VST (where we don't).
1737   if (Offset > 0) {
1738     // Save the current parsing location so we can jump back at the end
1739     // of the VST read.
1740     CurrentBit = Stream.GetCurrentBitNo();
1741     Stream.JumpToBit(Offset * 32);
1742 #ifndef NDEBUG
1743     // Do some checking if we are in debug mode.
1744     BitstreamEntry Entry = Stream.advance();
1745     assert(Entry.Kind == BitstreamEntry::SubBlock);
1746     assert(Entry.ID == bitc::VALUE_SYMTAB_BLOCK_ID);
1747 #else
1748     // In NDEBUG mode ignore the output so we don't get an unused variable
1749     // warning.
1750     Stream.advance();
1751 #endif
1752   }
1753
1754   // Compute the delta between the bitcode indices in the VST (the word offset
1755   // to the word-aligned ENTER_SUBBLOCK for the function block, and that
1756   // expected by the lazy reader. The reader's EnterSubBlock expects to have
1757   // already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID
1758   // (size BlockIDWidth). Note that we access the stream's AbbrevID width here
1759   // just before entering the VST subblock because: 1) the EnterSubBlock
1760   // changes the AbbrevID width; 2) the VST block is nested within the same
1761   // outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same
1762   // AbbrevID width before calling EnterSubBlock; and 3) when we want to
1763   // jump to the FUNCTION_BLOCK using this offset later, we don't want
1764   // to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.
1765   unsigned FuncBitcodeOffsetDelta =
1766       Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
1767
1768   if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1769     return error("Invalid record");
1770
1771   SmallVector<uint64_t, 64> Record;
1772
1773   Triple TT(TheModule->getTargetTriple());
1774
1775   // Read all the records for this value table.
1776   SmallString<128> ValueName;
1777   while (1) {
1778     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1779
1780     switch (Entry.Kind) {
1781     case BitstreamEntry::SubBlock: // Handled for us already.
1782     case BitstreamEntry::Error:
1783       return error("Malformed block");
1784     case BitstreamEntry::EndBlock:
1785       if (Offset > 0)
1786         Stream.JumpToBit(CurrentBit);
1787       return std::error_code();
1788     case BitstreamEntry::Record:
1789       // The interesting case.
1790       break;
1791     }
1792
1793     // Read a record.
1794     Record.clear();
1795     switch (Stream.readRecord(Entry.ID, Record)) {
1796     default:  // Default behavior: unknown type.
1797       break;
1798     case bitc::VST_CODE_ENTRY: {  // VST_ENTRY: [valueid, namechar x N]
1799       ErrorOr<Value *> ValOrErr = recordValue(Record, 1, TT);
1800       if (std::error_code EC = ValOrErr.getError())
1801         return EC;
1802       ValOrErr.get();
1803       break;
1804     }
1805     case bitc::VST_CODE_FNENTRY: {
1806       // VST_FNENTRY: [valueid, offset, namechar x N]
1807       ErrorOr<Value *> ValOrErr = recordValue(Record, 2, TT);
1808       if (std::error_code EC = ValOrErr.getError())
1809         return EC;
1810       Value *V = ValOrErr.get();
1811
1812       auto *GO = dyn_cast<GlobalObject>(V);
1813       if (!GO) {
1814         // If this is an alias, need to get the actual Function object
1815         // it aliases, in order to set up the DeferredFunctionInfo entry below.
1816         auto *GA = dyn_cast<GlobalAlias>(V);
1817         if (GA)
1818           GO = GA->getBaseObject();
1819         assert(GO);
1820       }
1821
1822       uint64_t FuncWordOffset = Record[1];
1823       Function *F = dyn_cast<Function>(GO);
1824       assert(F);
1825       uint64_t FuncBitOffset = FuncWordOffset * 32;
1826       DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;
1827       // Set the LastFunctionBlockBit to point to the last function block.
1828       // Later when parsing is resumed after function materialization,
1829       // we can simply skip that last function block.
1830       if (FuncBitOffset > LastFunctionBlockBit)
1831         LastFunctionBlockBit = FuncBitOffset;
1832       break;
1833     }
1834     case bitc::VST_CODE_BBENTRY: {
1835       if (convertToString(Record, 1, ValueName))
1836         return error("Invalid record");
1837       BasicBlock *BB = getBasicBlock(Record[0]);
1838       if (!BB)
1839         return error("Invalid record");
1840
1841       BB->setName(StringRef(ValueName.data(), ValueName.size()));
1842       ValueName.clear();
1843       break;
1844     }
1845     }
1846   }
1847 }
1848
1849 /// Parse a single METADATA_KIND record, inserting result in MDKindMap.
1850 std::error_code
1851 BitcodeReader::parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record) {
1852   if (Record.size() < 2)
1853     return error("Invalid record");
1854
1855   unsigned Kind = Record[0];
1856   SmallString<8> Name(Record.begin() + 1, Record.end());
1857
1858   unsigned NewKind = TheModule->getMDKindID(Name.str());
1859   if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1860     return error("Conflicting METADATA_KIND records");
1861   return std::error_code();
1862 }
1863
1864 static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
1865
1866 /// Parse a METADATA_BLOCK. If ModuleLevel is true then we are parsing
1867 /// module level metadata.
1868 std::error_code BitcodeReader::parseMetadata(bool ModuleLevel) {
1869   IsMetadataMaterialized = true;
1870   unsigned NextMetadataNo = MetadataList.size();
1871   if (ModuleLevel && SeenModuleValuesRecord) {
1872     // Now that we are parsing the module level metadata, we want to restart
1873     // the numbering of the MD values, and replace temp MD created earlier
1874     // with their real values. If we saw a METADATA_VALUE record then we
1875     // would have set the MetadataList size to the number specified in that
1876     // record, to support parsing function-level metadata first, and we need
1877     // to reset back to 0 to fill the MetadataList in with the parsed module
1878     // The function-level metadata parsing should have reset the MetadataList
1879     // size back to the value reported by the METADATA_VALUE record, saved in
1880     // NumModuleMDs.
1881     assert(NumModuleMDs == MetadataList.size() &&
1882            "Expected MetadataList to only contain module level values");
1883     NextMetadataNo = 0;
1884   }
1885
1886   if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1887     return error("Invalid record");
1888
1889   SmallVector<uint64_t, 64> Record;
1890
1891   auto getMD = [&](unsigned ID) -> Metadata * {
1892     return MetadataList.getValueFwdRef(ID);
1893   };
1894   auto getMDOrNull = [&](unsigned ID) -> Metadata *{
1895     if (ID)
1896       return getMD(ID - 1);
1897     return nullptr;
1898   };
1899   auto getMDString = [&](unsigned ID) -> MDString *{
1900     // This requires that the ID is not really a forward reference.  In
1901     // particular, the MDString must already have been resolved.
1902     return cast_or_null<MDString>(getMDOrNull(ID));
1903   };
1904
1905 #define GET_OR_DISTINCT(CLASS, DISTINCT, ARGS)                                 \
1906   (DISTINCT ? CLASS::getDistinct ARGS : CLASS::get ARGS)
1907
1908   // Read all the records.
1909   while (1) {
1910     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1911
1912     switch (Entry.Kind) {
1913     case BitstreamEntry::SubBlock: // Handled for us already.
1914     case BitstreamEntry::Error:
1915       return error("Malformed block");
1916     case BitstreamEntry::EndBlock:
1917       MetadataList.tryToResolveCycles();
1918       assert((!(ModuleLevel && SeenModuleValuesRecord) ||
1919               NumModuleMDs == MetadataList.size()) &&
1920              "Inconsistent bitcode: METADATA_VALUES mismatch");
1921       return std::error_code();
1922     case BitstreamEntry::Record:
1923       // The interesting case.
1924       break;
1925     }
1926
1927     // Read a record.
1928     Record.clear();
1929     unsigned Code = Stream.readRecord(Entry.ID, Record);
1930     bool IsDistinct = false;
1931     switch (Code) {
1932     default:  // Default behavior: ignore.
1933       break;
1934     case bitc::METADATA_NAME: {
1935       // Read name of the named metadata.
1936       SmallString<8> Name(Record.begin(), Record.end());
1937       Record.clear();
1938       Code = Stream.ReadCode();
1939
1940       unsigned NextBitCode = Stream.readRecord(Code, Record);
1941       if (NextBitCode != bitc::METADATA_NAMED_NODE)
1942         return error("METADATA_NAME not followed by METADATA_NAMED_NODE");
1943
1944       // Read named metadata elements.
1945       unsigned Size = Record.size();
1946       NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1947       for (unsigned i = 0; i != Size; ++i) {
1948         MDNode *MD =
1949             dyn_cast_or_null<MDNode>(MetadataList.getValueFwdRef(Record[i]));
1950         if (!MD)
1951           return error("Invalid record");
1952         NMD->addOperand(MD);
1953       }
1954       break;
1955     }
1956     case bitc::METADATA_OLD_FN_NODE: {
1957       // FIXME: Remove in 4.0.
1958       // This is a LocalAsMetadata record, the only type of function-local
1959       // metadata.
1960       if (Record.size() % 2 == 1)
1961         return error("Invalid record");
1962
1963       // If this isn't a LocalAsMetadata record, we're dropping it.  This used
1964       // to be legal, but there's no upgrade path.
1965       auto dropRecord = [&] {
1966         MetadataList.assignValue(MDNode::get(Context, None), NextMetadataNo++);
1967       };
1968       if (Record.size() != 2) {
1969         dropRecord();
1970         break;
1971       }
1972
1973       Type *Ty = getTypeByID(Record[0]);
1974       if (Ty->isMetadataTy() || Ty->isVoidTy()) {
1975         dropRecord();
1976         break;
1977       }
1978
1979       MetadataList.assignValue(
1980           LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1981           NextMetadataNo++);
1982       break;
1983     }
1984     case bitc::METADATA_OLD_NODE: {
1985       // FIXME: Remove in 4.0.
1986       if (Record.size() % 2 == 1)
1987         return error("Invalid record");
1988
1989       unsigned Size = Record.size();
1990       SmallVector<Metadata *, 8> Elts;
1991       for (unsigned i = 0; i != Size; i += 2) {
1992         Type *Ty = getTypeByID(Record[i]);
1993         if (!Ty)
1994           return error("Invalid record");
1995         if (Ty->isMetadataTy())
1996           Elts.push_back(MetadataList.getValueFwdRef(Record[i + 1]));
1997         else if (!Ty->isVoidTy()) {
1998           auto *MD =
1999               ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
2000           assert(isa<ConstantAsMetadata>(MD) &&
2001                  "Expected non-function-local metadata");
2002           Elts.push_back(MD);
2003         } else
2004           Elts.push_back(nullptr);
2005       }
2006       MetadataList.assignValue(MDNode::get(Context, Elts), NextMetadataNo++);
2007       break;
2008     }
2009     case bitc::METADATA_VALUE: {
2010       if (Record.size() != 2)
2011         return error("Invalid record");
2012
2013       Type *Ty = getTypeByID(Record[0]);
2014       if (Ty->isMetadataTy() || Ty->isVoidTy())
2015         return error("Invalid record");
2016
2017       MetadataList.assignValue(
2018           ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
2019           NextMetadataNo++);
2020       break;
2021     }
2022     case bitc::METADATA_DISTINCT_NODE:
2023       IsDistinct = true;
2024       // fallthrough...
2025     case bitc::METADATA_NODE: {
2026       SmallVector<Metadata *, 8> Elts;
2027       Elts.reserve(Record.size());
2028       for (unsigned ID : Record)
2029         Elts.push_back(ID ? MetadataList.getValueFwdRef(ID - 1) : nullptr);
2030       MetadataList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
2031                                           : MDNode::get(Context, Elts),
2032                                NextMetadataNo++);
2033       break;
2034     }
2035     case bitc::METADATA_LOCATION: {
2036       if (Record.size() != 5)
2037         return error("Invalid record");
2038
2039       unsigned Line = Record[1];
2040       unsigned Column = Record[2];
2041       MDNode *Scope = cast<MDNode>(MetadataList.getValueFwdRef(Record[3]));
2042       Metadata *InlinedAt =
2043           Record[4] ? MetadataList.getValueFwdRef(Record[4] - 1) : nullptr;
2044       MetadataList.assignValue(
2045           GET_OR_DISTINCT(DILocation, Record[0],
2046                           (Context, Line, Column, Scope, InlinedAt)),
2047           NextMetadataNo++);
2048       break;
2049     }
2050     case bitc::METADATA_GENERIC_DEBUG: {
2051       if (Record.size() < 4)
2052         return error("Invalid record");
2053
2054       unsigned Tag = Record[1];
2055       unsigned Version = Record[2];
2056
2057       if (Tag >= 1u << 16 || Version != 0)
2058         return error("Invalid record");
2059
2060       auto *Header = getMDString(Record[3]);
2061       SmallVector<Metadata *, 8> DwarfOps;
2062       for (unsigned I = 4, E = Record.size(); I != E; ++I)
2063         DwarfOps.push_back(
2064             Record[I] ? MetadataList.getValueFwdRef(Record[I] - 1) : nullptr);
2065       MetadataList.assignValue(
2066           GET_OR_DISTINCT(GenericDINode, Record[0],
2067                           (Context, Tag, Header, DwarfOps)),
2068           NextMetadataNo++);
2069       break;
2070     }
2071     case bitc::METADATA_SUBRANGE: {
2072       if (Record.size() != 3)
2073         return error("Invalid record");
2074
2075       MetadataList.assignValue(
2076           GET_OR_DISTINCT(DISubrange, Record[0],
2077                           (Context, Record[1], unrotateSign(Record[2]))),
2078           NextMetadataNo++);
2079       break;
2080     }
2081     case bitc::METADATA_ENUMERATOR: {
2082       if (Record.size() != 3)
2083         return error("Invalid record");
2084
2085       MetadataList.assignValue(
2086           GET_OR_DISTINCT(
2087               DIEnumerator, Record[0],
2088               (Context, unrotateSign(Record[1]), getMDString(Record[2]))),
2089           NextMetadataNo++);
2090       break;
2091     }
2092     case bitc::METADATA_BASIC_TYPE: {
2093       if (Record.size() != 6)
2094         return error("Invalid record");
2095
2096       MetadataList.assignValue(
2097           GET_OR_DISTINCT(DIBasicType, Record[0],
2098                           (Context, Record[1], getMDString(Record[2]),
2099                            Record[3], Record[4], Record[5])),
2100           NextMetadataNo++);
2101       break;
2102     }
2103     case bitc::METADATA_DERIVED_TYPE: {
2104       if (Record.size() != 12)
2105         return error("Invalid record");
2106
2107       MetadataList.assignValue(
2108           GET_OR_DISTINCT(DIDerivedType, Record[0],
2109                           (Context, Record[1], getMDString(Record[2]),
2110                            getMDOrNull(Record[3]), Record[4],
2111                            getMDOrNull(Record[5]), getMDOrNull(Record[6]),
2112                            Record[7], Record[8], Record[9], Record[10],
2113                            getMDOrNull(Record[11]))),
2114           NextMetadataNo++);
2115       break;
2116     }
2117     case bitc::METADATA_COMPOSITE_TYPE: {
2118       if (Record.size() != 16)
2119         return error("Invalid record");
2120
2121       MetadataList.assignValue(
2122           GET_OR_DISTINCT(DICompositeType, Record[0],
2123                           (Context, Record[1], getMDString(Record[2]),
2124                            getMDOrNull(Record[3]), Record[4],
2125                            getMDOrNull(Record[5]), getMDOrNull(Record[6]),
2126                            Record[7], Record[8], Record[9], Record[10],
2127                            getMDOrNull(Record[11]), Record[12],
2128                            getMDOrNull(Record[13]), getMDOrNull(Record[14]),
2129                            getMDString(Record[15]))),
2130           NextMetadataNo++);
2131       break;
2132     }
2133     case bitc::METADATA_SUBROUTINE_TYPE: {
2134       if (Record.size() != 3)
2135         return error("Invalid record");
2136
2137       MetadataList.assignValue(
2138           GET_OR_DISTINCT(DISubroutineType, Record[0],
2139                           (Context, Record[1], getMDOrNull(Record[2]))),
2140           NextMetadataNo++);
2141       break;
2142     }
2143
2144     case bitc::METADATA_MODULE: {
2145       if (Record.size() != 6)
2146         return error("Invalid record");
2147
2148       MetadataList.assignValue(
2149           GET_OR_DISTINCT(DIModule, Record[0],
2150                           (Context, getMDOrNull(Record[1]),
2151                            getMDString(Record[2]), getMDString(Record[3]),
2152                            getMDString(Record[4]), getMDString(Record[5]))),
2153           NextMetadataNo++);
2154       break;
2155     }
2156
2157     case bitc::METADATA_FILE: {
2158       if (Record.size() != 3)
2159         return error("Invalid record");
2160
2161       MetadataList.assignValue(
2162           GET_OR_DISTINCT(DIFile, Record[0], (Context, getMDString(Record[1]),
2163                                               getMDString(Record[2]))),
2164           NextMetadataNo++);
2165       break;
2166     }
2167     case bitc::METADATA_COMPILE_UNIT: {
2168       if (Record.size() < 14 || Record.size() > 16)
2169         return error("Invalid record");
2170
2171       // Ignore Record[0], which indicates whether this compile unit is
2172       // distinct.  It's always distinct.
2173       MetadataList.assignValue(
2174           DICompileUnit::getDistinct(
2175               Context, Record[1], getMDOrNull(Record[2]),
2176               getMDString(Record[3]), Record[4], getMDString(Record[5]),
2177               Record[6], getMDString(Record[7]), Record[8],
2178               getMDOrNull(Record[9]), getMDOrNull(Record[10]),
2179               getMDOrNull(Record[11]), getMDOrNull(Record[12]),
2180               getMDOrNull(Record[13]),
2181               Record.size() <= 15 ? 0 : getMDOrNull(Record[15]),
2182               Record.size() <= 14 ? 0 : Record[14]),
2183           NextMetadataNo++);
2184       break;
2185     }
2186     case bitc::METADATA_SUBPROGRAM: {
2187       if (Record.size() != 18 && Record.size() != 19)
2188         return error("Invalid record");
2189
2190       bool HasFn = Record.size() == 19;
2191       DISubprogram *SP = GET_OR_DISTINCT(
2192           DISubprogram,
2193           Record[0] || Record[8], // All definitions should be distinct.
2194           (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
2195            getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
2196            getMDOrNull(Record[6]), Record[7], Record[8], Record[9],
2197            getMDOrNull(Record[10]), Record[11], Record[12], Record[13],
2198            Record[14], getMDOrNull(Record[15 + HasFn]),
2199            getMDOrNull(Record[16 + HasFn]), getMDOrNull(Record[17 + HasFn])));
2200       MetadataList.assignValue(SP, NextMetadataNo++);
2201
2202       // Upgrade sp->function mapping to function->sp mapping.
2203       if (HasFn && Record[15]) {
2204         if (auto *CMD = dyn_cast<ConstantAsMetadata>(getMDOrNull(Record[15])))
2205           if (auto *F = dyn_cast<Function>(CMD->getValue())) {
2206             if (F->isMaterializable())
2207               // Defer until materialized; unmaterialized functions may not have
2208               // metadata.
2209               FunctionsWithSPs[F] = SP;
2210             else if (!F->empty())
2211               F->setSubprogram(SP);
2212           }
2213       }
2214       break;
2215     }
2216     case bitc::METADATA_LEXICAL_BLOCK: {
2217       if (Record.size() != 5)
2218         return error("Invalid record");
2219
2220       MetadataList.assignValue(
2221           GET_OR_DISTINCT(DILexicalBlock, Record[0],
2222                           (Context, getMDOrNull(Record[1]),
2223                            getMDOrNull(Record[2]), Record[3], Record[4])),
2224           NextMetadataNo++);
2225       break;
2226     }
2227     case bitc::METADATA_LEXICAL_BLOCK_FILE: {
2228       if (Record.size() != 4)
2229         return error("Invalid record");
2230
2231       MetadataList.assignValue(
2232           GET_OR_DISTINCT(DILexicalBlockFile, Record[0],
2233                           (Context, getMDOrNull(Record[1]),
2234                            getMDOrNull(Record[2]), Record[3])),
2235           NextMetadataNo++);
2236       break;
2237     }
2238     case bitc::METADATA_NAMESPACE: {
2239       if (Record.size() != 5)
2240         return error("Invalid record");
2241
2242       MetadataList.assignValue(
2243           GET_OR_DISTINCT(DINamespace, Record[0],
2244                           (Context, getMDOrNull(Record[1]),
2245                            getMDOrNull(Record[2]), getMDString(Record[3]),
2246                            Record[4])),
2247           NextMetadataNo++);
2248       break;
2249     }
2250     case bitc::METADATA_MACRO: {
2251       if (Record.size() != 5)
2252         return error("Invalid record");
2253
2254       MetadataList.assignValue(
2255           GET_OR_DISTINCT(DIMacro, Record[0],
2256                           (Context, Record[1], Record[2],
2257                            getMDString(Record[3]), getMDString(Record[4]))),
2258           NextMetadataNo++);
2259       break;
2260     }
2261     case bitc::METADATA_MACRO_FILE: {
2262       if (Record.size() != 5)
2263         return error("Invalid record");
2264
2265       MetadataList.assignValue(
2266           GET_OR_DISTINCT(DIMacroFile, Record[0],
2267                           (Context, Record[1], Record[2],
2268                            getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
2269           NextMetadataNo++);
2270       break;
2271     }
2272     case bitc::METADATA_TEMPLATE_TYPE: {
2273       if (Record.size() != 3)
2274         return error("Invalid record");
2275
2276       MetadataList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter,
2277                                                Record[0],
2278                                                (Context, getMDString(Record[1]),
2279                                                 getMDOrNull(Record[2]))),
2280                                NextMetadataNo++);
2281       break;
2282     }
2283     case bitc::METADATA_TEMPLATE_VALUE: {
2284       if (Record.size() != 5)
2285         return error("Invalid record");
2286
2287       MetadataList.assignValue(
2288           GET_OR_DISTINCT(DITemplateValueParameter, Record[0],
2289                           (Context, Record[1], getMDString(Record[2]),
2290                            getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
2291           NextMetadataNo++);
2292       break;
2293     }
2294     case bitc::METADATA_GLOBAL_VAR: {
2295       if (Record.size() != 11)
2296         return error("Invalid record");
2297
2298       MetadataList.assignValue(
2299           GET_OR_DISTINCT(DIGlobalVariable, Record[0],
2300                           (Context, getMDOrNull(Record[1]),
2301                            getMDString(Record[2]), getMDString(Record[3]),
2302                            getMDOrNull(Record[4]), Record[5],
2303                            getMDOrNull(Record[6]), Record[7], Record[8],
2304                            getMDOrNull(Record[9]), getMDOrNull(Record[10]))),
2305           NextMetadataNo++);
2306       break;
2307     }
2308     case bitc::METADATA_LOCAL_VAR: {
2309       // 10th field is for the obseleted 'inlinedAt:' field.
2310       if (Record.size() < 8 || Record.size() > 10)
2311         return error("Invalid record");
2312
2313       // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or
2314       // DW_TAG_arg_variable.
2315       bool HasTag = Record.size() > 8;
2316       MetadataList.assignValue(
2317           GET_OR_DISTINCT(DILocalVariable, Record[0],
2318                           (Context, getMDOrNull(Record[1 + HasTag]),
2319                            getMDString(Record[2 + HasTag]),
2320                            getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag],
2321                            getMDOrNull(Record[5 + HasTag]), Record[6 + HasTag],
2322                            Record[7 + HasTag])),
2323           NextMetadataNo++);
2324       break;
2325     }
2326     case bitc::METADATA_EXPRESSION: {
2327       if (Record.size() < 1)
2328         return error("Invalid record");
2329
2330       MetadataList.assignValue(
2331           GET_OR_DISTINCT(DIExpression, Record[0],
2332                           (Context, makeArrayRef(Record).slice(1))),
2333           NextMetadataNo++);
2334       break;
2335     }
2336     case bitc::METADATA_OBJC_PROPERTY: {
2337       if (Record.size() != 8)
2338         return error("Invalid record");
2339
2340       MetadataList.assignValue(
2341           GET_OR_DISTINCT(DIObjCProperty, Record[0],
2342                           (Context, getMDString(Record[1]),
2343                            getMDOrNull(Record[2]), Record[3],
2344                            getMDString(Record[4]), getMDString(Record[5]),
2345                            Record[6], getMDOrNull(Record[7]))),
2346           NextMetadataNo++);
2347       break;
2348     }
2349     case bitc::METADATA_IMPORTED_ENTITY: {
2350       if (Record.size() != 6)
2351         return error("Invalid record");
2352
2353       MetadataList.assignValue(
2354           GET_OR_DISTINCT(DIImportedEntity, Record[0],
2355                           (Context, Record[1], getMDOrNull(Record[2]),
2356                            getMDOrNull(Record[3]), Record[4],
2357                            getMDString(Record[5]))),
2358           NextMetadataNo++);
2359       break;
2360     }
2361     case bitc::METADATA_STRING: {
2362       std::string String(Record.begin(), Record.end());
2363       llvm::UpgradeMDStringConstant(String);
2364       Metadata *MD = MDString::get(Context, String);
2365       MetadataList.assignValue(MD, NextMetadataNo++);
2366       break;
2367     }
2368     case bitc::METADATA_KIND: {
2369       // Support older bitcode files that had METADATA_KIND records in a
2370       // block with METADATA_BLOCK_ID.
2371       if (std::error_code EC = parseMetadataKindRecord(Record))
2372         return EC;
2373       break;
2374     }
2375     }
2376   }
2377 #undef GET_OR_DISTINCT
2378 }
2379
2380 /// Parse the metadata kinds out of the METADATA_KIND_BLOCK.
2381 std::error_code BitcodeReader::parseMetadataKinds() {
2382   if (Stream.EnterSubBlock(bitc::METADATA_KIND_BLOCK_ID))
2383     return error("Invalid record");
2384
2385   SmallVector<uint64_t, 64> Record;
2386
2387   // Read all the records.
2388   while (1) {
2389     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2390
2391     switch (Entry.Kind) {
2392     case BitstreamEntry::SubBlock: // Handled for us already.
2393     case BitstreamEntry::Error:
2394       return error("Malformed block");
2395     case BitstreamEntry::EndBlock:
2396       return std::error_code();
2397     case BitstreamEntry::Record:
2398       // The interesting case.
2399       break;
2400     }
2401
2402     // Read a record.
2403     Record.clear();
2404     unsigned Code = Stream.readRecord(Entry.ID, Record);
2405     switch (Code) {
2406     default: // Default behavior: ignore.
2407       break;
2408     case bitc::METADATA_KIND: {
2409       if (std::error_code EC = parseMetadataKindRecord(Record))
2410         return EC;
2411       break;
2412     }
2413     }
2414   }
2415 }
2416
2417 /// Decode a signed value stored with the sign bit in the LSB for dense VBR
2418 /// encoding.
2419 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
2420   if ((V & 1) == 0)
2421     return V >> 1;
2422   if (V != 1)
2423     return -(V >> 1);
2424   // There is no such thing as -0 with integers.  "-0" really means MININT.
2425   return 1ULL << 63;
2426 }
2427
2428 /// Resolve all of the initializers for global values and aliases that we can.
2429 std::error_code BitcodeReader::resolveGlobalAndAliasInits() {
2430   std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
2431   std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
2432   std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
2433   std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
2434   std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFnWorklist;
2435
2436   GlobalInitWorklist.swap(GlobalInits);
2437   AliasInitWorklist.swap(AliasInits);
2438   FunctionPrefixWorklist.swap(FunctionPrefixes);
2439   FunctionPrologueWorklist.swap(FunctionPrologues);
2440   FunctionPersonalityFnWorklist.swap(FunctionPersonalityFns);
2441
2442   while (!GlobalInitWorklist.empty()) {
2443     unsigned ValID = GlobalInitWorklist.back().second;
2444     if (ValID >= ValueList.size()) {
2445       // Not ready to resolve this yet, it requires something later in the file.
2446       GlobalInits.push_back(GlobalInitWorklist.back());
2447     } else {
2448       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2449         GlobalInitWorklist.back().first->setInitializer(C);
2450       else
2451         return error("Expected a constant");
2452     }
2453     GlobalInitWorklist.pop_back();
2454   }
2455
2456   while (!AliasInitWorklist.empty()) {
2457     unsigned ValID = AliasInitWorklist.back().second;
2458     if (ValID >= ValueList.size()) {
2459       AliasInits.push_back(AliasInitWorklist.back());
2460     } else {
2461       Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]);
2462       if (!C)
2463         return error("Expected a constant");
2464       GlobalAlias *Alias = AliasInitWorklist.back().first;
2465       if (C->getType() != Alias->getType())
2466         return error("Alias and aliasee types don't match");
2467       Alias->setAliasee(C);
2468     }
2469     AliasInitWorklist.pop_back();
2470   }
2471
2472   while (!FunctionPrefixWorklist.empty()) {
2473     unsigned ValID = FunctionPrefixWorklist.back().second;
2474     if (ValID >= ValueList.size()) {
2475       FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2476     } else {
2477       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2478         FunctionPrefixWorklist.back().first->setPrefixData(C);
2479       else
2480         return error("Expected a constant");
2481     }
2482     FunctionPrefixWorklist.pop_back();
2483   }
2484
2485   while (!FunctionPrologueWorklist.empty()) {
2486     unsigned ValID = FunctionPrologueWorklist.back().second;
2487     if (ValID >= ValueList.size()) {
2488       FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2489     } else {
2490       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2491         FunctionPrologueWorklist.back().first->setPrologueData(C);
2492       else
2493         return error("Expected a constant");
2494     }
2495     FunctionPrologueWorklist.pop_back();
2496   }
2497
2498   while (!FunctionPersonalityFnWorklist.empty()) {
2499     unsigned ValID = FunctionPersonalityFnWorklist.back().second;
2500     if (ValID >= ValueList.size()) {
2501       FunctionPersonalityFns.push_back(FunctionPersonalityFnWorklist.back());
2502     } else {
2503       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2504         FunctionPersonalityFnWorklist.back().first->setPersonalityFn(C);
2505       else
2506         return error("Expected a constant");
2507     }
2508     FunctionPersonalityFnWorklist.pop_back();
2509   }
2510
2511   return std::error_code();
2512 }
2513
2514 static APInt readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
2515   SmallVector<uint64_t, 8> Words(Vals.size());
2516   std::transform(Vals.begin(), Vals.end(), Words.begin(),
2517                  BitcodeReader::decodeSignRotatedValue);
2518
2519   return APInt(TypeBits, Words);
2520 }
2521
2522 std::error_code BitcodeReader::parseConstants() {
2523   if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
2524     return error("Invalid record");
2525
2526   SmallVector<uint64_t, 64> Record;
2527
2528   // Read all the records for this value table.
2529   Type *CurTy = Type::getInt32Ty(Context);
2530   unsigned NextCstNo = ValueList.size();
2531   while (1) {
2532     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2533
2534     switch (Entry.Kind) {
2535     case BitstreamEntry::SubBlock: // Handled for us already.
2536     case BitstreamEntry::Error:
2537       return error("Malformed block");
2538     case BitstreamEntry::EndBlock:
2539       if (NextCstNo != ValueList.size())
2540         return error("Invalid ronstant reference");
2541
2542       // Once all the constants have been read, go through and resolve forward
2543       // references.
2544       ValueList.resolveConstantForwardRefs();
2545       return std::error_code();
2546     case BitstreamEntry::Record:
2547       // The interesting case.
2548       break;
2549     }
2550
2551     // Read a record.
2552     Record.clear();
2553     Value *V = nullptr;
2554     unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2555     switch (BitCode) {
2556     default:  // Default behavior: unknown constant
2557     case bitc::CST_CODE_UNDEF:     // UNDEF
2558       V = UndefValue::get(CurTy);
2559       break;
2560     case bitc::CST_CODE_SETTYPE:   // SETTYPE: [typeid]
2561       if (Record.empty())
2562         return error("Invalid record");
2563       if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
2564         return error("Invalid record");
2565       CurTy = TypeList[Record[0]];
2566       continue;  // Skip the ValueList manipulation.
2567     case bitc::CST_CODE_NULL:      // NULL
2568       V = Constant::getNullValue(CurTy);
2569       break;
2570     case bitc::CST_CODE_INTEGER:   // INTEGER: [intval]
2571       if (!CurTy->isIntegerTy() || Record.empty())
2572         return error("Invalid record");
2573       V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
2574       break;
2575     case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
2576       if (!CurTy->isIntegerTy() || Record.empty())
2577         return error("Invalid record");
2578
2579       APInt VInt =
2580           readWideAPInt(Record, cast<IntegerType>(CurTy)->getBitWidth());
2581       V = ConstantInt::get(Context, VInt);
2582
2583       break;
2584     }
2585     case bitc::CST_CODE_FLOAT: {    // FLOAT: [fpval]
2586       if (Record.empty())
2587         return error("Invalid record");
2588       if (CurTy->isHalfTy())
2589         V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
2590                                              APInt(16, (uint16_t)Record[0])));
2591       else if (CurTy->isFloatTy())
2592         V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
2593                                              APInt(32, (uint32_t)Record[0])));
2594       else if (CurTy->isDoubleTy())
2595         V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
2596                                              APInt(64, Record[0])));
2597       else if (CurTy->isX86_FP80Ty()) {
2598         // Bits are not stored the same way as a normal i80 APInt, compensate.
2599         uint64_t Rearrange[2];
2600         Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2601         Rearrange[1] = Record[0] >> 48;
2602         V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
2603                                              APInt(80, Rearrange)));
2604       } else if (CurTy->isFP128Ty())
2605         V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
2606                                              APInt(128, Record)));
2607       else if (CurTy->isPPC_FP128Ty())
2608         V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
2609                                              APInt(128, Record)));
2610       else
2611         V = UndefValue::get(CurTy);
2612       break;
2613     }
2614
2615     case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2616       if (Record.empty())
2617         return error("Invalid record");
2618
2619       unsigned Size = Record.size();
2620       SmallVector<Constant*, 16> Elts;
2621
2622       if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2623         for (unsigned i = 0; i != Size; ++i)
2624           Elts.push_back(ValueList.getConstantFwdRef(Record[i],
2625                                                      STy->getElementType(i)));
2626         V = ConstantStruct::get(STy, Elts);
2627       } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2628         Type *EltTy = ATy->getElementType();
2629         for (unsigned i = 0; i != Size; ++i)
2630           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2631         V = ConstantArray::get(ATy, Elts);
2632       } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2633         Type *EltTy = VTy->getElementType();
2634         for (unsigned i = 0; i != Size; ++i)
2635           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2636         V = ConstantVector::get(Elts);
2637       } else {
2638         V = UndefValue::get(CurTy);
2639       }
2640       break;
2641     }
2642     case bitc::CST_CODE_STRING:    // STRING: [values]
2643     case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2644       if (Record.empty())
2645         return error("Invalid record");
2646
2647       SmallString<16> Elts(Record.begin(), Record.end());
2648       V = ConstantDataArray::getString(Context, Elts,
2649                                        BitCode == bitc::CST_CODE_CSTRING);
2650       break;
2651     }
2652     case bitc::CST_CODE_DATA: {// DATA: [n x value]
2653       if (Record.empty())
2654         return error("Invalid record");
2655
2656       Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
2657       unsigned Size = Record.size();
2658
2659       if (EltTy->isIntegerTy(8)) {
2660         SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2661         if (isa<VectorType>(CurTy))
2662           V = ConstantDataVector::get(Context, Elts);
2663         else
2664           V = ConstantDataArray::get(Context, Elts);
2665       } else if (EltTy->isIntegerTy(16)) {
2666         SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2667         if (isa<VectorType>(CurTy))
2668           V = ConstantDataVector::get(Context, Elts);
2669         else
2670           V = ConstantDataArray::get(Context, Elts);
2671       } else if (EltTy->isIntegerTy(32)) {
2672         SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2673         if (isa<VectorType>(CurTy))
2674           V = ConstantDataVector::get(Context, Elts);
2675         else
2676           V = ConstantDataArray::get(Context, Elts);
2677       } else if (EltTy->isIntegerTy(64)) {
2678         SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2679         if (isa<VectorType>(CurTy))
2680           V = ConstantDataVector::get(Context, Elts);
2681         else
2682           V = ConstantDataArray::get(Context, Elts);
2683       } else if (EltTy->isFloatTy()) {
2684         SmallVector<float, 16> Elts(Size);
2685         std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
2686         if (isa<VectorType>(CurTy))
2687           V = ConstantDataVector::get(Context, Elts);
2688         else
2689           V = ConstantDataArray::get(Context, Elts);
2690       } else if (EltTy->isDoubleTy()) {
2691         SmallVector<double, 16> Elts(Size);
2692         std::transform(Record.begin(), Record.end(), Elts.begin(),
2693                        BitsToDouble);
2694         if (isa<VectorType>(CurTy))
2695           V = ConstantDataVector::get(Context, Elts);
2696         else
2697           V = ConstantDataArray::get(Context, Elts);
2698       } else {
2699         return error("Invalid type for value");
2700       }
2701       break;
2702     }
2703
2704     case bitc::CST_CODE_CE_BINOP: {  // CE_BINOP: [opcode, opval, opval]
2705       if (Record.size() < 3)
2706         return error("Invalid record");
2707       int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
2708       if (Opc < 0) {
2709         V = UndefValue::get(CurTy);  // Unknown binop.
2710       } else {
2711         Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2712         Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
2713         unsigned Flags = 0;
2714         if (Record.size() >= 4) {
2715           if (Opc == Instruction::Add ||
2716               Opc == Instruction::Sub ||
2717               Opc == Instruction::Mul ||
2718               Opc == Instruction::Shl) {
2719             if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2720               Flags |= OverflowingBinaryOperator::NoSignedWrap;
2721             if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2722               Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2723           } else if (Opc == Instruction::SDiv ||
2724                      Opc == Instruction::UDiv ||
2725                      Opc == Instruction::LShr ||
2726                      Opc == Instruction::AShr) {
2727             if (Record[3] & (1 << bitc::PEO_EXACT))
2728               Flags |= SDivOperator::IsExact;
2729           }
2730         }
2731         V = ConstantExpr::get(Opc, LHS, RHS, Flags);
2732       }
2733       break;
2734     }
2735     case bitc::CST_CODE_CE_CAST: {  // CE_CAST: [opcode, opty, opval]
2736       if (Record.size() < 3)
2737         return error("Invalid record");
2738       int Opc = getDecodedCastOpcode(Record[0]);
2739       if (Opc < 0) {
2740         V = UndefValue::get(CurTy);  // Unknown cast.
2741       } else {
2742         Type *OpTy = getTypeByID(Record[1]);
2743         if (!OpTy)
2744           return error("Invalid record");
2745         Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
2746         V = UpgradeBitCastExpr(Opc, Op, CurTy);
2747         if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
2748       }
2749       break;
2750     }
2751     case bitc::CST_CODE_CE_INBOUNDS_GEP:
2752     case bitc::CST_CODE_CE_GEP: {  // CE_GEP:        [n x operands]
2753       unsigned OpNum = 0;
2754       Type *PointeeType = nullptr;
2755       if (Record.size() % 2)
2756         PointeeType = getTypeByID(Record[OpNum++]);
2757       SmallVector<Constant*, 16> Elts;
2758       while (OpNum != Record.size()) {
2759         Type *ElTy = getTypeByID(Record[OpNum++]);
2760         if (!ElTy)
2761           return error("Invalid record");
2762         Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
2763       }
2764
2765       if (PointeeType &&
2766           PointeeType !=
2767               cast<SequentialType>(Elts[0]->getType()->getScalarType())
2768                   ->getElementType())
2769         return error("Explicit gep operator type does not match pointee type "
2770                      "of pointer operand");
2771
2772       ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2773       V = ConstantExpr::getGetElementPtr(PointeeType, Elts[0], Indices,
2774                                          BitCode ==
2775                                              bitc::CST_CODE_CE_INBOUNDS_GEP);
2776       break;
2777     }
2778     case bitc::CST_CODE_CE_SELECT: {  // CE_SELECT: [opval#, opval#, opval#]
2779       if (Record.size() < 3)
2780         return error("Invalid record");
2781
2782       Type *SelectorTy = Type::getInt1Ty(Context);
2783
2784       // The selector might be an i1 or an <n x i1>
2785       // Get the type from the ValueList before getting a forward ref.
2786       if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
2787         if (Value *V = ValueList[Record[0]])
2788           if (SelectorTy != V->getType())
2789             SelectorTy = VectorType::get(SelectorTy, VTy->getNumElements());
2790
2791       V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2792                                                               SelectorTy),
2793                                   ValueList.getConstantFwdRef(Record[1],CurTy),
2794                                   ValueList.getConstantFwdRef(Record[2],CurTy));
2795       break;
2796     }
2797     case bitc::CST_CODE_CE_EXTRACTELT
2798         : { // CE_EXTRACTELT: [opty, opval, opty, opval]
2799       if (Record.size() < 3)
2800         return error("Invalid record");
2801       VectorType *OpTy =
2802         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2803       if (!OpTy)
2804         return error("Invalid record");
2805       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2806       Constant *Op1 = nullptr;
2807       if (Record.size() == 4) {
2808         Type *IdxTy = getTypeByID(Record[2]);
2809         if (!IdxTy)
2810           return error("Invalid record");
2811         Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2812       } else // TODO: Remove with llvm 4.0
2813         Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2814       if (!Op1)
2815         return error("Invalid record");
2816       V = ConstantExpr::getExtractElement(Op0, Op1);
2817       break;
2818     }
2819     case bitc::CST_CODE_CE_INSERTELT
2820         : { // CE_INSERTELT: [opval, opval, opty, opval]
2821       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2822       if (Record.size() < 3 || !OpTy)
2823         return error("Invalid record");
2824       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2825       Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2826                                                   OpTy->getElementType());
2827       Constant *Op2 = nullptr;
2828       if (Record.size() == 4) {
2829         Type *IdxTy = getTypeByID(Record[2]);
2830         if (!IdxTy)
2831           return error("Invalid record");
2832         Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2833       } else // TODO: Remove with llvm 4.0
2834         Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2835       if (!Op2)
2836         return error("Invalid record");
2837       V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
2838       break;
2839     }
2840     case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
2841       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2842       if (Record.size() < 3 || !OpTy)
2843         return error("Invalid record");
2844       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2845       Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
2846       Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2847                                                  OpTy->getNumElements());
2848       Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
2849       V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2850       break;
2851     }
2852     case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
2853       VectorType *RTy = dyn_cast<VectorType>(CurTy);
2854       VectorType *OpTy =
2855         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2856       if (Record.size() < 4 || !RTy || !OpTy)
2857         return error("Invalid record");
2858       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2859       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2860       Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
2861                                                  RTy->getNumElements());
2862       Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
2863       V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
2864       break;
2865     }
2866     case bitc::CST_CODE_CE_CMP: {     // CE_CMP: [opty, opval, opval, pred]
2867       if (Record.size() < 4)
2868         return error("Invalid record");
2869       Type *OpTy = getTypeByID(Record[0]);
2870       if (!OpTy)
2871         return error("Invalid record");
2872       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2873       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2874
2875       if (OpTy->isFPOrFPVectorTy())
2876         V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
2877       else
2878         V = ConstantExpr::getICmp(Record[3], Op0, Op1);
2879       break;
2880     }
2881     // This maintains backward compatibility, pre-asm dialect keywords.
2882     // FIXME: Remove with the 4.0 release.
2883     case bitc::CST_CODE_INLINEASM_OLD: {
2884       if (Record.size() < 2)
2885         return error("Invalid record");
2886       std::string AsmStr, ConstrStr;
2887       bool HasSideEffects = Record[0] & 1;
2888       bool IsAlignStack = Record[0] >> 1;
2889       unsigned AsmStrSize = Record[1];
2890       if (2+AsmStrSize >= Record.size())
2891         return error("Invalid record");
2892       unsigned ConstStrSize = Record[2+AsmStrSize];
2893       if (3+AsmStrSize+ConstStrSize > Record.size())
2894         return error("Invalid record");
2895
2896       for (unsigned i = 0; i != AsmStrSize; ++i)
2897         AsmStr += (char)Record[2+i];
2898       for (unsigned i = 0; i != ConstStrSize; ++i)
2899         ConstrStr += (char)Record[3+AsmStrSize+i];
2900       PointerType *PTy = cast<PointerType>(CurTy);
2901       V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2902                          AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
2903       break;
2904     }
2905     // This version adds support for the asm dialect keywords (e.g.,
2906     // inteldialect).
2907     case bitc::CST_CODE_INLINEASM: {
2908       if (Record.size() < 2)
2909         return error("Invalid record");
2910       std::string AsmStr, ConstrStr;
2911       bool HasSideEffects = Record[0] & 1;
2912       bool IsAlignStack = (Record[0] >> 1) & 1;
2913       unsigned AsmDialect = Record[0] >> 2;
2914       unsigned AsmStrSize = Record[1];
2915       if (2+AsmStrSize >= Record.size())
2916         return error("Invalid record");
2917       unsigned ConstStrSize = Record[2+AsmStrSize];
2918       if (3+AsmStrSize+ConstStrSize > Record.size())
2919         return error("Invalid record");
2920
2921       for (unsigned i = 0; i != AsmStrSize; ++i)
2922         AsmStr += (char)Record[2+i];
2923       for (unsigned i = 0; i != ConstStrSize; ++i)
2924         ConstrStr += (char)Record[3+AsmStrSize+i];
2925       PointerType *PTy = cast<PointerType>(CurTy);
2926       V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2927                          AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
2928                          InlineAsm::AsmDialect(AsmDialect));
2929       break;
2930     }
2931     case bitc::CST_CODE_BLOCKADDRESS:{
2932       if (Record.size() < 3)
2933         return error("Invalid record");
2934       Type *FnTy = getTypeByID(Record[0]);
2935       if (!FnTy)
2936         return error("Invalid record");
2937       Function *Fn =
2938         dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
2939       if (!Fn)
2940         return error("Invalid record");
2941
2942       // If the function is already parsed we can insert the block address right
2943       // away.
2944       BasicBlock *BB;
2945       unsigned BBID = Record[2];
2946       if (!BBID)
2947         // Invalid reference to entry block.
2948         return error("Invalid ID");
2949       if (!Fn->empty()) {
2950         Function::iterator BBI = Fn->begin(), BBE = Fn->end();
2951         for (size_t I = 0, E = BBID; I != E; ++I) {
2952           if (BBI == BBE)
2953             return error("Invalid ID");
2954           ++BBI;
2955         }
2956         BB = &*BBI;
2957       } else {
2958         // Otherwise insert a placeholder and remember it so it can be inserted
2959         // when the function is parsed.
2960         auto &FwdBBs = BasicBlockFwdRefs[Fn];
2961         if (FwdBBs.empty())
2962           BasicBlockFwdRefQueue.push_back(Fn);
2963         if (FwdBBs.size() < BBID + 1)
2964           FwdBBs.resize(BBID + 1);
2965         if (!FwdBBs[BBID])
2966           FwdBBs[BBID] = BasicBlock::Create(Context);
2967         BB = FwdBBs[BBID];
2968       }
2969       V = BlockAddress::get(Fn, BB);
2970       break;
2971     }
2972     }
2973
2974     ValueList.assignValue(V, NextCstNo);
2975     ++NextCstNo;
2976   }
2977 }
2978
2979 std::error_code BitcodeReader::parseUseLists() {
2980   if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
2981     return error("Invalid record");
2982
2983   // Read all the records.
2984   SmallVector<uint64_t, 64> Record;
2985   while (1) {
2986     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2987
2988     switch (Entry.Kind) {
2989     case BitstreamEntry::SubBlock: // Handled for us already.
2990     case BitstreamEntry::Error:
2991       return error("Malformed block");
2992     case BitstreamEntry::EndBlock:
2993       return std::error_code();
2994     case BitstreamEntry::Record:
2995       // The interesting case.
2996       break;
2997     }
2998
2999     // Read a use list record.
3000     Record.clear();
3001     bool IsBB = false;
3002     switch (Stream.readRecord(Entry.ID, Record)) {
3003     default:  // Default behavior: unknown type.
3004       break;
3005     case bitc::USELIST_CODE_BB:
3006       IsBB = true;
3007       // fallthrough
3008     case bitc::USELIST_CODE_DEFAULT: {
3009       unsigned RecordLength = Record.size();
3010       if (RecordLength < 3)
3011         // Records should have at least an ID and two indexes.
3012         return error("Invalid record");
3013       unsigned ID = Record.back();
3014       Record.pop_back();
3015
3016       Value *V;
3017       if (IsBB) {
3018         assert(ID < FunctionBBs.size() && "Basic block not found");
3019         V = FunctionBBs[ID];
3020       } else
3021         V = ValueList[ID];
3022       unsigned NumUses = 0;
3023       SmallDenseMap<const Use *, unsigned, 16> Order;
3024       for (const Use &U : V->materialized_uses()) {
3025         if (++NumUses > Record.size())
3026           break;
3027         Order[&U] = Record[NumUses - 1];
3028       }
3029       if (Order.size() != Record.size() || NumUses > Record.size())
3030         // Mismatches can happen if the functions are being materialized lazily
3031         // (out-of-order), or a value has been upgraded.
3032         break;
3033
3034       V->sortUseList([&](const Use &L, const Use &R) {
3035         return Order.lookup(&L) < Order.lookup(&R);
3036       });
3037       break;
3038     }
3039     }
3040   }
3041 }
3042
3043 /// When we see the block for metadata, remember where it is and then skip it.
3044 /// This lets us lazily deserialize the metadata.
3045 std::error_code BitcodeReader::rememberAndSkipMetadata() {
3046   // Save the current stream state.
3047   uint64_t CurBit = Stream.GetCurrentBitNo();
3048   DeferredMetadataInfo.push_back(CurBit);
3049
3050   // Skip over the block for now.
3051   if (Stream.SkipBlock())
3052     return error("Invalid record");
3053   return std::error_code();
3054 }
3055
3056 std::error_code BitcodeReader::materializeMetadata() {
3057   for (uint64_t BitPos : DeferredMetadataInfo) {
3058     // Move the bit stream to the saved position.
3059     Stream.JumpToBit(BitPos);
3060     if (std::error_code EC = parseMetadata(true))
3061       return EC;
3062   }
3063   DeferredMetadataInfo.clear();
3064   return std::error_code();
3065 }
3066
3067 void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
3068
3069 void BitcodeReader::saveMetadataList(
3070     DenseMap<const Metadata *, unsigned> &MetadataToIDs, bool OnlyTempMD) {
3071   for (unsigned ID = 0; ID < MetadataList.size(); ++ID) {
3072     Metadata *MD = MetadataList[ID];
3073     auto *N = dyn_cast_or_null<MDNode>(MD);
3074     // Save all values if !OnlyTempMD, otherwise just the temporary metadata.
3075     if (!OnlyTempMD || (N && N->isTemporary())) {
3076       // Will call this after materializing each function, in order to
3077       // handle remapping of the function's instructions/metadata.
3078       // See if we already have an entry in that case.
3079       if (OnlyTempMD && MetadataToIDs.count(MD)) {
3080         assert(MetadataToIDs[MD] == ID && "Inconsistent metadata value id");
3081         continue;
3082       }
3083       MetadataToIDs[MD] = ID;
3084     }
3085   }
3086 }
3087
3088 /// When we see the block for a function body, remember where it is and then
3089 /// skip it.  This lets us lazily deserialize the functions.
3090 std::error_code BitcodeReader::rememberAndSkipFunctionBody() {
3091   // Get the function we are talking about.
3092   if (FunctionsWithBodies.empty())
3093     return error("Insufficient function protos");
3094
3095   Function *Fn = FunctionsWithBodies.back();
3096   FunctionsWithBodies.pop_back();
3097
3098   // Save the current stream state.
3099   uint64_t CurBit = Stream.GetCurrentBitNo();
3100   assert(
3101       (DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&
3102       "Mismatch between VST and scanned function offsets");
3103   DeferredFunctionInfo[Fn] = CurBit;
3104
3105   // Skip over the function block for now.
3106   if (Stream.SkipBlock())
3107     return error("Invalid record");
3108   return std::error_code();
3109 }
3110
3111 std::error_code BitcodeReader::globalCleanup() {
3112   // Patch the initializers for globals and aliases up.
3113   resolveGlobalAndAliasInits();
3114   if (!GlobalInits.empty() || !AliasInits.empty())
3115     return error("Malformed global initializer set");
3116
3117   // Look for intrinsic functions which need to be upgraded at some point
3118   for (Function &F : *TheModule) {
3119     Function *NewFn;
3120     if (UpgradeIntrinsicFunction(&F, NewFn))
3121       UpgradedIntrinsics[&F] = NewFn;
3122   }
3123
3124   // Look for global variables which need to be renamed.
3125   for (GlobalVariable &GV : TheModule->globals())
3126     UpgradeGlobalVariable(&GV);
3127
3128   // Force deallocation of memory for these vectors to favor the client that
3129   // want lazy deserialization.
3130   std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
3131   std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
3132   return std::error_code();
3133 }
3134
3135 /// Support for lazy parsing of function bodies. This is required if we
3136 /// either have an old bitcode file without a VST forward declaration record,
3137 /// or if we have an anonymous function being materialized, since anonymous
3138 /// functions do not have a name and are therefore not in the VST.
3139 std::error_code BitcodeReader::rememberAndSkipFunctionBodies() {
3140   Stream.JumpToBit(NextUnreadBit);
3141
3142   if (Stream.AtEndOfStream())
3143     return error("Could not find function in stream");
3144
3145   if (!SeenFirstFunctionBody)
3146     return error("Trying to materialize functions before seeing function blocks");
3147
3148   // An old bitcode file with the symbol table at the end would have
3149   // finished the parse greedily.
3150   assert(SeenValueSymbolTable);
3151
3152   SmallVector<uint64_t, 64> Record;
3153
3154   while (1) {
3155     BitstreamEntry Entry = Stream.advance();
3156     switch (Entry.Kind) {
3157     default:
3158       return error("Expect SubBlock");
3159     case BitstreamEntry::SubBlock:
3160       switch (Entry.ID) {
3161       default:
3162         return error("Expect function block");
3163       case bitc::FUNCTION_BLOCK_ID:
3164         if (std::error_code EC = rememberAndSkipFunctionBody())
3165           return EC;
3166         NextUnreadBit = Stream.GetCurrentBitNo();
3167         return std::error_code();
3168       }
3169     }
3170   }
3171 }
3172
3173 std::error_code BitcodeReader::parseBitcodeVersion() {
3174   if (Stream.EnterSubBlock(bitc::IDENTIFICATION_BLOCK_ID))
3175     return error("Invalid record");
3176
3177   // Read all the records.
3178   SmallVector<uint64_t, 64> Record;
3179   while (1) {
3180     BitstreamEntry Entry = Stream.advance();
3181
3182     switch (Entry.Kind) {
3183     default:
3184     case BitstreamEntry::Error:
3185       return error("Malformed block");
3186     case BitstreamEntry::EndBlock:
3187       return std::error_code();
3188     case BitstreamEntry::Record:
3189       // The interesting case.
3190       break;
3191     }
3192
3193     // Read a record.
3194     Record.clear();
3195     unsigned BitCode = Stream.readRecord(Entry.ID, Record);
3196     switch (BitCode) {
3197     default: // Default behavior: reject
3198       return error("Invalid value");
3199     case bitc::IDENTIFICATION_CODE_STRING: { // IDENTIFICATION:      [strchr x
3200                                              // N]
3201       convertToString(Record, 0, ProducerIdentification);
3202       break;
3203     }
3204     case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH:      [epoch#]
3205       unsigned epoch = (unsigned)Record[0];
3206       if (epoch != bitc::BITCODE_CURRENT_EPOCH) {
3207         return error(
3208           Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +
3209           "' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");
3210       }
3211     }
3212     }
3213   }
3214 }
3215
3216 std::error_code BitcodeReader::parseModule(uint64_t ResumeBit,
3217                                            bool ShouldLazyLoadMetadata) {
3218   if (ResumeBit)
3219     Stream.JumpToBit(ResumeBit);
3220   else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3221     return error("Invalid record");
3222
3223   SmallVector<uint64_t, 64> Record;
3224   std::vector<std::string> SectionTable;
3225   std::vector<std::string> GCTable;
3226
3227   // Read all the records for this module.
3228   while (1) {
3229     BitstreamEntry Entry = Stream.advance();
3230
3231     switch (Entry.Kind) {
3232     case BitstreamEntry::Error:
3233       return error("Malformed block");
3234     case BitstreamEntry::EndBlock:
3235       return globalCleanup();
3236
3237     case BitstreamEntry::SubBlock:
3238       switch (Entry.ID) {
3239       default:  // Skip unknown content.
3240         if (Stream.SkipBlock())
3241           return error("Invalid record");
3242         break;
3243       case bitc::BLOCKINFO_BLOCK_ID:
3244         if (Stream.ReadBlockInfoBlock())
3245           return error("Malformed block");
3246         break;
3247       case bitc::PARAMATTR_BLOCK_ID:
3248         if (std::error_code EC = parseAttributeBlock())
3249           return EC;
3250         break;
3251       case bitc::PARAMATTR_GROUP_BLOCK_ID:
3252         if (std::error_code EC = parseAttributeGroupBlock())
3253           return EC;
3254         break;
3255       case bitc::TYPE_BLOCK_ID_NEW:
3256         if (std::error_code EC = parseTypeTable())
3257           return EC;
3258         break;
3259       case bitc::VALUE_SYMTAB_BLOCK_ID:
3260         if (!SeenValueSymbolTable) {
3261           // Either this is an old form VST without function index and an
3262           // associated VST forward declaration record (which would have caused
3263           // the VST to be jumped to and parsed before it was encountered
3264           // normally in the stream), or there were no function blocks to
3265           // trigger an earlier parsing of the VST.
3266           assert(VSTOffset == 0 || FunctionsWithBodies.empty());
3267           if (std::error_code EC = parseValueSymbolTable())
3268             return EC;
3269           SeenValueSymbolTable = true;
3270         } else {
3271           // We must have had a VST forward declaration record, which caused
3272           // the parser to jump to and parse the VST earlier.
3273           assert(VSTOffset > 0);
3274           if (Stream.SkipBlock())
3275             return error("Invalid record");
3276         }
3277         break;
3278       case bitc::CONSTANTS_BLOCK_ID:
3279         if (std::error_code EC = parseConstants())
3280           return EC;
3281         if (std::error_code EC = resolveGlobalAndAliasInits())
3282           return EC;
3283         break;
3284       case bitc::METADATA_BLOCK_ID:
3285         if (ShouldLazyLoadMetadata && !IsMetadataMaterialized) {
3286           if (std::error_code EC = rememberAndSkipMetadata())
3287             return EC;
3288           break;
3289         }
3290         assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
3291         if (std::error_code EC = parseMetadata(true))
3292           return EC;
3293         break;
3294       case bitc::METADATA_KIND_BLOCK_ID:
3295         if (std::error_code EC = parseMetadataKinds())
3296           return EC;
3297         break;
3298       case bitc::FUNCTION_BLOCK_ID:
3299         // If this is the first function body we've seen, reverse the
3300         // FunctionsWithBodies list.
3301         if (!SeenFirstFunctionBody) {
3302           std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
3303           if (std::error_code EC = globalCleanup())
3304             return EC;
3305           SeenFirstFunctionBody = true;
3306         }
3307
3308         if (VSTOffset > 0) {
3309           // If we have a VST forward declaration record, make sure we
3310           // parse the VST now if we haven't already. It is needed to
3311           // set up the DeferredFunctionInfo vector for lazy reading.
3312           if (!SeenValueSymbolTable) {
3313             if (std::error_code EC =
3314                     BitcodeReader::parseValueSymbolTable(VSTOffset))
3315               return EC;
3316             SeenValueSymbolTable = true;
3317             // Fall through so that we record the NextUnreadBit below.
3318             // This is necessary in case we have an anonymous function that
3319             // is later materialized. Since it will not have a VST entry we
3320             // need to fall back to the lazy parse to find its offset.
3321           } else {
3322             // If we have a VST forward declaration record, but have already
3323             // parsed the VST (just above, when the first function body was
3324             // encountered here), then we are resuming the parse after
3325             // materializing functions. The ResumeBit points to the
3326             // start of the last function block recorded in the
3327             // DeferredFunctionInfo map. Skip it.
3328             if (Stream.SkipBlock())
3329               return error("Invalid record");
3330             continue;
3331           }
3332         }
3333
3334         // Support older bitcode files that did not have the function
3335         // index in the VST, nor a VST forward declaration record, as
3336         // well as anonymous functions that do not have VST entries.
3337         // Build the DeferredFunctionInfo vector on the fly.
3338         if (std::error_code EC = rememberAndSkipFunctionBody())
3339           return EC;
3340
3341         // Suspend parsing when we reach the function bodies. Subsequent
3342         // materialization calls will resume it when necessary. If the bitcode
3343         // file is old, the symbol table will be at the end instead and will not
3344         // have been seen yet. In this case, just finish the parse now.
3345         if (SeenValueSymbolTable) {
3346           NextUnreadBit = Stream.GetCurrentBitNo();
3347           return std::error_code();
3348         }
3349         break;
3350       case bitc::USELIST_BLOCK_ID:
3351         if (std::error_code EC = parseUseLists())
3352           return EC;
3353         break;
3354       case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
3355         if (std::error_code EC = parseOperandBundleTags())
3356           return EC;
3357         break;
3358       }
3359       continue;
3360
3361     case BitstreamEntry::Record:
3362       // The interesting case.
3363       break;
3364     }
3365
3366
3367     // Read a record.
3368     auto BitCode = Stream.readRecord(Entry.ID, Record);
3369     switch (BitCode) {
3370     default: break;  // Default behavior, ignore unknown content.
3371     case bitc::MODULE_CODE_VERSION: {  // VERSION: [version#]
3372       if (Record.size() < 1)
3373         return error("Invalid record");
3374       // Only version #0 and #1 are supported so far.
3375       unsigned module_version = Record[0];
3376       switch (module_version) {
3377         default:
3378           return error("Invalid value");
3379         case 0:
3380           UseRelativeIDs = false;
3381           break;
3382         case 1:
3383           UseRelativeIDs = true;
3384           break;
3385       }
3386       break;
3387     }
3388     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
3389       std::string S;
3390       if (convertToString(Record, 0, S))
3391         return error("Invalid record");
3392       TheModule->setTargetTriple(S);
3393       break;
3394     }
3395     case bitc::MODULE_CODE_DATALAYOUT: {  // DATALAYOUT: [strchr x N]
3396       std::string S;
3397       if (convertToString(Record, 0, S))
3398         return error("Invalid record");
3399       TheModule->setDataLayout(S);
3400       break;
3401     }
3402     case bitc::MODULE_CODE_ASM: {  // ASM: [strchr x N]
3403       std::string S;
3404       if (convertToString(Record, 0, S))
3405         return error("Invalid record");
3406       TheModule->setModuleInlineAsm(S);
3407       break;
3408     }
3409     case bitc::MODULE_CODE_DEPLIB: {  // DEPLIB: [strchr x N]
3410       // FIXME: Remove in 4.0.
3411       std::string S;
3412       if (convertToString(Record, 0, S))
3413         return error("Invalid record");
3414       // Ignore value.
3415       break;
3416     }
3417     case bitc::MODULE_CODE_SECTIONNAME: {  // SECTIONNAME: [strchr x N]
3418       std::string S;
3419       if (convertToString(Record, 0, S))
3420         return error("Invalid record");
3421       SectionTable.push_back(S);
3422       break;
3423     }
3424     case bitc::MODULE_CODE_GCNAME: {  // SECTIONNAME: [strchr x N]
3425       std::string S;
3426       if (convertToString(Record, 0, S))
3427         return error("Invalid record");
3428       GCTable.push_back(S);
3429       break;
3430     }
3431     case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
3432 &n