1*0b57cec5SDimitry Andric //===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric 
9*0b57cec5SDimitry Andric #include "llvm/Bitcode/BitcodeReader.h"
10*0b57cec5SDimitry Andric #include "MetadataLoader.h"
11*0b57cec5SDimitry Andric #include "ValueList.h"
12*0b57cec5SDimitry Andric #include "llvm/ADT/APFloat.h"
13*0b57cec5SDimitry Andric #include "llvm/ADT/APInt.h"
14*0b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h"
15*0b57cec5SDimitry Andric #include "llvm/ADT/DenseMap.h"
16*0b57cec5SDimitry Andric #include "llvm/ADT/Optional.h"
17*0b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h"
18*0b57cec5SDimitry Andric #include "llvm/ADT/SmallString.h"
19*0b57cec5SDimitry Andric #include "llvm/ADT/SmallVector.h"
20*0b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
21*0b57cec5SDimitry Andric #include "llvm/ADT/Triple.h"
22*0b57cec5SDimitry Andric #include "llvm/ADT/Twine.h"
23*0b57cec5SDimitry Andric #include "llvm/Bitstream/BitstreamReader.h"
24*0b57cec5SDimitry Andric #include "llvm/Bitcode/LLVMBitCodes.h"
25*0b57cec5SDimitry Andric #include "llvm/Config/llvm-config.h"
26*0b57cec5SDimitry Andric #include "llvm/IR/Argument.h"
27*0b57cec5SDimitry Andric #include "llvm/IR/Attributes.h"
28*0b57cec5SDimitry Andric #include "llvm/IR/AutoUpgrade.h"
29*0b57cec5SDimitry Andric #include "llvm/IR/BasicBlock.h"
30*0b57cec5SDimitry Andric #include "llvm/IR/CallingConv.h"
31*0b57cec5SDimitry Andric #include "llvm/IR/Comdat.h"
32*0b57cec5SDimitry Andric #include "llvm/IR/Constant.h"
33*0b57cec5SDimitry Andric #include "llvm/IR/Constants.h"
34*0b57cec5SDimitry Andric #include "llvm/IR/DataLayout.h"
35*0b57cec5SDimitry Andric #include "llvm/IR/DebugInfo.h"
36*0b57cec5SDimitry Andric #include "llvm/IR/DebugInfoMetadata.h"
37*0b57cec5SDimitry Andric #include "llvm/IR/DebugLoc.h"
38*0b57cec5SDimitry Andric #include "llvm/IR/DerivedTypes.h"
39*0b57cec5SDimitry Andric #include "llvm/IR/Function.h"
40*0b57cec5SDimitry Andric #include "llvm/IR/GVMaterializer.h"
41*0b57cec5SDimitry Andric #include "llvm/IR/GlobalAlias.h"
42*0b57cec5SDimitry Andric #include "llvm/IR/GlobalIFunc.h"
43*0b57cec5SDimitry Andric #include "llvm/IR/GlobalIndirectSymbol.h"
44*0b57cec5SDimitry Andric #include "llvm/IR/GlobalObject.h"
45*0b57cec5SDimitry Andric #include "llvm/IR/GlobalValue.h"
46*0b57cec5SDimitry Andric #include "llvm/IR/GlobalVariable.h"
47*0b57cec5SDimitry Andric #include "llvm/IR/InlineAsm.h"
48*0b57cec5SDimitry Andric #include "llvm/IR/InstIterator.h"
49*0b57cec5SDimitry Andric #include "llvm/IR/InstrTypes.h"
50*0b57cec5SDimitry Andric #include "llvm/IR/Instruction.h"
51*0b57cec5SDimitry Andric #include "llvm/IR/Instructions.h"
52*0b57cec5SDimitry Andric #include "llvm/IR/Intrinsics.h"
53*0b57cec5SDimitry Andric #include "llvm/IR/LLVMContext.h"
54*0b57cec5SDimitry Andric #include "llvm/IR/Metadata.h"
55*0b57cec5SDimitry Andric #include "llvm/IR/Module.h"
56*0b57cec5SDimitry Andric #include "llvm/IR/ModuleSummaryIndex.h"
57*0b57cec5SDimitry Andric #include "llvm/IR/Operator.h"
58*0b57cec5SDimitry Andric #include "llvm/IR/Type.h"
59*0b57cec5SDimitry Andric #include "llvm/IR/Value.h"
60*0b57cec5SDimitry Andric #include "llvm/IR/Verifier.h"
61*0b57cec5SDimitry Andric #include "llvm/Support/AtomicOrdering.h"
62*0b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
63*0b57cec5SDimitry Andric #include "llvm/Support/CommandLine.h"
64*0b57cec5SDimitry Andric #include "llvm/Support/Compiler.h"
65*0b57cec5SDimitry Andric #include "llvm/Support/Debug.h"
66*0b57cec5SDimitry Andric #include "llvm/Support/Error.h"
67*0b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h"
68*0b57cec5SDimitry Andric #include "llvm/Support/ErrorOr.h"
69*0b57cec5SDimitry Andric #include "llvm/Support/ManagedStatic.h"
70*0b57cec5SDimitry Andric #include "llvm/Support/MathExtras.h"
71*0b57cec5SDimitry Andric #include "llvm/Support/MemoryBuffer.h"
72*0b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h"
73*0b57cec5SDimitry Andric #include <algorithm>
74*0b57cec5SDimitry Andric #include <cassert>
75*0b57cec5SDimitry Andric #include <cstddef>
76*0b57cec5SDimitry Andric #include <cstdint>
77*0b57cec5SDimitry Andric #include <deque>
78*0b57cec5SDimitry Andric #include <map>
79*0b57cec5SDimitry Andric #include <memory>
80*0b57cec5SDimitry Andric #include <set>
81*0b57cec5SDimitry Andric #include <string>
82*0b57cec5SDimitry Andric #include <system_error>
83*0b57cec5SDimitry Andric #include <tuple>
84*0b57cec5SDimitry Andric #include <utility>
85*0b57cec5SDimitry Andric #include <vector>
86*0b57cec5SDimitry Andric 
87*0b57cec5SDimitry Andric using namespace llvm;
88*0b57cec5SDimitry Andric 
89*0b57cec5SDimitry Andric static cl::opt<bool> PrintSummaryGUIDs(
90*0b57cec5SDimitry Andric     "print-summary-global-ids", cl::init(false), cl::Hidden,
91*0b57cec5SDimitry Andric     cl::desc(
92*0b57cec5SDimitry Andric         "Print the global id for each value when reading the module summary"));
93*0b57cec5SDimitry Andric 
94*0b57cec5SDimitry Andric namespace {
95*0b57cec5SDimitry Andric 
96*0b57cec5SDimitry Andric enum {
97*0b57cec5SDimitry Andric   SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
98*0b57cec5SDimitry Andric };
99*0b57cec5SDimitry Andric 
100*0b57cec5SDimitry Andric } // end anonymous namespace
101*0b57cec5SDimitry Andric 
102*0b57cec5SDimitry Andric static Error error(const Twine &Message) {
103*0b57cec5SDimitry Andric   return make_error<StringError>(
104*0b57cec5SDimitry Andric       Message, make_error_code(BitcodeError::CorruptedBitcode));
105*0b57cec5SDimitry Andric }
106*0b57cec5SDimitry Andric 
107*0b57cec5SDimitry Andric static Error hasInvalidBitcodeHeader(BitstreamCursor &Stream) {
108*0b57cec5SDimitry Andric   if (!Stream.canSkipToPos(4))
109*0b57cec5SDimitry Andric     return createStringError(std::errc::illegal_byte_sequence,
110*0b57cec5SDimitry Andric                              "file too small to contain bitcode header");
111*0b57cec5SDimitry Andric   for (unsigned C : {'B', 'C'})
112*0b57cec5SDimitry Andric     if (Expected<SimpleBitstreamCursor::word_t> Res = Stream.Read(8)) {
113*0b57cec5SDimitry Andric       if (Res.get() != C)
114*0b57cec5SDimitry Andric         return createStringError(std::errc::illegal_byte_sequence,
115*0b57cec5SDimitry Andric                                  "file doesn't start with bitcode header");
116*0b57cec5SDimitry Andric     } else
117*0b57cec5SDimitry Andric       return Res.takeError();
118*0b57cec5SDimitry Andric   for (unsigned C : {0x0, 0xC, 0xE, 0xD})
119*0b57cec5SDimitry Andric     if (Expected<SimpleBitstreamCursor::word_t> Res = Stream.Read(4)) {
120*0b57cec5SDimitry Andric       if (Res.get() != C)
121*0b57cec5SDimitry Andric         return createStringError(std::errc::illegal_byte_sequence,
122*0b57cec5SDimitry Andric                                  "file doesn't start with bitcode header");
123*0b57cec5SDimitry Andric     } else
124*0b57cec5SDimitry Andric       return Res.takeError();
125*0b57cec5SDimitry Andric   return Error::success();
126*0b57cec5SDimitry Andric }
127*0b57cec5SDimitry Andric 
128*0b57cec5SDimitry Andric static Expected<BitstreamCursor> initStream(MemoryBufferRef Buffer) {
129*0b57cec5SDimitry Andric   const unsigned char *BufPtr = (const unsigned char *)Buffer.getBufferStart();
130*0b57cec5SDimitry Andric   const unsigned char *BufEnd = BufPtr + Buffer.getBufferSize();
131*0b57cec5SDimitry Andric 
132*0b57cec5SDimitry Andric   if (Buffer.getBufferSize() & 3)
133*0b57cec5SDimitry Andric     return error("Invalid bitcode signature");
134*0b57cec5SDimitry Andric 
135*0b57cec5SDimitry Andric   // If we have a wrapper header, parse it and ignore the non-bc file contents.
136*0b57cec5SDimitry Andric   // The magic number is 0x0B17C0DE stored in little endian.
137*0b57cec5SDimitry Andric   if (isBitcodeWrapper(BufPtr, BufEnd))
138*0b57cec5SDimitry Andric     if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
139*0b57cec5SDimitry Andric       return error("Invalid bitcode wrapper header");
140*0b57cec5SDimitry Andric 
141*0b57cec5SDimitry Andric   BitstreamCursor Stream(ArrayRef<uint8_t>(BufPtr, BufEnd));
142*0b57cec5SDimitry Andric   if (Error Err = hasInvalidBitcodeHeader(Stream))
143*0b57cec5SDimitry Andric     return std::move(Err);
144*0b57cec5SDimitry Andric 
145*0b57cec5SDimitry Andric   return std::move(Stream);
146*0b57cec5SDimitry Andric }
147*0b57cec5SDimitry Andric 
148*0b57cec5SDimitry Andric /// Convert a string from a record into an std::string, return true on failure.
149*0b57cec5SDimitry Andric template <typename StrTy>
150*0b57cec5SDimitry Andric static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
151*0b57cec5SDimitry Andric                             StrTy &Result) {
152*0b57cec5SDimitry Andric   if (Idx > Record.size())
153*0b57cec5SDimitry Andric     return true;
154*0b57cec5SDimitry Andric 
1555ffd83dbSDimitry Andric   Result.append(Record.begin() + Idx, Record.end());
156*0b57cec5SDimitry Andric   return false;
157*0b57cec5SDimitry Andric }
158*0b57cec5SDimitry Andric 
159*0b57cec5SDimitry Andric // Strip all the TBAA attachment for the module.
160*0b57cec5SDimitry Andric static void stripTBAA(Module *M) {
161*0b57cec5SDimitry Andric   for (auto &F : *M) {
162*0b57cec5SDimitry Andric     if (F.isMaterializable())
163*0b57cec5SDimitry Andric       continue;
164*0b57cec5SDimitry Andric     for (auto &I : instructions(F))
165*0b57cec5SDimitry Andric       I.setMetadata(LLVMContext::MD_tbaa, nullptr);
166*0b57cec5SDimitry Andric   }
167*0b57cec5SDimitry Andric }
168*0b57cec5SDimitry Andric 
169*0b57cec5SDimitry Andric /// Read the "IDENTIFICATION_BLOCK_ID" block, do some basic enforcement on the
170*0b57cec5SDimitry Andric /// "epoch" encoded in the bitcode, and return the producer name if any.
171*0b57cec5SDimitry Andric static Expected<std::string> readIdentificationBlock(BitstreamCursor &Stream) {
172*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::IDENTIFICATION_BLOCK_ID))
173*0b57cec5SDimitry Andric     return std::move(Err);
174*0b57cec5SDimitry Andric 
175*0b57cec5SDimitry Andric   // Read all the records.
176*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
177*0b57cec5SDimitry Andric 
178*0b57cec5SDimitry Andric   std::string ProducerIdentification;
179*0b57cec5SDimitry Andric 
180*0b57cec5SDimitry Andric   while (true) {
181*0b57cec5SDimitry Andric     BitstreamEntry Entry;
182*0b57cec5SDimitry Andric     if (Expected<BitstreamEntry> Res = Stream.advance())
183*0b57cec5SDimitry Andric       Entry = Res.get();
184*0b57cec5SDimitry Andric     else
185*0b57cec5SDimitry Andric       return Res.takeError();
186*0b57cec5SDimitry Andric 
187*0b57cec5SDimitry Andric     switch (Entry.Kind) {
188*0b57cec5SDimitry Andric     default:
189*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
190*0b57cec5SDimitry Andric       return error("Malformed block");
191*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
192*0b57cec5SDimitry Andric       return ProducerIdentification;
193*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
194*0b57cec5SDimitry Andric       // The interesting case.
195*0b57cec5SDimitry Andric       break;
196*0b57cec5SDimitry Andric     }
197*0b57cec5SDimitry Andric 
198*0b57cec5SDimitry Andric     // Read a record.
199*0b57cec5SDimitry Andric     Record.clear();
200*0b57cec5SDimitry Andric     Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
201*0b57cec5SDimitry Andric     if (!MaybeBitCode)
202*0b57cec5SDimitry Andric       return MaybeBitCode.takeError();
203*0b57cec5SDimitry Andric     switch (MaybeBitCode.get()) {
204*0b57cec5SDimitry Andric     default: // Default behavior: reject
205*0b57cec5SDimitry Andric       return error("Invalid value");
206*0b57cec5SDimitry Andric     case bitc::IDENTIFICATION_CODE_STRING: // IDENTIFICATION: [strchr x N]
207*0b57cec5SDimitry Andric       convertToString(Record, 0, ProducerIdentification);
208*0b57cec5SDimitry Andric       break;
209*0b57cec5SDimitry Andric     case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH: [epoch#]
210*0b57cec5SDimitry Andric       unsigned epoch = (unsigned)Record[0];
211*0b57cec5SDimitry Andric       if (epoch != bitc::BITCODE_CURRENT_EPOCH) {
212*0b57cec5SDimitry Andric         return error(
213*0b57cec5SDimitry Andric           Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +
214*0b57cec5SDimitry Andric           "' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");
215*0b57cec5SDimitry Andric       }
216*0b57cec5SDimitry Andric     }
217*0b57cec5SDimitry Andric     }
218*0b57cec5SDimitry Andric   }
219*0b57cec5SDimitry Andric }
220*0b57cec5SDimitry Andric 
221*0b57cec5SDimitry Andric static Expected<std::string> readIdentificationCode(BitstreamCursor &Stream) {
222*0b57cec5SDimitry Andric   // We expect a number of well-defined blocks, though we don't necessarily
223*0b57cec5SDimitry Andric   // need to understand them all.
224*0b57cec5SDimitry Andric   while (true) {
225*0b57cec5SDimitry Andric     if (Stream.AtEndOfStream())
226*0b57cec5SDimitry Andric       return "";
227*0b57cec5SDimitry Andric 
228*0b57cec5SDimitry Andric     BitstreamEntry Entry;
229*0b57cec5SDimitry Andric     if (Expected<BitstreamEntry> Res = Stream.advance())
230*0b57cec5SDimitry Andric       Entry = std::move(Res.get());
231*0b57cec5SDimitry Andric     else
232*0b57cec5SDimitry Andric       return Res.takeError();
233*0b57cec5SDimitry Andric 
234*0b57cec5SDimitry Andric     switch (Entry.Kind) {
235*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
236*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
237*0b57cec5SDimitry Andric       return error("Malformed block");
238*0b57cec5SDimitry Andric 
239*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
240*0b57cec5SDimitry Andric       if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID)
241*0b57cec5SDimitry Andric         return readIdentificationBlock(Stream);
242*0b57cec5SDimitry Andric 
243*0b57cec5SDimitry Andric       // Ignore other sub-blocks.
244*0b57cec5SDimitry Andric       if (Error Err = Stream.SkipBlock())
245*0b57cec5SDimitry Andric         return std::move(Err);
246*0b57cec5SDimitry Andric       continue;
247*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
248*0b57cec5SDimitry Andric       if (Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID))
249*0b57cec5SDimitry Andric         continue;
250*0b57cec5SDimitry Andric       else
251*0b57cec5SDimitry Andric         return Skipped.takeError();
252*0b57cec5SDimitry Andric     }
253*0b57cec5SDimitry Andric   }
254*0b57cec5SDimitry Andric }
255*0b57cec5SDimitry Andric 
256*0b57cec5SDimitry Andric static Expected<bool> hasObjCCategoryInModule(BitstreamCursor &Stream) {
257*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
258*0b57cec5SDimitry Andric     return std::move(Err);
259*0b57cec5SDimitry Andric 
260*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
261*0b57cec5SDimitry Andric   // Read all the records for this module.
262*0b57cec5SDimitry Andric 
263*0b57cec5SDimitry Andric   while (true) {
264*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
265*0b57cec5SDimitry Andric     if (!MaybeEntry)
266*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
267*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
268*0b57cec5SDimitry Andric 
269*0b57cec5SDimitry Andric     switch (Entry.Kind) {
270*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
271*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
272*0b57cec5SDimitry Andric       return error("Malformed block");
273*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
274*0b57cec5SDimitry Andric       return false;
275*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
276*0b57cec5SDimitry Andric       // The interesting case.
277*0b57cec5SDimitry Andric       break;
278*0b57cec5SDimitry Andric     }
279*0b57cec5SDimitry Andric 
280*0b57cec5SDimitry Andric     // Read a record.
281*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
282*0b57cec5SDimitry Andric     if (!MaybeRecord)
283*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
284*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
285*0b57cec5SDimitry Andric     default:
286*0b57cec5SDimitry Andric       break; // Default behavior, ignore unknown content.
287*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
288*0b57cec5SDimitry Andric       std::string S;
289*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
290*0b57cec5SDimitry Andric         return error("Invalid record");
291*0b57cec5SDimitry Andric       // Check for the i386 and other (x86_64, ARM) conventions
292*0b57cec5SDimitry Andric       if (S.find("__DATA,__objc_catlist") != std::string::npos ||
293*0b57cec5SDimitry Andric           S.find("__OBJC,__category") != std::string::npos)
294*0b57cec5SDimitry Andric         return true;
295*0b57cec5SDimitry Andric       break;
296*0b57cec5SDimitry Andric     }
297*0b57cec5SDimitry Andric     }
298*0b57cec5SDimitry Andric     Record.clear();
299*0b57cec5SDimitry Andric   }
300*0b57cec5SDimitry Andric   llvm_unreachable("Exit infinite loop");
301*0b57cec5SDimitry Andric }
302*0b57cec5SDimitry Andric 
303*0b57cec5SDimitry Andric static Expected<bool> hasObjCCategory(BitstreamCursor &Stream) {
304*0b57cec5SDimitry Andric   // We expect a number of well-defined blocks, though we don't necessarily
305*0b57cec5SDimitry Andric   // need to understand them all.
306*0b57cec5SDimitry Andric   while (true) {
307*0b57cec5SDimitry Andric     BitstreamEntry Entry;
308*0b57cec5SDimitry Andric     if (Expected<BitstreamEntry> Res = Stream.advance())
309*0b57cec5SDimitry Andric       Entry = std::move(Res.get());
310*0b57cec5SDimitry Andric     else
311*0b57cec5SDimitry Andric       return Res.takeError();
312*0b57cec5SDimitry Andric 
313*0b57cec5SDimitry Andric     switch (Entry.Kind) {
314*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
315*0b57cec5SDimitry Andric       return error("Malformed block");
316*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
317*0b57cec5SDimitry Andric       return false;
318*0b57cec5SDimitry Andric 
319*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
320*0b57cec5SDimitry Andric       if (Entry.ID == bitc::MODULE_BLOCK_ID)
321*0b57cec5SDimitry Andric         return hasObjCCategoryInModule(Stream);
322*0b57cec5SDimitry Andric 
323*0b57cec5SDimitry Andric       // Ignore other sub-blocks.
324*0b57cec5SDimitry Andric       if (Error Err = Stream.SkipBlock())
325*0b57cec5SDimitry Andric         return std::move(Err);
326*0b57cec5SDimitry Andric       continue;
327*0b57cec5SDimitry Andric 
328*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
329*0b57cec5SDimitry Andric       if (Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID))
330*0b57cec5SDimitry Andric         continue;
331*0b57cec5SDimitry Andric       else
332*0b57cec5SDimitry Andric         return Skipped.takeError();
333*0b57cec5SDimitry Andric     }
334*0b57cec5SDimitry Andric   }
335*0b57cec5SDimitry Andric }
336*0b57cec5SDimitry Andric 
337*0b57cec5SDimitry Andric static Expected<std::string> readModuleTriple(BitstreamCursor &Stream) {
338*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
339*0b57cec5SDimitry Andric     return std::move(Err);
340*0b57cec5SDimitry Andric 
341*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
342*0b57cec5SDimitry Andric 
343*0b57cec5SDimitry Andric   std::string Triple;
344*0b57cec5SDimitry Andric 
345*0b57cec5SDimitry Andric   // Read all the records for this module.
346*0b57cec5SDimitry Andric   while (true) {
347*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
348*0b57cec5SDimitry Andric     if (!MaybeEntry)
349*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
350*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
351*0b57cec5SDimitry Andric 
352*0b57cec5SDimitry Andric     switch (Entry.Kind) {
353*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
354*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
355*0b57cec5SDimitry Andric       return error("Malformed block");
356*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
357*0b57cec5SDimitry Andric       return Triple;
358*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
359*0b57cec5SDimitry Andric       // The interesting case.
360*0b57cec5SDimitry Andric       break;
361*0b57cec5SDimitry Andric     }
362*0b57cec5SDimitry Andric 
363*0b57cec5SDimitry Andric     // Read a record.
364*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
365*0b57cec5SDimitry Andric     if (!MaybeRecord)
366*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
367*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
368*0b57cec5SDimitry Andric     default: break;  // Default behavior, ignore unknown content.
369*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
370*0b57cec5SDimitry Andric       std::string S;
371*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
372*0b57cec5SDimitry Andric         return error("Invalid record");
373*0b57cec5SDimitry Andric       Triple = S;
374*0b57cec5SDimitry Andric       break;
375*0b57cec5SDimitry Andric     }
376*0b57cec5SDimitry Andric     }
377*0b57cec5SDimitry Andric     Record.clear();
378*0b57cec5SDimitry Andric   }
379*0b57cec5SDimitry Andric   llvm_unreachable("Exit infinite loop");
380*0b57cec5SDimitry Andric }
381*0b57cec5SDimitry Andric 
382*0b57cec5SDimitry Andric static Expected<std::string> readTriple(BitstreamCursor &Stream) {
383*0b57cec5SDimitry Andric   // We expect a number of well-defined blocks, though we don't necessarily
384*0b57cec5SDimitry Andric   // need to understand them all.
385*0b57cec5SDimitry Andric   while (true) {
386*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advance();
387*0b57cec5SDimitry Andric     if (!MaybeEntry)
388*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
389*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
390*0b57cec5SDimitry Andric 
391*0b57cec5SDimitry Andric     switch (Entry.Kind) {
392*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
393*0b57cec5SDimitry Andric       return error("Malformed block");
394*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
395*0b57cec5SDimitry Andric       return "";
396*0b57cec5SDimitry Andric 
397*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
398*0b57cec5SDimitry Andric       if (Entry.ID == bitc::MODULE_BLOCK_ID)
399*0b57cec5SDimitry Andric         return readModuleTriple(Stream);
400*0b57cec5SDimitry Andric 
401*0b57cec5SDimitry Andric       // Ignore other sub-blocks.
402*0b57cec5SDimitry Andric       if (Error Err = Stream.SkipBlock())
403*0b57cec5SDimitry Andric         return std::move(Err);
404*0b57cec5SDimitry Andric       continue;
405*0b57cec5SDimitry Andric 
406*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
407*0b57cec5SDimitry Andric       if (llvm::Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID))
408*0b57cec5SDimitry Andric         continue;
409*0b57cec5SDimitry Andric       else
410*0b57cec5SDimitry Andric         return Skipped.takeError();
411*0b57cec5SDimitry Andric     }
412*0b57cec5SDimitry Andric   }
413*0b57cec5SDimitry Andric }
414*0b57cec5SDimitry Andric 
415*0b57cec5SDimitry Andric namespace {
416*0b57cec5SDimitry Andric 
417*0b57cec5SDimitry Andric class BitcodeReaderBase {
418*0b57cec5SDimitry Andric protected:
419*0b57cec5SDimitry Andric   BitcodeReaderBase(BitstreamCursor Stream, StringRef Strtab)
420*0b57cec5SDimitry Andric       : Stream(std::move(Stream)), Strtab(Strtab) {
421*0b57cec5SDimitry Andric     this->Stream.setBlockInfo(&BlockInfo);
422*0b57cec5SDimitry Andric   }
423*0b57cec5SDimitry Andric 
424*0b57cec5SDimitry Andric   BitstreamBlockInfo BlockInfo;
425*0b57cec5SDimitry Andric   BitstreamCursor Stream;
426*0b57cec5SDimitry Andric   StringRef Strtab;
427*0b57cec5SDimitry Andric 
428*0b57cec5SDimitry Andric   /// In version 2 of the bitcode we store names of global values and comdats in
429*0b57cec5SDimitry Andric   /// a string table rather than in the VST.
430*0b57cec5SDimitry Andric   bool UseStrtab = false;
431*0b57cec5SDimitry Andric 
432*0b57cec5SDimitry Andric   Expected<unsigned> parseVersionRecord(ArrayRef<uint64_t> Record);
433*0b57cec5SDimitry Andric 
434*0b57cec5SDimitry Andric   /// If this module uses a string table, pop the reference to the string table
435*0b57cec5SDimitry Andric   /// and return the referenced string and the rest of the record. Otherwise
436*0b57cec5SDimitry Andric   /// just return the record itself.
437*0b57cec5SDimitry Andric   std::pair<StringRef, ArrayRef<uint64_t>>
438*0b57cec5SDimitry Andric   readNameFromStrtab(ArrayRef<uint64_t> Record);
439*0b57cec5SDimitry Andric 
440*0b57cec5SDimitry Andric   bool readBlockInfo();
441*0b57cec5SDimitry Andric 
442*0b57cec5SDimitry Andric   // Contains an arbitrary and optional string identifying the bitcode producer
443*0b57cec5SDimitry Andric   std::string ProducerIdentification;
444*0b57cec5SDimitry Andric 
445*0b57cec5SDimitry Andric   Error error(const Twine &Message);
446*0b57cec5SDimitry Andric };
447*0b57cec5SDimitry Andric 
448*0b57cec5SDimitry Andric } // end anonymous namespace
449*0b57cec5SDimitry Andric 
450*0b57cec5SDimitry Andric Error BitcodeReaderBase::error(const Twine &Message) {
451*0b57cec5SDimitry Andric   std::string FullMsg = Message.str();
452*0b57cec5SDimitry Andric   if (!ProducerIdentification.empty())
453*0b57cec5SDimitry Andric     FullMsg += " (Producer: '" + ProducerIdentification + "' Reader: 'LLVM " +
454*0b57cec5SDimitry Andric                LLVM_VERSION_STRING "')";
455*0b57cec5SDimitry Andric   return ::error(FullMsg);
456*0b57cec5SDimitry Andric }
457*0b57cec5SDimitry Andric 
458*0b57cec5SDimitry Andric Expected<unsigned>
459*0b57cec5SDimitry Andric BitcodeReaderBase::parseVersionRecord(ArrayRef<uint64_t> Record) {
460*0b57cec5SDimitry Andric   if (Record.empty())
461*0b57cec5SDimitry Andric     return error("Invalid record");
462*0b57cec5SDimitry Andric   unsigned ModuleVersion = Record[0];
463*0b57cec5SDimitry Andric   if (ModuleVersion > 2)
464*0b57cec5SDimitry Andric     return error("Invalid value");
465*0b57cec5SDimitry Andric   UseStrtab = ModuleVersion >= 2;
466*0b57cec5SDimitry Andric   return ModuleVersion;
467*0b57cec5SDimitry Andric }
468*0b57cec5SDimitry Andric 
469*0b57cec5SDimitry Andric std::pair<StringRef, ArrayRef<uint64_t>>
470*0b57cec5SDimitry Andric BitcodeReaderBase::readNameFromStrtab(ArrayRef<uint64_t> Record) {
471*0b57cec5SDimitry Andric   if (!UseStrtab)
472*0b57cec5SDimitry Andric     return {"", Record};
473*0b57cec5SDimitry Andric   // Invalid reference. Let the caller complain about the record being empty.
474*0b57cec5SDimitry Andric   if (Record[0] + Record[1] > Strtab.size())
475*0b57cec5SDimitry Andric     return {"", {}};
476*0b57cec5SDimitry Andric   return {StringRef(Strtab.data() + Record[0], Record[1]), Record.slice(2)};
477*0b57cec5SDimitry Andric }
478*0b57cec5SDimitry Andric 
479*0b57cec5SDimitry Andric namespace {
480*0b57cec5SDimitry Andric 
481*0b57cec5SDimitry Andric class BitcodeReader : public BitcodeReaderBase, public GVMaterializer {
482*0b57cec5SDimitry Andric   LLVMContext &Context;
483*0b57cec5SDimitry Andric   Module *TheModule = nullptr;
484*0b57cec5SDimitry Andric   // Next offset to start scanning for lazy parsing of function bodies.
485*0b57cec5SDimitry Andric   uint64_t NextUnreadBit = 0;
486*0b57cec5SDimitry Andric   // Last function offset found in the VST.
487*0b57cec5SDimitry Andric   uint64_t LastFunctionBlockBit = 0;
488*0b57cec5SDimitry Andric   bool SeenValueSymbolTable = false;
489*0b57cec5SDimitry Andric   uint64_t VSTOffset = 0;
490*0b57cec5SDimitry Andric 
491*0b57cec5SDimitry Andric   std::vector<std::string> SectionTable;
492*0b57cec5SDimitry Andric   std::vector<std::string> GCTable;
493*0b57cec5SDimitry Andric 
494*0b57cec5SDimitry Andric   std::vector<Type*> TypeList;
495*0b57cec5SDimitry Andric   DenseMap<Function *, FunctionType *> FunctionTypes;
496*0b57cec5SDimitry Andric   BitcodeReaderValueList ValueList;
497*0b57cec5SDimitry Andric   Optional<MetadataLoader> MDLoader;
498*0b57cec5SDimitry Andric   std::vector<Comdat *> ComdatList;
499*0b57cec5SDimitry Andric   SmallVector<Instruction *, 64> InstructionList;
500*0b57cec5SDimitry Andric 
501*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalVariable *, unsigned>> GlobalInits;
502*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalIndirectSymbol *, unsigned>> IndirectSymbolInits;
503*0b57cec5SDimitry Andric   std::vector<std::pair<Function *, unsigned>> FunctionPrefixes;
504*0b57cec5SDimitry Andric   std::vector<std::pair<Function *, unsigned>> FunctionPrologues;
505*0b57cec5SDimitry Andric   std::vector<std::pair<Function *, unsigned>> FunctionPersonalityFns;
506*0b57cec5SDimitry Andric 
507*0b57cec5SDimitry Andric   /// The set of attributes by index.  Index zero in the file is for null, and
508*0b57cec5SDimitry Andric   /// is thus not represented here.  As such all indices are off by one.
509*0b57cec5SDimitry Andric   std::vector<AttributeList> MAttributes;
510*0b57cec5SDimitry Andric 
511*0b57cec5SDimitry Andric   /// The set of attribute groups.
512*0b57cec5SDimitry Andric   std::map<unsigned, AttributeList> MAttributeGroups;
513*0b57cec5SDimitry Andric 
514*0b57cec5SDimitry Andric   /// While parsing a function body, this is a list of the basic blocks for the
515*0b57cec5SDimitry Andric   /// function.
516*0b57cec5SDimitry Andric   std::vector<BasicBlock*> FunctionBBs;
517*0b57cec5SDimitry Andric 
518*0b57cec5SDimitry Andric   // When reading the module header, this list is populated with functions that
519*0b57cec5SDimitry Andric   // have bodies later in the file.
520*0b57cec5SDimitry Andric   std::vector<Function*> FunctionsWithBodies;
521*0b57cec5SDimitry Andric 
522*0b57cec5SDimitry Andric   // When intrinsic functions are encountered which require upgrading they are
523*0b57cec5SDimitry Andric   // stored here with their replacement function.
524*0b57cec5SDimitry Andric   using UpdatedIntrinsicMap = DenseMap<Function *, Function *>;
525*0b57cec5SDimitry Andric   UpdatedIntrinsicMap UpgradedIntrinsics;
526*0b57cec5SDimitry Andric   // Intrinsics which were remangled because of types rename
527*0b57cec5SDimitry Andric   UpdatedIntrinsicMap RemangledIntrinsics;
528*0b57cec5SDimitry Andric 
529*0b57cec5SDimitry Andric   // Several operations happen after the module header has been read, but
530*0b57cec5SDimitry Andric   // before function bodies are processed. This keeps track of whether
531*0b57cec5SDimitry Andric   // we've done this yet.
532*0b57cec5SDimitry Andric   bool SeenFirstFunctionBody = false;
533*0b57cec5SDimitry Andric 
534*0b57cec5SDimitry Andric   /// When function bodies are initially scanned, this map contains info about
535*0b57cec5SDimitry Andric   /// where to find deferred function body in the stream.
536*0b57cec5SDimitry Andric   DenseMap<Function*, uint64_t> DeferredFunctionInfo;
537*0b57cec5SDimitry Andric 
538*0b57cec5SDimitry Andric   /// When Metadata block is initially scanned when parsing the module, we may
539*0b57cec5SDimitry Andric   /// choose to defer parsing of the metadata. This vector contains info about
540*0b57cec5SDimitry Andric   /// which Metadata blocks are deferred.
541*0b57cec5SDimitry Andric   std::vector<uint64_t> DeferredMetadataInfo;
542*0b57cec5SDimitry Andric 
543*0b57cec5SDimitry Andric   /// These are basic blocks forward-referenced by block addresses.  They are
544*0b57cec5SDimitry Andric   /// inserted lazily into functions when they're loaded.  The basic block ID is
545*0b57cec5SDimitry Andric   /// its index into the vector.
546*0b57cec5SDimitry Andric   DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
547*0b57cec5SDimitry Andric   std::deque<Function *> BasicBlockFwdRefQueue;
548*0b57cec5SDimitry Andric 
549*0b57cec5SDimitry Andric   /// Indicates that we are using a new encoding for instruction operands where
550*0b57cec5SDimitry Andric   /// most operands in the current FUNCTION_BLOCK are encoded relative to the
551*0b57cec5SDimitry Andric   /// instruction number, for a more compact encoding.  Some instruction
552*0b57cec5SDimitry Andric   /// operands are not relative to the instruction ID: basic block numbers, and
553*0b57cec5SDimitry Andric   /// types. Once the old style function blocks have been phased out, we would
554*0b57cec5SDimitry Andric   /// not need this flag.
555*0b57cec5SDimitry Andric   bool UseRelativeIDs = false;
556*0b57cec5SDimitry Andric 
557*0b57cec5SDimitry Andric   /// True if all functions will be materialized, negating the need to process
558*0b57cec5SDimitry Andric   /// (e.g.) blockaddress forward references.
559*0b57cec5SDimitry Andric   bool WillMaterializeAllForwardRefs = false;
560*0b57cec5SDimitry Andric 
561*0b57cec5SDimitry Andric   bool StripDebugInfo = false;
562*0b57cec5SDimitry Andric   TBAAVerifier TBAAVerifyHelper;
563*0b57cec5SDimitry Andric 
564*0b57cec5SDimitry Andric   std::vector<std::string> BundleTags;
565*0b57cec5SDimitry Andric   SmallVector<SyncScope::ID, 8> SSIDs;
566*0b57cec5SDimitry Andric 
567*0b57cec5SDimitry Andric public:
568*0b57cec5SDimitry Andric   BitcodeReader(BitstreamCursor Stream, StringRef Strtab,
569*0b57cec5SDimitry Andric                 StringRef ProducerIdentification, LLVMContext &Context);
570*0b57cec5SDimitry Andric 
571*0b57cec5SDimitry Andric   Error materializeForwardReferencedFunctions();
572*0b57cec5SDimitry Andric 
573*0b57cec5SDimitry Andric   Error materialize(GlobalValue *GV) override;
574*0b57cec5SDimitry Andric   Error materializeModule() override;
575*0b57cec5SDimitry Andric   std::vector<StructType *> getIdentifiedStructTypes() const override;
576*0b57cec5SDimitry Andric 
577*0b57cec5SDimitry Andric   /// Main interface to parsing a bitcode buffer.
578*0b57cec5SDimitry Andric   /// \returns true if an error occurred.
5795ffd83dbSDimitry Andric   Error parseBitcodeInto(
5805ffd83dbSDimitry Andric       Module *M, bool ShouldLazyLoadMetadata = false, bool IsImporting = false,
5815ffd83dbSDimitry Andric       DataLayoutCallbackTy DataLayoutCallback = [](std::string) {
5825ffd83dbSDimitry Andric         return None;
5835ffd83dbSDimitry Andric       });
584*0b57cec5SDimitry Andric 
585*0b57cec5SDimitry Andric   static uint64_t decodeSignRotatedValue(uint64_t V);
586*0b57cec5SDimitry Andric 
587*0b57cec5SDimitry Andric   /// Materialize any deferred Metadata block.
588*0b57cec5SDimitry Andric   Error materializeMetadata() override;
589*0b57cec5SDimitry Andric 
590*0b57cec5SDimitry Andric   void setStripDebugInfo() override;
591*0b57cec5SDimitry Andric 
592*0b57cec5SDimitry Andric private:
593*0b57cec5SDimitry Andric   std::vector<StructType *> IdentifiedStructTypes;
594*0b57cec5SDimitry Andric   StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
595*0b57cec5SDimitry Andric   StructType *createIdentifiedStructType(LLVMContext &Context);
596*0b57cec5SDimitry Andric 
597*0b57cec5SDimitry Andric   /// Map all pointer types within \param Ty to the opaque pointer
598*0b57cec5SDimitry Andric   /// type in the same address space if opaque pointers are being
599*0b57cec5SDimitry Andric   /// used, otherwise nop. This converts a bitcode-reader internal
600*0b57cec5SDimitry Andric   /// type into one suitable for use in a Value.
601*0b57cec5SDimitry Andric   Type *flattenPointerTypes(Type *Ty) {
602*0b57cec5SDimitry Andric     return Ty;
603*0b57cec5SDimitry Andric   }
604*0b57cec5SDimitry Andric 
605*0b57cec5SDimitry Andric   /// Given a fully structured pointer type (i.e. not opaque), return
606*0b57cec5SDimitry Andric   /// the flattened form of its element, suitable for use in a Value.
607*0b57cec5SDimitry Andric   Type *getPointerElementFlatType(Type *Ty) {
608*0b57cec5SDimitry Andric     return flattenPointerTypes(cast<PointerType>(Ty)->getElementType());
609*0b57cec5SDimitry Andric   }
610*0b57cec5SDimitry Andric 
611*0b57cec5SDimitry Andric   /// Given a fully structured pointer type, get its element type in
612*0b57cec5SDimitry Andric   /// both fully structured form, and flattened form suitable for use
613*0b57cec5SDimitry Andric   /// in a Value.
614*0b57cec5SDimitry Andric   std::pair<Type *, Type *> getPointerElementTypes(Type *FullTy) {
615*0b57cec5SDimitry Andric     Type *ElTy = cast<PointerType>(FullTy)->getElementType();
616*0b57cec5SDimitry Andric     return std::make_pair(ElTy, flattenPointerTypes(ElTy));
617*0b57cec5SDimitry Andric   }
618*0b57cec5SDimitry Andric 
619*0b57cec5SDimitry Andric   /// Return the flattened type (suitable for use in a Value)
620*0b57cec5SDimitry Andric   /// specified by the given \param ID .
621*0b57cec5SDimitry Andric   Type *getTypeByID(unsigned ID) {
622*0b57cec5SDimitry Andric     return flattenPointerTypes(getFullyStructuredTypeByID(ID));
623*0b57cec5SDimitry Andric   }
624*0b57cec5SDimitry Andric 
625*0b57cec5SDimitry Andric   /// Return the fully structured (bitcode-reader internal) type
626*0b57cec5SDimitry Andric   /// corresponding to the given \param ID .
627*0b57cec5SDimitry Andric   Type *getFullyStructuredTypeByID(unsigned ID);
628*0b57cec5SDimitry Andric 
629*0b57cec5SDimitry Andric   Value *getFnValueByID(unsigned ID, Type *Ty, Type **FullTy = nullptr) {
630*0b57cec5SDimitry Andric     if (Ty && Ty->isMetadataTy())
631*0b57cec5SDimitry Andric       return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
632*0b57cec5SDimitry Andric     return ValueList.getValueFwdRef(ID, Ty, FullTy);
633*0b57cec5SDimitry Andric   }
634*0b57cec5SDimitry Andric 
635*0b57cec5SDimitry Andric   Metadata *getFnMetadataByID(unsigned ID) {
636*0b57cec5SDimitry Andric     return MDLoader->getMetadataFwdRefOrLoad(ID);
637*0b57cec5SDimitry Andric   }
638*0b57cec5SDimitry Andric 
639*0b57cec5SDimitry Andric   BasicBlock *getBasicBlock(unsigned ID) const {
640*0b57cec5SDimitry Andric     if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
641*0b57cec5SDimitry Andric     return FunctionBBs[ID];
642*0b57cec5SDimitry Andric   }
643*0b57cec5SDimitry Andric 
644*0b57cec5SDimitry Andric   AttributeList getAttributes(unsigned i) const {
645*0b57cec5SDimitry Andric     if (i-1 < MAttributes.size())
646*0b57cec5SDimitry Andric       return MAttributes[i-1];
647*0b57cec5SDimitry Andric     return AttributeList();
648*0b57cec5SDimitry Andric   }
649*0b57cec5SDimitry Andric 
650*0b57cec5SDimitry Andric   /// Read a value/type pair out of the specified record from slot 'Slot'.
651*0b57cec5SDimitry Andric   /// Increment Slot past the number of slots used in the record. Return true on
652*0b57cec5SDimitry Andric   /// failure.
653*0b57cec5SDimitry Andric   bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
654*0b57cec5SDimitry Andric                         unsigned InstNum, Value *&ResVal,
655*0b57cec5SDimitry Andric                         Type **FullTy = nullptr) {
656*0b57cec5SDimitry Andric     if (Slot == Record.size()) return true;
657*0b57cec5SDimitry Andric     unsigned ValNo = (unsigned)Record[Slot++];
658*0b57cec5SDimitry Andric     // Adjust the ValNo, if it was encoded relative to the InstNum.
659*0b57cec5SDimitry Andric     if (UseRelativeIDs)
660*0b57cec5SDimitry Andric       ValNo = InstNum - ValNo;
661*0b57cec5SDimitry Andric     if (ValNo < InstNum) {
662*0b57cec5SDimitry Andric       // If this is not a forward reference, just return the value we already
663*0b57cec5SDimitry Andric       // have.
664*0b57cec5SDimitry Andric       ResVal = getFnValueByID(ValNo, nullptr, FullTy);
665*0b57cec5SDimitry Andric       return ResVal == nullptr;
666*0b57cec5SDimitry Andric     }
667*0b57cec5SDimitry Andric     if (Slot == Record.size())
668*0b57cec5SDimitry Andric       return true;
669*0b57cec5SDimitry Andric 
670*0b57cec5SDimitry Andric     unsigned TypeNo = (unsigned)Record[Slot++];
671*0b57cec5SDimitry Andric     ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
672*0b57cec5SDimitry Andric     if (FullTy)
673*0b57cec5SDimitry Andric       *FullTy = getFullyStructuredTypeByID(TypeNo);
674*0b57cec5SDimitry Andric     return ResVal == nullptr;
675*0b57cec5SDimitry Andric   }
676*0b57cec5SDimitry Andric 
677*0b57cec5SDimitry Andric   /// Read a value out of the specified record from slot 'Slot'. Increment Slot
678*0b57cec5SDimitry Andric   /// past the number of slots used by the value in the record. Return true if
679*0b57cec5SDimitry Andric   /// there is an error.
680*0b57cec5SDimitry Andric   bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
681*0b57cec5SDimitry Andric                 unsigned InstNum, Type *Ty, Value *&ResVal) {
682*0b57cec5SDimitry Andric     if (getValue(Record, Slot, InstNum, Ty, ResVal))
683*0b57cec5SDimitry Andric       return true;
684*0b57cec5SDimitry Andric     // All values currently take a single record slot.
685*0b57cec5SDimitry Andric     ++Slot;
686*0b57cec5SDimitry Andric     return false;
687*0b57cec5SDimitry Andric   }
688*0b57cec5SDimitry Andric 
689*0b57cec5SDimitry Andric   /// Like popValue, but does not increment the Slot number.
690*0b57cec5SDimitry Andric   bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
691*0b57cec5SDimitry Andric                 unsigned InstNum, Type *Ty, Value *&ResVal) {
692*0b57cec5SDimitry Andric     ResVal = getValue(Record, Slot, InstNum, Ty);
693*0b57cec5SDimitry Andric     return ResVal == nullptr;
694*0b57cec5SDimitry Andric   }
695*0b57cec5SDimitry Andric 
696*0b57cec5SDimitry Andric   /// Version of getValue that returns ResVal directly, or 0 if there is an
697*0b57cec5SDimitry Andric   /// error.
698*0b57cec5SDimitry Andric   Value *getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
699*0b57cec5SDimitry Andric                   unsigned InstNum, Type *Ty) {
700*0b57cec5SDimitry Andric     if (Slot == Record.size()) return nullptr;
701*0b57cec5SDimitry Andric     unsigned ValNo = (unsigned)Record[Slot];
702*0b57cec5SDimitry Andric     // Adjust the ValNo, if it was encoded relative to the InstNum.
703*0b57cec5SDimitry Andric     if (UseRelativeIDs)
704*0b57cec5SDimitry Andric       ValNo = InstNum - ValNo;
705*0b57cec5SDimitry Andric     return getFnValueByID(ValNo, Ty);
706*0b57cec5SDimitry Andric   }
707*0b57cec5SDimitry Andric 
708*0b57cec5SDimitry Andric   /// Like getValue, but decodes signed VBRs.
709*0b57cec5SDimitry Andric   Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
710*0b57cec5SDimitry Andric                         unsigned InstNum, Type *Ty) {
711*0b57cec5SDimitry Andric     if (Slot == Record.size()) return nullptr;
712*0b57cec5SDimitry Andric     unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
713*0b57cec5SDimitry Andric     // Adjust the ValNo, if it was encoded relative to the InstNum.
714*0b57cec5SDimitry Andric     if (UseRelativeIDs)
715*0b57cec5SDimitry Andric       ValNo = InstNum - ValNo;
716*0b57cec5SDimitry Andric     return getFnValueByID(ValNo, Ty);
717*0b57cec5SDimitry Andric   }
718*0b57cec5SDimitry Andric 
719*0b57cec5SDimitry Andric   /// Upgrades old-style typeless byval attributes by adding the corresponding
720*0b57cec5SDimitry Andric   /// argument's pointee type.
721*0b57cec5SDimitry Andric   void propagateByValTypes(CallBase *CB, ArrayRef<Type *> ArgsFullTys);
722*0b57cec5SDimitry Andric 
723*0b57cec5SDimitry Andric   /// Converts alignment exponent (i.e. power of two (or zero)) to the
724*0b57cec5SDimitry Andric   /// corresponding alignment to use. If alignment is too large, returns
725*0b57cec5SDimitry Andric   /// a corresponding error code.
7268bcb0991SDimitry Andric   Error parseAlignmentValue(uint64_t Exponent, MaybeAlign &Alignment);
727*0b57cec5SDimitry Andric   Error parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
7285ffd83dbSDimitry Andric   Error parseModule(
7295ffd83dbSDimitry Andric       uint64_t ResumeBit, bool ShouldLazyLoadMetadata = false,
7305ffd83dbSDimitry Andric       DataLayoutCallbackTy DataLayoutCallback = [](StringRef) { return None; });
731*0b57cec5SDimitry Andric 
732*0b57cec5SDimitry Andric   Error parseComdatRecord(ArrayRef<uint64_t> Record);
733*0b57cec5SDimitry Andric   Error parseGlobalVarRecord(ArrayRef<uint64_t> Record);
734*0b57cec5SDimitry Andric   Error parseFunctionRecord(ArrayRef<uint64_t> Record);
735*0b57cec5SDimitry Andric   Error parseGlobalIndirectSymbolRecord(unsigned BitCode,
736*0b57cec5SDimitry Andric                                         ArrayRef<uint64_t> Record);
737*0b57cec5SDimitry Andric 
738*0b57cec5SDimitry Andric   Error parseAttributeBlock();
739*0b57cec5SDimitry Andric   Error parseAttributeGroupBlock();
740*0b57cec5SDimitry Andric   Error parseTypeTable();
741*0b57cec5SDimitry Andric   Error parseTypeTableBody();
742*0b57cec5SDimitry Andric   Error parseOperandBundleTags();
743*0b57cec5SDimitry Andric   Error parseSyncScopeNames();
744*0b57cec5SDimitry Andric 
745*0b57cec5SDimitry Andric   Expected<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,
746*0b57cec5SDimitry Andric                                 unsigned NameIndex, Triple &TT);
747*0b57cec5SDimitry Andric   void setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta, Function *F,
748*0b57cec5SDimitry Andric                                ArrayRef<uint64_t> Record);
749*0b57cec5SDimitry Andric   Error parseValueSymbolTable(uint64_t Offset = 0);
750*0b57cec5SDimitry Andric   Error parseGlobalValueSymbolTable();
751*0b57cec5SDimitry Andric   Error parseConstants();
752*0b57cec5SDimitry Andric   Error rememberAndSkipFunctionBodies();
753*0b57cec5SDimitry Andric   Error rememberAndSkipFunctionBody();
754*0b57cec5SDimitry Andric   /// Save the positions of the Metadata blocks and skip parsing the blocks.
755*0b57cec5SDimitry Andric   Error rememberAndSkipMetadata();
756*0b57cec5SDimitry Andric   Error typeCheckLoadStoreInst(Type *ValType, Type *PtrType);
757*0b57cec5SDimitry Andric   Error parseFunctionBody(Function *F);
758*0b57cec5SDimitry Andric   Error globalCleanup();
759*0b57cec5SDimitry Andric   Error resolveGlobalAndIndirectSymbolInits();
760*0b57cec5SDimitry Andric   Error parseUseLists();
761*0b57cec5SDimitry Andric   Error findFunctionInStream(
762*0b57cec5SDimitry Andric       Function *F,
763*0b57cec5SDimitry Andric       DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
764*0b57cec5SDimitry Andric 
765*0b57cec5SDimitry Andric   SyncScope::ID getDecodedSyncScopeID(unsigned Val);
766*0b57cec5SDimitry Andric };
767*0b57cec5SDimitry Andric 
768*0b57cec5SDimitry Andric /// Class to manage reading and parsing function summary index bitcode
769*0b57cec5SDimitry Andric /// files/sections.
770*0b57cec5SDimitry Andric class ModuleSummaryIndexBitcodeReader : public BitcodeReaderBase {
771*0b57cec5SDimitry Andric   /// The module index built during parsing.
772*0b57cec5SDimitry Andric   ModuleSummaryIndex &TheIndex;
773*0b57cec5SDimitry Andric 
774*0b57cec5SDimitry Andric   /// Indicates whether we have encountered a global value summary section
775*0b57cec5SDimitry Andric   /// yet during parsing.
776*0b57cec5SDimitry Andric   bool SeenGlobalValSummary = false;
777*0b57cec5SDimitry Andric 
778*0b57cec5SDimitry Andric   /// Indicates whether we have already parsed the VST, used for error checking.
779*0b57cec5SDimitry Andric   bool SeenValueSymbolTable = false;
780*0b57cec5SDimitry Andric 
781*0b57cec5SDimitry Andric   /// Set to the offset of the VST recorded in the MODULE_CODE_VSTOFFSET record.
782*0b57cec5SDimitry Andric   /// Used to enable on-demand parsing of the VST.
783*0b57cec5SDimitry Andric   uint64_t VSTOffset = 0;
784*0b57cec5SDimitry Andric 
785*0b57cec5SDimitry Andric   // Map to save ValueId to ValueInfo association that was recorded in the
786*0b57cec5SDimitry Andric   // ValueSymbolTable. It is used after the VST is parsed to convert
787*0b57cec5SDimitry Andric   // call graph edges read from the function summary from referencing
788*0b57cec5SDimitry Andric   // callees by their ValueId to using the ValueInfo instead, which is how
789*0b57cec5SDimitry Andric   // they are recorded in the summary index being built.
790*0b57cec5SDimitry Andric   // We save a GUID which refers to the same global as the ValueInfo, but
791*0b57cec5SDimitry Andric   // ignoring the linkage, i.e. for values other than local linkage they are
792*0b57cec5SDimitry Andric   // identical.
793*0b57cec5SDimitry Andric   DenseMap<unsigned, std::pair<ValueInfo, GlobalValue::GUID>>
794*0b57cec5SDimitry Andric       ValueIdToValueInfoMap;
795*0b57cec5SDimitry Andric 
796*0b57cec5SDimitry Andric   /// Map populated during module path string table parsing, from the
797*0b57cec5SDimitry Andric   /// module ID to a string reference owned by the index's module
798*0b57cec5SDimitry Andric   /// path string table, used to correlate with combined index
799*0b57cec5SDimitry Andric   /// summary records.
800*0b57cec5SDimitry Andric   DenseMap<uint64_t, StringRef> ModuleIdMap;
801*0b57cec5SDimitry Andric 
802*0b57cec5SDimitry Andric   /// Original source file name recorded in a bitcode record.
803*0b57cec5SDimitry Andric   std::string SourceFileName;
804*0b57cec5SDimitry Andric 
805*0b57cec5SDimitry Andric   /// The string identifier given to this module by the client, normally the
806*0b57cec5SDimitry Andric   /// path to the bitcode file.
807*0b57cec5SDimitry Andric   StringRef ModulePath;
808*0b57cec5SDimitry Andric 
809*0b57cec5SDimitry Andric   /// For per-module summary indexes, the unique numerical identifier given to
810*0b57cec5SDimitry Andric   /// this module by the client.
811*0b57cec5SDimitry Andric   unsigned ModuleId;
812*0b57cec5SDimitry Andric 
813*0b57cec5SDimitry Andric public:
814*0b57cec5SDimitry Andric   ModuleSummaryIndexBitcodeReader(BitstreamCursor Stream, StringRef Strtab,
815*0b57cec5SDimitry Andric                                   ModuleSummaryIndex &TheIndex,
816*0b57cec5SDimitry Andric                                   StringRef ModulePath, unsigned ModuleId);
817*0b57cec5SDimitry Andric 
818*0b57cec5SDimitry Andric   Error parseModule();
819*0b57cec5SDimitry Andric 
820*0b57cec5SDimitry Andric private:
821*0b57cec5SDimitry Andric   void setValueGUID(uint64_t ValueID, StringRef ValueName,
822*0b57cec5SDimitry Andric                     GlobalValue::LinkageTypes Linkage,
823*0b57cec5SDimitry Andric                     StringRef SourceFileName);
824*0b57cec5SDimitry Andric   Error parseValueSymbolTable(
825*0b57cec5SDimitry Andric       uint64_t Offset,
826*0b57cec5SDimitry Andric       DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap);
827*0b57cec5SDimitry Andric   std::vector<ValueInfo> makeRefList(ArrayRef<uint64_t> Record);
828*0b57cec5SDimitry Andric   std::vector<FunctionSummary::EdgeTy> makeCallList(ArrayRef<uint64_t> Record,
829*0b57cec5SDimitry Andric                                                     bool IsOldProfileFormat,
830*0b57cec5SDimitry Andric                                                     bool HasProfile,
831*0b57cec5SDimitry Andric                                                     bool HasRelBF);
832*0b57cec5SDimitry Andric   Error parseEntireSummary(unsigned ID);
833*0b57cec5SDimitry Andric   Error parseModuleStringTable();
834*0b57cec5SDimitry Andric   void parseTypeIdCompatibleVtableSummaryRecord(ArrayRef<uint64_t> Record);
835*0b57cec5SDimitry Andric   void parseTypeIdCompatibleVtableInfo(ArrayRef<uint64_t> Record, size_t &Slot,
836*0b57cec5SDimitry Andric                                        TypeIdCompatibleVtableInfo &TypeId);
837*0b57cec5SDimitry Andric 
838*0b57cec5SDimitry Andric   std::pair<ValueInfo, GlobalValue::GUID>
839*0b57cec5SDimitry Andric   getValueInfoFromValueId(unsigned ValueId);
840*0b57cec5SDimitry Andric 
841*0b57cec5SDimitry Andric   void addThisModule();
842*0b57cec5SDimitry Andric   ModuleSummaryIndex::ModuleInfo *getThisModule();
843*0b57cec5SDimitry Andric };
844*0b57cec5SDimitry Andric 
845*0b57cec5SDimitry Andric } // end anonymous namespace
846*0b57cec5SDimitry Andric 
847*0b57cec5SDimitry Andric std::error_code llvm::errorToErrorCodeAndEmitErrors(LLVMContext &Ctx,
848*0b57cec5SDimitry Andric                                                     Error Err) {
849*0b57cec5SDimitry Andric   if (Err) {
850*0b57cec5SDimitry Andric     std::error_code EC;
851*0b57cec5SDimitry Andric     handleAllErrors(std::move(Err), [&](ErrorInfoBase &EIB) {
852*0b57cec5SDimitry Andric       EC = EIB.convertToErrorCode();
853*0b57cec5SDimitry Andric       Ctx.emitError(EIB.message());
854*0b57cec5SDimitry Andric     });
855*0b57cec5SDimitry Andric     return EC;
856*0b57cec5SDimitry Andric   }
857*0b57cec5SDimitry Andric   return std::error_code();
858*0b57cec5SDimitry Andric }
859*0b57cec5SDimitry Andric 
860*0b57cec5SDimitry Andric BitcodeReader::BitcodeReader(BitstreamCursor Stream, StringRef Strtab,
861*0b57cec5SDimitry Andric                              StringRef ProducerIdentification,
862*0b57cec5SDimitry Andric                              LLVMContext &Context)
863*0b57cec5SDimitry Andric     : BitcodeReaderBase(std::move(Stream), Strtab), Context(Context),
864*0b57cec5SDimitry Andric       ValueList(Context, Stream.SizeInBytes()) {
8655ffd83dbSDimitry Andric   this->ProducerIdentification = std::string(ProducerIdentification);
866*0b57cec5SDimitry Andric }
867*0b57cec5SDimitry Andric 
868*0b57cec5SDimitry Andric Error BitcodeReader::materializeForwardReferencedFunctions() {
869*0b57cec5SDimitry Andric   if (WillMaterializeAllForwardRefs)
870*0b57cec5SDimitry Andric     return Error::success();
871*0b57cec5SDimitry Andric 
872*0b57cec5SDimitry Andric   // Prevent recursion.
873*0b57cec5SDimitry Andric   WillMaterializeAllForwardRefs = true;
874*0b57cec5SDimitry Andric 
875*0b57cec5SDimitry Andric   while (!BasicBlockFwdRefQueue.empty()) {
876*0b57cec5SDimitry Andric     Function *F = BasicBlockFwdRefQueue.front();
877*0b57cec5SDimitry Andric     BasicBlockFwdRefQueue.pop_front();
878*0b57cec5SDimitry Andric     assert(F && "Expected valid function");
879*0b57cec5SDimitry Andric     if (!BasicBlockFwdRefs.count(F))
880*0b57cec5SDimitry Andric       // Already materialized.
881*0b57cec5SDimitry Andric       continue;
882*0b57cec5SDimitry Andric 
883*0b57cec5SDimitry Andric     // Check for a function that isn't materializable to prevent an infinite
884*0b57cec5SDimitry Andric     // loop.  When parsing a blockaddress stored in a global variable, there
885*0b57cec5SDimitry Andric     // isn't a trivial way to check if a function will have a body without a
886*0b57cec5SDimitry Andric     // linear search through FunctionsWithBodies, so just check it here.
887*0b57cec5SDimitry Andric     if (!F->isMaterializable())
888*0b57cec5SDimitry Andric       return error("Never resolved function from blockaddress");
889*0b57cec5SDimitry Andric 
890*0b57cec5SDimitry Andric     // Try to materialize F.
891*0b57cec5SDimitry Andric     if (Error Err = materialize(F))
892*0b57cec5SDimitry Andric       return Err;
893*0b57cec5SDimitry Andric   }
894*0b57cec5SDimitry Andric   assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
895*0b57cec5SDimitry Andric 
896*0b57cec5SDimitry Andric   // Reset state.
897*0b57cec5SDimitry Andric   WillMaterializeAllForwardRefs = false;
898*0b57cec5SDimitry Andric   return Error::success();
899*0b57cec5SDimitry Andric }
900*0b57cec5SDimitry Andric 
901*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
902*0b57cec5SDimitry Andric //  Helper functions to implement forward reference resolution, etc.
903*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
904*0b57cec5SDimitry Andric 
905*0b57cec5SDimitry Andric static bool hasImplicitComdat(size_t Val) {
906*0b57cec5SDimitry Andric   switch (Val) {
907*0b57cec5SDimitry Andric   default:
908*0b57cec5SDimitry Andric     return false;
909*0b57cec5SDimitry Andric   case 1:  // Old WeakAnyLinkage
910*0b57cec5SDimitry Andric   case 4:  // Old LinkOnceAnyLinkage
911*0b57cec5SDimitry Andric   case 10: // Old WeakODRLinkage
912*0b57cec5SDimitry Andric   case 11: // Old LinkOnceODRLinkage
913*0b57cec5SDimitry Andric     return true;
914*0b57cec5SDimitry Andric   }
915*0b57cec5SDimitry Andric }
916*0b57cec5SDimitry Andric 
917*0b57cec5SDimitry Andric static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
918*0b57cec5SDimitry Andric   switch (Val) {
919*0b57cec5SDimitry Andric   default: // Map unknown/new linkages to external
920*0b57cec5SDimitry Andric   case 0:
921*0b57cec5SDimitry Andric     return GlobalValue::ExternalLinkage;
922*0b57cec5SDimitry Andric   case 2:
923*0b57cec5SDimitry Andric     return GlobalValue::AppendingLinkage;
924*0b57cec5SDimitry Andric   case 3:
925*0b57cec5SDimitry Andric     return GlobalValue::InternalLinkage;
926*0b57cec5SDimitry Andric   case 5:
927*0b57cec5SDimitry Andric     return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
928*0b57cec5SDimitry Andric   case 6:
929*0b57cec5SDimitry Andric     return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
930*0b57cec5SDimitry Andric   case 7:
931*0b57cec5SDimitry Andric     return GlobalValue::ExternalWeakLinkage;
932*0b57cec5SDimitry Andric   case 8:
933*0b57cec5SDimitry Andric     return GlobalValue::CommonLinkage;
934*0b57cec5SDimitry Andric   case 9:
935*0b57cec5SDimitry Andric     return GlobalValue::PrivateLinkage;
936*0b57cec5SDimitry Andric   case 12:
937*0b57cec5SDimitry Andric     return GlobalValue::AvailableExternallyLinkage;
938*0b57cec5SDimitry Andric   case 13:
939*0b57cec5SDimitry Andric     return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
940*0b57cec5SDimitry Andric   case 14:
941*0b57cec5SDimitry Andric     return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
942*0b57cec5SDimitry Andric   case 15:
943*0b57cec5SDimitry Andric     return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
944*0b57cec5SDimitry Andric   case 1: // Old value with implicit comdat.
945*0b57cec5SDimitry Andric   case 16:
946*0b57cec5SDimitry Andric     return GlobalValue::WeakAnyLinkage;
947*0b57cec5SDimitry Andric   case 10: // Old value with implicit comdat.
948*0b57cec5SDimitry Andric   case 17:
949*0b57cec5SDimitry Andric     return GlobalValue::WeakODRLinkage;
950*0b57cec5SDimitry Andric   case 4: // Old value with implicit comdat.
951*0b57cec5SDimitry Andric   case 18:
952*0b57cec5SDimitry Andric     return GlobalValue::LinkOnceAnyLinkage;
953*0b57cec5SDimitry Andric   case 11: // Old value with implicit comdat.
954*0b57cec5SDimitry Andric   case 19:
955*0b57cec5SDimitry Andric     return GlobalValue::LinkOnceODRLinkage;
956*0b57cec5SDimitry Andric   }
957*0b57cec5SDimitry Andric }
958*0b57cec5SDimitry Andric 
959*0b57cec5SDimitry Andric static FunctionSummary::FFlags getDecodedFFlags(uint64_t RawFlags) {
960*0b57cec5SDimitry Andric   FunctionSummary::FFlags Flags;
961*0b57cec5SDimitry Andric   Flags.ReadNone = RawFlags & 0x1;
962*0b57cec5SDimitry Andric   Flags.ReadOnly = (RawFlags >> 1) & 0x1;
963*0b57cec5SDimitry Andric   Flags.NoRecurse = (RawFlags >> 2) & 0x1;
964*0b57cec5SDimitry Andric   Flags.ReturnDoesNotAlias = (RawFlags >> 3) & 0x1;
965*0b57cec5SDimitry Andric   Flags.NoInline = (RawFlags >> 4) & 0x1;
966480093f4SDimitry Andric   Flags.AlwaysInline = (RawFlags >> 5) & 0x1;
967*0b57cec5SDimitry Andric   return Flags;
968*0b57cec5SDimitry Andric }
969*0b57cec5SDimitry Andric 
970*0b57cec5SDimitry Andric /// Decode the flags for GlobalValue in the summary.
971*0b57cec5SDimitry Andric static GlobalValueSummary::GVFlags getDecodedGVSummaryFlags(uint64_t RawFlags,
972*0b57cec5SDimitry Andric                                                             uint64_t Version) {
973*0b57cec5SDimitry Andric   // Summary were not emitted before LLVM 3.9, we don't need to upgrade Linkage
974*0b57cec5SDimitry Andric   // like getDecodedLinkage() above. Any future change to the linkage enum and
975*0b57cec5SDimitry Andric   // to getDecodedLinkage() will need to be taken into account here as above.
976*0b57cec5SDimitry Andric   auto Linkage = GlobalValue::LinkageTypes(RawFlags & 0xF); // 4 bits
977*0b57cec5SDimitry Andric   RawFlags = RawFlags >> 4;
978*0b57cec5SDimitry Andric   bool NotEligibleToImport = (RawFlags & 0x1) || Version < 3;
979*0b57cec5SDimitry Andric   // The Live flag wasn't introduced until version 3. For dead stripping
980*0b57cec5SDimitry Andric   // to work correctly on earlier versions, we must conservatively treat all
981*0b57cec5SDimitry Andric   // values as live.
982*0b57cec5SDimitry Andric   bool Live = (RawFlags & 0x2) || Version < 3;
983*0b57cec5SDimitry Andric   bool Local = (RawFlags & 0x4);
984*0b57cec5SDimitry Andric   bool AutoHide = (RawFlags & 0x8);
985*0b57cec5SDimitry Andric 
986*0b57cec5SDimitry Andric   return GlobalValueSummary::GVFlags(Linkage, NotEligibleToImport, Live, Local, AutoHide);
987*0b57cec5SDimitry Andric }
988*0b57cec5SDimitry Andric 
989*0b57cec5SDimitry Andric // Decode the flags for GlobalVariable in the summary
990*0b57cec5SDimitry Andric static GlobalVarSummary::GVarFlags getDecodedGVarFlags(uint64_t RawFlags) {
9915ffd83dbSDimitry Andric   return GlobalVarSummary::GVarFlags(
9925ffd83dbSDimitry Andric       (RawFlags & 0x1) ? true : false, (RawFlags & 0x2) ? true : false,
9935ffd83dbSDimitry Andric       (RawFlags & 0x4) ? true : false,
9945ffd83dbSDimitry Andric       (GlobalObject::VCallVisibility)(RawFlags >> 3));
995*0b57cec5SDimitry Andric }
996*0b57cec5SDimitry Andric 
997*0b57cec5SDimitry Andric static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {
998*0b57cec5SDimitry Andric   switch (Val) {
999*0b57cec5SDimitry Andric   default: // Map unknown visibilities to default.
1000*0b57cec5SDimitry Andric   case 0: return GlobalValue::DefaultVisibility;
1001*0b57cec5SDimitry Andric   case 1: return GlobalValue::HiddenVisibility;
1002*0b57cec5SDimitry Andric   case 2: return GlobalValue::ProtectedVisibility;
1003*0b57cec5SDimitry Andric   }
1004*0b57cec5SDimitry Andric }
1005*0b57cec5SDimitry Andric 
1006*0b57cec5SDimitry Andric static GlobalValue::DLLStorageClassTypes
1007*0b57cec5SDimitry Andric getDecodedDLLStorageClass(unsigned Val) {
1008*0b57cec5SDimitry Andric   switch (Val) {
1009*0b57cec5SDimitry Andric   default: // Map unknown values to default.
1010*0b57cec5SDimitry Andric   case 0: return GlobalValue::DefaultStorageClass;
1011*0b57cec5SDimitry Andric   case 1: return GlobalValue::DLLImportStorageClass;
1012*0b57cec5SDimitry Andric   case 2: return GlobalValue::DLLExportStorageClass;
1013*0b57cec5SDimitry Andric   }
1014*0b57cec5SDimitry Andric }
1015*0b57cec5SDimitry Andric 
1016*0b57cec5SDimitry Andric static bool getDecodedDSOLocal(unsigned Val) {
1017*0b57cec5SDimitry Andric   switch(Val) {
1018*0b57cec5SDimitry Andric   default: // Map unknown values to preemptable.
1019*0b57cec5SDimitry Andric   case 0:  return false;
1020*0b57cec5SDimitry Andric   case 1:  return true;
1021*0b57cec5SDimitry Andric   }
1022*0b57cec5SDimitry Andric }
1023*0b57cec5SDimitry Andric 
1024*0b57cec5SDimitry Andric static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {
1025*0b57cec5SDimitry Andric   switch (Val) {
1026*0b57cec5SDimitry Andric     case 0: return GlobalVariable::NotThreadLocal;
1027*0b57cec5SDimitry Andric     default: // Map unknown non-zero value to general dynamic.
1028*0b57cec5SDimitry Andric     case 1: return GlobalVariable::GeneralDynamicTLSModel;
1029*0b57cec5SDimitry Andric     case 2: return GlobalVariable::LocalDynamicTLSModel;
1030*0b57cec5SDimitry Andric     case 3: return GlobalVariable::InitialExecTLSModel;
1031*0b57cec5SDimitry Andric     case 4: return GlobalVariable::LocalExecTLSModel;
1032*0b57cec5SDimitry Andric   }
1033*0b57cec5SDimitry Andric }
1034*0b57cec5SDimitry Andric 
1035*0b57cec5SDimitry Andric static GlobalVariable::UnnamedAddr getDecodedUnnamedAddrType(unsigned Val) {
1036*0b57cec5SDimitry Andric   switch (Val) {
1037*0b57cec5SDimitry Andric     default: // Map unknown to UnnamedAddr::None.
1038*0b57cec5SDimitry Andric     case 0: return GlobalVariable::UnnamedAddr::None;
1039*0b57cec5SDimitry Andric     case 1: return GlobalVariable::UnnamedAddr::Global;
1040*0b57cec5SDimitry Andric     case 2: return GlobalVariable::UnnamedAddr::Local;
1041*0b57cec5SDimitry Andric   }
1042*0b57cec5SDimitry Andric }
1043*0b57cec5SDimitry Andric 
1044*0b57cec5SDimitry Andric static int getDecodedCastOpcode(unsigned Val) {
1045*0b57cec5SDimitry Andric   switch (Val) {
1046*0b57cec5SDimitry Andric   default: return -1;
1047*0b57cec5SDimitry Andric   case bitc::CAST_TRUNC   : return Instruction::Trunc;
1048*0b57cec5SDimitry Andric   case bitc::CAST_ZEXT    : return Instruction::ZExt;
1049*0b57cec5SDimitry Andric   case bitc::CAST_SEXT    : return Instruction::SExt;
1050*0b57cec5SDimitry Andric   case bitc::CAST_FPTOUI  : return Instruction::FPToUI;
1051*0b57cec5SDimitry Andric   case bitc::CAST_FPTOSI  : return Instruction::FPToSI;
1052*0b57cec5SDimitry Andric   case bitc::CAST_UITOFP  : return Instruction::UIToFP;
1053*0b57cec5SDimitry Andric   case bitc::CAST_SITOFP  : return Instruction::SIToFP;
1054*0b57cec5SDimitry Andric   case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
1055*0b57cec5SDimitry Andric   case bitc::CAST_FPEXT   : return Instruction::FPExt;
1056*0b57cec5SDimitry Andric   case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
1057*0b57cec5SDimitry Andric   case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
1058*0b57cec5SDimitry Andric   case bitc::CAST_BITCAST : return Instruction::BitCast;
1059*0b57cec5SDimitry Andric   case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
1060*0b57cec5SDimitry Andric   }
1061*0b57cec5SDimitry Andric }
1062*0b57cec5SDimitry Andric 
1063*0b57cec5SDimitry Andric static int getDecodedUnaryOpcode(unsigned Val, Type *Ty) {
1064*0b57cec5SDimitry Andric   bool IsFP = Ty->isFPOrFPVectorTy();
1065*0b57cec5SDimitry Andric   // UnOps are only valid for int/fp or vector of int/fp types
1066*0b57cec5SDimitry Andric   if (!IsFP && !Ty->isIntOrIntVectorTy())
1067*0b57cec5SDimitry Andric     return -1;
1068*0b57cec5SDimitry Andric 
1069*0b57cec5SDimitry Andric   switch (Val) {
1070*0b57cec5SDimitry Andric   default:
1071*0b57cec5SDimitry Andric     return -1;
10728bcb0991SDimitry Andric   case bitc::UNOP_FNEG:
1073*0b57cec5SDimitry Andric     return IsFP ? Instruction::FNeg : -1;
1074*0b57cec5SDimitry Andric   }
1075*0b57cec5SDimitry Andric }
1076*0b57cec5SDimitry Andric 
1077*0b57cec5SDimitry Andric static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
1078*0b57cec5SDimitry Andric   bool IsFP = Ty->isFPOrFPVectorTy();
1079*0b57cec5SDimitry Andric   // BinOps are only valid for int/fp or vector of int/fp types
1080*0b57cec5SDimitry Andric   if (!IsFP && !Ty->isIntOrIntVectorTy())
1081*0b57cec5SDimitry Andric     return -1;
1082*0b57cec5SDimitry Andric 
1083*0b57cec5SDimitry Andric   switch (Val) {
1084*0b57cec5SDimitry Andric   default:
1085*0b57cec5SDimitry Andric     return -1;
1086*0b57cec5SDimitry Andric   case bitc::BINOP_ADD:
1087*0b57cec5SDimitry Andric     return IsFP ? Instruction::FAdd : Instruction::Add;
1088*0b57cec5SDimitry Andric   case bitc::BINOP_SUB:
1089*0b57cec5SDimitry Andric     return IsFP ? Instruction::FSub : Instruction::Sub;
1090*0b57cec5SDimitry Andric   case bitc::BINOP_MUL:
1091*0b57cec5SDimitry Andric     return IsFP ? Instruction::FMul : Instruction::Mul;
1092*0b57cec5SDimitry Andric   case bitc::BINOP_UDIV:
1093*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::UDiv;
1094*0b57cec5SDimitry Andric   case bitc::BINOP_SDIV:
1095*0b57cec5SDimitry Andric     return IsFP ? Instruction::FDiv : Instruction::SDiv;
1096*0b57cec5SDimitry Andric   case bitc::BINOP_UREM:
1097*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::URem;
1098*0b57cec5SDimitry Andric   case bitc::BINOP_SREM:
1099*0b57cec5SDimitry Andric     return IsFP ? Instruction::FRem : Instruction::SRem;
1100*0b57cec5SDimitry Andric   case bitc::BINOP_SHL:
1101*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::Shl;
1102*0b57cec5SDimitry Andric   case bitc::BINOP_LSHR:
1103*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::LShr;
1104*0b57cec5SDimitry Andric   case bitc::BINOP_ASHR:
1105*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::AShr;
1106*0b57cec5SDimitry Andric   case bitc::BINOP_AND:
1107*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::And;
1108*0b57cec5SDimitry Andric   case bitc::BINOP_OR:
1109*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::Or;
1110*0b57cec5SDimitry Andric   case bitc::BINOP_XOR:
1111*0b57cec5SDimitry Andric     return IsFP ? -1 : Instruction::Xor;
1112*0b57cec5SDimitry Andric   }
1113*0b57cec5SDimitry Andric }
1114*0b57cec5SDimitry Andric 
1115*0b57cec5SDimitry Andric static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {
1116*0b57cec5SDimitry Andric   switch (Val) {
1117*0b57cec5SDimitry Andric   default: return AtomicRMWInst::BAD_BINOP;
1118*0b57cec5SDimitry Andric   case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
1119*0b57cec5SDimitry Andric   case bitc::RMW_ADD: return AtomicRMWInst::Add;
1120*0b57cec5SDimitry Andric   case bitc::RMW_SUB: return AtomicRMWInst::Sub;
1121*0b57cec5SDimitry Andric   case bitc::RMW_AND: return AtomicRMWInst::And;
1122*0b57cec5SDimitry Andric   case bitc::RMW_NAND: return AtomicRMWInst::Nand;
1123*0b57cec5SDimitry Andric   case bitc::RMW_OR: return AtomicRMWInst::Or;
1124*0b57cec5SDimitry Andric   case bitc::RMW_XOR: return AtomicRMWInst::Xor;
1125*0b57cec5SDimitry Andric   case bitc::RMW_MAX: return AtomicRMWInst::Max;
1126*0b57cec5SDimitry Andric   case bitc::RMW_MIN: return AtomicRMWInst::Min;
1127*0b57cec5SDimitry Andric   case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
1128*0b57cec5SDimitry Andric   case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
1129*0b57cec5SDimitry Andric   case bitc::RMW_FADD: return AtomicRMWInst::FAdd;
1130*0b57cec5SDimitry Andric   case bitc::RMW_FSUB: return AtomicRMWInst::FSub;
1131*0b57cec5SDimitry Andric   }
1132*0b57cec5SDimitry Andric }
1133*0b57cec5SDimitry Andric 
1134*0b57cec5SDimitry Andric static AtomicOrdering getDecodedOrdering(unsigned Val) {
1135*0b57cec5SDimitry Andric   switch (Val) {
1136*0b57cec5SDimitry Andric   case bitc::ORDERING_NOTATOMIC: return AtomicOrdering::NotAtomic;
1137*0b57cec5SDimitry Andric   case bitc::ORDERING_UNORDERED: return AtomicOrdering::Unordered;
1138*0b57cec5SDimitry Andric   case bitc::ORDERING_MONOTONIC: return AtomicOrdering::Monotonic;
1139*0b57cec5SDimitry Andric   case bitc::ORDERING_ACQUIRE: return AtomicOrdering::Acquire;
1140*0b57cec5SDimitry Andric   case bitc::ORDERING_RELEASE: return AtomicOrdering::Release;
1141*0b57cec5SDimitry Andric   case bitc::ORDERING_ACQREL: return AtomicOrdering::AcquireRelease;
1142*0b57cec5SDimitry Andric   default: // Map unknown orderings to sequentially-consistent.
1143*0b57cec5SDimitry Andric   case bitc::ORDERING_SEQCST: return AtomicOrdering::SequentiallyConsistent;
1144*0b57cec5SDimitry Andric   }
1145*0b57cec5SDimitry Andric }
1146*0b57cec5SDimitry Andric 
1147*0b57cec5SDimitry Andric static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
1148*0b57cec5SDimitry Andric   switch (Val) {
1149*0b57cec5SDimitry Andric   default: // Map unknown selection kinds to any.
1150*0b57cec5SDimitry Andric   case bitc::COMDAT_SELECTION_KIND_ANY:
1151*0b57cec5SDimitry Andric     return Comdat::Any;
1152*0b57cec5SDimitry Andric   case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
1153*0b57cec5SDimitry Andric     return Comdat::ExactMatch;
1154*0b57cec5SDimitry Andric   case bitc::COMDAT_SELECTION_KIND_LARGEST:
1155*0b57cec5SDimitry Andric     return Comdat::Largest;
1156*0b57cec5SDimitry Andric   case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
1157*0b57cec5SDimitry Andric     return Comdat::NoDuplicates;
1158*0b57cec5SDimitry Andric   case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
1159*0b57cec5SDimitry Andric     return Comdat::SameSize;
1160*0b57cec5SDimitry Andric   }
1161*0b57cec5SDimitry Andric }
1162*0b57cec5SDimitry Andric 
1163*0b57cec5SDimitry Andric static FastMathFlags getDecodedFastMathFlags(unsigned Val) {
1164*0b57cec5SDimitry Andric   FastMathFlags FMF;
1165*0b57cec5SDimitry Andric   if (0 != (Val & bitc::UnsafeAlgebra))
1166*0b57cec5SDimitry Andric     FMF.setFast();
1167*0b57cec5SDimitry Andric   if (0 != (Val & bitc::AllowReassoc))
1168*0b57cec5SDimitry Andric     FMF.setAllowReassoc();
1169*0b57cec5SDimitry Andric   if (0 != (Val & bitc::NoNaNs))
1170*0b57cec5SDimitry Andric     FMF.setNoNaNs();
1171*0b57cec5SDimitry Andric   if (0 != (Val & bitc::NoInfs))
1172*0b57cec5SDimitry Andric     FMF.setNoInfs();
1173*0b57cec5SDimitry Andric   if (0 != (Val & bitc::NoSignedZeros))
1174*0b57cec5SDimitry Andric     FMF.setNoSignedZeros();
1175*0b57cec5SDimitry Andric   if (0 != (Val & bitc::AllowReciprocal))
1176*0b57cec5SDimitry Andric     FMF.setAllowReciprocal();
1177*0b57cec5SDimitry Andric   if (0 != (Val & bitc::AllowContract))
1178*0b57cec5SDimitry Andric     FMF.setAllowContract(true);
1179*0b57cec5SDimitry Andric   if (0 != (Val & bitc::ApproxFunc))
1180*0b57cec5SDimitry Andric     FMF.setApproxFunc();
1181*0b57cec5SDimitry Andric   return FMF;
1182*0b57cec5SDimitry Andric }
1183*0b57cec5SDimitry Andric 
1184*0b57cec5SDimitry Andric static void upgradeDLLImportExportLinkage(GlobalValue *GV, unsigned Val) {
1185*0b57cec5SDimitry Andric   switch (Val) {
1186*0b57cec5SDimitry Andric   case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
1187*0b57cec5SDimitry Andric   case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
1188*0b57cec5SDimitry Andric   }
1189*0b57cec5SDimitry Andric }
1190*0b57cec5SDimitry Andric 
1191*0b57cec5SDimitry Andric Type *BitcodeReader::getFullyStructuredTypeByID(unsigned ID) {
1192*0b57cec5SDimitry Andric   // The type table size is always specified correctly.
1193*0b57cec5SDimitry Andric   if (ID >= TypeList.size())
1194*0b57cec5SDimitry Andric     return nullptr;
1195*0b57cec5SDimitry Andric 
1196*0b57cec5SDimitry Andric   if (Type *Ty = TypeList[ID])
1197*0b57cec5SDimitry Andric     return Ty;
1198*0b57cec5SDimitry Andric 
1199*0b57cec5SDimitry Andric   // If we have a forward reference, the only possible case is when it is to a
1200*0b57cec5SDimitry Andric   // named struct.  Just create a placeholder for now.
1201*0b57cec5SDimitry Andric   return TypeList[ID] = createIdentifiedStructType(Context);
1202*0b57cec5SDimitry Andric }
1203*0b57cec5SDimitry Andric 
1204*0b57cec5SDimitry Andric StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
1205*0b57cec5SDimitry Andric                                                       StringRef Name) {
1206*0b57cec5SDimitry Andric   auto *Ret = StructType::create(Context, Name);
1207*0b57cec5SDimitry Andric   IdentifiedStructTypes.push_back(Ret);
1208*0b57cec5SDimitry Andric   return Ret;
1209*0b57cec5SDimitry Andric }
1210*0b57cec5SDimitry Andric 
1211*0b57cec5SDimitry Andric StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
1212*0b57cec5SDimitry Andric   auto *Ret = StructType::create(Context);
1213*0b57cec5SDimitry Andric   IdentifiedStructTypes.push_back(Ret);
1214*0b57cec5SDimitry Andric   return Ret;
1215*0b57cec5SDimitry Andric }
1216*0b57cec5SDimitry Andric 
1217*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
1218*0b57cec5SDimitry Andric //  Functions for parsing blocks from the bitcode file
1219*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
1220*0b57cec5SDimitry Andric 
1221*0b57cec5SDimitry Andric static uint64_t getRawAttributeMask(Attribute::AttrKind Val) {
1222*0b57cec5SDimitry Andric   switch (Val) {
1223*0b57cec5SDimitry Andric   case Attribute::EndAttrKinds:
12245ffd83dbSDimitry Andric   case Attribute::EmptyKey:
12255ffd83dbSDimitry Andric   case Attribute::TombstoneKey:
1226*0b57cec5SDimitry Andric     llvm_unreachable("Synthetic enumerators which should never get here");
1227*0b57cec5SDimitry Andric 
1228*0b57cec5SDimitry Andric   case Attribute::None:            return 0;
1229*0b57cec5SDimitry Andric   case Attribute::ZExt:            return 1 << 0;
1230*0b57cec5SDimitry Andric   case Attribute::SExt:            return 1 << 1;
1231*0b57cec5SDimitry Andric   case Attribute::NoReturn:        return 1 << 2;
1232*0b57cec5SDimitry Andric   case Attribute::InReg:           return 1 << 3;
1233*0b57cec5SDimitry Andric   case Attribute::StructRet:       return 1 << 4;
1234*0b57cec5SDimitry Andric   case Attribute::NoUnwind:        return 1 << 5;
1235*0b57cec5SDimitry Andric   case Attribute::NoAlias:         return 1 << 6;
1236*0b57cec5SDimitry Andric   case Attribute::ByVal:           return 1 << 7;
1237*0b57cec5SDimitry Andric   case Attribute::Nest:            return 1 << 8;
1238*0b57cec5SDimitry Andric   case Attribute::ReadNone:        return 1 << 9;
1239*0b57cec5SDimitry Andric   case Attribute::ReadOnly:        return 1 << 10;
1240*0b57cec5SDimitry Andric   case Attribute::NoInline:        return 1 << 11;
1241*0b57cec5SDimitry Andric   case Attribute::AlwaysInline:    return 1 << 12;
1242*0b57cec5SDimitry Andric   case Attribute::OptimizeForSize: return 1 << 13;
1243*0b57cec5SDimitry Andric   case Attribute::StackProtect:    return 1 << 14;
1244*0b57cec5SDimitry Andric   case Attribute::StackProtectReq: return 1 << 15;
1245*0b57cec5SDimitry Andric   case Attribute::Alignment:       return 31 << 16;
1246*0b57cec5SDimitry Andric   case Attribute::NoCapture:       return 1 << 21;
1247*0b57cec5SDimitry Andric   case Attribute::NoRedZone:       return 1 << 22;
1248*0b57cec5SDimitry Andric   case Attribute::NoImplicitFloat: return 1 << 23;
1249*0b57cec5SDimitry Andric   case Attribute::Naked:           return 1 << 24;
1250*0b57cec5SDimitry Andric   case Attribute::InlineHint:      return 1 << 25;
1251*0b57cec5SDimitry Andric   case Attribute::StackAlignment:  return 7 << 26;
1252*0b57cec5SDimitry Andric   case Attribute::ReturnsTwice:    return 1 << 29;
1253*0b57cec5SDimitry Andric   case Attribute::UWTable:         return 1 << 30;
1254*0b57cec5SDimitry Andric   case Attribute::NonLazyBind:     return 1U << 31;
1255*0b57cec5SDimitry Andric   case Attribute::SanitizeAddress: return 1ULL << 32;
1256*0b57cec5SDimitry Andric   case Attribute::MinSize:         return 1ULL << 33;
1257*0b57cec5SDimitry Andric   case Attribute::NoDuplicate:     return 1ULL << 34;
1258*0b57cec5SDimitry Andric   case Attribute::StackProtectStrong: return 1ULL << 35;
1259*0b57cec5SDimitry Andric   case Attribute::SanitizeThread:  return 1ULL << 36;
1260*0b57cec5SDimitry Andric   case Attribute::SanitizeMemory:  return 1ULL << 37;
1261*0b57cec5SDimitry Andric   case Attribute::NoBuiltin:       return 1ULL << 38;
1262*0b57cec5SDimitry Andric   case Attribute::Returned:        return 1ULL << 39;
1263*0b57cec5SDimitry Andric   case Attribute::Cold:            return 1ULL << 40;
1264*0b57cec5SDimitry Andric   case Attribute::Builtin:         return 1ULL << 41;
1265*0b57cec5SDimitry Andric   case Attribute::OptimizeNone:    return 1ULL << 42;
1266*0b57cec5SDimitry Andric   case Attribute::InAlloca:        return 1ULL << 43;
1267*0b57cec5SDimitry Andric   case Attribute::NonNull:         return 1ULL << 44;
1268*0b57cec5SDimitry Andric   case Attribute::JumpTable:       return 1ULL << 45;
1269*0b57cec5SDimitry Andric   case Attribute::Convergent:      return 1ULL << 46;
1270*0b57cec5SDimitry Andric   case Attribute::SafeStack:       return 1ULL << 47;
1271*0b57cec5SDimitry Andric   case Attribute::NoRecurse:       return 1ULL << 48;
1272*0b57cec5SDimitry Andric   case Attribute::InaccessibleMemOnly:         return 1ULL << 49;
1273*0b57cec5SDimitry Andric   case Attribute::InaccessibleMemOrArgMemOnly: return 1ULL << 50;
1274*0b57cec5SDimitry Andric   case Attribute::SwiftSelf:       return 1ULL << 51;
1275*0b57cec5SDimitry Andric   case Attribute::SwiftError:      return 1ULL << 52;
1276*0b57cec5SDimitry Andric   case Attribute::WriteOnly:       return 1ULL << 53;
1277*0b57cec5SDimitry Andric   case Attribute::Speculatable:    return 1ULL << 54;
1278*0b57cec5SDimitry Andric   case Attribute::StrictFP:        return 1ULL << 55;
1279*0b57cec5SDimitry Andric   case Attribute::SanitizeHWAddress: return 1ULL << 56;
1280*0b57cec5SDimitry Andric   case Attribute::NoCfCheck:       return 1ULL << 57;
1281*0b57cec5SDimitry Andric   case Attribute::OptForFuzzing:   return 1ULL << 58;
1282*0b57cec5SDimitry Andric   case Attribute::ShadowCallStack: return 1ULL << 59;
1283*0b57cec5SDimitry Andric   case Attribute::SpeculativeLoadHardening:
1284*0b57cec5SDimitry Andric     return 1ULL << 60;
1285*0b57cec5SDimitry Andric   case Attribute::ImmArg:
1286*0b57cec5SDimitry Andric     return 1ULL << 61;
1287*0b57cec5SDimitry Andric   case Attribute::WillReturn:
1288*0b57cec5SDimitry Andric     return 1ULL << 62;
1289*0b57cec5SDimitry Andric   case Attribute::NoFree:
1290*0b57cec5SDimitry Andric     return 1ULL << 63;
12915ffd83dbSDimitry Andric   default:
12925ffd83dbSDimitry Andric     // Other attributes are not supported in the raw format,
12935ffd83dbSDimitry Andric     // as we ran out of space.
12945ffd83dbSDimitry Andric     return 0;
1295*0b57cec5SDimitry Andric   }
1296*0b57cec5SDimitry Andric   llvm_unreachable("Unsupported attribute type");
1297*0b57cec5SDimitry Andric }
1298*0b57cec5SDimitry Andric 
1299*0b57cec5SDimitry Andric static void addRawAttributeValue(AttrBuilder &B, uint64_t Val) {
1300*0b57cec5SDimitry Andric   if (!Val) return;
1301*0b57cec5SDimitry Andric 
1302*0b57cec5SDimitry Andric   for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1303*0b57cec5SDimitry Andric        I = Attribute::AttrKind(I + 1)) {
1304*0b57cec5SDimitry Andric     if (uint64_t A = (Val & getRawAttributeMask(I))) {
1305*0b57cec5SDimitry Andric       if (I == Attribute::Alignment)
1306*0b57cec5SDimitry Andric         B.addAlignmentAttr(1ULL << ((A >> 16) - 1));
1307*0b57cec5SDimitry Andric       else if (I == Attribute::StackAlignment)
1308*0b57cec5SDimitry Andric         B.addStackAlignmentAttr(1ULL << ((A >> 26)-1));
1309*0b57cec5SDimitry Andric       else
1310*0b57cec5SDimitry Andric         B.addAttribute(I);
1311*0b57cec5SDimitry Andric     }
1312*0b57cec5SDimitry Andric   }
1313*0b57cec5SDimitry Andric }
1314*0b57cec5SDimitry Andric 
1315*0b57cec5SDimitry Andric /// This fills an AttrBuilder object with the LLVM attributes that have
1316*0b57cec5SDimitry Andric /// been decoded from the given integer. This function must stay in sync with
1317*0b57cec5SDimitry Andric /// 'encodeLLVMAttributesForBitcode'.
1318*0b57cec5SDimitry Andric static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1319*0b57cec5SDimitry Andric                                            uint64_t EncodedAttrs) {
1320*0b57cec5SDimitry Andric   // The alignment is stored as a 16-bit raw value from bits 31--16.  We shift
1321*0b57cec5SDimitry Andric   // the bits above 31 down by 11 bits.
1322*0b57cec5SDimitry Andric   unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1323*0b57cec5SDimitry Andric   assert((!Alignment || isPowerOf2_32(Alignment)) &&
1324*0b57cec5SDimitry Andric          "Alignment must be a power of two.");
1325*0b57cec5SDimitry Andric 
1326*0b57cec5SDimitry Andric   if (Alignment)
1327*0b57cec5SDimitry Andric     B.addAlignmentAttr(Alignment);
1328*0b57cec5SDimitry Andric   addRawAttributeValue(B, ((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1329*0b57cec5SDimitry Andric                           (EncodedAttrs & 0xffff));
1330*0b57cec5SDimitry Andric }
1331*0b57cec5SDimitry Andric 
1332*0b57cec5SDimitry Andric Error BitcodeReader::parseAttributeBlock() {
1333*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
1334*0b57cec5SDimitry Andric     return Err;
1335*0b57cec5SDimitry Andric 
1336*0b57cec5SDimitry Andric   if (!MAttributes.empty())
1337*0b57cec5SDimitry Andric     return error("Invalid multiple blocks");
1338*0b57cec5SDimitry Andric 
1339*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
1340*0b57cec5SDimitry Andric 
1341*0b57cec5SDimitry Andric   SmallVector<AttributeList, 8> Attrs;
1342*0b57cec5SDimitry Andric 
1343*0b57cec5SDimitry Andric   // Read all the records.
1344*0b57cec5SDimitry Andric   while (true) {
1345*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
1346*0b57cec5SDimitry Andric     if (!MaybeEntry)
1347*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
1348*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
1349*0b57cec5SDimitry Andric 
1350*0b57cec5SDimitry Andric     switch (Entry.Kind) {
1351*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1352*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
1353*0b57cec5SDimitry Andric       return error("Malformed block");
1354*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
1355*0b57cec5SDimitry Andric       return Error::success();
1356*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
1357*0b57cec5SDimitry Andric       // The interesting case.
1358*0b57cec5SDimitry Andric       break;
1359*0b57cec5SDimitry Andric     }
1360*0b57cec5SDimitry Andric 
1361*0b57cec5SDimitry Andric     // Read a record.
1362*0b57cec5SDimitry Andric     Record.clear();
1363*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
1364*0b57cec5SDimitry Andric     if (!MaybeRecord)
1365*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
1366*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
1367*0b57cec5SDimitry Andric     default:  // Default behavior: ignore.
1368*0b57cec5SDimitry Andric       break;
1369*0b57cec5SDimitry Andric     case bitc::PARAMATTR_CODE_ENTRY_OLD: // ENTRY: [paramidx0, attr0, ...]
13705ffd83dbSDimitry Andric       // Deprecated, but still needed to read old bitcode files.
1371*0b57cec5SDimitry Andric       if (Record.size() & 1)
1372*0b57cec5SDimitry Andric         return error("Invalid record");
1373*0b57cec5SDimitry Andric 
1374*0b57cec5SDimitry Andric       for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1375*0b57cec5SDimitry Andric         AttrBuilder B;
1376*0b57cec5SDimitry Andric         decodeLLVMAttributesForBitcode(B, Record[i+1]);
1377*0b57cec5SDimitry Andric         Attrs.push_back(AttributeList::get(Context, Record[i], B));
1378*0b57cec5SDimitry Andric       }
1379*0b57cec5SDimitry Andric 
1380*0b57cec5SDimitry Andric       MAttributes.push_back(AttributeList::get(Context, Attrs));
1381*0b57cec5SDimitry Andric       Attrs.clear();
1382*0b57cec5SDimitry Andric       break;
1383*0b57cec5SDimitry Andric     case bitc::PARAMATTR_CODE_ENTRY: // ENTRY: [attrgrp0, attrgrp1, ...]
1384*0b57cec5SDimitry Andric       for (unsigned i = 0, e = Record.size(); i != e; ++i)
1385*0b57cec5SDimitry Andric         Attrs.push_back(MAttributeGroups[Record[i]]);
1386*0b57cec5SDimitry Andric 
1387*0b57cec5SDimitry Andric       MAttributes.push_back(AttributeList::get(Context, Attrs));
1388*0b57cec5SDimitry Andric       Attrs.clear();
1389*0b57cec5SDimitry Andric       break;
1390*0b57cec5SDimitry Andric     }
1391*0b57cec5SDimitry Andric   }
1392*0b57cec5SDimitry Andric }
1393*0b57cec5SDimitry Andric 
1394*0b57cec5SDimitry Andric // Returns Attribute::None on unrecognized codes.
1395*0b57cec5SDimitry Andric static Attribute::AttrKind getAttrFromCode(uint64_t Code) {
1396*0b57cec5SDimitry Andric   switch (Code) {
1397*0b57cec5SDimitry Andric   default:
1398*0b57cec5SDimitry Andric     return Attribute::None;
1399*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_ALIGNMENT:
1400*0b57cec5SDimitry Andric     return Attribute::Alignment;
1401*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_ALWAYS_INLINE:
1402*0b57cec5SDimitry Andric     return Attribute::AlwaysInline;
1403*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_ARGMEMONLY:
1404*0b57cec5SDimitry Andric     return Attribute::ArgMemOnly;
1405*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_BUILTIN:
1406*0b57cec5SDimitry Andric     return Attribute::Builtin;
1407*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_BY_VAL:
1408*0b57cec5SDimitry Andric     return Attribute::ByVal;
1409*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_IN_ALLOCA:
1410*0b57cec5SDimitry Andric     return Attribute::InAlloca;
1411*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_COLD:
1412*0b57cec5SDimitry Andric     return Attribute::Cold;
1413*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_CONVERGENT:
1414*0b57cec5SDimitry Andric     return Attribute::Convergent;
1415*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY:
1416*0b57cec5SDimitry Andric     return Attribute::InaccessibleMemOnly;
1417*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY:
1418*0b57cec5SDimitry Andric     return Attribute::InaccessibleMemOrArgMemOnly;
1419*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_INLINE_HINT:
1420*0b57cec5SDimitry Andric     return Attribute::InlineHint;
1421*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_IN_REG:
1422*0b57cec5SDimitry Andric     return Attribute::InReg;
1423*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_JUMP_TABLE:
1424*0b57cec5SDimitry Andric     return Attribute::JumpTable;
1425*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_MIN_SIZE:
1426*0b57cec5SDimitry Andric     return Attribute::MinSize;
1427*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NAKED:
1428*0b57cec5SDimitry Andric     return Attribute::Naked;
1429*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NEST:
1430*0b57cec5SDimitry Andric     return Attribute::Nest;
1431*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_ALIAS:
1432*0b57cec5SDimitry Andric     return Attribute::NoAlias;
1433*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_BUILTIN:
1434*0b57cec5SDimitry Andric     return Attribute::NoBuiltin;
1435*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_CAPTURE:
1436*0b57cec5SDimitry Andric     return Attribute::NoCapture;
1437*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_DUPLICATE:
1438*0b57cec5SDimitry Andric     return Attribute::NoDuplicate;
1439*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NOFREE:
1440*0b57cec5SDimitry Andric     return Attribute::NoFree;
1441*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1442*0b57cec5SDimitry Andric     return Attribute::NoImplicitFloat;
1443*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_INLINE:
1444*0b57cec5SDimitry Andric     return Attribute::NoInline;
1445*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_RECURSE:
1446*0b57cec5SDimitry Andric     return Attribute::NoRecurse;
14475ffd83dbSDimitry Andric   case bitc::ATTR_KIND_NO_MERGE:
14485ffd83dbSDimitry Andric     return Attribute::NoMerge;
1449*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NON_LAZY_BIND:
1450*0b57cec5SDimitry Andric     return Attribute::NonLazyBind;
1451*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NON_NULL:
1452*0b57cec5SDimitry Andric     return Attribute::NonNull;
1453*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_DEREFERENCEABLE:
1454*0b57cec5SDimitry Andric     return Attribute::Dereferenceable;
1455*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:
1456*0b57cec5SDimitry Andric     return Attribute::DereferenceableOrNull;
1457*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_ALLOC_SIZE:
1458*0b57cec5SDimitry Andric     return Attribute::AllocSize;
1459*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_RED_ZONE:
1460*0b57cec5SDimitry Andric     return Attribute::NoRedZone;
1461*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_RETURN:
1462*0b57cec5SDimitry Andric     return Attribute::NoReturn;
1463*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NOSYNC:
1464*0b57cec5SDimitry Andric     return Attribute::NoSync;
1465*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NOCF_CHECK:
1466*0b57cec5SDimitry Andric     return Attribute::NoCfCheck;
1467*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_NO_UNWIND:
1468*0b57cec5SDimitry Andric     return Attribute::NoUnwind;
14695ffd83dbSDimitry Andric   case bitc::ATTR_KIND_NULL_POINTER_IS_VALID:
14705ffd83dbSDimitry Andric     return Attribute::NullPointerIsValid;
1471*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_OPT_FOR_FUZZING:
1472*0b57cec5SDimitry Andric     return Attribute::OptForFuzzing;
1473*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1474*0b57cec5SDimitry Andric     return Attribute::OptimizeForSize;
1475*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_OPTIMIZE_NONE:
1476*0b57cec5SDimitry Andric     return Attribute::OptimizeNone;
1477*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_READ_NONE:
1478*0b57cec5SDimitry Andric     return Attribute::ReadNone;
1479*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_READ_ONLY:
1480*0b57cec5SDimitry Andric     return Attribute::ReadOnly;
1481*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_RETURNED:
1482*0b57cec5SDimitry Andric     return Attribute::Returned;
1483*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_RETURNS_TWICE:
1484*0b57cec5SDimitry Andric     return Attribute::ReturnsTwice;
1485*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_S_EXT:
1486*0b57cec5SDimitry Andric     return Attribute::SExt;
1487*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SPECULATABLE:
1488*0b57cec5SDimitry Andric     return Attribute::Speculatable;
1489*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_STACK_ALIGNMENT:
1490*0b57cec5SDimitry Andric     return Attribute::StackAlignment;
1491*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_STACK_PROTECT:
1492*0b57cec5SDimitry Andric     return Attribute::StackProtect;
1493*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1494*0b57cec5SDimitry Andric     return Attribute::StackProtectReq;
1495*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1496*0b57cec5SDimitry Andric     return Attribute::StackProtectStrong;
1497*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SAFESTACK:
1498*0b57cec5SDimitry Andric     return Attribute::SafeStack;
1499*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SHADOWCALLSTACK:
1500*0b57cec5SDimitry Andric     return Attribute::ShadowCallStack;
1501*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_STRICT_FP:
1502*0b57cec5SDimitry Andric     return Attribute::StrictFP;
1503*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_STRUCT_RET:
1504*0b57cec5SDimitry Andric     return Attribute::StructRet;
1505*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1506*0b57cec5SDimitry Andric     return Attribute::SanitizeAddress;
1507*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SANITIZE_HWADDRESS:
1508*0b57cec5SDimitry Andric     return Attribute::SanitizeHWAddress;
1509*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SANITIZE_THREAD:
1510*0b57cec5SDimitry Andric     return Attribute::SanitizeThread;
1511*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SANITIZE_MEMORY:
1512*0b57cec5SDimitry Andric     return Attribute::SanitizeMemory;
1513*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SPECULATIVE_LOAD_HARDENING:
1514*0b57cec5SDimitry Andric     return Attribute::SpeculativeLoadHardening;
1515*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SWIFT_ERROR:
1516*0b57cec5SDimitry Andric     return Attribute::SwiftError;
1517*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SWIFT_SELF:
1518*0b57cec5SDimitry Andric     return Attribute::SwiftSelf;
1519*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_UW_TABLE:
1520*0b57cec5SDimitry Andric     return Attribute::UWTable;
1521*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_WILLRETURN:
1522*0b57cec5SDimitry Andric     return Attribute::WillReturn;
1523*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_WRITEONLY:
1524*0b57cec5SDimitry Andric     return Attribute::WriteOnly;
1525*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_Z_EXT:
1526*0b57cec5SDimitry Andric     return Attribute::ZExt;
1527*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_IMMARG:
1528*0b57cec5SDimitry Andric     return Attribute::ImmArg;
1529*0b57cec5SDimitry Andric   case bitc::ATTR_KIND_SANITIZE_MEMTAG:
1530*0b57cec5SDimitry Andric     return Attribute::SanitizeMemTag;
15315ffd83dbSDimitry Andric   case bitc::ATTR_KIND_PREALLOCATED:
15325ffd83dbSDimitry Andric     return Attribute::Preallocated;
15335ffd83dbSDimitry Andric   case bitc::ATTR_KIND_NOUNDEF:
15345ffd83dbSDimitry Andric     return Attribute::NoUndef;
1535*0b57cec5SDimitry Andric   }
1536*0b57cec5SDimitry Andric }
1537*0b57cec5SDimitry Andric 
1538*0b57cec5SDimitry Andric Error BitcodeReader::parseAlignmentValue(uint64_t Exponent,
15398bcb0991SDimitry Andric                                          MaybeAlign &Alignment) {
1540*0b57cec5SDimitry Andric   // Note: Alignment in bitcode files is incremented by 1, so that zero
1541*0b57cec5SDimitry Andric   // can be used for default alignment.
1542*0b57cec5SDimitry Andric   if (Exponent > Value::MaxAlignmentExponent + 1)
1543*0b57cec5SDimitry Andric     return error("Invalid alignment value");
15448bcb0991SDimitry Andric   Alignment = decodeMaybeAlign(Exponent);
1545*0b57cec5SDimitry Andric   return Error::success();
1546*0b57cec5SDimitry Andric }
1547*0b57cec5SDimitry Andric 
1548*0b57cec5SDimitry Andric Error BitcodeReader::parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind) {
1549*0b57cec5SDimitry Andric   *Kind = getAttrFromCode(Code);
1550*0b57cec5SDimitry Andric   if (*Kind == Attribute::None)
1551*0b57cec5SDimitry Andric     return error("Unknown attribute kind (" + Twine(Code) + ")");
1552*0b57cec5SDimitry Andric   return Error::success();
1553*0b57cec5SDimitry Andric }
1554*0b57cec5SDimitry Andric 
1555*0b57cec5SDimitry Andric Error BitcodeReader::parseAttributeGroupBlock() {
1556*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
1557*0b57cec5SDimitry Andric     return Err;
1558*0b57cec5SDimitry Andric 
1559*0b57cec5SDimitry Andric   if (!MAttributeGroups.empty())
1560*0b57cec5SDimitry Andric     return error("Invalid multiple blocks");
1561*0b57cec5SDimitry Andric 
1562*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
1563*0b57cec5SDimitry Andric 
1564*0b57cec5SDimitry Andric   // Read all the records.
1565*0b57cec5SDimitry Andric   while (true) {
1566*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
1567*0b57cec5SDimitry Andric     if (!MaybeEntry)
1568*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
1569*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
1570*0b57cec5SDimitry Andric 
1571*0b57cec5SDimitry Andric     switch (Entry.Kind) {
1572*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1573*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
1574*0b57cec5SDimitry Andric       return error("Malformed block");
1575*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
1576*0b57cec5SDimitry Andric       return Error::success();
1577*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
1578*0b57cec5SDimitry Andric       // The interesting case.
1579*0b57cec5SDimitry Andric       break;
1580*0b57cec5SDimitry Andric     }
1581*0b57cec5SDimitry Andric 
1582*0b57cec5SDimitry Andric     // Read a record.
1583*0b57cec5SDimitry Andric     Record.clear();
1584*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
1585*0b57cec5SDimitry Andric     if (!MaybeRecord)
1586*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
1587*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
1588*0b57cec5SDimitry Andric     default:  // Default behavior: ignore.
1589*0b57cec5SDimitry Andric       break;
1590*0b57cec5SDimitry Andric     case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1591*0b57cec5SDimitry Andric       if (Record.size() < 3)
1592*0b57cec5SDimitry Andric         return error("Invalid record");
1593*0b57cec5SDimitry Andric 
1594*0b57cec5SDimitry Andric       uint64_t GrpID = Record[0];
1595*0b57cec5SDimitry Andric       uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1596*0b57cec5SDimitry Andric 
1597*0b57cec5SDimitry Andric       AttrBuilder B;
1598*0b57cec5SDimitry Andric       for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1599*0b57cec5SDimitry Andric         if (Record[i] == 0) {        // Enum attribute
1600*0b57cec5SDimitry Andric           Attribute::AttrKind Kind;
1601*0b57cec5SDimitry Andric           if (Error Err = parseAttrKind(Record[++i], &Kind))
1602*0b57cec5SDimitry Andric             return Err;
1603*0b57cec5SDimitry Andric 
1604*0b57cec5SDimitry Andric           // Upgrade old-style byval attribute to one with a type, even if it's
1605*0b57cec5SDimitry Andric           // nullptr. We will have to insert the real type when we associate
1606*0b57cec5SDimitry Andric           // this AttributeList with a function.
1607*0b57cec5SDimitry Andric           if (Kind == Attribute::ByVal)
1608*0b57cec5SDimitry Andric             B.addByValAttr(nullptr);
1609*0b57cec5SDimitry Andric 
1610*0b57cec5SDimitry Andric           B.addAttribute(Kind);
1611*0b57cec5SDimitry Andric         } else if (Record[i] == 1) { // Integer attribute
1612*0b57cec5SDimitry Andric           Attribute::AttrKind Kind;
1613*0b57cec5SDimitry Andric           if (Error Err = parseAttrKind(Record[++i], &Kind))
1614*0b57cec5SDimitry Andric             return Err;
1615*0b57cec5SDimitry Andric           if (Kind == Attribute::Alignment)
1616*0b57cec5SDimitry Andric             B.addAlignmentAttr(Record[++i]);
1617*0b57cec5SDimitry Andric           else if (Kind == Attribute::StackAlignment)
1618*0b57cec5SDimitry Andric             B.addStackAlignmentAttr(Record[++i]);
1619*0b57cec5SDimitry Andric           else if (Kind == Attribute::Dereferenceable)
1620*0b57cec5SDimitry Andric             B.addDereferenceableAttr(Record[++i]);
1621*0b57cec5SDimitry Andric           else if (Kind == Attribute::DereferenceableOrNull)
1622*0b57cec5SDimitry Andric             B.addDereferenceableOrNullAttr(Record[++i]);
1623*0b57cec5SDimitry Andric           else if (Kind == Attribute::AllocSize)
1624*0b57cec5SDimitry Andric             B.addAllocSizeAttrFromRawRepr(Record[++i]);
1625*0b57cec5SDimitry Andric         } else if (Record[i] == 3 || Record[i] == 4) { // String attribute
1626*0b57cec5SDimitry Andric           bool HasValue = (Record[i++] == 4);
1627*0b57cec5SDimitry Andric           SmallString<64> KindStr;
1628*0b57cec5SDimitry Andric           SmallString<64> ValStr;
1629*0b57cec5SDimitry Andric 
1630*0b57cec5SDimitry Andric           while (Record[i] != 0 && i != e)
1631*0b57cec5SDimitry Andric             KindStr += Record[i++];
1632*0b57cec5SDimitry Andric           assert(Record[i] == 0 && "Kind string not null terminated");
1633*0b57cec5SDimitry Andric 
1634*0b57cec5SDimitry Andric           if (HasValue) {
1635*0b57cec5SDimitry Andric             // Has a value associated with it.
1636*0b57cec5SDimitry Andric             ++i; // Skip the '0' that terminates the "kind" string.
1637*0b57cec5SDimitry Andric             while (Record[i] != 0 && i != e)
1638*0b57cec5SDimitry Andric               ValStr += Record[i++];
1639*0b57cec5SDimitry Andric             assert(Record[i] == 0 && "Value string not null terminated");
1640*0b57cec5SDimitry Andric           }
1641*0b57cec5SDimitry Andric 
1642*0b57cec5SDimitry Andric           B.addAttribute(KindStr.str(), ValStr.str());
1643*0b57cec5SDimitry Andric         } else {
1644*0b57cec5SDimitry Andric           assert((Record[i] == 5 || Record[i] == 6) &&
1645*0b57cec5SDimitry Andric                  "Invalid attribute group entry");
1646*0b57cec5SDimitry Andric           bool HasType = Record[i] == 6;
1647*0b57cec5SDimitry Andric           Attribute::AttrKind Kind;
1648*0b57cec5SDimitry Andric           if (Error Err = parseAttrKind(Record[++i], &Kind))
1649*0b57cec5SDimitry Andric             return Err;
16505ffd83dbSDimitry Andric           if (Kind == Attribute::ByVal) {
1651*0b57cec5SDimitry Andric             B.addByValAttr(HasType ? getTypeByID(Record[++i]) : nullptr);
16525ffd83dbSDimitry Andric           } else if (Kind == Attribute::Preallocated) {
16535ffd83dbSDimitry Andric             B.addPreallocatedAttr(getTypeByID(Record[++i]));
16545ffd83dbSDimitry Andric           }
1655*0b57cec5SDimitry Andric         }
1656*0b57cec5SDimitry Andric       }
1657*0b57cec5SDimitry Andric 
16585ffd83dbSDimitry Andric       UpgradeAttributes(B);
1659*0b57cec5SDimitry Andric       MAttributeGroups[GrpID] = AttributeList::get(Context, Idx, B);
1660*0b57cec5SDimitry Andric       break;
1661*0b57cec5SDimitry Andric     }
1662*0b57cec5SDimitry Andric     }
1663*0b57cec5SDimitry Andric   }
1664*0b57cec5SDimitry Andric }
1665*0b57cec5SDimitry Andric 
1666*0b57cec5SDimitry Andric Error BitcodeReader::parseTypeTable() {
1667*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
1668*0b57cec5SDimitry Andric     return Err;
1669*0b57cec5SDimitry Andric 
1670*0b57cec5SDimitry Andric   return parseTypeTableBody();
1671*0b57cec5SDimitry Andric }
1672*0b57cec5SDimitry Andric 
1673*0b57cec5SDimitry Andric Error BitcodeReader::parseTypeTableBody() {
1674*0b57cec5SDimitry Andric   if (!TypeList.empty())
1675*0b57cec5SDimitry Andric     return error("Invalid multiple blocks");
1676*0b57cec5SDimitry Andric 
1677*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
1678*0b57cec5SDimitry Andric   unsigned NumRecords = 0;
1679*0b57cec5SDimitry Andric 
1680*0b57cec5SDimitry Andric   SmallString<64> TypeName;
1681*0b57cec5SDimitry Andric 
1682*0b57cec5SDimitry Andric   // Read all the records for this type table.
1683*0b57cec5SDimitry Andric   while (true) {
1684*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
1685*0b57cec5SDimitry Andric     if (!MaybeEntry)
1686*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
1687*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
1688*0b57cec5SDimitry Andric 
1689*0b57cec5SDimitry Andric     switch (Entry.Kind) {
1690*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1691*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
1692*0b57cec5SDimitry Andric       return error("Malformed block");
1693*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
1694*0b57cec5SDimitry Andric       if (NumRecords != TypeList.size())
1695*0b57cec5SDimitry Andric         return error("Malformed block");
1696*0b57cec5SDimitry Andric       return Error::success();
1697*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
1698*0b57cec5SDimitry Andric       // The interesting case.
1699*0b57cec5SDimitry Andric       break;
1700*0b57cec5SDimitry Andric     }
1701*0b57cec5SDimitry Andric 
1702*0b57cec5SDimitry Andric     // Read a record.
1703*0b57cec5SDimitry Andric     Record.clear();
1704*0b57cec5SDimitry Andric     Type *ResultTy = nullptr;
1705*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
1706*0b57cec5SDimitry Andric     if (!MaybeRecord)
1707*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
1708*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
1709*0b57cec5SDimitry Andric     default:
1710*0b57cec5SDimitry Andric       return error("Invalid value");
1711*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1712*0b57cec5SDimitry Andric       // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1713*0b57cec5SDimitry Andric       // type list.  This allows us to reserve space.
1714*0b57cec5SDimitry Andric       if (Record.size() < 1)
1715*0b57cec5SDimitry Andric         return error("Invalid record");
1716*0b57cec5SDimitry Andric       TypeList.resize(Record[0]);
1717*0b57cec5SDimitry Andric       continue;
1718*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_VOID:      // VOID
1719*0b57cec5SDimitry Andric       ResultTy = Type::getVoidTy(Context);
1720*0b57cec5SDimitry Andric       break;
1721*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_HALF:     // HALF
1722*0b57cec5SDimitry Andric       ResultTy = Type::getHalfTy(Context);
1723*0b57cec5SDimitry Andric       break;
17245ffd83dbSDimitry Andric     case bitc::TYPE_CODE_BFLOAT:    // BFLOAT
17255ffd83dbSDimitry Andric       ResultTy = Type::getBFloatTy(Context);
17265ffd83dbSDimitry Andric       break;
1727*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_FLOAT:     // FLOAT
1728*0b57cec5SDimitry Andric       ResultTy = Type::getFloatTy(Context);
1729*0b57cec5SDimitry Andric       break;
1730*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_DOUBLE:    // DOUBLE
1731*0b57cec5SDimitry Andric       ResultTy = Type::getDoubleTy(Context);
1732*0b57cec5SDimitry Andric       break;
1733*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_X86_FP80:  // X86_FP80
1734*0b57cec5SDimitry Andric       ResultTy = Type::getX86_FP80Ty(Context);
1735*0b57cec5SDimitry Andric       break;
1736*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_FP128:     // FP128
1737*0b57cec5SDimitry Andric       ResultTy = Type::getFP128Ty(Context);
1738*0b57cec5SDimitry Andric       break;
1739*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
1740*0b57cec5SDimitry Andric       ResultTy = Type::getPPC_FP128Ty(Context);
1741*0b57cec5SDimitry Andric       break;
1742*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_LABEL:     // LABEL
1743*0b57cec5SDimitry Andric       ResultTy = Type::getLabelTy(Context);
1744*0b57cec5SDimitry Andric       break;
1745*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_METADATA:  // METADATA
1746*0b57cec5SDimitry Andric       ResultTy = Type::getMetadataTy(Context);
1747*0b57cec5SDimitry Andric       break;
1748*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_X86_MMX:   // X86_MMX
1749*0b57cec5SDimitry Andric       ResultTy = Type::getX86_MMXTy(Context);
1750*0b57cec5SDimitry Andric       break;
1751*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_TOKEN:     // TOKEN
1752*0b57cec5SDimitry Andric       ResultTy = Type::getTokenTy(Context);
1753*0b57cec5SDimitry Andric       break;
1754*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
1755*0b57cec5SDimitry Andric       if (Record.size() < 1)
1756*0b57cec5SDimitry Andric         return error("Invalid record");
1757*0b57cec5SDimitry Andric 
1758*0b57cec5SDimitry Andric       uint64_t NumBits = Record[0];
1759*0b57cec5SDimitry Andric       if (NumBits < IntegerType::MIN_INT_BITS ||
1760*0b57cec5SDimitry Andric           NumBits > IntegerType::MAX_INT_BITS)
1761*0b57cec5SDimitry Andric         return error("Bitwidth for integer type out of range");
1762*0b57cec5SDimitry Andric       ResultTy = IntegerType::get(Context, NumBits);
1763*0b57cec5SDimitry Andric       break;
1764*0b57cec5SDimitry Andric     }
1765*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
1766*0b57cec5SDimitry Andric                                     //          [pointee type, address space]
1767*0b57cec5SDimitry Andric       if (Record.size() < 1)
1768*0b57cec5SDimitry Andric         return error("Invalid record");
1769*0b57cec5SDimitry Andric       unsigned AddressSpace = 0;
1770*0b57cec5SDimitry Andric       if (Record.size() == 2)
1771*0b57cec5SDimitry Andric         AddressSpace = Record[1];
1772*0b57cec5SDimitry Andric       ResultTy = getTypeByID(Record[0]);
1773*0b57cec5SDimitry Andric       if (!ResultTy ||
1774*0b57cec5SDimitry Andric           !PointerType::isValidElementType(ResultTy))
1775*0b57cec5SDimitry Andric         return error("Invalid type");
1776*0b57cec5SDimitry Andric       ResultTy = PointerType::get(ResultTy, AddressSpace);
1777*0b57cec5SDimitry Andric       break;
1778*0b57cec5SDimitry Andric     }
1779*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_FUNCTION_OLD: {
17805ffd83dbSDimitry Andric       // Deprecated, but still needed to read old bitcode files.
1781*0b57cec5SDimitry Andric       // FUNCTION: [vararg, attrid, retty, paramty x N]
1782*0b57cec5SDimitry Andric       if (Record.size() < 3)
1783*0b57cec5SDimitry Andric         return error("Invalid record");
1784*0b57cec5SDimitry Andric       SmallVector<Type*, 8> ArgTys;
1785*0b57cec5SDimitry Andric       for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1786*0b57cec5SDimitry Andric         if (Type *T = getTypeByID(Record[i]))
1787*0b57cec5SDimitry Andric           ArgTys.push_back(T);
1788*0b57cec5SDimitry Andric         else
1789*0b57cec5SDimitry Andric           break;
1790*0b57cec5SDimitry Andric       }
1791*0b57cec5SDimitry Andric 
1792*0b57cec5SDimitry Andric       ResultTy = getTypeByID(Record[2]);
1793*0b57cec5SDimitry Andric       if (!ResultTy || ArgTys.size() < Record.size()-3)
1794*0b57cec5SDimitry Andric         return error("Invalid type");
1795*0b57cec5SDimitry Andric 
1796*0b57cec5SDimitry Andric       ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1797*0b57cec5SDimitry Andric       break;
1798*0b57cec5SDimitry Andric     }
1799*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_FUNCTION: {
1800*0b57cec5SDimitry Andric       // FUNCTION: [vararg, retty, paramty x N]
1801*0b57cec5SDimitry Andric       if (Record.size() < 2)
1802*0b57cec5SDimitry Andric         return error("Invalid record");
1803*0b57cec5SDimitry Andric       SmallVector<Type*, 8> ArgTys;
1804*0b57cec5SDimitry Andric       for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1805*0b57cec5SDimitry Andric         if (Type *T = getTypeByID(Record[i])) {
1806*0b57cec5SDimitry Andric           if (!FunctionType::isValidArgumentType(T))
1807*0b57cec5SDimitry Andric             return error("Invalid function argument type");
1808*0b57cec5SDimitry Andric           ArgTys.push_back(T);
1809*0b57cec5SDimitry Andric         }
1810*0b57cec5SDimitry Andric         else
1811*0b57cec5SDimitry Andric           break;
1812*0b57cec5SDimitry Andric       }
1813*0b57cec5SDimitry Andric 
1814*0b57cec5SDimitry Andric       ResultTy = getTypeByID(Record[1]);
1815*0b57cec5SDimitry Andric       if (!ResultTy || ArgTys.size() < Record.size()-2)
1816*0b57cec5SDimitry Andric         return error("Invalid type");
1817*0b57cec5SDimitry Andric 
1818*0b57cec5SDimitry Andric       ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1819*0b57cec5SDimitry Andric       break;
1820*0b57cec5SDimitry Andric     }
1821*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_STRUCT_ANON: {  // STRUCT: [ispacked, eltty x N]
1822*0b57cec5SDimitry Andric       if (Record.size() < 1)
1823*0b57cec5SDimitry Andric         return error("Invalid record");
1824*0b57cec5SDimitry Andric       SmallVector<Type*, 8> EltTys;
1825*0b57cec5SDimitry Andric       for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1826*0b57cec5SDimitry Andric         if (Type *T = getTypeByID(Record[i]))
1827*0b57cec5SDimitry Andric           EltTys.push_back(T);
1828*0b57cec5SDimitry Andric         else
1829*0b57cec5SDimitry Andric           break;
1830*0b57cec5SDimitry Andric       }
1831*0b57cec5SDimitry Andric       if (EltTys.size() != Record.size()-1)
1832*0b57cec5SDimitry Andric         return error("Invalid type");
1833*0b57cec5SDimitry Andric       ResultTy = StructType::get(Context, EltTys, Record[0]);
1834*0b57cec5SDimitry Andric       break;
1835*0b57cec5SDimitry Andric     }
1836*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_STRUCT_NAME:   // STRUCT_NAME: [strchr x N]
1837*0b57cec5SDimitry Andric       if (convertToString(Record, 0, TypeName))
1838*0b57cec5SDimitry Andric         return error("Invalid record");
1839*0b57cec5SDimitry Andric       continue;
1840*0b57cec5SDimitry Andric 
1841*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1842*0b57cec5SDimitry Andric       if (Record.size() < 1)
1843*0b57cec5SDimitry Andric         return error("Invalid record");
1844*0b57cec5SDimitry Andric 
1845*0b57cec5SDimitry Andric       if (NumRecords >= TypeList.size())
1846*0b57cec5SDimitry Andric         return error("Invalid TYPE table");
1847*0b57cec5SDimitry Andric 
1848*0b57cec5SDimitry Andric       // Check to see if this was forward referenced, if so fill in the temp.
1849*0b57cec5SDimitry Andric       StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1850*0b57cec5SDimitry Andric       if (Res) {
1851*0b57cec5SDimitry Andric         Res->setName(TypeName);
1852*0b57cec5SDimitry Andric         TypeList[NumRecords] = nullptr;
1853*0b57cec5SDimitry Andric       } else  // Otherwise, create a new struct.
1854*0b57cec5SDimitry Andric         Res = createIdentifiedStructType(Context, TypeName);
1855*0b57cec5SDimitry Andric       TypeName.clear();
1856*0b57cec5SDimitry Andric 
1857*0b57cec5SDimitry Andric       SmallVector<Type*, 8> EltTys;
1858*0b57cec5SDimitry Andric       for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1859*0b57cec5SDimitry Andric         if (Type *T = getTypeByID(Record[i]))
1860*0b57cec5SDimitry Andric           EltTys.push_back(T);
1861*0b57cec5SDimitry Andric         else
1862*0b57cec5SDimitry Andric           break;
1863*0b57cec5SDimitry Andric       }
1864*0b57cec5SDimitry Andric       if (EltTys.size() != Record.size()-1)
1865*0b57cec5SDimitry Andric         return error("Invalid record");
1866*0b57cec5SDimitry Andric       Res->setBody(EltTys, Record[0]);
1867*0b57cec5SDimitry Andric       ResultTy = Res;
1868*0b57cec5SDimitry Andric       break;
1869*0b57cec5SDimitry Andric     }
1870*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_OPAQUE: {       // OPAQUE: []
1871*0b57cec5SDimitry Andric       if (Record.size() != 1)
1872*0b57cec5SDimitry Andric         return error("Invalid record");
1873*0b57cec5SDimitry Andric 
1874*0b57cec5SDimitry Andric       if (NumRecords >= TypeList.size())
1875*0b57cec5SDimitry Andric         return error("Invalid TYPE table");
1876*0b57cec5SDimitry Andric 
1877*0b57cec5SDimitry Andric       // Check to see if this was forward referenced, if so fill in the temp.
1878*0b57cec5SDimitry Andric       StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1879*0b57cec5SDimitry Andric       if (Res) {
1880*0b57cec5SDimitry Andric         Res->setName(TypeName);
1881*0b57cec5SDimitry Andric         TypeList[NumRecords] = nullptr;
1882*0b57cec5SDimitry Andric       } else  // Otherwise, create a new struct with no body.
1883*0b57cec5SDimitry Andric         Res = createIdentifiedStructType(Context, TypeName);
1884*0b57cec5SDimitry Andric       TypeName.clear();
1885*0b57cec5SDimitry Andric       ResultTy = Res;
1886*0b57cec5SDimitry Andric       break;
1887*0b57cec5SDimitry Andric     }
1888*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_ARRAY:     // ARRAY: [numelts, eltty]
1889*0b57cec5SDimitry Andric       if (Record.size() < 2)
1890*0b57cec5SDimitry Andric         return error("Invalid record");
1891*0b57cec5SDimitry Andric       ResultTy = getTypeByID(Record[1]);
1892*0b57cec5SDimitry Andric       if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
1893*0b57cec5SDimitry Andric         return error("Invalid type");
1894*0b57cec5SDimitry Andric       ResultTy = ArrayType::get(ResultTy, Record[0]);
1895*0b57cec5SDimitry Andric       break;
1896*0b57cec5SDimitry Andric     case bitc::TYPE_CODE_VECTOR:    // VECTOR: [numelts, eltty] or
1897*0b57cec5SDimitry Andric                                     //         [numelts, eltty, scalable]
1898*0b57cec5SDimitry Andric       if (Record.size() < 2)
1899*0b57cec5SDimitry Andric         return error("Invalid record");
1900*0b57cec5SDimitry Andric       if (Record[0] == 0)
1901*0b57cec5SDimitry Andric         return error("Invalid vector length");
1902*0b57cec5SDimitry Andric       ResultTy = getTypeByID(Record[1]);
1903*0b57cec5SDimitry Andric       if (!ResultTy || !StructType::isValidElementType(ResultTy))
1904*0b57cec5SDimitry Andric         return error("Invalid type");
1905*0b57cec5SDimitry Andric       bool Scalable = Record.size() > 2 ? Record[2] : false;
1906*0b57cec5SDimitry Andric       ResultTy = VectorType::get(ResultTy, Record[0], Scalable);
1907*0b57cec5SDimitry Andric       break;
1908*0b57cec5SDimitry Andric     }
1909*0b57cec5SDimitry Andric 
1910*0b57cec5SDimitry Andric     if (NumRecords >= TypeList.size())
1911*0b57cec5SDimitry Andric       return error("Invalid TYPE table");
1912*0b57cec5SDimitry Andric     if (TypeList[NumRecords])
1913*0b57cec5SDimitry Andric       return error(
1914*0b57cec5SDimitry Andric           "Invalid TYPE table: Only named structs can be forward referenced");
1915*0b57cec5SDimitry Andric     assert(ResultTy && "Didn't read a type?");
1916*0b57cec5SDimitry Andric     TypeList[NumRecords++] = ResultTy;
1917*0b57cec5SDimitry Andric   }
1918*0b57cec5SDimitry Andric }
1919*0b57cec5SDimitry Andric 
1920*0b57cec5SDimitry Andric Error BitcodeReader::parseOperandBundleTags() {
1921*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID))
1922*0b57cec5SDimitry Andric     return Err;
1923*0b57cec5SDimitry Andric 
1924*0b57cec5SDimitry Andric   if (!BundleTags.empty())
1925*0b57cec5SDimitry Andric     return error("Invalid multiple blocks");
1926*0b57cec5SDimitry Andric 
1927*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
1928*0b57cec5SDimitry Andric 
1929*0b57cec5SDimitry Andric   while (true) {
1930*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
1931*0b57cec5SDimitry Andric     if (!MaybeEntry)
1932*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
1933*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
1934*0b57cec5SDimitry Andric 
1935*0b57cec5SDimitry Andric     switch (Entry.Kind) {
1936*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1937*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
1938*0b57cec5SDimitry Andric       return error("Malformed block");
1939*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
1940*0b57cec5SDimitry Andric       return Error::success();
1941*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
1942*0b57cec5SDimitry Andric       // The interesting case.
1943*0b57cec5SDimitry Andric       break;
1944*0b57cec5SDimitry Andric     }
1945*0b57cec5SDimitry Andric 
1946*0b57cec5SDimitry Andric     // Tags are implicitly mapped to integers by their order.
1947*0b57cec5SDimitry Andric 
1948*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
1949*0b57cec5SDimitry Andric     if (!MaybeRecord)
1950*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
1951*0b57cec5SDimitry Andric     if (MaybeRecord.get() != bitc::OPERAND_BUNDLE_TAG)
1952*0b57cec5SDimitry Andric       return error("Invalid record");
1953*0b57cec5SDimitry Andric 
1954*0b57cec5SDimitry Andric     // OPERAND_BUNDLE_TAG: [strchr x N]
1955*0b57cec5SDimitry Andric     BundleTags.emplace_back();
1956*0b57cec5SDimitry Andric     if (convertToString(Record, 0, BundleTags.back()))
1957*0b57cec5SDimitry Andric       return error("Invalid record");
1958*0b57cec5SDimitry Andric     Record.clear();
1959*0b57cec5SDimitry Andric   }
1960*0b57cec5SDimitry Andric }
1961*0b57cec5SDimitry Andric 
1962*0b57cec5SDimitry Andric Error BitcodeReader::parseSyncScopeNames() {
1963*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::SYNC_SCOPE_NAMES_BLOCK_ID))
1964*0b57cec5SDimitry Andric     return Err;
1965*0b57cec5SDimitry Andric 
1966*0b57cec5SDimitry Andric   if (!SSIDs.empty())
1967*0b57cec5SDimitry Andric     return error("Invalid multiple synchronization scope names blocks");
1968*0b57cec5SDimitry Andric 
1969*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
1970*0b57cec5SDimitry Andric   while (true) {
1971*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
1972*0b57cec5SDimitry Andric     if (!MaybeEntry)
1973*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
1974*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
1975*0b57cec5SDimitry Andric 
1976*0b57cec5SDimitry Andric     switch (Entry.Kind) {
1977*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1978*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
1979*0b57cec5SDimitry Andric       return error("Malformed block");
1980*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
1981*0b57cec5SDimitry Andric       if (SSIDs.empty())
1982*0b57cec5SDimitry Andric         return error("Invalid empty synchronization scope names block");
1983*0b57cec5SDimitry Andric       return Error::success();
1984*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
1985*0b57cec5SDimitry Andric       // The interesting case.
1986*0b57cec5SDimitry Andric       break;
1987*0b57cec5SDimitry Andric     }
1988*0b57cec5SDimitry Andric 
1989*0b57cec5SDimitry Andric     // Synchronization scope names are implicitly mapped to synchronization
1990*0b57cec5SDimitry Andric     // scope IDs by their order.
1991*0b57cec5SDimitry Andric 
1992*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
1993*0b57cec5SDimitry Andric     if (!MaybeRecord)
1994*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
1995*0b57cec5SDimitry Andric     if (MaybeRecord.get() != bitc::SYNC_SCOPE_NAME)
1996*0b57cec5SDimitry Andric       return error("Invalid record");
1997*0b57cec5SDimitry Andric 
1998*0b57cec5SDimitry Andric     SmallString<16> SSN;
1999*0b57cec5SDimitry Andric     if (convertToString(Record, 0, SSN))
2000*0b57cec5SDimitry Andric       return error("Invalid record");
2001*0b57cec5SDimitry Andric 
2002*0b57cec5SDimitry Andric     SSIDs.push_back(Context.getOrInsertSyncScopeID(SSN));
2003*0b57cec5SDimitry Andric     Record.clear();
2004*0b57cec5SDimitry Andric   }
2005*0b57cec5SDimitry Andric }
2006*0b57cec5SDimitry Andric 
2007*0b57cec5SDimitry Andric /// Associate a value with its name from the given index in the provided record.
2008*0b57cec5SDimitry Andric Expected<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,
2009*0b57cec5SDimitry Andric                                              unsigned NameIndex, Triple &TT) {
2010*0b57cec5SDimitry Andric   SmallString<128> ValueName;
2011*0b57cec5SDimitry Andric   if (convertToString(Record, NameIndex, ValueName))
2012*0b57cec5SDimitry Andric     return error("Invalid record");
2013*0b57cec5SDimitry Andric   unsigned ValueID = Record[0];
2014*0b57cec5SDimitry Andric   if (ValueID >= ValueList.size() || !ValueList[ValueID])
2015*0b57cec5SDimitry Andric     return error("Invalid record");
2016*0b57cec5SDimitry Andric   Value *V = ValueList[ValueID];
2017*0b57cec5SDimitry Andric 
2018*0b57cec5SDimitry Andric   StringRef NameStr(ValueName.data(), ValueName.size());
2019*0b57cec5SDimitry Andric   if (NameStr.find_first_of(0) != StringRef::npos)
2020*0b57cec5SDimitry Andric     return error("Invalid value name");
2021*0b57cec5SDimitry Andric   V->setName(NameStr);
2022*0b57cec5SDimitry Andric   auto *GO = dyn_cast<GlobalObject>(V);
2023*0b57cec5SDimitry Andric   if (GO) {
2024*0b57cec5SDimitry Andric     if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
2025*0b57cec5SDimitry Andric       if (TT.supportsCOMDAT())
2026*0b57cec5SDimitry Andric         GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
2027*0b57cec5SDimitry Andric       else
2028*0b57cec5SDimitry Andric         GO->setComdat(nullptr);
2029*0b57cec5SDimitry Andric     }
2030*0b57cec5SDimitry Andric   }
2031*0b57cec5SDimitry Andric   return V;
2032*0b57cec5SDimitry Andric }
2033*0b57cec5SDimitry Andric 
2034*0b57cec5SDimitry Andric /// Helper to note and return the current location, and jump to the given
2035*0b57cec5SDimitry Andric /// offset.
2036*0b57cec5SDimitry Andric static Expected<uint64_t> jumpToValueSymbolTable(uint64_t Offset,
2037*0b57cec5SDimitry Andric                                                  BitstreamCursor &Stream) {
2038*0b57cec5SDimitry Andric   // Save the current parsing location so we can jump back at the end
2039*0b57cec5SDimitry Andric   // of the VST read.
2040*0b57cec5SDimitry Andric   uint64_t CurrentBit = Stream.GetCurrentBitNo();
2041*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(Offset * 32))
2042*0b57cec5SDimitry Andric     return std::move(JumpFailed);
2043*0b57cec5SDimitry Andric   Expected<BitstreamEntry> MaybeEntry = Stream.advance();
2044*0b57cec5SDimitry Andric   if (!MaybeEntry)
2045*0b57cec5SDimitry Andric     return MaybeEntry.takeError();
2046*0b57cec5SDimitry Andric   assert(MaybeEntry.get().Kind == BitstreamEntry::SubBlock);
2047*0b57cec5SDimitry Andric   assert(MaybeEntry.get().ID == bitc::VALUE_SYMTAB_BLOCK_ID);
2048*0b57cec5SDimitry Andric   return CurrentBit;
2049*0b57cec5SDimitry Andric }
2050*0b57cec5SDimitry Andric 
2051*0b57cec5SDimitry Andric void BitcodeReader::setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta,
2052*0b57cec5SDimitry Andric                                             Function *F,
2053*0b57cec5SDimitry Andric                                             ArrayRef<uint64_t> Record) {
2054*0b57cec5SDimitry Andric   // Note that we subtract 1 here because the offset is relative to one word
2055*0b57cec5SDimitry Andric   // before the start of the identification or module block, which was
2056*0b57cec5SDimitry Andric   // historically always the start of the regular bitcode header.
2057*0b57cec5SDimitry Andric   uint64_t FuncWordOffset = Record[1] - 1;
2058*0b57cec5SDimitry Andric   uint64_t FuncBitOffset = FuncWordOffset * 32;
2059*0b57cec5SDimitry Andric   DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;
2060*0b57cec5SDimitry Andric   // Set the LastFunctionBlockBit to point to the last function block.
2061*0b57cec5SDimitry Andric   // Later when parsing is resumed after function materialization,
2062*0b57cec5SDimitry Andric   // we can simply skip that last function block.
2063*0b57cec5SDimitry Andric   if (FuncBitOffset > LastFunctionBlockBit)
2064*0b57cec5SDimitry Andric     LastFunctionBlockBit = FuncBitOffset;
2065*0b57cec5SDimitry Andric }
2066*0b57cec5SDimitry Andric 
2067*0b57cec5SDimitry Andric /// Read a new-style GlobalValue symbol table.
2068*0b57cec5SDimitry Andric Error BitcodeReader::parseGlobalValueSymbolTable() {
2069*0b57cec5SDimitry Andric   unsigned FuncBitcodeOffsetDelta =
2070*0b57cec5SDimitry Andric       Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
2071*0b57cec5SDimitry Andric 
2072*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
2073*0b57cec5SDimitry Andric     return Err;
2074*0b57cec5SDimitry Andric 
2075*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
2076*0b57cec5SDimitry Andric   while (true) {
2077*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2078*0b57cec5SDimitry Andric     if (!MaybeEntry)
2079*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
2080*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
2081*0b57cec5SDimitry Andric 
2082*0b57cec5SDimitry Andric     switch (Entry.Kind) {
2083*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
2084*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
2085*0b57cec5SDimitry Andric       return error("Malformed block");
2086*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
2087*0b57cec5SDimitry Andric       return Error::success();
2088*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
2089*0b57cec5SDimitry Andric       break;
2090*0b57cec5SDimitry Andric     }
2091*0b57cec5SDimitry Andric 
2092*0b57cec5SDimitry Andric     Record.clear();
2093*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2094*0b57cec5SDimitry Andric     if (!MaybeRecord)
2095*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
2096*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
2097*0b57cec5SDimitry Andric     case bitc::VST_CODE_FNENTRY: // [valueid, offset]
2098*0b57cec5SDimitry Andric       setDeferredFunctionInfo(FuncBitcodeOffsetDelta,
2099*0b57cec5SDimitry Andric                               cast<Function>(ValueList[Record[0]]), Record);
2100*0b57cec5SDimitry Andric       break;
2101*0b57cec5SDimitry Andric     }
2102*0b57cec5SDimitry Andric   }
2103*0b57cec5SDimitry Andric }
2104*0b57cec5SDimitry Andric 
2105*0b57cec5SDimitry Andric /// Parse the value symbol table at either the current parsing location or
2106*0b57cec5SDimitry Andric /// at the given bit offset if provided.
2107*0b57cec5SDimitry Andric Error BitcodeReader::parseValueSymbolTable(uint64_t Offset) {
2108*0b57cec5SDimitry Andric   uint64_t CurrentBit;
2109*0b57cec5SDimitry Andric   // Pass in the Offset to distinguish between calling for the module-level
2110*0b57cec5SDimitry Andric   // VST (where we want to jump to the VST offset) and the function-level
2111*0b57cec5SDimitry Andric   // VST (where we don't).
2112*0b57cec5SDimitry Andric   if (Offset > 0) {
2113*0b57cec5SDimitry Andric     Expected<uint64_t> MaybeCurrentBit = jumpToValueSymbolTable(Offset, Stream);
2114*0b57cec5SDimitry Andric     if (!MaybeCurrentBit)
2115*0b57cec5SDimitry Andric       return MaybeCurrentBit.takeError();
2116*0b57cec5SDimitry Andric     CurrentBit = MaybeCurrentBit.get();
2117*0b57cec5SDimitry Andric     // If this module uses a string table, read this as a module-level VST.
2118*0b57cec5SDimitry Andric     if (UseStrtab) {
2119*0b57cec5SDimitry Andric       if (Error Err = parseGlobalValueSymbolTable())
2120*0b57cec5SDimitry Andric         return Err;
2121*0b57cec5SDimitry Andric       if (Error JumpFailed = Stream.JumpToBit(CurrentBit))
2122*0b57cec5SDimitry Andric         return JumpFailed;
2123*0b57cec5SDimitry Andric       return Error::success();
2124*0b57cec5SDimitry Andric     }
2125*0b57cec5SDimitry Andric     // Otherwise, the VST will be in a similar format to a function-level VST,
2126*0b57cec5SDimitry Andric     // and will contain symbol names.
2127*0b57cec5SDimitry Andric   }
2128*0b57cec5SDimitry Andric 
2129*0b57cec5SDimitry Andric   // Compute the delta between the bitcode indices in the VST (the word offset
2130*0b57cec5SDimitry Andric   // to the word-aligned ENTER_SUBBLOCK for the function block, and that
2131*0b57cec5SDimitry Andric   // expected by the lazy reader. The reader's EnterSubBlock expects to have
2132*0b57cec5SDimitry Andric   // already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID
2133*0b57cec5SDimitry Andric   // (size BlockIDWidth). Note that we access the stream's AbbrevID width here
2134*0b57cec5SDimitry Andric   // just before entering the VST subblock because: 1) the EnterSubBlock
2135*0b57cec5SDimitry Andric   // changes the AbbrevID width; 2) the VST block is nested within the same
2136*0b57cec5SDimitry Andric   // outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same
2137*0b57cec5SDimitry Andric   // AbbrevID width before calling EnterSubBlock; and 3) when we want to
2138*0b57cec5SDimitry Andric   // jump to the FUNCTION_BLOCK using this offset later, we don't want
2139*0b57cec5SDimitry Andric   // to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.
2140*0b57cec5SDimitry Andric   unsigned FuncBitcodeOffsetDelta =
2141*0b57cec5SDimitry Andric       Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
2142*0b57cec5SDimitry Andric 
2143*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
2144*0b57cec5SDimitry Andric     return Err;
2145*0b57cec5SDimitry Andric 
2146*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
2147*0b57cec5SDimitry Andric 
2148*0b57cec5SDimitry Andric   Triple TT(TheModule->getTargetTriple());
2149*0b57cec5SDimitry Andric 
2150*0b57cec5SDimitry Andric   // Read all the records for this value table.
2151*0b57cec5SDimitry Andric   SmallString<128> ValueName;
2152*0b57cec5SDimitry Andric 
2153*0b57cec5SDimitry Andric   while (true) {
2154*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2155*0b57cec5SDimitry Andric     if (!MaybeEntry)
2156*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
2157*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
2158*0b57cec5SDimitry Andric 
2159*0b57cec5SDimitry Andric     switch (Entry.Kind) {
2160*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
2161*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
2162*0b57cec5SDimitry Andric       return error("Malformed block");
2163*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
2164*0b57cec5SDimitry Andric       if (Offset > 0)
2165*0b57cec5SDimitry Andric         if (Error JumpFailed = Stream.JumpToBit(CurrentBit))
2166*0b57cec5SDimitry Andric           return JumpFailed;
2167*0b57cec5SDimitry Andric       return Error::success();
2168*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
2169*0b57cec5SDimitry Andric       // The interesting case.
2170*0b57cec5SDimitry Andric       break;
2171*0b57cec5SDimitry Andric     }
2172*0b57cec5SDimitry Andric 
2173*0b57cec5SDimitry Andric     // Read a record.
2174*0b57cec5SDimitry Andric     Record.clear();
2175*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2176*0b57cec5SDimitry Andric     if (!MaybeRecord)
2177*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
2178*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
2179*0b57cec5SDimitry Andric     default:  // Default behavior: unknown type.
2180*0b57cec5SDimitry Andric       break;
2181*0b57cec5SDimitry Andric     case bitc::VST_CODE_ENTRY: {  // VST_CODE_ENTRY: [valueid, namechar x N]
2182*0b57cec5SDimitry Andric       Expected<Value *> ValOrErr = recordValue(Record, 1, TT);
2183*0b57cec5SDimitry Andric       if (Error Err = ValOrErr.takeError())
2184*0b57cec5SDimitry Andric         return Err;
2185*0b57cec5SDimitry Andric       ValOrErr.get();
2186*0b57cec5SDimitry Andric       break;
2187*0b57cec5SDimitry Andric     }
2188*0b57cec5SDimitry Andric     case bitc::VST_CODE_FNENTRY: {
2189*0b57cec5SDimitry Andric       // VST_CODE_FNENTRY: [valueid, offset, namechar x N]
2190*0b57cec5SDimitry Andric       Expected<Value *> ValOrErr = recordValue(Record, 2, TT);
2191*0b57cec5SDimitry Andric       if (Error Err = ValOrErr.takeError())
2192*0b57cec5SDimitry Andric         return Err;
2193*0b57cec5SDimitry Andric       Value *V = ValOrErr.get();
2194*0b57cec5SDimitry Andric 
2195*0b57cec5SDimitry Andric       // Ignore function offsets emitted for aliases of functions in older
2196*0b57cec5SDimitry Andric       // versions of LLVM.
2197*0b57cec5SDimitry Andric       if (auto *F = dyn_cast<Function>(V))
2198*0b57cec5SDimitry Andric         setDeferredFunctionInfo(FuncBitcodeOffsetDelta, F, Record);
2199*0b57cec5SDimitry Andric       break;
2200*0b57cec5SDimitry Andric     }
2201*0b57cec5SDimitry Andric     case bitc::VST_CODE_BBENTRY: {
2202*0b57cec5SDimitry Andric       if (convertToString(Record, 1, ValueName))
2203*0b57cec5SDimitry Andric         return error("Invalid record");
2204*0b57cec5SDimitry Andric       BasicBlock *BB = getBasicBlock(Record[0]);
2205*0b57cec5SDimitry Andric       if (!BB)
2206*0b57cec5SDimitry Andric         return error("Invalid record");
2207*0b57cec5SDimitry Andric 
2208*0b57cec5SDimitry Andric       BB->setName(StringRef(ValueName.data(), ValueName.size()));
2209*0b57cec5SDimitry Andric       ValueName.clear();
2210*0b57cec5SDimitry Andric       break;
2211*0b57cec5SDimitry Andric     }
2212*0b57cec5SDimitry Andric     }
2213*0b57cec5SDimitry Andric   }
2214*0b57cec5SDimitry Andric }
2215*0b57cec5SDimitry Andric 
2216*0b57cec5SDimitry Andric /// Decode a signed value stored with the sign bit in the LSB for dense VBR
2217*0b57cec5SDimitry Andric /// encoding.
2218*0b57cec5SDimitry Andric uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
2219*0b57cec5SDimitry Andric   if ((V & 1) == 0)
2220*0b57cec5SDimitry Andric     return V >> 1;
2221*0b57cec5SDimitry Andric   if (V != 1)
2222*0b57cec5SDimitry Andric     return -(V >> 1);
2223*0b57cec5SDimitry Andric   // There is no such thing as -0 with integers.  "-0" really means MININT.
2224*0b57cec5SDimitry Andric   return 1ULL << 63;
2225*0b57cec5SDimitry Andric }
2226*0b57cec5SDimitry Andric 
2227*0b57cec5SDimitry Andric /// Resolve all of the initializers for global values and aliases that we can.
2228*0b57cec5SDimitry Andric Error BitcodeReader::resolveGlobalAndIndirectSymbolInits() {
2229*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalVariable *, unsigned>> GlobalInitWorklist;
2230*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalIndirectSymbol *, unsigned>>
2231*0b57cec5SDimitry Andric       IndirectSymbolInitWorklist;
2232*0b57cec5SDimitry Andric   std::vector<std::pair<Function *, unsigned>> FunctionPrefixWorklist;
2233*0b57cec5SDimitry Andric   std::vector<std::pair<Function *, unsigned>> FunctionPrologueWorklist;
2234*0b57cec5SDimitry Andric   std::vector<std::pair<Function *, unsigned>> FunctionPersonalityFnWorklist;
2235*0b57cec5SDimitry Andric 
2236*0b57cec5SDimitry Andric   GlobalInitWorklist.swap(GlobalInits);
2237*0b57cec5SDimitry Andric   IndirectSymbolInitWorklist.swap(IndirectSymbolInits);
2238*0b57cec5SDimitry Andric   FunctionPrefixWorklist.swap(FunctionPrefixes);
2239*0b57cec5SDimitry Andric   FunctionPrologueWorklist.swap(FunctionPrologues);
2240*0b57cec5SDimitry Andric   FunctionPersonalityFnWorklist.swap(FunctionPersonalityFns);
2241*0b57cec5SDimitry Andric 
2242*0b57cec5SDimitry Andric   while (!GlobalInitWorklist.empty()) {
2243*0b57cec5SDimitry Andric     unsigned ValID = GlobalInitWorklist.back().second;
2244*0b57cec5SDimitry Andric     if (ValID >= ValueList.size()) {
2245*0b57cec5SDimitry Andric       // Not ready to resolve this yet, it requires something later in the file.
2246*0b57cec5SDimitry Andric       GlobalInits.push_back(GlobalInitWorklist.back());
2247*0b57cec5SDimitry Andric     } else {
2248*0b57cec5SDimitry Andric       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2249*0b57cec5SDimitry Andric         GlobalInitWorklist.back().first->setInitializer(C);
2250*0b57cec5SDimitry Andric       else
2251*0b57cec5SDimitry Andric         return error("Expected a constant");
2252*0b57cec5SDimitry Andric     }
2253*0b57cec5SDimitry Andric     GlobalInitWorklist.pop_back();
2254*0b57cec5SDimitry Andric   }
2255*0b57cec5SDimitry Andric 
2256*0b57cec5SDimitry Andric   while (!IndirectSymbolInitWorklist.empty()) {
2257*0b57cec5SDimitry Andric     unsigned ValID = IndirectSymbolInitWorklist.back().second;
2258*0b57cec5SDimitry Andric     if (ValID >= ValueList.size()) {
2259*0b57cec5SDimitry Andric       IndirectSymbolInits.push_back(IndirectSymbolInitWorklist.back());
2260*0b57cec5SDimitry Andric     } else {
2261*0b57cec5SDimitry Andric       Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]);
2262*0b57cec5SDimitry Andric       if (!C)
2263*0b57cec5SDimitry Andric         return error("Expected a constant");
2264*0b57cec5SDimitry Andric       GlobalIndirectSymbol *GIS = IndirectSymbolInitWorklist.back().first;
2265*0b57cec5SDimitry Andric       if (isa<GlobalAlias>(GIS) && C->getType() != GIS->getType())
2266*0b57cec5SDimitry Andric         return error("Alias and aliasee types don't match");
2267*0b57cec5SDimitry Andric       GIS->setIndirectSymbol(C);
2268*0b57cec5SDimitry Andric     }
2269*0b57cec5SDimitry Andric     IndirectSymbolInitWorklist.pop_back();
2270*0b57cec5SDimitry Andric   }
2271*0b57cec5SDimitry Andric 
2272*0b57cec5SDimitry Andric   while (!FunctionPrefixWorklist.empty()) {
2273*0b57cec5SDimitry Andric     unsigned ValID = FunctionPrefixWorklist.back().second;
2274*0b57cec5SDimitry Andric     if (ValID >= ValueList.size()) {
2275*0b57cec5SDimitry Andric       FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2276*0b57cec5SDimitry Andric     } else {
2277*0b57cec5SDimitry Andric       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2278*0b57cec5SDimitry Andric         FunctionPrefixWorklist.back().first->setPrefixData(C);
2279*0b57cec5SDimitry Andric       else
2280*0b57cec5SDimitry Andric         return error("Expected a constant");
2281*0b57cec5SDimitry Andric     }
2282*0b57cec5SDimitry Andric     FunctionPrefixWorklist.pop_back();
2283*0b57cec5SDimitry Andric   }
2284*0b57cec5SDimitry Andric 
2285*0b57cec5SDimitry Andric   while (!FunctionPrologueWorklist.empty()) {
2286*0b57cec5SDimitry Andric     unsigned ValID = FunctionPrologueWorklist.back().second;
2287*0b57cec5SDimitry Andric     if (ValID >= ValueList.size()) {
2288*0b57cec5SDimitry Andric       FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2289*0b57cec5SDimitry Andric     } else {
2290*0b57cec5SDimitry Andric       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2291*0b57cec5SDimitry Andric         FunctionPrologueWorklist.back().first->setPrologueData(C);
2292*0b57cec5SDimitry Andric       else
2293*0b57cec5SDimitry Andric         return error("Expected a constant");
2294*0b57cec5SDimitry Andric     }
2295*0b57cec5SDimitry Andric     FunctionPrologueWorklist.pop_back();
2296*0b57cec5SDimitry Andric   }
2297*0b57cec5SDimitry Andric 
2298*0b57cec5SDimitry Andric   while (!FunctionPersonalityFnWorklist.empty()) {
2299*0b57cec5SDimitry Andric     unsigned ValID = FunctionPersonalityFnWorklist.back().second;
2300*0b57cec5SDimitry Andric     if (ValID >= ValueList.size()) {
2301*0b57cec5SDimitry Andric       FunctionPersonalityFns.push_back(FunctionPersonalityFnWorklist.back());
2302*0b57cec5SDimitry Andric     } else {
2303*0b57cec5SDimitry Andric       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2304*0b57cec5SDimitry Andric         FunctionPersonalityFnWorklist.back().first->setPersonalityFn(C);
2305*0b57cec5SDimitry Andric       else
2306*0b57cec5SDimitry Andric         return error("Expected a constant");
2307*0b57cec5SDimitry Andric     }
2308*0b57cec5SDimitry Andric     FunctionPersonalityFnWorklist.pop_back();
2309*0b57cec5SDimitry Andric   }
2310*0b57cec5SDimitry Andric 
2311*0b57cec5SDimitry Andric   return Error::success();
2312*0b57cec5SDimitry Andric }
2313*0b57cec5SDimitry Andric 
23145ffd83dbSDimitry Andric APInt llvm::readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
2315*0b57cec5SDimitry Andric   SmallVector<uint64_t, 8> Words(Vals.size());
2316*0b57cec5SDimitry Andric   transform(Vals, Words.begin(),
2317*0b57cec5SDimitry Andric                  BitcodeReader::decodeSignRotatedValue);
2318*0b57cec5SDimitry Andric 
2319*0b57cec5SDimitry Andric   return APInt(TypeBits, Words);
2320*0b57cec5SDimitry Andric }
2321*0b57cec5SDimitry Andric 
2322*0b57cec5SDimitry Andric Error BitcodeReader::parseConstants() {
2323*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
2324*0b57cec5SDimitry Andric     return Err;
2325*0b57cec5SDimitry Andric 
2326*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
2327*0b57cec5SDimitry Andric 
2328*0b57cec5SDimitry Andric   // Read all the records for this value table.
2329*0b57cec5SDimitry Andric   Type *CurTy = Type::getInt32Ty(Context);
2330*0b57cec5SDimitry Andric   Type *CurFullTy = Type::getInt32Ty(Context);
2331*0b57cec5SDimitry Andric   unsigned NextCstNo = ValueList.size();
2332*0b57cec5SDimitry Andric 
23335ffd83dbSDimitry Andric   struct DelayedShufTy {
23345ffd83dbSDimitry Andric     VectorType *OpTy;
23355ffd83dbSDimitry Andric     VectorType *RTy;
23365ffd83dbSDimitry Andric     Type *CurFullTy;
23375ffd83dbSDimitry Andric     uint64_t Op0Idx;
23385ffd83dbSDimitry Andric     uint64_t Op1Idx;
23395ffd83dbSDimitry Andric     uint64_t Op2Idx;
23405ffd83dbSDimitry Andric     unsigned CstNo;
23415ffd83dbSDimitry Andric   };
23425ffd83dbSDimitry Andric   std::vector<DelayedShufTy> DelayedShuffles;
2343*0b57cec5SDimitry Andric   while (true) {
2344*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2345*0b57cec5SDimitry Andric     if (!MaybeEntry)
2346*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
2347*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
2348*0b57cec5SDimitry Andric 
2349*0b57cec5SDimitry Andric     switch (Entry.Kind) {
2350*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
2351*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
2352*0b57cec5SDimitry Andric       return error("Malformed block");
2353*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
23545ffd83dbSDimitry Andric       // Once all the constants have been read, go through and resolve forward
23555ffd83dbSDimitry Andric       // references.
23565ffd83dbSDimitry Andric       //
23575ffd83dbSDimitry Andric       // We have to treat shuffles specially because they don't have three
23585ffd83dbSDimitry Andric       // operands anymore.  We need to convert the shuffle mask into an array,
23595ffd83dbSDimitry Andric       // and we can't convert a forward reference.
23605ffd83dbSDimitry Andric       for (auto &DelayedShuffle : DelayedShuffles) {
23615ffd83dbSDimitry Andric         VectorType *OpTy = DelayedShuffle.OpTy;
23625ffd83dbSDimitry Andric         VectorType *RTy = DelayedShuffle.RTy;
23635ffd83dbSDimitry Andric         uint64_t Op0Idx = DelayedShuffle.Op0Idx;
23645ffd83dbSDimitry Andric         uint64_t Op1Idx = DelayedShuffle.Op1Idx;
23655ffd83dbSDimitry Andric         uint64_t Op2Idx = DelayedShuffle.Op2Idx;
23665ffd83dbSDimitry Andric         uint64_t CstNo = DelayedShuffle.CstNo;
23675ffd83dbSDimitry Andric         Constant *Op0 = ValueList.getConstantFwdRef(Op0Idx, OpTy);
23685ffd83dbSDimitry Andric         Constant *Op1 = ValueList.getConstantFwdRef(Op1Idx, OpTy);
23695ffd83dbSDimitry Andric         Type *ShufTy =
23705ffd83dbSDimitry Andric             VectorType::get(Type::getInt32Ty(Context), RTy->getElementCount());
23715ffd83dbSDimitry Andric         Constant *Op2 = ValueList.getConstantFwdRef(Op2Idx, ShufTy);
23725ffd83dbSDimitry Andric         if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2))
23735ffd83dbSDimitry Andric           return error("Invalid shufflevector operands");
23745ffd83dbSDimitry Andric         SmallVector<int, 16> Mask;
23755ffd83dbSDimitry Andric         ShuffleVectorInst::getShuffleMask(Op2, Mask);
23765ffd83dbSDimitry Andric         Value *V = ConstantExpr::getShuffleVector(Op0, Op1, Mask);
23775ffd83dbSDimitry Andric         ValueList.assignValue(V, CstNo, DelayedShuffle.CurFullTy);
23785ffd83dbSDimitry Andric       }
23795ffd83dbSDimitry Andric 
2380*0b57cec5SDimitry Andric       if (NextCstNo != ValueList.size())
2381*0b57cec5SDimitry Andric         return error("Invalid constant reference");
2382*0b57cec5SDimitry Andric 
2383*0b57cec5SDimitry Andric       ValueList.resolveConstantForwardRefs();
2384*0b57cec5SDimitry Andric       return Error::success();
2385*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
2386*0b57cec5SDimitry Andric       // The interesting case.
2387*0b57cec5SDimitry Andric       break;
2388*0b57cec5SDimitry Andric     }
2389*0b57cec5SDimitry Andric 
2390*0b57cec5SDimitry Andric     // Read a record.
2391*0b57cec5SDimitry Andric     Record.clear();
2392*0b57cec5SDimitry Andric     Type *VoidType = Type::getVoidTy(Context);
2393*0b57cec5SDimitry Andric     Value *V = nullptr;
2394*0b57cec5SDimitry Andric     Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
2395*0b57cec5SDimitry Andric     if (!MaybeBitCode)
2396*0b57cec5SDimitry Andric       return MaybeBitCode.takeError();
2397*0b57cec5SDimitry Andric     switch (unsigned BitCode = MaybeBitCode.get()) {
2398*0b57cec5SDimitry Andric     default:  // Default behavior: unknown constant
2399*0b57cec5SDimitry Andric     case bitc::CST_CODE_UNDEF:     // UNDEF
2400*0b57cec5SDimitry Andric       V = UndefValue::get(CurTy);
2401*0b57cec5SDimitry Andric       break;
2402*0b57cec5SDimitry Andric     case bitc::CST_CODE_SETTYPE:   // SETTYPE: [typeid]
2403*0b57cec5SDimitry Andric       if (Record.empty())
2404*0b57cec5SDimitry Andric         return error("Invalid record");
2405*0b57cec5SDimitry Andric       if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
2406*0b57cec5SDimitry Andric         return error("Invalid record");
2407*0b57cec5SDimitry Andric       if (TypeList[Record[0]] == VoidType)
2408*0b57cec5SDimitry Andric         return error("Invalid constant type");
2409*0b57cec5SDimitry Andric       CurFullTy = TypeList[Record[0]];
2410*0b57cec5SDimitry Andric       CurTy = flattenPointerTypes(CurFullTy);
2411*0b57cec5SDimitry Andric       continue;  // Skip the ValueList manipulation.
2412*0b57cec5SDimitry Andric     case bitc::CST_CODE_NULL:      // NULL
24138bcb0991SDimitry Andric       if (CurTy->isVoidTy() || CurTy->isFunctionTy() || CurTy->isLabelTy())
24148bcb0991SDimitry Andric         return error("Invalid type for a constant null value");
2415*0b57cec5SDimitry Andric       V = Constant::getNullValue(CurTy);
2416*0b57cec5SDimitry Andric       break;
2417*0b57cec5SDimitry Andric     case bitc::CST_CODE_INTEGER:   // INTEGER: [intval]
2418*0b57cec5SDimitry Andric       if (!CurTy->isIntegerTy() || Record.empty())
2419*0b57cec5SDimitry Andric         return error("Invalid record");
2420*0b57cec5SDimitry Andric       V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
2421*0b57cec5SDimitry Andric       break;
2422*0b57cec5SDimitry Andric     case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
2423*0b57cec5SDimitry Andric       if (!CurTy->isIntegerTy() || Record.empty())
2424*0b57cec5SDimitry Andric         return error("Invalid record");
2425*0b57cec5SDimitry Andric 
2426*0b57cec5SDimitry Andric       APInt VInt =
2427*0b57cec5SDimitry Andric           readWideAPInt(Record, cast<IntegerType>(CurTy)->getBitWidth());
2428*0b57cec5SDimitry Andric       V = ConstantInt::get(Context, VInt);
2429*0b57cec5SDimitry Andric 
2430*0b57cec5SDimitry Andric       break;
2431*0b57cec5SDimitry Andric     }
2432*0b57cec5SDimitry Andric     case bitc::CST_CODE_FLOAT: {    // FLOAT: [fpval]
2433*0b57cec5SDimitry Andric       if (Record.empty())
2434*0b57cec5SDimitry Andric         return error("Invalid record");
2435*0b57cec5SDimitry Andric       if (CurTy->isHalfTy())
2436*0b57cec5SDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf(),
2437*0b57cec5SDimitry Andric                                              APInt(16, (uint16_t)Record[0])));
24385ffd83dbSDimitry Andric       else if (CurTy->isBFloatTy())
24395ffd83dbSDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::BFloat(),
24405ffd83dbSDimitry Andric                                              APInt(16, (uint32_t)Record[0])));
2441*0b57cec5SDimitry Andric       else if (CurTy->isFloatTy())
2442*0b57cec5SDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle(),
2443*0b57cec5SDimitry Andric                                              APInt(32, (uint32_t)Record[0])));
2444*0b57cec5SDimitry Andric       else if (CurTy->isDoubleTy())
2445*0b57cec5SDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble(),
2446*0b57cec5SDimitry Andric                                              APInt(64, Record[0])));
2447*0b57cec5SDimitry Andric       else if (CurTy->isX86_FP80Ty()) {
2448*0b57cec5SDimitry Andric         // Bits are not stored the same way as a normal i80 APInt, compensate.
2449*0b57cec5SDimitry Andric         uint64_t Rearrange[2];
2450*0b57cec5SDimitry Andric         Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2451*0b57cec5SDimitry Andric         Rearrange[1] = Record[0] >> 48;
2452*0b57cec5SDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended(),
2453*0b57cec5SDimitry Andric                                              APInt(80, Rearrange)));
2454*0b57cec5SDimitry Andric       } else if (CurTy->isFP128Ty())
2455*0b57cec5SDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad(),
2456*0b57cec5SDimitry Andric                                              APInt(128, Record)));
2457*0b57cec5SDimitry Andric       else if (CurTy->isPPC_FP128Ty())
2458*0b57cec5SDimitry Andric         V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble(),
2459*0b57cec5SDimitry Andric                                              APInt(128, Record)));
2460*0b57cec5SDimitry Andric       else
2461*0b57cec5SDimitry Andric         V = UndefValue::get(CurTy);
2462*0b57cec5SDimitry Andric       break;
2463*0b57cec5SDimitry Andric     }
2464*0b57cec5SDimitry Andric 
2465*0b57cec5SDimitry Andric     case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2466*0b57cec5SDimitry Andric       if (Record.empty())
2467*0b57cec5SDimitry Andric         return error("Invalid record");
2468*0b57cec5SDimitry Andric 
2469*0b57cec5SDimitry Andric       unsigned Size = Record.size();
2470*0b57cec5SDimitry Andric       SmallVector<Constant*, 16> Elts;
2471*0b57cec5SDimitry Andric 
2472*0b57cec5SDimitry Andric       if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2473*0b57cec5SDimitry Andric         for (unsigned i = 0; i != Size; ++i)
2474*0b57cec5SDimitry Andric           Elts.push_back(ValueList.getConstantFwdRef(Record[i],
2475*0b57cec5SDimitry Andric                                                      STy->getElementType(i)));
2476*0b57cec5SDimitry Andric         V = ConstantStruct::get(STy, Elts);
2477*0b57cec5SDimitry Andric       } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2478*0b57cec5SDimitry Andric         Type *EltTy = ATy->getElementType();
2479*0b57cec5SDimitry Andric         for (unsigned i = 0; i != Size; ++i)
2480*0b57cec5SDimitry Andric           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2481*0b57cec5SDimitry Andric         V = ConstantArray::get(ATy, Elts);
2482*0b57cec5SDimitry Andric       } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2483*0b57cec5SDimitry Andric         Type *EltTy = VTy->getElementType();
2484*0b57cec5SDimitry Andric         for (unsigned i = 0; i != Size; ++i)
2485*0b57cec5SDimitry Andric           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
2486*0b57cec5SDimitry Andric         V = ConstantVector::get(Elts);
2487*0b57cec5SDimitry Andric       } else {
2488*0b57cec5SDimitry Andric         V = UndefValue::get(CurTy);
2489*0b57cec5SDimitry Andric       }
2490*0b57cec5SDimitry Andric       break;
2491*0b57cec5SDimitry Andric     }
2492*0b57cec5SDimitry Andric     case bitc::CST_CODE_STRING:    // STRING: [values]
2493*0b57cec5SDimitry Andric     case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2494*0b57cec5SDimitry Andric       if (Record.empty())
2495*0b57cec5SDimitry Andric         return error("Invalid record");
2496*0b57cec5SDimitry Andric 
2497*0b57cec5SDimitry Andric       SmallString<16> Elts(Record.begin(), Record.end());
2498*0b57cec5SDimitry Andric       V = ConstantDataArray::getString(Context, Elts,
2499*0b57cec5SDimitry Andric                                        BitCode == bitc::CST_CODE_CSTRING);
2500*0b57cec5SDimitry Andric       break;
2501*0b57cec5SDimitry Andric     }
2502*0b57cec5SDimitry Andric     case bitc::CST_CODE_DATA: {// DATA: [n x value]
2503*0b57cec5SDimitry Andric       if (Record.empty())
2504*0b57cec5SDimitry Andric         return error("Invalid record");
2505*0b57cec5SDimitry Andric 
25065ffd83dbSDimitry Andric       Type *EltTy;
25075ffd83dbSDimitry Andric       if (auto *Array = dyn_cast<ArrayType>(CurTy))
25085ffd83dbSDimitry Andric         EltTy = Array->getElementType();
25095ffd83dbSDimitry Andric       else
25105ffd83dbSDimitry Andric         EltTy = cast<VectorType>(CurTy)->getElementType();
2511*0b57cec5SDimitry Andric       if (EltTy->isIntegerTy(8)) {
2512*0b57cec5SDimitry Andric         SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2513*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
2514*0b57cec5SDimitry Andric           V = ConstantDataVector::get(Context, Elts);
2515*0b57cec5SDimitry Andric         else
2516*0b57cec5SDimitry Andric           V = ConstantDataArray::get(Context, Elts);
2517*0b57cec5SDimitry Andric       } else if (EltTy->isIntegerTy(16)) {
2518*0b57cec5SDimitry Andric         SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2519*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
2520*0b57cec5SDimitry Andric           V = ConstantDataVector::get(Context, Elts);
2521*0b57cec5SDimitry Andric         else
2522*0b57cec5SDimitry Andric           V = ConstantDataArray::get(Context, Elts);
2523*0b57cec5SDimitry Andric       } else if (EltTy->isIntegerTy(32)) {
2524*0b57cec5SDimitry Andric         SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2525*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
2526*0b57cec5SDimitry Andric           V = ConstantDataVector::get(Context, Elts);
2527*0b57cec5SDimitry Andric         else
2528*0b57cec5SDimitry Andric           V = ConstantDataArray::get(Context, Elts);
2529*0b57cec5SDimitry Andric       } else if (EltTy->isIntegerTy(64)) {
2530*0b57cec5SDimitry Andric         SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2531*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
2532*0b57cec5SDimitry Andric           V = ConstantDataVector::get(Context, Elts);
2533*0b57cec5SDimitry Andric         else
2534*0b57cec5SDimitry Andric           V = ConstantDataArray::get(Context, Elts);
2535*0b57cec5SDimitry Andric       } else if (EltTy->isHalfTy()) {
2536*0b57cec5SDimitry Andric         SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2537*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
25385ffd83dbSDimitry Andric           V = ConstantDataVector::getFP(EltTy, Elts);
2539*0b57cec5SDimitry Andric         else
25405ffd83dbSDimitry Andric           V = ConstantDataArray::getFP(EltTy, Elts);
25415ffd83dbSDimitry Andric       } else if (EltTy->isBFloatTy()) {
25425ffd83dbSDimitry Andric         SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
25435ffd83dbSDimitry Andric         if (isa<VectorType>(CurTy))
25445ffd83dbSDimitry Andric           V = ConstantDataVector::getFP(EltTy, Elts);
25455ffd83dbSDimitry Andric         else
25465ffd83dbSDimitry Andric           V = ConstantDataArray::getFP(EltTy, Elts);
2547*0b57cec5SDimitry Andric       } else if (EltTy->isFloatTy()) {
2548*0b57cec5SDimitry Andric         SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2549*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
25505ffd83dbSDimitry Andric           V = ConstantDataVector::getFP(EltTy, Elts);
2551*0b57cec5SDimitry Andric         else
25525ffd83dbSDimitry Andric           V = ConstantDataArray::getFP(EltTy, Elts);
2553*0b57cec5SDimitry Andric       } else if (EltTy->isDoubleTy()) {
2554*0b57cec5SDimitry Andric         SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2555*0b57cec5SDimitry Andric         if (isa<VectorType>(CurTy))
25565ffd83dbSDimitry Andric           V = ConstantDataVector::getFP(EltTy, Elts);
2557*0b57cec5SDimitry Andric         else
25585ffd83dbSDimitry Andric           V = ConstantDataArray::getFP(EltTy, Elts);
2559*0b57cec5SDimitry Andric       } else {
2560*0b57cec5SDimitry Andric         return error("Invalid type for value");
2561*0b57cec5SDimitry Andric       }
2562*0b57cec5SDimitry Andric       break;
2563*0b57cec5SDimitry Andric     }
2564*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_UNOP: {  // CE_UNOP: [opcode, opval]
2565*0b57cec5SDimitry Andric       if (Record.size() < 2)
2566*0b57cec5SDimitry Andric         return error("Invalid record");
2567*0b57cec5SDimitry Andric       int Opc = getDecodedUnaryOpcode(Record[0], CurTy);
2568*0b57cec5SDimitry Andric       if (Opc < 0) {
2569*0b57cec5SDimitry Andric         V = UndefValue::get(CurTy);  // Unknown unop.
2570*0b57cec5SDimitry Andric       } else {
2571*0b57cec5SDimitry Andric         Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2572*0b57cec5SDimitry Andric         unsigned Flags = 0;
2573*0b57cec5SDimitry Andric         V = ConstantExpr::get(Opc, LHS, Flags);
2574*0b57cec5SDimitry Andric       }
2575*0b57cec5SDimitry Andric       break;
2576*0b57cec5SDimitry Andric     }
2577*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_BINOP: {  // CE_BINOP: [opcode, opval, opval]
2578*0b57cec5SDimitry Andric       if (Record.size() < 3)
2579*0b57cec5SDimitry Andric         return error("Invalid record");
2580*0b57cec5SDimitry Andric       int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
2581*0b57cec5SDimitry Andric       if (Opc < 0) {
2582*0b57cec5SDimitry Andric         V = UndefValue::get(CurTy);  // Unknown binop.
2583*0b57cec5SDimitry Andric       } else {
2584*0b57cec5SDimitry Andric         Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2585*0b57cec5SDimitry Andric         Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
2586*0b57cec5SDimitry Andric         unsigned Flags = 0;
2587*0b57cec5SDimitry Andric         if (Record.size() >= 4) {
2588*0b57cec5SDimitry Andric           if (Opc == Instruction::Add ||
2589*0b57cec5SDimitry Andric               Opc == Instruction::Sub ||
2590*0b57cec5SDimitry Andric               Opc == Instruction::Mul ||
2591*0b57cec5SDimitry Andric               Opc == Instruction::Shl) {
2592*0b57cec5SDimitry Andric             if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2593*0b57cec5SDimitry Andric               Flags |= OverflowingBinaryOperator::NoSignedWrap;
2594*0b57cec5SDimitry Andric             if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2595*0b57cec5SDimitry Andric               Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2596*0b57cec5SDimitry Andric           } else if (Opc == Instruction::SDiv ||
2597*0b57cec5SDimitry Andric                      Opc == Instruction::UDiv ||
2598*0b57cec5SDimitry Andric                      Opc == Instruction::LShr ||
2599*0b57cec5SDimitry Andric                      Opc == Instruction::AShr) {
2600*0b57cec5SDimitry Andric             if (Record[3] & (1 << bitc::PEO_EXACT))
2601*0b57cec5SDimitry Andric               Flags |= SDivOperator::IsExact;
2602*0b57cec5SDimitry Andric           }
2603*0b57cec5SDimitry Andric         }
2604*0b57cec5SDimitry Andric         V = ConstantExpr::get(Opc, LHS, RHS, Flags);
2605*0b57cec5SDimitry Andric       }
2606*0b57cec5SDimitry Andric       break;
2607*0b57cec5SDimitry Andric     }
2608*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_CAST: {  // CE_CAST: [opcode, opty, opval]
2609*0b57cec5SDimitry Andric       if (Record.size() < 3)
2610*0b57cec5SDimitry Andric         return error("Invalid record");
2611*0b57cec5SDimitry Andric       int Opc = getDecodedCastOpcode(Record[0]);
2612*0b57cec5SDimitry Andric       if (Opc < 0) {
2613*0b57cec5SDimitry Andric         V = UndefValue::get(CurTy);  // Unknown cast.
2614*0b57cec5SDimitry Andric       } else {
2615*0b57cec5SDimitry Andric         Type *OpTy = getTypeByID(Record[1]);
2616*0b57cec5SDimitry Andric         if (!OpTy)
2617*0b57cec5SDimitry Andric           return error("Invalid record");
2618*0b57cec5SDimitry Andric         Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
2619*0b57cec5SDimitry Andric         V = UpgradeBitCastExpr(Opc, Op, CurTy);
2620*0b57cec5SDimitry Andric         if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
2621*0b57cec5SDimitry Andric       }
2622*0b57cec5SDimitry Andric       break;
2623*0b57cec5SDimitry Andric     }
2624*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_INBOUNDS_GEP: // [ty, n x operands]
2625*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_GEP: // [ty, n x operands]
2626*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX: { // [ty, flags, n x
2627*0b57cec5SDimitry Andric                                                      // operands]
2628*0b57cec5SDimitry Andric       unsigned OpNum = 0;
2629*0b57cec5SDimitry Andric       Type *PointeeType = nullptr;
2630*0b57cec5SDimitry Andric       if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX ||
2631*0b57cec5SDimitry Andric           Record.size() % 2)
2632*0b57cec5SDimitry Andric         PointeeType = getTypeByID(Record[OpNum++]);
2633*0b57cec5SDimitry Andric 
2634*0b57cec5SDimitry Andric       bool InBounds = false;
2635*0b57cec5SDimitry Andric       Optional<unsigned> InRangeIndex;
2636*0b57cec5SDimitry Andric       if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX) {
2637*0b57cec5SDimitry Andric         uint64_t Op = Record[OpNum++];
2638*0b57cec5SDimitry Andric         InBounds = Op & 1;
2639*0b57cec5SDimitry Andric         InRangeIndex = Op >> 1;
2640*0b57cec5SDimitry Andric       } else if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)
2641*0b57cec5SDimitry Andric         InBounds = true;
2642*0b57cec5SDimitry Andric 
2643*0b57cec5SDimitry Andric       SmallVector<Constant*, 16> Elts;
2644*0b57cec5SDimitry Andric       Type *Elt0FullTy = nullptr;
2645*0b57cec5SDimitry Andric       while (OpNum != Record.size()) {
2646*0b57cec5SDimitry Andric         if (!Elt0FullTy)
2647*0b57cec5SDimitry Andric           Elt0FullTy = getFullyStructuredTypeByID(Record[OpNum]);
2648*0b57cec5SDimitry Andric         Type *ElTy = getTypeByID(Record[OpNum++]);
2649*0b57cec5SDimitry Andric         if (!ElTy)
2650*0b57cec5SDimitry Andric           return error("Invalid record");
2651*0b57cec5SDimitry Andric         Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
2652*0b57cec5SDimitry Andric       }
2653*0b57cec5SDimitry Andric 
2654*0b57cec5SDimitry Andric       if (Elts.size() < 1)
2655*0b57cec5SDimitry Andric         return error("Invalid gep with no operands");
2656*0b57cec5SDimitry Andric 
2657*0b57cec5SDimitry Andric       Type *ImplicitPointeeType =
2658*0b57cec5SDimitry Andric           getPointerElementFlatType(Elt0FullTy->getScalarType());
2659*0b57cec5SDimitry Andric       if (!PointeeType)
2660*0b57cec5SDimitry Andric         PointeeType = ImplicitPointeeType;
2661*0b57cec5SDimitry Andric       else if (PointeeType != ImplicitPointeeType)
2662*0b57cec5SDimitry Andric         return error("Explicit gep operator type does not match pointee type "
2663*0b57cec5SDimitry Andric                      "of pointer operand");
2664*0b57cec5SDimitry Andric 
2665*0b57cec5SDimitry Andric       ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2666*0b57cec5SDimitry Andric       V = ConstantExpr::getGetElementPtr(PointeeType, Elts[0], Indices,
2667*0b57cec5SDimitry Andric                                          InBounds, InRangeIndex);
2668*0b57cec5SDimitry Andric       break;
2669*0b57cec5SDimitry Andric     }
2670*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_SELECT: {  // CE_SELECT: [opval#, opval#, opval#]
2671*0b57cec5SDimitry Andric       if (Record.size() < 3)
2672*0b57cec5SDimitry Andric         return error("Invalid record");
2673*0b57cec5SDimitry Andric 
2674*0b57cec5SDimitry Andric       Type *SelectorTy = Type::getInt1Ty(Context);
2675*0b57cec5SDimitry Andric 
26765ffd83dbSDimitry Andric       // The selector might be an i1, an <n x i1>, or a <vscale x n x i1>
2677*0b57cec5SDimitry Andric       // Get the type from the ValueList before getting a forward ref.
2678*0b57cec5SDimitry Andric       if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
2679*0b57cec5SDimitry Andric         if (Value *V = ValueList[Record[0]])
2680*0b57cec5SDimitry Andric           if (SelectorTy != V->getType())
26815ffd83dbSDimitry Andric             SelectorTy = VectorType::get(SelectorTy,
26825ffd83dbSDimitry Andric                                          VTy->getElementCount());
2683*0b57cec5SDimitry Andric 
2684*0b57cec5SDimitry Andric       V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2685*0b57cec5SDimitry Andric                                                               SelectorTy),
2686*0b57cec5SDimitry Andric                                   ValueList.getConstantFwdRef(Record[1],CurTy),
2687*0b57cec5SDimitry Andric                                   ValueList.getConstantFwdRef(Record[2],CurTy));
2688*0b57cec5SDimitry Andric       break;
2689*0b57cec5SDimitry Andric     }
2690*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_EXTRACTELT
2691*0b57cec5SDimitry Andric         : { // CE_EXTRACTELT: [opty, opval, opty, opval]
2692*0b57cec5SDimitry Andric       if (Record.size() < 3)
2693*0b57cec5SDimitry Andric         return error("Invalid record");
2694*0b57cec5SDimitry Andric       VectorType *OpTy =
2695*0b57cec5SDimitry Andric         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2696*0b57cec5SDimitry Andric       if (!OpTy)
2697*0b57cec5SDimitry Andric         return error("Invalid record");
2698*0b57cec5SDimitry Andric       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2699*0b57cec5SDimitry Andric       Constant *Op1 = nullptr;
2700*0b57cec5SDimitry Andric       if (Record.size() == 4) {
2701*0b57cec5SDimitry Andric         Type *IdxTy = getTypeByID(Record[2]);
2702*0b57cec5SDimitry Andric         if (!IdxTy)
2703*0b57cec5SDimitry Andric           return error("Invalid record");
2704*0b57cec5SDimitry Andric         Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
27055ffd83dbSDimitry Andric       } else {
27065ffd83dbSDimitry Andric         // Deprecated, but still needed to read old bitcode files.
2707*0b57cec5SDimitry Andric         Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
27085ffd83dbSDimitry Andric       }
2709*0b57cec5SDimitry Andric       if (!Op1)
2710*0b57cec5SDimitry Andric         return error("Invalid record");
2711*0b57cec5SDimitry Andric       V = ConstantExpr::getExtractElement(Op0, Op1);
2712*0b57cec5SDimitry Andric       break;
2713*0b57cec5SDimitry Andric     }
2714*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_INSERTELT
2715*0b57cec5SDimitry Andric         : { // CE_INSERTELT: [opval, opval, opty, opval]
2716*0b57cec5SDimitry Andric       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2717*0b57cec5SDimitry Andric       if (Record.size() < 3 || !OpTy)
2718*0b57cec5SDimitry Andric         return error("Invalid record");
2719*0b57cec5SDimitry Andric       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2720*0b57cec5SDimitry Andric       Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2721*0b57cec5SDimitry Andric                                                   OpTy->getElementType());
2722*0b57cec5SDimitry Andric       Constant *Op2 = nullptr;
2723*0b57cec5SDimitry Andric       if (Record.size() == 4) {
2724*0b57cec5SDimitry Andric         Type *IdxTy = getTypeByID(Record[2]);
2725*0b57cec5SDimitry Andric         if (!IdxTy)
2726*0b57cec5SDimitry Andric           return error("Invalid record");
2727*0b57cec5SDimitry Andric         Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
27285ffd83dbSDimitry Andric       } else {
27295ffd83dbSDimitry Andric         // Deprecated, but still needed to read old bitcode files.
2730*0b57cec5SDimitry Andric         Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
27315ffd83dbSDimitry Andric       }
2732*0b57cec5SDimitry Andric       if (!Op2)
2733*0b57cec5SDimitry Andric         return error("Invalid record");
2734*0b57cec5SDimitry Andric       V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
2735*0b57cec5SDimitry Andric       break;
2736*0b57cec5SDimitry Andric     }
2737*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
2738*0b57cec5SDimitry Andric       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
2739*0b57cec5SDimitry Andric       if (Record.size() < 3 || !OpTy)
2740*0b57cec5SDimitry Andric         return error("Invalid record");
27415ffd83dbSDimitry Andric       DelayedShuffles.push_back(
27425ffd83dbSDimitry Andric           {OpTy, OpTy, CurFullTy, Record[0], Record[1], Record[2], NextCstNo});
27435ffd83dbSDimitry Andric       ++NextCstNo;
27445ffd83dbSDimitry Andric       continue;
2745*0b57cec5SDimitry Andric     }
2746*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
2747*0b57cec5SDimitry Andric       VectorType *RTy = dyn_cast<VectorType>(CurTy);
2748*0b57cec5SDimitry Andric       VectorType *OpTy =
2749*0b57cec5SDimitry Andric         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
2750*0b57cec5SDimitry Andric       if (Record.size() < 4 || !RTy || !OpTy)
2751*0b57cec5SDimitry Andric         return error("Invalid record");
27525ffd83dbSDimitry Andric       DelayedShuffles.push_back(
27535ffd83dbSDimitry Andric           {OpTy, RTy, CurFullTy, Record[1], Record[2], Record[3], NextCstNo});
27545ffd83dbSDimitry Andric       ++NextCstNo;
27555ffd83dbSDimitry Andric       continue;
2756*0b57cec5SDimitry Andric     }
2757*0b57cec5SDimitry Andric     case bitc::CST_CODE_CE_CMP: {     // CE_CMP: [opty, opval, opval, pred]
2758*0b57cec5SDimitry Andric       if (Record.size() < 4)
2759*0b57cec5SDimitry Andric         return error("Invalid record");
2760*0b57cec5SDimitry Andric       Type *OpTy = getTypeByID(Record[0]);
2761*0b57cec5SDimitry Andric       if (!OpTy)
2762*0b57cec5SDimitry Andric         return error("Invalid record");
2763*0b57cec5SDimitry Andric       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2764*0b57cec5SDimitry Andric       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2765*0b57cec5SDimitry Andric 
2766*0b57cec5SDimitry Andric       if (OpTy->isFPOrFPVectorTy())
2767*0b57cec5SDimitry Andric         V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
2768*0b57cec5SDimitry Andric       else
2769*0b57cec5SDimitry Andric         V = ConstantExpr::getICmp(Record[3], Op0, Op1);
2770*0b57cec5SDimitry Andric       break;
2771*0b57cec5SDimitry Andric     }
2772*0b57cec5SDimitry Andric     // This maintains backward compatibility, pre-asm dialect keywords.
27735ffd83dbSDimitry Andric     // Deprecated, but still needed to read old bitcode files.
2774*0b57cec5SDimitry Andric     case bitc::CST_CODE_INLINEASM_OLD: {
2775*0b57cec5SDimitry Andric       if (Record.size() < 2)
2776*0b57cec5SDimitry Andric         return error("Invalid record");
2777*0b57cec5SDimitry Andric       std::string AsmStr, ConstrStr;
2778*0b57cec5SDimitry Andric       bool HasSideEffects = Record[0] & 1;
2779*0b57cec5SDimitry Andric       bool IsAlignStack = Record[0] >> 1;
2780*0b57cec5SDimitry Andric       unsigned AsmStrSize = Record[1];
2781*0b57cec5SDimitry Andric       if (2+AsmStrSize >= Record.size())
2782*0b57cec5SDimitry Andric         return error("Invalid record");
2783*0b57cec5SDimitry Andric       unsigned ConstStrSize = Record[2+AsmStrSize];
2784*0b57cec5SDimitry Andric       if (3+AsmStrSize+ConstStrSize > Record.size())
2785*0b57cec5SDimitry Andric         return error("Invalid record");
2786*0b57cec5SDimitry Andric 
2787*0b57cec5SDimitry Andric       for (unsigned i = 0; i != AsmStrSize; ++i)
2788*0b57cec5SDimitry Andric         AsmStr += (char)Record[2+i];
2789*0b57cec5SDimitry Andric       for (unsigned i = 0; i != ConstStrSize; ++i)
2790*0b57cec5SDimitry Andric         ConstrStr += (char)Record[3+AsmStrSize+i];
2791*0b57cec5SDimitry Andric       UpgradeInlineAsmString(&AsmStr);
2792*0b57cec5SDimitry Andric       V = InlineAsm::get(
2793*0b57cec5SDimitry Andric           cast<FunctionType>(getPointerElementFlatType(CurFullTy)), AsmStr,
2794*0b57cec5SDimitry Andric           ConstrStr, HasSideEffects, IsAlignStack);
2795*0b57cec5SDimitry Andric       break;
2796*0b57cec5SDimitry Andric     }
2797*0b57cec5SDimitry Andric     // This version adds support for the asm dialect keywords (e.g.,
2798*0b57cec5SDimitry Andric     // inteldialect).
2799*0b57cec5SDimitry Andric     case bitc::CST_CODE_INLINEASM: {
2800*0b57cec5SDimitry Andric       if (Record.size() < 2)
2801*0b57cec5SDimitry Andric         return error("Invalid record");
2802*0b57cec5SDimitry Andric       std::string AsmStr, ConstrStr;
2803*0b57cec5SDimitry Andric       bool HasSideEffects = Record[0] & 1;
2804*0b57cec5SDimitry Andric       bool IsAlignStack = (Record[0] >> 1) & 1;
2805*0b57cec5SDimitry Andric       unsigned AsmDialect = Record[0] >> 2;
2806*0b57cec5SDimitry Andric       unsigned AsmStrSize = Record[1];
2807*0b57cec5SDimitry Andric       if (2+AsmStrSize >= Record.size())
2808*0b57cec5SDimitry Andric         return error("Invalid record");
2809*0b57cec5SDimitry Andric       unsigned ConstStrSize = Record[2+AsmStrSize];
2810*0b57cec5SDimitry Andric       if (3+AsmStrSize+ConstStrSize > Record.size())
2811*0b57cec5SDimitry Andric         return error("Invalid record");
2812*0b57cec5SDimitry Andric 
2813*0b57cec5SDimitry Andric       for (unsigned i = 0; i != AsmStrSize; ++i)
2814*0b57cec5SDimitry Andric         AsmStr += (char)Record[2+i];
2815*0b57cec5SDimitry Andric       for (unsigned i = 0; i != ConstStrSize; ++i)
2816*0b57cec5SDimitry Andric         ConstrStr += (char)Record[3+AsmStrSize+i];
2817*0b57cec5SDimitry Andric       UpgradeInlineAsmString(&AsmStr);
2818*0b57cec5SDimitry Andric       V = InlineAsm::get(
2819*0b57cec5SDimitry Andric           cast<FunctionType>(getPointerElementFlatType(CurFullTy)), AsmStr,
2820*0b57cec5SDimitry Andric           ConstrStr, HasSideEffects, IsAlignStack,
2821*0b57cec5SDimitry Andric           InlineAsm::AsmDialect(AsmDialect));
2822*0b57cec5SDimitry Andric       break;
2823*0b57cec5SDimitry Andric     }
2824*0b57cec5SDimitry Andric     case bitc::CST_CODE_BLOCKADDRESS:{
2825*0b57cec5SDimitry Andric       if (Record.size() < 3)
2826*0b57cec5SDimitry Andric         return error("Invalid record");
2827*0b57cec5SDimitry Andric       Type *FnTy = getTypeByID(Record[0]);
2828*0b57cec5SDimitry Andric       if (!FnTy)
2829*0b57cec5SDimitry Andric         return error("Invalid record");
2830*0b57cec5SDimitry Andric       Function *Fn =
2831*0b57cec5SDimitry Andric         dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
2832*0b57cec5SDimitry Andric       if (!Fn)
2833*0b57cec5SDimitry Andric         return error("Invalid record");
2834*0b57cec5SDimitry Andric 
2835*0b57cec5SDimitry Andric       // If the function is already parsed we can insert the block address right
2836*0b57cec5SDimitry Andric       // away.
2837*0b57cec5SDimitry Andric       BasicBlock *BB;
2838*0b57cec5SDimitry Andric       unsigned BBID = Record[2];
2839*0b57cec5SDimitry Andric       if (!BBID)
2840*0b57cec5SDimitry Andric         // Invalid reference to entry block.
2841*0b57cec5SDimitry Andric         return error("Invalid ID");
2842*0b57cec5SDimitry Andric       if (!Fn->empty()) {
2843*0b57cec5SDimitry Andric         Function::iterator BBI = Fn->begin(), BBE = Fn->end();
2844*0b57cec5SDimitry Andric         for (size_t I = 0, E = BBID; I != E; ++I) {
2845*0b57cec5SDimitry Andric           if (BBI == BBE)
2846*0b57cec5SDimitry Andric             return error("Invalid ID");
2847*0b57cec5SDimitry Andric           ++BBI;
2848*0b57cec5SDimitry Andric         }
2849*0b57cec5SDimitry Andric         BB = &*BBI;
2850*0b57cec5SDimitry Andric       } else {
2851*0b57cec5SDimitry Andric         // Otherwise insert a placeholder and remember it so it can be inserted
2852*0b57cec5SDimitry Andric         // when the function is parsed.
2853*0b57cec5SDimitry Andric         auto &FwdBBs = BasicBlockFwdRefs[Fn];
2854*0b57cec5SDimitry Andric         if (FwdBBs.empty())
2855*0b57cec5SDimitry Andric           BasicBlockFwdRefQueue.push_back(Fn);
2856*0b57cec5SDimitry Andric         if (FwdBBs.size() < BBID + 1)
2857*0b57cec5SDimitry Andric           FwdBBs.resize(BBID + 1);
2858*0b57cec5SDimitry Andric         if (!FwdBBs[BBID])
2859*0b57cec5SDimitry Andric           FwdBBs[BBID] = BasicBlock::Create(Context);
2860*0b57cec5SDimitry Andric         BB = FwdBBs[BBID];
2861*0b57cec5SDimitry Andric       }
2862*0b57cec5SDimitry Andric       V = BlockAddress::get(Fn, BB);
2863*0b57cec5SDimitry Andric       break;
2864*0b57cec5SDimitry Andric     }
2865*0b57cec5SDimitry Andric     }
2866*0b57cec5SDimitry Andric 
2867*0b57cec5SDimitry Andric     assert(V->getType() == flattenPointerTypes(CurFullTy) &&
2868*0b57cec5SDimitry Andric            "Incorrect fully structured type provided for Constant");
2869*0b57cec5SDimitry Andric     ValueList.assignValue(V, NextCstNo, CurFullTy);
2870*0b57cec5SDimitry Andric     ++NextCstNo;
2871*0b57cec5SDimitry Andric   }
2872*0b57cec5SDimitry Andric }
2873*0b57cec5SDimitry Andric 
2874*0b57cec5SDimitry Andric Error BitcodeReader::parseUseLists() {
2875*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
2876*0b57cec5SDimitry Andric     return Err;
2877*0b57cec5SDimitry Andric 
2878*0b57cec5SDimitry Andric   // Read all the records.
2879*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
2880*0b57cec5SDimitry Andric 
2881*0b57cec5SDimitry Andric   while (true) {
2882*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2883*0b57cec5SDimitry Andric     if (!MaybeEntry)
2884*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
2885*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
2886*0b57cec5SDimitry Andric 
2887*0b57cec5SDimitry Andric     switch (Entry.Kind) {
2888*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
2889*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
2890*0b57cec5SDimitry Andric       return error("Malformed block");
2891*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
2892*0b57cec5SDimitry Andric       return Error::success();
2893*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
2894*0b57cec5SDimitry Andric       // The interesting case.
2895*0b57cec5SDimitry Andric       break;
2896*0b57cec5SDimitry Andric     }
2897*0b57cec5SDimitry Andric 
2898*0b57cec5SDimitry Andric     // Read a use list record.
2899*0b57cec5SDimitry Andric     Record.clear();
2900*0b57cec5SDimitry Andric     bool IsBB = false;
2901*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2902*0b57cec5SDimitry Andric     if (!MaybeRecord)
2903*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
2904*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
2905*0b57cec5SDimitry Andric     default:  // Default behavior: unknown type.
2906*0b57cec5SDimitry Andric       break;
2907*0b57cec5SDimitry Andric     case bitc::USELIST_CODE_BB:
2908*0b57cec5SDimitry Andric       IsBB = true;
2909*0b57cec5SDimitry Andric       LLVM_FALLTHROUGH;
2910*0b57cec5SDimitry Andric     case bitc::USELIST_CODE_DEFAULT: {
2911*0b57cec5SDimitry Andric       unsigned RecordLength = Record.size();
2912*0b57cec5SDimitry Andric       if (RecordLength < 3)
2913*0b57cec5SDimitry Andric         // Records should have at least an ID and two indexes.
2914*0b57cec5SDimitry Andric         return error("Invalid record");
2915*0b57cec5SDimitry Andric       unsigned ID = Record.back();
2916*0b57cec5SDimitry Andric       Record.pop_back();
2917*0b57cec5SDimitry Andric 
2918*0b57cec5SDimitry Andric       Value *V;
2919*0b57cec5SDimitry Andric       if (IsBB) {
2920*0b57cec5SDimitry Andric         assert(ID < FunctionBBs.size() && "Basic block not found");
2921*0b57cec5SDimitry Andric         V = FunctionBBs[ID];
2922*0b57cec5SDimitry Andric       } else
2923*0b57cec5SDimitry Andric         V = ValueList[ID];
2924*0b57cec5SDimitry Andric       unsigned NumUses = 0;
2925*0b57cec5SDimitry Andric       SmallDenseMap<const Use *, unsigned, 16> Order;
2926*0b57cec5SDimitry Andric       for (const Use &U : V->materialized_uses()) {
2927*0b57cec5SDimitry Andric         if (++NumUses > Record.size())
2928*0b57cec5SDimitry Andric           break;
2929*0b57cec5SDimitry Andric         Order[&U] = Record[NumUses - 1];
2930*0b57cec5SDimitry Andric       }
2931*0b57cec5SDimitry Andric       if (Order.size() != Record.size() || NumUses > Record.size())
2932*0b57cec5SDimitry Andric         // Mismatches can happen if the functions are being materialized lazily
2933*0b57cec5SDimitry Andric         // (out-of-order), or a value has been upgraded.
2934*0b57cec5SDimitry Andric         break;
2935*0b57cec5SDimitry Andric 
2936*0b57cec5SDimitry Andric       V->sortUseList([&](const Use &L, const Use &R) {
2937*0b57cec5SDimitry Andric         return Order.lookup(&L) < Order.lookup(&R);
2938*0b57cec5SDimitry Andric       });
2939*0b57cec5SDimitry Andric       break;
2940*0b57cec5SDimitry Andric     }
2941*0b57cec5SDimitry Andric     }
2942*0b57cec5SDimitry Andric   }
2943*0b57cec5SDimitry Andric }
2944*0b57cec5SDimitry Andric 
2945*0b57cec5SDimitry Andric /// When we see the block for metadata, remember where it is and then skip it.
2946*0b57cec5SDimitry Andric /// This lets us lazily deserialize the metadata.
2947*0b57cec5SDimitry Andric Error BitcodeReader::rememberAndSkipMetadata() {
2948*0b57cec5SDimitry Andric   // Save the current stream state.
2949*0b57cec5SDimitry Andric   uint64_t CurBit = Stream.GetCurrentBitNo();
2950*0b57cec5SDimitry Andric   DeferredMetadataInfo.push_back(CurBit);
2951*0b57cec5SDimitry Andric 
2952*0b57cec5SDimitry Andric   // Skip over the block for now.
2953*0b57cec5SDimitry Andric   if (Error Err = Stream.SkipBlock())
2954*0b57cec5SDimitry Andric     return Err;
2955*0b57cec5SDimitry Andric   return Error::success();
2956*0b57cec5SDimitry Andric }
2957*0b57cec5SDimitry Andric 
2958*0b57cec5SDimitry Andric Error BitcodeReader::materializeMetadata() {
2959*0b57cec5SDimitry Andric   for (uint64_t BitPos : DeferredMetadataInfo) {
2960*0b57cec5SDimitry Andric     // Move the bit stream to the saved position.
2961*0b57cec5SDimitry Andric     if (Error JumpFailed = Stream.JumpToBit(BitPos))
2962*0b57cec5SDimitry Andric       return JumpFailed;
2963*0b57cec5SDimitry Andric     if (Error Err = MDLoader->parseModuleMetadata())
2964*0b57cec5SDimitry Andric       return Err;
2965*0b57cec5SDimitry Andric   }
2966*0b57cec5SDimitry Andric 
2967*0b57cec5SDimitry Andric   // Upgrade "Linker Options" module flag to "llvm.linker.options" module-level
2968*0b57cec5SDimitry Andric   // metadata.
2969*0b57cec5SDimitry Andric   if (Metadata *Val = TheModule->getModuleFlag("Linker Options")) {
2970*0b57cec5SDimitry Andric     NamedMDNode *LinkerOpts =
2971*0b57cec5SDimitry Andric         TheModule->getOrInsertNamedMetadata("llvm.linker.options");
2972*0b57cec5SDimitry Andric     for (const MDOperand &MDOptions : cast<MDNode>(Val)->operands())
2973*0b57cec5SDimitry Andric       LinkerOpts->addOperand(cast<MDNode>(MDOptions));
2974*0b57cec5SDimitry Andric   }
2975*0b57cec5SDimitry Andric 
2976*0b57cec5SDimitry Andric   DeferredMetadataInfo.clear();
2977*0b57cec5SDimitry Andric   return Error::success();
2978*0b57cec5SDimitry Andric }
2979*0b57cec5SDimitry Andric 
2980*0b57cec5SDimitry Andric void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
2981*0b57cec5SDimitry Andric 
2982*0b57cec5SDimitry Andric /// When we see the block for a function body, remember where it is and then
2983*0b57cec5SDimitry Andric /// skip it.  This lets us lazily deserialize the functions.
2984*0b57cec5SDimitry Andric Error BitcodeReader::rememberAndSkipFunctionBody() {
2985*0b57cec5SDimitry Andric   // Get the function we are talking about.
2986*0b57cec5SDimitry Andric   if (FunctionsWithBodies.empty())
2987*0b57cec5SDimitry Andric     return error("Insufficient function protos");
2988*0b57cec5SDimitry Andric 
2989*0b57cec5SDimitry Andric   Function *Fn = FunctionsWithBodies.back();
2990*0b57cec5SDimitry Andric   FunctionsWithBodies.pop_back();
2991*0b57cec5SDimitry Andric 
2992*0b57cec5SDimitry Andric   // Save the current stream state.
2993*0b57cec5SDimitry Andric   uint64_t CurBit = Stream.GetCurrentBitNo();
2994*0b57cec5SDimitry Andric   assert(
2995*0b57cec5SDimitry Andric       (DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&
2996*0b57cec5SDimitry Andric       "Mismatch between VST and scanned function offsets");
2997*0b57cec5SDimitry Andric   DeferredFunctionInfo[Fn] = CurBit;
2998*0b57cec5SDimitry Andric 
2999*0b57cec5SDimitry Andric   // Skip over the function block for now.
3000*0b57cec5SDimitry Andric   if (Error Err = Stream.SkipBlock())
3001*0b57cec5SDimitry Andric     return Err;
3002*0b57cec5SDimitry Andric   return Error::success();
3003*0b57cec5SDimitry Andric }
3004*0b57cec5SDimitry Andric 
3005*0b57cec5SDimitry Andric Error BitcodeReader::globalCleanup() {
3006*0b57cec5SDimitry Andric   // Patch the initializers for globals and aliases up.
3007*0b57cec5SDimitry Andric   if (Error Err = resolveGlobalAndIndirectSymbolInits())
3008*0b57cec5SDimitry Andric     return Err;
3009*0b57cec5SDimitry Andric   if (!GlobalInits.empty() || !IndirectSymbolInits.empty())
3010*0b57cec5SDimitry Andric     return error("Malformed global initializer set");
3011*0b57cec5SDimitry Andric 
3012*0b57cec5SDimitry Andric   // Look for intrinsic functions which need to be upgraded at some point
30135ffd83dbSDimitry Andric   // and functions that need to have their function attributes upgraded.
3014*0b57cec5SDimitry Andric   for (Function &F : *TheModule) {
3015*0b57cec5SDimitry Andric     MDLoader->upgradeDebugIntrinsics(F);
3016*0b57cec5SDimitry Andric     Function *NewFn;
3017*0b57cec5SDimitry Andric     if (UpgradeIntrinsicFunction(&F, NewFn))
3018*0b57cec5SDimitry Andric       UpgradedIntrinsics[&F] = NewFn;
3019*0b57cec5SDimitry Andric     else if (auto Remangled = Intrinsic::remangleIntrinsicFunction(&F))
3020*0b57cec5SDimitry Andric       // Some types could be renamed during loading if several modules are
3021*0b57cec5SDimitry Andric       // loaded in the same LLVMContext (LTO scenario). In this case we should
3022*0b57cec5SDimitry Andric       // remangle intrinsics names as well.
3023*0b57cec5SDimitry Andric       RemangledIntrinsics[&F] = Remangled.getValue();
30245ffd83dbSDimitry Andric     // Look for functions that rely on old function attribute behavior.
30255ffd83dbSDimitry Andric     UpgradeFunctionAttributes(F);
3026*0b57cec5SDimitry Andric   }
3027*0b57cec5SDimitry Andric 
3028*0b57cec5SDimitry Andric   // Look for global variables which need to be renamed.
3029*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalVariable *, GlobalVariable *>> UpgradedVariables;
3030*0b57cec5SDimitry Andric   for (GlobalVariable &GV : TheModule->globals())
3031*0b57cec5SDimitry Andric     if (GlobalVariable *Upgraded = UpgradeGlobalVariable(&GV))
3032*0b57cec5SDimitry Andric       UpgradedVariables.emplace_back(&GV, Upgraded);
3033*0b57cec5SDimitry Andric   for (auto &Pair : UpgradedVariables) {
3034*0b57cec5SDimitry Andric     Pair.first->eraseFromParent();
3035*0b57cec5SDimitry Andric     TheModule->getGlobalList().push_back(Pair.second);
3036*0b57cec5SDimitry Andric   }
3037*0b57cec5SDimitry Andric 
3038*0b57cec5SDimitry Andric   // Force deallocation of memory for these vectors to favor the client that
3039*0b57cec5SDimitry Andric   // want lazy deserialization.
3040*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalVariable *, unsigned>>().swap(GlobalInits);
3041*0b57cec5SDimitry Andric   std::vector<std::pair<GlobalIndirectSymbol *, unsigned>>().swap(
3042*0b57cec5SDimitry Andric       IndirectSymbolInits);
3043*0b57cec5SDimitry Andric   return Error::success();
3044*0b57cec5SDimitry Andric }
3045*0b57cec5SDimitry Andric 
3046*0b57cec5SDimitry Andric /// Support for lazy parsing of function bodies. This is required if we
3047*0b57cec5SDimitry Andric /// either have an old bitcode file without a VST forward declaration record,
3048*0b57cec5SDimitry Andric /// or if we have an anonymous function being materialized, since anonymous
3049*0b57cec5SDimitry Andric /// functions do not have a name and are therefore not in the VST.
3050*0b57cec5SDimitry Andric Error BitcodeReader::rememberAndSkipFunctionBodies() {
3051*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(NextUnreadBit))
3052*0b57cec5SDimitry Andric     return JumpFailed;
3053*0b57cec5SDimitry Andric 
3054*0b57cec5SDimitry Andric   if (Stream.AtEndOfStream())
3055*0b57cec5SDimitry Andric     return error("Could not find function in stream");
3056*0b57cec5SDimitry Andric 
3057*0b57cec5SDimitry Andric   if (!SeenFirstFunctionBody)
3058*0b57cec5SDimitry Andric     return error("Trying to materialize functions before seeing function blocks");
3059*0b57cec5SDimitry Andric 
3060*0b57cec5SDimitry Andric   // An old bitcode file with the symbol table at the end would have
3061*0b57cec5SDimitry Andric   // finished the parse greedily.
3062*0b57cec5SDimitry Andric   assert(SeenValueSymbolTable);
3063*0b57cec5SDimitry Andric 
3064*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
3065*0b57cec5SDimitry Andric 
3066*0b57cec5SDimitry Andric   while (true) {
3067*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
3068*0b57cec5SDimitry Andric     if (!MaybeEntry)
3069*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
3070*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
3071*0b57cec5SDimitry Andric 
3072*0b57cec5SDimitry Andric     switch (Entry.Kind) {
3073*0b57cec5SDimitry Andric     default:
3074*0b57cec5SDimitry Andric       return error("Expect SubBlock");
3075*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
3076*0b57cec5SDimitry Andric       switch (Entry.ID) {
3077*0b57cec5SDimitry Andric       default:
3078*0b57cec5SDimitry Andric         return error("Expect function block");
3079*0b57cec5SDimitry Andric       case bitc::FUNCTION_BLOCK_ID:
3080*0b57cec5SDimitry Andric         if (Error Err = rememberAndSkipFunctionBody())
3081*0b57cec5SDimitry Andric           return Err;
3082*0b57cec5SDimitry Andric         NextUnreadBit = Stream.GetCurrentBitNo();
3083*0b57cec5SDimitry Andric         return Error::success();
3084*0b57cec5SDimitry Andric       }
3085*0b57cec5SDimitry Andric     }
3086*0b57cec5SDimitry Andric   }
3087*0b57cec5SDimitry Andric }
3088*0b57cec5SDimitry Andric 
3089*0b57cec5SDimitry Andric bool BitcodeReaderBase::readBlockInfo() {
3090*0b57cec5SDimitry Andric   Expected<Optional<BitstreamBlockInfo>> MaybeNewBlockInfo =
3091*0b57cec5SDimitry Andric       Stream.ReadBlockInfoBlock();
3092*0b57cec5SDimitry Andric   if (!MaybeNewBlockInfo)
3093*0b57cec5SDimitry Andric     return true; // FIXME Handle the error.
3094*0b57cec5SDimitry Andric   Optional<BitstreamBlockInfo> NewBlockInfo =
3095*0b57cec5SDimitry Andric       std::move(MaybeNewBlockInfo.get());
3096*0b57cec5SDimitry Andric   if (!NewBlockInfo)
3097*0b57cec5SDimitry Andric     return true;
3098*0b57cec5SDimitry Andric   BlockInfo = std::move(*NewBlockInfo);
3099*0b57cec5SDimitry Andric   return false;
3100*0b57cec5SDimitry Andric }
3101*0b57cec5SDimitry Andric 
3102*0b57cec5SDimitry Andric Error BitcodeReader::parseComdatRecord(ArrayRef<uint64_t> Record) {
3103*0b57cec5SDimitry Andric   // v1: [selection_kind, name]
3104*0b57cec5SDimitry Andric   // v2: [strtab_offset, strtab_size, selection_kind]
3105*0b57cec5SDimitry Andric   StringRef Name;
3106*0b57cec5SDimitry Andric   std::tie(Name, Record) = readNameFromStrtab(Record);
3107*0b57cec5SDimitry Andric 
3108*0b57cec5SDimitry Andric   if (Record.empty())
3109*0b57cec5SDimitry Andric     return error("Invalid record");
3110*0b57cec5SDimitry Andric   Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
3111*0b57cec5SDimitry Andric   std::string OldFormatName;
3112*0b57cec5SDimitry Andric   if (!UseStrtab) {
3113*0b57cec5SDimitry Andric     if (Record.size() < 2)
3114*0b57cec5SDimitry Andric       return error("Invalid record");
3115*0b57cec5SDimitry Andric     unsigned ComdatNameSize = Record[1];
3116*0b57cec5SDimitry Andric     OldFormatName.reserve(ComdatNameSize);
3117*0b57cec5SDimitry Andric     for (unsigned i = 0; i != ComdatNameSize; ++i)
3118*0b57cec5SDimitry Andric       OldFormatName += (char)Record[2 + i];
3119*0b57cec5SDimitry Andric     Name = OldFormatName;
3120*0b57cec5SDimitry Andric   }
3121*0b57cec5SDimitry Andric   Comdat *C = TheModule->getOrInsertComdat(Name);
3122*0b57cec5SDimitry Andric   C->setSelectionKind(SK);
3123*0b57cec5SDimitry Andric   ComdatList.push_back(C);
3124*0b57cec5SDimitry Andric   return Error::success();
3125*0b57cec5SDimitry Andric }
3126*0b57cec5SDimitry Andric 
3127*0b57cec5SDimitry Andric static void inferDSOLocal(GlobalValue *GV) {
3128*0b57cec5SDimitry Andric   // infer dso_local from linkage and visibility if it is not encoded.
3129*0b57cec5SDimitry Andric   if (GV->hasLocalLinkage() ||
3130*0b57cec5SDimitry Andric       (!GV->hasDefaultVisibility() && !GV->hasExternalWeakLinkage()))
3131*0b57cec5SDimitry Andric     GV->setDSOLocal(true);
3132*0b57cec5SDimitry Andric }
3133*0b57cec5SDimitry Andric 
3134*0b57cec5SDimitry Andric Error BitcodeReader::parseGlobalVarRecord(ArrayRef<uint64_t> Record) {
3135*0b57cec5SDimitry Andric   // v1: [pointer type, isconst, initid, linkage, alignment, section,
3136*0b57cec5SDimitry Andric   // visibility, threadlocal, unnamed_addr, externally_initialized,
3137*0b57cec5SDimitry Andric   // dllstorageclass, comdat, attributes, preemption specifier,
3138*0b57cec5SDimitry Andric   // partition strtab offset, partition strtab size] (name in VST)
3139*0b57cec5SDimitry Andric   // v2: [strtab_offset, strtab_size, v1]
3140*0b57cec5SDimitry Andric   StringRef Name;
3141*0b57cec5SDimitry Andric   std::tie(Name, Record) = readNameFromStrtab(Record);
3142*0b57cec5SDimitry Andric 
3143*0b57cec5SDimitry Andric   if (Record.size() < 6)
3144*0b57cec5SDimitry Andric     return error("Invalid record");
3145*0b57cec5SDimitry Andric   Type *FullTy = getFullyStructuredTypeByID(Record[0]);
3146*0b57cec5SDimitry Andric   Type *Ty = flattenPointerTypes(FullTy);
3147*0b57cec5SDimitry Andric   if (!Ty)
3148*0b57cec5SDimitry Andric     return error("Invalid record");
3149*0b57cec5SDimitry Andric   bool isConstant = Record[1] & 1;
3150*0b57cec5SDimitry Andric   bool explicitType = Record[1] & 2;
3151*0b57cec5SDimitry Andric   unsigned AddressSpace;
3152*0b57cec5SDimitry Andric   if (explicitType) {
3153*0b57cec5SDimitry Andric     AddressSpace = Record[1] >> 2;
3154*0b57cec5SDimitry Andric   } else {
3155*0b57cec5SDimitry Andric     if (!Ty->isPointerTy())
3156*0b57cec5SDimitry Andric       return error("Invalid type for value");
3157*0b57cec5SDimitry Andric     AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
3158*0b57cec5SDimitry Andric     std::tie(FullTy, Ty) = getPointerElementTypes(FullTy);
3159*0b57cec5SDimitry Andric   }
3160*0b57cec5SDimitry Andric 
3161*0b57cec5SDimitry Andric   uint64_t RawLinkage = Record[3];
3162*0b57cec5SDimitry Andric   GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
31638bcb0991SDimitry Andric   MaybeAlign Alignment;
3164*0b57cec5SDimitry Andric   if (Error Err = parseAlignmentValue(Record[4], Alignment))
3165*0b57cec5SDimitry Andric     return Err;
3166*0b57cec5SDimitry Andric   std::string Section;
3167*0b57cec5SDimitry Andric   if (Record[5]) {
3168*0b57cec5SDimitry Andric     if (Record[5] - 1 >= SectionTable.size())
3169*0b57cec5SDimitry Andric       return error("Invalid ID");
3170*0b57cec5SDimitry Andric     Section = SectionTable[Record[5] - 1];
3171*0b57cec5SDimitry Andric   }
3172*0b57cec5SDimitry Andric   GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
3173*0b57cec5SDimitry Andric   // Local linkage must have default visibility.
31745ffd83dbSDimitry Andric   // auto-upgrade `hidden` and `protected` for old bitcode.
3175*0b57cec5SDimitry Andric   if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
3176*0b57cec5SDimitry Andric     Visibility = getDecodedVisibility(Record[6]);
3177*0b57cec5SDimitry Andric 
3178*0b57cec5SDimitry Andric   GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
3179*0b57cec5SDimitry Andric   if (Record.size() > 7)
3180*0b57cec5SDimitry Andric     TLM = getDecodedThreadLocalMode(Record[7]);
3181*0b57cec5SDimitry Andric 
3182*0b57cec5SDimitry Andric   GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;
3183*0b57cec5SDimitry Andric   if (Record.size() > 8)
3184*0b57cec5SDimitry Andric     UnnamedAddr = getDecodedUnnamedAddrType(Record[8]);
3185*0b57cec5SDimitry Andric 
3186*0b57cec5SDimitry Andric   bool ExternallyInitialized = false;
3187*0b57cec5SDimitry Andric   if (Record.size() > 9)
3188*0b57cec5SDimitry Andric     ExternallyInitialized = Record[9];
3189*0b57cec5SDimitry Andric 
3190*0b57cec5SDimitry Andric   GlobalVariable *NewGV =
3191*0b57cec5SDimitry Andric       new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, Name,
3192*0b57cec5SDimitry Andric                          nullptr, TLM, AddressSpace, ExternallyInitialized);
3193*0b57cec5SDimitry Andric   NewGV->setAlignment(Alignment);
3194*0b57cec5SDimitry Andric   if (!Section.empty())
3195*0b57cec5SDimitry Andric     NewGV->setSection(Section);
3196*0b57cec5SDimitry Andric   NewGV->setVisibility(Visibility);
3197*0b57cec5SDimitry Andric   NewGV->setUnnamedAddr(UnnamedAddr);
3198*0b57cec5SDimitry Andric 
3199*0b57cec5SDimitry Andric   if (Record.size() > 10)
3200*0b57cec5SDimitry Andric     NewGV->setDLLStorageClass(getDecodedDLLStorageClass(Record[10]));
3201*0b57cec5SDimitry Andric   else
3202*0b57cec5SDimitry Andric     upgradeDLLImportExportLinkage(NewGV, RawLinkage);
3203*0b57cec5SDimitry Andric 
3204*0b57cec5SDimitry Andric   FullTy = PointerType::get(FullTy, AddressSpace);
3205*0b57cec5SDimitry Andric   assert(NewGV->getType() == flattenPointerTypes(FullTy) &&
3206*0b57cec5SDimitry Andric          "Incorrect fully specified type for GlobalVariable");
3207*0b57cec5SDimitry Andric   ValueList.push_back(NewGV, FullTy);
3208*0b57cec5SDimitry Andric 
3209*0b57cec5SDimitry Andric   // Remember which value to use for the global initializer.
3210*0b57cec5SDimitry Andric   if (unsigned InitID = Record[2])
3211*0b57cec5SDimitry Andric     GlobalInits.push_back(std::make_pair(NewGV, InitID - 1));
3212*0b57cec5SDimitry Andric 
3213*0b57cec5SDimitry Andric   if (Record.size() > 11) {
3214*0b57cec5SDimitry Andric     if (unsigned ComdatID = Record[11]) {
3215*0b57cec5SDimitry Andric       if (ComdatID > ComdatList.size())
3216*0b57cec5SDimitry Andric         return error("Invalid global variable comdat ID");
3217*0b57cec5SDimitry Andric       NewGV->setComdat(ComdatList[ComdatID - 1]);
3218*0b57cec5SDimitry Andric     }
3219*0b57cec5SDimitry Andric   } else if (hasImplicitComdat(RawLinkage)) {
3220*0b57cec5SDimitry Andric     NewGV->setComdat(reinterpret_cast<Comdat *>(1));
3221*0b57cec5SDimitry Andric   }
3222*0b57cec5SDimitry Andric 
3223*0b57cec5SDimitry Andric   if (Record.size() > 12) {
3224*0b57cec5SDimitry Andric     auto AS = getAttributes(Record[12]).getFnAttributes();
3225*0b57cec5SDimitry Andric     NewGV->setAttributes(AS);
3226*0b57cec5SDimitry Andric   }
3227*0b57cec5SDimitry Andric 
3228*0b57cec5SDimitry Andric   if (Record.size() > 13) {
3229*0b57cec5SDimitry Andric     NewGV->setDSOLocal(getDecodedDSOLocal(Record[13]));
3230*0b57cec5SDimitry Andric   }
3231*0b57cec5SDimitry Andric   inferDSOLocal(NewGV);
3232*0b57cec5SDimitry Andric 
3233*0b57cec5SDimitry Andric   // Check whether we have enough values to read a partition name.
3234*0b57cec5SDimitry Andric   if (Record.size() > 15)
3235*0b57cec5SDimitry Andric     NewGV->setPartition(StringRef(Strtab.data() + Record[14], Record[15]));
3236*0b57cec5SDimitry Andric 
3237*0b57cec5SDimitry Andric   return Error::success();
3238*0b57cec5SDimitry Andric }
3239*0b57cec5SDimitry Andric 
3240*0b57cec5SDimitry Andric Error BitcodeReader::parseFunctionRecord(ArrayRef<uint64_t> Record) {
3241*0b57cec5SDimitry Andric   // v1: [type, callingconv, isproto, linkage, paramattr, alignment, section,
3242*0b57cec5SDimitry Andric   // visibility, gc, unnamed_addr, prologuedata, dllstorageclass, comdat,
3243*0b57cec5SDimitry Andric   // prefixdata,  personalityfn, preemption specifier, addrspace] (name in VST)
3244*0b57cec5SDimitry Andric   // v2: [strtab_offset, strtab_size, v1]
3245*0b57cec5SDimitry Andric   StringRef Name;
3246*0b57cec5SDimitry Andric   std::tie(Name, Record) = readNameFromStrtab(Record);
3247*0b57cec5SDimitry Andric 
3248*0b57cec5SDimitry Andric   if (Record.size() < 8)
3249*0b57cec5SDimitry Andric     return error("Invalid record");
3250*0b57cec5SDimitry Andric   Type *FullFTy = getFullyStructuredTypeByID(Record[0]);
3251*0b57cec5SDimitry Andric   Type *FTy = flattenPointerTypes(FullFTy);
3252*0b57cec5SDimitry Andric   if (!FTy)
3253*0b57cec5SDimitry Andric     return error("Invalid record");
3254*0b57cec5SDimitry Andric   if (isa<PointerType>(FTy))
3255*0b57cec5SDimitry Andric     std::tie(FullFTy, FTy) = getPointerElementTypes(FullFTy);
3256*0b57cec5SDimitry Andric 
3257*0b57cec5SDimitry Andric   if (!isa<FunctionType>(FTy))
3258*0b57cec5SDimitry Andric     return error("Invalid type for value");
3259*0b57cec5SDimitry Andric   auto CC = static_cast<CallingConv::ID>(Record[1]);
3260*0b57cec5SDimitry Andric   if (CC & ~CallingConv::MaxID)
3261*0b57cec5SDimitry Andric     return error("Invalid calling convention ID");
3262*0b57cec5SDimitry Andric 
3263*0b57cec5SDimitry Andric   unsigned AddrSpace = TheModule->getDataLayout().getProgramAddressSpace();
3264*0b57cec5SDimitry Andric   if (Record.size() > 16)
3265*0b57cec5SDimitry Andric     AddrSpace = Record[16];
3266*0b57cec5SDimitry Andric 
3267*0b57cec5SDimitry Andric   Function *Func =
3268*0b57cec5SDimitry Andric       Function::Create(cast<FunctionType>(FTy), GlobalValue::ExternalLinkage,
3269*0b57cec5SDimitry Andric                        AddrSpace, Name, TheModule);
3270*0b57cec5SDimitry Andric 
3271*0b57cec5SDimitry Andric   assert(Func->getFunctionType() == flattenPointerTypes(FullFTy) &&
3272*0b57cec5SDimitry Andric          "Incorrect fully specified type provided for function");
3273*0b57cec5SDimitry Andric   FunctionTypes[Func] = cast<FunctionType>(FullFTy);
3274*0b57cec5SDimitry Andric 
3275*0b57cec5SDimitry Andric   Func->setCallingConv(CC);
3276*0b57cec5SDimitry Andric   bool isProto = Record[2];
3277*0b57cec5SDimitry Andric   uint64_t RawLinkage = Record[3];
3278*0b57cec5SDimitry Andric   Func->setLinkage(getDecodedLinkage(RawLinkage));
3279*0b57cec5SDimitry Andric   Func->setAttributes(getAttributes(Record[4]));
3280*0b57cec5SDimitry Andric 
3281*0b57cec5SDimitry Andric   // Upgrade any old-style byval without a type by propagating the argument's
3282*0b57cec5SDimitry Andric   // pointee type. There should be no opaque pointers where the byval type is
3283*0b57cec5SDimitry Andric   // implicit.
3284*0b57cec5SDimitry Andric   for (unsigned i = 0; i != Func->arg_size(); ++i) {
3285*0b57cec5SDimitry Andric     if (!Func->hasParamAttribute(i, Attribute::ByVal))
3286*0b57cec5SDimitry Andric       continue;
3287*0b57cec5SDimitry Andric 
3288*0b57cec5SDimitry Andric     Type *PTy = cast<FunctionType>(FullFTy)->getParamType(i);
3289*0b57cec5SDimitry Andric     Func->removeParamAttr(i, Attribute::ByVal);
3290*0b57cec5SDimitry Andric     Func->addParamAttr(i, Attribute::getWithByValType(
3291*0b57cec5SDimitry Andric                               Context, getPointerElementFlatType(PTy)));
3292*0b57cec5SDimitry Andric   }
3293*0b57cec5SDimitry Andric 
32948bcb0991SDimitry Andric   MaybeAlign Alignment;
3295*0b57cec5SDimitry Andric   if (Error Err = parseAlignmentValue(Record[5], Alignment))
3296*0b57cec5SDimitry Andric     return Err;
3297*0b57cec5SDimitry Andric   Func->setAlignment(Alignment);
3298*0b57cec5SDimitry Andric   if (Record[6]) {
3299*0b57cec5SDimitry Andric     if (Record[6] - 1 >= SectionTable.size())
3300*0b57cec5SDimitry Andric       return error("Invalid ID");
3301*0b57cec5SDimitry Andric     Func->setSection(SectionTable[Record[6] - 1]);
3302*0b57cec5SDimitry Andric   }
3303*0b57cec5SDimitry Andric   // Local linkage must have default visibility.
33045ffd83dbSDimitry Andric   // auto-upgrade `hidden` and `protected` for old bitcode.
3305*0b57cec5SDimitry Andric   if (!Func->hasLocalLinkage())
3306*0b57cec5SDimitry Andric     Func->setVisibility(getDecodedVisibility(Record[7]));
3307*0b57cec5SDimitry Andric   if (Record.size() > 8 && Record[8]) {
3308*0b57cec5SDimitry Andric     if (Record[8] - 1 >= GCTable.size())
3309*0b57cec5SDimitry Andric       return error("Invalid ID");
3310*0b57cec5SDimitry Andric     Func->setGC(GCTable[Record[8] - 1]);
3311*0b57cec5SDimitry Andric   }
3312*0b57cec5SDimitry Andric   GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;
3313*0b57cec5SDimitry Andric   if (Record.size() > 9)
3314*0b57cec5SDimitry Andric     UnnamedAddr = getDecodedUnnamedAddrType(Record[9]);
3315*0b57cec5SDimitry Andric   Func->setUnnamedAddr(UnnamedAddr);
3316*0b57cec5SDimitry Andric   if (Record.size() > 10 && Record[10] != 0)
3317*0b57cec5SDimitry Andric     FunctionPrologues.push_back(std::make_pair(Func, Record[10] - 1));
3318*0b57cec5SDimitry Andric 
3319*0b57cec5SDimitry Andric   if (Record.size() > 11)
3320*0b57cec5SDimitry Andric     Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));
3321*0b57cec5SDimitry Andric   else
3322*0b57cec5SDimitry Andric     upgradeDLLImportExportLinkage(Func, RawLinkage);
3323*0b57cec5SDimitry Andric 
3324*0b57cec5SDimitry Andric   if (Record.size() > 12) {
3325*0b57cec5SDimitry Andric     if (unsigned ComdatID = Record[12]) {
3326*0b57cec5SDimitry Andric       if (ComdatID > ComdatList.size())
3327*0b57cec5SDimitry Andric         return error("Invalid function comdat ID");
3328*0b57cec5SDimitry Andric       Func->setComdat(ComdatList[ComdatID - 1]);
3329*0b57cec5SDimitry Andric     }
3330*0b57cec5SDimitry Andric   } else if (hasImplicitComdat(RawLinkage)) {
3331*0b57cec5SDimitry Andric     Func->setComdat(reinterpret_cast<Comdat *>(1));
3332*0b57cec5SDimitry Andric   }
3333*0b57cec5SDimitry Andric 
3334*0b57cec5SDimitry Andric   if (Record.size() > 13 && Record[13] != 0)
3335*0b57cec5SDimitry Andric     FunctionPrefixes.push_back(std::make_pair(Func, Record[13] - 1));
3336*0b57cec5SDimitry Andric 
3337*0b57cec5SDimitry Andric   if (Record.size() > 14 && Record[14] != 0)
3338*0b57cec5SDimitry Andric     FunctionPersonalityFns.push_back(std::make_pair(Func, Record[14] - 1));
3339*0b57cec5SDimitry Andric 
3340*0b57cec5SDimitry Andric   if (Record.size() > 15) {
3341*0b57cec5SDimitry Andric     Func->setDSOLocal(getDecodedDSOLocal(Record[15]));
3342*0b57cec5SDimitry Andric   }
3343*0b57cec5SDimitry Andric   inferDSOLocal(Func);
3344*0b57cec5SDimitry Andric 
3345*0b57cec5SDimitry Andric   // Record[16] is the address space number.
3346*0b57cec5SDimitry Andric 
3347*0b57cec5SDimitry Andric   // Check whether we have enough values to read a partition name.
3348*0b57cec5SDimitry Andric   if (Record.size() > 18)
3349*0b57cec5SDimitry Andric     Func->setPartition(StringRef(Strtab.data() + Record[17], Record[18]));
3350*0b57cec5SDimitry Andric 
3351*0b57cec5SDimitry Andric   Type *FullTy = PointerType::get(FullFTy, AddrSpace);
3352*0b57cec5SDimitry Andric   assert(Func->getType() == flattenPointerTypes(FullTy) &&
3353*0b57cec5SDimitry Andric          "Incorrect fully specified type provided for Function");
3354*0b57cec5SDimitry Andric   ValueList.push_back(Func, FullTy);
3355*0b57cec5SDimitry Andric 
3356*0b57cec5SDimitry Andric   // If this is a function with a body, remember the prototype we are
3357*0b57cec5SDimitry Andric   // creating now, so that we can match up the body with them later.
3358*0b57cec5SDimitry Andric   if (!isProto) {
3359*0b57cec5SDimitry Andric     Func->setIsMaterializable(true);
3360*0b57cec5SDimitry Andric     FunctionsWithBodies.push_back(Func);
3361*0b57cec5SDimitry Andric     DeferredFunctionInfo[Func] = 0;
3362*0b57cec5SDimitry Andric   }
3363*0b57cec5SDimitry Andric   return Error::success();
3364*0b57cec5SDimitry Andric }
3365*0b57cec5SDimitry Andric 
3366*0b57cec5SDimitry Andric Error BitcodeReader::parseGlobalIndirectSymbolRecord(
3367*0b57cec5SDimitry Andric     unsigned BitCode, ArrayRef<uint64_t> Record) {
3368*0b57cec5SDimitry Andric   // v1 ALIAS_OLD: [alias type, aliasee val#, linkage] (name in VST)
3369*0b57cec5SDimitry Andric   // v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, visibility,
3370*0b57cec5SDimitry Andric   // dllstorageclass, threadlocal, unnamed_addr,
3371*0b57cec5SDimitry Andric   // preemption specifier] (name in VST)
3372*0b57cec5SDimitry Andric   // v1 IFUNC: [alias type, addrspace, aliasee val#, linkage,
3373*0b57cec5SDimitry Andric   // visibility, dllstorageclass, threadlocal, unnamed_addr,
3374*0b57cec5SDimitry Andric   // preemption specifier] (name in VST)
3375*0b57cec5SDimitry Andric   // v2: [strtab_offset, strtab_size, v1]
3376*0b57cec5SDimitry Andric   StringRef Name;
3377*0b57cec5SDimitry Andric   std::tie(Name, Record) = readNameFromStrtab(Record);
3378*0b57cec5SDimitry Andric 
3379*0b57cec5SDimitry Andric   bool NewRecord = BitCode != bitc::MODULE_CODE_ALIAS_OLD;
3380*0b57cec5SDimitry Andric   if (Record.size() < (3 + (unsigned)NewRecord))
3381*0b57cec5SDimitry Andric     return error("Invalid record");
3382*0b57cec5SDimitry Andric   unsigned OpNum = 0;
3383*0b57cec5SDimitry Andric   Type *FullTy = getFullyStructuredTypeByID(Record[OpNum++]);
3384*0b57cec5SDimitry Andric   Type *Ty = flattenPointerTypes(FullTy);
3385*0b57cec5SDimitry Andric   if (!Ty)
3386*0b57cec5SDimitry Andric     return error("Invalid record");
3387*0b57cec5SDimitry Andric 
3388*0b57cec5SDimitry Andric   unsigned AddrSpace;
3389*0b57cec5SDimitry Andric   if (!NewRecord) {
3390*0b57cec5SDimitry Andric     auto *PTy = dyn_cast<PointerType>(Ty);
3391*0b57cec5SDimitry Andric     if (!PTy)
3392*0b57cec5SDimitry Andric       return error("Invalid type for value");
3393*0b57cec5SDimitry Andric     std::tie(FullTy, Ty) = getPointerElementTypes(FullTy);
3394*0b57cec5SDimitry Andric     AddrSpace = PTy->getAddressSpace();
3395*0b57cec5SDimitry Andric   } else {
3396*0b57cec5SDimitry Andric     AddrSpace = Record[OpNum++];
3397*0b57cec5SDimitry Andric   }
3398*0b57cec5SDimitry Andric 
3399*0b57cec5SDimitry Andric   auto Val = Record[OpNum++];
3400*0b57cec5SDimitry Andric   auto Linkage = Record[OpNum++];
3401*0b57cec5SDimitry Andric   GlobalIndirectSymbol *NewGA;
3402*0b57cec5SDimitry Andric   if (BitCode == bitc::MODULE_CODE_ALIAS ||
3403*0b57cec5SDimitry Andric       BitCode == bitc::MODULE_CODE_ALIAS_OLD)
3404*0b57cec5SDimitry Andric     NewGA = GlobalAlias::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,
3405*0b57cec5SDimitry Andric                                 TheModule);
3406*0b57cec5SDimitry Andric   else
3407*0b57cec5SDimitry Andric     NewGA = GlobalIFunc::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,
3408*0b57cec5SDimitry Andric                                 nullptr, TheModule);
3409*0b57cec5SDimitry Andric 
3410*0b57cec5SDimitry Andric   assert(NewGA->getValueType() == flattenPointerTypes(FullTy) &&
3411*0b57cec5SDimitry Andric          "Incorrect fully structured type provided for GlobalIndirectSymbol");
3412*0b57cec5SDimitry Andric   // Local linkage must have default visibility.
34135ffd83dbSDimitry Andric   // auto-upgrade `hidden` and `protected` for old bitcode.
3414*0b57cec5SDimitry Andric   if (OpNum != Record.size()) {
3415*0b57cec5SDimitry Andric     auto VisInd = OpNum++;
3416*0b57cec5SDimitry Andric     if (!NewGA->hasLocalLinkage())
3417*0b57cec5SDimitry Andric       NewGA->setVisibility(getDecodedVisibility(Record[VisInd]));
3418*0b57cec5SDimitry Andric   }
3419*0b57cec5SDimitry Andric   if (BitCode == bitc::MODULE_CODE_ALIAS ||
3420*0b57cec5SDimitry Andric       BitCode == bitc::MODULE_CODE_ALIAS_OLD) {
3421*0b57cec5SDimitry Andric     if (OpNum != Record.size())
3422*0b57cec5SDimitry Andric       NewGA->setDLLStorageClass(getDecodedDLLStorageClass(Record[OpNum++]));
3423*0b57cec5SDimitry Andric     else
3424*0b57cec5SDimitry Andric       upgradeDLLImportExportLinkage(NewGA, Linkage);
3425*0b57cec5SDimitry Andric     if (OpNum != Record.size())
3426*0b57cec5SDimitry Andric       NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[OpNum++]));
3427*0b57cec5SDimitry Andric     if (OpNum != Record.size())
3428*0b57cec5SDimitry Andric       NewGA->setUnnamedAddr(getDecodedUnnamedAddrType(Record[OpNum++]));
3429*0b57cec5SDimitry Andric   }
3430*0b57cec5SDimitry Andric   if (OpNum != Record.size())
3431*0b57cec5SDimitry Andric     NewGA->setDSOLocal(getDecodedDSOLocal(Record[OpNum++]));
3432*0b57cec5SDimitry Andric   inferDSOLocal(NewGA);
3433*0b57cec5SDimitry Andric 
3434*0b57cec5SDimitry Andric   // Check whether we have enough values to read a partition name.
3435*0b57cec5SDimitry Andric   if (OpNum + 1 < Record.size()) {
3436*0b57cec5SDimitry Andric     NewGA->setPartition(
3437*0b57cec5SDimitry Andric         StringRef(Strtab.data() + Record[OpNum], Record[OpNum + 1]));
3438*0b57cec5SDimitry Andric     OpNum += 2;
3439*0b57cec5SDimitry Andric   }
3440*0b57cec5SDimitry Andric 
3441*0b57cec5SDimitry Andric   FullTy = PointerType::get(FullTy, AddrSpace);
3442*0b57cec5SDimitry Andric   assert(NewGA->getType() == flattenPointerTypes(FullTy) &&
3443*0b57cec5SDimitry Andric          "Incorrect fully structured type provided for GlobalIndirectSymbol");
3444*0b57cec5SDimitry Andric   ValueList.push_back(NewGA, FullTy);
3445*0b57cec5SDimitry Andric   IndirectSymbolInits.push_back(std::make_pair(NewGA, Val));
3446*0b57cec5SDimitry Andric   return Error::success();
3447*0b57cec5SDimitry Andric }
3448*0b57cec5SDimitry Andric 
3449*0b57cec5SDimitry Andric Error BitcodeReader::parseModule(uint64_t ResumeBit,
34505ffd83dbSDimitry Andric                                  bool ShouldLazyLoadMetadata,
34515ffd83dbSDimitry Andric                                  DataLayoutCallbackTy DataLayoutCallback) {
3452*0b57cec5SDimitry Andric   if (ResumeBit) {
3453*0b57cec5SDimitry Andric     if (Error JumpFailed = Stream.JumpToBit(ResumeBit))
3454*0b57cec5SDimitry Andric       return JumpFailed;
3455*0b57cec5SDimitry Andric   } else if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
3456*0b57cec5SDimitry Andric     return Err;
3457*0b57cec5SDimitry Andric 
3458*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
3459*0b57cec5SDimitry Andric 
34605ffd83dbSDimitry Andric   // Parts of bitcode parsing depend on the datalayout.  Make sure we
34615ffd83dbSDimitry Andric   // finalize the datalayout before we run any of that code.
34625ffd83dbSDimitry Andric   bool ResolvedDataLayout = false;
34635ffd83dbSDimitry Andric   auto ResolveDataLayout = [&] {
34645ffd83dbSDimitry Andric     if (ResolvedDataLayout)
34655ffd83dbSDimitry Andric       return;
34665ffd83dbSDimitry Andric 
34675ffd83dbSDimitry Andric     // datalayout and triple can't be parsed after this point.
34685ffd83dbSDimitry Andric     ResolvedDataLayout = true;
34695ffd83dbSDimitry Andric 
34705ffd83dbSDimitry Andric     // Upgrade data layout string.
34715ffd83dbSDimitry Andric     std::string DL = llvm::UpgradeDataLayoutString(
34725ffd83dbSDimitry Andric         TheModule->getDataLayoutStr(), TheModule->getTargetTriple());
34735ffd83dbSDimitry Andric     TheModule->setDataLayout(DL);
34745ffd83dbSDimitry Andric 
34755ffd83dbSDimitry Andric     if (auto LayoutOverride =
34765ffd83dbSDimitry Andric             DataLayoutCallback(TheModule->getTargetTriple()))
34775ffd83dbSDimitry Andric       TheModule->setDataLayout(*LayoutOverride);
34785ffd83dbSDimitry Andric   };
34795ffd83dbSDimitry Andric 
3480*0b57cec5SDimitry Andric   // Read all the records for this module.
3481*0b57cec5SDimitry Andric   while (true) {
3482*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
3483*0b57cec5SDimitry Andric     if (!MaybeEntry)
3484*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
3485*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
3486*0b57cec5SDimitry Andric 
3487*0b57cec5SDimitry Andric     switch (Entry.Kind) {
3488*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
3489*0b57cec5SDimitry Andric       return error("Malformed block");
3490*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
34915ffd83dbSDimitry Andric       ResolveDataLayout();
3492*0b57cec5SDimitry Andric       return globalCleanup();
3493*0b57cec5SDimitry Andric 
3494*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
3495*0b57cec5SDimitry Andric       switch (Entry.ID) {
3496*0b57cec5SDimitry Andric       default:  // Skip unknown content.
3497*0b57cec5SDimitry Andric         if (Error Err = Stream.SkipBlock())
3498*0b57cec5SDimitry Andric           return Err;
3499*0b57cec5SDimitry Andric         break;
3500*0b57cec5SDimitry Andric       case bitc::BLOCKINFO_BLOCK_ID:
3501*0b57cec5SDimitry Andric         if (readBlockInfo())
3502*0b57cec5SDimitry Andric           return error("Malformed block");
3503*0b57cec5SDimitry Andric         break;
3504*0b57cec5SDimitry Andric       case bitc::PARAMATTR_BLOCK_ID:
3505*0b57cec5SDimitry Andric         if (Error Err = parseAttributeBlock())
3506*0b57cec5SDimitry Andric           return Err;
3507*0b57cec5SDimitry Andric         break;
3508*0b57cec5SDimitry Andric       case bitc::PARAMATTR_GROUP_BLOCK_ID:
3509*0b57cec5SDimitry Andric         if (Error Err = parseAttributeGroupBlock())
3510*0b57cec5SDimitry Andric           return Err;
3511*0b57cec5SDimitry Andric         break;
3512*0b57cec5SDimitry Andric       case bitc::TYPE_BLOCK_ID_NEW:
3513*0b57cec5SDimitry Andric         if (Error Err = parseTypeTable())
3514*0b57cec5SDimitry Andric           return Err;
3515*0b57cec5SDimitry Andric         break;
3516*0b57cec5SDimitry Andric       case bitc::VALUE_SYMTAB_BLOCK_ID:
3517*0b57cec5SDimitry Andric         if (!SeenValueSymbolTable) {
3518*0b57cec5SDimitry Andric           // Either this is an old form VST without function index and an
3519*0b57cec5SDimitry Andric           // associated VST forward declaration record (which would have caused
3520*0b57cec5SDimitry Andric           // the VST to be jumped to and parsed before it was encountered
3521*0b57cec5SDimitry Andric           // normally in the stream), or there were no function blocks to
3522*0b57cec5SDimitry Andric           // trigger an earlier parsing of the VST.
3523*0b57cec5SDimitry Andric           assert(VSTOffset == 0 || FunctionsWithBodies.empty());
3524*0b57cec5SDimitry Andric           if (Error Err = parseValueSymbolTable())
3525*0b57cec5SDimitry Andric             return Err;
3526*0b57cec5SDimitry Andric           SeenValueSymbolTable = true;
3527*0b57cec5SDimitry Andric         } else {
3528*0b57cec5SDimitry Andric           // We must have had a VST forward declaration record, which caused
3529*0b57cec5SDimitry Andric           // the parser to jump to and parse the VST earlier.
3530*0b57cec5SDimitry Andric           assert(VSTOffset > 0);
3531*0b57cec5SDimitry Andric           if (Error Err = Stream.SkipBlock())
3532*0b57cec5SDimitry Andric             return Err;
3533*0b57cec5SDimitry Andric         }
3534*0b57cec5SDimitry Andric         break;
3535*0b57cec5SDimitry Andric       case bitc::CONSTANTS_BLOCK_ID:
3536*0b57cec5SDimitry Andric         if (Error Err = parseConstants())
3537*0b57cec5SDimitry Andric           return Err;
3538*0b57cec5SDimitry Andric         if (Error Err = resolveGlobalAndIndirectSymbolInits())
3539*0b57cec5SDimitry Andric           return Err;
3540*0b57cec5SDimitry Andric         break;
3541*0b57cec5SDimitry Andric       case bitc::METADATA_BLOCK_ID:
3542*0b57cec5SDimitry Andric         if (ShouldLazyLoadMetadata) {
3543*0b57cec5SDimitry Andric           if (Error Err = rememberAndSkipMetadata())
3544*0b57cec5SDimitry Andric             return Err;
3545*0b57cec5SDimitry Andric           break;
3546*0b57cec5SDimitry Andric         }
3547*0b57cec5SDimitry Andric         assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
3548*0b57cec5SDimitry Andric         if (Error Err = MDLoader->parseModuleMetadata())
3549*0b57cec5SDimitry Andric           return Err;
3550*0b57cec5SDimitry Andric         break;
3551*0b57cec5SDimitry Andric       case bitc::METADATA_KIND_BLOCK_ID:
3552*0b57cec5SDimitry Andric         if (Error Err = MDLoader->parseMetadataKinds())
3553*0b57cec5SDimitry Andric           return Err;
3554*0b57cec5SDimitry Andric         break;
3555*0b57cec5SDimitry Andric       case bitc::FUNCTION_BLOCK_ID:
35565ffd83dbSDimitry Andric         ResolveDataLayout();
35575ffd83dbSDimitry Andric 
3558*0b57cec5SDimitry Andric         // If this is the first function body we've seen, reverse the
3559*0b57cec5SDimitry Andric         // FunctionsWithBodies list.
3560*0b57cec5SDimitry Andric         if (!SeenFirstFunctionBody) {
3561*0b57cec5SDimitry Andric           std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
3562*0b57cec5SDimitry Andric           if (Error Err = globalCleanup())
3563*0b57cec5SDimitry Andric             return Err;
3564*0b57cec5SDimitry Andric           SeenFirstFunctionBody = true;
3565*0b57cec5SDimitry Andric         }
3566*0b57cec5SDimitry Andric 
3567*0b57cec5SDimitry Andric         if (VSTOffset > 0) {
3568*0b57cec5SDimitry Andric           // If we have a VST forward declaration record, make sure we
3569*0b57cec5SDimitry Andric           // parse the VST now if we haven't already. It is needed to
3570*0b57cec5SDimitry Andric           // set up the DeferredFunctionInfo vector for lazy reading.
3571*0b57cec5SDimitry Andric           if (!SeenValueSymbolTable) {
3572*0b57cec5SDimitry Andric             if (Error Err = BitcodeReader::parseValueSymbolTable(VSTOffset))
3573*0b57cec5SDimitry Andric               return Err;
3574*0b57cec5SDimitry Andric             SeenValueSymbolTable = true;
3575*0b57cec5SDimitry Andric             // Fall through so that we record the NextUnreadBit below.
3576*0b57cec5SDimitry Andric             // This is necessary in case we have an anonymous function that
3577*0b57cec5SDimitry Andric             // is later materialized. Since it will not have a VST entry we
3578*0b57cec5SDimitry Andric             // need to fall back to the lazy parse to find its offset.
3579*0b57cec5SDimitry Andric           } else {
3580*0b57cec5SDimitry Andric             // If we have a VST forward declaration record, but have already
3581*0b57cec5SDimitry Andric             // parsed the VST (just above, when the first function body was
3582*0b57cec5SDimitry Andric             // encountered here), then we are resuming the parse after
3583*0b57cec5SDimitry Andric             // materializing functions. The ResumeBit points to the
3584*0b57cec5SDimitry Andric             // start of the last function block recorded in the
3585*0b57cec5SDimitry Andric             // DeferredFunctionInfo map. Skip it.
3586*0b57cec5SDimitry Andric             if (Error Err = Stream.SkipBlock())
3587*0b57cec5SDimitry Andric               return Err;
3588*0b57cec5SDimitry Andric             continue;
3589*0b57cec5SDimitry Andric           }
3590*0b57cec5SDimitry Andric         }
3591*0b57cec5SDimitry Andric 
3592*0b57cec5SDimitry Andric         // Support older bitcode files that did not have the function
3593*0b57cec5SDimitry Andric         // index in the VST, nor a VST forward declaration record, as
3594*0b57cec5SDimitry Andric         // well as anonymous functions that do not have VST entries.
3595*0b57cec5SDimitry Andric         // Build the DeferredFunctionInfo vector on the fly.
3596*0b57cec5SDimitry Andric         if (Error Err = rememberAndSkipFunctionBody())
3597*0b57cec5SDimitry Andric           return Err;
3598*0b57cec5SDimitry Andric 
3599*0b57cec5SDimitry Andric         // Suspend parsing when we reach the function bodies. Subsequent
3600*0b57cec5SDimitry Andric         // materialization calls will resume it when necessary. If the bitcode
3601*0b57cec5SDimitry Andric         // file is old, the symbol table will be at the end instead and will not
3602*0b57cec5SDimitry Andric         // have been seen yet. In this case, just finish the parse now.
3603*0b57cec5SDimitry Andric         if (SeenValueSymbolTable) {
3604*0b57cec5SDimitry Andric           NextUnreadBit = Stream.GetCurrentBitNo();
3605*0b57cec5SDimitry Andric           // After the VST has been parsed, we need to make sure intrinsic name
3606*0b57cec5SDimitry Andric           // are auto-upgraded.
3607*0b57cec5SDimitry Andric           return globalCleanup();
3608*0b57cec5SDimitry Andric         }
3609*0b57cec5SDimitry Andric         break;
3610*0b57cec5SDimitry Andric       case bitc::USELIST_BLOCK_ID:
3611*0b57cec5SDimitry Andric         if (Error Err = parseUseLists())
3612*0b57cec5SDimitry Andric           return Err;
3613*0b57cec5SDimitry Andric         break;
3614*0b57cec5SDimitry Andric       case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
3615*0b57cec5SDimitry Andric         if (Error Err = parseOperandBundleTags())
3616*0b57cec5SDimitry Andric           return Err;
3617*0b57cec5SDimitry Andric         break;
3618*0b57cec5SDimitry Andric       case bitc::SYNC_SCOPE_NAMES_BLOCK_ID:
3619*0b57cec5SDimitry Andric         if (Error Err = parseSyncScopeNames())
3620*0b57cec5SDimitry Andric           return Err;
3621*0b57cec5SDimitry Andric         break;
3622*0b57cec5SDimitry Andric       }
3623*0b57cec5SDimitry Andric       continue;
3624*0b57cec5SDimitry Andric 
3625*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
3626*0b57cec5SDimitry Andric       // The interesting case.
3627*0b57cec5SDimitry Andric       break;
3628*0b57cec5SDimitry Andric     }
3629*0b57cec5SDimitry Andric 
3630*0b57cec5SDimitry Andric     // Read a record.
3631*0b57cec5SDimitry Andric     Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
3632*0b57cec5SDimitry Andric     if (!MaybeBitCode)
3633*0b57cec5SDimitry Andric       return MaybeBitCode.takeError();
3634*0b57cec5SDimitry Andric     switch (unsigned BitCode = MaybeBitCode.get()) {
3635*0b57cec5SDimitry Andric     default: break;  // Default behavior, ignore unknown content.
3636*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_VERSION: {
3637*0b57cec5SDimitry Andric       Expected<unsigned> VersionOrErr = parseVersionRecord(Record);
3638*0b57cec5SDimitry Andric       if (!VersionOrErr)
3639*0b57cec5SDimitry Andric         return VersionOrErr.takeError();
3640*0b57cec5SDimitry Andric       UseRelativeIDs = *VersionOrErr >= 1;
3641*0b57cec5SDimitry Andric       break;
3642*0b57cec5SDimitry Andric     }
3643*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
36445ffd83dbSDimitry Andric       if (ResolvedDataLayout)
36455ffd83dbSDimitry Andric         return error("target triple too late in module");
3646*0b57cec5SDimitry Andric       std::string S;
3647*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
3648*0b57cec5SDimitry Andric         return error("Invalid record");
3649*0b57cec5SDimitry Andric       TheModule->setTargetTriple(S);
3650*0b57cec5SDimitry Andric       break;
3651*0b57cec5SDimitry Andric     }
3652*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_DATALAYOUT: {  // DATALAYOUT: [strchr x N]
36535ffd83dbSDimitry Andric       if (ResolvedDataLayout)
36545ffd83dbSDimitry Andric         return error("datalayout too late in module");
3655*0b57cec5SDimitry Andric       std::string S;
3656*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
3657*0b57cec5SDimitry Andric         return error("Invalid record");
3658*0b57cec5SDimitry Andric       TheModule->setDataLayout(S);
3659*0b57cec5SDimitry Andric       break;
3660*0b57cec5SDimitry Andric     }
3661*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_ASM: {  // ASM: [strchr x N]
3662*0b57cec5SDimitry Andric       std::string S;
3663*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
3664*0b57cec5SDimitry Andric         return error("Invalid record");
3665*0b57cec5SDimitry Andric       TheModule->setModuleInlineAsm(S);
3666*0b57cec5SDimitry Andric       break;
3667*0b57cec5SDimitry Andric     }
3668*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_DEPLIB: {  // DEPLIB: [strchr x N]
36695ffd83dbSDimitry Andric       // Deprecated, but still needed to read old bitcode files.
3670*0b57cec5SDimitry Andric       std::string S;
3671*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
3672*0b57cec5SDimitry Andric         return error("Invalid record");
3673*0b57cec5SDimitry Andric       // Ignore value.
3674*0b57cec5SDimitry Andric       break;
3675*0b57cec5SDimitry Andric     }
3676*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_SECTIONNAME: {  // SECTIONNAME: [strchr x N]
3677*0b57cec5SDimitry Andric       std::string S;
3678*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
3679*0b57cec5SDimitry Andric         return error("Invalid record");
3680*0b57cec5SDimitry Andric       SectionTable.push_back(S);
3681*0b57cec5SDimitry Andric       break;
3682*0b57cec5SDimitry Andric     }
3683*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_GCNAME: {  // SECTIONNAME: [strchr x N]
3684*0b57cec5SDimitry Andric       std::string S;
3685*0b57cec5SDimitry Andric       if (convertToString(Record, 0, S))
3686*0b57cec5SDimitry Andric         return error("Invalid record");
3687*0b57cec5SDimitry Andric       GCTable.push_back(S);
3688*0b57cec5SDimitry Andric       break;
3689*0b57cec5SDimitry Andric     }
3690*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_COMDAT:
3691*0b57cec5SDimitry Andric       if (Error Err = parseComdatRecord(Record))
3692*0b57cec5SDimitry Andric         return Err;
3693*0b57cec5SDimitry Andric       break;
3694*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_GLOBALVAR:
3695*0b57cec5SDimitry Andric       if (Error Err = parseGlobalVarRecord(Record))
3696*0b57cec5SDimitry Andric         return Err;
3697*0b57cec5SDimitry Andric       break;
3698*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_FUNCTION:
36995ffd83dbSDimitry Andric       ResolveDataLayout();
3700*0b57cec5SDimitry Andric       if (Error Err = parseFunctionRecord(Record))
3701*0b57cec5SDimitry Andric         return Err;
3702*0b57cec5SDimitry Andric       break;
3703*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_IFUNC:
3704*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_ALIAS:
3705*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_ALIAS_OLD:
3706*0b57cec5SDimitry Andric       if (Error Err = parseGlobalIndirectSymbolRecord(BitCode, Record))
3707*0b57cec5SDimitry Andric         return Err;
3708*0b57cec5SDimitry Andric       break;
3709*0b57cec5SDimitry Andric     /// MODULE_CODE_VSTOFFSET: [offset]
3710*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_VSTOFFSET:
3711*0b57cec5SDimitry Andric       if (Record.size() < 1)
3712*0b57cec5SDimitry Andric         return error("Invalid record");
3713*0b57cec5SDimitry Andric       // Note that we subtract 1 here because the offset is relative to one word
3714*0b57cec5SDimitry Andric       // before the start of the identification or module block, which was
3715*0b57cec5SDimitry Andric       // historically always the start of the regular bitcode header.
3716*0b57cec5SDimitry Andric       VSTOffset = Record[0] - 1;
3717*0b57cec5SDimitry Andric       break;
3718*0b57cec5SDimitry Andric     /// MODULE_CODE_SOURCE_FILENAME: [namechar x N]
3719*0b57cec5SDimitry Andric     case bitc::MODULE_CODE_SOURCE_FILENAME:
3720*0b57cec5SDimitry Andric       SmallString<128> ValueName;
3721*0b57cec5SDimitry Andric       if (convertToString(Record, 0, ValueName))
3722*0b57cec5SDimitry Andric         return error("Invalid record");
3723*0b57cec5SDimitry Andric       TheModule->setSourceFileName(ValueName);
3724*0b57cec5SDimitry Andric       break;
3725*0b57cec5SDimitry Andric     }
3726*0b57cec5SDimitry Andric     Record.clear();
3727*0b57cec5SDimitry Andric   }
3728*0b57cec5SDimitry Andric }
3729*0b57cec5SDimitry Andric 
3730*0b57cec5SDimitry Andric Error BitcodeReader::parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata,
37315ffd83dbSDimitry Andric                                       bool IsImporting,
37325ffd83dbSDimitry Andric                                       DataLayoutCallbackTy DataLayoutCallback) {
3733*0b57cec5SDimitry Andric   TheModule = M;
3734*0b57cec5SDimitry Andric   MDLoader = MetadataLoader(Stream, *M, ValueList, IsImporting,
3735*0b57cec5SDimitry Andric                             [&](unsigned ID) { return getTypeByID(ID); });
37365ffd83dbSDimitry Andric   return parseModule(0, ShouldLazyLoadMetadata, DataLayoutCallback);
3737*0b57cec5SDimitry Andric }
3738*0b57cec5SDimitry Andric 
3739*0b57cec5SDimitry Andric Error BitcodeReader::typeCheckLoadStoreInst(Type *ValType, Type *PtrType) {
3740*0b57cec5SDimitry Andric   if (!isa<PointerType>(PtrType))
3741*0b57cec5SDimitry Andric     return error("Load/Store operand is not a pointer type");
3742*0b57cec5SDimitry Andric   Type *ElemType = cast<PointerType>(PtrType)->getElementType();
3743*0b57cec5SDimitry Andric 
3744*0b57cec5SDimitry Andric   if (ValType && ValType != ElemType)
3745*0b57cec5SDimitry Andric     return error("Explicit load/store type does not match pointee "
3746*0b57cec5SDimitry Andric                  "type of pointer operand");
3747*0b57cec5SDimitry Andric   if (!PointerType::isLoadableOrStorableType(ElemType))
3748*0b57cec5SDimitry Andric     return error("Cannot load/store from pointer");
3749*0b57cec5SDimitry Andric   return Error::success();
3750*0b57cec5SDimitry Andric }
3751*0b57cec5SDimitry Andric 
3752*0b57cec5SDimitry Andric void BitcodeReader::propagateByValTypes(CallBase *CB,
3753*0b57cec5SDimitry Andric                                         ArrayRef<Type *> ArgsFullTys) {
3754*0b57cec5SDimitry Andric   for (unsigned i = 0; i != CB->arg_size(); ++i) {
3755*0b57cec5SDimitry Andric     if (!CB->paramHasAttr(i, Attribute::ByVal))
3756*0b57cec5SDimitry Andric       continue;
3757*0b57cec5SDimitry Andric 
3758*0b57cec5SDimitry Andric     CB->removeParamAttr(i, Attribute::ByVal);
3759*0b57cec5SDimitry Andric     CB->addParamAttr(
3760*0b57cec5SDimitry Andric         i, Attribute::getWithByValType(
3761*0b57cec5SDimitry Andric                Context, getPointerElementFlatType(ArgsFullTys[i])));
3762*0b57cec5SDimitry Andric   }
3763*0b57cec5SDimitry Andric }
3764*0b57cec5SDimitry Andric 
3765*0b57cec5SDimitry Andric /// Lazily parse the specified function body block.
3766*0b57cec5SDimitry Andric Error BitcodeReader::parseFunctionBody(Function *F) {
3767*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
3768*0b57cec5SDimitry Andric     return Err;
3769*0b57cec5SDimitry Andric 
3770*0b57cec5SDimitry Andric   // Unexpected unresolved metadata when parsing function.
3771*0b57cec5SDimitry Andric   if (MDLoader->hasFwdRefs())
3772*0b57cec5SDimitry Andric     return error("Invalid function metadata: incoming forward references");
3773*0b57cec5SDimitry Andric 
3774*0b57cec5SDimitry Andric   InstructionList.clear();
3775*0b57cec5SDimitry Andric   unsigned ModuleValueListSize = ValueList.size();
3776*0b57cec5SDimitry Andric   unsigned ModuleMDLoaderSize = MDLoader->size();
3777*0b57cec5SDimitry Andric 
3778*0b57cec5SDimitry Andric   // Add all the function arguments to the value table.
3779*0b57cec5SDimitry Andric   unsigned ArgNo = 0;
3780*0b57cec5SDimitry Andric   FunctionType *FullFTy = FunctionTypes[F];
3781*0b57cec5SDimitry Andric   for (Argument &I : F->args()) {
3782*0b57cec5SDimitry Andric     assert(I.getType() == flattenPointerTypes(FullFTy->getParamType(ArgNo)) &&
3783*0b57cec5SDimitry Andric            "Incorrect fully specified type for Function Argument");
3784*0b57cec5SDimitry Andric     ValueList.push_back(&I, FullFTy->getParamType(ArgNo++));
3785*0b57cec5SDimitry Andric   }
3786*0b57cec5SDimitry Andric   unsigned NextValueNo = ValueList.size();
3787*0b57cec5SDimitry Andric   BasicBlock *CurBB = nullptr;
3788*0b57cec5SDimitry Andric   unsigned CurBBNo = 0;
3789*0b57cec5SDimitry Andric 
3790*0b57cec5SDimitry Andric   DebugLoc LastLoc;
3791*0b57cec5SDimitry Andric   auto getLastInstruction = [&]() -> Instruction * {
3792*0b57cec5SDimitry Andric     if (CurBB && !CurBB->empty())
3793*0b57cec5SDimitry Andric       return &CurBB->back();
3794*0b57cec5SDimitry Andric     else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
3795*0b57cec5SDimitry Andric              !FunctionBBs[CurBBNo - 1]->empty())
3796*0b57cec5SDimitry Andric       return &FunctionBBs[CurBBNo - 1]->back();
3797*0b57cec5SDimitry Andric     return nullptr;
3798*0b57cec5SDimitry Andric   };
3799*0b57cec5SDimitry Andric 
3800*0b57cec5SDimitry Andric   std::vector<OperandBundleDef> OperandBundles;
3801*0b57cec5SDimitry Andric 
3802*0b57cec5SDimitry Andric   // Read all the records.
3803*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
3804*0b57cec5SDimitry Andric 
3805*0b57cec5SDimitry Andric   while (true) {
3806*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
3807*0b57cec5SDimitry Andric     if (!MaybeEntry)
3808*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
3809*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
3810*0b57cec5SDimitry Andric 
3811*0b57cec5SDimitry Andric     switch (Entry.Kind) {
3812*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
3813*0b57cec5SDimitry Andric       return error("Malformed block");
3814*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
3815*0b57cec5SDimitry Andric       goto OutOfRecordLoop;
3816*0b57cec5SDimitry Andric 
3817*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
3818*0b57cec5SDimitry Andric       switch (Entry.ID) {
3819*0b57cec5SDimitry Andric       default:  // Skip unknown content.
3820*0b57cec5SDimitry Andric         if (Error Err = Stream.SkipBlock())
3821*0b57cec5SDimitry Andric           return Err;
3822*0b57cec5SDimitry Andric         break;
3823*0b57cec5SDimitry Andric       case bitc::CONSTANTS_BLOCK_ID:
3824*0b57cec5SDimitry Andric         if (Error Err = parseConstants())
3825*0b57cec5SDimitry Andric           return Err;
3826*0b57cec5SDimitry Andric         NextValueNo = ValueList.size();
3827*0b57cec5SDimitry Andric         break;
3828*0b57cec5SDimitry Andric       case bitc::VALUE_SYMTAB_BLOCK_ID:
3829*0b57cec5SDimitry Andric         if (Error Err = parseValueSymbolTable())
3830*0b57cec5SDimitry Andric           return Err;
3831*0b57cec5SDimitry Andric         break;
3832*0b57cec5SDimitry Andric       case bitc::METADATA_ATTACHMENT_ID:
3833*0b57cec5SDimitry Andric         if (Error Err = MDLoader->parseMetadataAttachment(*F, InstructionList))
3834*0b57cec5SDimitry Andric           return Err;
3835*0b57cec5SDimitry Andric         break;
3836*0b57cec5SDimitry Andric       case bitc::METADATA_BLOCK_ID:
3837*0b57cec5SDimitry Andric         assert(DeferredMetadataInfo.empty() &&
3838*0b57cec5SDimitry Andric                "Must read all module-level metadata before function-level");
3839*0b57cec5SDimitry Andric         if (Error Err = MDLoader->parseFunctionMetadata())
3840*0b57cec5SDimitry Andric           return Err;
3841*0b57cec5SDimitry Andric         break;
3842*0b57cec5SDimitry Andric       case bitc::USELIST_BLOCK_ID:
3843*0b57cec5SDimitry Andric         if (Error Err = parseUseLists())
3844*0b57cec5SDimitry Andric           return Err;
3845*0b57cec5SDimitry Andric         break;
3846*0b57cec5SDimitry Andric       }
3847*0b57cec5SDimitry Andric       continue;
3848*0b57cec5SDimitry Andric 
3849*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
3850*0b57cec5SDimitry Andric       // The interesting case.
3851*0b57cec5SDimitry Andric       break;
3852*0b57cec5SDimitry Andric     }
3853*0b57cec5SDimitry Andric 
3854*0b57cec5SDimitry Andric     // Read a record.
3855*0b57cec5SDimitry Andric     Record.clear();
3856*0b57cec5SDimitry Andric     Instruction *I = nullptr;
3857*0b57cec5SDimitry Andric     Type *FullTy = nullptr;
3858*0b57cec5SDimitry Andric     Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
3859*0b57cec5SDimitry Andric     if (!MaybeBitCode)
3860*0b57cec5SDimitry Andric       return MaybeBitCode.takeError();
3861*0b57cec5SDimitry Andric     switch (unsigned BitCode = MaybeBitCode.get()) {
3862*0b57cec5SDimitry Andric     default: // Default behavior: reject
3863*0b57cec5SDimitry Andric       return error("Invalid value");
3864*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_DECLAREBLOCKS: {   // DECLAREBLOCKS: [nblocks]
3865*0b57cec5SDimitry Andric       if (Record.size() < 1 || Record[0] == 0)
3866*0b57cec5SDimitry Andric         return error("Invalid record");
3867*0b57cec5SDimitry Andric       // Create all the basic blocks for the function.
3868*0b57cec5SDimitry Andric       FunctionBBs.resize(Record[0]);
3869*0b57cec5SDimitry Andric 
3870*0b57cec5SDimitry Andric       // See if anything took the address of blocks in this function.
3871*0b57cec5SDimitry Andric       auto BBFRI = BasicBlockFwdRefs.find(F);
3872*0b57cec5SDimitry Andric       if (BBFRI == BasicBlockFwdRefs.end()) {
3873*0b57cec5SDimitry Andric         for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
3874*0b57cec5SDimitry Andric           FunctionBBs[i] = BasicBlock::Create(Context, "", F);
3875*0b57cec5SDimitry Andric       } else {
3876*0b57cec5SDimitry Andric         auto &BBRefs = BBFRI->second;
3877*0b57cec5SDimitry Andric         // Check for invalid basic block references.
3878*0b57cec5SDimitry Andric         if (BBRefs.size() > FunctionBBs.size())
3879*0b57cec5SDimitry Andric           return error("Invalid ID");
3880*0b57cec5SDimitry Andric         assert(!BBRefs.empty() && "Unexpected empty array");
3881*0b57cec5SDimitry Andric         assert(!BBRefs.front() && "Invalid reference to entry block");
3882*0b57cec5SDimitry Andric         for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
3883*0b57cec5SDimitry Andric              ++I)
3884*0b57cec5SDimitry Andric           if (I < RE && BBRefs[I]) {
3885*0b57cec5SDimitry Andric             BBRefs[I]->insertInto(F);
3886*0b57cec5SDimitry Andric             FunctionBBs[I] = BBRefs[I];
3887*0b57cec5SDimitry Andric           } else {
3888*0b57cec5SDimitry Andric             FunctionBBs[I] = BasicBlock::Create(Context, "", F);
3889*0b57cec5SDimitry Andric           }
3890*0b57cec5SDimitry Andric 
3891*0b57cec5SDimitry Andric         // Erase from the table.
3892*0b57cec5SDimitry Andric         BasicBlockFwdRefs.erase(BBFRI);
3893*0b57cec5SDimitry Andric       }
3894*0b57cec5SDimitry Andric 
3895*0b57cec5SDimitry Andric       CurBB = FunctionBBs[0];
3896*0b57cec5SDimitry Andric       continue;
3897*0b57cec5SDimitry Andric     }
3898*0b57cec5SDimitry Andric 
3899*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:  // DEBUG_LOC_AGAIN
3900*0b57cec5SDimitry Andric       // This record indicates that the last instruction is at the same
3901*0b57cec5SDimitry Andric       // location as the previous instruction with a location.
3902*0b57cec5SDimitry Andric       I = getLastInstruction();
3903*0b57cec5SDimitry Andric 
3904*0b57cec5SDimitry Andric       if (!I)
3905*0b57cec5SDimitry Andric         return error("Invalid record");
3906*0b57cec5SDimitry Andric       I->setDebugLoc(LastLoc);
3907*0b57cec5SDimitry Andric       I = nullptr;
3908*0b57cec5SDimitry Andric       continue;
3909*0b57cec5SDimitry Andric 
3910*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_DEBUG_LOC: {      // DEBUG_LOC: [line, col, scope, ia]
3911*0b57cec5SDimitry Andric       I = getLastInstruction();
3912*0b57cec5SDimitry Andric       if (!I || Record.size() < 4)
3913*0b57cec5SDimitry Andric         return error("Invalid record");
3914*0b57cec5SDimitry Andric 
3915*0b57cec5SDimitry Andric       unsigned Line = Record[0], Col = Record[1];
3916*0b57cec5SDimitry Andric       unsigned ScopeID = Record[2], IAID = Record[3];
3917*0b57cec5SDimitry Andric       bool isImplicitCode = Record.size() == 5 && Record[4];
3918*0b57cec5SDimitry Andric 
3919*0b57cec5SDimitry Andric       MDNode *Scope = nullptr, *IA = nullptr;
3920*0b57cec5SDimitry Andric       if (ScopeID) {
3921*0b57cec5SDimitry Andric         Scope = dyn_cast_or_null<MDNode>(
3922*0b57cec5SDimitry Andric             MDLoader->getMetadataFwdRefOrLoad(ScopeID - 1));
3923*0b57cec5SDimitry Andric         if (!Scope)
3924*0b57cec5SDimitry Andric           return error("Invalid record");
3925*0b57cec5SDimitry Andric       }
3926*0b57cec5SDimitry Andric       if (IAID) {
3927*0b57cec5SDimitry Andric         IA = dyn_cast_or_null<MDNode>(
3928*0b57cec5SDimitry Andric             MDLoader->getMetadataFwdRefOrLoad(IAID - 1));
3929*0b57cec5SDimitry Andric         if (!IA)
3930*0b57cec5SDimitry Andric           return error("Invalid record");
3931*0b57cec5SDimitry Andric       }
3932*0b57cec5SDimitry Andric       LastLoc = DebugLoc::get(Line, Col, Scope, IA, isImplicitCode);
3933*0b57cec5SDimitry Andric       I->setDebugLoc(LastLoc);
3934*0b57cec5SDimitry Andric       I = nullptr;
3935*0b57cec5SDimitry Andric       continue;
3936*0b57cec5SDimitry Andric     }
3937*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_UNOP: {    // UNOP: [opval, ty, opcode]
3938*0b57cec5SDimitry Andric       unsigned OpNum = 0;
3939*0b57cec5SDimitry Andric       Value *LHS;
3940*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3941*0b57cec5SDimitry Andric           OpNum+1 > Record.size())
3942*0b57cec5SDimitry Andric         return error("Invalid record");
3943*0b57cec5SDimitry Andric 
3944*0b57cec5SDimitry Andric       int Opc = getDecodedUnaryOpcode(Record[OpNum++], LHS->getType());
3945*0b57cec5SDimitry Andric       if (Opc == -1)
3946*0b57cec5SDimitry Andric         return error("Invalid record");
3947*0b57cec5SDimitry Andric       I = UnaryOperator::Create((Instruction::UnaryOps)Opc, LHS);
3948*0b57cec5SDimitry Andric       InstructionList.push_back(I);
3949*0b57cec5SDimitry Andric       if (OpNum < Record.size()) {
3950*0b57cec5SDimitry Andric         if (isa<FPMathOperator>(I)) {
3951*0b57cec5SDimitry Andric           FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
3952*0b57cec5SDimitry Andric           if (FMF.any())
3953*0b57cec5SDimitry Andric             I->setFastMathFlags(FMF);
3954*0b57cec5SDimitry Andric         }
3955*0b57cec5SDimitry Andric       }
3956*0b57cec5SDimitry Andric       break;
3957*0b57cec5SDimitry Andric     }
3958*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_BINOP: {    // BINOP: [opval, ty, opval, opcode]
3959*0b57cec5SDimitry Andric       unsigned OpNum = 0;
3960*0b57cec5SDimitry Andric       Value *LHS, *RHS;
3961*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
3962*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
3963*0b57cec5SDimitry Andric           OpNum+1 > Record.size())
3964*0b57cec5SDimitry Andric         return error("Invalid record");
3965*0b57cec5SDimitry Andric 
3966*0b57cec5SDimitry Andric       int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
3967*0b57cec5SDimitry Andric       if (Opc == -1)
3968*0b57cec5SDimitry Andric         return error("Invalid record");
3969*0b57cec5SDimitry Andric       I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
3970*0b57cec5SDimitry Andric       InstructionList.push_back(I);
3971*0b57cec5SDimitry Andric       if (OpNum < Record.size()) {
3972*0b57cec5SDimitry Andric         if (Opc == Instruction::Add ||
3973*0b57cec5SDimitry Andric             Opc == Instruction::Sub ||
3974*0b57cec5SDimitry Andric             Opc == Instruction::Mul ||
3975*0b57cec5SDimitry Andric             Opc == Instruction::Shl) {
3976*0b57cec5SDimitry Andric           if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
3977*0b57cec5SDimitry Andric             cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
3978*0b57cec5SDimitry Andric           if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
3979*0b57cec5SDimitry Andric             cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
3980*0b57cec5SDimitry Andric         } else if (Opc == Instruction::SDiv ||
3981*0b57cec5SDimitry Andric                    Opc == Instruction::UDiv ||
3982*0b57cec5SDimitry Andric                    Opc == Instruction::LShr ||
3983*0b57cec5SDimitry Andric                    Opc == Instruction::AShr) {
3984*0b57cec5SDimitry Andric           if (Record[OpNum] & (1 << bitc::PEO_EXACT))
3985*0b57cec5SDimitry Andric             cast<BinaryOperator>(I)->setIsExact(true);
3986*0b57cec5SDimitry Andric         } else if (isa<FPMathOperator>(I)) {
3987*0b57cec5SDimitry Andric           FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
3988*0b57cec5SDimitry Andric           if (FMF.any())
3989*0b57cec5SDimitry Andric             I->setFastMathFlags(FMF);
3990*0b57cec5SDimitry Andric         }
3991*0b57cec5SDimitry Andric 
3992*0b57cec5SDimitry Andric       }
3993*0b57cec5SDimitry Andric       break;
3994*0b57cec5SDimitry Andric     }
3995*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CAST: {    // CAST: [opval, opty, destty, castopc]
3996*0b57cec5SDimitry Andric       unsigned OpNum = 0;
3997*0b57cec5SDimitry Andric       Value *Op;
3998*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3999*0b57cec5SDimitry Andric           OpNum+2 != Record.size())
4000*0b57cec5SDimitry Andric         return error("Invalid record");
4001*0b57cec5SDimitry Andric 
4002*0b57cec5SDimitry Andric       FullTy = getFullyStructuredTypeByID(Record[OpNum]);
4003*0b57cec5SDimitry Andric       Type *ResTy = flattenPointerTypes(FullTy);
4004*0b57cec5SDimitry Andric       int Opc = getDecodedCastOpcode(Record[OpNum + 1]);
4005*0b57cec5SDimitry Andric       if (Opc == -1 || !ResTy)
4006*0b57cec5SDimitry Andric         return error("Invalid record");
4007*0b57cec5SDimitry Andric       Instruction *Temp = nullptr;
4008*0b57cec5SDimitry Andric       if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
4009*0b57cec5SDimitry Andric         if (Temp) {
4010*0b57cec5SDimitry Andric           InstructionList.push_back(Temp);
4011480093f4SDimitry Andric           assert(CurBB && "No current BB?");
4012*0b57cec5SDimitry Andric           CurBB->getInstList().push_back(Temp);
4013*0b57cec5SDimitry Andric         }
4014*0b57cec5SDimitry Andric       } else {
4015*0b57cec5SDimitry Andric         auto CastOp = (Instruction::CastOps)Opc;
4016*0b57cec5SDimitry Andric         if (!CastInst::castIsValid(CastOp, Op, ResTy))
4017*0b57cec5SDimitry Andric           return error("Invalid cast");
4018*0b57cec5SDimitry Andric         I = CastInst::Create(CastOp, Op, ResTy);
4019*0b57cec5SDimitry Andric       }
4020*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4021*0b57cec5SDimitry Andric       break;
4022*0b57cec5SDimitry Andric     }
4023*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:
4024*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_GEP_OLD:
4025*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
4026*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4027*0b57cec5SDimitry Andric 
4028*0b57cec5SDimitry Andric       Type *Ty;
4029*0b57cec5SDimitry Andric       bool InBounds;
4030*0b57cec5SDimitry Andric 
4031*0b57cec5SDimitry Andric       if (BitCode == bitc::FUNC_CODE_INST_GEP) {
4032*0b57cec5SDimitry Andric         InBounds = Record[OpNum++];
4033*0b57cec5SDimitry Andric         FullTy = getFullyStructuredTypeByID(Record[OpNum++]);
4034*0b57cec5SDimitry Andric         Ty = flattenPointerTypes(FullTy);
4035*0b57cec5SDimitry Andric       } else {
4036*0b57cec5SDimitry Andric         InBounds = BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD;
4037*0b57cec5SDimitry Andric         Ty = nullptr;
4038*0b57cec5SDimitry Andric       }
4039*0b57cec5SDimitry Andric 
4040*0b57cec5SDimitry Andric       Value *BasePtr;
4041*0b57cec5SDimitry Andric       Type *FullBaseTy = nullptr;
4042*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr, &FullBaseTy))
4043*0b57cec5SDimitry Andric         return error("Invalid record");
4044*0b57cec5SDimitry Andric 
4045*0b57cec5SDimitry Andric       if (!Ty) {
4046*0b57cec5SDimitry Andric         std::tie(FullTy, Ty) =
4047*0b57cec5SDimitry Andric             getPointerElementTypes(FullBaseTy->getScalarType());
4048*0b57cec5SDimitry Andric       } else if (Ty != getPointerElementFlatType(FullBaseTy->getScalarType()))
4049*0b57cec5SDimitry Andric         return error(
4050*0b57cec5SDimitry Andric             "Explicit gep type does not match pointee type of pointer operand");
4051*0b57cec5SDimitry Andric 
4052*0b57cec5SDimitry Andric       SmallVector<Value*, 16> GEPIdx;
4053*0b57cec5SDimitry Andric       while (OpNum != Record.size()) {
4054*0b57cec5SDimitry Andric         Value *Op;
4055*0b57cec5SDimitry Andric         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4056*0b57cec5SDimitry Andric           return error("Invalid record");
4057*0b57cec5SDimitry Andric         GEPIdx.push_back(Op);
4058*0b57cec5SDimitry Andric       }
4059*0b57cec5SDimitry Andric 
4060*0b57cec5SDimitry Andric       I = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
4061*0b57cec5SDimitry Andric       FullTy = GetElementPtrInst::getGEPReturnType(FullTy, I, GEPIdx);
4062*0b57cec5SDimitry Andric 
4063*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4064*0b57cec5SDimitry Andric       if (InBounds)
4065*0b57cec5SDimitry Andric         cast<GetElementPtrInst>(I)->setIsInBounds(true);
4066*0b57cec5SDimitry Andric       break;
4067*0b57cec5SDimitry Andric     }
4068*0b57cec5SDimitry Andric 
4069*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_EXTRACTVAL: {
4070*0b57cec5SDimitry Andric                                        // EXTRACTVAL: [opty, opval, n x indices]
4071*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4072*0b57cec5SDimitry Andric       Value *Agg;
4073*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Agg, &FullTy))
4074*0b57cec5SDimitry Andric         return error("Invalid record");
4075*0b57cec5SDimitry Andric 
4076*0b57cec5SDimitry Andric       unsigned RecSize = Record.size();
4077*0b57cec5SDimitry Andric       if (OpNum == RecSize)
4078*0b57cec5SDimitry Andric         return error("EXTRACTVAL: Invalid instruction with 0 indices");
4079*0b57cec5SDimitry Andric 
4080*0b57cec5SDimitry Andric       SmallVector<unsigned, 4> EXTRACTVALIdx;
4081*0b57cec5SDimitry Andric       for (; OpNum != RecSize; ++OpNum) {
4082*0b57cec5SDimitry Andric         bool IsArray = FullTy->isArrayTy();
4083*0b57cec5SDimitry Andric         bool IsStruct = FullTy->isStructTy();
4084*0b57cec5SDimitry Andric         uint64_t Index = Record[OpNum];
4085*0b57cec5SDimitry Andric 
4086*0b57cec5SDimitry Andric         if (!IsStruct && !IsArray)
4087*0b57cec5SDimitry Andric           return error("EXTRACTVAL: Invalid type");
4088*0b57cec5SDimitry Andric         if ((unsigned)Index != Index)
4089*0b57cec5SDimitry Andric           return error("Invalid value");
4090*0b57cec5SDimitry Andric         if (IsStruct && Index >= FullTy->getStructNumElements())
4091*0b57cec5SDimitry Andric           return error("EXTRACTVAL: Invalid struct index");
4092*0b57cec5SDimitry Andric         if (IsArray && Index >= FullTy->getArrayNumElements())
4093*0b57cec5SDimitry Andric           return error("EXTRACTVAL: Invalid array index");
4094*0b57cec5SDimitry Andric         EXTRACTVALIdx.push_back((unsigned)Index);
4095*0b57cec5SDimitry Andric 
4096*0b57cec5SDimitry Andric         if (IsStruct)
4097*0b57cec5SDimitry Andric           FullTy = FullTy->getStructElementType(Index);
4098*0b57cec5SDimitry Andric         else
4099*0b57cec5SDimitry Andric           FullTy = FullTy->getArrayElementType();
4100*0b57cec5SDimitry Andric       }
4101*0b57cec5SDimitry Andric 
4102*0b57cec5SDimitry Andric       I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
4103*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4104*0b57cec5SDimitry Andric       break;
4105*0b57cec5SDimitry Andric     }
4106*0b57cec5SDimitry Andric 
4107*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_INSERTVAL: {
4108*0b57cec5SDimitry Andric                            // INSERTVAL: [opty, opval, opty, opval, n x indices]
4109*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4110*0b57cec5SDimitry Andric       Value *Agg;
4111*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Agg, &FullTy))
4112*0b57cec5SDimitry Andric         return error("Invalid record");
4113*0b57cec5SDimitry Andric       Value *Val;
4114*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Val))
4115*0b57cec5SDimitry Andric         return error("Invalid record");
4116*0b57cec5SDimitry Andric 
4117*0b57cec5SDimitry Andric       unsigned RecSize = Record.size();
4118*0b57cec5SDimitry Andric       if (OpNum == RecSize)
4119*0b57cec5SDimitry Andric         return error("INSERTVAL: Invalid instruction with 0 indices");
4120*0b57cec5SDimitry Andric 
4121*0b57cec5SDimitry Andric       SmallVector<unsigned, 4> INSERTVALIdx;
4122*0b57cec5SDimitry Andric       Type *CurTy = Agg->getType();
4123*0b57cec5SDimitry Andric       for (; OpNum != RecSize; ++OpNum) {
4124*0b57cec5SDimitry Andric         bool IsArray = CurTy->isArrayTy();
4125*0b57cec5SDimitry Andric         bool IsStruct = CurTy->isStructTy();
4126*0b57cec5SDimitry Andric         uint64_t Index = Record[OpNum];
4127*0b57cec5SDimitry Andric 
4128*0b57cec5SDimitry Andric         if (!IsStruct && !IsArray)
4129*0b57cec5SDimitry Andric           return error("INSERTVAL: Invalid type");
4130*0b57cec5SDimitry Andric         if ((unsigned)Index != Index)
4131*0b57cec5SDimitry Andric           return error("Invalid value");
4132*0b57cec5SDimitry Andric         if (IsStruct && Index >= CurTy->getStructNumElements())
4133*0b57cec5SDimitry Andric           return error("INSERTVAL: Invalid struct index");
4134*0b57cec5SDimitry Andric         if (IsArray && Index >= CurTy->getArrayNumElements())
4135*0b57cec5SDimitry Andric           return error("INSERTVAL: Invalid array index");
4136*0b57cec5SDimitry Andric 
4137*0b57cec5SDimitry Andric         INSERTVALIdx.push_back((unsigned)Index);
4138*0b57cec5SDimitry Andric         if (IsStruct)
4139*0b57cec5SDimitry Andric           CurTy = CurTy->getStructElementType(Index);
4140*0b57cec5SDimitry Andric         else
4141*0b57cec5SDimitry Andric           CurTy = CurTy->getArrayElementType();
4142*0b57cec5SDimitry Andric       }
4143*0b57cec5SDimitry Andric 
4144*0b57cec5SDimitry Andric       if (CurTy != Val->getType())
4145*0b57cec5SDimitry Andric         return error("Inserted value type doesn't match aggregate type");
4146*0b57cec5SDimitry Andric 
4147*0b57cec5SDimitry Andric       I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
4148*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4149*0b57cec5SDimitry Andric       break;
4150*0b57cec5SDimitry Andric     }
4151*0b57cec5SDimitry Andric 
4152*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
4153*0b57cec5SDimitry Andric       // obsolete form of select
4154*0b57cec5SDimitry Andric       // handles select i1 ... in old bitcode
4155*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4156*0b57cec5SDimitry Andric       Value *TrueVal, *FalseVal, *Cond;
4157*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal, &FullTy) ||
4158*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
4159*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
4160*0b57cec5SDimitry Andric         return error("Invalid record");
4161*0b57cec5SDimitry Andric 
4162*0b57cec5SDimitry Andric       I = SelectInst::Create(Cond, TrueVal, FalseVal);
4163*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4164*0b57cec5SDimitry Andric       break;
4165*0b57cec5SDimitry Andric     }
4166*0b57cec5SDimitry Andric 
4167*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
4168*0b57cec5SDimitry Andric       // new form of select
4169*0b57cec5SDimitry Andric       // handles select i1 or select [N x i1]
4170*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4171*0b57cec5SDimitry Andric       Value *TrueVal, *FalseVal, *Cond;
4172*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal, &FullTy) ||
4173*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
4174*0b57cec5SDimitry Andric           getValueTypePair(Record, OpNum, NextValueNo, Cond))
4175*0b57cec5SDimitry Andric         return error("Invalid record");
4176*0b57cec5SDimitry Andric 
4177*0b57cec5SDimitry Andric       // select condition can be either i1 or [N x i1]
4178*0b57cec5SDimitry Andric       if (VectorType* vector_type =
4179*0b57cec5SDimitry Andric           dyn_cast<VectorType>(Cond->getType())) {
4180*0b57cec5SDimitry Andric         // expect <n x i1>
4181*0b57cec5SDimitry Andric         if (vector_type->getElementType() != Type::getInt1Ty(Context))
4182*0b57cec5SDimitry Andric           return error("Invalid type for value");
4183*0b57cec5SDimitry Andric       } else {
4184*0b57cec5SDimitry Andric         // expect i1
4185*0b57cec5SDimitry Andric         if (Cond->getType() != Type::getInt1Ty(Context))
4186*0b57cec5SDimitry Andric           return error("Invalid type for value");
4187*0b57cec5SDimitry Andric       }
4188*0b57cec5SDimitry Andric 
4189*0b57cec5SDimitry Andric       I = SelectInst::Create(Cond, TrueVal, FalseVal);
4190*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4191*0b57cec5SDimitry Andric       if (OpNum < Record.size() && isa<FPMathOperator>(I)) {
4192*0b57cec5SDimitry Andric         FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
4193*0b57cec5SDimitry Andric         if (FMF.any())
4194*0b57cec5SDimitry Andric           I->setFastMathFlags(FMF);
4195*0b57cec5SDimitry Andric       }
4196*0b57cec5SDimitry Andric       break;
4197*0b57cec5SDimitry Andric     }
4198*0b57cec5SDimitry Andric 
4199*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
4200*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4201*0b57cec5SDimitry Andric       Value *Vec, *Idx;
4202*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Vec, &FullTy) ||
4203*0b57cec5SDimitry Andric           getValueTypePair(Record, OpNum, NextValueNo, Idx))
4204*0b57cec5SDimitry Andric         return error("Invalid record");
4205*0b57cec5SDimitry Andric       if (!Vec->getType()->isVectorTy())
4206*0b57cec5SDimitry Andric         return error("Invalid type for value");
4207*0b57cec5SDimitry Andric       I = ExtractElementInst::Create(Vec, Idx);
42085ffd83dbSDimitry Andric       FullTy = cast<VectorType>(FullTy)->getElementType();
4209*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4210*0b57cec5SDimitry Andric       break;
4211*0b57cec5SDimitry Andric     }
4212*0b57cec5SDimitry Andric 
4213*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
4214*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4215*0b57cec5SDimitry Andric       Value *Vec, *Elt, *Idx;
4216*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Vec, &FullTy))
4217*0b57cec5SDimitry Andric         return error("Invalid record");
4218*0b57cec5SDimitry Andric       if (!Vec->getType()->isVectorTy())
4219*0b57cec5SDimitry Andric         return error("Invalid type for value");
4220*0b57cec5SDimitry Andric       if (popValue(Record, OpNum, NextValueNo,
4221*0b57cec5SDimitry Andric                    cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
4222*0b57cec5SDimitry Andric           getValueTypePair(Record, OpNum, NextValueNo, Idx))
4223*0b57cec5SDimitry Andric         return error("Invalid record");
4224*0b57cec5SDimitry Andric       I = InsertElementInst::Create(Vec, Elt, Idx);
4225*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4226*0b57cec5SDimitry Andric       break;
4227*0b57cec5SDimitry Andric     }
4228*0b57cec5SDimitry Andric 
4229*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
4230*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4231*0b57cec5SDimitry Andric       Value *Vec1, *Vec2, *Mask;
4232*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Vec1, &FullTy) ||
4233*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
4234*0b57cec5SDimitry Andric         return error("Invalid record");
4235*0b57cec5SDimitry Andric 
4236*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
4237*0b57cec5SDimitry Andric         return error("Invalid record");
4238*0b57cec5SDimitry Andric       if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())
4239*0b57cec5SDimitry Andric         return error("Invalid type for value");
42405ffd83dbSDimitry Andric 
4241*0b57cec5SDimitry Andric       I = new ShuffleVectorInst(Vec1, Vec2, Mask);
42425ffd83dbSDimitry Andric       FullTy =
42435ffd83dbSDimitry Andric           VectorType::get(cast<VectorType>(FullTy)->getElementType(),
42445ffd83dbSDimitry Andric                           cast<VectorType>(Mask->getType())->getElementCount());
4245*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4246*0b57cec5SDimitry Andric       break;
4247*0b57cec5SDimitry Andric     }
4248*0b57cec5SDimitry Andric 
4249*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CMP:   // CMP: [opty, opval, opval, pred]
4250*0b57cec5SDimitry Andric       // Old form of ICmp/FCmp returning bool
4251*0b57cec5SDimitry Andric       // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
4252*0b57cec5SDimitry Andric       // both legal on vectors but had different behaviour.
4253*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
4254*0b57cec5SDimitry Andric       // FCmp/ICmp returning bool or vector of bool
4255*0b57cec5SDimitry Andric 
4256*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4257*0b57cec5SDimitry Andric       Value *LHS, *RHS;
4258*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
4259*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS))
4260*0b57cec5SDimitry Andric         return error("Invalid record");
4261*0b57cec5SDimitry Andric 
4262*0b57cec5SDimitry Andric       if (OpNum >= Record.size())
4263*0b57cec5SDimitry Andric         return error(
4264*0b57cec5SDimitry Andric             "Invalid record: operand number exceeded available operands");
4265*0b57cec5SDimitry Andric 
4266*0b57cec5SDimitry Andric       unsigned PredVal = Record[OpNum];
4267*0b57cec5SDimitry Andric       bool IsFP = LHS->getType()->isFPOrFPVectorTy();
4268*0b57cec5SDimitry Andric       FastMathFlags FMF;
4269*0b57cec5SDimitry Andric       if (IsFP && Record.size() > OpNum+1)
4270*0b57cec5SDimitry Andric         FMF = getDecodedFastMathFlags(Record[++OpNum]);
4271*0b57cec5SDimitry Andric 
4272*0b57cec5SDimitry Andric       if (OpNum+1 != Record.size())
4273*0b57cec5SDimitry Andric         return error("Invalid record");
4274*0b57cec5SDimitry Andric 
4275*0b57cec5SDimitry Andric       if (LHS->getType()->isFPOrFPVectorTy())
4276*0b57cec5SDimitry Andric         I = new FCmpInst((FCmpInst::Predicate)PredVal, LHS, RHS);
4277*0b57cec5SDimitry Andric       else
4278*0b57cec5SDimitry Andric         I = new ICmpInst((ICmpInst::Predicate)PredVal, LHS, RHS);
4279*0b57cec5SDimitry Andric 
4280*0b57cec5SDimitry Andric       if (FMF.any())
4281*0b57cec5SDimitry Andric         I->setFastMathFlags(FMF);
4282*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4283*0b57cec5SDimitry Andric       break;
4284*0b57cec5SDimitry Andric     }
4285*0b57cec5SDimitry Andric 
4286*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
4287*0b57cec5SDimitry Andric       {
4288*0b57cec5SDimitry Andric         unsigned Size = Record.size();
4289*0b57cec5SDimitry Andric         if (Size == 0) {
4290*0b57cec5SDimitry Andric           I = ReturnInst::Create(Context);
4291*0b57cec5SDimitry Andric           InstructionList.push_back(I);
4292*0b57cec5SDimitry Andric           break;
4293*0b57cec5SDimitry Andric         }
4294*0b57cec5SDimitry Andric 
4295*0b57cec5SDimitry Andric         unsigned OpNum = 0;
4296*0b57cec5SDimitry Andric         Value *Op = nullptr;
4297*0b57cec5SDimitry Andric         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4298*0b57cec5SDimitry Andric           return error("Invalid record");
4299*0b57cec5SDimitry Andric         if (OpNum != Record.size())
4300*0b57cec5SDimitry Andric           return error("Invalid record");
4301*0b57cec5SDimitry Andric 
4302*0b57cec5SDimitry Andric         I = ReturnInst::Create(Context, Op);
4303*0b57cec5SDimitry Andric         InstructionList.push_back(I);
4304*0b57cec5SDimitry Andric         break;
4305*0b57cec5SDimitry Andric       }
4306*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
4307*0b57cec5SDimitry Andric       if (Record.size() != 1 && Record.size() != 3)
4308*0b57cec5SDimitry Andric         return error("Invalid record");
4309*0b57cec5SDimitry Andric       BasicBlock *TrueDest = getBasicBlock(Record[0]);
4310*0b57cec5SDimitry Andric       if (!TrueDest)
4311*0b57cec5SDimitry Andric         return error("Invalid record");
4312*0b57cec5SDimitry Andric 
4313*0b57cec5SDimitry Andric       if (Record.size() == 1) {
4314*0b57cec5SDimitry Andric         I = BranchInst::Create(TrueDest);
4315*0b57cec5SDimitry Andric         InstructionList.push_back(I);
4316*0b57cec5SDimitry Andric       }
4317*0b57cec5SDimitry Andric       else {
4318*0b57cec5SDimitry Andric         BasicBlock *FalseDest = getBasicBlock(Record[1]);
4319*0b57cec5SDimitry Andric         Value *Cond = getValue(Record, 2, NextValueNo,
4320*0b57cec5SDimitry Andric                                Type::getInt1Ty(Context));
4321*0b57cec5SDimitry Andric         if (!FalseDest || !Cond)
4322*0b57cec5SDimitry Andric           return error("Invalid record");
4323*0b57cec5SDimitry Andric         I = BranchInst::Create(TrueDest, FalseDest, Cond);
4324*0b57cec5SDimitry Andric         InstructionList.push_back(I);
4325*0b57cec5SDimitry Andric       }
4326*0b57cec5SDimitry Andric       break;
4327*0b57cec5SDimitry Andric     }
4328*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CLEANUPRET: { // CLEANUPRET: [val] or [val,bb#]
4329*0b57cec5SDimitry Andric       if (Record.size() != 1 && Record.size() != 2)
4330*0b57cec5SDimitry Andric         return error("Invalid record");
4331*0b57cec5SDimitry Andric       unsigned Idx = 0;
4332*0b57cec5SDimitry Andric       Value *CleanupPad =
4333*0b57cec5SDimitry Andric           getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4334*0b57cec5SDimitry Andric       if (!CleanupPad)
4335*0b57cec5SDimitry Andric         return error("Invalid record");
4336*0b57cec5SDimitry Andric       BasicBlock *UnwindDest = nullptr;
4337*0b57cec5SDimitry Andric       if (Record.size() == 2) {
4338*0b57cec5SDimitry Andric         UnwindDest = getBasicBlock(Record[Idx++]);
4339*0b57cec5SDimitry Andric         if (!UnwindDest)
4340*0b57cec5SDimitry Andric           return error("Invalid record");
4341*0b57cec5SDimitry Andric       }
4342*0b57cec5SDimitry Andric 
4343*0b57cec5SDimitry Andric       I = CleanupReturnInst::Create(CleanupPad, UnwindDest);
4344*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4345*0b57cec5SDimitry Andric       break;
4346*0b57cec5SDimitry Andric     }
4347*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [val,bb#]
4348*0b57cec5SDimitry Andric       if (Record.size() != 2)
4349*0b57cec5SDimitry Andric         return error("Invalid record");
4350*0b57cec5SDimitry Andric       unsigned Idx = 0;
4351*0b57cec5SDimitry Andric       Value *CatchPad =
4352*0b57cec5SDimitry Andric           getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4353*0b57cec5SDimitry Andric       if (!CatchPad)
4354*0b57cec5SDimitry Andric         return error("Invalid record");
4355*0b57cec5SDimitry Andric       BasicBlock *BB = getBasicBlock(Record[Idx++]);
4356*0b57cec5SDimitry Andric       if (!BB)
4357*0b57cec5SDimitry Andric         return error("Invalid record");
4358*0b57cec5SDimitry Andric 
4359*0b57cec5SDimitry Andric       I = CatchReturnInst::Create(CatchPad, BB);
4360*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4361*0b57cec5SDimitry Andric       break;
4362*0b57cec5SDimitry Andric     }
4363*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CATCHSWITCH: { // CATCHSWITCH: [tok,num,(bb)*,bb?]
4364*0b57cec5SDimitry Andric       // We must have, at minimum, the outer scope and the number of arguments.
4365*0b57cec5SDimitry Andric       if (Record.size() < 2)
4366*0b57cec5SDimitry Andric         return error("Invalid record");
4367*0b57cec5SDimitry Andric 
4368*0b57cec5SDimitry Andric       unsigned Idx = 0;
4369*0b57cec5SDimitry Andric 
4370*0b57cec5SDimitry Andric       Value *ParentPad =
4371*0b57cec5SDimitry Andric           getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4372*0b57cec5SDimitry Andric 
4373*0b57cec5SDimitry Andric       unsigned NumHandlers = Record[Idx++];
4374*0b57cec5SDimitry Andric 
4375*0b57cec5SDimitry Andric       SmallVector<BasicBlock *, 2> Handlers;
4376*0b57cec5SDimitry Andric       for (unsigned Op = 0; Op != NumHandlers; ++Op) {
4377*0b57cec5SDimitry Andric         BasicBlock *BB = getBasicBlock(Record[Idx++]);
4378*0b57cec5SDimitry Andric         if (!BB)
4379*0b57cec5SDimitry Andric           return error("Invalid record");
4380*0b57cec5SDimitry Andric         Handlers.push_back(BB);
4381*0b57cec5SDimitry Andric       }
4382*0b57cec5SDimitry Andric 
4383*0b57cec5SDimitry Andric       BasicBlock *UnwindDest = nullptr;
4384*0b57cec5SDimitry Andric       if (Idx + 1 == Record.size()) {
4385*0b57cec5SDimitry Andric         UnwindDest = getBasicBlock(Record[Idx++]);
4386*0b57cec5SDimitry Andric         if (!UnwindDest)
4387*0b57cec5SDimitry Andric           return error("Invalid record");
4388*0b57cec5SDimitry Andric       }
4389*0b57cec5SDimitry Andric 
4390*0b57cec5SDimitry Andric       if (Record.size() != Idx)
4391*0b57cec5SDimitry Andric         return error("Invalid record");
4392*0b57cec5SDimitry Andric 
4393*0b57cec5SDimitry Andric       auto *CatchSwitch =
4394*0b57cec5SDimitry Andric           CatchSwitchInst::Create(ParentPad, UnwindDest, NumHandlers);
4395*0b57cec5SDimitry Andric       for (BasicBlock *Handler : Handlers)
4396*0b57cec5SDimitry Andric         CatchSwitch->addHandler(Handler);
4397*0b57cec5SDimitry Andric       I = CatchSwitch;
4398*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4399*0b57cec5SDimitry Andric       break;
4400*0b57cec5SDimitry Andric     }
4401*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CATCHPAD:
4402*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CLEANUPPAD: { // [tok,num,(ty,val)*]
4403*0b57cec5SDimitry Andric       // We must have, at minimum, the outer scope and the number of arguments.
4404*0b57cec5SDimitry Andric       if (Record.size() < 2)
4405*0b57cec5SDimitry Andric         return error("Invalid record");
4406*0b57cec5SDimitry Andric 
4407*0b57cec5SDimitry Andric       unsigned Idx = 0;
4408*0b57cec5SDimitry Andric 
4409*0b57cec5SDimitry Andric       Value *ParentPad =
4410*0b57cec5SDimitry Andric           getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
4411*0b57cec5SDimitry Andric 
4412*0b57cec5SDimitry Andric       unsigned NumArgOperands = Record[Idx++];
4413*0b57cec5SDimitry Andric 
4414*0b57cec5SDimitry Andric       SmallVector<Value *, 2> Args;
4415*0b57cec5SDimitry Andric       for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
4416*0b57cec5SDimitry Andric         Value *Val;
4417*0b57cec5SDimitry Andric         if (getValueTypePair(Record, Idx, NextValueNo, Val))
4418*0b57cec5SDimitry Andric           return error("Invalid record");
4419*0b57cec5SDimitry Andric         Args.push_back(Val);
4420*0b57cec5SDimitry Andric       }
4421*0b57cec5SDimitry Andric 
4422*0b57cec5SDimitry Andric       if (Record.size() != Idx)
4423*0b57cec5SDimitry Andric         return error("Invalid record");
4424*0b57cec5SDimitry Andric 
4425*0b57cec5SDimitry Andric       if (BitCode == bitc::FUNC_CODE_INST_CLEANUPPAD)
4426*0b57cec5SDimitry Andric         I = CleanupPadInst::Create(ParentPad, Args);
4427*0b57cec5SDimitry Andric       else
4428*0b57cec5SDimitry Andric         I = CatchPadInst::Create(ParentPad, Args);
4429*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4430*0b57cec5SDimitry Andric       break;
4431*0b57cec5SDimitry Andric     }
4432*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
4433*0b57cec5SDimitry Andric       // Check magic
4434*0b57cec5SDimitry Andric       if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
4435*0b57cec5SDimitry Andric         // "New" SwitchInst format with case ranges. The changes to write this
4436*0b57cec5SDimitry Andric         // format were reverted but we still recognize bitcode that uses it.
4437*0b57cec5SDimitry Andric         // Hopefully someday we will have support for case ranges and can use
4438*0b57cec5SDimitry Andric         // this format again.
4439*0b57cec5SDimitry Andric 
4440*0b57cec5SDimitry Andric         Type *OpTy = getTypeByID(Record[1]);
4441*0b57cec5SDimitry Andric         unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
4442*0b57cec5SDimitry Andric 
4443*0b57cec5SDimitry Andric         Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
4444*0b57cec5SDimitry Andric         BasicBlock *Default = getBasicBlock(Record[3]);
4445*0b57cec5SDimitry Andric         if (!OpTy || !Cond || !Default)
4446*0b57cec5SDimitry Andric           return error("Invalid record");
4447*0b57cec5SDimitry Andric 
4448*0b57cec5SDimitry Andric         unsigned NumCases = Record[4];
4449*0b57cec5SDimitry Andric 
4450*0b57cec5SDimitry Andric         SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4451*0b57cec5SDimitry Andric         InstructionList.push_back(SI);
4452*0b57cec5SDimitry Andric 
4453*0b57cec5SDimitry Andric         unsigned CurIdx = 5;
4454*0b57cec5SDimitry Andric         for (unsigned i = 0; i != NumCases; ++i) {
4455*0b57cec5SDimitry Andric           SmallVector<ConstantInt*, 1> CaseVals;
4456*0b57cec5SDimitry Andric           unsigned NumItems = Record[CurIdx++];
4457*0b57cec5SDimitry Andric           for (unsigned ci = 0; ci != NumItems; ++ci) {
4458*0b57cec5SDimitry Andric             bool isSingleNumber = Record[CurIdx++];
4459*0b57cec5SDimitry Andric 
4460*0b57cec5SDimitry Andric             APInt Low;
4461*0b57cec5SDimitry Andric             unsigned ActiveWords = 1;
4462*0b57cec5SDimitry Andric             if (ValueBitWidth > 64)
4463*0b57cec5SDimitry Andric               ActiveWords = Record[CurIdx++];
4464*0b57cec5SDimitry Andric             Low = readWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
4465*0b57cec5SDimitry Andric                                 ValueBitWidth);
4466*0b57cec5SDimitry Andric             CurIdx += ActiveWords;
4467*0b57cec5SDimitry Andric 
4468*0b57cec5SDimitry Andric             if (!isSingleNumber) {
4469*0b57cec5SDimitry Andric               ActiveWords = 1;
4470*0b57cec5SDimitry Andric               if (ValueBitWidth > 64)
4471*0b57cec5SDimitry Andric                 ActiveWords = Record[CurIdx++];
4472*0b57cec5SDimitry Andric               APInt High = readWideAPInt(
4473*0b57cec5SDimitry Andric                   makeArrayRef(&Record[CurIdx], ActiveWords), ValueBitWidth);
4474*0b57cec5SDimitry Andric               CurIdx += ActiveWords;
4475*0b57cec5SDimitry Andric 
4476*0b57cec5SDimitry Andric               // FIXME: It is not clear whether values in the range should be
4477*0b57cec5SDimitry Andric               // compared as signed or unsigned values. The partially
4478*0b57cec5SDimitry Andric               // implemented changes that used this format in the past used
4479*0b57cec5SDimitry Andric               // unsigned comparisons.
4480*0b57cec5SDimitry Andric               for ( ; Low.ule(High); ++Low)
4481*0b57cec5SDimitry Andric                 CaseVals.push_back(ConstantInt::get(Context, Low));
4482*0b57cec5SDimitry Andric             } else
4483*0b57cec5SDimitry Andric               CaseVals.push_back(ConstantInt::get(Context, Low));
4484*0b57cec5SDimitry Andric           }
4485*0b57cec5SDimitry Andric           BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
4486*0b57cec5SDimitry Andric           for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
4487*0b57cec5SDimitry Andric                  cve = CaseVals.end(); cvi != cve; ++cvi)
4488*0b57cec5SDimitry Andric             SI->addCase(*cvi, DestBB);
4489*0b57cec5SDimitry Andric         }
4490*0b57cec5SDimitry Andric         I = SI;
4491*0b57cec5SDimitry Andric         break;
4492*0b57cec5SDimitry Andric       }
4493*0b57cec5SDimitry Andric 
4494*0b57cec5SDimitry Andric       // Old SwitchInst format without case ranges.
4495*0b57cec5SDimitry Andric 
4496*0b57cec5SDimitry Andric       if (Record.size() < 3 || (Record.size() & 1) == 0)
4497*0b57cec5SDimitry Andric         return error("Invalid record");
4498*0b57cec5SDimitry Andric       Type *OpTy = getTypeByID(Record[0]);
4499*0b57cec5SDimitry Andric       Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
4500*0b57cec5SDimitry Andric       BasicBlock *Default = getBasicBlock(Record[2]);
4501*0b57cec5SDimitry Andric       if (!OpTy || !Cond || !Default)
4502*0b57cec5SDimitry Andric         return error("Invalid record");
4503*0b57cec5SDimitry Andric       unsigned NumCases = (Record.size()-3)/2;
4504*0b57cec5SDimitry Andric       SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
4505*0b57cec5SDimitry Andric       InstructionList.push_back(SI);
4506*0b57cec5SDimitry Andric       for (unsigned i = 0, e = NumCases; i != e; ++i) {
4507*0b57cec5SDimitry Andric         ConstantInt *CaseVal =
4508*0b57cec5SDimitry Andric           dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
4509*0b57cec5SDimitry Andric         BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
4510*0b57cec5SDimitry Andric         if (!CaseVal || !DestBB) {
4511*0b57cec5SDimitry Andric           delete SI;
4512*0b57cec5SDimitry Andric           return error("Invalid record");
4513*0b57cec5SDimitry Andric         }
4514*0b57cec5SDimitry Andric         SI->addCase(CaseVal, DestBB);
4515*0b57cec5SDimitry Andric       }
4516*0b57cec5SDimitry Andric       I = SI;
4517*0b57cec5SDimitry Andric       break;
4518*0b57cec5SDimitry Andric     }
4519*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
4520*0b57cec5SDimitry Andric       if (Record.size() < 2)
4521*0b57cec5SDimitry Andric         return error("Invalid record");
4522*0b57cec5SDimitry Andric       Type *OpTy = getTypeByID(Record[0]);
4523*0b57cec5SDimitry Andric       Value *Address = getValue(Record, 1, NextValueNo, OpTy);
4524*0b57cec5SDimitry Andric       if (!OpTy || !Address)
4525*0b57cec5SDimitry Andric         return error("Invalid record");
4526*0b57cec5SDimitry Andric       unsigned NumDests = Record.size()-2;
4527*0b57cec5SDimitry Andric       IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
4528*0b57cec5SDimitry Andric       InstructionList.push_back(IBI);
4529*0b57cec5SDimitry Andric       for (unsigned i = 0, e = NumDests; i != e; ++i) {
4530*0b57cec5SDimitry Andric         if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
4531*0b57cec5SDimitry Andric           IBI->addDestination(DestBB);
4532*0b57cec5SDimitry Andric         } else {
4533*0b57cec5SDimitry Andric           delete IBI;
4534*0b57cec5SDimitry Andric           return error("Invalid record");
4535*0b57cec5SDimitry Andric         }
4536*0b57cec5SDimitry Andric       }
4537*0b57cec5SDimitry Andric       I = IBI;
4538*0b57cec5SDimitry Andric       break;
4539*0b57cec5SDimitry Andric     }
4540*0b57cec5SDimitry Andric 
4541*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_INVOKE: {
4542*0b57cec5SDimitry Andric       // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
4543*0b57cec5SDimitry Andric       if (Record.size() < 4)
4544*0b57cec5SDimitry Andric         return error("Invalid record");
4545*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4546*0b57cec5SDimitry Andric       AttributeList PAL = getAttributes(Record[OpNum++]);
4547*0b57cec5SDimitry Andric       unsigned CCInfo = Record[OpNum++];
4548*0b57cec5SDimitry Andric       BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);
4549*0b57cec5SDimitry Andric       BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);
4550*0b57cec5SDimitry Andric 
4551*0b57cec5SDimitry Andric       FunctionType *FTy = nullptr;
4552*0b57cec5SDimitry Andric       FunctionType *FullFTy = nullptr;
4553*0b57cec5SDimitry Andric       if ((CCInfo >> 13) & 1) {
4554*0b57cec5SDimitry Andric         FullFTy =
4555*0b57cec5SDimitry Andric             dyn_cast<FunctionType>(getFullyStructuredTypeByID(Record[OpNum++]));
4556*0b57cec5SDimitry Andric         if (!FullFTy)
4557*0b57cec5SDimitry Andric           return error("Explicit invoke type is not a function type");
4558*0b57cec5SDimitry Andric         FTy = cast<FunctionType>(flattenPointerTypes(FullFTy));
4559*0b57cec5SDimitry Andric       }
4560*0b57cec5SDimitry Andric 
4561*0b57cec5SDimitry Andric       Value *Callee;
4562*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Callee, &FullTy))
4563*0b57cec5SDimitry Andric         return error("Invalid record");
4564*0b57cec5SDimitry Andric 
4565*0b57cec5SDimitry Andric       PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
4566*0b57cec5SDimitry Andric       if (!CalleeTy)
4567*0b57cec5SDimitry Andric         return error("Callee is not a pointer");
4568*0b57cec5SDimitry Andric       if (!FTy) {
4569*0b57cec5SDimitry Andric         FullFTy =
4570*0b57cec5SDimitry Andric             dyn_cast<FunctionType>(cast<PointerType>(FullTy)->getElementType());
4571*0b57cec5SDimitry Andric         if (!FullFTy)
4572*0b57cec5SDimitry Andric           return error("Callee is not of pointer to function type");
4573*0b57cec5SDimitry Andric         FTy = cast<FunctionType>(flattenPointerTypes(FullFTy));
4574*0b57cec5SDimitry Andric       } else if (getPointerElementFlatType(FullTy) != FTy)
4575*0b57cec5SDimitry Andric         return error("Explicit invoke type does not match pointee type of "
4576*0b57cec5SDimitry Andric                      "callee operand");
4577*0b57cec5SDimitry Andric       if (Record.size() < FTy->getNumParams() + OpNum)
4578*0b57cec5SDimitry Andric         return error("Insufficient operands to call");
4579*0b57cec5SDimitry Andric 
4580*0b57cec5SDimitry Andric       SmallVector<Value*, 16> Ops;
4581*0b57cec5SDimitry Andric       SmallVector<Type *, 16> ArgsFullTys;
4582*0b57cec5SDimitry Andric       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4583*0b57cec5SDimitry Andric         Ops.push_back(getValue(Record, OpNum, NextValueNo,
4584*0b57cec5SDimitry Andric                                FTy->getParamType(i)));
4585*0b57cec5SDimitry Andric         ArgsFullTys.push_back(FullFTy->getParamType(i));
4586*0b57cec5SDimitry Andric         if (!Ops.back())
4587*0b57cec5SDimitry Andric           return error("Invalid record");
4588*0b57cec5SDimitry Andric       }
4589*0b57cec5SDimitry Andric 
4590*0b57cec5SDimitry Andric       if (!FTy->isVarArg()) {
4591*0b57cec5SDimitry Andric         if (Record.size() != OpNum)
4592*0b57cec5SDimitry Andric           return error("Invalid record");
4593*0b57cec5SDimitry Andric       } else {
4594*0b57cec5SDimitry Andric         // Read type/value pairs for varargs params.
4595*0b57cec5SDimitry Andric         while (OpNum != Record.size()) {
4596*0b57cec5SDimitry Andric           Value *Op;
4597*0b57cec5SDimitry Andric           Type *FullTy;
4598*0b57cec5SDimitry Andric           if (getValueTypePair(Record, OpNum, NextValueNo, Op, &FullTy))
4599*0b57cec5SDimitry Andric             return error("Invalid record");
4600*0b57cec5SDimitry Andric           Ops.push_back(Op);
4601*0b57cec5SDimitry Andric           ArgsFullTys.push_back(FullTy);
4602*0b57cec5SDimitry Andric         }
4603*0b57cec5SDimitry Andric       }
4604*0b57cec5SDimitry Andric 
4605*0b57cec5SDimitry Andric       I = InvokeInst::Create(FTy, Callee, NormalBB, UnwindBB, Ops,
4606*0b57cec5SDimitry Andric                              OperandBundles);
4607*0b57cec5SDimitry Andric       FullTy = FullFTy->getReturnType();
4608*0b57cec5SDimitry Andric       OperandBundles.clear();
4609*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4610*0b57cec5SDimitry Andric       cast<InvokeInst>(I)->setCallingConv(
4611*0b57cec5SDimitry Andric           static_cast<CallingConv::ID>(CallingConv::MaxID & CCInfo));
4612*0b57cec5SDimitry Andric       cast<InvokeInst>(I)->setAttributes(PAL);
4613*0b57cec5SDimitry Andric       propagateByValTypes(cast<CallBase>(I), ArgsFullTys);
4614*0b57cec5SDimitry Andric 
4615*0b57cec5SDimitry Andric       break;
4616*0b57cec5SDimitry Andric     }
4617*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
4618*0b57cec5SDimitry Andric       unsigned Idx = 0;
4619*0b57cec5SDimitry Andric       Value *Val = nullptr;
4620*0b57cec5SDimitry Andric       if (getValueTypePair(Record, Idx, NextValueNo, Val))
4621*0b57cec5SDimitry Andric         return error("Invalid record");
4622*0b57cec5SDimitry Andric       I = ResumeInst::Create(Val);
4623*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4624*0b57cec5SDimitry Andric       break;
4625*0b57cec5SDimitry Andric     }
4626*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CALLBR: {
4627*0b57cec5SDimitry Andric       // CALLBR: [attr, cc, norm, transfs, fty, fnid, args]
4628*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4629*0b57cec5SDimitry Andric       AttributeList PAL = getAttributes(Record[OpNum++]);
4630*0b57cec5SDimitry Andric       unsigned CCInfo = Record[OpNum++];
4631*0b57cec5SDimitry Andric 
4632*0b57cec5SDimitry Andric       BasicBlock *DefaultDest = getBasicBlock(Record[OpNum++]);
4633*0b57cec5SDimitry Andric       unsigned NumIndirectDests = Record[OpNum++];
4634*0b57cec5SDimitry Andric       SmallVector<BasicBlock *, 16> IndirectDests;
4635*0b57cec5SDimitry Andric       for (unsigned i = 0, e = NumIndirectDests; i != e; ++i)
4636*0b57cec5SDimitry Andric         IndirectDests.push_back(getBasicBlock(Record[OpNum++]));
4637*0b57cec5SDimitry Andric 
4638*0b57cec5SDimitry Andric       FunctionType *FTy = nullptr;
4639*0b57cec5SDimitry Andric       FunctionType *FullFTy = nullptr;
4640*0b57cec5SDimitry Andric       if ((CCInfo >> bitc::CALL_EXPLICIT_TYPE) & 1) {
4641*0b57cec5SDimitry Andric         FullFTy =
4642*0b57cec5SDimitry Andric             dyn_cast<FunctionType>(getFullyStructuredTypeByID(Record[OpNum++]));
4643*0b57cec5SDimitry Andric         if (!FullFTy)
4644*0b57cec5SDimitry Andric           return error("Explicit call type is not a function type");
4645*0b57cec5SDimitry Andric         FTy = cast<FunctionType>(flattenPointerTypes(FullFTy));
4646*0b57cec5SDimitry Andric       }
4647*0b57cec5SDimitry Andric 
4648*0b57cec5SDimitry Andric       Value *Callee;
4649*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Callee, &FullTy))
4650*0b57cec5SDimitry Andric         return error("Invalid record");
4651*0b57cec5SDimitry Andric 
4652*0b57cec5SDimitry Andric       PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
4653*0b57cec5SDimitry Andric       if (!OpTy)
4654*0b57cec5SDimitry Andric         return error("Callee is not a pointer type");
4655*0b57cec5SDimitry Andric       if (!FTy) {
4656*0b57cec5SDimitry Andric         FullFTy =
4657*0b57cec5SDimitry Andric             dyn_cast<FunctionType>(cast<PointerType>(FullTy)->getElementType());
4658*0b57cec5SDimitry Andric         if (!FullFTy)
4659*0b57cec5SDimitry Andric           return error("Callee is not of pointer to function type");
4660*0b57cec5SDimitry Andric         FTy = cast<FunctionType>(flattenPointerTypes(FullFTy));
4661*0b57cec5SDimitry Andric       } else if (getPointerElementFlatType(FullTy) != FTy)
4662*0b57cec5SDimitry Andric         return error("Explicit call type does not match pointee type of "
4663*0b57cec5SDimitry Andric                      "callee operand");
4664*0b57cec5SDimitry Andric       if (Record.size() < FTy->getNumParams() + OpNum)
4665*0b57cec5SDimitry Andric         return error("Insufficient operands to call");
4666*0b57cec5SDimitry Andric 
4667*0b57cec5SDimitry Andric       SmallVector<Value*, 16> Args;
4668*0b57cec5SDimitry Andric       // Read the fixed params.
4669*0b57cec5SDimitry Andric       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
4670*0b57cec5SDimitry Andric         if (FTy->getParamType(i)->isLabelTy())
4671*0b57cec5SDimitry Andric           Args.push_back(getBasicBlock(Record[OpNum]));
4672*0b57cec5SDimitry Andric         else
4673*0b57cec5SDimitry Andric           Args.push_back(getValue(Record, OpNum, NextValueNo,
4674*0b57cec5SDimitry Andric                                   FTy->getParamType(i)));
4675*0b57cec5SDimitry Andric         if (!Args.back())
4676*0b57cec5SDimitry Andric           return error("Invalid record");
4677*0b57cec5SDimitry Andric       }
4678*0b57cec5SDimitry Andric 
4679*0b57cec5SDimitry Andric       // Read type/value pairs for varargs params.
4680*0b57cec5SDimitry Andric       if (!FTy->isVarArg()) {
4681*0b57cec5SDimitry Andric         if (OpNum != Record.size())
4682*0b57cec5SDimitry Andric           return error("Invalid record");
4683*0b57cec5SDimitry Andric       } else {
4684*0b57cec5SDimitry Andric         while (OpNum != Record.size()) {
4685*0b57cec5SDimitry Andric           Value *Op;
4686*0b57cec5SDimitry Andric           if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4687*0b57cec5SDimitry Andric             return error("Invalid record");
4688*0b57cec5SDimitry Andric           Args.push_back(Op);
4689*0b57cec5SDimitry Andric         }
4690*0b57cec5SDimitry Andric       }
4691*0b57cec5SDimitry Andric 
4692*0b57cec5SDimitry Andric       I = CallBrInst::Create(FTy, Callee, DefaultDest, IndirectDests, Args,
4693*0b57cec5SDimitry Andric                              OperandBundles);
4694*0b57cec5SDimitry Andric       FullTy = FullFTy->getReturnType();
4695*0b57cec5SDimitry Andric       OperandBundles.clear();
4696*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4697*0b57cec5SDimitry Andric       cast<CallBrInst>(I)->setCallingConv(
4698*0b57cec5SDimitry Andric           static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));
4699*0b57cec5SDimitry Andric       cast<CallBrInst>(I)->setAttributes(PAL);
4700*0b57cec5SDimitry Andric       break;
4701*0b57cec5SDimitry Andric     }
4702*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
4703*0b57cec5SDimitry Andric       I = new UnreachableInst(Context);
4704*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4705*0b57cec5SDimitry Andric       break;
4706*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
47078bcb0991SDimitry Andric       if (Record.size() < 1)
4708*0b57cec5SDimitry Andric         return error("Invalid record");
47098bcb0991SDimitry Andric       // The first record specifies the type.
4710*0b57cec5SDimitry Andric       FullTy = getFullyStructuredTypeByID(Record[0]);
4711*0b57cec5SDimitry Andric       Type *Ty = flattenPointerTypes(FullTy);
4712*0b57cec5SDimitry Andric       if (!Ty)
4713*0b57cec5SDimitry Andric         return error("Invalid record");
4714*0b57cec5SDimitry Andric 
47158bcb0991SDimitry Andric       // Phi arguments are pairs of records of [value, basic block].
47168bcb0991SDimitry Andric       // There is an optional final record for fast-math-flags if this phi has a
47178bcb0991SDimitry Andric       // floating-point type.
47188bcb0991SDimitry Andric       size_t NumArgs = (Record.size() - 1) / 2;
47198bcb0991SDimitry Andric       PHINode *PN = PHINode::Create(Ty, NumArgs);
4720480093f4SDimitry Andric       if ((Record.size() - 1) % 2 == 1 && !isa<FPMathOperator>(PN))
4721480093f4SDimitry Andric         return error("Invalid record");
4722*0b57cec5SDimitry Andric       InstructionList.push_back(PN);
4723*0b57cec5SDimitry Andric 
47248bcb0991SDimitry Andric       for (unsigned i = 0; i != NumArgs; i++) {
4725*0b57cec5SDimitry Andric         Value *V;
4726*0b57cec5SDimitry Andric         // With the new function encoding, it is possible that operands have
4727*0b57cec5SDimitry Andric         // negative IDs (for forward references).  Use a signed VBR
4728*0b57cec5SDimitry Andric         // representation to keep the encoding small.
4729*0b57cec5SDimitry Andric         if (UseRelativeIDs)
47308bcb0991SDimitry Andric           V = getValueSigned(Record, i * 2 + 1, NextValueNo, Ty);
4731*0b57cec5SDimitry Andric         else
47328bcb0991SDimitry Andric           V = getValue(Record, i * 2 + 1, NextValueNo, Ty);
47338bcb0991SDimitry Andric         BasicBlock *BB = getBasicBlock(Record[i * 2 + 2]);
4734*0b57cec5SDimitry Andric         if (!V || !BB)
4735*0b57cec5SDimitry Andric           return error("Invalid record");
4736*0b57cec5SDimitry Andric         PN->addIncoming(V, BB);
4737*0b57cec5SDimitry Andric       }
4738*0b57cec5SDimitry Andric       I = PN;
47398bcb0991SDimitry Andric 
47408bcb0991SDimitry Andric       // If there are an even number of records, the final record must be FMF.
47418bcb0991SDimitry Andric       if (Record.size() % 2 == 0) {
47428bcb0991SDimitry Andric         assert(isa<FPMathOperator>(I) && "Unexpected phi type");
47438bcb0991SDimitry Andric         FastMathFlags FMF = getDecodedFastMathFlags(Record[Record.size() - 1]);
47448bcb0991SDimitry Andric         if (FMF.any())
47458bcb0991SDimitry Andric           I->setFastMathFlags(FMF);
47468bcb0991SDimitry Andric       }
47478bcb0991SDimitry Andric 
4748*0b57cec5SDimitry Andric       break;
4749*0b57cec5SDimitry Andric     }
4750*0b57cec5SDimitry Andric 
4751*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_LANDINGPAD:
4752*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_LANDINGPAD_OLD: {
4753*0b57cec5SDimitry Andric       // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
4754*0b57cec5SDimitry Andric       unsigned Idx = 0;
4755*0b57cec5SDimitry Andric       if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {
4756*0b57cec5SDimitry Andric         if (Record.size() < 3)
4757*0b57cec5SDimitry Andric           return error("Invalid record");
4758*0b57cec5SDimitry Andric       } else {
4759*0b57cec5SDimitry Andric         assert(BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD);
4760*0b57cec5SDimitry Andric         if (Record.size() < 4)
4761*0b57cec5SDimitry Andric           return error("Invalid record");
4762*0b57cec5SDimitry Andric       }
4763*0b57cec5SDimitry Andric       FullTy = getFullyStructuredTypeByID(Record[Idx++]);
4764*0b57cec5SDimitry Andric       Type *Ty = flattenPointerTypes(FullTy);
4765*0b57cec5SDimitry Andric       if (!Ty)
4766*0b57cec5SDimitry Andric         return error("Invalid record");
4767*0b57cec5SDimitry Andric       if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {
4768*0b57cec5SDimitry Andric         Value *PersFn = nullptr;
4769*0b57cec5SDimitry Andric         if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
4770*0b57cec5SDimitry Andric           return error("Invalid record");
4771*0b57cec5SDimitry Andric 
4772*0b57cec5SDimitry Andric         if (!F->hasPersonalityFn())
4773*0b57cec5SDimitry Andric           F->setPersonalityFn(cast<Constant>(PersFn));
4774*0b57cec5SDimitry Andric         else if (F->getPersonalityFn() != cast<Constant>(PersFn))
4775*0b57cec5SDimitry Andric           return error("Personality function mismatch");
4776*0b57cec5SDimitry Andric       }
4777*0b57cec5SDimitry Andric 
4778*0b57cec5SDimitry Andric       bool IsCleanup = !!Record[Idx++];
4779*0b57cec5SDimitry Andric       unsigned NumClauses = Record[Idx++];
4780*0b57cec5SDimitry Andric       LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);
4781*0b57cec5SDimitry Andric       LP->setCleanup(IsCleanup);
4782*0b57cec5SDimitry Andric       for (unsigned J = 0; J != NumClauses; ++J) {
4783*0b57cec5SDimitry Andric         LandingPadInst::ClauseType CT =
4784*0b57cec5SDimitry Andric           LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
4785*0b57cec5SDimitry Andric         Value *Val;
4786*0b57cec5SDimitry Andric 
4787*0b57cec5SDimitry Andric         if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
4788*0b57cec5SDimitry Andric           delete LP;
4789*0b57cec5SDimitry Andric           return error("Invalid record");
4790*0b57cec5SDimitry Andric         }
4791*0b57cec5SDimitry Andric 
4792*0b57cec5SDimitry Andric         assert((CT != LandingPadInst::Catch ||
4793*0b57cec5SDimitry Andric                 !isa<ArrayType>(Val->getType())) &&
4794*0b57cec5SDimitry Andric                "Catch clause has a invalid type!");
4795*0b57cec5SDimitry Andric         assert((CT != LandingPadInst::Filter ||
4796*0b57cec5SDimitry Andric                 isa<ArrayType>(Val->getType())) &&
4797*0b57cec5SDimitry Andric                "Filter clause has invalid type!");
4798*0b57cec5SDimitry Andric         LP->addClause(cast<Constant>(Val));
4799*0b57cec5SDimitry Andric       }
4800*0b57cec5SDimitry Andric 
4801*0b57cec5SDimitry Andric       I = LP;
4802*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4803*0b57cec5SDimitry Andric       break;
4804*0b57cec5SDimitry Andric     }
4805*0b57cec5SDimitry Andric 
4806*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
4807*0b57cec5SDimitry Andric       if (Record.size() != 4)
4808*0b57cec5SDimitry Andric         return error("Invalid record");
4809*0b57cec5SDimitry Andric       uint64_t AlignRecord = Record[3];
4810*0b57cec5SDimitry Andric       const uint64_t InAllocaMask = uint64_t(1) << 5;
4811*0b57cec5SDimitry Andric       const uint64_t ExplicitTypeMask = uint64_t(1) << 6;
4812*0b57cec5SDimitry Andric       const uint64_t SwiftErrorMask = uint64_t(1) << 7;
4813*0b57cec5SDimitry Andric       const uint64_t FlagMask = InAllocaMask | ExplicitTypeMask |
4814*0b57cec5SDimitry Andric                                 SwiftErrorMask;
4815*0b57cec5SDimitry Andric       bool InAlloca = AlignRecord & InAllocaMask;
4816*0b57cec5SDimitry Andric       bool SwiftError = AlignRecord & SwiftErrorMask;
4817*0b57cec5SDimitry Andric       FullTy = getFullyStructuredTypeByID(Record[0]);
4818*0b57cec5SDimitry Andric       Type *Ty = flattenPointerTypes(FullTy);
4819*0b57cec5SDimitry Andric       if ((AlignRecord & ExplicitTypeMask) == 0) {
4820*0b57cec5SDimitry Andric         auto *PTy = dyn_cast_or_null<PointerType>(Ty);
4821*0b57cec5SDimitry Andric         if (!PTy)
4822*0b57cec5SDimitry Andric           return error("Old-style alloca with a non-pointer type");
4823*0b57cec5SDimitry Andric         std::tie(FullTy, Ty) = getPointerElementTypes(FullTy);
4824*0b57cec5SDimitry Andric       }
4825*0b57cec5SDimitry Andric       Type *OpTy = getTypeByID(Record[1]);
4826*0b57cec5SDimitry Andric       Value *Size = getFnValueByID(Record[2], OpTy);
48278bcb0991SDimitry Andric       MaybeAlign Align;
4828*0b57cec5SDimitry Andric       if (Error Err = parseAlignmentValue(AlignRecord & ~FlagMask, Align)) {
4829*0b57cec5SDimitry Andric         return Err;
4830*0b57cec5SDimitry Andric       }
4831*0b57cec5SDimitry Andric       if (!Ty || !Size)
4832*0b57cec5SDimitry Andric         return error("Invalid record");
4833*0b57cec5SDimitry Andric 
4834*0b57cec5SDimitry Andric       // FIXME: Make this an optional field.
4835*0b57cec5SDimitry Andric       const DataLayout &DL = TheModule->getDataLayout();
4836*0b57cec5SDimitry Andric       unsigned AS = DL.getAllocaAddrSpace();
4837*0b57cec5SDimitry Andric 
48385ffd83dbSDimitry Andric       SmallPtrSet<Type *, 4> Visited;
48395ffd83dbSDimitry Andric       if (!Align && !Ty->isSized(&Visited))
48405ffd83dbSDimitry Andric         return error("alloca of unsized type");
48415ffd83dbSDimitry Andric       if (!Align)
48425ffd83dbSDimitry Andric         Align = DL.getPrefTypeAlign(Ty);
48435ffd83dbSDimitry Andric 
48445ffd83dbSDimitry Andric       AllocaInst *AI = new AllocaInst(Ty, AS, Size, *Align);
4845*0b57cec5SDimitry Andric       AI->setUsedWithInAlloca(InAlloca);
4846*0b57cec5SDimitry Andric       AI->setSwiftError(SwiftError);
4847*0b57cec5SDimitry Andric       I = AI;
4848*0b57cec5SDimitry Andric       FullTy = PointerType::get(FullTy, AS);
4849*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4850*0b57cec5SDimitry Andric       break;
4851*0b57cec5SDimitry Andric     }
4852*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
4853*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4854*0b57cec5SDimitry Andric       Value *Op;
4855*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Op, &FullTy) ||
4856*0b57cec5SDimitry Andric           (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
4857*0b57cec5SDimitry Andric         return error("Invalid record");
4858*0b57cec5SDimitry Andric 
4859*0b57cec5SDimitry Andric       if (!isa<PointerType>(Op->getType()))
4860*0b57cec5SDimitry Andric         return error("Load operand is not a pointer type");
4861*0b57cec5SDimitry Andric 
4862*0b57cec5SDimitry Andric       Type *Ty = nullptr;
4863*0b57cec5SDimitry Andric       if (OpNum + 3 == Record.size()) {
4864*0b57cec5SDimitry Andric         FullTy = getFullyStructuredTypeByID(Record[OpNum++]);
4865*0b57cec5SDimitry Andric         Ty = flattenPointerTypes(FullTy);
4866*0b57cec5SDimitry Andric       } else
4867*0b57cec5SDimitry Andric         std::tie(FullTy, Ty) = getPointerElementTypes(FullTy);
4868*0b57cec5SDimitry Andric 
4869*0b57cec5SDimitry Andric       if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))
4870*0b57cec5SDimitry Andric         return Err;
4871*0b57cec5SDimitry Andric 
48728bcb0991SDimitry Andric       MaybeAlign Align;
4873*0b57cec5SDimitry Andric       if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4874*0b57cec5SDimitry Andric         return Err;
48755ffd83dbSDimitry Andric       SmallPtrSet<Type *, 4> Visited;
48765ffd83dbSDimitry Andric       if (!Align && !Ty->isSized(&Visited))
48775ffd83dbSDimitry Andric         return error("load of unsized type");
48785ffd83dbSDimitry Andric       if (!Align)
48795ffd83dbSDimitry Andric         Align = TheModule->getDataLayout().getABITypeAlign(Ty);
48805ffd83dbSDimitry Andric       I = new LoadInst(Ty, Op, "", Record[OpNum + 1], *Align);
4881*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4882*0b57cec5SDimitry Andric       break;
4883*0b57cec5SDimitry Andric     }
4884*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_LOADATOMIC: {
4885*0b57cec5SDimitry Andric        // LOADATOMIC: [opty, op, align, vol, ordering, ssid]
4886*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4887*0b57cec5SDimitry Andric       Value *Op;
4888*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Op, &FullTy) ||
4889*0b57cec5SDimitry Andric           (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
4890*0b57cec5SDimitry Andric         return error("Invalid record");
4891*0b57cec5SDimitry Andric 
4892*0b57cec5SDimitry Andric       if (!isa<PointerType>(Op->getType()))
4893*0b57cec5SDimitry Andric         return error("Load operand is not a pointer type");
4894*0b57cec5SDimitry Andric 
4895*0b57cec5SDimitry Andric       Type *Ty = nullptr;
4896*0b57cec5SDimitry Andric       if (OpNum + 5 == Record.size()) {
4897*0b57cec5SDimitry Andric         FullTy = getFullyStructuredTypeByID(Record[OpNum++]);
4898*0b57cec5SDimitry Andric         Ty = flattenPointerTypes(FullTy);
4899*0b57cec5SDimitry Andric       } else
4900*0b57cec5SDimitry Andric         std::tie(FullTy, Ty) = getPointerElementTypes(FullTy);
4901*0b57cec5SDimitry Andric 
4902*0b57cec5SDimitry Andric       if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))
4903*0b57cec5SDimitry Andric         return Err;
4904*0b57cec5SDimitry Andric 
4905*0b57cec5SDimitry Andric       AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4906*0b57cec5SDimitry Andric       if (Ordering == AtomicOrdering::NotAtomic ||
4907*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::Release ||
4908*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::AcquireRelease)
4909*0b57cec5SDimitry Andric         return error("Invalid record");
4910*0b57cec5SDimitry Andric       if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)
4911*0b57cec5SDimitry Andric         return error("Invalid record");
4912*0b57cec5SDimitry Andric       SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);
4913*0b57cec5SDimitry Andric 
49148bcb0991SDimitry Andric       MaybeAlign Align;
4915*0b57cec5SDimitry Andric       if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4916*0b57cec5SDimitry Andric         return Err;
49175ffd83dbSDimitry Andric       if (!Align)
49185ffd83dbSDimitry Andric         return error("Alignment missing from atomic load");
49195ffd83dbSDimitry Andric       I = new LoadInst(Ty, Op, "", Record[OpNum + 1], *Align, Ordering, SSID);
4920*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4921*0b57cec5SDimitry Andric       break;
4922*0b57cec5SDimitry Andric     }
4923*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_STORE:
4924*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]
4925*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4926*0b57cec5SDimitry Andric       Value *Val, *Ptr;
4927*0b57cec5SDimitry Andric       Type *FullTy;
4928*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, &FullTy) ||
4929*0b57cec5SDimitry Andric           (BitCode == bitc::FUNC_CODE_INST_STORE
4930*0b57cec5SDimitry Andric                ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4931*0b57cec5SDimitry Andric                : popValue(Record, OpNum, NextValueNo,
4932*0b57cec5SDimitry Andric                           getPointerElementFlatType(FullTy), Val)) ||
4933*0b57cec5SDimitry Andric           OpNum + 2 != Record.size())
4934*0b57cec5SDimitry Andric         return error("Invalid record");
4935*0b57cec5SDimitry Andric 
4936*0b57cec5SDimitry Andric       if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
4937*0b57cec5SDimitry Andric         return Err;
49388bcb0991SDimitry Andric       MaybeAlign Align;
4939*0b57cec5SDimitry Andric       if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4940*0b57cec5SDimitry Andric         return Err;
49415ffd83dbSDimitry Andric       SmallPtrSet<Type *, 4> Visited;
49425ffd83dbSDimitry Andric       if (!Align && !Val->getType()->isSized(&Visited))
49435ffd83dbSDimitry Andric         return error("store of unsized type");
49445ffd83dbSDimitry Andric       if (!Align)
49455ffd83dbSDimitry Andric         Align = TheModule->getDataLayout().getABITypeAlign(Val->getType());
49465ffd83dbSDimitry Andric       I = new StoreInst(Val, Ptr, Record[OpNum + 1], *Align);
4947*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4948*0b57cec5SDimitry Andric       break;
4949*0b57cec5SDimitry Andric     }
4950*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_STOREATOMIC:
4951*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_STOREATOMIC_OLD: {
4952*0b57cec5SDimitry Andric       // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, ssid]
4953*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4954*0b57cec5SDimitry Andric       Value *Val, *Ptr;
4955*0b57cec5SDimitry Andric       Type *FullTy;
4956*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, &FullTy) ||
4957*0b57cec5SDimitry Andric           !isa<PointerType>(Ptr->getType()) ||
4958*0b57cec5SDimitry Andric           (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC
4959*0b57cec5SDimitry Andric                ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4960*0b57cec5SDimitry Andric                : popValue(Record, OpNum, NextValueNo,
4961*0b57cec5SDimitry Andric                           getPointerElementFlatType(FullTy), Val)) ||
4962*0b57cec5SDimitry Andric           OpNum + 4 != Record.size())
4963*0b57cec5SDimitry Andric         return error("Invalid record");
4964*0b57cec5SDimitry Andric 
4965*0b57cec5SDimitry Andric       if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
4966*0b57cec5SDimitry Andric         return Err;
4967*0b57cec5SDimitry Andric       AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
4968*0b57cec5SDimitry Andric       if (Ordering == AtomicOrdering::NotAtomic ||
4969*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::Acquire ||
4970*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::AcquireRelease)
4971*0b57cec5SDimitry Andric         return error("Invalid record");
4972*0b57cec5SDimitry Andric       SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);
4973*0b57cec5SDimitry Andric       if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)
4974*0b57cec5SDimitry Andric         return error("Invalid record");
4975*0b57cec5SDimitry Andric 
49768bcb0991SDimitry Andric       MaybeAlign Align;
4977*0b57cec5SDimitry Andric       if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4978*0b57cec5SDimitry Andric         return Err;
49795ffd83dbSDimitry Andric       if (!Align)
49805ffd83dbSDimitry Andric         return error("Alignment missing from atomic store");
49815ffd83dbSDimitry Andric       I = new StoreInst(Val, Ptr, Record[OpNum + 1], *Align, Ordering, SSID);
4982*0b57cec5SDimitry Andric       InstructionList.push_back(I);
4983*0b57cec5SDimitry Andric       break;
4984*0b57cec5SDimitry Andric     }
4985*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CMPXCHG_OLD:
4986*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CMPXCHG: {
4987*0b57cec5SDimitry Andric       // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, ssid,
4988*0b57cec5SDimitry Andric       //          failureordering?, isweak?]
4989*0b57cec5SDimitry Andric       unsigned OpNum = 0;
4990*0b57cec5SDimitry Andric       Value *Ptr, *Cmp, *New;
4991*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, &FullTy))
4992*0b57cec5SDimitry Andric         return error("Invalid record");
4993*0b57cec5SDimitry Andric 
4994*0b57cec5SDimitry Andric       if (!isa<PointerType>(Ptr->getType()))
4995*0b57cec5SDimitry Andric         return error("Cmpxchg operand is not a pointer type");
4996*0b57cec5SDimitry Andric 
4997*0b57cec5SDimitry Andric       if (BitCode == bitc::FUNC_CODE_INST_CMPXCHG) {
4998*0b57cec5SDimitry Andric         if (getValueTypePair(Record, OpNum, NextValueNo, Cmp, &FullTy))
4999*0b57cec5SDimitry Andric           return error("Invalid record");
5000*0b57cec5SDimitry Andric       } else if (popValue(Record, OpNum, NextValueNo,
5001*0b57cec5SDimitry Andric                           getPointerElementFlatType(FullTy), Cmp))
5002*0b57cec5SDimitry Andric         return error("Invalid record");
5003*0b57cec5SDimitry Andric       else
5004*0b57cec5SDimitry Andric         FullTy = cast<PointerType>(FullTy)->getElementType();
5005*0b57cec5SDimitry Andric 
5006*0b57cec5SDimitry Andric       if (popValue(Record, OpNum, NextValueNo, Cmp->getType(), New) ||
5007*0b57cec5SDimitry Andric           Record.size() < OpNum + 3 || Record.size() > OpNum + 5)
5008*0b57cec5SDimitry Andric         return error("Invalid record");
5009*0b57cec5SDimitry Andric 
5010*0b57cec5SDimitry Andric       AtomicOrdering SuccessOrdering = getDecodedOrdering(Record[OpNum + 1]);
5011*0b57cec5SDimitry Andric       if (SuccessOrdering == AtomicOrdering::NotAtomic ||
5012*0b57cec5SDimitry Andric           SuccessOrdering == AtomicOrdering::Unordered)
5013*0b57cec5SDimitry Andric         return error("Invalid record");
5014*0b57cec5SDimitry Andric       SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 2]);
5015*0b57cec5SDimitry Andric 
5016*0b57cec5SDimitry Andric       if (Error Err = typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))
5017*0b57cec5SDimitry Andric         return Err;
5018*0b57cec5SDimitry Andric       AtomicOrdering FailureOrdering;
5019*0b57cec5SDimitry Andric       if (Record.size() < 7)
5020*0b57cec5SDimitry Andric         FailureOrdering =
5021*0b57cec5SDimitry Andric             AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
5022*0b57cec5SDimitry Andric       else
5023*0b57cec5SDimitry Andric         FailureOrdering = getDecodedOrdering(Record[OpNum + 3]);
5024*0b57cec5SDimitry Andric 
50255ffd83dbSDimitry Andric       Align Alignment(
50265ffd83dbSDimitry Andric           TheModule->getDataLayout().getTypeStoreSize(Cmp->getType()));
50275ffd83dbSDimitry Andric       I = new AtomicCmpXchgInst(Ptr, Cmp, New, Alignment, SuccessOrdering,
50285ffd83dbSDimitry Andric                                 FailureOrdering, SSID);
5029*0b57cec5SDimitry Andric       FullTy = StructType::get(Context, {FullTy, Type::getInt1Ty(Context)});
5030*0b57cec5SDimitry Andric       cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
5031*0b57cec5SDimitry Andric 
5032*0b57cec5SDimitry Andric       if (Record.size() < 8) {
5033*0b57cec5SDimitry Andric         // Before weak cmpxchgs existed, the instruction simply returned the
5034*0b57cec5SDimitry Andric         // value loaded from memory, so bitcode files from that era will be
5035*0b57cec5SDimitry Andric         // expecting the first component of a modern cmpxchg.
5036*0b57cec5SDimitry Andric         CurBB->getInstList().push_back(I);
5037*0b57cec5SDimitry Andric         I = ExtractValueInst::Create(I, 0);
5038*0b57cec5SDimitry Andric         FullTy = cast<StructType>(FullTy)->getElementType(0);
5039*0b57cec5SDimitry Andric       } else {
5040*0b57cec5SDimitry Andric         cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
5041*0b57cec5SDimitry Andric       }
5042*0b57cec5SDimitry Andric 
5043*0b57cec5SDimitry Andric       InstructionList.push_back(I);
5044*0b57cec5SDimitry Andric       break;
5045*0b57cec5SDimitry Andric     }
5046*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_ATOMICRMW: {
5047*0b57cec5SDimitry Andric       // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, ssid]
5048*0b57cec5SDimitry Andric       unsigned OpNum = 0;
5049*0b57cec5SDimitry Andric       Value *Ptr, *Val;
5050*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, &FullTy) ||
5051*0b57cec5SDimitry Andric           !isa<PointerType>(Ptr->getType()) ||
5052*0b57cec5SDimitry Andric           popValue(Record, OpNum, NextValueNo,
5053*0b57cec5SDimitry Andric                    getPointerElementFlatType(FullTy), Val) ||
5054*0b57cec5SDimitry Andric           OpNum + 4 != Record.size())
5055*0b57cec5SDimitry Andric         return error("Invalid record");
5056*0b57cec5SDimitry Andric       AtomicRMWInst::BinOp Operation = getDecodedRMWOperation(Record[OpNum]);
5057*0b57cec5SDimitry Andric       if (Operation < AtomicRMWInst::FIRST_BINOP ||
5058*0b57cec5SDimitry Andric           Operation > AtomicRMWInst::LAST_BINOP)
5059*0b57cec5SDimitry Andric         return error("Invalid record");
5060*0b57cec5SDimitry Andric       AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
5061*0b57cec5SDimitry Andric       if (Ordering == AtomicOrdering::NotAtomic ||
5062*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::Unordered)
5063*0b57cec5SDimitry Andric         return error("Invalid record");
5064*0b57cec5SDimitry Andric       SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);
50655ffd83dbSDimitry Andric       Align Alignment(
50665ffd83dbSDimitry Andric           TheModule->getDataLayout().getTypeStoreSize(Val->getType()));
50675ffd83dbSDimitry Andric       I = new AtomicRMWInst(Operation, Ptr, Val, Alignment, Ordering, SSID);
5068*0b57cec5SDimitry Andric       FullTy = getPointerElementFlatType(FullTy);
5069*0b57cec5SDimitry Andric       cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
5070*0b57cec5SDimitry Andric       InstructionList.push_back(I);
5071*0b57cec5SDimitry Andric       break;
5072*0b57cec5SDimitry Andric     }
5073*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, ssid]
5074*0b57cec5SDimitry Andric       if (2 != Record.size())
5075*0b57cec5SDimitry Andric         return error("Invalid record");
5076*0b57cec5SDimitry Andric       AtomicOrdering Ordering = getDecodedOrdering(Record[0]);
5077*0b57cec5SDimitry Andric       if (Ordering == AtomicOrdering::NotAtomic ||
5078*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::Unordered ||
5079*0b57cec5SDimitry Andric           Ordering == AtomicOrdering::Monotonic)
5080*0b57cec5SDimitry Andric         return error("Invalid record");
5081*0b57cec5SDimitry Andric       SyncScope::ID SSID = getDecodedSyncScopeID(Record[1]);
5082*0b57cec5SDimitry Andric       I = new FenceInst(Context, Ordering, SSID);
5083*0b57cec5SDimitry Andric       InstructionList.push_back(I);
5084*0b57cec5SDimitry Andric       break;
5085*0b57cec5SDimitry Andric     }
5086*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_CALL: {
5087*0b57cec5SDimitry Andric       // CALL: [paramattrs, cc, fmf, fnty, fnid, arg0, arg1...]
5088*0b57cec5SDimitry Andric       if (Record.size() < 3)
5089*0b57cec5SDimitry Andric         return error("Invalid record");
5090*0b57cec5SDimitry Andric 
5091*0b57cec5SDimitry Andric       unsigned OpNum = 0;
5092*0b57cec5SDimitry Andric       AttributeList PAL = getAttributes(Record[OpNum++]);
5093*0b57cec5SDimitry Andric       unsigned CCInfo = Record[OpNum++];
5094*0b57cec5SDimitry Andric 
5095*0b57cec5SDimitry Andric       FastMathFlags FMF;
5096*0b57cec5SDimitry Andric       if ((CCInfo >> bitc::CALL_FMF) & 1) {
5097*0b57cec5SDimitry Andric         FMF = getDecodedFastMathFlags(Record[OpNum++]);
5098*0b57cec5SDimitry Andric         if (!FMF.any())
5099*0b57cec5SDimitry Andric           return error("Fast math flags indicator set for call with no FMF");
5100*0b57cec5SDimitry Andric       }
5101*0b57cec5SDimitry Andric 
5102*0b57cec5SDimitry Andric       FunctionType *FTy = nullptr;
5103*0b57cec5SDimitry Andric       FunctionType *FullFTy = nullptr;
5104*0b57cec5SDimitry Andric       if ((CCInfo >> bitc::CALL_EXPLICIT_TYPE) & 1) {
5105*0b57cec5SDimitry Andric         FullFTy =
5106*0b57cec5SDimitry Andric             dyn_cast<FunctionType>(getFullyStructuredTypeByID(Record[OpNum++]));
5107*0b57cec5SDimitry Andric         if (!FullFTy)
5108*0b57cec5SDimitry Andric           return error("Explicit call type is not a function type");
5109*0b57cec5SDimitry Andric         FTy = cast<FunctionType>(flattenPointerTypes(FullFTy));
5110*0b57cec5SDimitry Andric       }
5111*0b57cec5SDimitry Andric 
5112*0b57cec5SDimitry Andric       Value *Callee;
5113*0b57cec5SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Callee, &FullTy))
5114*0b57cec5SDimitry Andric         return error("Invalid record");
5115*0b57cec5SDimitry Andric 
5116*0b57cec5SDimitry Andric       PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
5117*0b57cec5SDimitry Andric       if (!OpTy)
5118*0b57cec5SDimitry Andric         return error("Callee is not a pointer type");
5119*0b57cec5SDimitry Andric       if (!FTy) {
5120*0b57cec5SDimitry Andric         FullFTy =
5121*0b57cec5SDimitry Andric             dyn_cast<FunctionType>(cast<PointerType>(FullTy)->getElementType());
5122*0b57cec5SDimitry Andric         if (!FullFTy)
5123*0b57cec5SDimitry Andric           return error("Callee is not of pointer to function type");
5124*0b57cec5SDimitry Andric         FTy = cast<FunctionType>(flattenPointerTypes(FullFTy));
5125*0b57cec5SDimitry Andric       } else if (getPointerElementFlatType(FullTy) != FTy)
5126*0b57cec5SDimitry Andric         return error("Explicit call type does not match pointee type of "
5127*0b57cec5SDimitry Andric                      "callee operand");
5128*0b57cec5SDimitry Andric       if (Record.size() < FTy->getNumParams() + OpNum)
5129*0b57cec5SDimitry Andric         return error("Insufficient operands to call");
5130*0b57cec5SDimitry Andric 
5131*0b57cec5SDimitry Andric       SmallVector<Value*, 16> Args;
5132*0b57cec5SDimitry Andric       SmallVector<Type*, 16> ArgsFullTys;
5133*0b57cec5SDimitry Andric       // Read the fixed params.
5134*0b57cec5SDimitry Andric       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
5135*0b57cec5SDimitry Andric         if (FTy->getParamType(i)->isLabelTy())
5136*0b57cec5SDimitry Andric           Args.push_back(getBasicBlock(Record[OpNum]));
5137*0b57cec5SDimitry Andric         else
5138*0b57cec5SDimitry Andric           Args.push_back(getValue(Record, OpNum, NextValueNo,
5139*0b57cec5SDimitry Andric                                   FTy->getParamType(i)));
5140*0b57cec5SDimitry Andric         ArgsFullTys.push_back(FullFTy->getParamType(i));
5141*0b57cec5SDimitry Andric         if (!Args.back())
5142*0b57cec5SDimitry Andric           return error("Invalid record");
5143*0b57cec5SDimitry Andric       }
5144*0b57cec5SDimitry Andric 
5145*0b57cec5SDimitry Andric       // Read type/value pairs for varargs params.
5146*0b57cec5SDimitry Andric       if (!FTy->isVarArg()) {
5147*0b57cec5SDimitry Andric         if (OpNum != Record.size())
5148*0b57cec5SDimitry Andric           return error("Invalid record");
5149*0b57cec5SDimitry Andric       } else {
5150*0b57cec5SDimitry Andric         while (OpNum != Record.size()) {
5151*0b57cec5SDimitry Andric           Value *Op;
5152*0b57cec5SDimitry Andric           Type *FullTy;
5153*0b57cec5SDimitry Andric           if (getValueTypePair(Record, OpNum, NextValueNo, Op, &FullTy))
5154*0b57cec5SDimitry Andric             return error("Invalid record");
5155*0b57cec5SDimitry Andric           Args.push_back(Op);
5156*0b57cec5SDimitry Andric           ArgsFullTys.push_back(FullTy);
5157*0b57cec5SDimitry Andric         }
5158*0b57cec5SDimitry Andric       }
5159*0b57cec5SDimitry Andric 
5160*0b57cec5SDimitry Andric       I = CallInst::Create(FTy, Callee, Args, OperandBundles);
5161*0b57cec5SDimitry Andric       FullTy = FullFTy->getReturnType();
5162*0b57cec5SDimitry Andric       OperandBundles.clear();
5163*0b57cec5SDimitry Andric       InstructionList.push_back(I);
5164*0b57cec5SDimitry Andric       cast<CallInst>(I)->setCallingConv(
5165*0b57cec5SDimitry Andric           static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));
5166*0b57cec5SDimitry Andric       CallInst::TailCallKind TCK = CallInst::TCK_None;
5167*0b57cec5SDimitry Andric       if (CCInfo & 1 << bitc::CALL_TAIL)
5168*0b57cec5SDimitry Andric         TCK = CallInst::TCK_Tail;
5169*0b57cec5SDimitry Andric       if (CCInfo & (1 << bitc::CALL_MUSTTAIL))
5170*0b57cec5SDimitry Andric         TCK = CallInst::TCK_MustTail;
5171*0b57cec5SDimitry Andric       if (CCInfo & (1 << bitc::CALL_NOTAIL))
5172*0b57cec5SDimitry Andric         TCK = CallInst::TCK_NoTail;
5173*0b57cec5SDimitry Andric       cast<CallInst>(I)->setTailCallKind(TCK);
5174*0b57cec5SDimitry Andric       cast<CallInst>(I)->setAttributes(PAL);
5175*0b57cec5SDimitry Andric       propagateByValTypes(cast<CallBase>(I), ArgsFullTys);
5176*0b57cec5SDimitry Andric       if (FMF.any()) {
5177*0b57cec5SDimitry Andric         if (!isa<FPMathOperator>(I))
5178*0b57cec5SDimitry Andric           return error("Fast-math-flags specified for call without "
5179*0b57cec5SDimitry Andric                        "floating-point scalar or vector return type");
5180*0b57cec5SDimitry Andric         I->setFastMathFlags(FMF);
5181*0b57cec5SDimitry Andric       }
5182*0b57cec5SDimitry Andric       break;
5183*0b57cec5SDimitry Andric     }
5184*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
5185*0b57cec5SDimitry Andric       if (Record.size() < 3)
5186*0b57cec5SDimitry Andric         return error("Invalid record");
5187*0b57cec5SDimitry Andric       Type *OpTy = getTypeByID(Record[0]);
5188*0b57cec5SDimitry Andric       Value *Op = getValue(Record, 1, NextValueNo, OpTy);
5189*0b57cec5SDimitry Andric       FullTy = getFullyStructuredTypeByID(Record[2]);
5190*0b57cec5SDimitry Andric       Type *ResTy = flattenPointerTypes(FullTy);
5191*0b57cec5SDimitry Andric       if (!OpTy || !Op || !ResTy)
5192*0b57cec5SDimitry Andric         return error("Invalid record");
5193*0b57cec5SDimitry Andric       I = new VAArgInst(Op, ResTy);
5194*0b57cec5SDimitry Andric       InstructionList.push_back(I);
5195*0b57cec5SDimitry Andric       break;
5196*0b57cec5SDimitry Andric     }
5197*0b57cec5SDimitry Andric 
5198*0b57cec5SDimitry Andric     case bitc::FUNC_CODE_OPERAND_BUNDLE: {
5199*0b57cec5SDimitry Andric       // A call or an invoke can be optionally prefixed with some variable
5200*0b57cec5SDimitry Andric       // number of operand bundle blocks.  These blocks are read into
5201*0b57cec5SDimitry Andric       // OperandBundles and consumed at the next call or invoke instruction.
5202*0b57cec5SDimitry Andric 
5203*0b57cec5SDimitry Andric       if (Record.size() < 1 || Record[0] >= BundleTags.size())
5204*0b57cec5SDimitry Andric         return error("Invalid record");
5205*0b57cec5SDimitry Andric 
5206*0b57cec5SDimitry Andric       std::vector<Value *> Inputs;
5207*0b57cec5SDimitry Andric 
5208*0b57cec5SDimitry Andric       unsigned OpNum = 1;
5209*0b57cec5SDimitry Andric       while (OpNum != Record.size()) {
5210*0b57cec5SDimitry Andric         Value *Op;
5211*0b57cec5SDimitry Andric         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
5212*0b57cec5SDimitry Andric           return error("Invalid record");
5213*0b57cec5SDimitry Andric         Inputs.push_back(Op);
5214*0b57cec5SDimitry Andric       }
5215*0b57cec5SDimitry Andric 
5216*0b57cec5SDimitry Andric       OperandBundles.emplace_back(BundleTags[Record[0]], std::move(Inputs));
5217*0b57cec5SDimitry Andric       continue;
5218*0b57cec5SDimitry Andric     }
5219480093f4SDimitry Andric 
5220480093f4SDimitry Andric     case bitc::FUNC_CODE_INST_FREEZE: { // FREEZE: [opty,opval]
5221480093f4SDimitry Andric       unsigned OpNum = 0;
5222480093f4SDimitry Andric       Value *Op = nullptr;
5223480093f4SDimitry Andric       if (getValueTypePair(Record, OpNum, NextValueNo, Op, &FullTy))
5224480093f4SDimitry Andric         return error("Invalid record");
5225480093f4SDimitry Andric       if (OpNum != Record.size())
5226480093f4SDimitry Andric         return error("Invalid record");
5227480093f4SDimitry Andric 
5228480093f4SDimitry Andric       I = new FreezeInst(Op);
5229480093f4SDimitry Andric       InstructionList.push_back(I);
5230480093f4SDimitry Andric       break;
5231480093f4SDimitry Andric     }
5232*0b57cec5SDimitry Andric     }
5233*0b57cec5SDimitry Andric 
5234*0b57cec5SDimitry Andric     // Add instruction to end of current BB.  If there is no current BB, reject
5235*0b57cec5SDimitry Andric     // this file.
5236*0b57cec5SDimitry Andric     if (!CurBB) {
5237*0b57cec5SDimitry Andric       I->deleteValue();
5238*0b57cec5SDimitry Andric       return error("Invalid instruction with no BB");
5239*0b57cec5SDimitry Andric     }
5240*0b57cec5SDimitry Andric     if (!OperandBundles.empty()) {
5241*0b57cec5SDimitry Andric       I->deleteValue();
5242*0b57cec5SDimitry Andric       return error("Operand bundles found with no consumer");
5243*0b57cec5SDimitry Andric     }
5244*0b57cec5SDimitry Andric     CurBB->getInstList().push_back(I);
5245*0b57cec5SDimitry Andric 
5246*0b57cec5SDimitry Andric     // If this was a terminator instruction, move to the next block.
5247*0b57cec5SDimitry Andric     if (I->isTerminator()) {
5248*0b57cec5SDimitry Andric       ++CurBBNo;
5249*0b57cec5SDimitry Andric       CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
5250*0b57cec5SDimitry Andric     }
5251*0b57cec5SDimitry Andric 
5252*0b57cec5SDimitry Andric     // Non-void values get registered in the value table for future use.
5253480093f4SDimitry Andric     if (!I->getType()->isVoidTy()) {
5254*0b57cec5SDimitry Andric       if (!FullTy) {
5255*0b57cec5SDimitry Andric         FullTy = I->getType();
5256*0b57cec5SDimitry Andric         assert(
5257*0b57cec5SDimitry Andric             !FullTy->isPointerTy() && !isa<StructType>(FullTy) &&
5258*0b57cec5SDimitry Andric             !isa<ArrayType>(FullTy) &&
5259*0b57cec5SDimitry Andric             (!isa<VectorType>(FullTy) ||
52605ffd83dbSDimitry Andric              cast<VectorType>(FullTy)->getElementType()->isFloatingPointTy() ||
52615ffd83dbSDimitry Andric              cast<VectorType>(FullTy)->getElementType()->isIntegerTy()) &&
5262*0b57cec5SDimitry Andric             "Structured types must be assigned with corresponding non-opaque "
5263*0b57cec5SDimitry Andric             "pointer type");
5264*0b57cec5SDimitry Andric       }
5265*0b57cec5SDimitry Andric 
5266*0b57cec5SDimitry Andric       assert(I->getType() == flattenPointerTypes(FullTy) &&
5267*0b57cec5SDimitry Andric              "Incorrect fully structured type provided for Instruction");
5268*0b57cec5SDimitry Andric       ValueList.assignValue(I, NextValueNo++, FullTy);
5269*0b57cec5SDimitry Andric     }
5270*0b57cec5SDimitry Andric   }
5271*0b57cec5SDimitry Andric 
5272*0b57cec5SDimitry Andric OutOfRecordLoop:
5273*0b57cec5SDimitry Andric 
5274*0b57cec5SDimitry Andric   if (!OperandBundles.empty())
5275*0b57cec5SDimitry Andric     return error("Operand bundles found with no consumer");
5276*0b57cec5SDimitry Andric 
5277*0b57cec5SDimitry Andric   // Check the function list for unresolved values.
5278*0b57cec5SDimitry Andric   if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
5279*0b57cec5SDimitry Andric     if (!A->getParent()) {
5280*0b57cec5SDimitry Andric       // We found at least one unresolved value.  Nuke them all to avoid leaks.
5281*0b57cec5SDimitry Andric       for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
5282*0b57cec5SDimitry Andric         if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
5283*0b57cec5SDimitry Andric           A->replaceAllUsesWith(UndefValue::get(A->getType()));
5284*0b57cec5SDimitry Andric           delete A;
5285*0b57cec5SDimitry Andric         }
5286*0b57cec5SDimitry Andric       }
5287*0b57cec5SDimitry Andric       return error("Never resolved value found in function");
5288*0b57cec5SDimitry Andric     }
5289*0b57cec5SDimitry Andric   }
5290*0b57cec5SDimitry Andric 
5291*0b57cec5SDimitry Andric   // Unexpected unresolved metadata about to be dropped.
5292*0b57cec5SDimitry Andric   if (MDLoader->hasFwdRefs())
5293*0b57cec5SDimitry Andric     return error("Invalid function metadata: outgoing forward refs");
5294*0b57cec5SDimitry Andric 
5295*0b57cec5SDimitry Andric   // Trim the value list down to the size it was before we parsed this function.
5296*0b57cec5SDimitry Andric   ValueList.shrinkTo(ModuleValueListSize);
5297*0b57cec5SDimitry Andric   MDLoader->shrinkTo(ModuleMDLoaderSize);
5298*0b57cec5SDimitry Andric   std::vector<BasicBlock*>().swap(FunctionBBs);
5299*0b57cec5SDimitry Andric   return Error::success();
5300*0b57cec5SDimitry Andric }
5301*0b57cec5SDimitry Andric 
5302*0b57cec5SDimitry Andric /// Find the function body in the bitcode stream
5303*0b57cec5SDimitry Andric Error BitcodeReader::findFunctionInStream(
5304*0b57cec5SDimitry Andric     Function *F,
5305*0b57cec5SDimitry Andric     DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
5306*0b57cec5SDimitry Andric   while (DeferredFunctionInfoIterator->second == 0) {
5307*0b57cec5SDimitry Andric     // This is the fallback handling for the old format bitcode that
5308*0b57cec5SDimitry Andric     // didn't contain the function index in the VST, or when we have
5309*0b57cec5SDimitry Andric     // an anonymous function which would not have a VST entry.
5310*0b57cec5SDimitry Andric     // Assert that we have one of those two cases.
5311*0b57cec5SDimitry Andric     assert(VSTOffset == 0 || !F->hasName());
5312*0b57cec5SDimitry Andric     // Parse the next body in the stream and set its position in the
5313*0b57cec5SDimitry Andric     // DeferredFunctionInfo map.
5314*0b57cec5SDimitry Andric     if (Error Err = rememberAndSkipFunctionBodies())
5315*0b57cec5SDimitry Andric       return Err;
5316*0b57cec5SDimitry Andric   }
5317*0b57cec5SDimitry Andric   return Error::success();
5318*0b57cec5SDimitry Andric }
5319*0b57cec5SDimitry Andric 
5320*0b57cec5SDimitry Andric SyncScope::ID BitcodeReader::getDecodedSyncScopeID(unsigned Val) {
5321*0b57cec5SDimitry Andric   if (Val == SyncScope::SingleThread || Val == SyncScope::System)
5322*0b57cec5SDimitry Andric     return SyncScope::ID(Val);
5323*0b57cec5SDimitry Andric   if (Val >= SSIDs.size())
5324*0b57cec5SDimitry Andric     return SyncScope::System; // Map unknown synchronization scopes to system.
5325*0b57cec5SDimitry Andric   return SSIDs[Val];
5326*0b57cec5SDimitry Andric }
5327*0b57cec5SDimitry Andric 
5328*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
5329*0b57cec5SDimitry Andric // GVMaterializer implementation
5330*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
5331*0b57cec5SDimitry Andric 
5332*0b57cec5SDimitry Andric Error BitcodeReader::materialize(GlobalValue *GV) {
5333*0b57cec5SDimitry Andric   Function *F = dyn_cast<Function>(GV);
5334*0b57cec5SDimitry Andric   // If it's not a function or is already material, ignore the request.
5335*0b57cec5SDimitry Andric   if (!F || !F->isMaterializable())
5336*0b57cec5SDimitry Andric     return Error::success();
5337*0b57cec5SDimitry Andric 
5338*0b57cec5SDimitry Andric   DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
5339*0b57cec5SDimitry Andric   assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
5340*0b57cec5SDimitry Andric   // If its position is recorded as 0, its body is somewhere in the stream
5341*0b57cec5SDimitry Andric   // but we haven't seen it yet.
5342*0b57cec5SDimitry Andric   if (DFII->second == 0)
5343*0b57cec5SDimitry Andric     if (Error Err = findFunctionInStream(F, DFII))
5344*0b57cec5SDimitry Andric       return Err;
5345*0b57cec5SDimitry Andric 
5346*0b57cec5SDimitry Andric   // Materialize metadata before parsing any function bodies.
5347*0b57cec5SDimitry Andric   if (Error Err = materializeMetadata())
5348*0b57cec5SDimitry Andric     return Err;
5349*0b57cec5SDimitry Andric 
5350*0b57cec5SDimitry Andric   // Move the bit stream to the saved position of the deferred function body.
5351*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(DFII->second))
5352*0b57cec5SDimitry Andric     return JumpFailed;
5353*0b57cec5SDimitry Andric   if (Error Err = parseFunctionBody(F))
5354*0b57cec5SDimitry Andric     return Err;
5355*0b57cec5SDimitry Andric   F->setIsMaterializable(false);
5356*0b57cec5SDimitry Andric 
5357*0b57cec5SDimitry Andric   if (StripDebugInfo)
5358*0b57cec5SDimitry Andric     stripDebugInfo(*F);
5359*0b57cec5SDimitry Andric 
5360*0b57cec5SDimitry Andric   // Upgrade any old intrinsic calls in the function.
5361*0b57cec5SDimitry Andric   for (auto &I : UpgradedIntrinsics) {
5362*0b57cec5SDimitry Andric     for (auto UI = I.first->materialized_user_begin(), UE = I.first->user_end();
5363*0b57cec5SDimitry Andric          UI != UE;) {
5364*0b57cec5SDimitry Andric       User *U = *UI;
5365*0b57cec5SDimitry Andric       ++UI;
5366*0b57cec5SDimitry Andric       if (CallInst *CI = dyn_cast<CallInst>(U))
5367*0b57cec5SDimitry Andric         UpgradeIntrinsicCall(CI, I.second);
5368*0b57cec5SDimitry Andric     }
5369*0b57cec5SDimitry Andric   }
5370*0b57cec5SDimitry Andric 
5371*0b57cec5SDimitry Andric   // Update calls to the remangled intrinsics
5372*0b57cec5SDimitry Andric   for (auto &I : RemangledIntrinsics)
5373*0b57cec5SDimitry Andric     for (auto UI = I.first->materialized_user_begin(), UE = I.first->user_end();
5374*0b57cec5SDimitry Andric          UI != UE;)
5375*0b57cec5SDimitry Andric       // Don't expect any other users than call sites
53765ffd83dbSDimitry Andric       cast<CallBase>(*UI++)->setCalledFunction(I.second);
5377*0b57cec5SDimitry Andric 
5378*0b57cec5SDimitry Andric   // Finish fn->subprogram upgrade for materialized functions.
5379*0b57cec5SDimitry Andric   if (DISubprogram *SP = MDLoader->lookupSubprogramForFunction(F))
5380*0b57cec5SDimitry Andric     F->setSubprogram(SP);
5381*0b57cec5SDimitry Andric 
5382*0b57cec5SDimitry Andric   // Check if the TBAA Metadata are valid, otherwise we will need to strip them.
5383*0b57cec5SDimitry Andric   if (!MDLoader->isStrippingTBAA()) {
5384*0b57cec5SDimitry Andric     for (auto &I : instructions(F)) {
5385*0b57cec5SDimitry Andric       MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa);
5386*0b57cec5SDimitry Andric       if (!TBAA || TBAAVerifyHelper.visitTBAAMetadata(I, TBAA))
5387*0b57cec5SDimitry Andric         continue;
5388*0b57cec5SDimitry Andric       MDLoader->setStripTBAA(true);
5389*0b57cec5SDimitry Andric       stripTBAA(F->getParent());
5390*0b57cec5SDimitry Andric     }
5391*0b57cec5SDimitry Andric   }
5392*0b57cec5SDimitry Andric 
53935ffd83dbSDimitry Andric   // Look for functions that rely on old function attribute behavior.
53945ffd83dbSDimitry Andric   UpgradeFunctionAttributes(*F);
53955ffd83dbSDimitry Andric 
5396*0b57cec5SDimitry Andric   // Bring in any functions that this function forward-referenced via
5397*0b57cec5SDimitry Andric   // blockaddresses.
5398*0b57cec5SDimitry Andric   return materializeForwardReferencedFunctions();
5399*0b57cec5SDimitry Andric }
5400*0b57cec5SDimitry Andric 
5401*0b57cec5SDimitry Andric Error BitcodeReader::materializeModule() {
5402*0b57cec5SDimitry Andric   if (Error Err = materializeMetadata())
5403*0b57cec5SDimitry Andric     return Err;
5404*0b57cec5SDimitry Andric 
5405*0b57cec5SDimitry Andric   // Promise to materialize all forward references.
5406*0b57cec5SDimitry Andric   WillMaterializeAllForwardRefs = true;
5407*0b57cec5SDimitry Andric 
5408*0b57cec5SDimitry Andric   // Iterate over the module, deserializing any functions that are still on
5409*0b57cec5SDimitry Andric   // disk.
5410*0b57cec5SDimitry Andric   for (Function &F : *TheModule) {
5411*0b57cec5SDimitry Andric     if (Error Err = materialize(&F))
5412*0b57cec5SDimitry Andric       return Err;
5413*0b57cec5SDimitry Andric   }
5414*0b57cec5SDimitry Andric   // At this point, if there are any function bodies, parse the rest of
5415*0b57cec5SDimitry Andric   // the bits in the module past the last function block we have recorded
5416*0b57cec5SDimitry Andric   // through either lazy scanning or the VST.
5417*0b57cec5SDimitry Andric   if (LastFunctionBlockBit || NextUnreadBit)
5418*0b57cec5SDimitry Andric     if (Error Err = parseModule(LastFunctionBlockBit > NextUnreadBit
5419*0b57cec5SDimitry Andric                                     ? LastFunctionBlockBit
5420*0b57cec5SDimitry Andric                                     : NextUnreadBit))
5421*0b57cec5SDimitry Andric       return Err;
5422*0b57cec5SDimitry Andric 
5423*0b57cec5SDimitry Andric   // Check that all block address forward references got resolved (as we
5424*0b57cec5SDimitry Andric   // promised above).
5425*0b57cec5SDimitry Andric   if (!BasicBlockFwdRefs.empty())
5426*0b57cec5SDimitry Andric     return error("Never resolved function from blockaddress");
5427*0b57cec5SDimitry Andric 
5428*0b57cec5SDimitry Andric   // Upgrade any intrinsic calls that slipped through (should not happen!) and
5429*0b57cec5SDimitry Andric   // delete the old functions to clean up. We can't do this unless the entire
5430*0b57cec5SDimitry Andric   // module is materialized because there could always be another function body
5431*0b57cec5SDimitry Andric   // with calls to the old function.
5432*0b57cec5SDimitry Andric   for (auto &I : UpgradedIntrinsics) {
5433*0b57cec5SDimitry Andric     for (auto *U : I.first->users()) {
5434*0b57cec5SDimitry Andric       if (CallInst *CI = dyn_cast<CallInst>(U))
5435*0b57cec5SDimitry Andric         UpgradeIntrinsicCall(CI, I.second);
5436*0b57cec5SDimitry Andric     }
5437*0b57cec5SDimitry Andric     if (!I.first->use_empty())
5438*0b57cec5SDimitry Andric       I.first->replaceAllUsesWith(I.second);
5439*0b57cec5SDimitry Andric     I.first->eraseFromParent();
5440*0b57cec5SDimitry Andric   }
5441*0b57cec5SDimitry Andric   UpgradedIntrinsics.clear();
5442*0b57cec5SDimitry Andric   // Do the same for remangled intrinsics
5443*0b57cec5SDimitry Andric   for (auto &I : RemangledIntrinsics) {
5444*0b57cec5SDimitry Andric     I.first->replaceAllUsesWith(I.second);
5445*0b57cec5SDimitry Andric     I.first->eraseFromParent();
5446*0b57cec5SDimitry Andric   }
5447*0b57cec5SDimitry Andric   RemangledIntrinsics.clear();
5448*0b57cec5SDimitry Andric 
5449*0b57cec5SDimitry Andric   UpgradeDebugInfo(*TheModule);
5450*0b57cec5SDimitry Andric 
5451*0b57cec5SDimitry Andric   UpgradeModuleFlags(*TheModule);
5452*0b57cec5SDimitry Andric 
54538bcb0991SDimitry Andric   UpgradeARCRuntime(*TheModule);
5454*0b57cec5SDimitry Andric 
5455*0b57cec5SDimitry Andric   return Error::success();
5456*0b57cec5SDimitry Andric }
5457*0b57cec5SDimitry Andric 
5458*0b57cec5SDimitry Andric std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
5459*0b57cec5SDimitry Andric   return IdentifiedStructTypes;
5460*0b57cec5SDimitry Andric }
5461*0b57cec5SDimitry Andric 
5462*0b57cec5SDimitry Andric ModuleSummaryIndexBitcodeReader::ModuleSummaryIndexBitcodeReader(
5463*0b57cec5SDimitry Andric     BitstreamCursor Cursor, StringRef Strtab, ModuleSummaryIndex &TheIndex,
5464*0b57cec5SDimitry Andric     StringRef ModulePath, unsigned ModuleId)
5465*0b57cec5SDimitry Andric     : BitcodeReaderBase(std::move(Cursor), Strtab), TheIndex(TheIndex),
5466*0b57cec5SDimitry Andric       ModulePath(ModulePath), ModuleId(ModuleId) {}
5467*0b57cec5SDimitry Andric 
5468*0b57cec5SDimitry Andric void ModuleSummaryIndexBitcodeReader::addThisModule() {
5469*0b57cec5SDimitry Andric   TheIndex.addModule(ModulePath, ModuleId);
5470*0b57cec5SDimitry Andric }
5471*0b57cec5SDimitry Andric 
5472*0b57cec5SDimitry Andric ModuleSummaryIndex::ModuleInfo *
5473*0b57cec5SDimitry Andric ModuleSummaryIndexBitcodeReader::getThisModule() {
5474*0b57cec5SDimitry Andric   return TheIndex.getModule(ModulePath);
5475*0b57cec5SDimitry Andric }
5476*0b57cec5SDimitry Andric 
5477*0b57cec5SDimitry Andric std::pair<ValueInfo, GlobalValue::GUID>
5478*0b57cec5SDimitry Andric ModuleSummaryIndexBitcodeReader::getValueInfoFromValueId(unsigned ValueId) {
5479*0b57cec5SDimitry Andric   auto VGI = ValueIdToValueInfoMap[ValueId];
5480*0b57cec5SDimitry Andric   assert(VGI.first);
5481*0b57cec5SDimitry Andric   return VGI;
5482*0b57cec5SDimitry Andric }
5483*0b57cec5SDimitry Andric 
5484*0b57cec5SDimitry Andric void ModuleSummaryIndexBitcodeReader::setValueGUID(
5485*0b57cec5SDimitry Andric     uint64_t ValueID, StringRef ValueName, GlobalValue::LinkageTypes Linkage,
5486*0b57cec5SDimitry Andric     StringRef SourceFileName) {
5487*0b57cec5SDimitry Andric   std::string GlobalId =
5488*0b57cec5SDimitry Andric       GlobalValue::getGlobalIdentifier(ValueName, Linkage, SourceFileName);
5489*0b57cec5SDimitry Andric   auto ValueGUID = GlobalValue::getGUID(GlobalId);
5490*0b57cec5SDimitry Andric   auto OriginalNameID = ValueGUID;
5491*0b57cec5SDimitry Andric   if (GlobalValue::isLocalLinkage(Linkage))
5492*0b57cec5SDimitry Andric     OriginalNameID = GlobalValue::getGUID(ValueName);
5493*0b57cec5SDimitry Andric   if (PrintSummaryGUIDs)
5494*0b57cec5SDimitry Andric     dbgs() << "GUID " << ValueGUID << "(" << OriginalNameID << ") is "
5495*0b57cec5SDimitry Andric            << ValueName << "\n";
5496*0b57cec5SDimitry Andric 
5497*0b57cec5SDimitry Andric   // UseStrtab is false for legacy summary formats and value names are
5498*0b57cec5SDimitry Andric   // created on stack. In that case we save the name in a string saver in
5499*0b57cec5SDimitry Andric   // the index so that the value name can be recorded.
5500*0b57cec5SDimitry Andric   ValueIdToValueInfoMap[ValueID] = std::make_pair(
5501*0b57cec5SDimitry Andric       TheIndex.getOrInsertValueInfo(
5502*0b57cec5SDimitry Andric           ValueGUID,
5503*0b57cec5SDimitry Andric           UseStrtab ? ValueName : TheIndex.saveString(ValueName)),
5504*0b57cec5SDimitry Andric       OriginalNameID);
5505*0b57cec5SDimitry Andric }
5506*0b57cec5SDimitry Andric 
5507*0b57cec5SDimitry Andric // Specialized value symbol table parser used when reading module index
5508*0b57cec5SDimitry Andric // blocks where we don't actually create global values. The parsed information
5509*0b57cec5SDimitry Andric // is saved in the bitcode reader for use when later parsing summaries.
5510*0b57cec5SDimitry Andric Error ModuleSummaryIndexBitcodeReader::parseValueSymbolTable(
5511*0b57cec5SDimitry Andric     uint64_t Offset,
5512*0b57cec5SDimitry Andric     DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap) {
5513*0b57cec5SDimitry Andric   // With a strtab the VST is not required to parse the summary.
5514*0b57cec5SDimitry Andric   if (UseStrtab)
5515*0b57cec5SDimitry Andric     return Error::success();
5516*0b57cec5SDimitry Andric 
5517*0b57cec5SDimitry Andric   assert(Offset > 0 && "Expected non-zero VST offset");
5518*0b57cec5SDimitry Andric   Expected<uint64_t> MaybeCurrentBit = jumpToValueSymbolTable(Offset, Stream);
5519*0b57cec5SDimitry Andric   if (!MaybeCurrentBit)
5520*0b57cec5SDimitry Andric     return MaybeCurrentBit.takeError();
5521*0b57cec5SDimitry Andric   uint64_t CurrentBit = MaybeCurrentBit.get();
5522*0b57cec5SDimitry Andric 
5523*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
5524*0b57cec5SDimitry Andric     return Err;
5525*0b57cec5SDimitry Andric 
5526*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
5527*0b57cec5SDimitry Andric 
5528*0b57cec5SDimitry Andric   // Read all the records for this value table.
5529*0b57cec5SDimitry Andric   SmallString<128> ValueName;
5530*0b57cec5SDimitry Andric 
5531*0b57cec5SDimitry Andric   while (true) {
5532*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
5533*0b57cec5SDimitry Andric     if (!MaybeEntry)
5534*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
5535*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
5536*0b57cec5SDimitry Andric 
5537*0b57cec5SDimitry Andric     switch (Entry.Kind) {
5538*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
5539*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
5540*0b57cec5SDimitry Andric       return error("Malformed block");
5541*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
5542*0b57cec5SDimitry Andric       // Done parsing VST, jump back to wherever we came from.
5543*0b57cec5SDimitry Andric       if (Error JumpFailed = Stream.JumpToBit(CurrentBit))
5544*0b57cec5SDimitry Andric         return JumpFailed;
5545*0b57cec5SDimitry Andric       return Error::success();
5546*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
5547*0b57cec5SDimitry Andric       // The interesting case.
5548*0b57cec5SDimitry Andric       break;
5549*0b57cec5SDimitry Andric     }
5550*0b57cec5SDimitry Andric 
5551*0b57cec5SDimitry Andric     // Read a record.
5552*0b57cec5SDimitry Andric     Record.clear();
5553*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
5554*0b57cec5SDimitry Andric     if (!MaybeRecord)
5555*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
5556*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
5557*0b57cec5SDimitry Andric     default: // Default behavior: ignore (e.g. VST_CODE_BBENTRY records).
5558*0b57cec5SDimitry Andric       break;
5559*0b57cec5SDimitry Andric     case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]
5560*0b57cec5SDimitry Andric       if (convertToString(Record, 1, ValueName))
5561*0b57cec5SDimitry Andric         return error("Invalid record");
5562*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
5563*0b57cec5SDimitry Andric       assert(!SourceFileName.empty());
5564*0b57cec5SDimitry Andric       auto VLI = ValueIdToLinkageMap.find(ValueID);
5565*0b57cec5SDimitry Andric       assert(VLI != ValueIdToLinkageMap.end() &&
5566*0b57cec5SDimitry Andric              "No linkage found for VST entry?");
5567*0b57cec5SDimitry Andric       auto Linkage = VLI->second;
5568*0b57cec5SDimitry Andric       setValueGUID(ValueID, ValueName, Linkage, SourceFileName);
5569*0b57cec5SDimitry Andric       ValueName.clear();
5570*0b57cec5SDimitry Andric       break;
5571*0b57cec5SDimitry Andric     }
5572*0b57cec5SDimitry Andric     case bitc::VST_CODE_FNENTRY: {
5573*0b57cec5SDimitry Andric       // VST_CODE_FNENTRY: [valueid, offset, namechar x N]
5574*0b57cec5SDimitry Andric       if (convertToString(Record, 2, ValueName))
5575*0b57cec5SDimitry Andric         return error("Invalid record");
5576*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
5577*0b57cec5SDimitry Andric       assert(!SourceFileName.empty());
5578*0b57cec5SDimitry Andric       auto VLI = ValueIdToLinkageMap.find(ValueID);
5579*0b57cec5SDimitry Andric       assert(VLI != ValueIdToLinkageMap.end() &&
5580*0b57cec5SDimitry Andric              "No linkage found for VST entry?");
5581*0b57cec5SDimitry Andric       auto Linkage = VLI->second;
5582*0b57cec5SDimitry Andric       setValueGUID(ValueID, ValueName, Linkage, SourceFileName);
5583*0b57cec5SDimitry Andric       ValueName.clear();
5584*0b57cec5SDimitry Andric       break;
5585*0b57cec5SDimitry Andric     }
5586*0b57cec5SDimitry Andric     case bitc::VST_CODE_COMBINED_ENTRY: {
5587*0b57cec5SDimitry Andric       // VST_CODE_COMBINED_ENTRY: [valueid, refguid]
5588*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
5589*0b57cec5SDimitry Andric       GlobalValue::GUID RefGUID = Record[1];
5590*0b57cec5SDimitry Andric       // The "original name", which is the second value of the pair will be
5591*0b57cec5SDimitry Andric       // overriden later by a FS_COMBINED_ORIGINAL_NAME in the combined index.
5592*0b57cec5SDimitry Andric       ValueIdToValueInfoMap[ValueID] =
5593*0b57cec5SDimitry Andric           std::make_pair(TheIndex.getOrInsertValueInfo(RefGUID), RefGUID);
5594*0b57cec5SDimitry Andric       break;
5595*0b57cec5SDimitry Andric     }
5596*0b57cec5SDimitry Andric     }
5597*0b57cec5SDimitry Andric   }
5598*0b57cec5SDimitry Andric }
5599*0b57cec5SDimitry Andric 
5600*0b57cec5SDimitry Andric // Parse just the blocks needed for building the index out of the module.
5601*0b57cec5SDimitry Andric // At the end of this routine the module Index is populated with a map
5602*0b57cec5SDimitry Andric // from global value id to GlobalValueSummary objects.
5603*0b57cec5SDimitry Andric Error ModuleSummaryIndexBitcodeReader::parseModule() {
5604*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
5605*0b57cec5SDimitry Andric     return Err;
5606*0b57cec5SDimitry Andric 
5607*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
5608*0b57cec5SDimitry Andric   DenseMap<unsigned, GlobalValue::LinkageTypes> ValueIdToLinkageMap;
5609*0b57cec5SDimitry Andric   unsigned ValueId = 0;
5610*0b57cec5SDimitry Andric 
5611*0b57cec5SDimitry Andric   // Read the index for this module.
5612*0b57cec5SDimitry Andric   while (true) {
5613*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
5614*0b57cec5SDimitry Andric     if (!MaybeEntry)
5615*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
5616*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
5617*0b57cec5SDimitry Andric 
5618*0b57cec5SDimitry Andric     switch (Entry.Kind) {
5619*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
5620*0b57cec5SDimitry Andric       return error("Malformed block");
5621*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
5622*0b57cec5SDimitry Andric       return Error::success();
5623*0b57cec5SDimitry Andric 
5624*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
5625*0b57cec5SDimitry Andric       switch (Entry.ID) {
5626*0b57cec5SDimitry Andric       default: // Skip unknown content.
5627*0b57cec5SDimitry Andric         if (Error Err = Stream.SkipBlock())
5628*0b57cec5SDimitry Andric           return Err;
5629*0b57cec5SDimitry Andric         break;
5630*0b57cec5SDimitry Andric       case bitc::BLOCKINFO_BLOCK_ID:
5631*0b57cec5SDimitry Andric         // Need to parse these to get abbrev ids (e.g. for VST)
5632*0b57cec5SDimitry Andric         if (readBlockInfo())
5633*0b57cec5SDimitry Andric           return error("Malformed block");
5634*0b57cec5SDimitry Andric         break;
5635*0b57cec5SDimitry Andric       case bitc::VALUE_SYMTAB_BLOCK_ID:
5636*0b57cec5SDimitry Andric         // Should have been parsed earlier via VSTOffset, unless there
5637*0b57cec5SDimitry Andric         // is no summary section.
5638*0b57cec5SDimitry Andric         assert(((SeenValueSymbolTable && VSTOffset > 0) ||
5639*0b57cec5SDimitry Andric                 !SeenGlobalValSummary) &&
5640*0b57cec5SDimitry Andric                "Expected early VST parse via VSTOffset record");
5641*0b57cec5SDimitry Andric         if (Error Err = Stream.SkipBlock())
5642*0b57cec5SDimitry Andric           return Err;
5643*0b57cec5SDimitry Andric         break;
5644*0b57cec5SDimitry Andric       case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
5645*0b57cec5SDimitry Andric       case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:
5646*0b57cec5SDimitry Andric         // Add the module if it is a per-module index (has a source file name).
5647*0b57cec5SDimitry Andric         if (!SourceFileName.empty())
5648*0b57cec5SDimitry Andric           addThisModule();
5649*0b57cec5SDimitry Andric         assert(!SeenValueSymbolTable &&
5650*0b57cec5SDimitry Andric                "Already read VST when parsing summary block?");
5651*0b57cec5SDimitry Andric         // We might not have a VST if there were no values in the
5652*0b57cec5SDimitry Andric         // summary. An empty summary block generated when we are
5653*0b57cec5SDimitry Andric         // performing ThinLTO compiles so we don't later invoke
5654*0b57cec5SDimitry Andric         // the regular LTO process on them.
5655*0b57cec5SDimitry Andric         if (VSTOffset > 0) {
5656*0b57cec5SDimitry Andric           if (Error Err = parseValueSymbolTable(VSTOffset, ValueIdToLinkageMap))
5657*0b57cec5SDimitry Andric             return Err;
5658*0b57cec5SDimitry Andric           SeenValueSymbolTable = true;
5659*0b57cec5SDimitry Andric         }
5660*0b57cec5SDimitry Andric         SeenGlobalValSummary = true;
5661*0b57cec5SDimitry Andric         if (Error Err = parseEntireSummary(Entry.ID))
5662*0b57cec5SDimitry Andric           return Err;
5663*0b57cec5SDimitry Andric         break;
5664*0b57cec5SDimitry Andric       case bitc::MODULE_STRTAB_BLOCK_ID:
5665*0b57cec5SDimitry Andric         if (Error Err = parseModuleStringTable())
5666*0b57cec5SDimitry Andric           return Err;
5667*0b57cec5SDimitry Andric         break;
5668*0b57cec5SDimitry Andric       }
5669*0b57cec5SDimitry Andric       continue;
5670*0b57cec5SDimitry Andric 
5671*0b57cec5SDimitry Andric     case BitstreamEntry::Record: {
5672*0b57cec5SDimitry Andric         Record.clear();
5673*0b57cec5SDimitry Andric         Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
5674*0b57cec5SDimitry Andric         if (!MaybeBitCode)
5675*0b57cec5SDimitry Andric           return MaybeBitCode.takeError();
5676*0b57cec5SDimitry Andric         switch (MaybeBitCode.get()) {
5677*0b57cec5SDimitry Andric         default:
5678*0b57cec5SDimitry Andric           break; // Default behavior, ignore unknown content.
5679*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_VERSION: {
5680*0b57cec5SDimitry Andric           if (Error Err = parseVersionRecord(Record).takeError())
5681*0b57cec5SDimitry Andric             return Err;
5682*0b57cec5SDimitry Andric           break;
5683*0b57cec5SDimitry Andric         }
5684*0b57cec5SDimitry Andric         /// MODULE_CODE_SOURCE_FILENAME: [namechar x N]
5685*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_SOURCE_FILENAME: {
5686*0b57cec5SDimitry Andric           SmallString<128> ValueName;
5687*0b57cec5SDimitry Andric           if (convertToString(Record, 0, ValueName))
5688*0b57cec5SDimitry Andric             return error("Invalid record");
5689*0b57cec5SDimitry Andric           SourceFileName = ValueName.c_str();
5690*0b57cec5SDimitry Andric           break;
5691*0b57cec5SDimitry Andric         }
5692*0b57cec5SDimitry Andric         /// MODULE_CODE_HASH: [5*i32]
5693*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_HASH: {
5694*0b57cec5SDimitry Andric           if (Record.size() != 5)
5695*0b57cec5SDimitry Andric             return error("Invalid hash length " + Twine(Record.size()).str());
5696*0b57cec5SDimitry Andric           auto &Hash = getThisModule()->second.second;
5697*0b57cec5SDimitry Andric           int Pos = 0;
5698*0b57cec5SDimitry Andric           for (auto &Val : Record) {
5699*0b57cec5SDimitry Andric             assert(!(Val >> 32) && "Unexpected high bits set");
5700*0b57cec5SDimitry Andric             Hash[Pos++] = Val;
5701*0b57cec5SDimitry Andric           }
5702*0b57cec5SDimitry Andric           break;
5703*0b57cec5SDimitry Andric         }
5704*0b57cec5SDimitry Andric         /// MODULE_CODE_VSTOFFSET: [offset]
5705*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_VSTOFFSET:
5706*0b57cec5SDimitry Andric           if (Record.size() < 1)
5707*0b57cec5SDimitry Andric             return error("Invalid record");
5708*0b57cec5SDimitry Andric           // Note that we subtract 1 here because the offset is relative to one
5709*0b57cec5SDimitry Andric           // word before the start of the identification or module block, which
5710*0b57cec5SDimitry Andric           // was historically always the start of the regular bitcode header.
5711*0b57cec5SDimitry Andric           VSTOffset = Record[0] - 1;
5712*0b57cec5SDimitry Andric           break;
5713*0b57cec5SDimitry Andric         // v1 GLOBALVAR: [pointer type, isconst,     initid,       linkage, ...]
5714*0b57cec5SDimitry Andric         // v1 FUNCTION:  [type,         callingconv, isproto,      linkage, ...]
5715*0b57cec5SDimitry Andric         // v1 ALIAS:     [alias type,   addrspace,   aliasee val#, linkage, ...]
5716*0b57cec5SDimitry Andric         // v2: [strtab offset, strtab size, v1]
5717*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_GLOBALVAR:
5718*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_FUNCTION:
5719*0b57cec5SDimitry Andric         case bitc::MODULE_CODE_ALIAS: {
5720*0b57cec5SDimitry Andric           StringRef Name;
5721*0b57cec5SDimitry Andric           ArrayRef<uint64_t> GVRecord;
5722*0b57cec5SDimitry Andric           std::tie(Name, GVRecord) = readNameFromStrtab(Record);
5723*0b57cec5SDimitry Andric           if (GVRecord.size() <= 3)
5724*0b57cec5SDimitry Andric             return error("Invalid record");
5725*0b57cec5SDimitry Andric           uint64_t RawLinkage = GVRecord[3];
5726*0b57cec5SDimitry Andric           GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
5727*0b57cec5SDimitry Andric           if (!UseStrtab) {
5728*0b57cec5SDimitry Andric             ValueIdToLinkageMap[ValueId++] = Linkage;
5729*0b57cec5SDimitry Andric             break;
5730*0b57cec5SDimitry Andric           }
5731*0b57cec5SDimitry Andric 
5732*0b57cec5SDimitry Andric           setValueGUID(ValueId++, Name, Linkage, SourceFileName);
5733*0b57cec5SDimitry Andric           break;
5734*0b57cec5SDimitry Andric         }
5735*0b57cec5SDimitry Andric         }
5736*0b57cec5SDimitry Andric       }
5737*0b57cec5SDimitry Andric       continue;
5738*0b57cec5SDimitry Andric     }
5739*0b57cec5SDimitry Andric   }
5740*0b57cec5SDimitry Andric }
5741*0b57cec5SDimitry Andric 
5742*0b57cec5SDimitry Andric std::vector<ValueInfo>
5743*0b57cec5SDimitry Andric ModuleSummaryIndexBitcodeReader::makeRefList(ArrayRef<uint64_t> Record) {
5744*0b57cec5SDimitry Andric   std::vector<ValueInfo> Ret;
5745*0b57cec5SDimitry Andric   Ret.reserve(Record.size());
5746*0b57cec5SDimitry Andric   for (uint64_t RefValueId : Record)
5747*0b57cec5SDimitry Andric     Ret.push_back(getValueInfoFromValueId(RefValueId).first);
5748*0b57cec5SDimitry Andric   return Ret;
5749*0b57cec5SDimitry Andric }
5750*0b57cec5SDimitry Andric 
5751*0b57cec5SDimitry Andric std::vector<FunctionSummary::EdgeTy>
5752*0b57cec5SDimitry Andric ModuleSummaryIndexBitcodeReader::makeCallList(ArrayRef<uint64_t> Record,
5753*0b57cec5SDimitry Andric                                               bool IsOldProfileFormat,
5754*0b57cec5SDimitry Andric                                               bool HasProfile, bool HasRelBF) {
5755*0b57cec5SDimitry Andric   std::vector<FunctionSummary::EdgeTy> Ret;
5756*0b57cec5SDimitry Andric   Ret.reserve(Record.size());
5757*0b57cec5SDimitry Andric   for (unsigned I = 0, E = Record.size(); I != E; ++I) {
5758*0b57cec5SDimitry Andric     CalleeInfo::HotnessType Hotness = CalleeInfo::HotnessType::Unknown;
5759*0b57cec5SDimitry Andric     uint64_t RelBF = 0;
5760*0b57cec5SDimitry Andric     ValueInfo Callee = getValueInfoFromValueId(Record[I]).first;
5761*0b57cec5SDimitry Andric     if (IsOldProfileFormat) {
5762*0b57cec5SDimitry Andric       I += 1; // Skip old callsitecount field
5763*0b57cec5SDimitry Andric       if (HasProfile)
5764*0b57cec5SDimitry Andric         I += 1; // Skip old profilecount field
5765*0b57cec5SDimitry Andric     } else if (HasProfile)
5766*0b57cec5SDimitry Andric       Hotness = static_cast<CalleeInfo::HotnessType>(Record[++I]);
5767*0b57cec5SDimitry Andric     else if (HasRelBF)
5768*0b57cec5SDimitry Andric       RelBF = Record[++I];
5769*0b57cec5SDimitry Andric     Ret.push_back(FunctionSummary::EdgeTy{Callee, CalleeInfo(Hotness, RelBF)});
5770*0b57cec5SDimitry Andric   }
5771*0b57cec5SDimitry Andric   return Ret;
5772*0b57cec5SDimitry Andric }
5773*0b57cec5SDimitry Andric 
5774*0b57cec5SDimitry Andric static void
5775*0b57cec5SDimitry Andric parseWholeProgramDevirtResolutionByArg(ArrayRef<uint64_t> Record, size_t &Slot,
5776*0b57cec5SDimitry Andric                                        WholeProgramDevirtResolution &Wpd) {
5777*0b57cec5SDimitry Andric   uint64_t ArgNum = Record[Slot++];
5778*0b57cec5SDimitry Andric   WholeProgramDevirtResolution::ByArg &B =
5779*0b57cec5SDimitry Andric       Wpd.ResByArg[{Record.begin() + Slot, Record.begin() + Slot + ArgNum}];
5780*0b57cec5SDimitry Andric   Slot += ArgNum;
5781*0b57cec5SDimitry Andric 
5782*0b57cec5SDimitry Andric   B.TheKind =
5783*0b57cec5SDimitry Andric       static_cast<WholeProgramDevirtResolution::ByArg::Kind>(Record[Slot++]);
5784*0b57cec5SDimitry Andric   B.Info = Record[Slot++];
5785*0b57cec5SDimitry Andric   B.Byte = Record[Slot++];
5786*0b57cec5SDimitry Andric   B.Bit = Record[Slot++];
5787*0b57cec5SDimitry Andric }
5788*0b57cec5SDimitry Andric 
5789*0b57cec5SDimitry Andric static void parseWholeProgramDevirtResolution(ArrayRef<uint64_t> Record,
5790*0b57cec5SDimitry Andric                                               StringRef Strtab, size_t &Slot,
5791*0b57cec5SDimitry Andric                                               TypeIdSummary &TypeId) {
5792*0b57cec5SDimitry Andric   uint64_t Id = Record[Slot++];
5793*0b57cec5SDimitry Andric   WholeProgramDevirtResolution &Wpd = TypeId.WPDRes[Id];
5794*0b57cec5SDimitry Andric 
5795*0b57cec5SDimitry Andric   Wpd.TheKind = static_cast<WholeProgramDevirtResolution::Kind>(Record[Slot++]);
5796*0b57cec5SDimitry Andric   Wpd.SingleImplName = {Strtab.data() + Record[Slot],
5797*0b57cec5SDimitry Andric                         static_cast<size_t>(Record[Slot + 1])};
5798*0b57cec5SDimitry Andric   Slot += 2;
5799*0b57cec5SDimitry Andric 
5800*0b57cec5SDimitry Andric   uint64_t ResByArgNum = Record[Slot++];
5801*0b57cec5SDimitry Andric   for (uint64_t I = 0; I != ResByArgNum; ++I)
5802*0b57cec5SDimitry Andric     parseWholeProgramDevirtResolutionByArg(Record, Slot, Wpd);
5803*0b57cec5SDimitry Andric }
5804*0b57cec5SDimitry Andric 
5805*0b57cec5SDimitry Andric static void parseTypeIdSummaryRecord(ArrayRef<uint64_t> Record,
5806*0b57cec5SDimitry Andric                                      StringRef Strtab,
5807*0b57cec5SDimitry Andric                                      ModuleSummaryIndex &TheIndex) {
5808*0b57cec5SDimitry Andric   size_t Slot = 0;
5809*0b57cec5SDimitry Andric   TypeIdSummary &TypeId = TheIndex.getOrInsertTypeIdSummary(
5810*0b57cec5SDimitry Andric       {Strtab.data() + Record[Slot], static_cast<size_t>(Record[Slot + 1])});
5811*0b57cec5SDimitry Andric   Slot += 2;
5812*0b57cec5SDimitry Andric 
5813*0b57cec5SDimitry Andric   TypeId.TTRes.TheKind = static_cast<TypeTestResolution::Kind>(Record[Slot++]);
5814*0b57cec5SDimitry Andric   TypeId.TTRes.SizeM1BitWidth = Record[Slot++];
5815*0b57cec5SDimitry Andric   TypeId.TTRes.AlignLog2 = Record[Slot++];
5816*0b57cec5SDimitry Andric   TypeId.TTRes.SizeM1 = Record[Slot++];
5817*0b57cec5SDimitry Andric   TypeId.TTRes.BitMask = Record[Slot++];
5818*0b57cec5SDimitry Andric   TypeId.TTRes.InlineBits = Record[Slot++];
5819*0b57cec5SDimitry Andric 
5820*0b57cec5SDimitry Andric   while (Slot < Record.size())
5821*0b57cec5SDimitry Andric     parseWholeProgramDevirtResolution(Record, Strtab, Slot, TypeId);
5822*0b57cec5SDimitry Andric }
5823*0b57cec5SDimitry Andric 
58245ffd83dbSDimitry Andric static std::vector<FunctionSummary::ParamAccess>
58255ffd83dbSDimitry Andric parseParamAccesses(ArrayRef<uint64_t> Record) {
58265ffd83dbSDimitry Andric   auto ReadRange = [&]() {
58275ffd83dbSDimitry Andric     APInt Lower(FunctionSummary::ParamAccess::RangeWidth,
58285ffd83dbSDimitry Andric                 BitcodeReader::decodeSignRotatedValue(Record.front()));
58295ffd83dbSDimitry Andric     Record = Record.drop_front();
58305ffd83dbSDimitry Andric     APInt Upper(FunctionSummary::ParamAccess::RangeWidth,
58315ffd83dbSDimitry Andric                 BitcodeReader::decodeSignRotatedValue(Record.front()));
58325ffd83dbSDimitry Andric     Record = Record.drop_front();
58335ffd83dbSDimitry Andric     ConstantRange Range{Lower, Upper};
58345ffd83dbSDimitry Andric     assert(!Range.isFullSet());
58355ffd83dbSDimitry Andric     assert(!Range.isUpperSignWrapped());
58365ffd83dbSDimitry Andric     return Range;
58375ffd83dbSDimitry Andric   };
58385ffd83dbSDimitry Andric 
58395ffd83dbSDimitry Andric   std::vector<FunctionSummary::ParamAccess> PendingParamAccesses;
58405ffd83dbSDimitry Andric   while (!Record.empty()) {
58415ffd83dbSDimitry Andric     PendingParamAccesses.emplace_back();
58425ffd83dbSDimitry Andric     FunctionSummary::ParamAccess &ParamAccess = PendingParamAccesses.back();
58435ffd83dbSDimitry Andric     ParamAccess.ParamNo = Record.front();
58445ffd83dbSDimitry Andric     Record = Record.drop_front();
58455ffd83dbSDimitry Andric     ParamAccess.Use = ReadRange();
58465ffd83dbSDimitry Andric     ParamAccess.Calls.resize(Record.front());
58475ffd83dbSDimitry Andric     Record = Record.drop_front();
58485ffd83dbSDimitry Andric     for (auto &Call : ParamAccess.Calls) {
58495ffd83dbSDimitry Andric       Call.ParamNo = Record.front();
58505ffd83dbSDimitry Andric       Record = Record.drop_front();
58515ffd83dbSDimitry Andric       Call.Callee = Record.front();
58525ffd83dbSDimitry Andric       Record = Record.drop_front();
58535ffd83dbSDimitry Andric       Call.Offsets = ReadRange();
58545ffd83dbSDimitry Andric     }
58555ffd83dbSDimitry Andric   }
58565ffd83dbSDimitry Andric   return PendingParamAccesses;
58575ffd83dbSDimitry Andric }
58585ffd83dbSDimitry Andric 
5859*0b57cec5SDimitry Andric void ModuleSummaryIndexBitcodeReader::parseTypeIdCompatibleVtableInfo(
5860*0b57cec5SDimitry Andric     ArrayRef<uint64_t> Record, size_t &Slot,
5861*0b57cec5SDimitry Andric     TypeIdCompatibleVtableInfo &TypeId) {
5862*0b57cec5SDimitry Andric   uint64_t Offset = Record[Slot++];
5863*0b57cec5SDimitry Andric   ValueInfo Callee = getValueInfoFromValueId(Record[Slot++]).first;
5864*0b57cec5SDimitry Andric   TypeId.push_back({Offset, Callee});
5865*0b57cec5SDimitry Andric }
5866*0b57cec5SDimitry Andric 
5867*0b57cec5SDimitry Andric void ModuleSummaryIndexBitcodeReader::parseTypeIdCompatibleVtableSummaryRecord(
5868*0b57cec5SDimitry Andric     ArrayRef<uint64_t> Record) {
5869*0b57cec5SDimitry Andric   size_t Slot = 0;
5870*0b57cec5SDimitry Andric   TypeIdCompatibleVtableInfo &TypeId =
5871*0b57cec5SDimitry Andric       TheIndex.getOrInsertTypeIdCompatibleVtableSummary(
5872*0b57cec5SDimitry Andric           {Strtab.data() + Record[Slot],
5873*0b57cec5SDimitry Andric            static_cast<size_t>(Record[Slot + 1])});
5874*0b57cec5SDimitry Andric   Slot += 2;
5875*0b57cec5SDimitry Andric 
5876*0b57cec5SDimitry Andric   while (Slot < Record.size())
5877*0b57cec5SDimitry Andric     parseTypeIdCompatibleVtableInfo(Record, Slot, TypeId);
5878*0b57cec5SDimitry Andric }
5879*0b57cec5SDimitry Andric 
5880*0b57cec5SDimitry Andric static void setSpecialRefs(std::vector<ValueInfo> &Refs, unsigned ROCnt,
5881*0b57cec5SDimitry Andric                            unsigned WOCnt) {
5882*0b57cec5SDimitry Andric   // Readonly and writeonly refs are in the end of the refs list.
5883*0b57cec5SDimitry Andric   assert(ROCnt + WOCnt <= Refs.size());
5884*0b57cec5SDimitry Andric   unsigned FirstWORef = Refs.size() - WOCnt;
5885*0b57cec5SDimitry Andric   unsigned RefNo = FirstWORef - ROCnt;
5886*0b57cec5SDimitry Andric   for (; RefNo < FirstWORef; ++RefNo)
5887*0b57cec5SDimitry Andric     Refs[RefNo].setReadOnly();
5888*0b57cec5SDimitry Andric   for (; RefNo < Refs.size(); ++RefNo)
5889*0b57cec5SDimitry Andric     Refs[RefNo].setWriteOnly();
5890*0b57cec5SDimitry Andric }
5891*0b57cec5SDimitry Andric 
5892*0b57cec5SDimitry Andric // Eagerly parse the entire summary block. This populates the GlobalValueSummary
5893*0b57cec5SDimitry Andric // objects in the index.
5894*0b57cec5SDimitry Andric Error ModuleSummaryIndexBitcodeReader::parseEntireSummary(unsigned ID) {
5895*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(ID))
5896*0b57cec5SDimitry Andric     return Err;
5897*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
5898*0b57cec5SDimitry Andric 
5899*0b57cec5SDimitry Andric   // Parse version
5900*0b57cec5SDimitry Andric   {
5901*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
5902*0b57cec5SDimitry Andric     if (!MaybeEntry)
5903*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
5904*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
5905*0b57cec5SDimitry Andric 
5906*0b57cec5SDimitry Andric     if (Entry.Kind != BitstreamEntry::Record)
5907*0b57cec5SDimitry Andric       return error("Invalid Summary Block: record for version expected");
5908*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
5909*0b57cec5SDimitry Andric     if (!MaybeRecord)
5910*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
5911*0b57cec5SDimitry Andric     if (MaybeRecord.get() != bitc::FS_VERSION)
5912*0b57cec5SDimitry Andric       return error("Invalid Summary Block: version expected");
5913*0b57cec5SDimitry Andric   }
5914*0b57cec5SDimitry Andric   const uint64_t Version = Record[0];
5915*0b57cec5SDimitry Andric   const bool IsOldProfileFormat = Version == 1;
5916480093f4SDimitry Andric   if (Version < 1 || Version > ModuleSummaryIndex::BitcodeSummaryVersion)
5917*0b57cec5SDimitry Andric     return error("Invalid summary version " + Twine(Version) +
5918480093f4SDimitry Andric                  ". Version should be in the range [1-" +
5919480093f4SDimitry Andric                  Twine(ModuleSummaryIndex::BitcodeSummaryVersion) +
5920480093f4SDimitry Andric                  "].");
5921*0b57cec5SDimitry Andric   Record.clear();
5922*0b57cec5SDimitry Andric 
5923*0b57cec5SDimitry Andric   // Keep around the last seen summary to be used when we see an optional
5924*0b57cec5SDimitry Andric   // "OriginalName" attachement.
5925*0b57cec5SDimitry Andric   GlobalValueSummary *LastSeenSummary = nullptr;
5926*0b57cec5SDimitry Andric   GlobalValue::GUID LastSeenGUID = 0;
5927*0b57cec5SDimitry Andric 
5928*0b57cec5SDimitry Andric   // We can expect to see any number of type ID information records before
5929*0b57cec5SDimitry Andric   // each function summary records; these variables store the information
5930*0b57cec5SDimitry Andric   // collected so far so that it can be used to create the summary object.
5931*0b57cec5SDimitry Andric   std::vector<GlobalValue::GUID> PendingTypeTests;
5932*0b57cec5SDimitry Andric   std::vector<FunctionSummary::VFuncId> PendingTypeTestAssumeVCalls,
5933*0b57cec5SDimitry Andric       PendingTypeCheckedLoadVCalls;
5934*0b57cec5SDimitry Andric   std::vector<FunctionSummary::ConstVCall> PendingTypeTestAssumeConstVCalls,
5935*0b57cec5SDimitry Andric       PendingTypeCheckedLoadConstVCalls;
59365ffd83dbSDimitry Andric   std::vector<FunctionSummary::ParamAccess> PendingParamAccesses;
5937*0b57cec5SDimitry Andric 
5938*0b57cec5SDimitry Andric   while (true) {
5939*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
5940*0b57cec5SDimitry Andric     if (!MaybeEntry)
5941*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
5942*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
5943*0b57cec5SDimitry Andric 
5944*0b57cec5SDimitry Andric     switch (Entry.Kind) {
5945*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
5946*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
5947*0b57cec5SDimitry Andric       return error("Malformed block");
5948*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
5949*0b57cec5SDimitry Andric       return Error::success();
5950*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
5951*0b57cec5SDimitry Andric       // The interesting case.
5952*0b57cec5SDimitry Andric       break;
5953*0b57cec5SDimitry Andric     }
5954*0b57cec5SDimitry Andric 
5955*0b57cec5SDimitry Andric     // Read a record. The record format depends on whether this
5956*0b57cec5SDimitry Andric     // is a per-module index or a combined index file. In the per-module
5957*0b57cec5SDimitry Andric     // case the records contain the associated value's ID for correlation
5958*0b57cec5SDimitry Andric     // with VST entries. In the combined index the correlation is done
5959*0b57cec5SDimitry Andric     // via the bitcode offset of the summary records (which were saved
5960*0b57cec5SDimitry Andric     // in the combined index VST entries). The records also contain
5961*0b57cec5SDimitry Andric     // information used for ThinLTO renaming and importing.
5962*0b57cec5SDimitry Andric     Record.clear();
5963*0b57cec5SDimitry Andric     Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
5964*0b57cec5SDimitry Andric     if (!MaybeBitCode)
5965*0b57cec5SDimitry Andric       return MaybeBitCode.takeError();
5966*0b57cec5SDimitry Andric     switch (unsigned BitCode = MaybeBitCode.get()) {
5967*0b57cec5SDimitry Andric     default: // Default behavior: ignore.
5968*0b57cec5SDimitry Andric       break;
5969*0b57cec5SDimitry Andric     case bitc::FS_FLAGS: {  // [flags]
59705ffd83dbSDimitry Andric       TheIndex.setFlags(Record[0]);
5971*0b57cec5SDimitry Andric       break;
5972*0b57cec5SDimitry Andric     }
5973*0b57cec5SDimitry Andric     case bitc::FS_VALUE_GUID: { // [valueid, refguid]
5974*0b57cec5SDimitry Andric       uint64_t ValueID = Record[0];
5975*0b57cec5SDimitry Andric       GlobalValue::GUID RefGUID = Record[1];
5976*0b57cec5SDimitry Andric       ValueIdToValueInfoMap[ValueID] =
5977*0b57cec5SDimitry Andric           std::make_pair(TheIndex.getOrInsertValueInfo(RefGUID), RefGUID);
5978*0b57cec5SDimitry Andric       break;
5979*0b57cec5SDimitry Andric     }
5980*0b57cec5SDimitry Andric     // FS_PERMODULE: [valueid, flags, instcount, fflags, numrefs,
5981*0b57cec5SDimitry Andric     //                numrefs x valueid, n x (valueid)]
5982*0b57cec5SDimitry Andric     // FS_PERMODULE_PROFILE: [valueid, flags, instcount, fflags, numrefs,
5983*0b57cec5SDimitry Andric     //                        numrefs x valueid,
5984*0b57cec5SDimitry Andric     //                        n x (valueid, hotness)]
5985*0b57cec5SDimitry Andric     // FS_PERMODULE_RELBF: [valueid, flags, instcount, fflags, numrefs,
5986*0b57cec5SDimitry Andric     //                      numrefs x valueid,
5987*0b57cec5SDimitry Andric     //                      n x (valueid, relblockfreq)]
5988*0b57cec5SDimitry Andric     case bitc::FS_PERMODULE:
5989*0b57cec5SDimitry Andric     case bitc::FS_PERMODULE_RELBF:
5990*0b57cec5SDimitry Andric     case bitc::FS_PERMODULE_PROFILE: {
5991*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
5992*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[1];
5993*0b57cec5SDimitry Andric       unsigned InstCount = Record[2];
5994*0b57cec5SDimitry Andric       uint64_t RawFunFlags = 0;
5995*0b57cec5SDimitry Andric       unsigned NumRefs = Record[3];
5996*0b57cec5SDimitry Andric       unsigned NumRORefs = 0, NumWORefs = 0;
5997*0b57cec5SDimitry Andric       int RefListStartIndex = 4;
5998*0b57cec5SDimitry Andric       if (Version >= 4) {
5999*0b57cec5SDimitry Andric         RawFunFlags = Record[3];
6000*0b57cec5SDimitry Andric         NumRefs = Record[4];
6001*0b57cec5SDimitry Andric         RefListStartIndex = 5;
6002*0b57cec5SDimitry Andric         if (Version >= 5) {
6003*0b57cec5SDimitry Andric           NumRORefs = Record[5];
6004*0b57cec5SDimitry Andric           RefListStartIndex = 6;
6005*0b57cec5SDimitry Andric           if (Version >= 7) {
6006*0b57cec5SDimitry Andric             NumWORefs = Record[6];
6007*0b57cec5SDimitry Andric             RefListStartIndex = 7;
6008*0b57cec5SDimitry Andric           }
6009*0b57cec5SDimitry Andric         }
6010*0b57cec5SDimitry Andric       }
6011*0b57cec5SDimitry Andric 
6012*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
6013*0b57cec5SDimitry Andric       // The module path string ref set in the summary must be owned by the
6014*0b57cec5SDimitry Andric       // index's module string table. Since we don't have a module path
6015*0b57cec5SDimitry Andric       // string table section in the per-module index, we create a single
6016*0b57cec5SDimitry Andric       // module path string table entry with an empty (0) ID to take
6017*0b57cec5SDimitry Andric       // ownership.
6018*0b57cec5SDimitry Andric       int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;
6019*0b57cec5SDimitry Andric       assert(Record.size() >= RefListStartIndex + NumRefs &&
6020*0b57cec5SDimitry Andric              "Record size inconsistent with number of references");
6021*0b57cec5SDimitry Andric       std::vector<ValueInfo> Refs = makeRefList(
6022*0b57cec5SDimitry Andric           ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
6023*0b57cec5SDimitry Andric       bool HasProfile = (BitCode == bitc::FS_PERMODULE_PROFILE);
6024*0b57cec5SDimitry Andric       bool HasRelBF = (BitCode == bitc::FS_PERMODULE_RELBF);
6025*0b57cec5SDimitry Andric       std::vector<FunctionSummary::EdgeTy> Calls = makeCallList(
6026*0b57cec5SDimitry Andric           ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),
6027*0b57cec5SDimitry Andric           IsOldProfileFormat, HasProfile, HasRelBF);
6028*0b57cec5SDimitry Andric       setSpecialRefs(Refs, NumRORefs, NumWORefs);
60298bcb0991SDimitry Andric       auto FS = std::make_unique<FunctionSummary>(
6030*0b57cec5SDimitry Andric           Flags, InstCount, getDecodedFFlags(RawFunFlags), /*EntryCount=*/0,
6031*0b57cec5SDimitry Andric           std::move(Refs), std::move(Calls), std::move(PendingTypeTests),
6032*0b57cec5SDimitry Andric           std::move(PendingTypeTestAssumeVCalls),
6033*0b57cec5SDimitry Andric           std::move(PendingTypeCheckedLoadVCalls),
6034*0b57cec5SDimitry Andric           std::move(PendingTypeTestAssumeConstVCalls),
60355ffd83dbSDimitry Andric           std::move(PendingTypeCheckedLoadConstVCalls),
60365ffd83dbSDimitry Andric           std::move(PendingParamAccesses));
6037*0b57cec5SDimitry Andric       auto VIAndOriginalGUID = getValueInfoFromValueId(ValueID);
6038*0b57cec5SDimitry Andric       FS->setModulePath(getThisModule()->first());
6039*0b57cec5SDimitry Andric       FS->setOriginalName(VIAndOriginalGUID.second);
6040*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(VIAndOriginalGUID.first, std::move(FS));
6041*0b57cec5SDimitry Andric       break;
6042*0b57cec5SDimitry Andric     }
6043*0b57cec5SDimitry Andric     // FS_ALIAS: [valueid, flags, valueid]
6044*0b57cec5SDimitry Andric     // Aliases must be emitted (and parsed) after all FS_PERMODULE entries, as
6045*0b57cec5SDimitry Andric     // they expect all aliasee summaries to be available.
6046*0b57cec5SDimitry Andric     case bitc::FS_ALIAS: {
6047*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
6048*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[1];
6049*0b57cec5SDimitry Andric       unsigned AliaseeID = Record[2];
6050*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
60518bcb0991SDimitry Andric       auto AS = std::make_unique<AliasSummary>(Flags);
6052*0b57cec5SDimitry Andric       // The module path string ref set in the summary must be owned by the
6053*0b57cec5SDimitry Andric       // index's module string table. Since we don't have a module path
6054*0b57cec5SDimitry Andric       // string table section in the per-module index, we create a single
6055*0b57cec5SDimitry Andric       // module path string table entry with an empty (0) ID to take
6056*0b57cec5SDimitry Andric       // ownership.
6057*0b57cec5SDimitry Andric       AS->setModulePath(getThisModule()->first());
6058*0b57cec5SDimitry Andric 
6059*0b57cec5SDimitry Andric       auto AliaseeVI = getValueInfoFromValueId(AliaseeID).first;
6060*0b57cec5SDimitry Andric       auto AliaseeInModule = TheIndex.findSummaryInModule(AliaseeVI, ModulePath);
6061*0b57cec5SDimitry Andric       if (!AliaseeInModule)
6062*0b57cec5SDimitry Andric         return error("Alias expects aliasee summary to be parsed");
6063*0b57cec5SDimitry Andric       AS->setAliasee(AliaseeVI, AliaseeInModule);
6064*0b57cec5SDimitry Andric 
6065*0b57cec5SDimitry Andric       auto GUID = getValueInfoFromValueId(ValueID);
6066*0b57cec5SDimitry Andric       AS->setOriginalName(GUID.second);
6067*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(GUID.first, std::move(AS));
6068*0b57cec5SDimitry Andric       break;
6069*0b57cec5SDimitry Andric     }
6070*0b57cec5SDimitry Andric     // FS_PERMODULE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags, n x valueid]
6071*0b57cec5SDimitry Andric     case bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS: {
6072*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
6073*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[1];
6074*0b57cec5SDimitry Andric       unsigned RefArrayStart = 2;
6075*0b57cec5SDimitry Andric       GlobalVarSummary::GVarFlags GVF(/* ReadOnly */ false,
60765ffd83dbSDimitry Andric                                       /* WriteOnly */ false,
60775ffd83dbSDimitry Andric                                       /* Constant */ false,
60785ffd83dbSDimitry Andric                                       GlobalObject::VCallVisibilityPublic);
6079*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
6080*0b57cec5SDimitry Andric       if (Version >= 5) {
6081*0b57cec5SDimitry Andric         GVF = getDecodedGVarFlags(Record[2]);
6082*0b57cec5SDimitry Andric         RefArrayStart = 3;
6083*0b57cec5SDimitry Andric       }
6084*0b57cec5SDimitry Andric       std::vector<ValueInfo> Refs =
6085*0b57cec5SDimitry Andric           makeRefList(ArrayRef<uint64_t>(Record).slice(RefArrayStart));
6086*0b57cec5SDimitry Andric       auto FS =
60878bcb0991SDimitry Andric           std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));
6088*0b57cec5SDimitry Andric       FS->setModulePath(getThisModule()->first());
6089*0b57cec5SDimitry Andric       auto GUID = getValueInfoFromValueId(ValueID);
6090*0b57cec5SDimitry Andric       FS->setOriginalName(GUID.second);
6091*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(GUID.first, std::move(FS));
6092*0b57cec5SDimitry Andric       break;
6093*0b57cec5SDimitry Andric     }
6094*0b57cec5SDimitry Andric     // FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags,
6095*0b57cec5SDimitry Andric     //                        numrefs, numrefs x valueid,
6096*0b57cec5SDimitry Andric     //                        n x (valueid, offset)]
6097*0b57cec5SDimitry Andric     case bitc::FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: {
6098*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
6099*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[1];
6100*0b57cec5SDimitry Andric       GlobalVarSummary::GVarFlags GVF = getDecodedGVarFlags(Record[2]);
6101*0b57cec5SDimitry Andric       unsigned NumRefs = Record[3];
6102*0b57cec5SDimitry Andric       unsigned RefListStartIndex = 4;
6103*0b57cec5SDimitry Andric       unsigned VTableListStartIndex = RefListStartIndex + NumRefs;
6104*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
6105*0b57cec5SDimitry Andric       std::vector<ValueInfo> Refs = makeRefList(
6106*0b57cec5SDimitry Andric           ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
6107*0b57cec5SDimitry Andric       VTableFuncList VTableFuncs;
6108*0b57cec5SDimitry Andric       for (unsigned I = VTableListStartIndex, E = Record.size(); I != E; ++I) {
6109*0b57cec5SDimitry Andric         ValueInfo Callee = getValueInfoFromValueId(Record[I]).first;
6110*0b57cec5SDimitry Andric         uint64_t Offset = Record[++I];
6111*0b57cec5SDimitry Andric         VTableFuncs.push_back({Callee, Offset});
6112*0b57cec5SDimitry Andric       }
6113*0b57cec5SDimitry Andric       auto VS =
61148bcb0991SDimitry Andric           std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));
6115*0b57cec5SDimitry Andric       VS->setModulePath(getThisModule()->first());
6116*0b57cec5SDimitry Andric       VS->setVTableFuncs(VTableFuncs);
6117*0b57cec5SDimitry Andric       auto GUID = getValueInfoFromValueId(ValueID);
6118*0b57cec5SDimitry Andric       VS->setOriginalName(GUID.second);
6119*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(GUID.first, std::move(VS));
6120*0b57cec5SDimitry Andric       break;
6121*0b57cec5SDimitry Andric     }
6122*0b57cec5SDimitry Andric     // FS_COMBINED: [valueid, modid, flags, instcount, fflags, numrefs,
6123*0b57cec5SDimitry Andric     //               numrefs x valueid, n x (valueid)]
6124*0b57cec5SDimitry Andric     // FS_COMBINED_PROFILE: [valueid, modid, flags, instcount, fflags, numrefs,
6125*0b57cec5SDimitry Andric     //                       numrefs x valueid, n x (valueid, hotness)]
6126*0b57cec5SDimitry Andric     case bitc::FS_COMBINED:
6127*0b57cec5SDimitry Andric     case bitc::FS_COMBINED_PROFILE: {
6128*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
6129*0b57cec5SDimitry Andric       uint64_t ModuleId = Record[1];
6130*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[2];
6131*0b57cec5SDimitry Andric       unsigned InstCount = Record[3];
6132*0b57cec5SDimitry Andric       uint64_t RawFunFlags = 0;
6133*0b57cec5SDimitry Andric       uint64_t EntryCount = 0;
6134*0b57cec5SDimitry Andric       unsigned NumRefs = Record[4];
6135*0b57cec5SDimitry Andric       unsigned NumRORefs = 0, NumWORefs = 0;
6136*0b57cec5SDimitry Andric       int RefListStartIndex = 5;
6137*0b57cec5SDimitry Andric 
6138*0b57cec5SDimitry Andric       if (Version >= 4) {
6139*0b57cec5SDimitry Andric         RawFunFlags = Record[4];
6140*0b57cec5SDimitry Andric         RefListStartIndex = 6;
6141*0b57cec5SDimitry Andric         size_t NumRefsIndex = 5;
6142*0b57cec5SDimitry Andric         if (Version >= 5) {
6143*0b57cec5SDimitry Andric           unsigned NumRORefsOffset = 1;
6144*0b57cec5SDimitry Andric           RefListStartIndex = 7;
6145*0b57cec5SDimitry Andric           if (Version >= 6) {
6146*0b57cec5SDimitry Andric             NumRefsIndex = 6;
6147*0b57cec5SDimitry Andric             EntryCount = Record[5];
6148*0b57cec5SDimitry Andric             RefListStartIndex = 8;
6149*0b57cec5SDimitry Andric             if (Version >= 7) {
6150*0b57cec5SDimitry Andric               RefListStartIndex = 9;
6151*0b57cec5SDimitry Andric               NumWORefs = Record[8];
6152*0b57cec5SDimitry Andric               NumRORefsOffset = 2;
6153*0b57cec5SDimitry Andric             }
6154*0b57cec5SDimitry Andric           }
6155*0b57cec5SDimitry Andric           NumRORefs = Record[RefListStartIndex - NumRORefsOffset];
6156*0b57cec5SDimitry Andric         }
6157*0b57cec5SDimitry Andric         NumRefs = Record[NumRefsIndex];
6158*0b57cec5SDimitry Andric       }
6159*0b57cec5SDimitry Andric 
6160*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
6161*0b57cec5SDimitry Andric       int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;
6162*0b57cec5SDimitry Andric       assert(Record.size() >= RefListStartIndex + NumRefs &&
6163*0b57cec5SDimitry Andric              "Record size inconsistent with number of references");
6164*0b57cec5SDimitry Andric       std::vector<ValueInfo> Refs = makeRefList(
6165*0b57cec5SDimitry Andric           ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
6166*0b57cec5SDimitry Andric       bool HasProfile = (BitCode == bitc::FS_COMBINED_PROFILE);
6167*0b57cec5SDimitry Andric       std::vector<FunctionSummary::EdgeTy> Edges = makeCallList(
6168*0b57cec5SDimitry Andric           ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),
6169*0b57cec5SDimitry Andric           IsOldProfileFormat, HasProfile, false);
6170*0b57cec5SDimitry Andric       ValueInfo VI = getValueInfoFromValueId(ValueID).first;
6171*0b57cec5SDimitry Andric       setSpecialRefs(Refs, NumRORefs, NumWORefs);
61728bcb0991SDimitry Andric       auto FS = std::make_unique<FunctionSummary>(
6173*0b57cec5SDimitry Andric           Flags, InstCount, getDecodedFFlags(RawFunFlags), EntryCount,
6174*0b57cec5SDimitry Andric           std::move(Refs), std::move(Edges), std::move(PendingTypeTests),
6175*0b57cec5SDimitry Andric           std::move(PendingTypeTestAssumeVCalls),
6176*0b57cec5SDimitry Andric           std::move(PendingTypeCheckedLoadVCalls),
6177*0b57cec5SDimitry Andric           std::move(PendingTypeTestAssumeConstVCalls),
61785ffd83dbSDimitry Andric           std::move(PendingTypeCheckedLoadConstVCalls),
61795ffd83dbSDimitry Andric           std::move(PendingParamAccesses));
6180*0b57cec5SDimitry Andric       LastSeenSummary = FS.get();
6181*0b57cec5SDimitry Andric       LastSeenGUID = VI.getGUID();
6182*0b57cec5SDimitry Andric       FS->setModulePath(ModuleIdMap[ModuleId]);
6183*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(VI, std::move(FS));
6184*0b57cec5SDimitry Andric       break;
6185*0b57cec5SDimitry Andric     }
6186*0b57cec5SDimitry Andric     // FS_COMBINED_ALIAS: [valueid, modid, flags, valueid]
6187*0b57cec5SDimitry Andric     // Aliases must be emitted (and parsed) after all FS_COMBINED entries, as
6188*0b57cec5SDimitry Andric     // they expect all aliasee summaries to be available.
6189*0b57cec5SDimitry Andric     case bitc::FS_COMBINED_ALIAS: {
6190*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
6191*0b57cec5SDimitry Andric       uint64_t ModuleId = Record[1];
6192*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[2];
6193*0b57cec5SDimitry Andric       unsigned AliaseeValueId = Record[3];
6194*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
61958bcb0991SDimitry Andric       auto AS = std::make_unique<AliasSummary>(Flags);
6196*0b57cec5SDimitry Andric       LastSeenSummary = AS.get();
6197*0b57cec5SDimitry Andric       AS->setModulePath(ModuleIdMap[ModuleId]);
6198*0b57cec5SDimitry Andric 
6199*0b57cec5SDimitry Andric       auto AliaseeVI = getValueInfoFromValueId(AliaseeValueId).first;
6200*0b57cec5SDimitry Andric       auto AliaseeInModule = TheIndex.findSummaryInModule(AliaseeVI, AS->modulePath());
6201*0b57cec5SDimitry Andric       AS->setAliasee(AliaseeVI, AliaseeInModule);
6202*0b57cec5SDimitry Andric 
6203*0b57cec5SDimitry Andric       ValueInfo VI = getValueInfoFromValueId(ValueID).first;
6204*0b57cec5SDimitry Andric       LastSeenGUID = VI.getGUID();
6205*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(VI, std::move(AS));
6206*0b57cec5SDimitry Andric       break;
6207*0b57cec5SDimitry Andric     }
6208*0b57cec5SDimitry Andric     // FS_COMBINED_GLOBALVAR_INIT_REFS: [valueid, modid, flags, n x valueid]
6209*0b57cec5SDimitry Andric     case bitc::FS_COMBINED_GLOBALVAR_INIT_REFS: {
6210*0b57cec5SDimitry Andric       unsigned ValueID = Record[0];
6211*0b57cec5SDimitry Andric       uint64_t ModuleId = Record[1];
6212*0b57cec5SDimitry Andric       uint64_t RawFlags = Record[2];
6213*0b57cec5SDimitry Andric       unsigned RefArrayStart = 3;
6214*0b57cec5SDimitry Andric       GlobalVarSummary::GVarFlags GVF(/* ReadOnly */ false,
62155ffd83dbSDimitry Andric                                       /* WriteOnly */ false,
62165ffd83dbSDimitry Andric                                       /* Constant */ false,
62175ffd83dbSDimitry Andric                                       GlobalObject::VCallVisibilityPublic);
6218*0b57cec5SDimitry Andric       auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
6219*0b57cec5SDimitry Andric       if (Version >= 5) {
6220*0b57cec5SDimitry Andric         GVF = getDecodedGVarFlags(Record[3]);
6221*0b57cec5SDimitry Andric         RefArrayStart = 4;
6222*0b57cec5SDimitry Andric       }
6223*0b57cec5SDimitry Andric       std::vector<ValueInfo> Refs =
6224*0b57cec5SDimitry Andric           makeRefList(ArrayRef<uint64_t>(Record).slice(RefArrayStart));
6225*0b57cec5SDimitry Andric       auto FS =
62268bcb0991SDimitry Andric           std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));
6227*0b57cec5SDimitry Andric       LastSeenSummary = FS.get();
6228*0b57cec5SDimitry Andric       FS->setModulePath(ModuleIdMap[ModuleId]);
6229*0b57cec5SDimitry Andric       ValueInfo VI = getValueInfoFromValueId(ValueID).first;
6230*0b57cec5SDimitry Andric       LastSeenGUID = VI.getGUID();
6231*0b57cec5SDimitry Andric       TheIndex.addGlobalValueSummary(VI, std::move(FS));
6232*0b57cec5SDimitry Andric       break;
6233*0b57cec5SDimitry Andric     }
6234*0b57cec5SDimitry Andric     // FS_COMBINED_ORIGINAL_NAME: [original_name]
6235*0b57cec5SDimitry Andric     case bitc::FS_COMBINED_ORIGINAL_NAME: {
6236*0b57cec5SDimitry Andric       uint64_t OriginalName = Record[0];
6237*0b57cec5SDimitry Andric       if (!LastSeenSummary)
6238*0b57cec5SDimitry Andric         return error("Name attachment that does not follow a combined record");
6239*0b57cec5SDimitry Andric       LastSeenSummary->setOriginalName(OriginalName);
6240*0b57cec5SDimitry Andric       TheIndex.addOriginalName(LastSeenGUID, OriginalName);
6241*0b57cec5SDimitry Andric       // Reset the LastSeenSummary
6242*0b57cec5SDimitry Andric       LastSeenSummary = nullptr;
6243*0b57cec5SDimitry Andric       LastSeenGUID = 0;
6244*0b57cec5SDimitry Andric       break;
6245*0b57cec5SDimitry Andric     }
6246*0b57cec5SDimitry Andric     case bitc::FS_TYPE_TESTS:
6247*0b57cec5SDimitry Andric       assert(PendingTypeTests.empty());
6248*0b57cec5SDimitry Andric       PendingTypeTests.insert(PendingTypeTests.end(), Record.begin(),
6249*0b57cec5SDimitry Andric                               Record.end());
6250*0b57cec5SDimitry Andric       break;
6251*0b57cec5SDimitry Andric 
6252*0b57cec5SDimitry Andric     case bitc::FS_TYPE_TEST_ASSUME_VCALLS:
6253*0b57cec5SDimitry Andric       assert(PendingTypeTestAssumeVCalls.empty());
6254*0b57cec5SDimitry Andric       for (unsigned I = 0; I != Record.size(); I += 2)
6255*0b57cec5SDimitry Andric         PendingTypeTestAssumeVCalls.push_back({Record[I], Record[I+1]});
6256*0b57cec5SDimitry Andric       break;
6257*0b57cec5SDimitry Andric 
6258*0b57cec5SDimitry Andric     case bitc::FS_TYPE_CHECKED_LOAD_VCALLS:
6259*0b57cec5SDimitry Andric       assert(PendingTypeCheckedLoadVCalls.empty());
6260*0b57cec5SDimitry Andric       for (unsigned I = 0; I != Record.size(); I += 2)
6261*0b57cec5SDimitry Andric         PendingTypeCheckedLoadVCalls.push_back({Record[I], Record[I+1]});
6262*0b57cec5SDimitry Andric       break;
6263*0b57cec5SDimitry Andric 
6264*0b57cec5SDimitry Andric     case bitc::FS_TYPE_TEST_ASSUME_CONST_VCALL:
6265*0b57cec5SDimitry Andric       PendingTypeTestAssumeConstVCalls.push_back(
6266*0b57cec5SDimitry Andric           {{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});
6267*0b57cec5SDimitry Andric       break;
6268*0b57cec5SDimitry Andric 
6269*0b57cec5SDimitry Andric     case bitc::FS_TYPE_CHECKED_LOAD_CONST_VCALL:
6270*0b57cec5SDimitry Andric       PendingTypeCheckedLoadConstVCalls.push_back(
6271*0b57cec5SDimitry Andric           {{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});
6272*0b57cec5SDimitry Andric       break;
6273*0b57cec5SDimitry Andric 
6274*0b57cec5SDimitry Andric     case bitc::FS_CFI_FUNCTION_DEFS: {
6275*0b57cec5SDimitry Andric       std::set<std::string> &CfiFunctionDefs = TheIndex.cfiFunctionDefs();
6276*0b57cec5SDimitry Andric       for (unsigned I = 0; I != Record.size(); I += 2)
6277*0b57cec5SDimitry Andric         CfiFunctionDefs.insert(
6278*0b57cec5SDimitry Andric             {Strtab.data() + Record[I], static_cast<size_t>(Record[I + 1])});
6279*0b57cec5SDimitry Andric       break;
6280*0b57cec5SDimitry Andric     }
6281*0b57cec5SDimitry Andric 
6282*0b57cec5SDimitry Andric     case bitc::FS_CFI_FUNCTION_DECLS: {
6283*0b57cec5SDimitry Andric       std::set<std::string> &CfiFunctionDecls = TheIndex.cfiFunctionDecls();
6284*0b57cec5SDimitry Andric       for (unsigned I = 0; I != Record.size(); I += 2)
6285*0b57cec5SDimitry Andric         CfiFunctionDecls.insert(
6286*0b57cec5SDimitry Andric             {Strtab.data() + Record[I], static_cast<size_t>(Record[I + 1])});
6287*0b57cec5SDimitry Andric       break;
6288*0b57cec5SDimitry Andric     }
6289*0b57cec5SDimitry Andric 
6290*0b57cec5SDimitry Andric     case bitc::FS_TYPE_ID:
6291*0b57cec5SDimitry Andric       parseTypeIdSummaryRecord(Record, Strtab, TheIndex);
6292*0b57cec5SDimitry Andric       break;
6293*0b57cec5SDimitry Andric 
6294*0b57cec5SDimitry Andric     case bitc::FS_TYPE_ID_METADATA:
6295*0b57cec5SDimitry Andric       parseTypeIdCompatibleVtableSummaryRecord(Record);
6296*0b57cec5SDimitry Andric       break;
62975ffd83dbSDimitry Andric 
62985ffd83dbSDimitry Andric     case bitc::FS_BLOCK_COUNT:
62995ffd83dbSDimitry Andric       TheIndex.addBlockCount(Record[0]);
63005ffd83dbSDimitry Andric       break;
63015ffd83dbSDimitry Andric 
63025ffd83dbSDimitry Andric     case bitc::FS_PARAM_ACCESS: {
63035ffd83dbSDimitry Andric       PendingParamAccesses = parseParamAccesses(Record);
63045ffd83dbSDimitry Andric       break;
63055ffd83dbSDimitry Andric     }
6306*0b57cec5SDimitry Andric     }
6307*0b57cec5SDimitry Andric   }
6308*0b57cec5SDimitry Andric   llvm_unreachable("Exit infinite loop");
6309*0b57cec5SDimitry Andric }
6310*0b57cec5SDimitry Andric 
6311*0b57cec5SDimitry Andric // Parse the  module string table block into the Index.
6312*0b57cec5SDimitry Andric // This populates the ModulePathStringTable map in the index.
6313*0b57cec5SDimitry Andric Error ModuleSummaryIndexBitcodeReader::parseModuleStringTable() {
6314*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::MODULE_STRTAB_BLOCK_ID))
6315*0b57cec5SDimitry Andric     return Err;
6316*0b57cec5SDimitry Andric 
6317*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
6318*0b57cec5SDimitry Andric 
6319*0b57cec5SDimitry Andric   SmallString<128> ModulePath;
6320*0b57cec5SDimitry Andric   ModuleSummaryIndex::ModuleInfo *LastSeenModule = nullptr;
6321*0b57cec5SDimitry Andric 
6322*0b57cec5SDimitry Andric   while (true) {
6323*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
6324*0b57cec5SDimitry Andric     if (!MaybeEntry)
6325*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
6326*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
6327*0b57cec5SDimitry Andric 
6328*0b57cec5SDimitry Andric     switch (Entry.Kind) {
6329*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
6330*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
6331*0b57cec5SDimitry Andric       return error("Malformed block");
6332*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
6333*0b57cec5SDimitry Andric       return Error::success();
6334*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
6335*0b57cec5SDimitry Andric       // The interesting case.
6336*0b57cec5SDimitry Andric       break;
6337*0b57cec5SDimitry Andric     }
6338*0b57cec5SDimitry Andric 
6339*0b57cec5SDimitry Andric     Record.clear();
6340*0b57cec5SDimitry Andric     Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
6341*0b57cec5SDimitry Andric     if (!MaybeRecord)
6342*0b57cec5SDimitry Andric       return MaybeRecord.takeError();
6343*0b57cec5SDimitry Andric     switch (MaybeRecord.get()) {
6344*0b57cec5SDimitry Andric     default: // Default behavior: ignore.
6345*0b57cec5SDimitry Andric       break;
6346*0b57cec5SDimitry Andric     case bitc::MST_CODE_ENTRY: {
6347*0b57cec5SDimitry Andric       // MST_ENTRY: [modid, namechar x N]
6348*0b57cec5SDimitry Andric       uint64_t ModuleId = Record[0];
6349*0b57cec5SDimitry Andric 
6350*0b57cec5SDimitry Andric       if (convertToString(Record, 1, ModulePath))
6351*0b57cec5SDimitry Andric         return error("Invalid record");
6352*0b57cec5SDimitry Andric 
6353*0b57cec5SDimitry Andric       LastSeenModule = TheIndex.addModule(ModulePath, ModuleId);
6354*0b57cec5SDimitry Andric       ModuleIdMap[ModuleId] = LastSeenModule->first();
6355*0b57cec5SDimitry Andric 
6356*0b57cec5SDimitry Andric       ModulePath.clear();
6357*0b57cec5SDimitry Andric       break;
6358*0b57cec5SDimitry Andric     }
6359*0b57cec5SDimitry Andric     /// MST_CODE_HASH: [5*i32]
6360*0b57cec5SDimitry Andric     case bitc::MST_CODE_HASH: {
6361*0b57cec5SDimitry Andric       if (Record.size() != 5)
6362*0b57cec5SDimitry Andric         return error("Invalid hash length " + Twine(Record.size()).str());
6363*0b57cec5SDimitry Andric       if (!LastSeenModule)
6364*0b57cec5SDimitry Andric         return error("Invalid hash that does not follow a module path");
6365*0b57cec5SDimitry Andric       int Pos = 0;
6366*0b57cec5SDimitry Andric       for (auto &Val : Record) {
6367*0b57cec5SDimitry Andric         assert(!(Val >> 32) && "Unexpected high bits set");
6368*0b57cec5SDimitry Andric         LastSeenModule->second.second[Pos++] = Val;
6369*0b57cec5SDimitry Andric       }
6370*0b57cec5SDimitry Andric       // Reset LastSeenModule to avoid overriding the hash unexpectedly.
6371*0b57cec5SDimitry Andric       LastSeenModule = nullptr;
6372*0b57cec5SDimitry Andric       break;
6373*0b57cec5SDimitry Andric     }
6374*0b57cec5SDimitry Andric     }
6375*0b57cec5SDimitry Andric   }
6376*0b57cec5SDimitry Andric   llvm_unreachable("Exit infinite loop");
6377*0b57cec5SDimitry Andric }
6378*0b57cec5SDimitry Andric 
6379*0b57cec5SDimitry Andric namespace {
6380*0b57cec5SDimitry Andric 
6381*0b57cec5SDimitry Andric // FIXME: This class is only here to support the transition to llvm::Error. It
6382*0b57cec5SDimitry Andric // will be removed once this transition is complete. Clients should prefer to
6383*0b57cec5SDimitry Andric // deal with the Error value directly, rather than converting to error_code.
6384*0b57cec5SDimitry Andric class BitcodeErrorCategoryType : public std::error_category {
6385*0b57cec5SDimitry Andric   const char *name() const noexcept override {
6386*0b57cec5SDimitry Andric     return "llvm.bitcode";
6387*0b57cec5SDimitry Andric   }
6388*0b57cec5SDimitry Andric 
6389*0b57cec5SDimitry Andric   std::string message(int IE) const override {
6390*0b57cec5SDimitry Andric     BitcodeError E = static_cast<BitcodeError>(IE);
6391*0b57cec5SDimitry Andric     switch (E) {
6392*0b57cec5SDimitry Andric     case BitcodeError::CorruptedBitcode:
6393*0b57cec5SDimitry Andric       return "Corrupted bitcode";
6394*0b57cec5SDimitry Andric     }
6395*0b57cec5SDimitry Andric     llvm_unreachable("Unknown error type!");
6396*0b57cec5SDimitry Andric   }
6397*0b57cec5SDimitry Andric };
6398*0b57cec5SDimitry Andric 
6399*0b57cec5SDimitry Andric } // end anonymous namespace
6400*0b57cec5SDimitry Andric 
6401*0b57cec5SDimitry Andric static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
6402*0b57cec5SDimitry Andric 
6403*0b57cec5SDimitry Andric const std::error_category &llvm::BitcodeErrorCategory() {
6404*0b57cec5SDimitry Andric   return *ErrorCategory;
6405*0b57cec5SDimitry Andric }
6406*0b57cec5SDimitry Andric 
6407*0b57cec5SDimitry Andric static Expected<StringRef> readBlobInRecord(BitstreamCursor &Stream,
6408*0b57cec5SDimitry Andric                                             unsigned Block, unsigned RecordID) {
6409*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(Block))
6410*0b57cec5SDimitry Andric     return std::move(Err);
6411*0b57cec5SDimitry Andric 
6412*0b57cec5SDimitry Andric   StringRef Strtab;
6413*0b57cec5SDimitry Andric   while (true) {
6414*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
6415*0b57cec5SDimitry Andric     if (!MaybeEntry)
6416*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
6417*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
6418*0b57cec5SDimitry Andric 
6419*0b57cec5SDimitry Andric     switch (Entry.Kind) {
6420*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
6421*0b57cec5SDimitry Andric       return Strtab;
6422*0b57cec5SDimitry Andric 
6423*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
6424*0b57cec5SDimitry Andric       return error("Malformed block");
6425*0b57cec5SDimitry Andric 
6426*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
6427*0b57cec5SDimitry Andric       if (Error Err = Stream.SkipBlock())
6428*0b57cec5SDimitry Andric         return std::move(Err);
6429*0b57cec5SDimitry Andric       break;
6430*0b57cec5SDimitry Andric 
6431*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
6432*0b57cec5SDimitry Andric       StringRef Blob;
6433*0b57cec5SDimitry Andric       SmallVector<uint64_t, 1> Record;
6434*0b57cec5SDimitry Andric       Expected<unsigned> MaybeRecord =
6435*0b57cec5SDimitry Andric           Stream.readRecord(Entry.ID, Record, &Blob);
6436*0b57cec5SDimitry Andric       if (!MaybeRecord)
6437*0b57cec5SDimitry Andric         return MaybeRecord.takeError();
6438*0b57cec5SDimitry Andric       if (MaybeRecord.get() == RecordID)
6439*0b57cec5SDimitry Andric         Strtab = Blob;
6440*0b57cec5SDimitry Andric       break;
6441*0b57cec5SDimitry Andric     }
6442*0b57cec5SDimitry Andric   }
6443*0b57cec5SDimitry Andric }
6444*0b57cec5SDimitry Andric 
6445*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
6446*0b57cec5SDimitry Andric // External interface
6447*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
6448*0b57cec5SDimitry Andric 
6449*0b57cec5SDimitry Andric Expected<std::vector<BitcodeModule>>
6450*0b57cec5SDimitry Andric llvm::getBitcodeModuleList(MemoryBufferRef Buffer) {
6451*0b57cec5SDimitry Andric   auto FOrErr = getBitcodeFileContents(Buffer);
6452*0b57cec5SDimitry Andric   if (!FOrErr)
6453*0b57cec5SDimitry Andric     return FOrErr.takeError();
6454*0b57cec5SDimitry Andric   return std::move(FOrErr->Mods);
6455*0b57cec5SDimitry Andric }
6456*0b57cec5SDimitry Andric 
6457*0b57cec5SDimitry Andric Expected<BitcodeFileContents>
6458*0b57cec5SDimitry Andric llvm::getBitcodeFileContents(MemoryBufferRef Buffer) {
6459*0b57cec5SDimitry Andric   Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
6460*0b57cec5SDimitry Andric   if (!StreamOrErr)
6461*0b57cec5SDimitry Andric     return StreamOrErr.takeError();
6462*0b57cec5SDimitry Andric   BitstreamCursor &Stream = *StreamOrErr;
6463*0b57cec5SDimitry Andric 
6464*0b57cec5SDimitry Andric   BitcodeFileContents F;
6465*0b57cec5SDimitry Andric   while (true) {
6466*0b57cec5SDimitry Andric     uint64_t BCBegin = Stream.getCurrentByteNo();
6467*0b57cec5SDimitry Andric 
6468*0b57cec5SDimitry Andric     // We may be consuming bitcode from a client that leaves garbage at the end
6469*0b57cec5SDimitry Andric     // of the bitcode stream (e.g. Apple's ar tool). If we are close enough to
6470*0b57cec5SDimitry Andric     // the end that there cannot possibly be another module, stop looking.
6471*0b57cec5SDimitry Andric     if (BCBegin + 8 >= Stream.getBitcodeBytes().size())
6472*0b57cec5SDimitry Andric       return F;
6473*0b57cec5SDimitry Andric 
6474*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
6475*0b57cec5SDimitry Andric     if (!MaybeEntry)
6476*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
6477*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
6478*0b57cec5SDimitry Andric 
6479*0b57cec5SDimitry Andric     switch (Entry.Kind) {
6480*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
6481*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
6482*0b57cec5SDimitry Andric       return error("Malformed block");
6483*0b57cec5SDimitry Andric 
6484*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: {
6485*0b57cec5SDimitry Andric       uint64_t IdentificationBit = -1ull;
6486*0b57cec5SDimitry Andric       if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {
6487*0b57cec5SDimitry Andric         IdentificationBit = Stream.GetCurrentBitNo() - BCBegin * 8;
6488*0b57cec5SDimitry Andric         if (Error Err = Stream.SkipBlock())
6489*0b57cec5SDimitry Andric           return std::move(Err);
6490*0b57cec5SDimitry Andric 
6491*0b57cec5SDimitry Andric         {
6492*0b57cec5SDimitry Andric           Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
6493*0b57cec5SDimitry Andric           if (!MaybeEntry)
6494*0b57cec5SDimitry Andric             return MaybeEntry.takeError();
6495*0b57cec5SDimitry Andric           Entry = MaybeEntry.get();
6496*0b57cec5SDimitry Andric         }
6497*0b57cec5SDimitry Andric 
6498*0b57cec5SDimitry Andric         if (Entry.Kind != BitstreamEntry::SubBlock ||
6499*0b57cec5SDimitry Andric             Entry.ID != bitc::MODULE_BLOCK_ID)
6500*0b57cec5SDimitry Andric           return error("Malformed block");
6501*0b57cec5SDimitry Andric       }
6502*0b57cec5SDimitry Andric 
6503*0b57cec5SDimitry Andric       if (Entry.ID == bitc::MODULE_BLOCK_ID) {
6504*0b57cec5SDimitry Andric         uint64_t ModuleBit = Stream.GetCurrentBitNo() - BCBegin * 8;
6505*0b57cec5SDimitry Andric         if (Error Err = Stream.SkipBlock())
6506*0b57cec5SDimitry Andric           return std::move(Err);
6507*0b57cec5SDimitry Andric 
6508*0b57cec5SDimitry Andric         F.Mods.push_back({Stream.getBitcodeBytes().slice(
6509*0b57cec5SDimitry Andric                               BCBegin, Stream.getCurrentByteNo() - BCBegin),
6510*0b57cec5SDimitry Andric                           Buffer.getBufferIdentifier(), IdentificationBit,
6511*0b57cec5SDimitry Andric                           ModuleBit});
6512*0b57cec5SDimitry Andric         continue;
6513*0b57cec5SDimitry Andric       }
6514*0b57cec5SDimitry Andric 
6515*0b57cec5SDimitry Andric       if (Entry.ID == bitc::STRTAB_BLOCK_ID) {
6516*0b57cec5SDimitry Andric         Expected<StringRef> Strtab =
6517*0b57cec5SDimitry Andric             readBlobInRecord(Stream, bitc::STRTAB_BLOCK_ID, bitc::STRTAB_BLOB);
6518*0b57cec5SDimitry Andric         if (!Strtab)
6519*0b57cec5SDimitry Andric           return Strtab.takeError();
6520*0b57cec5SDimitry Andric         // This string table is used by every preceding bitcode module that does
6521*0b57cec5SDimitry Andric         // not have its own string table. A bitcode file may have multiple
6522*0b57cec5SDimitry Andric         // string tables if it was created by binary concatenation, for example
6523*0b57cec5SDimitry Andric         // with "llvm-cat -b".
6524*0b57cec5SDimitry Andric         for (auto I = F.Mods.rbegin(), E = F.Mods.rend(); I != E; ++I) {
6525*0b57cec5SDimitry Andric           if (!I->Strtab.empty())
6526*0b57cec5SDimitry Andric             break;
6527*0b57cec5SDimitry Andric           I->Strtab = *Strtab;
6528*0b57cec5SDimitry Andric         }
6529*0b57cec5SDimitry Andric         // Similarly, the string table is used by every preceding symbol table;
6530*0b57cec5SDimitry Andric         // normally there will be just one unless the bitcode file was created
6531*0b57cec5SDimitry Andric         // by binary concatenation.
6532*0b57cec5SDimitry Andric         if (!F.Symtab.empty() && F.StrtabForSymtab.empty())
6533*0b57cec5SDimitry Andric           F.StrtabForSymtab = *Strtab;
6534*0b57cec5SDimitry Andric         continue;
6535*0b57cec5SDimitry Andric       }
6536*0b57cec5SDimitry Andric 
6537*0b57cec5SDimitry Andric       if (Entry.ID == bitc::SYMTAB_BLOCK_ID) {
6538*0b57cec5SDimitry Andric         Expected<StringRef> SymtabOrErr =
6539*0b57cec5SDimitry Andric             readBlobInRecord(Stream, bitc::SYMTAB_BLOCK_ID, bitc::SYMTAB_BLOB);
6540*0b57cec5SDimitry Andric         if (!SymtabOrErr)
6541*0b57cec5SDimitry Andric           return SymtabOrErr.takeError();
6542*0b57cec5SDimitry Andric 
6543*0b57cec5SDimitry Andric         // We can expect the bitcode file to have multiple symbol tables if it
6544*0b57cec5SDimitry Andric         // was created by binary concatenation. In that case we silently
6545*0b57cec5SDimitry Andric         // ignore any subsequent symbol tables, which is fine because this is a
6546*0b57cec5SDimitry Andric         // low level function. The client is expected to notice that the number
6547*0b57cec5SDimitry Andric         // of modules in the symbol table does not match the number of modules
6548*0b57cec5SDimitry Andric         // in the input file and regenerate the symbol table.
6549*0b57cec5SDimitry Andric         if (F.Symtab.empty())
6550*0b57cec5SDimitry Andric           F.Symtab = *SymtabOrErr;
6551*0b57cec5SDimitry Andric         continue;
6552*0b57cec5SDimitry Andric       }
6553*0b57cec5SDimitry Andric 
6554*0b57cec5SDimitry Andric       if (Error Err = Stream.SkipBlock())
6555*0b57cec5SDimitry Andric         return std::move(Err);
6556*0b57cec5SDimitry Andric       continue;
6557*0b57cec5SDimitry Andric     }
6558*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
6559*0b57cec5SDimitry Andric       if (Expected<unsigned> StreamFailed = Stream.skipRecord(Entry.ID))
6560*0b57cec5SDimitry Andric         continue;
6561*0b57cec5SDimitry Andric       else
6562*0b57cec5SDimitry Andric         return StreamFailed.takeError();
6563*0b57cec5SDimitry Andric     }
6564*0b57cec5SDimitry Andric   }
6565*0b57cec5SDimitry Andric }
6566*0b57cec5SDimitry Andric 
6567*0b57cec5SDimitry Andric /// Get a lazy one-at-time loading module from bitcode.
6568*0b57cec5SDimitry Andric ///
6569*0b57cec5SDimitry Andric /// This isn't always used in a lazy context.  In particular, it's also used by
6570*0b57cec5SDimitry Andric /// \a parseModule().  If this is truly lazy, then we need to eagerly pull
6571*0b57cec5SDimitry Andric /// in forward-referenced functions from block address references.
6572*0b57cec5SDimitry Andric ///
6573*0b57cec5SDimitry Andric /// \param[in] MaterializeAll Set to \c true if we should materialize
6574*0b57cec5SDimitry Andric /// everything.
6575*0b57cec5SDimitry Andric Expected<std::unique_ptr<Module>>
6576*0b57cec5SDimitry Andric BitcodeModule::getModuleImpl(LLVMContext &Context, bool MaterializeAll,
65775ffd83dbSDimitry Andric                              bool ShouldLazyLoadMetadata, bool IsImporting,
65785ffd83dbSDimitry Andric                              DataLayoutCallbackTy DataLayoutCallback) {
6579*0b57cec5SDimitry Andric   BitstreamCursor Stream(Buffer);
6580*0b57cec5SDimitry Andric 
6581*0b57cec5SDimitry Andric   std::string ProducerIdentification;
6582*0b57cec5SDimitry Andric   if (IdentificationBit != -1ull) {
6583*0b57cec5SDimitry Andric     if (Error JumpFailed = Stream.JumpToBit(IdentificationBit))
6584*0b57cec5SDimitry Andric       return std::move(JumpFailed);
6585*0b57cec5SDimitry Andric     Expected<std::string> ProducerIdentificationOrErr =
6586*0b57cec5SDimitry Andric         readIdentificationBlock(Stream);
6587*0b57cec5SDimitry Andric     if (!ProducerIdentificationOrErr)
6588*0b57cec5SDimitry Andric       return ProducerIdentificationOrErr.takeError();
6589*0b57cec5SDimitry Andric 
6590*0b57cec5SDimitry Andric     ProducerIdentification = *ProducerIdentificationOrErr;
6591*0b57cec5SDimitry Andric   }
6592*0b57cec5SDimitry Andric 
6593*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
6594*0b57cec5SDimitry Andric     return std::move(JumpFailed);
6595*0b57cec5SDimitry Andric   auto *R = new BitcodeReader(std::move(Stream), Strtab, ProducerIdentification,
6596*0b57cec5SDimitry Andric                               Context);
6597*0b57cec5SDimitry Andric 
6598*0b57cec5SDimitry Andric   std::unique_ptr<Module> M =
65998bcb0991SDimitry Andric       std::make_unique<Module>(ModuleIdentifier, Context);
6600*0b57cec5SDimitry Andric   M->setMaterializer(R);
6601*0b57cec5SDimitry Andric 
6602*0b57cec5SDimitry Andric   // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
66035ffd83dbSDimitry Andric   if (Error Err = R->parseBitcodeInto(M.get(), ShouldLazyLoadMetadata,
66045ffd83dbSDimitry Andric                                       IsImporting, DataLayoutCallback))
6605*0b57cec5SDimitry Andric     return std::move(Err);
6606*0b57cec5SDimitry Andric 
6607*0b57cec5SDimitry Andric   if (MaterializeAll) {
6608*0b57cec5SDimitry Andric     // Read in the entire module, and destroy the BitcodeReader.
6609*0b57cec5SDimitry Andric     if (Error Err = M->materializeAll())
6610*0b57cec5SDimitry Andric       return std::move(Err);
6611*0b57cec5SDimitry Andric   } else {
6612*0b57cec5SDimitry Andric     // Resolve forward references from blockaddresses.
6613*0b57cec5SDimitry Andric     if (Error Err = R->materializeForwardReferencedFunctions())
6614*0b57cec5SDimitry Andric       return std::move(Err);
6615*0b57cec5SDimitry Andric   }
6616*0b57cec5SDimitry Andric   return std::move(M);
6617*0b57cec5SDimitry Andric }
6618*0b57cec5SDimitry Andric 
6619*0b57cec5SDimitry Andric Expected<std::unique_ptr<Module>>
6620*0b57cec5SDimitry Andric BitcodeModule::getLazyModule(LLVMContext &Context, bool ShouldLazyLoadMetadata,
6621*0b57cec5SDimitry Andric                              bool IsImporting) {
66225ffd83dbSDimitry Andric   return getModuleImpl(Context, false, ShouldLazyLoadMetadata, IsImporting,
66235ffd83dbSDimitry Andric                        [](StringRef) { return None; });
6624*0b57cec5SDimitry Andric }
6625*0b57cec5SDimitry Andric 
6626*0b57cec5SDimitry Andric // Parse the specified bitcode buffer and merge the index into CombinedIndex.
6627*0b57cec5SDimitry Andric // We don't use ModuleIdentifier here because the client may need to control the
6628*0b57cec5SDimitry Andric // module path used in the combined summary (e.g. when reading summaries for
6629*0b57cec5SDimitry Andric // regular LTO modules).
6630*0b57cec5SDimitry Andric Error BitcodeModule::readSummary(ModuleSummaryIndex &CombinedIndex,
6631*0b57cec5SDimitry Andric                                  StringRef ModulePath, uint64_t ModuleId) {
6632*0b57cec5SDimitry Andric   BitstreamCursor Stream(Buffer);
6633*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
6634*0b57cec5SDimitry Andric     return JumpFailed;
6635*0b57cec5SDimitry Andric 
6636*0b57cec5SDimitry Andric   ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, CombinedIndex,
6637*0b57cec5SDimitry Andric                                     ModulePath, ModuleId);
6638*0b57cec5SDimitry Andric   return R.parseModule();
6639*0b57cec5SDimitry Andric }
6640*0b57cec5SDimitry Andric 
6641*0b57cec5SDimitry Andric // Parse the specified bitcode buffer, returning the function info index.
6642*0b57cec5SDimitry Andric Expected<std::unique_ptr<ModuleSummaryIndex>> BitcodeModule::getSummary() {
6643*0b57cec5SDimitry Andric   BitstreamCursor Stream(Buffer);
6644*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
6645*0b57cec5SDimitry Andric     return std::move(JumpFailed);
6646*0b57cec5SDimitry Andric 
66478bcb0991SDimitry Andric   auto Index = std::make_unique<ModuleSummaryIndex>(/*HaveGVs=*/false);
6648*0b57cec5SDimitry Andric   ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, *Index,
6649*0b57cec5SDimitry Andric                                     ModuleIdentifier, 0);
6650*0b57cec5SDimitry Andric 
6651*0b57cec5SDimitry Andric   if (Error Err = R.parseModule())
6652*0b57cec5SDimitry Andric     return std::move(Err);
6653*0b57cec5SDimitry Andric 
6654*0b57cec5SDimitry Andric   return std::move(Index);
6655*0b57cec5SDimitry Andric }
6656*0b57cec5SDimitry Andric 
6657*0b57cec5SDimitry Andric static Expected<bool> getEnableSplitLTOUnitFlag(BitstreamCursor &Stream,
6658*0b57cec5SDimitry Andric                                                 unsigned ID) {
6659*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(ID))
6660*0b57cec5SDimitry Andric     return std::move(Err);
6661*0b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
6662*0b57cec5SDimitry Andric 
6663*0b57cec5SDimitry Andric   while (true) {
6664*0b57cec5SDimitry Andric     Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
6665*0b57cec5SDimitry Andric     if (!MaybeEntry)
6666*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
6667*0b57cec5SDimitry Andric     BitstreamEntry Entry = MaybeEntry.get();
6668*0b57cec5SDimitry Andric 
6669*0b57cec5SDimitry Andric     switch (Entry.Kind) {
6670*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
6671*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
6672*0b57cec5SDimitry Andric       return error("Malformed block");
6673*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
6674*0b57cec5SDimitry Andric       // If no flags record found, conservatively return true to mimic
6675*0b57cec5SDimitry Andric       // behavior before this flag was added.
6676*0b57cec5SDimitry Andric       return true;
6677*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
6678*0b57cec5SDimitry Andric       // The interesting case.
6679*0b57cec5SDimitry Andric       break;
6680*0b57cec5SDimitry Andric     }
6681*0b57cec5SDimitry Andric 
6682*0b57cec5SDimitry Andric     // Look for the FS_FLAGS record.
6683*0b57cec5SDimitry Andric     Record.clear();
6684*0b57cec5SDimitry Andric     Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
6685*0b57cec5SDimitry Andric     if (!MaybeBitCode)
6686*0b57cec5SDimitry Andric       return MaybeBitCode.takeError();
6687*0b57cec5SDimitry Andric     switch (MaybeBitCode.get()) {
6688*0b57cec5SDimitry Andric     default: // Default behavior: ignore.
6689*0b57cec5SDimitry Andric       break;
6690*0b57cec5SDimitry Andric     case bitc::FS_FLAGS: { // [flags]
6691*0b57cec5SDimitry Andric       uint64_t Flags = Record[0];
6692*0b57cec5SDimitry Andric       // Scan flags.
6693480093f4SDimitry Andric       assert(Flags <= 0x3f && "Unexpected bits in flag");
6694*0b57cec5SDimitry Andric 
6695*0b57cec5SDimitry Andric       return Flags & 0x8;
6696*0b57cec5SDimitry Andric     }
6697*0b57cec5SDimitry Andric     }
6698*0b57cec5SDimitry Andric   }
6699*0b57cec5SDimitry Andric   llvm_unreachable("Exit infinite loop");
6700*0b57cec5SDimitry Andric }
6701*0b57cec5SDimitry Andric 
6702*0b57cec5SDimitry Andric // Check if the given bitcode buffer contains a global value summary block.
6703*0b57cec5SDimitry Andric Expected<BitcodeLTOInfo> BitcodeModule::getLTOInfo() {
6704*0b57cec5SDimitry Andric   BitstreamCursor Stream(Buffer);
6705*0b57cec5SDimitry Andric   if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
6706*0b57cec5SDimitry Andric     return std::move(JumpFailed);
6707*0b57cec5SDimitry Andric 
6708*0b57cec5SDimitry Andric   if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
6709*0b57cec5SDimitry Andric     return std::move(Err);
6710*0b57cec5SDimitry Andric 
6711*0b57cec5SDimitry Andric   while (true) {
6712*0b57cec5SDimitry Andric     Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
6713*0b57cec5SDimitry Andric     if (!MaybeEntry)
6714*0b57cec5SDimitry Andric       return MaybeEntry.takeError();
6715*0b57cec5SDimitry Andric     llvm::BitstreamEntry Entry = MaybeEntry.get();
6716*0b57cec5SDimitry Andric 
6717*0b57cec5SDimitry Andric     switch (Entry.Kind) {
6718*0b57cec5SDimitry Andric     case BitstreamEntry::Error:
6719*0b57cec5SDimitry Andric       return error("Malformed block");
6720*0b57cec5SDimitry Andric     case BitstreamEntry::EndBlock:
6721*0b57cec5SDimitry Andric       return BitcodeLTOInfo{/*IsThinLTO=*/false, /*HasSummary=*/false,
6722*0b57cec5SDimitry Andric                             /*EnableSplitLTOUnit=*/false};
6723*0b57cec5SDimitry Andric 
6724*0b57cec5SDimitry Andric     case BitstreamEntry::SubBlock:
6725*0b57cec5SDimitry Andric       if (Entry.ID == bitc::GLOBALVAL_SUMMARY_BLOCK_ID) {
6726*0b57cec5SDimitry Andric         Expected<bool> EnableSplitLTOUnit =
6727*0b57cec5SDimitry Andric             getEnableSplitLTOUnitFlag(Stream, Entry.ID);
6728*0b57cec5SDimitry Andric         if (!EnableSplitLTOUnit)
6729*0b57cec5SDimitry Andric           return EnableSplitLTOUnit.takeError();
6730*0b57cec5SDimitry Andric         return BitcodeLTOInfo{/*IsThinLTO=*/true, /*HasSummary=*/true,
6731*0b57cec5SDimitry Andric                               *EnableSplitLTOUnit};
6732*0b57cec5SDimitry Andric       }
6733*0b57cec5SDimitry Andric 
6734*0b57cec5SDimitry Andric       if (Entry.ID == bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID) {
6735*0b57cec5SDimitry Andric         Expected<bool> EnableSplitLTOUnit =
6736*0b57cec5SDimitry Andric             getEnableSplitLTOUnitFlag(Stream, Entry.ID);
6737*0b57cec5SDimitry Andric         if (!EnableSplitLTOUnit)
6738*0b57cec5SDimitry Andric           return EnableSplitLTOUnit.takeError();
6739*0b57cec5SDimitry Andric         return BitcodeLTOInfo{/*IsThinLTO=*/false, /*HasSummary=*/true,
6740*0b57cec5SDimitry Andric                               *EnableSplitLTOUnit};
6741*0b57cec5SDimitry Andric       }
6742*0b57cec5SDimitry Andric 
6743*0b57cec5SDimitry Andric       // Ignore other sub-blocks.
6744*0b57cec5SDimitry Andric       if (Error Err = Stream.SkipBlock())
6745*0b57cec5SDimitry Andric         return std::move(Err);
6746*0b57cec5SDimitry Andric       continue;
6747*0b57cec5SDimitry Andric 
6748*0b57cec5SDimitry Andric     case BitstreamEntry::Record:
6749*0b57cec5SDimitry Andric       if (Expected<unsigned> StreamFailed = Stream.skipRecord(Entry.ID))
6750*0b57cec5SDimitry Andric         continue;
6751*0b57cec5SDimitry Andric       else
6752*0b57cec5SDimitry Andric         return StreamFailed.takeError();
6753*0b57cec5SDimitry Andric     }
6754*0b57cec5SDimitry Andric   }
6755*0b57cec5SDimitry Andric }
6756*0b57cec5SDimitry Andric 
6757*0b57cec5SDimitry Andric static Expected<BitcodeModule> getSingleModule(MemoryBufferRef Buffer) {
6758*0b57cec5SDimitry Andric   Expected<std::vector<BitcodeModule>> MsOrErr = getBitcodeModuleList(Buffer);
6759*0b57cec5SDimitry Andric   if (!MsOrErr)
6760*0b57cec5SDimitry Andric     return MsOrErr.takeError();
6761*0b57cec5SDimitry Andric 
6762*0b57cec5SDimitry Andric   if (MsOrErr->size() != 1)
6763*0b57cec5SDimitry Andric     return error("Expected a single module");
6764*0b57cec5SDimitry Andric 
6765*0b57cec5SDimitry Andric   return (*MsOrErr)[0];
6766*0b57cec5SDimitry Andric }
6767*0b57cec5SDimitry Andric 
6768*0b57cec5SDimitry Andric Expected<std::unique_ptr<Module>>
6769*0b57cec5SDimitry Andric llvm::getLazyBitcodeModule(MemoryBufferRef Buffer, LLVMContext &Context,
6770*0b57cec5SDimitry Andric                            bool ShouldLazyLoadMetadata, bool IsImporting) {
6771*0b57cec5SDimitry Andric   Expected<BitcodeModule> BM = getSingleModule(Buffer);
6772*0b57cec5SDimitry Andric   if (!BM)
6773*0b57cec5SDimitry Andric     return BM.takeError();
6774*0b57cec5SDimitry Andric 
6775*0b57cec5SDimitry Andric   return BM->getLazyModule(Context, ShouldLazyLoadMetadata, IsImporting);
6776*0b57cec5SDimitry Andric }
6777*0b57cec5SDimitry Andric 
6778*0b57cec5SDimitry Andric Expected<std::unique_ptr<Module>> llvm::getOwningLazyBitcodeModule(
6779*0b57cec5SDimitry Andric     std::unique_ptr<MemoryBuffer> &&Buffer, LLVMContext &Context,
6780*0b57cec5SDimitry Andric     bool ShouldLazyLoadMetadata, bool IsImporting) {
6781*0b57cec5SDimitry Andric   auto MOrErr = getLazyBitcodeModule(*Buffer, Context, ShouldLazyLoadMetadata,
6782*0b57cec5SDimitry Andric                                      IsImporting);
6783*0b57cec5SDimitry Andric   if (MOrErr)
6784*0b57cec5SDimitry Andric     (*MOrErr)->setOwnedMemoryBuffer(std::move(Buffer));
6785*0b57cec5SDimitry Andric   return MOrErr;
6786*0b57cec5SDimitry Andric }
6787*0b57cec5SDimitry Andric 
6788*0b57cec5SDimitry Andric Expected<std::unique_ptr<Module>>
67895ffd83dbSDimitry Andric BitcodeModule::parseModule(LLVMContext &Context,
67905ffd83dbSDimitry Andric                            DataLayoutCallbackTy DataLayoutCallback) {
67915ffd83dbSDimitry Andric   return getModuleImpl(Context, true, false, false, DataLayoutCallback);
6792*0b57cec5SDimitry Andric   // TODO: Restore the use-lists to the in-memory state when the bitcode was
6793*0b57cec5SDimitry Andric   // written.  We must defer until the Module has been fully materialized.
6794*0b57cec5SDimitry Andric }
6795*0b57cec5SDimitry Andric 
67965ffd83dbSDimitry Andric Expected<std::unique_ptr<Module>>
67975ffd83dbSDimitry Andric llvm::parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context,
67985ffd83dbSDimitry Andric                        DataLayoutCallbackTy DataLayoutCallback) {
6799*0b57cec5SDimitry Andric   Expected<BitcodeModule> BM = getSingleModule(Buffer);
6800*0b57cec5SDimitry Andric   if (!BM)
6801*0b57cec5SDimitry Andric     return BM.takeError();
6802*0b57cec5SDimitry Andric 
68035ffd83dbSDimitry Andric   return BM->parseModule(Context, DataLayoutCallback);
6804*0b57cec5SDimitry Andric }
6805*0b57cec5SDimitry Andric 
6806*0b57cec5SDimitry Andric Expected<std::string> llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer) {
6807*0b57cec5SDimitry Andric   Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
6808*0b57cec5SDimitry Andric   if (!StreamOrErr)
6809*0b57cec5SDimitry Andric     return StreamOrErr.takeError();
6810*0b57cec5SDimitry Andric 
6811*0b57cec5SDimitry Andric   return readTriple(*StreamOrErr);
6812*0b57cec5SDimitry Andric }
6813*0b57cec5SDimitry Andric 
6814*0b57cec5SDimitry Andric Expected<bool> llvm::isBitcodeContainingObjCCategory(MemoryBufferRef Buffer) {
6815*0b57cec5SDimitry Andric   Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
6816*0b57cec5SDimitry Andric   if (!StreamOrErr)
6817*0b57cec5SDimitry Andric     return StreamOrErr.takeError();
6818*0b57cec5SDimitry Andric 
6819*0b57cec5SDimitry Andric   return hasObjCCategory(*StreamOrErr);
6820*0b57cec5SDimitry Andric }
6821*0b57cec5SDimitry Andric 
6822*0b57cec5SDimitry Andric Expected<std::string> llvm::getBitcodeProducerString(MemoryBufferRef Buffer) {
6823*0b57cec5SDimitry Andric   Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
6824*0b57cec5SDimitry Andric   if (!StreamOrErr)
6825*0b57cec5SDimitry Andric     return StreamOrErr.takeError();
6826*0b57cec5SDimitry Andric 
6827*0b57cec5SDimitry Andric   return readIdentificationCode(*StreamOrErr);
6828*0b57cec5SDimitry Andric }
6829*0b57cec5SDimitry Andric 
6830*0b57cec5SDimitry Andric Error llvm::readModuleSummaryIndex(MemoryBufferRef Buffer,
6831*0b57cec5SDimitry Andric                                    ModuleSummaryIndex &CombinedIndex,
6832*0b57cec5SDimitry Andric                                    uint64_t ModuleId) {
6833*0b57cec5SDimitry Andric   Expected<BitcodeModule> BM = getSingleModule(Buffer);
6834*0b57cec5SDimitry Andric   if (!BM)
6835*0b57cec5SDimitry Andric     return BM.takeError();
6836*0b57cec5SDimitry Andric 
6837*0b57cec5SDimitry Andric   return BM->readSummary(CombinedIndex, BM->getModuleIdentifier(), ModuleId);
6838*0b57cec5SDimitry Andric }
6839*0b57cec5SDimitry Andric 
6840*0b57cec5SDimitry Andric Expected<std::unique_ptr<ModuleSummaryIndex>>
6841*0b57cec5SDimitry Andric llvm::getModuleSummaryIndex(MemoryBufferRef Buffer) {
6842*0b57cec5SDimitry Andric   Expected<BitcodeModule> BM = getSingleModule(Buffer);
6843*0b57cec5SDimitry Andric   if (!BM)
6844*0b57cec5SDimitry Andric     return BM.takeError();
6845*0b57cec5SDimitry Andric 
6846*0b57cec5SDimitry Andric   return BM->getSummary();
6847*0b57cec5SDimitry Andric }
6848*0b57cec5SDimitry Andric 
6849*0b57cec5SDimitry Andric Expected<BitcodeLTOInfo> llvm::getBitcodeLTOInfo(MemoryBufferRef Buffer) {
6850*0b57cec5SDimitry Andric   Expected<BitcodeModule> BM = getSingleModule(Buffer);
6851*0b57cec5SDimitry Andric   if (!BM)
6852*0b57cec5SDimitry Andric     return BM.takeError();
6853*0b57cec5SDimitry Andric 
6854*0b57cec5SDimitry Andric   return BM->getLTOInfo();
6855*0b57cec5SDimitry Andric }
6856*0b57cec5SDimitry Andric 
6857*0b57cec5SDimitry Andric Expected<std::unique_ptr<ModuleSummaryIndex>>
6858*0b57cec5SDimitry Andric llvm::getModuleSummaryIndexForFile(StringRef Path,
6859*0b57cec5SDimitry Andric                                    bool IgnoreEmptyThinLTOIndexFile) {
6860*0b57cec5SDimitry Andric   ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
6861*0b57cec5SDimitry Andric       MemoryBuffer::getFileOrSTDIN(Path);
6862*0b57cec5SDimitry Andric   if (!FileOrErr)
6863*0b57cec5SDimitry Andric     return errorCodeToError(FileOrErr.getError());
6864*0b57cec5SDimitry Andric   if (IgnoreEmptyThinLTOIndexFile && !(*FileOrErr)->getBufferSize())
6865*0b57cec5SDimitry Andric     return nullptr;
6866*0b57cec5SDimitry Andric   return getModuleSummaryIndex(**FileOrErr);
6867*0b57cec5SDimitry Andric }
6868