blob: c2dc67b87859ceba4fefbb6679141f4c67d6c281 [file] [log] [blame]
Chris Lattner1314b992007-04-22 06:23:29 +00001//===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner1314b992007-04-22 06:23:29 +00007//
8//===----------------------------------------------------------------------===//
Chris Lattner1314b992007-04-22 06:23:29 +00009
Teresa Johnsonad176792016-11-11 05:34:58 +000010#include "llvm/Bitcode/BitcodeReader.h"
Mehdi Aminief27db82016-12-12 19:34:26 +000011#include "MetadataLoader.h"
12#include "ValueList.h"
13
Eugene Zelenko1804a772016-08-25 00:45:04 +000014#include "llvm/ADT/APFloat.h"
15#include "llvm/ADT/APInt.h"
16#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/DenseMap.h"
18#include "llvm/ADT/None.h"
Benjamin Kramer0a446fd2015-03-01 21:28:53 +000019#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/SmallString.h"
21#include "llvm/ADT/SmallVector.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000022#include "llvm/ADT/StringRef.h"
David Majnemer3087b222015-01-20 05:58:07 +000023#include "llvm/ADT/Triple.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000024#include "llvm/ADT/Twine.h"
Benjamin Kramercced8be2015-03-17 20:40:24 +000025#include "llvm/Bitcode/BitstreamReader.h"
Tobias Grosser0a8e12f2013-07-26 04:16:55 +000026#include "llvm/Bitcode/LLVMBitCodes.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000027#include "llvm/IR/Argument.h"
28#include "llvm/IR/Attributes.h"
Chandler Carruth91065212014-03-05 10:34:14 +000029#include "llvm/IR/AutoUpgrade.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000030#include "llvm/IR/BasicBlock.h"
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +000031#include "llvm/IR/CallSite.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000032#include "llvm/IR/CallingConv.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000033#include "llvm/IR/Comdat.h"
34#include "llvm/IR/Constant.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000035#include "llvm/IR/Constants.h"
Rafael Espindola0d68b4c2015-03-30 21:36:43 +000036#include "llvm/IR/DebugInfo.h"
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000037#include "llvm/IR/DebugInfoMetadata.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000038#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000039#include "llvm/IR/DerivedTypes.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000040#include "llvm/IR/DiagnosticInfo.h"
Rafael Espindolad0b23be2015-01-10 00:07:30 +000041#include "llvm/IR/DiagnosticPrinter.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000042#include "llvm/IR/Function.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000043#include "llvm/IR/GVMaterializer.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000044#include "llvm/IR/GlobalAlias.h"
45#include "llvm/IR/GlobalIFunc.h"
46#include "llvm/IR/GlobalIndirectSymbol.h"
47#include "llvm/IR/GlobalObject.h"
48#include "llvm/IR/GlobalValue.h"
49#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000050#include "llvm/IR/InlineAsm.h"
Mehdi Amini86623052016-12-16 19:16:29 +000051#include "llvm/IR/InstIterator.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000052#include "llvm/IR/InstrTypes.h"
53#include "llvm/IR/Instruction.h"
54#include "llvm/IR/Instructions.h"
55#include "llvm/IR/Intrinsics.h"
Manman Ren209b17c2013-09-28 00:22:27 +000056#include "llvm/IR/LLVMContext.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000057#include "llvm/IR/Module.h"
Teresa Johnson26ab5772016-03-15 00:04:37 +000058#include "llvm/IR/ModuleSummaryIndex.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000059#include "llvm/IR/OperandTraits.h"
60#include "llvm/IR/Operator.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000061#include "llvm/IR/TrackingMDRef.h"
62#include "llvm/IR/Type.h"
Benjamin Kramercced8be2015-03-17 20:40:24 +000063#include "llvm/IR/ValueHandle.h"
Mehdi Amini86623052016-12-16 19:16:29 +000064#include "llvm/IR/Verifier.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000065#include "llvm/Support/AtomicOrdering.h"
66#include "llvm/Support/Casting.h"
Teresa Johnson916495d2016-04-04 18:52:58 +000067#include "llvm/Support/CommandLine.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000068#include "llvm/Support/Compiler.h"
Teresa Johnson916495d2016-04-04 18:52:58 +000069#include "llvm/Support/Debug.h"
Peter Collingbourne58f7f072016-11-09 00:51:04 +000070#include "llvm/Support/Error.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000071#include "llvm/Support/ErrorHandling.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000072#include "llvm/Support/ManagedStatic.h"
Chris Lattner6694f602007-04-29 07:54:31 +000073#include "llvm/Support/MemoryBuffer.h"
Tobias Grosser0a8e12f2013-07-26 04:16:55 +000074#include "llvm/Support/raw_ostream.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000075#include <algorithm>
76#include <cassert>
77#include <cstddef>
78#include <cstdint>
Benjamin Kramercced8be2015-03-17 20:40:24 +000079#include <deque>
Eugene Zelenko1804a772016-08-25 00:45:04 +000080#include <limits>
81#include <map>
82#include <memory>
83#include <string>
84#include <system_error>
85#include <tuple>
Benjamin Kramer82de7d32016-05-27 14:27:24 +000086#include <utility>
Eugene Zelenko1804a772016-08-25 00:45:04 +000087#include <vector>
Eugene Zelenko6ac3f732016-01-26 18:48:36 +000088
Chris Lattner1314b992007-04-22 06:23:29 +000089using namespace llvm;
90
Teresa Johnson916495d2016-04-04 18:52:58 +000091static cl::opt<bool> PrintSummaryGUIDs(
92 "print-summary-global-ids", cl::init(false), cl::Hidden,
93 cl::desc(
94 "Print the global id for each value when reading the module summary"));
95
Benjamin Kramercced8be2015-03-17 20:40:24 +000096namespace {
Eugene Zelenko1804a772016-08-25 00:45:04 +000097
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +000098enum {
99 SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
100};
101
Peter Collingbournec0032b72016-11-11 19:50:10 +0000102Error error(const Twine &Message) {
103 return make_error<StringError>(
104 Message, make_error_code(BitcodeError::CorruptedBitcode));
105}
106
107/// Helper to read the header common to all bitcode files.
108bool hasValidBitcodeHeader(BitstreamCursor &Stream) {
109 // Sniff for the signature.
110 if (!Stream.canSkipToPos(4) ||
111 Stream.Read(8) != 'B' ||
112 Stream.Read(8) != 'C' ||
113 Stream.Read(4) != 0x0 ||
114 Stream.Read(4) != 0xC ||
115 Stream.Read(4) != 0xE ||
116 Stream.Read(4) != 0xD)
117 return false;
118 return true;
119}
120
121Expected<BitstreamCursor> initStream(MemoryBufferRef Buffer) {
122 const unsigned char *BufPtr = (const unsigned char *)Buffer.getBufferStart();
123 const unsigned char *BufEnd = BufPtr + Buffer.getBufferSize();
124
125 if (Buffer.getBufferSize() & 3)
126 return error("Invalid bitcode signature");
127
128 // If we have a wrapper header, parse it and ignore the non-bc file contents.
129 // The magic number is 0x0B17C0DE stored in little endian.
130 if (isBitcodeWrapper(BufPtr, BufEnd))
131 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
132 return error("Invalid bitcode wrapper header");
133
134 BitstreamCursor Stream(ArrayRef<uint8_t>(BufPtr, BufEnd));
135 if (!hasValidBitcodeHeader(Stream))
136 return error("Invalid bitcode signature");
137
138 return std::move(Stream);
139}
140
Peter Collingbournecd513a42016-11-11 19:50:24 +0000141/// Convert a string from a record into an std::string, return true on failure.
142template <typename StrTy>
143static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
144 StrTy &Result) {
145 if (Idx > Record.size())
146 return true;
147
148 for (unsigned i = Idx, e = Record.size(); i != e; ++i)
149 Result += (char)Record[i];
150 return false;
151}
152
Mehdi Amini86623052016-12-16 19:16:29 +0000153// Strip all the TBAA attachment for the module.
154void stripTBAA(Module *M) {
155 for (auto &F : *M) {
156 if (F.isMaterializable())
157 continue;
158 for (auto &I : instructions(F))
159 I.setMetadata(LLVMContext::MD_tbaa, nullptr);
160 }
161}
162
Peter Collingbournecd513a42016-11-11 19:50:24 +0000163/// Read the "IDENTIFICATION_BLOCK_ID" block, do some basic enforcement on the
164/// "epoch" encoded in the bitcode, and return the producer name if any.
165Expected<std::string> readIdentificationBlock(BitstreamCursor &Stream) {
166 if (Stream.EnterSubBlock(bitc::IDENTIFICATION_BLOCK_ID))
167 return error("Invalid record");
168
169 // Read all the records.
170 SmallVector<uint64_t, 64> Record;
171
172 std::string ProducerIdentification;
173
174 while (true) {
175 BitstreamEntry Entry = Stream.advance();
176
177 switch (Entry.Kind) {
178 default:
179 case BitstreamEntry::Error:
180 return error("Malformed block");
181 case BitstreamEntry::EndBlock:
182 return ProducerIdentification;
183 case BitstreamEntry::Record:
184 // The interesting case.
185 break;
186 }
187
188 // Read a record.
189 Record.clear();
190 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
191 switch (BitCode) {
192 default: // Default behavior: reject
193 return error("Invalid value");
194 case bitc::IDENTIFICATION_CODE_STRING: // IDENTIFICATION: [strchr x N]
195 convertToString(Record, 0, ProducerIdentification);
196 break;
197 case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH: [epoch#]
198 unsigned epoch = (unsigned)Record[0];
199 if (epoch != bitc::BITCODE_CURRENT_EPOCH) {
200 return error(
201 Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +
202 "' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");
203 }
204 }
205 }
206 }
207}
208
209Expected<std::string> readIdentificationCode(BitstreamCursor &Stream) {
210 // We expect a number of well-defined blocks, though we don't necessarily
211 // need to understand them all.
212 while (true) {
213 if (Stream.AtEndOfStream())
214 return "";
215
216 BitstreamEntry Entry = Stream.advance();
217 switch (Entry.Kind) {
218 case BitstreamEntry::EndBlock:
219 case BitstreamEntry::Error:
220 return error("Malformed block");
221
222 case BitstreamEntry::SubBlock:
223 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID)
224 return readIdentificationBlock(Stream);
225
226 // Ignore other sub-blocks.
227 if (Stream.SkipBlock())
228 return error("Malformed block");
229 continue;
230 case BitstreamEntry::Record:
231 Stream.skipRecord(Entry.ID);
232 continue;
233 }
234 }
235}
236
237Expected<bool> hasObjCCategoryInModule(BitstreamCursor &Stream) {
238 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
239 return error("Invalid record");
240
241 SmallVector<uint64_t, 64> Record;
242 // Read all the records for this module.
243
244 while (true) {
245 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
246
247 switch (Entry.Kind) {
248 case BitstreamEntry::SubBlock: // Handled for us already.
249 case BitstreamEntry::Error:
250 return error("Malformed block");
251 case BitstreamEntry::EndBlock:
252 return false;
253 case BitstreamEntry::Record:
254 // The interesting case.
255 break;
256 }
257
258 // Read a record.
259 switch (Stream.readRecord(Entry.ID, Record)) {
260 default:
261 break; // Default behavior, ignore unknown content.
262 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
263 std::string S;
264 if (convertToString(Record, 0, S))
265 return error("Invalid record");
266 // Check for the i386 and other (x86_64, ARM) conventions
267 if (S.find("__DATA, __objc_catlist") != std::string::npos ||
268 S.find("__OBJC,__category") != std::string::npos)
269 return true;
270 break;
271 }
272 }
273 Record.clear();
274 }
275 llvm_unreachable("Exit infinite loop");
276}
277
278Expected<bool> hasObjCCategory(BitstreamCursor &Stream) {
279 // We expect a number of well-defined blocks, though we don't necessarily
280 // need to understand them all.
281 while (true) {
282 BitstreamEntry Entry = Stream.advance();
283
284 switch (Entry.Kind) {
285 case BitstreamEntry::Error:
286 return error("Malformed block");
287 case BitstreamEntry::EndBlock:
288 return false;
289
290 case BitstreamEntry::SubBlock:
291 if (Entry.ID == bitc::MODULE_BLOCK_ID)
292 return hasObjCCategoryInModule(Stream);
293
294 // Ignore other sub-blocks.
295 if (Stream.SkipBlock())
296 return error("Malformed block");
297 continue;
298
299 case BitstreamEntry::Record:
300 Stream.skipRecord(Entry.ID);
301 continue;
302 }
303 }
304}
305
306Expected<std::string> readModuleTriple(BitstreamCursor &Stream) {
307 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
308 return error("Invalid record");
309
310 SmallVector<uint64_t, 64> Record;
311
312 std::string Triple;
313
314 // Read all the records for this module.
315 while (true) {
316 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
317
318 switch (Entry.Kind) {
319 case BitstreamEntry::SubBlock: // Handled for us already.
320 case BitstreamEntry::Error:
321 return error("Malformed block");
322 case BitstreamEntry::EndBlock:
323 return Triple;
324 case BitstreamEntry::Record:
325 // The interesting case.
326 break;
327 }
328
329 // Read a record.
330 switch (Stream.readRecord(Entry.ID, Record)) {
331 default: break; // Default behavior, ignore unknown content.
332 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
333 std::string S;
334 if (convertToString(Record, 0, S))
335 return error("Invalid record");
336 Triple = S;
337 break;
338 }
339 }
340 Record.clear();
341 }
342 llvm_unreachable("Exit infinite loop");
343}
344
345Expected<std::string> readTriple(BitstreamCursor &Stream) {
346 // We expect a number of well-defined blocks, though we don't necessarily
347 // need to understand them all.
348 while (true) {
349 BitstreamEntry Entry = Stream.advance();
350
351 switch (Entry.Kind) {
352 case BitstreamEntry::Error:
353 return error("Malformed block");
354 case BitstreamEntry::EndBlock:
355 return "";
356
357 case BitstreamEntry::SubBlock:
358 if (Entry.ID == bitc::MODULE_BLOCK_ID)
359 return readModuleTriple(Stream);
360
361 // Ignore other sub-blocks.
362 if (Stream.SkipBlock())
363 return error("Malformed block");
364 continue;
365
366 case BitstreamEntry::Record:
367 Stream.skipRecord(Entry.ID);
368 continue;
369 }
370 }
371}
372
Peter Collingbourne6e860752016-09-23 18:27:42 +0000373class BitcodeReaderBase {
374protected:
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000375 BitcodeReaderBase(BitstreamCursor Stream, StringRef Strtab)
376 : Stream(std::move(Stream)), Strtab(Strtab) {
Peter Collingbournec0032b72016-11-11 19:50:10 +0000377 this->Stream.setBlockInfo(&BlockInfo);
378 }
Peter Collingbourne6e860752016-09-23 18:27:42 +0000379
Peter Collingbourne77c89b62016-11-08 04:17:11 +0000380 BitstreamBlockInfo BlockInfo;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000381 BitstreamCursor Stream;
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000382 StringRef Strtab;
383
384 /// In version 2 of the bitcode we store names of global values and comdats in
385 /// a string table rather than in the VST.
386 bool UseStrtab = false;
Peter Collingbourne6e860752016-09-23 18:27:42 +0000387
Peter Collingbournece24a2a2017-04-12 20:02:09 +0000388 Expected<unsigned> parseVersionRecord(ArrayRef<uint64_t> Record);
389
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000390 /// If this module uses a string table, pop the reference to the string table
391 /// and return the referenced string and the rest of the record. Otherwise
392 /// just return the record itself.
393 std::pair<StringRef, ArrayRef<uint64_t>>
394 readNameFromStrtab(ArrayRef<uint64_t> Record);
395
Peter Collingbourne939c7d92016-11-08 04:16:57 +0000396 bool readBlockInfo();
Peter Collingbourne6e860752016-09-23 18:27:42 +0000397
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000398 // Contains an arbitrary and optional string identifying the bitcode producer
399 std::string ProducerIdentification;
400
401 Error error(const Twine &Message);
Peter Collingbourne6e860752016-09-23 18:27:42 +0000402};
403
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000404Error BitcodeReaderBase::error(const Twine &Message) {
405 std::string FullMsg = Message.str();
406 if (!ProducerIdentification.empty())
407 FullMsg += " (Producer: '" + ProducerIdentification + "' Reader: 'LLVM " +
408 LLVM_VERSION_STRING "')";
Peter Collingbournec0032b72016-11-11 19:50:10 +0000409 return ::error(FullMsg);
Peter Collingbourne6e860752016-09-23 18:27:42 +0000410}
411
Peter Collingbournece24a2a2017-04-12 20:02:09 +0000412Expected<unsigned>
413BitcodeReaderBase::parseVersionRecord(ArrayRef<uint64_t> Record) {
414 if (Record.size() < 1)
415 return error("Invalid record");
416 unsigned ModuleVersion = Record[0];
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000417 if (ModuleVersion > 2)
Peter Collingbournece24a2a2017-04-12 20:02:09 +0000418 return error("Invalid value");
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000419 UseStrtab = ModuleVersion >= 2;
Peter Collingbournece24a2a2017-04-12 20:02:09 +0000420 return ModuleVersion;
421}
422
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000423std::pair<StringRef, ArrayRef<uint64_t>>
424BitcodeReaderBase::readNameFromStrtab(ArrayRef<uint64_t> Record) {
425 if (!UseStrtab)
426 return {"", Record};
427 // Invalid reference. Let the caller complain about the record being empty.
428 if (Record[0] + Record[1] > Strtab.size())
429 return {"", {}};
430 return {StringRef(Strtab.data() + Record[0], Record[1]), Record.slice(2)};
431}
432
Peter Collingbourne6e860752016-09-23 18:27:42 +0000433class BitcodeReader : public BitcodeReaderBase, public GVMaterializer {
434 LLVMContext &Context;
435 Module *TheModule = nullptr;
Teresa Johnson1493ad92015-10-10 14:18:36 +0000436 // Next offset to start scanning for lazy parsing of function bodies.
Rafael Espindola4223a1f2015-06-15 20:08:17 +0000437 uint64_t NextUnreadBit = 0;
Teresa Johnson1493ad92015-10-10 14:18:36 +0000438 // Last function offset found in the VST.
439 uint64_t LastFunctionBlockBit = 0;
Rafael Espindola4223a1f2015-06-15 20:08:17 +0000440 bool SeenValueSymbolTable = false;
Peter Collingbourne128a9762015-10-27 23:01:25 +0000441 uint64_t VSTOffset = 0;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000442
Peter Collingbournece24a2a2017-04-12 20:02:09 +0000443 std::vector<std::string> SectionTable;
444 std::vector<std::string> GCTable;
445
Benjamin Kramercced8be2015-03-17 20:40:24 +0000446 std::vector<Type*> TypeList;
447 BitcodeReaderValueList ValueList;
Mehdi Aminief27db82016-12-12 19:34:26 +0000448 Optional<MetadataLoader> MDLoader;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000449 std::vector<Comdat *> ComdatList;
450 SmallVector<Instruction *, 64> InstructionList;
451
452 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +0000453 std::vector<std::pair<GlobalIndirectSymbol*, unsigned> > IndirectSymbolInits;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000454 std::vector<std::pair<Function*, unsigned> > FunctionPrefixes;
455 std::vector<std::pair<Function*, unsigned> > FunctionPrologues;
David Majnemer7fddecc2015-06-17 20:52:32 +0000456 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFns;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000457
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000458 /// The set of attributes by index. Index zero in the file is for null, and
459 /// is thus not represented here. As such all indices are off by one.
Reid Klecknerb5180542017-03-21 16:57:19 +0000460 std::vector<AttributeList> MAttributes;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000461
Karl Schimpf36440082015-08-31 16:43:55 +0000462 /// The set of attribute groups.
Reid Klecknerb5180542017-03-21 16:57:19 +0000463 std::map<unsigned, AttributeList> MAttributeGroups;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000464
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000465 /// While parsing a function body, this is a list of the basic blocks for the
466 /// function.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000467 std::vector<BasicBlock*> FunctionBBs;
468
469 // When reading the module header, this list is populated with functions that
470 // have bodies later in the file.
471 std::vector<Function*> FunctionsWithBodies;
472
473 // When intrinsic functions are encountered which require upgrading they are
474 // stored here with their replacement function.
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +0000475 typedef DenseMap<Function*, Function*> UpdatedIntrinsicMap;
476 UpdatedIntrinsicMap UpgradedIntrinsics;
477 // Intrinsics which were remangled because of types rename
478 UpdatedIntrinsicMap RemangledIntrinsics;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000479
Benjamin Kramercced8be2015-03-17 20:40:24 +0000480 // Several operations happen after the module header has been read, but
481 // before function bodies are processed. This keeps track of whether
482 // we've done this yet.
Rafael Espindola4223a1f2015-06-15 20:08:17 +0000483 bool SeenFirstFunctionBody = false;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000484
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000485 /// When function bodies are initially scanned, this map contains info about
486 /// where to find deferred function body in the stream.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000487 DenseMap<Function*, uint64_t> DeferredFunctionInfo;
488
489 /// When Metadata block is initially scanned when parsing the module, we may
490 /// choose to defer parsing of the metadata. This vector contains info about
491 /// which Metadata blocks are deferred.
492 std::vector<uint64_t> DeferredMetadataInfo;
493
494 /// These are basic blocks forward-referenced by block addresses. They are
495 /// inserted lazily into functions when they're loaded. The basic block ID is
496 /// its index into the vector.
497 DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
498 std::deque<Function *> BasicBlockFwdRefQueue;
499
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000500 /// Indicates that we are using a new encoding for instruction operands where
501 /// most operands in the current FUNCTION_BLOCK are encoded relative to the
502 /// instruction number, for a more compact encoding. Some instruction
503 /// operands are not relative to the instruction ID: basic block numbers, and
504 /// types. Once the old style function blocks have been phased out, we would
Benjamin Kramercced8be2015-03-17 20:40:24 +0000505 /// not need this flag.
Rafael Espindola4223a1f2015-06-15 20:08:17 +0000506 bool UseRelativeIDs = false;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000507
508 /// True if all functions will be materialized, negating the need to process
509 /// (e.g.) blockaddress forward references.
Rafael Espindola4223a1f2015-06-15 20:08:17 +0000510 bool WillMaterializeAllForwardRefs = false;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000511
Rafael Espindola0d68b4c2015-03-30 21:36:43 +0000512 bool StripDebugInfo = false;
Mehdi Amini86623052016-12-16 19:16:29 +0000513 TBAAVerifier TBAAVerifyHelper;
Rafael Espindola0d68b4c2015-03-30 21:36:43 +0000514
Sanjoy Dasb513a9f2015-09-24 23:34:52 +0000515 std::vector<std::string> BundleTags;
516
Benjamin Kramercced8be2015-03-17 20:40:24 +0000517public:
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000518 BitcodeReader(BitstreamCursor Stream, StringRef Strtab,
519 StringRef ProducerIdentification, LLVMContext &Context);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000520
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000521 Error materializeForwardReferencedFunctions();
Benjamin Kramercced8be2015-03-17 20:40:24 +0000522
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000523 Error materialize(GlobalValue *GV) override;
524 Error materializeModule() override;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000525 std::vector<StructType *> getIdentifiedStructTypes() const override;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000526
Rafael Espindola6ace6852015-06-15 21:02:49 +0000527 /// \brief Main interface to parsing a bitcode buffer.
528 /// \returns true if an error occurred.
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000529 Error parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata = false,
530 bool IsImporting = false);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000531
Benjamin Kramercced8be2015-03-17 20:40:24 +0000532 static uint64_t decodeSignRotatedValue(uint64_t V);
533
534 /// Materialize any deferred Metadata block.
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000535 Error materializeMetadata() override;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000536
Rafael Espindola0d68b4c2015-03-30 21:36:43 +0000537 void setStripDebugInfo() override;
538
Benjamin Kramercced8be2015-03-17 20:40:24 +0000539private:
540 std::vector<StructType *> IdentifiedStructTypes;
541 StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
542 StructType *createIdentifiedStructType(LLVMContext &Context);
543
544 Type *getTypeByID(unsigned ID);
Eugene Zelenko1804a772016-08-25 00:45:04 +0000545
David Majnemer8a1c45d2015-12-12 05:38:55 +0000546 Value *getFnValueByID(unsigned ID, Type *Ty) {
Benjamin Kramercced8be2015-03-17 20:40:24 +0000547 if (Ty && Ty->isMetadataTy())
548 return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
David Majnemer8a1c45d2015-12-12 05:38:55 +0000549 return ValueList.getValueFwdRef(ID, Ty);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000550 }
Eugene Zelenko1804a772016-08-25 00:45:04 +0000551
Benjamin Kramercced8be2015-03-17 20:40:24 +0000552 Metadata *getFnMetadataByID(unsigned ID) {
Mehdi Amini3bb4d012017-01-20 20:29:16 +0000553 return MDLoader->getMetadataFwdRefOrLoad(ID);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000554 }
Eugene Zelenko1804a772016-08-25 00:45:04 +0000555
Benjamin Kramercced8be2015-03-17 20:40:24 +0000556 BasicBlock *getBasicBlock(unsigned ID) const {
557 if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
558 return FunctionBBs[ID];
559 }
Eugene Zelenko1804a772016-08-25 00:45:04 +0000560
Reid Klecknerb5180542017-03-21 16:57:19 +0000561 AttributeList getAttributes(unsigned i) const {
Benjamin Kramercced8be2015-03-17 20:40:24 +0000562 if (i-1 < MAttributes.size())
563 return MAttributes[i-1];
Reid Klecknerb5180542017-03-21 16:57:19 +0000564 return AttributeList();
Benjamin Kramercced8be2015-03-17 20:40:24 +0000565 }
566
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000567 /// Read a value/type pair out of the specified record from slot 'Slot'.
568 /// Increment Slot past the number of slots used in the record. Return true on
569 /// failure.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000570 bool getValueTypePair(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
571 unsigned InstNum, Value *&ResVal) {
572 if (Slot == Record.size()) return true;
573 unsigned ValNo = (unsigned)Record[Slot++];
574 // Adjust the ValNo, if it was encoded relative to the InstNum.
575 if (UseRelativeIDs)
576 ValNo = InstNum - ValNo;
577 if (ValNo < InstNum) {
578 // If this is not a forward reference, just return the value we already
579 // have.
580 ResVal = getFnValueByID(ValNo, nullptr);
581 return ResVal == nullptr;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000582 }
David Blaikiedbe6e0f2015-04-17 06:40:14 +0000583 if (Slot == Record.size())
584 return true;
Benjamin Kramercced8be2015-03-17 20:40:24 +0000585
586 unsigned TypeNo = (unsigned)Record[Slot++];
587 ResVal = getFnValueByID(ValNo, getTypeByID(TypeNo));
588 return ResVal == nullptr;
589 }
590
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000591 /// Read a value out of the specified record from slot 'Slot'. Increment Slot
592 /// past the number of slots used by the value in the record. Return true if
593 /// there is an error.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000594 bool popValue(SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
David Majnemer8a1c45d2015-12-12 05:38:55 +0000595 unsigned InstNum, Type *Ty, Value *&ResVal) {
596 if (getValue(Record, Slot, InstNum, Ty, ResVal))
Benjamin Kramercced8be2015-03-17 20:40:24 +0000597 return true;
598 // All values currently take a single record slot.
599 ++Slot;
600 return false;
601 }
602
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000603 /// Like popValue, but does not increment the Slot number.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000604 bool getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
David Majnemer8a1c45d2015-12-12 05:38:55 +0000605 unsigned InstNum, Type *Ty, Value *&ResVal) {
606 ResVal = getValue(Record, Slot, InstNum, Ty);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000607 return ResVal == nullptr;
608 }
609
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000610 /// Version of getValue that returns ResVal directly, or 0 if there is an
611 /// error.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000612 Value *getValue(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
David Majnemer8a1c45d2015-12-12 05:38:55 +0000613 unsigned InstNum, Type *Ty) {
Benjamin Kramercced8be2015-03-17 20:40:24 +0000614 if (Slot == Record.size()) return nullptr;
615 unsigned ValNo = (unsigned)Record[Slot];
616 // Adjust the ValNo, if it was encoded relative to the InstNum.
617 if (UseRelativeIDs)
618 ValNo = InstNum - ValNo;
David Majnemer8a1c45d2015-12-12 05:38:55 +0000619 return getFnValueByID(ValNo, Ty);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000620 }
621
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000622 /// Like getValue, but decodes signed VBRs.
Benjamin Kramercced8be2015-03-17 20:40:24 +0000623 Value *getValueSigned(SmallVectorImpl<uint64_t> &Record, unsigned Slot,
David Majnemer8a1c45d2015-12-12 05:38:55 +0000624 unsigned InstNum, Type *Ty) {
Benjamin Kramercced8be2015-03-17 20:40:24 +0000625 if (Slot == Record.size()) return nullptr;
626 unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
627 // Adjust the ValNo, if it was encoded relative to the InstNum.
628 if (UseRelativeIDs)
629 ValNo = InstNum - ValNo;
David Majnemer8a1c45d2015-12-12 05:38:55 +0000630 return getFnValueByID(ValNo, Ty);
Benjamin Kramercced8be2015-03-17 20:40:24 +0000631 }
632
633 /// Converts alignment exponent (i.e. power of two (or zero)) to the
634 /// corresponding alignment to use. If alignment is too large, returns
635 /// a corresponding error code.
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000636 Error parseAlignmentValue(uint64_t Exponent, unsigned &Alignment);
637 Error parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
638 Error parseModule(uint64_t ResumeBit, bool ShouldLazyLoadMetadata = false);
Peter Collingbournece24a2a2017-04-12 20:02:09 +0000639
640 Error parseComdatRecord(ArrayRef<uint64_t> Record);
641 Error parseGlobalVarRecord(ArrayRef<uint64_t> Record);
642 Error parseFunctionRecord(ArrayRef<uint64_t> Record);
643 Error parseGlobalIndirectSymbolRecord(unsigned BitCode,
644 ArrayRef<uint64_t> Record);
645
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000646 Error parseAttributeBlock();
647 Error parseAttributeGroupBlock();
648 Error parseTypeTable();
649 Error parseTypeTableBody();
650 Error parseOperandBundleTags();
Benjamin Kramercced8be2015-03-17 20:40:24 +0000651
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000652 Expected<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,
653 unsigned NameIndex, Triple &TT);
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000654 void setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta, Function *F,
655 ArrayRef<uint64_t> Record);
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000656 Error parseValueSymbolTable(uint64_t Offset = 0);
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000657 Error parseGlobalValueSymbolTable();
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000658 Error parseConstants();
659 Error rememberAndSkipFunctionBodies();
660 Error rememberAndSkipFunctionBody();
Benjamin Kramercced8be2015-03-17 20:40:24 +0000661 /// Save the positions of the Metadata blocks and skip parsing the blocks.
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000662 Error rememberAndSkipMetadata();
663 Error typeCheckLoadStoreInst(Type *ValType, Type *PtrType);
664 Error parseFunctionBody(Function *F);
665 Error globalCleanup();
666 Error resolveGlobalAndIndirectSymbolInits();
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000667 Error parseUseLists();
668 Error findFunctionInStream(
Benjamin Kramercced8be2015-03-17 20:40:24 +0000669 Function *F,
670 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
671};
Teresa Johnson403a7872015-10-04 14:33:43 +0000672
673/// Class to manage reading and parsing function summary index bitcode
674/// files/sections.
Peter Collingbourne6e860752016-09-23 18:27:42 +0000675class ModuleSummaryIndexBitcodeReader : public BitcodeReaderBase {
Peter Collingbournea46ec9f2016-12-01 06:00:53 +0000676 /// The module index built during parsing.
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +0000677 ModuleSummaryIndex &TheIndex;
Teresa Johnson403a7872015-10-04 14:33:43 +0000678
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000679 /// Indicates whether we have encountered a global value summary section
Peter Collingbournea46ec9f2016-12-01 06:00:53 +0000680 /// yet during parsing.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000681 bool SeenGlobalValSummary = false;
Teresa Johnson403a7872015-10-04 14:33:43 +0000682
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000683 /// Indicates whether we have already parsed the VST, used for error checking.
684 bool SeenValueSymbolTable = false;
685
686 /// Set to the offset of the VST recorded in the MODULE_CODE_VSTOFFSET record.
687 /// Used to enable on-demand parsing of the VST.
688 uint64_t VSTOffset = 0;
689
Peter Collingbourne9667b912017-05-04 18:03:25 +0000690 // Map to save ValueId to ValueInfo association that was recorded in the
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000691 // ValueSymbolTable. It is used after the VST is parsed to convert
692 // call graph edges read from the function summary from referencing
Peter Collingbourne9667b912017-05-04 18:03:25 +0000693 // callees by their ValueId to using the ValueInfo instead, which is how
Teresa Johnson26ab5772016-03-15 00:04:37 +0000694 // they are recorded in the summary index being built.
Peter Collingbourne9667b912017-05-04 18:03:25 +0000695 // We save a GUID which refers to the same global as the ValueInfo, but
696 // ignoring the linkage, i.e. for values other than local linkage they are
697 // identical.
698 DenseMap<unsigned, std::pair<ValueInfo, GlobalValue::GUID>>
699 ValueIdToValueInfoMap;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000700
Teresa Johnson403a7872015-10-04 14:33:43 +0000701 /// Map populated during module path string table parsing, from the
702 /// module ID to a string reference owned by the index's module
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000703 /// path string table, used to correlate with combined index
Teresa Johnson403a7872015-10-04 14:33:43 +0000704 /// summary records.
705 DenseMap<uint64_t, StringRef> ModuleIdMap;
706
Teresa Johnsone1164de2016-02-10 21:55:02 +0000707 /// Original source file name recorded in a bitcode record.
708 std::string SourceFileName;
709
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000710 /// The string identifier given to this module by the client, normally the
711 /// path to the bitcode file.
712 StringRef ModulePath;
713
714 /// For per-module summary indexes, the unique numerical identifier given to
715 /// this module by the client.
716 unsigned ModuleId;
717
Teresa Johnsonf72278f2015-11-02 18:02:11 +0000718public:
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000719 ModuleSummaryIndexBitcodeReader(BitstreamCursor Stream, StringRef Strtab,
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000720 ModuleSummaryIndex &TheIndex,
721 StringRef ModulePath, unsigned ModuleId);
Teresa Johnson403a7872015-10-04 14:33:43 +0000722
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000723 Error parseModule();
Teresa Johnson403a7872015-10-04 14:33:43 +0000724
Teresa Johnsonf72278f2015-11-02 18:02:11 +0000725private:
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000726 void setValueGUID(uint64_t ValueID, StringRef ValueName,
727 GlobalValue::LinkageTypes Linkage,
728 StringRef SourceFileName);
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000729 Error parseValueSymbolTable(
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000730 uint64_t Offset,
731 DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap);
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000732 std::vector<ValueInfo> makeRefList(ArrayRef<uint64_t> Record);
733 std::vector<FunctionSummary::EdgeTy> makeCallList(ArrayRef<uint64_t> Record,
734 bool IsOldProfileFormat,
735 bool HasProfile);
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000736 Error parseEntireSummary();
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000737 Error parseModuleStringTable();
Eugene Zelenko1804a772016-08-25 00:45:04 +0000738
Peter Collingbourne9667b912017-05-04 18:03:25 +0000739 std::pair<ValueInfo, GlobalValue::GUID>
740 getValueInfoFromValueId(unsigned ValueId);
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000741
742 ModulePathStringTableTy::iterator addThisModulePath();
Teresa Johnson403a7872015-10-04 14:33:43 +0000743};
Eugene Zelenko1804a772016-08-25 00:45:04 +0000744
Peter Collingbournecd513a42016-11-11 19:50:24 +0000745} // end anonymous namespace
746
747std::error_code llvm::errorToErrorCodeAndEmitErrors(LLVMContext &Ctx,
748 Error Err) {
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000749 if (Err) {
750 std::error_code EC;
751 handleAllErrors(std::move(Err), [&](ErrorInfoBase &EIB) {
752 EC = EIB.convertToErrorCode();
753 Ctx.emitError(EIB.message());
754 });
755 return EC;
756 }
757 return std::error_code();
758}
759
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000760BitcodeReader::BitcodeReader(BitstreamCursor Stream, StringRef Strtab,
Peter Collingbourne7a748032016-11-16 21:44:45 +0000761 StringRef ProducerIdentification,
762 LLVMContext &Context)
Peter Collingbournea0f371a2017-04-17 17:51:36 +0000763 : BitcodeReaderBase(std::move(Stream), Strtab), Context(Context),
Mehdi Aminief27db82016-12-12 19:34:26 +0000764 ValueList(Context) {
Peter Collingbourne7a748032016-11-16 21:44:45 +0000765 this->ProducerIdentification = ProducerIdentification;
766}
Rafael Espindolad0b23be2015-01-10 00:07:30 +0000767
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000768Error BitcodeReader::materializeForwardReferencedFunctions() {
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +0000769 if (WillMaterializeAllForwardRefs)
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000770 return Error::success();
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +0000771
772 // Prevent recursion.
773 WillMaterializeAllForwardRefs = true;
774
Duncan P. N. Exon Smith5a511b52014-08-05 17:49:48 +0000775 while (!BasicBlockFwdRefQueue.empty()) {
776 Function *F = BasicBlockFwdRefQueue.front();
777 BasicBlockFwdRefQueue.pop_front();
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +0000778 assert(F && "Expected valid function");
Duncan P. N. Exon Smith5a511b52014-08-05 17:49:48 +0000779 if (!BasicBlockFwdRefs.count(F))
780 // Already materialized.
781 continue;
782
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +0000783 // Check for a function that isn't materializable to prevent an infinite
784 // loop. When parsing a blockaddress stored in a global variable, there
785 // isn't a trivial way to check if a function will have a body without a
786 // linear search through FunctionsWithBodies, so just check it here.
787 if (!F->isMaterializable())
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000788 return error("Never resolved function from blockaddress");
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +0000789
790 // Try to materialize F.
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000791 if (Error Err = materialize(F))
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000792 return Err;
Rafael Espindolab7993462012-01-02 07:49:53 +0000793 }
Duncan P. N. Exon Smith5a511b52014-08-05 17:49:48 +0000794 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +0000795
796 // Reset state.
797 WillMaterializeAllForwardRefs = false;
Peter Collingbourne58f7f072016-11-09 00:51:04 +0000798 return Error::success();
Rafael Espindolab7993462012-01-02 07:49:53 +0000799}
800
Chris Lattnerfee5a372007-05-04 03:30:17 +0000801//===----------------------------------------------------------------------===//
802// Helper functions to implement forward reference resolution, etc.
803//===----------------------------------------------------------------------===//
Chris Lattner6694f602007-04-29 07:54:31 +0000804
Rafael Espindola12ca34f2015-01-19 15:16:06 +0000805static bool hasImplicitComdat(size_t Val) {
806 switch (Val) {
807 default:
808 return false;
809 case 1: // Old WeakAnyLinkage
810 case 4: // Old LinkOnceAnyLinkage
811 case 10: // Old WeakODRLinkage
812 case 11: // Old LinkOnceODRLinkage
813 return true;
814 }
815}
816
Rafael Espindola7b4b2dc2015-01-08 15:36:32 +0000817static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
Chris Lattner1314b992007-04-22 06:23:29 +0000818 switch (Val) {
819 default: // Map unknown/new linkages to external
Rafael Espindola7b4b2dc2015-01-08 15:36:32 +0000820 case 0:
821 return GlobalValue::ExternalLinkage;
Rafael Espindola7b4b2dc2015-01-08 15:36:32 +0000822 case 2:
823 return GlobalValue::AppendingLinkage;
824 case 3:
825 return GlobalValue::InternalLinkage;
Rafael Espindola7b4b2dc2015-01-08 15:36:32 +0000826 case 5:
827 return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
828 case 6:
829 return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
830 case 7:
831 return GlobalValue::ExternalWeakLinkage;
832 case 8:
833 return GlobalValue::CommonLinkage;
834 case 9:
835 return GlobalValue::PrivateLinkage;
Rafael Espindola7b4b2dc2015-01-08 15:36:32 +0000836 case 12:
837 return GlobalValue::AvailableExternallyLinkage;
Rafael Espindola2fb5bc32014-03-13 23:18:37 +0000838 case 13:
839 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
840 case 14:
841 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
Rafael Espindolabec6af62015-01-08 15:39:50 +0000842 case 15:
843 return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
Rafael Espindola12ca34f2015-01-19 15:16:06 +0000844 case 1: // Old value with implicit comdat.
845 case 16:
846 return GlobalValue::WeakAnyLinkage;
847 case 10: // Old value with implicit comdat.
848 case 17:
849 return GlobalValue::WeakODRLinkage;
850 case 4: // Old value with implicit comdat.
851 case 18:
852 return GlobalValue::LinkOnceAnyLinkage;
853 case 11: // Old value with implicit comdat.
854 case 19:
855 return GlobalValue::LinkOnceODRLinkage;
Chris Lattner1314b992007-04-22 06:23:29 +0000856 }
857}
858
Piotr Padlewski332b3b22016-08-11 22:13:57 +0000859/// Decode the flags for GlobalValue in the summary.
Mehdi Aminic3ed48c2016-04-24 03:18:18 +0000860static GlobalValueSummary::GVFlags getDecodedGVSummaryFlags(uint64_t RawFlags,
861 uint64_t Version) {
862 // Summary were not emitted before LLVM 3.9, we don't need to upgrade Linkage
863 // like getDecodedLinkage() above. Any future change to the linkage enum and
864 // to getDecodedLinkage() will need to be taken into account here as above.
865 auto Linkage = GlobalValue::LinkageTypes(RawFlags & 0xF); // 4 bits
Mehdi Amini1380edf2017-02-03 07:41:43 +0000866 RawFlags = RawFlags >> 4;
867 bool NotEligibleToImport = (RawFlags & 0x1) || Version < 3;
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +0000868 // The Live flag wasn't introduced until version 3. For dead stripping
Teresa Johnson6c475a72017-01-05 21:34:18 +0000869 // to work correctly on earlier versions, we must conservatively treat all
870 // values as live.
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +0000871 bool Live = (RawFlags & 0x2) || Version < 3;
872 return GlobalValueSummary::GVFlags(Linkage, NotEligibleToImport, Live);
Mehdi Aminic3ed48c2016-04-24 03:18:18 +0000873}
874
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000875static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {
Chris Lattner1314b992007-04-22 06:23:29 +0000876 switch (Val) {
877 default: // Map unknown visibilities to default.
878 case 0: return GlobalValue::DefaultVisibility;
879 case 1: return GlobalValue::HiddenVisibility;
Anton Korobeynikov31fc4f92007-04-29 20:56:48 +0000880 case 2: return GlobalValue::ProtectedVisibility;
Chris Lattner1314b992007-04-22 06:23:29 +0000881 }
882}
883
Nico Rieck7157bb72014-01-14 15:22:47 +0000884static GlobalValue::DLLStorageClassTypes
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000885getDecodedDLLStorageClass(unsigned Val) {
Nico Rieck7157bb72014-01-14 15:22:47 +0000886 switch (Val) {
887 default: // Map unknown values to default.
888 case 0: return GlobalValue::DefaultStorageClass;
889 case 1: return GlobalValue::DLLImportStorageClass;
890 case 2: return GlobalValue::DLLExportStorageClass;
891 }
892}
893
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000894static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000895 switch (Val) {
896 case 0: return GlobalVariable::NotThreadLocal;
897 default: // Map unknown non-zero value to general dynamic.
898 case 1: return GlobalVariable::GeneralDynamicTLSModel;
899 case 2: return GlobalVariable::LocalDynamicTLSModel;
900 case 3: return GlobalVariable::InitialExecTLSModel;
901 case 4: return GlobalVariable::LocalExecTLSModel;
902 }
903}
904
Peter Collingbourne96efdd62016-06-14 21:01:22 +0000905static GlobalVariable::UnnamedAddr getDecodedUnnamedAddrType(unsigned Val) {
906 switch (Val) {
907 default: // Map unknown to UnnamedAddr::None.
908 case 0: return GlobalVariable::UnnamedAddr::None;
909 case 1: return GlobalVariable::UnnamedAddr::Global;
910 case 2: return GlobalVariable::UnnamedAddr::Local;
911 }
912}
913
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000914static int getDecodedCastOpcode(unsigned Val) {
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000915 switch (Val) {
916 default: return -1;
917 case bitc::CAST_TRUNC : return Instruction::Trunc;
918 case bitc::CAST_ZEXT : return Instruction::ZExt;
919 case bitc::CAST_SEXT : return Instruction::SExt;
920 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
921 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
922 case bitc::CAST_UITOFP : return Instruction::UIToFP;
923 case bitc::CAST_SITOFP : return Instruction::SIToFP;
924 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
925 case bitc::CAST_FPEXT : return Instruction::FPExt;
926 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
927 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
928 case bitc::CAST_BITCAST : return Instruction::BitCast;
Matt Arsenault3aa9b032013-11-18 02:51:33 +0000929 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000930 }
931}
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000932
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000933static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000934 bool IsFP = Ty->isFPOrFPVectorTy();
935 // BinOps are only valid for int/fp or vector of int/fp types
936 if (!IsFP && !Ty->isIntOrIntVectorTy())
937 return -1;
938
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000939 switch (Val) {
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000940 default:
941 return -1;
Dan Gohmana5b96452009-06-04 22:49:04 +0000942 case bitc::BINOP_ADD:
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000943 return IsFP ? Instruction::FAdd : Instruction::Add;
Dan Gohmana5b96452009-06-04 22:49:04 +0000944 case bitc::BINOP_SUB:
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000945 return IsFP ? Instruction::FSub : Instruction::Sub;
Dan Gohmana5b96452009-06-04 22:49:04 +0000946 case bitc::BINOP_MUL:
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000947 return IsFP ? Instruction::FMul : Instruction::Mul;
948 case bitc::BINOP_UDIV:
949 return IsFP ? -1 : Instruction::UDiv;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000950 case bitc::BINOP_SDIV:
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000951 return IsFP ? Instruction::FDiv : Instruction::SDiv;
952 case bitc::BINOP_UREM:
953 return IsFP ? -1 : Instruction::URem;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000954 case bitc::BINOP_SREM:
Filipe Cabecinhasea79c5b2015-04-22 09:06:21 +0000955 return IsFP ? Instruction::FRem : Instruction::SRem;
956 case bitc::BINOP_SHL:
957 return IsFP ? -1 : Instruction::Shl;
958 case bitc::BINOP_LSHR:
959 return IsFP ? -1 : Instruction::LShr;
960 case bitc::BINOP_ASHR:
961 return IsFP ? -1 : Instruction::AShr;
962 case bitc::BINOP_AND:
963 return IsFP ? -1 : Instruction::And;
964 case bitc::BINOP_OR:
965 return IsFP ? -1 : Instruction::Or;
966 case bitc::BINOP_XOR:
967 return IsFP ? -1 : Instruction::Xor;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000968 }
969}
970
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000971static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {
Eli Friedmanc9a551e2011-07-28 21:48:00 +0000972 switch (Val) {
973 default: return AtomicRMWInst::BAD_BINOP;
974 case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
975 case bitc::RMW_ADD: return AtomicRMWInst::Add;
976 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
977 case bitc::RMW_AND: return AtomicRMWInst::And;
978 case bitc::RMW_NAND: return AtomicRMWInst::Nand;
979 case bitc::RMW_OR: return AtomicRMWInst::Or;
980 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
981 case bitc::RMW_MAX: return AtomicRMWInst::Max;
982 case bitc::RMW_MIN: return AtomicRMWInst::Min;
983 case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
984 case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
985 }
986}
987
Rafael Espindolacbdcb502015-06-15 20:55:37 +0000988static AtomicOrdering getDecodedOrdering(unsigned Val) {
Eli Friedmanfee02c62011-07-25 23:16:38 +0000989 switch (Val) {
JF Bastien800f87a2016-04-06 21:19:33 +0000990 case bitc::ORDERING_NOTATOMIC: return AtomicOrdering::NotAtomic;
991 case bitc::ORDERING_UNORDERED: return AtomicOrdering::Unordered;
992 case bitc::ORDERING_MONOTONIC: return AtomicOrdering::Monotonic;
993 case bitc::ORDERING_ACQUIRE: return AtomicOrdering::Acquire;
994 case bitc::ORDERING_RELEASE: return AtomicOrdering::Release;
995 case bitc::ORDERING_ACQREL: return AtomicOrdering::AcquireRelease;
Eli Friedmanfee02c62011-07-25 23:16:38 +0000996 default: // Map unknown orderings to sequentially-consistent.
JF Bastien800f87a2016-04-06 21:19:33 +0000997 case bitc::ORDERING_SEQCST: return AtomicOrdering::SequentiallyConsistent;
Eli Friedmanfee02c62011-07-25 23:16:38 +0000998 }
999}
1000
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001001static SynchronizationScope getDecodedSynchScope(unsigned Val) {
Eli Friedmanfee02c62011-07-25 23:16:38 +00001002 switch (Val) {
1003 case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
1004 default: // Map unknown scopes to cross-thread.
1005 case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
1006 }
1007}
1008
David Majnemerdad0a642014-06-27 18:19:56 +00001009static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
1010 switch (Val) {
1011 default: // Map unknown selection kinds to any.
1012 case bitc::COMDAT_SELECTION_KIND_ANY:
1013 return Comdat::Any;
1014 case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
1015 return Comdat::ExactMatch;
1016 case bitc::COMDAT_SELECTION_KIND_LARGEST:
1017 return Comdat::Largest;
1018 case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
1019 return Comdat::NoDuplicates;
1020 case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
1021 return Comdat::SameSize;
1022 }
1023}
1024
James Molloy88eb5352015-07-10 12:52:00 +00001025static FastMathFlags getDecodedFastMathFlags(unsigned Val) {
1026 FastMathFlags FMF;
1027 if (0 != (Val & FastMathFlags::UnsafeAlgebra))
1028 FMF.setUnsafeAlgebra();
1029 if (0 != (Val & FastMathFlags::NoNaNs))
1030 FMF.setNoNaNs();
1031 if (0 != (Val & FastMathFlags::NoInfs))
1032 FMF.setNoInfs();
1033 if (0 != (Val & FastMathFlags::NoSignedZeros))
1034 FMF.setNoSignedZeros();
1035 if (0 != (Val & FastMathFlags::AllowReciprocal))
1036 FMF.setAllowReciprocal();
Adam Nemetcd847a82017-03-28 20:11:52 +00001037 if (0 != (Val & FastMathFlags::AllowContract))
1038 FMF.setAllowContract(true);
James Molloy88eb5352015-07-10 12:52:00 +00001039 return FMF;
1040}
1041
Eugene Zelenko1804a772016-08-25 00:45:04 +00001042static void upgradeDLLImportExportLinkage(GlobalValue *GV, unsigned Val) {
Nico Rieck7157bb72014-01-14 15:22:47 +00001043 switch (Val) {
1044 case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
1045 case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
1046 }
1047}
1048
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00001049
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001050Type *BitcodeReader::getTypeByID(unsigned ID) {
1051 // The type table size is always specified correctly.
1052 if (ID >= TypeList.size())
Craig Topper2617dcc2014-04-15 06:32:26 +00001053 return nullptr;
Derek Schuff206dddd2012-02-06 19:03:04 +00001054
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001055 if (Type *Ty = TypeList[ID])
1056 return Ty;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001057
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001058 // If we have a forward reference, the only possible case is when it is to a
1059 // named struct. Just create a placeholder for now.
Rafael Espindola2fa1e432014-12-03 07:18:23 +00001060 return TypeList[ID] = createIdentifiedStructType(Context);
1061}
1062
1063StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
1064 StringRef Name) {
1065 auto *Ret = StructType::create(Context, Name);
1066 IdentifiedStructTypes.push_back(Ret);
1067 return Ret;
1068}
1069
1070StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
1071 auto *Ret = StructType::create(Context);
1072 IdentifiedStructTypes.push_back(Ret);
1073 return Ret;
Chris Lattner1314b992007-04-22 06:23:29 +00001074}
1075
Chris Lattnerfee5a372007-05-04 03:30:17 +00001076//===----------------------------------------------------------------------===//
1077// Functions for parsing blocks from the bitcode file
1078//===----------------------------------------------------------------------===//
1079
Amaury Sechet74084c42016-11-06 07:48:46 +00001080static uint64_t getRawAttributeMask(Attribute::AttrKind Val) {
1081 switch (Val) {
1082 case Attribute::EndAttrKinds:
1083 llvm_unreachable("Synthetic enumerators which should never get here");
1084
1085 case Attribute::None: return 0;
1086 case Attribute::ZExt: return 1 << 0;
1087 case Attribute::SExt: return 1 << 1;
1088 case Attribute::NoReturn: return 1 << 2;
1089 case Attribute::InReg: return 1 << 3;
1090 case Attribute::StructRet: return 1 << 4;
1091 case Attribute::NoUnwind: return 1 << 5;
1092 case Attribute::NoAlias: return 1 << 6;
1093 case Attribute::ByVal: return 1 << 7;
1094 case Attribute::Nest: return 1 << 8;
1095 case Attribute::ReadNone: return 1 << 9;
1096 case Attribute::ReadOnly: return 1 << 10;
1097 case Attribute::NoInline: return 1 << 11;
1098 case Attribute::AlwaysInline: return 1 << 12;
1099 case Attribute::OptimizeForSize: return 1 << 13;
1100 case Attribute::StackProtect: return 1 << 14;
1101 case Attribute::StackProtectReq: return 1 << 15;
1102 case Attribute::Alignment: return 31 << 16;
1103 case Attribute::NoCapture: return 1 << 21;
1104 case Attribute::NoRedZone: return 1 << 22;
1105 case Attribute::NoImplicitFloat: return 1 << 23;
1106 case Attribute::Naked: return 1 << 24;
1107 case Attribute::InlineHint: return 1 << 25;
1108 case Attribute::StackAlignment: return 7 << 26;
1109 case Attribute::ReturnsTwice: return 1 << 29;
1110 case Attribute::UWTable: return 1 << 30;
1111 case Attribute::NonLazyBind: return 1U << 31;
1112 case Attribute::SanitizeAddress: return 1ULL << 32;
1113 case Attribute::MinSize: return 1ULL << 33;
1114 case Attribute::NoDuplicate: return 1ULL << 34;
1115 case Attribute::StackProtectStrong: return 1ULL << 35;
1116 case Attribute::SanitizeThread: return 1ULL << 36;
1117 case Attribute::SanitizeMemory: return 1ULL << 37;
1118 case Attribute::NoBuiltin: return 1ULL << 38;
1119 case Attribute::Returned: return 1ULL << 39;
1120 case Attribute::Cold: return 1ULL << 40;
1121 case Attribute::Builtin: return 1ULL << 41;
1122 case Attribute::OptimizeNone: return 1ULL << 42;
1123 case Attribute::InAlloca: return 1ULL << 43;
1124 case Attribute::NonNull: return 1ULL << 44;
1125 case Attribute::JumpTable: return 1ULL << 45;
1126 case Attribute::Convergent: return 1ULL << 46;
1127 case Attribute::SafeStack: return 1ULL << 47;
1128 case Attribute::NoRecurse: return 1ULL << 48;
1129 case Attribute::InaccessibleMemOnly: return 1ULL << 49;
1130 case Attribute::InaccessibleMemOrArgMemOnly: return 1ULL << 50;
1131 case Attribute::SwiftSelf: return 1ULL << 51;
1132 case Attribute::SwiftError: return 1ULL << 52;
1133 case Attribute::WriteOnly: return 1ULL << 53;
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001134 case Attribute::Speculatable: return 1ULL << 54;
Amaury Sechet74084c42016-11-06 07:48:46 +00001135 case Attribute::Dereferenceable:
1136 llvm_unreachable("dereferenceable attribute not supported in raw format");
1137 break;
1138 case Attribute::DereferenceableOrNull:
1139 llvm_unreachable("dereferenceable_or_null attribute not supported in raw "
1140 "format");
1141 break;
1142 case Attribute::ArgMemOnly:
1143 llvm_unreachable("argmemonly attribute not supported in raw format");
1144 break;
1145 case Attribute::AllocSize:
1146 llvm_unreachable("allocsize not supported in raw format");
1147 break;
1148 }
1149 llvm_unreachable("Unsupported attribute type");
1150}
1151
1152static void addRawAttributeValue(AttrBuilder &B, uint64_t Val) {
1153 if (!Val) return;
1154
1155 for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
1156 I = Attribute::AttrKind(I + 1)) {
1157 if (I == Attribute::Dereferenceable ||
1158 I == Attribute::DereferenceableOrNull ||
1159 I == Attribute::ArgMemOnly ||
1160 I == Attribute::AllocSize)
1161 continue;
1162 if (uint64_t A = (Val & getRawAttributeMask(I))) {
1163 if (I == Attribute::Alignment)
1164 B.addAlignmentAttr(1ULL << ((A >> 16) - 1));
1165 else if (I == Attribute::StackAlignment)
1166 B.addStackAlignmentAttr(1ULL << ((A >> 26)-1));
1167 else
1168 B.addAttribute(I);
1169 }
1170 }
1171}
1172
Bill Wendling56aeccc2013-02-04 23:32:23 +00001173/// \brief This fills an AttrBuilder object with the LLVM attributes that have
1174/// been decoded from the given integer. This function must stay in sync with
1175/// 'encodeLLVMAttributesForBitcode'.
1176static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1177 uint64_t EncodedAttrs) {
1178 // FIXME: Remove in 4.0.
1179
1180 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
1181 // the bits above 31 down by 11 bits.
1182 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1183 assert((!Alignment || isPowerOf2_32(Alignment)) &&
1184 "Alignment must be a power of two.");
1185
1186 if (Alignment)
1187 B.addAlignmentAttr(Alignment);
Amaury Sechet74084c42016-11-06 07:48:46 +00001188 addRawAttributeValue(B, ((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1189 (EncodedAttrs & 0xffff));
Bill Wendling56aeccc2013-02-04 23:32:23 +00001190}
1191
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001192Error BitcodeReader::parseAttributeBlock() {
Chris Lattner982ec1e2007-05-05 00:17:00 +00001193 if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001194 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001195
Devang Patela05633e2008-09-26 22:53:05 +00001196 if (!MAttributes.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001197 return error("Invalid multiple blocks");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001198
Chris Lattnerfee5a372007-05-04 03:30:17 +00001199 SmallVector<uint64_t, 64> Record;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001200
Reid Klecknerb5180542017-03-21 16:57:19 +00001201 SmallVector<AttributeList, 8> Attrs;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001202
Chris Lattnerfee5a372007-05-04 03:30:17 +00001203 // Read all the records.
Eugene Zelenko1804a772016-08-25 00:45:04 +00001204 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00001205 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
Joe Abbey97b7a172013-02-06 22:14:06 +00001206
Chris Lattner27d38752013-01-20 02:13:19 +00001207 switch (Entry.Kind) {
1208 case BitstreamEntry::SubBlock: // Handled for us already.
1209 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001210 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00001211 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001212 return Error::success();
Chris Lattner27d38752013-01-20 02:13:19 +00001213 case BitstreamEntry::Record:
1214 // The interesting case.
1215 break;
Chris Lattnerfee5a372007-05-04 03:30:17 +00001216 }
Joe Abbey97b7a172013-02-06 22:14:06 +00001217
Chris Lattnerfee5a372007-05-04 03:30:17 +00001218 // Read a record.
1219 Record.clear();
Chris Lattner27d38752013-01-20 02:13:19 +00001220 switch (Stream.readRecord(Entry.ID, Record)) {
Chris Lattnerfee5a372007-05-04 03:30:17 +00001221 default: // Default behavior: ignore.
1222 break;
Bill Wendling56aeccc2013-02-04 23:32:23 +00001223 case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
1224 // FIXME: Remove in 4.0.
Chris Lattnerfee5a372007-05-04 03:30:17 +00001225 if (Record.size() & 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001226 return error("Invalid record");
Chris Lattnerfee5a372007-05-04 03:30:17 +00001227
Chris Lattnerfee5a372007-05-04 03:30:17 +00001228 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
Bill Wendling60011b82013-01-29 01:43:29 +00001229 AttrBuilder B;
Bill Wendling56aeccc2013-02-04 23:32:23 +00001230 decodeLLVMAttributesForBitcode(B, Record[i+1]);
Reid Klecknerb5180542017-03-21 16:57:19 +00001231 Attrs.push_back(AttributeList::get(Context, Record[i], B));
Devang Patela05633e2008-09-26 22:53:05 +00001232 }
Devang Patela05633e2008-09-26 22:53:05 +00001233
Reid Klecknerb5180542017-03-21 16:57:19 +00001234 MAttributes.push_back(AttributeList::get(Context, Attrs));
Chris Lattnerfee5a372007-05-04 03:30:17 +00001235 Attrs.clear();
1236 break;
1237 }
Bill Wendling0dc08912013-02-12 08:13:50 +00001238 case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
1239 for (unsigned i = 0, e = Record.size(); i != e; ++i)
1240 Attrs.push_back(MAttributeGroups[Record[i]]);
1241
Reid Klecknerb5180542017-03-21 16:57:19 +00001242 MAttributes.push_back(AttributeList::get(Context, Attrs));
Bill Wendling0dc08912013-02-12 08:13:50 +00001243 Attrs.clear();
1244 break;
1245 }
Duncan Sands04eb67e2007-11-20 14:09:29 +00001246 }
Chris Lattnerfee5a372007-05-04 03:30:17 +00001247 }
1248}
1249
Reid Klecknere9f36af2013-11-12 01:31:00 +00001250// Returns Attribute::None on unrecognized codes.
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001251static Attribute::AttrKind getAttrFromCode(uint64_t Code) {
Reid Klecknere9f36af2013-11-12 01:31:00 +00001252 switch (Code) {
1253 default:
1254 return Attribute::None;
1255 case bitc::ATTR_KIND_ALIGNMENT:
1256 return Attribute::Alignment;
1257 case bitc::ATTR_KIND_ALWAYS_INLINE:
1258 return Attribute::AlwaysInline;
Igor Laevsky39d662f2015-07-11 10:30:36 +00001259 case bitc::ATTR_KIND_ARGMEMONLY:
1260 return Attribute::ArgMemOnly;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001261 case bitc::ATTR_KIND_BUILTIN:
1262 return Attribute::Builtin;
1263 case bitc::ATTR_KIND_BY_VAL:
1264 return Attribute::ByVal;
Reid Klecknera534a382013-12-19 02:14:12 +00001265 case bitc::ATTR_KIND_IN_ALLOCA:
1266 return Attribute::InAlloca;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001267 case bitc::ATTR_KIND_COLD:
1268 return Attribute::Cold;
Owen Anderson85fa7d52015-05-26 23:48:40 +00001269 case bitc::ATTR_KIND_CONVERGENT:
1270 return Attribute::Convergent;
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001271 case bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY:
1272 return Attribute::InaccessibleMemOnly;
1273 case bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY:
1274 return Attribute::InaccessibleMemOrArgMemOnly;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001275 case bitc::ATTR_KIND_INLINE_HINT:
1276 return Attribute::InlineHint;
1277 case bitc::ATTR_KIND_IN_REG:
1278 return Attribute::InReg;
Tom Roeder44cb65f2014-06-05 19:29:43 +00001279 case bitc::ATTR_KIND_JUMP_TABLE:
1280 return Attribute::JumpTable;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001281 case bitc::ATTR_KIND_MIN_SIZE:
1282 return Attribute::MinSize;
1283 case bitc::ATTR_KIND_NAKED:
1284 return Attribute::Naked;
1285 case bitc::ATTR_KIND_NEST:
1286 return Attribute::Nest;
1287 case bitc::ATTR_KIND_NO_ALIAS:
1288 return Attribute::NoAlias;
1289 case bitc::ATTR_KIND_NO_BUILTIN:
1290 return Attribute::NoBuiltin;
1291 case bitc::ATTR_KIND_NO_CAPTURE:
1292 return Attribute::NoCapture;
1293 case bitc::ATTR_KIND_NO_DUPLICATE:
1294 return Attribute::NoDuplicate;
1295 case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
1296 return Attribute::NoImplicitFloat;
1297 case bitc::ATTR_KIND_NO_INLINE:
1298 return Attribute::NoInline;
James Molloye6f87ca2015-11-06 10:32:53 +00001299 case bitc::ATTR_KIND_NO_RECURSE:
1300 return Attribute::NoRecurse;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001301 case bitc::ATTR_KIND_NON_LAZY_BIND:
1302 return Attribute::NonLazyBind;
Nick Lewyckyd52b1522014-05-20 01:23:40 +00001303 case bitc::ATTR_KIND_NON_NULL:
1304 return Attribute::NonNull;
Hal Finkelb0407ba2014-07-18 15:51:28 +00001305 case bitc::ATTR_KIND_DEREFERENCEABLE:
1306 return Attribute::Dereferenceable;
Sanjoy Das31ea6d12015-04-16 20:29:50 +00001307 case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:
1308 return Attribute::DereferenceableOrNull;
George Burgess IV278199f2016-04-12 01:05:35 +00001309 case bitc::ATTR_KIND_ALLOC_SIZE:
1310 return Attribute::AllocSize;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001311 case bitc::ATTR_KIND_NO_RED_ZONE:
1312 return Attribute::NoRedZone;
1313 case bitc::ATTR_KIND_NO_RETURN:
1314 return Attribute::NoReturn;
1315 case bitc::ATTR_KIND_NO_UNWIND:
1316 return Attribute::NoUnwind;
1317 case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
1318 return Attribute::OptimizeForSize;
1319 case bitc::ATTR_KIND_OPTIMIZE_NONE:
1320 return Attribute::OptimizeNone;
1321 case bitc::ATTR_KIND_READ_NONE:
1322 return Attribute::ReadNone;
1323 case bitc::ATTR_KIND_READ_ONLY:
1324 return Attribute::ReadOnly;
1325 case bitc::ATTR_KIND_RETURNED:
1326 return Attribute::Returned;
1327 case bitc::ATTR_KIND_RETURNS_TWICE:
1328 return Attribute::ReturnsTwice;
1329 case bitc::ATTR_KIND_S_EXT:
1330 return Attribute::SExt;
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001331 case bitc::ATTR_KIND_SPECULATABLE:
1332 return Attribute::Speculatable;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001333 case bitc::ATTR_KIND_STACK_ALIGNMENT:
1334 return Attribute::StackAlignment;
1335 case bitc::ATTR_KIND_STACK_PROTECT:
1336 return Attribute::StackProtect;
1337 case bitc::ATTR_KIND_STACK_PROTECT_REQ:
1338 return Attribute::StackProtectReq;
1339 case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
1340 return Attribute::StackProtectStrong;
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001341 case bitc::ATTR_KIND_SAFESTACK:
1342 return Attribute::SafeStack;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001343 case bitc::ATTR_KIND_STRUCT_RET:
1344 return Attribute::StructRet;
1345 case bitc::ATTR_KIND_SANITIZE_ADDRESS:
1346 return Attribute::SanitizeAddress;
1347 case bitc::ATTR_KIND_SANITIZE_THREAD:
1348 return Attribute::SanitizeThread;
1349 case bitc::ATTR_KIND_SANITIZE_MEMORY:
1350 return Attribute::SanitizeMemory;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001351 case bitc::ATTR_KIND_SWIFT_ERROR:
1352 return Attribute::SwiftError;
Manman Renf46262e2016-03-29 17:37:21 +00001353 case bitc::ATTR_KIND_SWIFT_SELF:
1354 return Attribute::SwiftSelf;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001355 case bitc::ATTR_KIND_UW_TABLE:
1356 return Attribute::UWTable;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001357 case bitc::ATTR_KIND_WRITEONLY:
1358 return Attribute::WriteOnly;
Reid Klecknere9f36af2013-11-12 01:31:00 +00001359 case bitc::ATTR_KIND_Z_EXT:
1360 return Attribute::ZExt;
1361 }
1362}
1363
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001364Error BitcodeReader::parseAlignmentValue(uint64_t Exponent,
1365 unsigned &Alignment) {
JF Bastien30bf96b2015-02-22 19:32:03 +00001366 // Note: Alignment in bitcode files is incremented by 1, so that zero
1367 // can be used for default alignment.
1368 if (Exponent > Value::MaxAlignmentExponent + 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001369 return error("Invalid alignment value");
JF Bastien30bf96b2015-02-22 19:32:03 +00001370 Alignment = (1 << static_cast<unsigned>(Exponent)) >> 1;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001371 return Error::success();
JF Bastien30bf96b2015-02-22 19:32:03 +00001372}
1373
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001374Error BitcodeReader::parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind) {
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001375 *Kind = getAttrFromCode(Code);
Reid Klecknere9f36af2013-11-12 01:31:00 +00001376 if (*Kind == Attribute::None)
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001377 return error("Unknown attribute kind (" + Twine(Code) + ")");
1378 return Error::success();
Tobias Grosser0a8e12f2013-07-26 04:16:55 +00001379}
1380
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001381Error BitcodeReader::parseAttributeGroupBlock() {
Bill Wendlingba629332013-02-10 23:24:25 +00001382 if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001383 return error("Invalid record");
Bill Wendlingba629332013-02-10 23:24:25 +00001384
1385 if (!MAttributeGroups.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001386 return error("Invalid multiple blocks");
Bill Wendlingba629332013-02-10 23:24:25 +00001387
1388 SmallVector<uint64_t, 64> Record;
1389
1390 // Read all the records.
Eugene Zelenko1804a772016-08-25 00:45:04 +00001391 while (true) {
Bill Wendlingba629332013-02-10 23:24:25 +00001392 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1393
1394 switch (Entry.Kind) {
1395 case BitstreamEntry::SubBlock: // Handled for us already.
1396 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001397 return error("Malformed block");
Bill Wendlingba629332013-02-10 23:24:25 +00001398 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001399 return Error::success();
Bill Wendlingba629332013-02-10 23:24:25 +00001400 case BitstreamEntry::Record:
1401 // The interesting case.
1402 break;
1403 }
1404
1405 // Read a record.
1406 Record.clear();
1407 switch (Stream.readRecord(Entry.ID, Record)) {
1408 default: // Default behavior: ignore.
1409 break;
1410 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
1411 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001412 return error("Invalid record");
Bill Wendlingba629332013-02-10 23:24:25 +00001413
Bill Wendlinge46707e2013-02-11 22:32:29 +00001414 uint64_t GrpID = Record[0];
Bill Wendlingba629332013-02-10 23:24:25 +00001415 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
1416
1417 AttrBuilder B;
1418 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1419 if (Record[i] == 0) { // Enum attribute
Tobias Grosser0a8e12f2013-07-26 04:16:55 +00001420 Attribute::AttrKind Kind;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001421 if (Error Err = parseAttrKind(Record[++i], &Kind))
1422 return Err;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +00001423
1424 B.addAttribute(Kind);
Hal Finkele15442c2014-07-18 06:51:55 +00001425 } else if (Record[i] == 1) { // Integer attribute
Tobias Grosser0a8e12f2013-07-26 04:16:55 +00001426 Attribute::AttrKind Kind;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001427 if (Error Err = parseAttrKind(Record[++i], &Kind))
1428 return Err;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +00001429 if (Kind == Attribute::Alignment)
Bill Wendlingba629332013-02-10 23:24:25 +00001430 B.addAlignmentAttr(Record[++i]);
Hal Finkelb0407ba2014-07-18 15:51:28 +00001431 else if (Kind == Attribute::StackAlignment)
Bill Wendlingba629332013-02-10 23:24:25 +00001432 B.addStackAlignmentAttr(Record[++i]);
Hal Finkelb0407ba2014-07-18 15:51:28 +00001433 else if (Kind == Attribute::Dereferenceable)
1434 B.addDereferenceableAttr(Record[++i]);
Sanjoy Das31ea6d12015-04-16 20:29:50 +00001435 else if (Kind == Attribute::DereferenceableOrNull)
1436 B.addDereferenceableOrNullAttr(Record[++i]);
George Burgess IV278199f2016-04-12 01:05:35 +00001437 else if (Kind == Attribute::AllocSize)
1438 B.addAllocSizeAttrFromRawRepr(Record[++i]);
Bill Wendlingba629332013-02-10 23:24:25 +00001439 } else { // String attribute
Bill Wendlinge46707e2013-02-11 22:32:29 +00001440 assert((Record[i] == 3 || Record[i] == 4) &&
1441 "Invalid attribute group entry");
Bill Wendlingba629332013-02-10 23:24:25 +00001442 bool HasValue = (Record[i++] == 4);
1443 SmallString<64> KindStr;
1444 SmallString<64> ValStr;
1445
1446 while (Record[i] != 0 && i != e)
1447 KindStr += Record[i++];
Bill Wendlinge46707e2013-02-11 22:32:29 +00001448 assert(Record[i] == 0 && "Kind string not null terminated");
Bill Wendlingba629332013-02-10 23:24:25 +00001449
1450 if (HasValue) {
1451 // Has a value associated with it.
Bill Wendlinge46707e2013-02-11 22:32:29 +00001452 ++i; // Skip the '0' that terminates the "kind" string.
Bill Wendlingba629332013-02-10 23:24:25 +00001453 while (Record[i] != 0 && i != e)
1454 ValStr += Record[i++];
Bill Wendlinge46707e2013-02-11 22:32:29 +00001455 assert(Record[i] == 0 && "Value string not null terminated");
Bill Wendlingba629332013-02-10 23:24:25 +00001456 }
1457
1458 B.addAttribute(KindStr.str(), ValStr.str());
1459 }
1460 }
1461
Reid Klecknerb5180542017-03-21 16:57:19 +00001462 MAttributeGroups[GrpID] = AttributeList::get(Context, Idx, B);
Bill Wendlingba629332013-02-10 23:24:25 +00001463 break;
1464 }
1465 }
1466 }
1467}
1468
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001469Error BitcodeReader::parseTypeTable() {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001470 if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001471 return error("Invalid record");
Derek Schuff206dddd2012-02-06 19:03:04 +00001472
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001473 return parseTypeTableBody();
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001474}
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001475
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001476Error BitcodeReader::parseTypeTableBody() {
Chris Lattner1314b992007-04-22 06:23:29 +00001477 if (!TypeList.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001478 return error("Invalid multiple blocks");
Chris Lattner1314b992007-04-22 06:23:29 +00001479
1480 SmallVector<uint64_t, 64> Record;
1481 unsigned NumRecords = 0;
1482
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001483 SmallString<64> TypeName;
Derek Schuff206dddd2012-02-06 19:03:04 +00001484
Chris Lattner1314b992007-04-22 06:23:29 +00001485 // Read all the records for this type table.
Eugene Zelenko1804a772016-08-25 00:45:04 +00001486 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00001487 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
Joe Abbey97b7a172013-02-06 22:14:06 +00001488
Chris Lattner27d38752013-01-20 02:13:19 +00001489 switch (Entry.Kind) {
1490 case BitstreamEntry::SubBlock: // Handled for us already.
1491 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001492 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00001493 case BitstreamEntry::EndBlock:
Chris Lattner1314b992007-04-22 06:23:29 +00001494 if (NumRecords != TypeList.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001495 return error("Malformed block");
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001496 return Error::success();
Chris Lattner27d38752013-01-20 02:13:19 +00001497 case BitstreamEntry::Record:
1498 // The interesting case.
1499 break;
Chris Lattner1314b992007-04-22 06:23:29 +00001500 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001501
Chris Lattner1314b992007-04-22 06:23:29 +00001502 // Read a record.
1503 Record.clear();
Craig Topper2617dcc2014-04-15 06:32:26 +00001504 Type *ResultTy = nullptr;
Chris Lattner27d38752013-01-20 02:13:19 +00001505 switch (Stream.readRecord(Entry.ID, Record)) {
Rafael Espindola48da4f42013-11-04 16:16:24 +00001506 default:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001507 return error("Invalid value");
Chris Lattner1314b992007-04-22 06:23:29 +00001508 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
1509 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
1510 // type list. This allows us to reserve space.
1511 if (Record.size() < 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001512 return error("Invalid record");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001513 TypeList.resize(Record[0]);
Chris Lattner1314b992007-04-22 06:23:29 +00001514 continue;
Chris Lattner1314b992007-04-22 06:23:29 +00001515 case bitc::TYPE_CODE_VOID: // VOID
Owen Anderson55f1c092009-08-13 21:58:54 +00001516 ResultTy = Type::getVoidTy(Context);
Chris Lattner1314b992007-04-22 06:23:29 +00001517 break;
Dan Gohman518cda42011-12-17 00:04:22 +00001518 case bitc::TYPE_CODE_HALF: // HALF
1519 ResultTy = Type::getHalfTy(Context);
1520 break;
Chris Lattner1314b992007-04-22 06:23:29 +00001521 case bitc::TYPE_CODE_FLOAT: // FLOAT
Owen Anderson55f1c092009-08-13 21:58:54 +00001522 ResultTy = Type::getFloatTy(Context);
Chris Lattner1314b992007-04-22 06:23:29 +00001523 break;
1524 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
Owen Anderson55f1c092009-08-13 21:58:54 +00001525 ResultTy = Type::getDoubleTy(Context);
Chris Lattner1314b992007-04-22 06:23:29 +00001526 break;
Dale Johannesenff4c3be2007-08-03 01:03:46 +00001527 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
Owen Anderson55f1c092009-08-13 21:58:54 +00001528 ResultTy = Type::getX86_FP80Ty(Context);
Dale Johannesenff4c3be2007-08-03 01:03:46 +00001529 break;
1530 case bitc::TYPE_CODE_FP128: // FP128
Owen Anderson55f1c092009-08-13 21:58:54 +00001531 ResultTy = Type::getFP128Ty(Context);
Dale Johannesenff4c3be2007-08-03 01:03:46 +00001532 break;
1533 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
Owen Anderson55f1c092009-08-13 21:58:54 +00001534 ResultTy = Type::getPPC_FP128Ty(Context);
Dale Johannesenff4c3be2007-08-03 01:03:46 +00001535 break;
Chris Lattner1314b992007-04-22 06:23:29 +00001536 case bitc::TYPE_CODE_LABEL: // LABEL
Owen Anderson55f1c092009-08-13 21:58:54 +00001537 ResultTy = Type::getLabelTy(Context);
Chris Lattner1314b992007-04-22 06:23:29 +00001538 break;
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001539 case bitc::TYPE_CODE_METADATA: // METADATA
Owen Anderson55f1c092009-08-13 21:58:54 +00001540 ResultTy = Type::getMetadataTy(Context);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001541 break;
Dale Johannesenbaa5d042010-09-10 20:55:01 +00001542 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
1543 ResultTy = Type::getX86_MMXTy(Context);
1544 break;
David Majnemerb611e3f2015-08-14 05:09:07 +00001545 case bitc::TYPE_CODE_TOKEN: // TOKEN
1546 ResultTy = Type::getTokenTy(Context);
1547 break;
Filipe Cabecinhasfcd044b2015-01-30 18:13:50 +00001548 case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
Chris Lattner1314b992007-04-22 06:23:29 +00001549 if (Record.size() < 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001550 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001551
Filipe Cabecinhasfcd044b2015-01-30 18:13:50 +00001552 uint64_t NumBits = Record[0];
1553 if (NumBits < IntegerType::MIN_INT_BITS ||
1554 NumBits > IntegerType::MAX_INT_BITS)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001555 return error("Bitwidth for integer type out of range");
Filipe Cabecinhasfcd044b2015-01-30 18:13:50 +00001556 ResultTy = IntegerType::get(Context, NumBits);
Chris Lattner1314b992007-04-22 06:23:29 +00001557 break;
Filipe Cabecinhasfcd044b2015-01-30 18:13:50 +00001558 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001559 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
Christopher Lamb54dd24c2007-12-11 08:59:05 +00001560 // [pointee type, address space]
Chris Lattner1314b992007-04-22 06:23:29 +00001561 if (Record.size() < 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001562 return error("Invalid record");
Christopher Lamb54dd24c2007-12-11 08:59:05 +00001563 unsigned AddressSpace = 0;
1564 if (Record.size() == 2)
1565 AddressSpace = Record[1];
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001566 ResultTy = getTypeByID(Record[0]);
Filipe Cabecinhasd8a1bcd2015-04-29 02:27:28 +00001567 if (!ResultTy ||
1568 !PointerType::isValidElementType(ResultTy))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001569 return error("Invalid type");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001570 ResultTy = PointerType::get(ResultTy, AddressSpace);
Chris Lattner1314b992007-04-22 06:23:29 +00001571 break;
Christopher Lamb54dd24c2007-12-11 08:59:05 +00001572 }
Nuno Lopes561dae02012-05-23 15:19:39 +00001573 case bitc::TYPE_CODE_FUNCTION_OLD: {
1574 // FIXME: attrid is dead, remove it in LLVM 4.0
1575 // FUNCTION: [vararg, attrid, retty, paramty x N]
1576 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001577 return error("Invalid record");
Nuno Lopes561dae02012-05-23 15:19:39 +00001578 SmallVector<Type*, 8> ArgTys;
1579 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
1580 if (Type *T = getTypeByID(Record[i]))
1581 ArgTys.push_back(T);
1582 else
1583 break;
1584 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001585
Nuno Lopes561dae02012-05-23 15:19:39 +00001586 ResultTy = getTypeByID(Record[2]);
Craig Topper2617dcc2014-04-15 06:32:26 +00001587 if (!ResultTy || ArgTys.size() < Record.size()-3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001588 return error("Invalid type");
Nuno Lopes561dae02012-05-23 15:19:39 +00001589
1590 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1591 break;
1592 }
Chad Rosier95898722011-11-03 00:14:01 +00001593 case bitc::TYPE_CODE_FUNCTION: {
1594 // FUNCTION: [vararg, retty, paramty x N]
1595 if (Record.size() < 2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001596 return error("Invalid record");
Chris Lattnercc3aaf12012-01-27 03:15:49 +00001597 SmallVector<Type*, 8> ArgTys;
Chad Rosier95898722011-11-03 00:14:01 +00001598 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
Filipe Cabecinhas32af5422015-05-19 01:21:06 +00001599 if (Type *T = getTypeByID(Record[i])) {
1600 if (!FunctionType::isValidArgumentType(T))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001601 return error("Invalid function argument type");
Chad Rosier95898722011-11-03 00:14:01 +00001602 ArgTys.push_back(T);
Filipe Cabecinhas32af5422015-05-19 01:21:06 +00001603 }
Chad Rosier95898722011-11-03 00:14:01 +00001604 else
1605 break;
1606 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001607
Chad Rosier95898722011-11-03 00:14:01 +00001608 ResultTy = getTypeByID(Record[1]);
Craig Topper2617dcc2014-04-15 06:32:26 +00001609 if (!ResultTy || ArgTys.size() < Record.size()-2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001610 return error("Invalid type");
Chad Rosier95898722011-11-03 00:14:01 +00001611
1612 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1613 break;
1614 }
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001615 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
Chris Lattner3c5616e2007-05-06 08:21:50 +00001616 if (Record.size() < 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001617 return error("Invalid record");
Chris Lattnercc3aaf12012-01-27 03:15:49 +00001618 SmallVector<Type*, 8> EltTys;
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001619 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1620 if (Type *T = getTypeByID(Record[i]))
1621 EltTys.push_back(T);
1622 else
1623 break;
1624 }
1625 if (EltTys.size() != Record.size()-1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001626 return error("Invalid type");
Owen Anderson03cb69f2009-08-05 23:16:16 +00001627 ResultTy = StructType::get(Context, EltTys, Record[0]);
Chris Lattner1314b992007-04-22 06:23:29 +00001628 break;
1629 }
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001630 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001631 if (convertToString(Record, 0, TypeName))
1632 return error("Invalid record");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001633 continue;
1634
1635 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1636 if (Record.size() < 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001637 return error("Invalid record");
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001638
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001639 if (NumRecords >= TypeList.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001640 return error("Invalid TYPE table");
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001641
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001642 // Check to see if this was forward referenced, if so fill in the temp.
1643 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1644 if (Res) {
1645 Res->setName(TypeName);
Craig Topper2617dcc2014-04-15 06:32:26 +00001646 TypeList[NumRecords] = nullptr;
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001647 } else // Otherwise, create a new struct.
Rafael Espindola2fa1e432014-12-03 07:18:23 +00001648 Res = createIdentifiedStructType(Context, TypeName);
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001649 TypeName.clear();
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001650
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001651 SmallVector<Type*, 8> EltTys;
1652 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1653 if (Type *T = getTypeByID(Record[i]))
1654 EltTys.push_back(T);
1655 else
1656 break;
1657 }
1658 if (EltTys.size() != Record.size()-1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001659 return error("Invalid record");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001660 Res->setBody(EltTys, Record[0]);
1661 ResultTy = Res;
1662 break;
1663 }
1664 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
1665 if (Record.size() != 1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001666 return error("Invalid record");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001667
1668 if (NumRecords >= TypeList.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001669 return error("Invalid TYPE table");
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001670
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001671 // Check to see if this was forward referenced, if so fill in the temp.
1672 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1673 if (Res) {
1674 Res->setName(TypeName);
Craig Topper2617dcc2014-04-15 06:32:26 +00001675 TypeList[NumRecords] = nullptr;
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001676 } else // Otherwise, create a new struct with no body.
Rafael Espindola2fa1e432014-12-03 07:18:23 +00001677 Res = createIdentifiedStructType(Context, TypeName);
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001678 TypeName.clear();
1679 ResultTy = Res;
1680 break;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001681 }
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001682 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
1683 if (Record.size() < 2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001684 return error("Invalid record");
Filipe Cabecinhas6fe8aab2015-04-29 02:36:08 +00001685 ResultTy = getTypeByID(Record[1]);
1686 if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001687 return error("Invalid type");
Filipe Cabecinhas6fe8aab2015-04-29 02:36:08 +00001688 ResultTy = ArrayType::get(ResultTy, Record[0]);
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001689 break;
1690 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty]
1691 if (Record.size() < 2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001692 return error("Invalid record");
Filipe Cabecinhas8e421902015-06-03 00:05:30 +00001693 if (Record[0] == 0)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001694 return error("Invalid vector length");
Filipe Cabecinhas6fe8aab2015-04-29 02:36:08 +00001695 ResultTy = getTypeByID(Record[1]);
1696 if (!ResultTy || !StructType::isValidElementType(ResultTy))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001697 return error("Invalid type");
Filipe Cabecinhas6fe8aab2015-04-29 02:36:08 +00001698 ResultTy = VectorType::get(ResultTy, Record[0]);
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001699 break;
1700 }
1701
1702 if (NumRecords >= TypeList.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001703 return error("Invalid TYPE table");
Filipe Cabecinhasd0858e12015-01-30 10:57:58 +00001704 if (TypeList[NumRecords])
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001705 return error(
Filipe Cabecinhasd0858e12015-01-30 10:57:58 +00001706 "Invalid TYPE table: Only named structs can be forward referenced");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001707 assert(ResultTy && "Didn't read a type?");
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001708 TypeList[NumRecords++] = ResultTy;
1709 }
1710}
1711
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001712Error BitcodeReader::parseOperandBundleTags() {
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00001713 if (Stream.EnterSubBlock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID))
1714 return error("Invalid record");
1715
1716 if (!BundleTags.empty())
1717 return error("Invalid multiple blocks");
1718
1719 SmallVector<uint64_t, 64> Record;
1720
Eugene Zelenko1804a772016-08-25 00:45:04 +00001721 while (true) {
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00001722 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1723
1724 switch (Entry.Kind) {
1725 case BitstreamEntry::SubBlock: // Handled for us already.
1726 case BitstreamEntry::Error:
1727 return error("Malformed block");
1728 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001729 return Error::success();
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00001730 case BitstreamEntry::Record:
1731 // The interesting case.
1732 break;
1733 }
1734
1735 // Tags are implicitly mapped to integers by their order.
1736
1737 if (Stream.readRecord(Entry.ID, Record) != bitc::OPERAND_BUNDLE_TAG)
1738 return error("Invalid record");
1739
1740 // OPERAND_BUNDLE_TAG: [strchr x N]
1741 BundleTags.emplace_back();
1742 if (convertToString(Record, 0, BundleTags.back()))
1743 return error("Invalid record");
1744 Record.clear();
1745 }
1746}
1747
Teresa Johnsonff642b92015-09-17 20:12:00 +00001748/// Associate a value with its name from the given index in the provided record.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001749Expected<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,
1750 unsigned NameIndex, Triple &TT) {
Teresa Johnsonff642b92015-09-17 20:12:00 +00001751 SmallString<128> ValueName;
1752 if (convertToString(Record, NameIndex, ValueName))
1753 return error("Invalid record");
1754 unsigned ValueID = Record[0];
1755 if (ValueID >= ValueList.size() || !ValueList[ValueID])
1756 return error("Invalid record");
1757 Value *V = ValueList[ValueID];
1758
Filipe Cabecinhasa2b0ac42015-11-04 14:53:36 +00001759 StringRef NameStr(ValueName.data(), ValueName.size());
1760 if (NameStr.find_first_of(0) != StringRef::npos)
1761 return error("Invalid value name");
1762 V->setName(NameStr);
Teresa Johnsonff642b92015-09-17 20:12:00 +00001763 auto *GO = dyn_cast<GlobalObject>(V);
1764 if (GO) {
1765 if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1766 if (TT.isOSBinFormatMachO())
1767 GO->setComdat(nullptr);
1768 else
1769 GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1770 }
1771 }
1772 return V;
1773}
1774
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00001775/// Helper to note and return the current location, and jump to the given
1776/// offset.
1777static uint64_t jumpToValueSymbolTable(uint64_t Offset,
1778 BitstreamCursor &Stream) {
1779 // Save the current parsing location so we can jump back at the end
1780 // of the VST read.
1781 uint64_t CurrentBit = Stream.GetCurrentBitNo();
1782 Stream.JumpToBit(Offset * 32);
1783#ifndef NDEBUG
1784 // Do some checking if we are in debug mode.
1785 BitstreamEntry Entry = Stream.advance();
1786 assert(Entry.Kind == BitstreamEntry::SubBlock);
1787 assert(Entry.ID == bitc::VALUE_SYMTAB_BLOCK_ID);
1788#else
1789 // In NDEBUG mode ignore the output so we don't get an unused variable
1790 // warning.
1791 Stream.advance();
1792#endif
1793 return CurrentBit;
1794}
1795
Peter Collingbournea0f371a2017-04-17 17:51:36 +00001796void BitcodeReader::setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta,
1797 Function *F,
1798 ArrayRef<uint64_t> Record) {
1799 // Note that we subtract 1 here because the offset is relative to one word
1800 // before the start of the identification or module block, which was
1801 // historically always the start of the regular bitcode header.
1802 uint64_t FuncWordOffset = Record[1] - 1;
1803 uint64_t FuncBitOffset = FuncWordOffset * 32;
1804 DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;
1805 // Set the LastFunctionBlockBit to point to the last function block.
1806 // Later when parsing is resumed after function materialization,
1807 // we can simply skip that last function block.
1808 if (FuncBitOffset > LastFunctionBlockBit)
1809 LastFunctionBlockBit = FuncBitOffset;
1810}
1811
1812/// Read a new-style GlobalValue symbol table.
1813Error BitcodeReader::parseGlobalValueSymbolTable() {
1814 unsigned FuncBitcodeOffsetDelta =
1815 Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
1816
1817 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1818 return error("Invalid record");
1819
1820 SmallVector<uint64_t, 64> Record;
1821 while (true) {
1822 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1823
1824 switch (Entry.Kind) {
1825 case BitstreamEntry::SubBlock:
1826 case BitstreamEntry::Error:
1827 return error("Malformed block");
1828 case BitstreamEntry::EndBlock:
1829 return Error::success();
1830 case BitstreamEntry::Record:
1831 break;
1832 }
1833
1834 Record.clear();
1835 switch (Stream.readRecord(Entry.ID, Record)) {
1836 case bitc::VST_CODE_FNENTRY: // [valueid, offset]
1837 setDeferredFunctionInfo(FuncBitcodeOffsetDelta,
1838 cast<Function>(ValueList[Record[0]]), Record);
1839 break;
1840 }
1841 }
1842}
1843
Teresa Johnsonff642b92015-09-17 20:12:00 +00001844/// Parse the value symbol table at either the current parsing location or
1845/// at the given bit offset if provided.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001846Error BitcodeReader::parseValueSymbolTable(uint64_t Offset) {
Teresa Johnsonff642b92015-09-17 20:12:00 +00001847 uint64_t CurrentBit;
1848 // Pass in the Offset to distinguish between calling for the module-level
1849 // VST (where we want to jump to the VST offset) and the function-level
1850 // VST (where we don't).
Peter Collingbournea0f371a2017-04-17 17:51:36 +00001851 if (Offset > 0) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00001852 CurrentBit = jumpToValueSymbolTable(Offset, Stream);
Peter Collingbournea0f371a2017-04-17 17:51:36 +00001853 // If this module uses a string table, read this as a module-level VST.
1854 if (UseStrtab) {
1855 if (Error Err = parseGlobalValueSymbolTable())
1856 return Err;
1857 Stream.JumpToBit(CurrentBit);
1858 return Error::success();
1859 }
1860 // Otherwise, the VST will be in a similar format to a function-level VST,
1861 // and will contain symbol names.
1862 }
Teresa Johnsonff642b92015-09-17 20:12:00 +00001863
1864 // Compute the delta between the bitcode indices in the VST (the word offset
1865 // to the word-aligned ENTER_SUBBLOCK for the function block, and that
1866 // expected by the lazy reader. The reader's EnterSubBlock expects to have
1867 // already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID
1868 // (size BlockIDWidth). Note that we access the stream's AbbrevID width here
1869 // just before entering the VST subblock because: 1) the EnterSubBlock
1870 // changes the AbbrevID width; 2) the VST block is nested within the same
1871 // outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same
1872 // AbbrevID width before calling EnterSubBlock; and 3) when we want to
1873 // jump to the FUNCTION_BLOCK using this offset later, we don't want
1874 // to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.
1875 unsigned FuncBitcodeOffsetDelta =
1876 Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;
1877
Chris Lattner982ec1e2007-05-05 00:17:00 +00001878 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001879 return error("Invalid record");
Chris Lattnerccaa4482007-04-23 21:26:05 +00001880
1881 SmallVector<uint64_t, 64> Record;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001882
David Majnemer3087b222015-01-20 05:58:07 +00001883 Triple TT(TheModule->getTargetTriple());
1884
Chris Lattnerccaa4482007-04-23 21:26:05 +00001885 // Read all the records for this value table.
1886 SmallString<128> ValueName;
Eugene Zelenko1804a772016-08-25 00:45:04 +00001887
1888 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00001889 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
Joe Abbey97b7a172013-02-06 22:14:06 +00001890
Chris Lattner27d38752013-01-20 02:13:19 +00001891 switch (Entry.Kind) {
1892 case BitstreamEntry::SubBlock: // Handled for us already.
1893 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001894 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00001895 case BitstreamEntry::EndBlock:
Teresa Johnsonff642b92015-09-17 20:12:00 +00001896 if (Offset > 0)
1897 Stream.JumpToBit(CurrentBit);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001898 return Error::success();
Chris Lattner27d38752013-01-20 02:13:19 +00001899 case BitstreamEntry::Record:
1900 // The interesting case.
1901 break;
Chris Lattnerccaa4482007-04-23 21:26:05 +00001902 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001903
Chris Lattnerccaa4482007-04-23 21:26:05 +00001904 // Read a record.
1905 Record.clear();
Chris Lattner27d38752013-01-20 02:13:19 +00001906 switch (Stream.readRecord(Entry.ID, Record)) {
Chris Lattnerccaa4482007-04-23 21:26:05 +00001907 default: // Default behavior: unknown type.
1908 break;
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00001909 case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001910 Expected<Value *> ValOrErr = recordValue(Record, 1, TT);
1911 if (Error Err = ValOrErr.takeError())
1912 return Err;
Teresa Johnsonff642b92015-09-17 20:12:00 +00001913 ValOrErr.get();
1914 break;
1915 }
1916 case bitc::VST_CODE_FNENTRY: {
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00001917 // VST_CODE_FNENTRY: [valueid, offset, namechar x N]
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001918 Expected<Value *> ValOrErr = recordValue(Record, 2, TT);
1919 if (Error Err = ValOrErr.takeError())
1920 return Err;
Teresa Johnsonff642b92015-09-17 20:12:00 +00001921 Value *V = ValOrErr.get();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001922
Peter Collingbournedb4cafa2017-04-06 19:39:24 +00001923 // Ignore function offsets emitted for aliases of functions in older
1924 // versions of LLVM.
Peter Collingbournea0f371a2017-04-17 17:51:36 +00001925 if (auto *F = dyn_cast<Function>(V))
1926 setDeferredFunctionInfo(FuncBitcodeOffsetDelta, F, Record);
Chris Lattnerccaa4482007-04-23 21:26:05 +00001927 break;
Reid Spencerdea02bd2007-05-04 01:43:33 +00001928 }
Bill Wendling35a9c3c2011-04-10 23:18:04 +00001929 case bitc::VST_CODE_BBENTRY: {
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001930 if (convertToString(Record, 1, ValueName))
1931 return error("Invalid record");
Chris Lattner6be58c62007-05-03 22:18:21 +00001932 BasicBlock *BB = getBasicBlock(Record[0]);
Craig Topper2617dcc2014-04-15 06:32:26 +00001933 if (!BB)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001934 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001935
Daniel Dunbard786b512009-07-26 00:34:27 +00001936 BB->setName(StringRef(ValueName.data(), ValueName.size()));
Chris Lattner6be58c62007-05-03 22:18:21 +00001937 ValueName.clear();
1938 break;
Chris Lattnerccaa4482007-04-23 21:26:05 +00001939 }
Reid Spencerdea02bd2007-05-04 01:43:33 +00001940 }
Chris Lattnerccaa4482007-04-23 21:26:05 +00001941 }
1942}
1943
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001944/// Decode a signed value stored with the sign bit in the LSB for dense VBR
1945/// encoding.
Jan Wen Voungafaced02012-10-11 20:20:40 +00001946uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
Chris Lattner08feb1e2007-04-24 04:04:35 +00001947 if ((V & 1) == 0)
1948 return V >> 1;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001949 if (V != 1)
Chris Lattner08feb1e2007-04-24 04:04:35 +00001950 return -(V >> 1);
1951 // There is no such thing as -0 with integers. "-0" really means MININT.
1952 return 1ULL << 63;
1953}
1954
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001955/// Resolve all of the initializers for global values and aliases that we can.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00001956Error BitcodeReader::resolveGlobalAndIndirectSymbolInits() {
Chris Lattner44c17072007-04-26 02:46:40 +00001957 std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001958 std::vector<std::pair<GlobalIndirectSymbol*, unsigned> >
1959 IndirectSymbolInitWorklist;
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001960 std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001961 std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
David Majnemer7fddecc2015-06-17 20:52:32 +00001962 std::vector<std::pair<Function*, unsigned> > FunctionPersonalityFnWorklist;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001963
Chris Lattner44c17072007-04-26 02:46:40 +00001964 GlobalInitWorklist.swap(GlobalInits);
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001965 IndirectSymbolInitWorklist.swap(IndirectSymbolInits);
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001966 FunctionPrefixWorklist.swap(FunctionPrefixes);
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001967 FunctionPrologueWorklist.swap(FunctionPrologues);
David Majnemer7fddecc2015-06-17 20:52:32 +00001968 FunctionPersonalityFnWorklist.swap(FunctionPersonalityFns);
Chris Lattner44c17072007-04-26 02:46:40 +00001969
1970 while (!GlobalInitWorklist.empty()) {
Chris Lattner831d4202007-04-26 03:27:58 +00001971 unsigned ValID = GlobalInitWorklist.back().second;
Chris Lattner44c17072007-04-26 02:46:40 +00001972 if (ValID >= ValueList.size()) {
1973 // Not ready to resolve this yet, it requires something later in the file.
Chris Lattner831d4202007-04-26 03:27:58 +00001974 GlobalInits.push_back(GlobalInitWorklist.back());
Chris Lattner44c17072007-04-26 02:46:40 +00001975 } else {
Karthik Bhat82540e92014-03-27 12:08:23 +00001976 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
Chris Lattner44c17072007-04-26 02:46:40 +00001977 GlobalInitWorklist.back().first->setInitializer(C);
1978 else
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001979 return error("Expected a constant");
Chris Lattner44c17072007-04-26 02:46:40 +00001980 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001981 GlobalInitWorklist.pop_back();
Chris Lattner44c17072007-04-26 02:46:40 +00001982 }
1983
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001984 while (!IndirectSymbolInitWorklist.empty()) {
1985 unsigned ValID = IndirectSymbolInitWorklist.back().second;
Chris Lattner44c17072007-04-26 02:46:40 +00001986 if (ValID >= ValueList.size()) {
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001987 IndirectSymbolInits.push_back(IndirectSymbolInitWorklist.back());
Chris Lattner44c17072007-04-26 02:46:40 +00001988 } else {
Filipe Cabecinhasa911af02015-06-06 20:44:53 +00001989 Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]);
1990 if (!C)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001991 return error("Expected a constant");
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001992 GlobalIndirectSymbol *GIS = IndirectSymbolInitWorklist.back().first;
1993 if (isa<GlobalAlias>(GIS) && C->getType() != GIS->getType())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00001994 return error("Alias and aliasee types don't match");
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001995 GIS->setIndirectSymbol(C);
Chris Lattner44c17072007-04-26 02:46:40 +00001996 }
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001997 IndirectSymbolInitWorklist.pop_back();
Chris Lattner44c17072007-04-26 02:46:40 +00001998 }
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001999
2000 while (!FunctionPrefixWorklist.empty()) {
2001 unsigned ValID = FunctionPrefixWorklist.back().second;
2002 if (ValID >= ValueList.size()) {
2003 FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
2004 } else {
Karthik Bhat82540e92014-03-27 12:08:23 +00002005 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00002006 FunctionPrefixWorklist.back().first->setPrefixData(C);
2007 else
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002008 return error("Expected a constant");
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00002009 }
2010 FunctionPrefixWorklist.pop_back();
2011 }
2012
Peter Collingbourne51d2de72014-12-03 02:08:38 +00002013 while (!FunctionPrologueWorklist.empty()) {
2014 unsigned ValID = FunctionPrologueWorklist.back().second;
2015 if (ValID >= ValueList.size()) {
2016 FunctionPrologues.push_back(FunctionPrologueWorklist.back());
2017 } else {
2018 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2019 FunctionPrologueWorklist.back().first->setPrologueData(C);
2020 else
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002021 return error("Expected a constant");
Peter Collingbourne51d2de72014-12-03 02:08:38 +00002022 }
2023 FunctionPrologueWorklist.pop_back();
2024 }
2025
David Majnemer7fddecc2015-06-17 20:52:32 +00002026 while (!FunctionPersonalityFnWorklist.empty()) {
2027 unsigned ValID = FunctionPersonalityFnWorklist.back().second;
2028 if (ValID >= ValueList.size()) {
2029 FunctionPersonalityFns.push_back(FunctionPersonalityFnWorklist.back());
2030 } else {
2031 if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
2032 FunctionPersonalityFnWorklist.back().first->setPersonalityFn(C);
2033 else
2034 return error("Expected a constant");
2035 }
2036 FunctionPersonalityFnWorklist.pop_back();
2037 }
2038
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002039 return Error::success();
Chris Lattner44c17072007-04-26 02:46:40 +00002040}
2041
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002042static APInt readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
Benjamin Kramer9704ed02012-05-28 14:10:31 +00002043 SmallVector<uint64_t, 8> Words(Vals.size());
David Majnemer2d006e72016-08-12 04:32:42 +00002044 transform(Vals, Words.begin(),
Jan Wen Voungafaced02012-10-11 20:20:40 +00002045 BitcodeReader::decodeSignRotatedValue);
Benjamin Kramer9704ed02012-05-28 14:10:31 +00002046
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00002047 return APInt(TypeBits, Words);
2048}
2049
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002050Error BitcodeReader::parseConstants() {
Chris Lattner982ec1e2007-05-05 00:17:00 +00002051 if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002052 return error("Invalid record");
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002053
2054 SmallVector<uint64_t, 64> Record;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002055
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002056 // Read all the records for this value table.
Chris Lattner229907c2011-07-18 04:54:35 +00002057 Type *CurTy = Type::getInt32Ty(Context);
Chris Lattner1663cca2007-04-24 05:48:56 +00002058 unsigned NextCstNo = ValueList.size();
Eugene Zelenko1804a772016-08-25 00:45:04 +00002059
2060 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00002061 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
Joe Abbey97b7a172013-02-06 22:14:06 +00002062
Chris Lattner27d38752013-01-20 02:13:19 +00002063 switch (Entry.Kind) {
2064 case BitstreamEntry::SubBlock: // Handled for us already.
2065 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002066 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00002067 case BitstreamEntry::EndBlock:
2068 if (NextCstNo != ValueList.size())
George Burgess IV1030d682016-01-20 22:15:23 +00002069 return error("Invalid constant reference");
Joe Abbey97b7a172013-02-06 22:14:06 +00002070
Chris Lattner27d38752013-01-20 02:13:19 +00002071 // Once all the constants have been read, go through and resolve forward
2072 // references.
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002073 ValueList.resolveConstantForwardRefs();
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002074 return Error::success();
Chris Lattner27d38752013-01-20 02:13:19 +00002075 case BitstreamEntry::Record:
2076 // The interesting case.
Chris Lattner74429932008-08-21 02:34:16 +00002077 break;
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002078 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002079
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002080 // Read a record.
2081 Record.clear();
Filipe Cabecinhas2849b482016-06-05 18:43:17 +00002082 Type *VoidType = Type::getVoidTy(Context);
Craig Topper2617dcc2014-04-15 06:32:26 +00002083 Value *V = nullptr;
Chris Lattner27d38752013-01-20 02:13:19 +00002084 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
Dan Gohman0ebd6962009-07-20 21:19:07 +00002085 switch (BitCode) {
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002086 default: // Default behavior: unknown constant
2087 case bitc::CST_CODE_UNDEF: // UNDEF
Owen Andersonb292b8c2009-07-30 23:03:37 +00002088 V = UndefValue::get(CurTy);
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002089 break;
2090 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
2091 if (Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002092 return error("Invalid record");
Karthik Bhat82540e92014-03-27 12:08:23 +00002093 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002094 return error("Invalid record");
Filipe Cabecinhas2849b482016-06-05 18:43:17 +00002095 if (TypeList[Record[0]] == VoidType)
2096 return error("Invalid constant type");
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002097 CurTy = TypeList[Record[0]];
Chris Lattner08feb1e2007-04-24 04:04:35 +00002098 continue; // Skip the ValueList manipulation.
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002099 case bitc::CST_CODE_NULL: // NULL
Owen Anderson5a1acd92009-07-31 20:28:14 +00002100 V = Constant::getNullValue(CurTy);
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002101 break;
2102 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
Duncan Sands19d0b472010-02-16 11:11:14 +00002103 if (!CurTy->isIntegerTy() || Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002104 return error("Invalid record");
Jan Wen Voungafaced02012-10-11 20:20:40 +00002105 V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
Chris Lattner08feb1e2007-04-24 04:04:35 +00002106 break;
Chris Lattnere14cb882007-05-04 19:11:41 +00002107 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
Duncan Sands19d0b472010-02-16 11:11:14 +00002108 if (!CurTy->isIntegerTy() || Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002109 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002110
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002111 APInt VInt =
2112 readWideAPInt(Record, cast<IntegerType>(CurTy)->getBitWidth());
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00002113 V = ConstantInt::get(Context, VInt);
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002114
Chris Lattner08feb1e2007-04-24 04:04:35 +00002115 break;
2116 }
Dale Johannesen245dceb2007-09-11 18:32:33 +00002117 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
Chris Lattner08feb1e2007-04-24 04:04:35 +00002118 if (Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002119 return error("Invalid record");
Dan Gohman518cda42011-12-17 00:04:22 +00002120 if (CurTy->isHalfTy())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00002121 V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf(),
Tim Northover29178a32013-01-22 09:46:31 +00002122 APInt(16, (uint16_t)Record[0])));
Dan Gohman518cda42011-12-17 00:04:22 +00002123 else if (CurTy->isFloatTy())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00002124 V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle(),
Tim Northover29178a32013-01-22 09:46:31 +00002125 APInt(32, (uint32_t)Record[0])));
Chris Lattnerfdd87902009-10-05 05:54:46 +00002126 else if (CurTy->isDoubleTy())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00002127 V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble(),
Tim Northover29178a32013-01-22 09:46:31 +00002128 APInt(64, Record[0])));
Chris Lattnerfdd87902009-10-05 05:54:46 +00002129 else if (CurTy->isX86_FP80Ty()) {
Dale Johannesen93eefa02009-03-23 21:16:53 +00002130 // Bits are not stored the same way as a normal i80 APInt, compensate.
2131 uint64_t Rearrange[2];
2132 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
2133 Rearrange[1] = Record[0] >> 48;
Stephan Bergmann17c7f702016-12-14 11:57:17 +00002134 V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended(),
Tim Northover29178a32013-01-22 09:46:31 +00002135 APInt(80, Rearrange)));
Chris Lattnerfdd87902009-10-05 05:54:46 +00002136 } else if (CurTy->isFP128Ty())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00002137 V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad(),
Tim Northover29178a32013-01-22 09:46:31 +00002138 APInt(128, Record)));
Chris Lattnerfdd87902009-10-05 05:54:46 +00002139 else if (CurTy->isPPC_FP128Ty())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00002140 V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble(),
Tim Northover29178a32013-01-22 09:46:31 +00002141 APInt(128, Record)));
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002142 else
Owen Andersonb292b8c2009-07-30 23:03:37 +00002143 V = UndefValue::get(CurTy);
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002144 break;
Dale Johannesen245dceb2007-09-11 18:32:33 +00002145 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002146
Chris Lattnere14cb882007-05-04 19:11:41 +00002147 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
2148 if (Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002149 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002150
Chris Lattnere14cb882007-05-04 19:11:41 +00002151 unsigned Size = Record.size();
Chris Lattnercc3aaf12012-01-27 03:15:49 +00002152 SmallVector<Constant*, 16> Elts;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002153
Chris Lattner229907c2011-07-18 04:54:35 +00002154 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
Chris Lattner1663cca2007-04-24 05:48:56 +00002155 for (unsigned i = 0; i != Size; ++i)
Chris Lattnere14cb882007-05-04 19:11:41 +00002156 Elts.push_back(ValueList.getConstantFwdRef(Record[i],
Chris Lattner1663cca2007-04-24 05:48:56 +00002157 STy->getElementType(i)));
Owen Anderson45308b52009-07-27 22:29:26 +00002158 V = ConstantStruct::get(STy, Elts);
Chris Lattner229907c2011-07-18 04:54:35 +00002159 } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
2160 Type *EltTy = ATy->getElementType();
Chris Lattner1663cca2007-04-24 05:48:56 +00002161 for (unsigned i = 0; i != Size; ++i)
Chris Lattnere14cb882007-05-04 19:11:41 +00002162 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
Owen Andersonc2c79322009-07-28 18:32:17 +00002163 V = ConstantArray::get(ATy, Elts);
Chris Lattner229907c2011-07-18 04:54:35 +00002164 } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
2165 Type *EltTy = VTy->getElementType();
Chris Lattner1663cca2007-04-24 05:48:56 +00002166 for (unsigned i = 0; i != Size; ++i)
Chris Lattnere14cb882007-05-04 19:11:41 +00002167 Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
Owen Anderson4aa32952009-07-28 21:19:26 +00002168 V = ConstantVector::get(Elts);
Chris Lattner1663cca2007-04-24 05:48:56 +00002169 } else {
Owen Andersonb292b8c2009-07-30 23:03:37 +00002170 V = UndefValue::get(CurTy);
Chris Lattner1663cca2007-04-24 05:48:56 +00002171 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002172 break;
2173 }
Chris Lattnerbb8278a2012-02-05 02:41:35 +00002174 case bitc::CST_CODE_STRING: // STRING: [values]
Chris Lattnerf25f7102007-05-06 00:53:07 +00002175 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
2176 if (Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002177 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002178
Benjamin Kramer9704ed02012-05-28 14:10:31 +00002179 SmallString<16> Elts(Record.begin(), Record.end());
Chris Lattnerbb8278a2012-02-05 02:41:35 +00002180 V = ConstantDataArray::getString(Context, Elts,
2181 BitCode == bitc::CST_CODE_CSTRING);
Chris Lattnerf25f7102007-05-06 00:53:07 +00002182 break;
2183 }
Chris Lattner372dd1e2012-01-30 00:51:16 +00002184 case bitc::CST_CODE_DATA: {// DATA: [n x value]
2185 if (Record.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002186 return error("Invalid record");
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002187
Chris Lattner372dd1e2012-01-30 00:51:16 +00002188 Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
Chris Lattner372dd1e2012-01-30 00:51:16 +00002189 if (EltTy->isIntegerTy(8)) {
2190 SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
2191 if (isa<VectorType>(CurTy))
2192 V = ConstantDataVector::get(Context, Elts);
2193 else
2194 V = ConstantDataArray::get(Context, Elts);
2195 } else if (EltTy->isIntegerTy(16)) {
2196 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2197 if (isa<VectorType>(CurTy))
2198 V = ConstantDataVector::get(Context, Elts);
2199 else
2200 V = ConstantDataArray::get(Context, Elts);
2201 } else if (EltTy->isIntegerTy(32)) {
2202 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
2203 if (isa<VectorType>(CurTy))
2204 V = ConstantDataVector::get(Context, Elts);
2205 else
2206 V = ConstantDataArray::get(Context, Elts);
2207 } else if (EltTy->isIntegerTy(64)) {
2208 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
2209 if (isa<VectorType>(CurTy))
2210 V = ConstantDataVector::get(Context, Elts);
2211 else
2212 V = ConstantDataArray::get(Context, Elts);
Justin Bognera43eacb2016-01-06 22:31:32 +00002213 } else if (EltTy->isHalfTy()) {
2214 SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
2215 if (isa<VectorType>(CurTy))
2216 V = ConstantDataVector::getFP(Context, Elts);
2217 else
2218 V = ConstantDataArray::getFP(Context, Elts);
Chris Lattner372dd1e2012-01-30 00:51:16 +00002219 } else if (EltTy->isFloatTy()) {
Justin Bognera43eacb2016-01-06 22:31:32 +00002220 SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
Chris Lattner372dd1e2012-01-30 00:51:16 +00002221 if (isa<VectorType>(CurTy))
Justin Bognera43eacb2016-01-06 22:31:32 +00002222 V = ConstantDataVector::getFP(Context, Elts);
Chris Lattner372dd1e2012-01-30 00:51:16 +00002223 else
Justin Bognera43eacb2016-01-06 22:31:32 +00002224 V = ConstantDataArray::getFP(Context, Elts);
Chris Lattner372dd1e2012-01-30 00:51:16 +00002225 } else if (EltTy->isDoubleTy()) {
Justin Bognera43eacb2016-01-06 22:31:32 +00002226 SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
Chris Lattner372dd1e2012-01-30 00:51:16 +00002227 if (isa<VectorType>(CurTy))
Justin Bognera43eacb2016-01-06 22:31:32 +00002228 V = ConstantDataVector::getFP(Context, Elts);
Chris Lattner372dd1e2012-01-30 00:51:16 +00002229 else
Justin Bognera43eacb2016-01-06 22:31:32 +00002230 V = ConstantDataArray::getFP(Context, Elts);
Chris Lattner372dd1e2012-01-30 00:51:16 +00002231 } else {
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002232 return error("Invalid type for value");
Chris Lattner372dd1e2012-01-30 00:51:16 +00002233 }
2234 break;
2235 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002236 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
Rafael Espindola48da4f42013-11-04 16:16:24 +00002237 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002238 return error("Invalid record");
2239 int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
Chris Lattner890683d2007-04-24 18:15:21 +00002240 if (Opc < 0) {
Owen Andersonb292b8c2009-07-30 23:03:37 +00002241 V = UndefValue::get(CurTy); // Unknown binop.
Chris Lattner890683d2007-04-24 18:15:21 +00002242 } else {
2243 Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
2244 Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
Dan Gohman1b849082009-09-07 23:54:19 +00002245 unsigned Flags = 0;
2246 if (Record.size() >= 4) {
2247 if (Opc == Instruction::Add ||
2248 Opc == Instruction::Sub ||
Chris Lattnera676c0f2011-02-07 16:40:21 +00002249 Opc == Instruction::Mul ||
2250 Opc == Instruction::Shl) {
Dan Gohman1b849082009-09-07 23:54:19 +00002251 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2252 Flags |= OverflowingBinaryOperator::NoSignedWrap;
2253 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2254 Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
Chris Lattner35315d02011-02-06 21:44:57 +00002255 } else if (Opc == Instruction::SDiv ||
Chris Lattnera676c0f2011-02-07 16:40:21 +00002256 Opc == Instruction::UDiv ||
2257 Opc == Instruction::LShr ||
2258 Opc == Instruction::AShr) {
Chris Lattner35315d02011-02-06 21:44:57 +00002259 if (Record[3] & (1 << bitc::PEO_EXACT))
Dan Gohman1b849082009-09-07 23:54:19 +00002260 Flags |= SDivOperator::IsExact;
2261 }
2262 }
2263 V = ConstantExpr::get(Opc, LHS, RHS, Flags);
Chris Lattner890683d2007-04-24 18:15:21 +00002264 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002265 break;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002266 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002267 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
Rafael Espindola48da4f42013-11-04 16:16:24 +00002268 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002269 return error("Invalid record");
2270 int Opc = getDecodedCastOpcode(Record[0]);
Chris Lattner890683d2007-04-24 18:15:21 +00002271 if (Opc < 0) {
Owen Andersonb292b8c2009-07-30 23:03:37 +00002272 V = UndefValue::get(CurTy); // Unknown cast.
Chris Lattner890683d2007-04-24 18:15:21 +00002273 } else {
Chris Lattner229907c2011-07-18 04:54:35 +00002274 Type *OpTy = getTypeByID(Record[1]);
Rafael Espindola48da4f42013-11-04 16:16:24 +00002275 if (!OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002276 return error("Invalid record");
Chris Lattner890683d2007-04-24 18:15:21 +00002277 Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002278 V = UpgradeBitCastExpr(Opc, Op, CurTy);
2279 if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
Chris Lattner890683d2007-04-24 18:15:21 +00002280 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002281 break;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002282 }
Peter Collingbourned93620b2016-11-10 22:34:55 +00002283 case bitc::CST_CODE_CE_INBOUNDS_GEP: // [ty, n x operands]
2284 case bitc::CST_CODE_CE_GEP: // [ty, n x operands]
2285 case bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX: { // [ty, flags, n x
2286 // operands]
David Blaikieb9263572015-03-13 21:03:36 +00002287 unsigned OpNum = 0;
2288 Type *PointeeType = nullptr;
Peter Collingbourned93620b2016-11-10 22:34:55 +00002289 if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX ||
2290 Record.size() % 2)
David Blaikieb9263572015-03-13 21:03:36 +00002291 PointeeType = getTypeByID(Record[OpNum++]);
Peter Collingbourned93620b2016-11-10 22:34:55 +00002292
2293 bool InBounds = false;
2294 Optional<unsigned> InRangeIndex;
2295 if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX) {
2296 uint64_t Op = Record[OpNum++];
2297 InBounds = Op & 1;
2298 InRangeIndex = Op >> 1;
2299 } else if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)
2300 InBounds = true;
2301
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002302 SmallVector<Constant*, 16> Elts;
David Blaikieb9263572015-03-13 21:03:36 +00002303 while (OpNum != Record.size()) {
2304 Type *ElTy = getTypeByID(Record[OpNum++]);
Rafael Espindola48da4f42013-11-04 16:16:24 +00002305 if (!ElTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002306 return error("Invalid record");
David Blaikieb9263572015-03-13 21:03:36 +00002307 Elts.push_back(ValueList.getConstantFwdRef(Record[OpNum++], ElTy));
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002308 }
David Blaikieb9263572015-03-13 21:03:36 +00002309
David Blaikieb9263572015-03-13 21:03:36 +00002310 if (PointeeType &&
David Blaikie4a2e73b2015-04-02 18:55:32 +00002311 PointeeType !=
Peter Collingbourne9ef5a8c2016-11-13 06:59:28 +00002312 cast<PointerType>(Elts[0]->getType()->getScalarType())
David Blaikie4a2e73b2015-04-02 18:55:32 +00002313 ->getElementType())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002314 return error("Explicit gep operator type does not match pointee type "
David Blaikie12cf5d702015-03-16 22:03:50 +00002315 "of pointer operand");
David Blaikie4a2e73b2015-04-02 18:55:32 +00002316
Filipe Cabecinhasfc2a3c92016-06-05 18:43:26 +00002317 if (Elts.size() < 1)
2318 return error("Invalid gep with no operands");
2319
David Blaikie4a2e73b2015-04-02 18:55:32 +00002320 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2321 V = ConstantExpr::getGetElementPtr(PointeeType, Elts[0], Indices,
Peter Collingbourned93620b2016-11-10 22:34:55 +00002322 InBounds, InRangeIndex);
Chris Lattner890683d2007-04-24 18:15:21 +00002323 break;
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002324 }
Joe Abbey1a6e7702013-09-12 22:02:31 +00002325 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
Rafael Espindola48da4f42013-11-04 16:16:24 +00002326 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002327 return error("Invalid record");
Joe Abbey1a6e7702013-09-12 22:02:31 +00002328
2329 Type *SelectorTy = Type::getInt1Ty(Context);
2330
Filipe Cabecinhas984fefd2015-08-31 18:00:30 +00002331 // The selector might be an i1 or an <n x i1>
2332 // Get the type from the ValueList before getting a forward ref.
Joe Abbey1a6e7702013-09-12 22:02:31 +00002333 if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
Filipe Cabecinhas984fefd2015-08-31 18:00:30 +00002334 if (Value *V = ValueList[Record[0]])
2335 if (SelectorTy != V->getType())
2336 SelectorTy = VectorType::get(SelectorTy, VTy->getNumElements());
Joe Abbey1a6e7702013-09-12 22:02:31 +00002337
2338 V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
2339 SelectorTy),
2340 ValueList.getConstantFwdRef(Record[1],CurTy),
2341 ValueList.getConstantFwdRef(Record[2],CurTy));
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002342 break;
Joe Abbey1a6e7702013-09-12 22:02:31 +00002343 }
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00002344 case bitc::CST_CODE_CE_EXTRACTELT
2345 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
Rafael Espindola48da4f42013-11-04 16:16:24 +00002346 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002347 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00002348 VectorType *OpTy =
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002349 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
Craig Topper2617dcc2014-04-15 06:32:26 +00002350 if (!OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002351 return error("Invalid record");
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002352 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00002353 Constant *Op1 = nullptr;
2354 if (Record.size() == 4) {
2355 Type *IdxTy = getTypeByID(Record[2]);
2356 if (!IdxTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002357 return error("Invalid record");
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00002358 Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2359 } else // TODO: Remove with llvm 4.0
2360 Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2361 if (!Op1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002362 return error("Invalid record");
Owen Anderson487375e2009-07-29 18:55:55 +00002363 V = ConstantExpr::getExtractElement(Op0, Op1);
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002364 break;
2365 }
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00002366 case bitc::CST_CODE_CE_INSERTELT
2367 : { // CE_INSERTELT: [opval, opval, opty, opval]
Chris Lattner229907c2011-07-18 04:54:35 +00002368 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
Craig Topper2617dcc2014-04-15 06:32:26 +00002369 if (Record.size() < 3 || !OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002370 return error("Invalid record");
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002371 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2372 Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
2373 OpTy->getElementType());
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00002374 Constant *Op2 = nullptr;
2375 if (Record.size() == 4) {
2376 Type *IdxTy = getTypeByID(Record[2]);
2377 if (!IdxTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002378 return error("Invalid record");
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00002379 Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
2380 } else // TODO: Remove with llvm 4.0
2381 Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
2382 if (!Op2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002383 return error("Invalid record");
Owen Anderson487375e2009-07-29 18:55:55 +00002384 V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002385 break;
2386 }
2387 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
Chris Lattner229907c2011-07-18 04:54:35 +00002388 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
Craig Topper2617dcc2014-04-15 06:32:26 +00002389 if (Record.size() < 3 || !OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002390 return error("Invalid record");
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002391 Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
2392 Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
Chris Lattner229907c2011-07-18 04:54:35 +00002393 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
Owen Andersone9f98042009-07-07 20:18:58 +00002394 OpTy->getNumElements());
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002395 Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
Owen Anderson487375e2009-07-29 18:55:55 +00002396 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002397 break;
2398 }
Nate Begeman94aa38d2009-02-12 21:28:33 +00002399 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
Chris Lattner229907c2011-07-18 04:54:35 +00002400 VectorType *RTy = dyn_cast<VectorType>(CurTy);
2401 VectorType *OpTy =
Duncan Sands89d412a2010-10-28 15:47:26 +00002402 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
Craig Topper2617dcc2014-04-15 06:32:26 +00002403 if (Record.size() < 4 || !RTy || !OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002404 return error("Invalid record");
Nate Begeman94aa38d2009-02-12 21:28:33 +00002405 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2406 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
Chris Lattner229907c2011-07-18 04:54:35 +00002407 Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
Owen Andersone9f98042009-07-07 20:18:58 +00002408 RTy->getNumElements());
Nate Begeman94aa38d2009-02-12 21:28:33 +00002409 Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
Owen Anderson487375e2009-07-29 18:55:55 +00002410 V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
Nate Begeman94aa38d2009-02-12 21:28:33 +00002411 break;
2412 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002413 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
Rafael Espindola48da4f42013-11-04 16:16:24 +00002414 if (Record.size() < 4)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002415 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00002416 Type *OpTy = getTypeByID(Record[0]);
Craig Topper2617dcc2014-04-15 06:32:26 +00002417 if (!OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002418 return error("Invalid record");
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002419 Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
2420 Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
2421
Duncan Sands9dff9be2010-02-15 16:12:20 +00002422 if (OpTy->isFPOrFPVectorTy())
Owen Anderson487375e2009-07-29 18:55:55 +00002423 V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
Nate Begemand2195702008-05-12 19:01:56 +00002424 else
Owen Anderson487375e2009-07-29 18:55:55 +00002425 V = ConstantExpr::getICmp(Record[3], Op0, Op1);
Chris Lattner1e16bcf72007-04-24 07:07:11 +00002426 break;
Chris Lattner1663cca2007-04-24 05:48:56 +00002427 }
Chad Rosierd8c76102012-09-05 19:00:49 +00002428 // This maintains backward compatibility, pre-asm dialect keywords.
Chad Rosier5895eda2012-09-05 06:28:52 +00002429 // FIXME: Remove with the 4.0 release.
Chad Rosier18fcdcf2012-09-05 00:56:20 +00002430 case bitc::CST_CODE_INLINEASM_OLD: {
Rafael Espindola48da4f42013-11-04 16:16:24 +00002431 if (Record.size() < 2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002432 return error("Invalid record");
Chris Lattneraf8fffc2007-05-06 01:58:20 +00002433 std::string AsmStr, ConstrStr;
Dale Johannesenfd04c742009-10-13 20:46:56 +00002434 bool HasSideEffects = Record[0] & 1;
Dale Johannesen1cfb9582009-10-21 23:28:00 +00002435 bool IsAlignStack = Record[0] >> 1;
Chris Lattneraf8fffc2007-05-06 01:58:20 +00002436 unsigned AsmStrSize = Record[1];
2437 if (2+AsmStrSize >= Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002438 return error("Invalid record");
Chris Lattneraf8fffc2007-05-06 01:58:20 +00002439 unsigned ConstStrSize = Record[2+AsmStrSize];
2440 if (3+AsmStrSize+ConstStrSize > Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002441 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002442
Chris Lattneraf8fffc2007-05-06 01:58:20 +00002443 for (unsigned i = 0; i != AsmStrSize; ++i)
2444 AsmStr += (char)Record[2+i];
2445 for (unsigned i = 0; i != ConstStrSize; ++i)
2446 ConstrStr += (char)Record[3+AsmStrSize+i];
Chris Lattner229907c2011-07-18 04:54:35 +00002447 PointerType *PTy = cast<PointerType>(CurTy);
Chris Lattneraf8fffc2007-05-06 01:58:20 +00002448 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
Dale Johannesen1cfb9582009-10-21 23:28:00 +00002449 AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
Chris Lattneraf8fffc2007-05-06 01:58:20 +00002450 break;
2451 }
Chad Rosierd8c76102012-09-05 19:00:49 +00002452 // This version adds support for the asm dialect keywords (e.g.,
2453 // inteldialect).
Chad Rosier18fcdcf2012-09-05 00:56:20 +00002454 case bitc::CST_CODE_INLINEASM: {
Rafael Espindola48da4f42013-11-04 16:16:24 +00002455 if (Record.size() < 2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002456 return error("Invalid record");
Chad Rosier18fcdcf2012-09-05 00:56:20 +00002457 std::string AsmStr, ConstrStr;
2458 bool HasSideEffects = Record[0] & 1;
2459 bool IsAlignStack = (Record[0] >> 1) & 1;
2460 unsigned AsmDialect = Record[0] >> 2;
2461 unsigned AsmStrSize = Record[1];
2462 if (2+AsmStrSize >= Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002463 return error("Invalid record");
Chad Rosier18fcdcf2012-09-05 00:56:20 +00002464 unsigned ConstStrSize = Record[2+AsmStrSize];
2465 if (3+AsmStrSize+ConstStrSize > Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002466 return error("Invalid record");
Chad Rosier18fcdcf2012-09-05 00:56:20 +00002467
2468 for (unsigned i = 0; i != AsmStrSize; ++i)
2469 AsmStr += (char)Record[2+i];
2470 for (unsigned i = 0; i != ConstStrSize; ++i)
2471 ConstrStr += (char)Record[3+AsmStrSize+i];
2472 PointerType *PTy = cast<PointerType>(CurTy);
2473 V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
2474 AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
Chad Rosierd8c76102012-09-05 19:00:49 +00002475 InlineAsm::AsmDialect(AsmDialect));
Chad Rosier18fcdcf2012-09-05 00:56:20 +00002476 break;
2477 }
Chris Lattner5956dc82009-10-28 05:53:48 +00002478 case bitc::CST_CODE_BLOCKADDRESS:{
Rafael Espindola48da4f42013-11-04 16:16:24 +00002479 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002480 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00002481 Type *FnTy = getTypeByID(Record[0]);
Craig Topper2617dcc2014-04-15 06:32:26 +00002482 if (!FnTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002483 return error("Invalid record");
Chris Lattner5956dc82009-10-28 05:53:48 +00002484 Function *Fn =
2485 dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
Craig Topper2617dcc2014-04-15 06:32:26 +00002486 if (!Fn)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002487 return error("Invalid record");
Benjamin Kramer736a4fc2012-09-21 14:34:31 +00002488
2489 // If the function is already parsed we can insert the block address right
2490 // away.
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00002491 BasicBlock *BB;
2492 unsigned BBID = Record[2];
2493 if (!BBID)
2494 // Invalid reference to entry block.
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002495 return error("Invalid ID");
Benjamin Kramer736a4fc2012-09-21 14:34:31 +00002496 if (!Fn->empty()) {
2497 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00002498 for (size_t I = 0, E = BBID; I != E; ++I) {
Benjamin Kramer736a4fc2012-09-21 14:34:31 +00002499 if (BBI == BBE)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002500 return error("Invalid ID");
Benjamin Kramer736a4fc2012-09-21 14:34:31 +00002501 ++BBI;
2502 }
Duncan P. N. Exon Smithfb1743a32015-10-13 16:48:55 +00002503 BB = &*BBI;
Benjamin Kramer736a4fc2012-09-21 14:34:31 +00002504 } else {
2505 // Otherwise insert a placeholder and remember it so it can be inserted
2506 // when the function is parsed.
Duncan P. N. Exon Smith5a511b52014-08-05 17:49:48 +00002507 auto &FwdBBs = BasicBlockFwdRefs[Fn];
2508 if (FwdBBs.empty())
2509 BasicBlockFwdRefQueue.push_back(Fn);
Duncan P. N. Exon Smith5a5fd7b2014-08-16 01:54:37 +00002510 if (FwdBBs.size() < BBID + 1)
2511 FwdBBs.resize(BBID + 1);
2512 if (!FwdBBs[BBID])
2513 FwdBBs[BBID] = BasicBlock::Create(Context);
2514 BB = FwdBBs[BBID];
Benjamin Kramer736a4fc2012-09-21 14:34:31 +00002515 }
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00002516 V = BlockAddress::get(Fn, BB);
Chris Lattner5956dc82009-10-28 05:53:48 +00002517 break;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002518 }
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002519 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002520
David Majnemer8a1c45d2015-12-12 05:38:55 +00002521 ValueList.assignValue(V, NextCstNo);
Chris Lattner1663cca2007-04-24 05:48:56 +00002522 ++NextCstNo;
Chris Lattnerfbc1d332007-04-24 03:30:34 +00002523 }
2524}
Chris Lattner1314b992007-04-22 06:23:29 +00002525
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002526Error BitcodeReader::parseUseLists() {
Chad Rosierca2567b2011-12-07 21:44:12 +00002527 if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002528 return error("Invalid record");
Chad Rosierca2567b2011-12-07 21:44:12 +00002529
Chad Rosierca2567b2011-12-07 21:44:12 +00002530 // Read all the records.
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002531 SmallVector<uint64_t, 64> Record;
Eugene Zelenko1804a772016-08-25 00:45:04 +00002532
2533 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00002534 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
Joe Abbey97b7a172013-02-06 22:14:06 +00002535
Chris Lattner27d38752013-01-20 02:13:19 +00002536 switch (Entry.Kind) {
2537 case BitstreamEntry::SubBlock: // Handled for us already.
2538 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002539 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00002540 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002541 return Error::success();
Chris Lattner27d38752013-01-20 02:13:19 +00002542 case BitstreamEntry::Record:
2543 // The interesting case.
2544 break;
Chad Rosierca2567b2011-12-07 21:44:12 +00002545 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002546
Chad Rosierca2567b2011-12-07 21:44:12 +00002547 // Read a use list record.
2548 Record.clear();
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002549 bool IsBB = false;
Chris Lattner27d38752013-01-20 02:13:19 +00002550 switch (Stream.readRecord(Entry.ID, Record)) {
Chad Rosierca2567b2011-12-07 21:44:12 +00002551 default: // Default behavior: unknown type.
2552 break;
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002553 case bitc::USELIST_CODE_BB:
2554 IsBB = true;
Justin Bognerb03fd122016-08-17 05:10:15 +00002555 LLVM_FALLTHROUGH;
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002556 case bitc::USELIST_CODE_DEFAULT: {
Chad Rosierca2567b2011-12-07 21:44:12 +00002557 unsigned RecordLength = Record.size();
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002558 if (RecordLength < 3)
2559 // Records should have at least an ID and two indexes.
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002560 return error("Invalid record");
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002561 unsigned ID = Record.back();
2562 Record.pop_back();
2563
2564 Value *V;
2565 if (IsBB) {
2566 assert(ID < FunctionBBs.size() && "Basic block not found");
2567 V = FunctionBBs[ID];
2568 } else
2569 V = ValueList[ID];
2570 unsigned NumUses = 0;
2571 SmallDenseMap<const Use *, unsigned, 16> Order;
Rafael Espindola257a3532016-01-15 19:00:20 +00002572 for (const Use &U : V->materialized_uses()) {
Duncan P. N. Exon Smith13183642014-08-16 01:54:34 +00002573 if (++NumUses > Record.size())
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002574 break;
Duncan P. N. Exon Smith13183642014-08-16 01:54:34 +00002575 Order[&U] = Record[NumUses - 1];
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002576 }
2577 if (Order.size() != Record.size() || NumUses > Record.size())
2578 // Mismatches can happen if the functions are being materialized lazily
2579 // (out-of-order), or a value has been upgraded.
2580 break;
2581
2582 V->sortUseList([&](const Use &L, const Use &R) {
2583 return Order.lookup(&L) < Order.lookup(&R);
2584 });
Chad Rosierca2567b2011-12-07 21:44:12 +00002585 break;
2586 }
2587 }
2588 }
2589}
2590
Manman Ren4a9b0eb2015-03-13 19:24:30 +00002591/// When we see the block for metadata, remember where it is and then skip it.
2592/// This lets us lazily deserialize the metadata.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002593Error BitcodeReader::rememberAndSkipMetadata() {
Manman Ren4a9b0eb2015-03-13 19:24:30 +00002594 // Save the current stream state.
2595 uint64_t CurBit = Stream.GetCurrentBitNo();
2596 DeferredMetadataInfo.push_back(CurBit);
2597
2598 // Skip over the block for now.
2599 if (Stream.SkipBlock())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002600 return error("Invalid record");
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002601 return Error::success();
Manman Ren4a9b0eb2015-03-13 19:24:30 +00002602}
2603
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +00002604Error BitcodeReader::materializeMetadata() {
Manman Ren4a9b0eb2015-03-13 19:24:30 +00002605 for (uint64_t BitPos : DeferredMetadataInfo) {
2606 // Move the bit stream to the saved position.
2607 Stream.JumpToBit(BitPos);
Mehdi Aminief27db82016-12-12 19:34:26 +00002608 if (Error Err = MDLoader->parseModuleMetadata())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002609 return Err;
Manman Ren4a9b0eb2015-03-13 19:24:30 +00002610 }
2611 DeferredMetadataInfo.clear();
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002612 return Error::success();
Manman Ren4a9b0eb2015-03-13 19:24:30 +00002613}
2614
Rafael Espindola468b8682015-04-01 14:44:59 +00002615void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
Rafael Espindola0d68b4c2015-03-30 21:36:43 +00002616
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002617/// When we see the block for a function body, remember where it is and then
2618/// skip it. This lets us lazily deserialize the functions.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002619Error BitcodeReader::rememberAndSkipFunctionBody() {
Chris Lattner51ffe7c2007-05-01 04:59:48 +00002620 // Get the function we are talking about.
2621 if (FunctionsWithBodies.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002622 return error("Insufficient function protos");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002623
Chris Lattner51ffe7c2007-05-01 04:59:48 +00002624 Function *Fn = FunctionsWithBodies.back();
2625 FunctionsWithBodies.pop_back();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002626
Chris Lattner51ffe7c2007-05-01 04:59:48 +00002627 // Save the current stream state.
2628 uint64_t CurBit = Stream.GetCurrentBitNo();
Teresa Johnson1493ad92015-10-10 14:18:36 +00002629 assert(
2630 (DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&
2631 "Mismatch between VST and scanned function offsets");
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002632 DeferredFunctionInfo[Fn] = CurBit;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002633
Chris Lattner51ffe7c2007-05-01 04:59:48 +00002634 // Skip over the function block for now.
2635 if (Stream.SkipBlock())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002636 return error("Invalid record");
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002637 return Error::success();
Chris Lattner51ffe7c2007-05-01 04:59:48 +00002638}
2639
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002640Error BitcodeReader::globalCleanup() {
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002641 // Patch the initializers for globals and aliases up.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002642 if (Error Err = resolveGlobalAndIndirectSymbolInits())
2643 return Err;
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00002644 if (!GlobalInits.empty() || !IndirectSymbolInits.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002645 return error("Malformed global initializer set");
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002646
2647 // Look for intrinsic functions which need to be upgraded at some point
Yaron Kerenef5e7ad2015-06-12 18:13:20 +00002648 for (Function &F : *TheModule) {
Adrian Prantl6825fb62017-04-18 01:21:53 +00002649 MDLoader->upgradeDebugIntrinsics(F);
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002650 Function *NewFn;
Yaron Kerenef5e7ad2015-06-12 18:13:20 +00002651 if (UpgradeIntrinsicFunction(&F, NewFn))
Rafael Espindola4e721212015-07-02 16:22:40 +00002652 UpgradedIntrinsics[&F] = NewFn;
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00002653 else if (auto Remangled = Intrinsic::remangleIntrinsicFunction(&F))
2654 // Some types could be renamed during loading if several modules are
2655 // loaded in the same LLVMContext (LTO scenario). In this case we should
2656 // remangle intrinsics names as well.
2657 RemangledIntrinsics[&F] = Remangled.getValue();
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002658 }
2659
2660 // Look for global variables which need to be renamed.
Yaron Kerenef5e7ad2015-06-12 18:13:20 +00002661 for (GlobalVariable &GV : TheModule->globals())
2662 UpgradeGlobalVariable(&GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +00002663
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002664 // Force deallocation of memory for these vectors to favor the client that
2665 // want lazy deserialization.
2666 std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00002667 std::vector<std::pair<GlobalIndirectSymbol*, unsigned> >().swap(
2668 IndirectSymbolInits);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002669 return Error::success();
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002670}
2671
Teresa Johnson1493ad92015-10-10 14:18:36 +00002672/// Support for lazy parsing of function bodies. This is required if we
2673/// either have an old bitcode file without a VST forward declaration record,
2674/// or if we have an anonymous function being materialized, since anonymous
2675/// functions do not have a name and are therefore not in the VST.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002676Error BitcodeReader::rememberAndSkipFunctionBodies() {
Teresa Johnson1493ad92015-10-10 14:18:36 +00002677 Stream.JumpToBit(NextUnreadBit);
2678
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002679 if (Stream.AtEndOfStream())
2680 return error("Could not find function in stream");
Teresa Johnson1493ad92015-10-10 14:18:36 +00002681
Filipe Cabecinhas7aae2f22015-11-03 13:48:26 +00002682 if (!SeenFirstFunctionBody)
2683 return error("Trying to materialize functions before seeing function blocks");
2684
Teresa Johnson1493ad92015-10-10 14:18:36 +00002685 // An old bitcode file with the symbol table at the end would have
2686 // finished the parse greedily.
2687 assert(SeenValueSymbolTable);
2688
2689 SmallVector<uint64_t, 64> Record;
2690
Eugene Zelenko1804a772016-08-25 00:45:04 +00002691 while (true) {
Teresa Johnson1493ad92015-10-10 14:18:36 +00002692 BitstreamEntry Entry = Stream.advance();
2693 switch (Entry.Kind) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002694 default:
2695 return error("Expect SubBlock");
2696 case BitstreamEntry::SubBlock:
2697 switch (Entry.ID) {
Teresa Johnson1493ad92015-10-10 14:18:36 +00002698 default:
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002699 return error("Expect function block");
2700 case bitc::FUNCTION_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002701 if (Error Err = rememberAndSkipFunctionBody())
2702 return Err;
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002703 NextUnreadBit = Stream.GetCurrentBitNo();
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002704 return Error::success();
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002705 }
Teresa Johnson1493ad92015-10-10 14:18:36 +00002706 }
2707 }
2708}
2709
Peter Collingbourne939c7d92016-11-08 04:16:57 +00002710bool BitcodeReaderBase::readBlockInfo() {
Peter Collingbourne77c89b62016-11-08 04:17:11 +00002711 Optional<BitstreamBlockInfo> NewBlockInfo = Stream.ReadBlockInfoBlock();
2712 if (!NewBlockInfo)
2713 return true;
2714 BlockInfo = std::move(*NewBlockInfo);
2715 return false;
Peter Collingbourne939c7d92016-11-08 04:16:57 +00002716}
2717
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002718Error BitcodeReader::parseComdatRecord(ArrayRef<uint64_t> Record) {
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002719 // v1: [selection_kind, name]
2720 // v2: [strtab_offset, strtab_size, selection_kind]
2721 StringRef Name;
2722 std::tie(Name, Record) = readNameFromStrtab(Record);
2723
2724 if (Record.size() < 1)
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002725 return error("Invalid record");
2726 Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002727 std::string OldFormatName;
2728 if (!UseStrtab) {
2729 if (Record.size() < 2)
2730 return error("Invalid record");
2731 unsigned ComdatNameSize = Record[1];
2732 OldFormatName.reserve(ComdatNameSize);
2733 for (unsigned i = 0; i != ComdatNameSize; ++i)
2734 OldFormatName += (char)Record[2 + i];
2735 Name = OldFormatName;
2736 }
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002737 Comdat *C = TheModule->getOrInsertComdat(Name);
2738 C->setSelectionKind(SK);
2739 ComdatList.push_back(C);
2740 return Error::success();
2741}
2742
2743Error BitcodeReader::parseGlobalVarRecord(ArrayRef<uint64_t> Record) {
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002744 // v1: [pointer type, isconst, initid, linkage, alignment, section,
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002745 // visibility, threadlocal, unnamed_addr, externally_initialized,
Javed Absarf3d79042017-05-11 12:28:08 +00002746 // dllstorageclass, comdat, attributes] (name in VST)
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002747 // v2: [strtab_offset, strtab_size, v1]
2748 StringRef Name;
2749 std::tie(Name, Record) = readNameFromStrtab(Record);
2750
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002751 if (Record.size() < 6)
2752 return error("Invalid record");
2753 Type *Ty = getTypeByID(Record[0]);
2754 if (!Ty)
2755 return error("Invalid record");
2756 bool isConstant = Record[1] & 1;
2757 bool explicitType = Record[1] & 2;
2758 unsigned AddressSpace;
2759 if (explicitType) {
2760 AddressSpace = Record[1] >> 2;
2761 } else {
2762 if (!Ty->isPointerTy())
2763 return error("Invalid type for value");
2764 AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
2765 Ty = cast<PointerType>(Ty)->getElementType();
2766 }
2767
2768 uint64_t RawLinkage = Record[3];
2769 GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
2770 unsigned Alignment;
2771 if (Error Err = parseAlignmentValue(Record[4], Alignment))
2772 return Err;
2773 std::string Section;
2774 if (Record[5]) {
2775 if (Record[5] - 1 >= SectionTable.size())
2776 return error("Invalid ID");
2777 Section = SectionTable[Record[5] - 1];
2778 }
2779 GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
2780 // Local linkage must have default visibility.
2781 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
2782 // FIXME: Change to an error if non-default in 4.0.
2783 Visibility = getDecodedVisibility(Record[6]);
2784
2785 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
2786 if (Record.size() > 7)
2787 TLM = getDecodedThreadLocalMode(Record[7]);
2788
2789 GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;
2790 if (Record.size() > 8)
2791 UnnamedAddr = getDecodedUnnamedAddrType(Record[8]);
2792
2793 bool ExternallyInitialized = false;
2794 if (Record.size() > 9)
2795 ExternallyInitialized = Record[9];
2796
2797 GlobalVariable *NewGV =
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002798 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, Name,
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002799 nullptr, TLM, AddressSpace, ExternallyInitialized);
2800 NewGV->setAlignment(Alignment);
2801 if (!Section.empty())
2802 NewGV->setSection(Section);
2803 NewGV->setVisibility(Visibility);
2804 NewGV->setUnnamedAddr(UnnamedAddr);
2805
2806 if (Record.size() > 10)
2807 NewGV->setDLLStorageClass(getDecodedDLLStorageClass(Record[10]));
2808 else
2809 upgradeDLLImportExportLinkage(NewGV, RawLinkage);
2810
2811 ValueList.push_back(NewGV);
2812
2813 // Remember which value to use for the global initializer.
2814 if (unsigned InitID = Record[2])
2815 GlobalInits.push_back(std::make_pair(NewGV, InitID - 1));
2816
2817 if (Record.size() > 11) {
2818 if (unsigned ComdatID = Record[11]) {
2819 if (ComdatID > ComdatList.size())
2820 return error("Invalid global variable comdat ID");
2821 NewGV->setComdat(ComdatList[ComdatID - 1]);
2822 }
2823 } else if (hasImplicitComdat(RawLinkage)) {
2824 NewGV->setComdat(reinterpret_cast<Comdat *>(1));
2825 }
Javed Absarf3d79042017-05-11 12:28:08 +00002826
2827 if (Record.size() > 12) {
2828 auto AS = getAttributes(Record[12]).getFnAttributes();
2829 NewGV->setAttributes(AS);
2830 }
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002831 return Error::success();
2832}
2833
2834Error BitcodeReader::parseFunctionRecord(ArrayRef<uint64_t> Record) {
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002835 // v1: [type, callingconv, isproto, linkage, paramattr, alignment, section,
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002836 // visibility, gc, unnamed_addr, prologuedata, dllstorageclass, comdat,
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002837 // prefixdata] (name in VST)
2838 // v2: [strtab_offset, strtab_size, v1]
2839 StringRef Name;
2840 std::tie(Name, Record) = readNameFromStrtab(Record);
2841
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002842 if (Record.size() < 8)
2843 return error("Invalid record");
2844 Type *Ty = getTypeByID(Record[0]);
2845 if (!Ty)
2846 return error("Invalid record");
2847 if (auto *PTy = dyn_cast<PointerType>(Ty))
2848 Ty = PTy->getElementType();
2849 auto *FTy = dyn_cast<FunctionType>(Ty);
2850 if (!FTy)
2851 return error("Invalid type for value");
2852 auto CC = static_cast<CallingConv::ID>(Record[1]);
2853 if (CC & ~CallingConv::MaxID)
2854 return error("Invalid calling convention ID");
2855
2856 Function *Func =
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002857 Function::Create(FTy, GlobalValue::ExternalLinkage, Name, TheModule);
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002858
2859 Func->setCallingConv(CC);
2860 bool isProto = Record[2];
2861 uint64_t RawLinkage = Record[3];
2862 Func->setLinkage(getDecodedLinkage(RawLinkage));
2863 Func->setAttributes(getAttributes(Record[4]));
2864
2865 unsigned Alignment;
2866 if (Error Err = parseAlignmentValue(Record[5], Alignment))
2867 return Err;
2868 Func->setAlignment(Alignment);
2869 if (Record[6]) {
2870 if (Record[6] - 1 >= SectionTable.size())
2871 return error("Invalid ID");
2872 Func->setSection(SectionTable[Record[6] - 1]);
2873 }
2874 // Local linkage must have default visibility.
2875 if (!Func->hasLocalLinkage())
2876 // FIXME: Change to an error if non-default in 4.0.
2877 Func->setVisibility(getDecodedVisibility(Record[7]));
2878 if (Record.size() > 8 && Record[8]) {
2879 if (Record[8] - 1 >= GCTable.size())
2880 return error("Invalid ID");
2881 Func->setGC(GCTable[Record[8] - 1]);
2882 }
2883 GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;
2884 if (Record.size() > 9)
2885 UnnamedAddr = getDecodedUnnamedAddrType(Record[9]);
2886 Func->setUnnamedAddr(UnnamedAddr);
2887 if (Record.size() > 10 && Record[10] != 0)
2888 FunctionPrologues.push_back(std::make_pair(Func, Record[10] - 1));
2889
2890 if (Record.size() > 11)
2891 Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));
2892 else
2893 upgradeDLLImportExportLinkage(Func, RawLinkage);
2894
2895 if (Record.size() > 12) {
2896 if (unsigned ComdatID = Record[12]) {
2897 if (ComdatID > ComdatList.size())
2898 return error("Invalid function comdat ID");
2899 Func->setComdat(ComdatList[ComdatID - 1]);
2900 }
2901 } else if (hasImplicitComdat(RawLinkage)) {
2902 Func->setComdat(reinterpret_cast<Comdat *>(1));
2903 }
2904
2905 if (Record.size() > 13 && Record[13] != 0)
2906 FunctionPrefixes.push_back(std::make_pair(Func, Record[13] - 1));
2907
2908 if (Record.size() > 14 && Record[14] != 0)
2909 FunctionPersonalityFns.push_back(std::make_pair(Func, Record[14] - 1));
2910
2911 ValueList.push_back(Func);
2912
2913 // If this is a function with a body, remember the prototype we are
2914 // creating now, so that we can match up the body with them later.
2915 if (!isProto) {
2916 Func->setIsMaterializable(true);
2917 FunctionsWithBodies.push_back(Func);
2918 DeferredFunctionInfo[Func] = 0;
2919 }
2920 return Error::success();
2921}
2922
2923Error BitcodeReader::parseGlobalIndirectSymbolRecord(
2924 unsigned BitCode, ArrayRef<uint64_t> Record) {
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002925 // v1 ALIAS_OLD: [alias type, aliasee val#, linkage] (name in VST)
2926 // v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, visibility,
2927 // dllstorageclass] (name in VST)
2928 // v1 IFUNC: [alias type, addrspace, aliasee val#, linkage,
2929 // visibility, dllstorageclass] (name in VST)
2930 // v2: [strtab_offset, strtab_size, v1]
2931 StringRef Name;
2932 std::tie(Name, Record) = readNameFromStrtab(Record);
2933
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002934 bool NewRecord = BitCode != bitc::MODULE_CODE_ALIAS_OLD;
2935 if (Record.size() < (3 + (unsigned)NewRecord))
2936 return error("Invalid record");
2937 unsigned OpNum = 0;
2938 Type *Ty = getTypeByID(Record[OpNum++]);
2939 if (!Ty)
2940 return error("Invalid record");
2941
2942 unsigned AddrSpace;
2943 if (!NewRecord) {
2944 auto *PTy = dyn_cast<PointerType>(Ty);
2945 if (!PTy)
2946 return error("Invalid type for value");
2947 Ty = PTy->getElementType();
2948 AddrSpace = PTy->getAddressSpace();
2949 } else {
2950 AddrSpace = Record[OpNum++];
2951 }
2952
2953 auto Val = Record[OpNum++];
2954 auto Linkage = Record[OpNum++];
2955 GlobalIndirectSymbol *NewGA;
2956 if (BitCode == bitc::MODULE_CODE_ALIAS ||
2957 BitCode == bitc::MODULE_CODE_ALIAS_OLD)
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002958 NewGA = GlobalAlias::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002959 TheModule);
2960 else
Peter Collingbournea0f371a2017-04-17 17:51:36 +00002961 NewGA = GlobalIFunc::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,
Peter Collingbournece24a2a2017-04-12 20:02:09 +00002962 nullptr, TheModule);
2963 // Old bitcode files didn't have visibility field.
2964 // Local linkage must have default visibility.
2965 if (OpNum != Record.size()) {
2966 auto VisInd = OpNum++;
2967 if (!NewGA->hasLocalLinkage())
2968 // FIXME: Change to an error if non-default in 4.0.
2969 NewGA->setVisibility(getDecodedVisibility(Record[VisInd]));
2970 }
2971 if (OpNum != Record.size())
2972 NewGA->setDLLStorageClass(getDecodedDLLStorageClass(Record[OpNum++]));
2973 else
2974 upgradeDLLImportExportLinkage(NewGA, Linkage);
2975 if (OpNum != Record.size())
2976 NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[OpNum++]));
2977 if (OpNum != Record.size())
2978 NewGA->setUnnamedAddr(getDecodedUnnamedAddrType(Record[OpNum++]));
2979 ValueList.push_back(NewGA);
2980 IndirectSymbolInits.push_back(std::make_pair(NewGA, Val));
2981 return Error::success();
2982}
2983
Peter Collingbourne58f7f072016-11-09 00:51:04 +00002984Error BitcodeReader::parseModule(uint64_t ResumeBit,
2985 bool ShouldLazyLoadMetadata) {
Teresa Johnson1493ad92015-10-10 14:18:36 +00002986 if (ResumeBit)
2987 Stream.JumpToBit(ResumeBit);
Derek Schuff8b2dcad2012-02-06 22:30:29 +00002988 else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002989 return error("Invalid record");
Chris Lattner1314b992007-04-22 06:23:29 +00002990
Chris Lattner1314b992007-04-22 06:23:29 +00002991 SmallVector<uint64_t, 64> Record;
Chris Lattner1314b992007-04-22 06:23:29 +00002992
2993 // Read all the records for this module.
Eugene Zelenko1804a772016-08-25 00:45:04 +00002994 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00002995 BitstreamEntry Entry = Stream.advance();
Joe Abbey97b7a172013-02-06 22:14:06 +00002996
Chris Lattner27d38752013-01-20 02:13:19 +00002997 switch (Entry.Kind) {
2998 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00002999 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00003000 case BitstreamEntry::EndBlock:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003001 return globalCleanup();
Joe Abbey97b7a172013-02-06 22:14:06 +00003002
Chris Lattner27d38752013-01-20 02:13:19 +00003003 case BitstreamEntry::SubBlock:
3004 switch (Entry.ID) {
Chris Lattner1314b992007-04-22 06:23:29 +00003005 default: // Skip unknown content.
3006 if (Stream.SkipBlock())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003007 return error("Invalid record");
Chris Lattner1314b992007-04-22 06:23:29 +00003008 break;
Chris Lattner6eeea5d2007-05-05 18:57:30 +00003009 case bitc::BLOCKINFO_BLOCK_ID:
Peter Collingbourne939c7d92016-11-08 04:16:57 +00003010 if (readBlockInfo())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003011 return error("Malformed block");
Chris Lattner6eeea5d2007-05-05 18:57:30 +00003012 break;
Chris Lattnerfee5a372007-05-04 03:30:17 +00003013 case bitc::PARAMATTR_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003014 if (Error Err = parseAttributeBlock())
3015 return Err;
Chris Lattnerfee5a372007-05-04 03:30:17 +00003016 break;
Bill Wendlingba629332013-02-10 23:24:25 +00003017 case bitc::PARAMATTR_GROUP_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003018 if (Error Err = parseAttributeGroupBlock())
3019 return Err;
Bill Wendlingba629332013-02-10 23:24:25 +00003020 break;
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00003021 case bitc::TYPE_BLOCK_ID_NEW:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003022 if (Error Err = parseTypeTable())
3023 return Err;
Chris Lattner1314b992007-04-22 06:23:29 +00003024 break;
Chris Lattnerccaa4482007-04-23 21:26:05 +00003025 case bitc::VALUE_SYMTAB_BLOCK_ID:
Teresa Johnsonff642b92015-09-17 20:12:00 +00003026 if (!SeenValueSymbolTable) {
3027 // Either this is an old form VST without function index and an
3028 // associated VST forward declaration record (which would have caused
3029 // the VST to be jumped to and parsed before it was encountered
3030 // normally in the stream), or there were no function blocks to
3031 // trigger an earlier parsing of the VST.
3032 assert(VSTOffset == 0 || FunctionsWithBodies.empty());
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003033 if (Error Err = parseValueSymbolTable())
3034 return Err;
Teresa Johnsonff642b92015-09-17 20:12:00 +00003035 SeenValueSymbolTable = true;
3036 } else {
3037 // We must have had a VST forward declaration record, which caused
3038 // the parser to jump to and parse the VST earlier.
3039 assert(VSTOffset > 0);
3040 if (Stream.SkipBlock())
3041 return error("Invalid record");
3042 }
Chris Lattnerccaa4482007-04-23 21:26:05 +00003043 break;
Chris Lattnerfbc1d332007-04-24 03:30:34 +00003044 case bitc::CONSTANTS_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003045 if (Error Err = parseConstants())
3046 return Err;
3047 if (Error Err = resolveGlobalAndIndirectSymbolInits())
3048 return Err;
Chris Lattnerfbc1d332007-04-24 03:30:34 +00003049 break;
Devang Patel7428d8a2009-07-22 17:43:22 +00003050 case bitc::METADATA_BLOCK_ID:
Mehdi Aminibf2090e2016-12-12 19:23:39 +00003051 if (ShouldLazyLoadMetadata) {
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003052 if (Error Err = rememberAndSkipMetadata())
3053 return Err;
Manman Ren4a9b0eb2015-03-13 19:24:30 +00003054 break;
3055 }
3056 assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
Mehdi Aminief27db82016-12-12 19:34:26 +00003057 if (Error Err = MDLoader->parseModuleMetadata())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003058 return Err;
Devang Patel7428d8a2009-07-22 17:43:22 +00003059 break;
Teresa Johnson12545072015-11-15 02:00:09 +00003060 case bitc::METADATA_KIND_BLOCK_ID:
Mehdi Aminief27db82016-12-12 19:34:26 +00003061 if (Error Err = MDLoader->parseMetadataKinds())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003062 return Err;
Teresa Johnson12545072015-11-15 02:00:09 +00003063 break;
Chris Lattner51ffe7c2007-05-01 04:59:48 +00003064 case bitc::FUNCTION_BLOCK_ID:
Mehdi Amini466a64e2016-08-13 23:39:14 +00003065 // If this is the first function body we've seen, reverse the
3066 // FunctionsWithBodies list.
3067 if (!SeenFirstFunctionBody) {
3068 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003069 if (Error Err = globalCleanup())
3070 return Err;
Mehdi Amini466a64e2016-08-13 23:39:14 +00003071 SeenFirstFunctionBody = true;
3072 }
3073
Teresa Johnsonff642b92015-09-17 20:12:00 +00003074 if (VSTOffset > 0) {
3075 // If we have a VST forward declaration record, make sure we
3076 // parse the VST now if we haven't already. It is needed to
3077 // set up the DeferredFunctionInfo vector for lazy reading.
3078 if (!SeenValueSymbolTable) {
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003079 if (Error Err = BitcodeReader::parseValueSymbolTable(VSTOffset))
3080 return Err;
Teresa Johnsonff642b92015-09-17 20:12:00 +00003081 SeenValueSymbolTable = true;
Teresa Johnson1493ad92015-10-10 14:18:36 +00003082 // Fall through so that we record the NextUnreadBit below.
3083 // This is necessary in case we have an anonymous function that
3084 // is later materialized. Since it will not have a VST entry we
3085 // need to fall back to the lazy parse to find its offset.
Teresa Johnsonff642b92015-09-17 20:12:00 +00003086 } else {
3087 // If we have a VST forward declaration record, but have already
3088 // parsed the VST (just above, when the first function body was
3089 // encountered here), then we are resuming the parse after
Teresa Johnson1493ad92015-10-10 14:18:36 +00003090 // materializing functions. The ResumeBit points to the
3091 // start of the last function block recorded in the
3092 // DeferredFunctionInfo map. Skip it.
Teresa Johnsonff642b92015-09-17 20:12:00 +00003093 if (Stream.SkipBlock())
3094 return error("Invalid record");
3095 continue;
3096 }
3097 }
3098
3099 // Support older bitcode files that did not have the function
Teresa Johnson1493ad92015-10-10 14:18:36 +00003100 // index in the VST, nor a VST forward declaration record, as
3101 // well as anonymous functions that do not have VST entries.
Teresa Johnsonff642b92015-09-17 20:12:00 +00003102 // Build the DeferredFunctionInfo vector on the fly.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003103 if (Error Err = rememberAndSkipFunctionBody())
3104 return Err;
Teresa Johnson1493ad92015-10-10 14:18:36 +00003105
Rafael Espindola1c863ca2015-06-22 18:06:15 +00003106 // Suspend parsing when we reach the function bodies. Subsequent
3107 // materialization calls will resume it when necessary. If the bitcode
3108 // file is old, the symbol table will be at the end instead and will not
3109 // have been seen yet. In this case, just finish the parse now.
3110 if (SeenValueSymbolTable) {
Derek Schuff8b2dcad2012-02-06 22:30:29 +00003111 NextUnreadBit = Stream.GetCurrentBitNo();
Mehdi Aminia71002e2016-08-14 00:01:27 +00003112 // After the VST has been parsed, we need to make sure intrinsic name
3113 // are auto-upgraded.
3114 return globalCleanup();
Derek Schuff8b2dcad2012-02-06 22:30:29 +00003115 }
Chris Lattner51ffe7c2007-05-01 04:59:48 +00003116 break;
Chad Rosierca2567b2011-12-07 21:44:12 +00003117 case bitc::USELIST_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003118 if (Error Err = parseUseLists())
3119 return Err;
Chad Rosierca2567b2011-12-07 21:44:12 +00003120 break;
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00003121 case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003122 if (Error Err = parseOperandBundleTags())
3123 return Err;
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00003124 break;
Chris Lattner1314b992007-04-22 06:23:29 +00003125 }
3126 continue;
Joe Abbey97b7a172013-02-06 22:14:06 +00003127
Chris Lattner27d38752013-01-20 02:13:19 +00003128 case BitstreamEntry::Record:
3129 // The interesting case.
3130 break;
Chris Lattner1314b992007-04-22 06:23:29 +00003131 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003132
Chris Lattner1314b992007-04-22 06:23:29 +00003133 // Read a record.
David Blaikie6a51dbd2015-09-17 22:18:59 +00003134 auto BitCode = Stream.readRecord(Entry.ID, Record);
3135 switch (BitCode) {
Chris Lattner1314b992007-04-22 06:23:29 +00003136 default: break; // Default behavior, ignore unknown content.
Peter Collingbournece24a2a2017-04-12 20:02:09 +00003137 case bitc::MODULE_CODE_VERSION: {
3138 Expected<unsigned> VersionOrErr = parseVersionRecord(Record);
3139 if (!VersionOrErr)
3140 return VersionOrErr.takeError();
3141 UseRelativeIDs = *VersionOrErr >= 1;
Chris Lattner1314b992007-04-22 06:23:29 +00003142 break;
Jan Wen Voungafaced02012-10-11 20:20:40 +00003143 }
Chris Lattnere14cb882007-05-04 19:11:41 +00003144 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
Chris Lattner1314b992007-04-22 06:23:29 +00003145 std::string S;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003146 if (convertToString(Record, 0, S))
3147 return error("Invalid record");
Chris Lattner1314b992007-04-22 06:23:29 +00003148 TheModule->setTargetTriple(S);
3149 break;
3150 }
Chris Lattnere14cb882007-05-04 19:11:41 +00003151 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
Chris Lattner1314b992007-04-22 06:23:29 +00003152 std::string S;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003153 if (convertToString(Record, 0, S))
3154 return error("Invalid record");
Chris Lattner1314b992007-04-22 06:23:29 +00003155 TheModule->setDataLayout(S);
3156 break;
3157 }
Chris Lattnere14cb882007-05-04 19:11:41 +00003158 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
Chris Lattner1314b992007-04-22 06:23:29 +00003159 std::string S;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003160 if (convertToString(Record, 0, S))
3161 return error("Invalid record");
Chris Lattner1314b992007-04-22 06:23:29 +00003162 TheModule->setModuleInlineAsm(S);
3163 break;
3164 }
Bill Wendling706d3d62012-11-28 08:41:48 +00003165 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
3166 // FIXME: Remove in 4.0.
3167 std::string S;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003168 if (convertToString(Record, 0, S))
3169 return error("Invalid record");
Bill Wendling706d3d62012-11-28 08:41:48 +00003170 // Ignore value.
3171 break;
3172 }
Chris Lattnere14cb882007-05-04 19:11:41 +00003173 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
Chris Lattner1314b992007-04-22 06:23:29 +00003174 std::string S;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003175 if (convertToString(Record, 0, S))
3176 return error("Invalid record");
Chris Lattner1314b992007-04-22 06:23:29 +00003177 SectionTable.push_back(S);
3178 break;
3179 }
Gordon Henriksend930f912008-08-17 18:44:35 +00003180 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
Gordon Henriksen71183b62007-12-10 03:18:06 +00003181 std::string S;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003182 if (convertToString(Record, 0, S))
3183 return error("Invalid record");
Gordon Henriksend930f912008-08-17 18:44:35 +00003184 GCTable.push_back(S);
Gordon Henriksen71183b62007-12-10 03:18:06 +00003185 break;
3186 }
Peter Collingbournece24a2a2017-04-12 20:02:09 +00003187 case bitc::MODULE_CODE_COMDAT: {
3188 if (Error Err = parseComdatRecord(Record))
3189 return Err;
David Majnemerdad0a642014-06-27 18:19:56 +00003190 break;
3191 }
Chris Lattner1314b992007-04-22 06:23:29 +00003192 case bitc::MODULE_CODE_GLOBALVAR: {
Peter Collingbournece24a2a2017-04-12 20:02:09 +00003193 if (Error Err = parseGlobalVarRecord(Record))
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003194 return Err;
Chris Lattner1314b992007-04-22 06:23:29 +00003195 break;
3196 }
Chris Lattner1314b992007-04-22 06:23:29 +00003197 case bitc::MODULE_CODE_FUNCTION: {
Peter Collingbournece24a2a2017-04-12 20:02:09 +00003198 if (Error Err = parseFunctionRecord(Record))
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003199 return Err;
Chris Lattner1314b992007-04-22 06:23:29 +00003200 break;
3201 }
Dmitry Polukhina1feff72016-04-07 12:32:19 +00003202 case bitc::MODULE_CODE_IFUNC:
David Blaikie6a51dbd2015-09-17 22:18:59 +00003203 case bitc::MODULE_CODE_ALIAS:
3204 case bitc::MODULE_CODE_ALIAS_OLD: {
Peter Collingbournece24a2a2017-04-12 20:02:09 +00003205 if (Error Err = parseGlobalIndirectSymbolRecord(BitCode, Record))
3206 return Err;
Chris Lattner44c17072007-04-26 02:46:40 +00003207 break;
Chris Lattner1314b992007-04-22 06:23:29 +00003208 }
Teresa Johnsonff642b92015-09-17 20:12:00 +00003209 /// MODULE_CODE_VSTOFFSET: [offset]
3210 case bitc::MODULE_CODE_VSTOFFSET:
3211 if (Record.size() < 1)
3212 return error("Invalid record");
Peter Collingbournebfcf9802016-11-29 02:27:04 +00003213 // Note that we subtract 1 here because the offset is relative to one word
3214 // before the start of the identification or module block, which was
3215 // historically always the start of the regular bitcode header.
3216 VSTOffset = Record[0] - 1;
Teresa Johnsonff642b92015-09-17 20:12:00 +00003217 break;
Teresa Johnsone1164de2016-02-10 21:55:02 +00003218 /// MODULE_CODE_SOURCE_FILENAME: [namechar x N]
3219 case bitc::MODULE_CODE_SOURCE_FILENAME:
3220 SmallString<128> ValueName;
3221 if (convertToString(Record, 0, ValueName))
3222 return error("Invalid record");
3223 TheModule->setSourceFileName(ValueName);
3224 break;
Chris Lattner831d4202007-04-26 03:27:58 +00003225 }
Chris Lattner1314b992007-04-22 06:23:29 +00003226 Record.clear();
3227 }
Chris Lattner1314b992007-04-22 06:23:29 +00003228}
3229
Teresa Johnsona61f5e32016-12-16 21:25:01 +00003230Error BitcodeReader::parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata,
3231 bool IsImporting) {
Rafael Espindolac6afe0d2015-06-16 20:03:39 +00003232 TheModule = M;
Teresa Johnsona61f5e32016-12-16 21:25:01 +00003233 MDLoader = MetadataLoader(Stream, *M, ValueList, IsImporting,
Mehdi Aminief27db82016-12-12 19:34:26 +00003234 [&](unsigned ID) { return getTypeByID(ID); });
Peter Collingbourne7a748032016-11-16 21:44:45 +00003235 return parseModule(0, ShouldLazyLoadMetadata);
Chris Lattner1314b992007-04-22 06:23:29 +00003236}
Chris Lattner6694f602007-04-29 07:54:31 +00003237
Chris Lattner51ffe7c2007-05-01 04:59:48 +00003238
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003239Error BitcodeReader::typeCheckLoadStoreInst(Type *ValType, Type *PtrType) {
Filipe Cabecinhas11bb8492015-05-18 21:48:55 +00003240 if (!isa<PointerType>(PtrType))
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003241 return error("Load/Store operand is not a pointer type");
Filipe Cabecinhas11bb8492015-05-18 21:48:55 +00003242 Type *ElemType = cast<PointerType>(PtrType)->getElementType();
3243
3244 if (ValType && ValType != ElemType)
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003245 return error("Explicit load/store type does not match pointee "
3246 "type of pointer operand");
Filipe Cabecinhas11bb8492015-05-18 21:48:55 +00003247 if (!PointerType::isLoadableOrStorableType(ElemType))
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003248 return error("Cannot load/store from pointer");
3249 return Error::success();
Filipe Cabecinhas11bb8492015-05-18 21:48:55 +00003250}
3251
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003252/// Lazily parse the specified function body block.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003253Error BitcodeReader::parseFunctionBody(Function *F) {
Chris Lattner982ec1e2007-05-05 00:17:00 +00003254 if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003255 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003256
Duncan P. N. Exon Smith8742de92016-04-02 14:55:01 +00003257 // Unexpected unresolved metadata when parsing function.
Mehdi Aminief27db82016-12-12 19:34:26 +00003258 if (MDLoader->hasFwdRefs())
Duncan P. N. Exon Smith8742de92016-04-02 14:55:01 +00003259 return error("Invalid function metadata: incoming forward references");
3260
Nick Lewyckya72e1af2010-02-25 08:30:17 +00003261 InstructionList.clear();
Chris Lattner85b7b402007-05-01 05:52:21 +00003262 unsigned ModuleValueListSize = ValueList.size();
Mehdi Aminief27db82016-12-12 19:34:26 +00003263 unsigned ModuleMDLoaderSize = MDLoader->size();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003264
Chris Lattner85b7b402007-05-01 05:52:21 +00003265 // Add all the function arguments to the value table.
Duncan P. N. Exon Smithfb1743a32015-10-13 16:48:55 +00003266 for (Argument &I : F->args())
3267 ValueList.push_back(&I);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003268
Chris Lattner83930552007-05-01 07:01:57 +00003269 unsigned NextValueNo = ValueList.size();
Craig Topper2617dcc2014-04-15 06:32:26 +00003270 BasicBlock *CurBB = nullptr;
Chris Lattnere53603e2007-05-02 04:27:25 +00003271 unsigned CurBBNo = 0;
3272
Chris Lattner07d09ed2010-04-03 02:17:50 +00003273 DebugLoc LastLoc;
Duncan P. N. Exon Smith52d0f162015-01-09 02:51:45 +00003274 auto getLastInstruction = [&]() -> Instruction * {
3275 if (CurBB && !CurBB->empty())
3276 return &CurBB->back();
3277 else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
3278 !FunctionBBs[CurBBNo - 1]->empty())
3279 return &FunctionBBs[CurBBNo - 1]->back();
3280 return nullptr;
3281 };
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003282
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00003283 std::vector<OperandBundleDef> OperandBundles;
3284
Chris Lattner85b7b402007-05-01 05:52:21 +00003285 // Read all the records.
3286 SmallVector<uint64_t, 64> Record;
Eugene Zelenko1804a772016-08-25 00:45:04 +00003287
3288 while (true) {
Chris Lattner27d38752013-01-20 02:13:19 +00003289 BitstreamEntry Entry = Stream.advance();
Joe Abbey97b7a172013-02-06 22:14:06 +00003290
Chris Lattner27d38752013-01-20 02:13:19 +00003291 switch (Entry.Kind) {
3292 case BitstreamEntry::Error:
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003293 return error("Malformed block");
Chris Lattner27d38752013-01-20 02:13:19 +00003294 case BitstreamEntry::EndBlock:
3295 goto OutOfRecordLoop;
Joe Abbey97b7a172013-02-06 22:14:06 +00003296
Chris Lattner27d38752013-01-20 02:13:19 +00003297 case BitstreamEntry::SubBlock:
3298 switch (Entry.ID) {
Chris Lattner85b7b402007-05-01 05:52:21 +00003299 default: // Skip unknown content.
3300 if (Stream.SkipBlock())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003301 return error("Invalid record");
Chris Lattner85b7b402007-05-01 05:52:21 +00003302 break;
3303 case bitc::CONSTANTS_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003304 if (Error Err = parseConstants())
3305 return Err;
Chris Lattner83930552007-05-01 07:01:57 +00003306 NextValueNo = ValueList.size();
Chris Lattner85b7b402007-05-01 05:52:21 +00003307 break;
3308 case bitc::VALUE_SYMTAB_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003309 if (Error Err = parseValueSymbolTable())
3310 return Err;
Chris Lattner85b7b402007-05-01 05:52:21 +00003311 break;
Devang Patelaf206b82009-09-18 19:26:43 +00003312 case bitc::METADATA_ATTACHMENT_ID:
Mehdi Aminief27db82016-12-12 19:34:26 +00003313 if (Error Err = MDLoader->parseMetadataAttachment(*F, InstructionList))
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003314 return Err;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003315 break;
Victor Hernandez108d3ac2010-01-13 19:34:08 +00003316 case bitc::METADATA_BLOCK_ID:
Mehdi Aminief27db82016-12-12 19:34:26 +00003317 assert(DeferredMetadataInfo.empty() &&
3318 "Must read all module-level metadata before function-level");
3319 if (Error Err = MDLoader->parseFunctionMetadata())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003320 return Err;
Victor Hernandez108d3ac2010-01-13 19:34:08 +00003321 break;
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00003322 case bitc::USELIST_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00003323 if (Error Err = parseUseLists())
3324 return Err;
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00003325 break;
Chris Lattner85b7b402007-05-01 05:52:21 +00003326 }
3327 continue;
Joe Abbey97b7a172013-02-06 22:14:06 +00003328
Chris Lattner27d38752013-01-20 02:13:19 +00003329 case BitstreamEntry::Record:
3330 // The interesting case.
3331 break;
Chris Lattner85b7b402007-05-01 05:52:21 +00003332 }
Joe Abbey97b7a172013-02-06 22:14:06 +00003333
Chris Lattner85b7b402007-05-01 05:52:21 +00003334 // Read a record.
3335 Record.clear();
Craig Topper2617dcc2014-04-15 06:32:26 +00003336 Instruction *I = nullptr;
Chris Lattner27d38752013-01-20 02:13:19 +00003337 unsigned BitCode = Stream.readRecord(Entry.ID, Record);
Dan Gohman0ebd6962009-07-20 21:19:07 +00003338 switch (BitCode) {
Chris Lattner83930552007-05-01 07:01:57 +00003339 default: // Default behavior: reject
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003340 return error("Invalid value");
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00003341 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
Chris Lattner83930552007-05-01 07:01:57 +00003342 if (Record.size() < 1 || Record[0] == 0)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003343 return error("Invalid record");
Chris Lattner85b7b402007-05-01 05:52:21 +00003344 // Create all the basic blocks for the function.
Chris Lattner6ce15cb2007-05-03 22:09:51 +00003345 FunctionBBs.resize(Record[0]);
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00003346
3347 // See if anything took the address of blocks in this function.
3348 auto BBFRI = BasicBlockFwdRefs.find(F);
3349 if (BBFRI == BasicBlockFwdRefs.end()) {
3350 for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
3351 FunctionBBs[i] = BasicBlock::Create(Context, "", F);
3352 } else {
3353 auto &BBRefs = BBFRI->second;
Duncan P. N. Exon Smith5a5fd7b2014-08-16 01:54:37 +00003354 // Check for invalid basic block references.
3355 if (BBRefs.size() > FunctionBBs.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003356 return error("Invalid ID");
Duncan P. N. Exon Smith5a5fd7b2014-08-16 01:54:37 +00003357 assert(!BBRefs.empty() && "Unexpected empty array");
3358 assert(!BBRefs.front() && "Invalid reference to entry block");
3359 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
3360 ++I)
3361 if (I < RE && BBRefs[I]) {
3362 BBRefs[I]->insertInto(F);
3363 FunctionBBs[I] = BBRefs[I];
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00003364 } else {
3365 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
3366 }
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00003367
3368 // Erase from the table.
3369 BasicBlockFwdRefs.erase(BBFRI);
3370 }
3371
Chris Lattner83930552007-05-01 07:01:57 +00003372 CurBB = FunctionBBs[0];
3373 continue;
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00003374 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003375
Chris Lattner07d09ed2010-04-03 02:17:50 +00003376 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
3377 // This record indicates that the last instruction is at the same
3378 // location as the previous instruction with a location.
Duncan P. N. Exon Smith52d0f162015-01-09 02:51:45 +00003379 I = getLastInstruction();
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003380
Craig Topper2617dcc2014-04-15 06:32:26 +00003381 if (!I)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003382 return error("Invalid record");
Chris Lattner07d09ed2010-04-03 02:17:50 +00003383 I->setDebugLoc(LastLoc);
Craig Topper2617dcc2014-04-15 06:32:26 +00003384 I = nullptr;
Chris Lattner07d09ed2010-04-03 02:17:50 +00003385 continue;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003386
Duncan P. N. Exon Smith9ed19662015-01-09 17:53:27 +00003387 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
Duncan P. N. Exon Smith52d0f162015-01-09 02:51:45 +00003388 I = getLastInstruction();
Craig Topper2617dcc2014-04-15 06:32:26 +00003389 if (!I || Record.size() < 4)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003390 return error("Invalid record");
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003391
Chris Lattner07d09ed2010-04-03 02:17:50 +00003392 unsigned Line = Record[0], Col = Record[1];
3393 unsigned ScopeID = Record[2], IAID = Record[3];
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003394
Craig Topper2617dcc2014-04-15 06:32:26 +00003395 MDNode *Scope = nullptr, *IA = nullptr;
Justin Bognerae341c62016-03-17 20:12:06 +00003396 if (ScopeID) {
Mehdi Aminief27db82016-12-12 19:34:26 +00003397 Scope = MDLoader->getMDNodeFwdRefOrNull(ScopeID - 1);
Justin Bognerae341c62016-03-17 20:12:06 +00003398 if (!Scope)
3399 return error("Invalid record");
3400 }
3401 if (IAID) {
Mehdi Aminief27db82016-12-12 19:34:26 +00003402 IA = MDLoader->getMDNodeFwdRefOrNull(IAID - 1);
Justin Bognerae341c62016-03-17 20:12:06 +00003403 if (!IA)
3404 return error("Invalid record");
3405 }
Chris Lattner07d09ed2010-04-03 02:17:50 +00003406 LastLoc = DebugLoc::get(Line, Col, Scope, IA);
3407 I->setDebugLoc(LastLoc);
Craig Topper2617dcc2014-04-15 06:32:26 +00003408 I = nullptr;
Chris Lattner07d09ed2010-04-03 02:17:50 +00003409 continue;
3410 }
3411
Chris Lattnere9759c22007-05-06 00:21:25 +00003412 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
3413 unsigned OpNum = 0;
3414 Value *LHS, *RHS;
3415 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
Jan Wen Voungafaced02012-10-11 20:20:40 +00003416 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
Dan Gohman0ebd6962009-07-20 21:19:07 +00003417 OpNum+1 > Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003418 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003419
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003420 int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
Rafael Espindola48da4f42013-11-04 16:16:24 +00003421 if (Opc == -1)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003422 return error("Invalid record");
Gabor Greife1f6e4b2008-05-16 19:29:10 +00003423 I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
Devang Patelaf206b82009-09-18 19:26:43 +00003424 InstructionList.push_back(I);
Dan Gohman1b849082009-09-07 23:54:19 +00003425 if (OpNum < Record.size()) {
3426 if (Opc == Instruction::Add ||
3427 Opc == Instruction::Sub ||
Chris Lattnera676c0f2011-02-07 16:40:21 +00003428 Opc == Instruction::Mul ||
3429 Opc == Instruction::Shl) {
Dan Gohman00f47472010-01-25 21:55:39 +00003430 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
Dan Gohman1b849082009-09-07 23:54:19 +00003431 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
Dan Gohman00f47472010-01-25 21:55:39 +00003432 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
Dan Gohman1b849082009-09-07 23:54:19 +00003433 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
Chris Lattner35315d02011-02-06 21:44:57 +00003434 } else if (Opc == Instruction::SDiv ||
Chris Lattnera676c0f2011-02-07 16:40:21 +00003435 Opc == Instruction::UDiv ||
3436 Opc == Instruction::LShr ||
3437 Opc == Instruction::AShr) {
Chris Lattner35315d02011-02-06 21:44:57 +00003438 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
Dan Gohman1b849082009-09-07 23:54:19 +00003439 cast<BinaryOperator>(I)->setIsExact(true);
Michael Ilseman9978d7e2012-11-27 00:43:38 +00003440 } else if (isa<FPMathOperator>(I)) {
James Molloy88eb5352015-07-10 12:52:00 +00003441 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
Michael Ilseman9978d7e2012-11-27 00:43:38 +00003442 if (FMF.any())
3443 I->setFastMathFlags(FMF);
Dan Gohman1b849082009-09-07 23:54:19 +00003444 }
Michael Ilseman9978d7e2012-11-27 00:43:38 +00003445
Dan Gohman1b849082009-09-07 23:54:19 +00003446 }
Chris Lattner85b7b402007-05-01 05:52:21 +00003447 break;
3448 }
Chris Lattnere9759c22007-05-06 00:21:25 +00003449 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
3450 unsigned OpNum = 0;
3451 Value *Op;
3452 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3453 OpNum+2 != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003454 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003455
Chris Lattner229907c2011-07-18 04:54:35 +00003456 Type *ResTy = getTypeByID(Record[OpNum]);
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003457 int Opc = getDecodedCastOpcode(Record[OpNum + 1]);
Craig Topper2617dcc2014-04-15 06:32:26 +00003458 if (Opc == -1 || !ResTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003459 return error("Invalid record");
Craig Topper2617dcc2014-04-15 06:32:26 +00003460 Instruction *Temp = nullptr;
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00003461 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
3462 if (Temp) {
3463 InstructionList.push_back(Temp);
3464 CurBB->getInstList().push_back(Temp);
3465 }
3466 } else {
Filipe Cabecinhasb70fd872015-10-06 12:37:54 +00003467 auto CastOp = (Instruction::CastOps)Opc;
3468 if (!CastInst::castIsValid(CastOp, Op, ResTy))
3469 return error("Invalid cast");
3470 I = CastInst::Create(CastOp, Op, ResTy);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00003471 }
Devang Patelaf206b82009-09-18 19:26:43 +00003472 InstructionList.push_back(I);
Chris Lattnere53603e2007-05-02 04:27:25 +00003473 break;
3474 }
David Blaikieb5b5efd2015-02-25 01:08:52 +00003475 case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:
3476 case bitc::FUNC_CODE_INST_GEP_OLD:
3477 case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
Chris Lattnerdf1233d2007-05-06 00:00:00 +00003478 unsigned OpNum = 0;
David Blaikieb5b5efd2015-02-25 01:08:52 +00003479
3480 Type *Ty;
3481 bool InBounds;
3482
3483 if (BitCode == bitc::FUNC_CODE_INST_GEP) {
3484 InBounds = Record[OpNum++];
3485 Ty = getTypeByID(Record[OpNum++]);
3486 } else {
3487 InBounds = BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD;
3488 Ty = nullptr;
3489 }
3490
Chris Lattnerdf1233d2007-05-06 00:00:00 +00003491 Value *BasePtr;
3492 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003493 return error("Invalid record");
Chris Lattner1fc27f02007-05-02 05:16:49 +00003494
David Blaikie60310f22015-05-08 00:42:26 +00003495 if (!Ty)
Peter Collingbourne9ef5a8c2016-11-13 06:59:28 +00003496 Ty = cast<PointerType>(BasePtr->getType()->getScalarType())
David Blaikie60310f22015-05-08 00:42:26 +00003497 ->getElementType();
3498 else if (Ty !=
Peter Collingbourne9ef5a8c2016-11-13 06:59:28 +00003499 cast<PointerType>(BasePtr->getType()->getScalarType())
David Blaikie60310f22015-05-08 00:42:26 +00003500 ->getElementType())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003501 return error(
David Blaikie675e8cb2015-03-16 21:35:48 +00003502 "Explicit gep type does not match pointee type of pointer operand");
3503
Chris Lattner5285b5e2007-05-02 05:46:45 +00003504 SmallVector<Value*, 16> GEPIdx;
Chris Lattnerdf1233d2007-05-06 00:00:00 +00003505 while (OpNum != Record.size()) {
3506 Value *Op;
3507 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003508 return error("Invalid record");
Chris Lattnerdf1233d2007-05-06 00:00:00 +00003509 GEPIdx.push_back(Op);
Chris Lattner1fc27f02007-05-02 05:16:49 +00003510 }
3511
David Blaikie096b1da2015-03-14 19:53:33 +00003512 I = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
David Blaikie675e8cb2015-03-16 21:35:48 +00003513
Devang Patelaf206b82009-09-18 19:26:43 +00003514 InstructionList.push_back(I);
David Blaikieb5b5efd2015-02-25 01:08:52 +00003515 if (InBounds)
Dan Gohman1b849082009-09-07 23:54:19 +00003516 cast<GetElementPtrInst>(I)->setIsInBounds(true);
Chris Lattner1fc27f02007-05-02 05:16:49 +00003517 break;
3518 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003519
Dan Gohman1ecaf452008-05-31 00:58:22 +00003520 case bitc::FUNC_CODE_INST_EXTRACTVAL: {
3521 // EXTRACTVAL: [opty, opval, n x indices]
Dan Gohman30499842008-05-23 01:55:30 +00003522 unsigned OpNum = 0;
3523 Value *Agg;
3524 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003525 return error("Invalid record");
Dan Gohman30499842008-05-23 01:55:30 +00003526
Filipe Cabecinhas1c299d02015-05-16 00:33:12 +00003527 unsigned RecSize = Record.size();
3528 if (OpNum == RecSize)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003529 return error("EXTRACTVAL: Invalid instruction with 0 indices");
Filipe Cabecinhas1c299d02015-05-16 00:33:12 +00003530
Dan Gohman1ecaf452008-05-31 00:58:22 +00003531 SmallVector<unsigned, 4> EXTRACTVALIdx;
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003532 Type *CurTy = Agg->getType();
Filipe Cabecinhas1c299d02015-05-16 00:33:12 +00003533 for (; OpNum != RecSize; ++OpNum) {
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003534 bool IsArray = CurTy->isArrayTy();
3535 bool IsStruct = CurTy->isStructTy();
Dan Gohman1ecaf452008-05-31 00:58:22 +00003536 uint64_t Index = Record[OpNum];
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003537
3538 if (!IsStruct && !IsArray)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003539 return error("EXTRACTVAL: Invalid type");
Dan Gohman1ecaf452008-05-31 00:58:22 +00003540 if ((unsigned)Index != Index)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003541 return error("Invalid value");
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003542 if (IsStruct && Index >= CurTy->subtypes().size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003543 return error("EXTRACTVAL: Invalid struct index");
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003544 if (IsArray && Index >= CurTy->getArrayNumElements())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003545 return error("EXTRACTVAL: Invalid array index");
Dan Gohman1ecaf452008-05-31 00:58:22 +00003546 EXTRACTVALIdx.push_back((unsigned)Index);
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003547
3548 if (IsStruct)
3549 CurTy = CurTy->subtypes()[Index];
3550 else
3551 CurTy = CurTy->subtypes()[0];
Dan Gohman30499842008-05-23 01:55:30 +00003552 }
3553
Jay Foad57aa6362011-07-13 10:26:04 +00003554 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
Devang Patelaf206b82009-09-18 19:26:43 +00003555 InstructionList.push_back(I);
Dan Gohman30499842008-05-23 01:55:30 +00003556 break;
3557 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003558
Dan Gohman1ecaf452008-05-31 00:58:22 +00003559 case bitc::FUNC_CODE_INST_INSERTVAL: {
3560 // INSERTVAL: [opty, opval, opty, opval, n x indices]
Dan Gohman30499842008-05-23 01:55:30 +00003561 unsigned OpNum = 0;
3562 Value *Agg;
3563 if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003564 return error("Invalid record");
Dan Gohman30499842008-05-23 01:55:30 +00003565 Value *Val;
3566 if (getValueTypePair(Record, OpNum, NextValueNo, Val))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003567 return error("Invalid record");
Dan Gohman30499842008-05-23 01:55:30 +00003568
Filipe Cabecinhas1c299d02015-05-16 00:33:12 +00003569 unsigned RecSize = Record.size();
3570 if (OpNum == RecSize)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003571 return error("INSERTVAL: Invalid instruction with 0 indices");
Filipe Cabecinhas1c299d02015-05-16 00:33:12 +00003572
Dan Gohman1ecaf452008-05-31 00:58:22 +00003573 SmallVector<unsigned, 4> INSERTVALIdx;
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003574 Type *CurTy = Agg->getType();
Filipe Cabecinhas1c299d02015-05-16 00:33:12 +00003575 for (; OpNum != RecSize; ++OpNum) {
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003576 bool IsArray = CurTy->isArrayTy();
3577 bool IsStruct = CurTy->isStructTy();
Dan Gohman1ecaf452008-05-31 00:58:22 +00003578 uint64_t Index = Record[OpNum];
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003579
3580 if (!IsStruct && !IsArray)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003581 return error("INSERTVAL: Invalid type");
Dan Gohman1ecaf452008-05-31 00:58:22 +00003582 if ((unsigned)Index != Index)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003583 return error("Invalid value");
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003584 if (IsStruct && Index >= CurTy->subtypes().size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003585 return error("INSERTVAL: Invalid struct index");
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003586 if (IsArray && Index >= CurTy->getArrayNumElements())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003587 return error("INSERTVAL: Invalid array index");
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003588
Dan Gohman1ecaf452008-05-31 00:58:22 +00003589 INSERTVALIdx.push_back((unsigned)Index);
Filipe Cabecinhasecf8f7f2015-02-16 00:03:11 +00003590 if (IsStruct)
3591 CurTy = CurTy->subtypes()[Index];
3592 else
3593 CurTy = CurTy->subtypes()[0];
Dan Gohman30499842008-05-23 01:55:30 +00003594 }
3595
Filipe Cabecinhas4708a022015-05-18 22:27:11 +00003596 if (CurTy != Val->getType())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003597 return error("Inserted value type doesn't match aggregate type");
Filipe Cabecinhas4708a022015-05-18 22:27:11 +00003598
Jay Foad57aa6362011-07-13 10:26:04 +00003599 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
Devang Patelaf206b82009-09-18 19:26:43 +00003600 InstructionList.push_back(I);
Dan Gohman30499842008-05-23 01:55:30 +00003601 break;
3602 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003603
Chris Lattnere9759c22007-05-06 00:21:25 +00003604 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
Dan Gohmanc5d28922008-09-16 01:01:33 +00003605 // obsolete form of select
3606 // handles select i1 ... in old bitcode
Chris Lattnere9759c22007-05-06 00:21:25 +00003607 unsigned OpNum = 0;
3608 Value *TrueVal, *FalseVal, *Cond;
3609 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
Jan Wen Voungafaced02012-10-11 20:20:40 +00003610 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
3611 popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003612 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003613
Dan Gohmanc5d28922008-09-16 01:01:33 +00003614 I = SelectInst::Create(Cond, TrueVal, FalseVal);
Devang Patelaf206b82009-09-18 19:26:43 +00003615 InstructionList.push_back(I);
Dan Gohmanc5d28922008-09-16 01:01:33 +00003616 break;
3617 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003618
Dan Gohmanc5d28922008-09-16 01:01:33 +00003619 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
3620 // new form of select
3621 // handles select i1 or select [N x i1]
3622 unsigned OpNum = 0;
3623 Value *TrueVal, *FalseVal, *Cond;
3624 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
Jan Wen Voungafaced02012-10-11 20:20:40 +00003625 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
Dan Gohmanc5d28922008-09-16 01:01:33 +00003626 getValueTypePair(Record, OpNum, NextValueNo, Cond))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003627 return error("Invalid record");
Dan Gohmanc579d972008-09-09 01:02:47 +00003628
3629 // select condition can be either i1 or [N x i1]
Chris Lattner229907c2011-07-18 04:54:35 +00003630 if (VectorType* vector_type =
3631 dyn_cast<VectorType>(Cond->getType())) {
Dan Gohmanc579d972008-09-09 01:02:47 +00003632 // expect <n x i1>
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003633 if (vector_type->getElementType() != Type::getInt1Ty(Context))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003634 return error("Invalid type for value");
Dan Gohmanc579d972008-09-09 01:02:47 +00003635 } else {
3636 // expect i1
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003637 if (Cond->getType() != Type::getInt1Ty(Context))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003638 return error("Invalid type for value");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003639 }
3640
Gabor Greife9ecc682008-04-06 20:25:17 +00003641 I = SelectInst::Create(Cond, TrueVal, FalseVal);
Devang Patelaf206b82009-09-18 19:26:43 +00003642 InstructionList.push_back(I);
Chris Lattner1fc27f02007-05-02 05:16:49 +00003643 break;
3644 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003645
Chris Lattner1fc27f02007-05-02 05:16:49 +00003646 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
Chris Lattnere9759c22007-05-06 00:21:25 +00003647 unsigned OpNum = 0;
3648 Value *Vec, *Idx;
3649 if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00003650 getValueTypePair(Record, OpNum, NextValueNo, Idx))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003651 return error("Invalid record");
Filipe Cabecinhasff1e2342015-04-24 11:30:15 +00003652 if (!Vec->getType()->isVectorTy())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003653 return error("Invalid type for value");
Eric Christopherc9742252009-07-25 02:28:41 +00003654 I = ExtractElementInst::Create(Vec, Idx);
Devang Patelaf206b82009-09-18 19:26:43 +00003655 InstructionList.push_back(I);
Chris Lattner1fc27f02007-05-02 05:16:49 +00003656 break;
3657 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003658
Chris Lattner1fc27f02007-05-02 05:16:49 +00003659 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
Chris Lattnere9759c22007-05-06 00:21:25 +00003660 unsigned OpNum = 0;
3661 Value *Vec, *Elt, *Idx;
Filipe Cabecinhasff1e2342015-04-24 11:30:15 +00003662 if (getValueTypePair(Record, OpNum, NextValueNo, Vec))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003663 return error("Invalid record");
Filipe Cabecinhasff1e2342015-04-24 11:30:15 +00003664 if (!Vec->getType()->isVectorTy())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003665 return error("Invalid type for value");
Filipe Cabecinhasff1e2342015-04-24 11:30:15 +00003666 if (popValue(Record, OpNum, NextValueNo,
Chris Lattnere9759c22007-05-06 00:21:25 +00003667 cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00003668 getValueTypePair(Record, OpNum, NextValueNo, Idx))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003669 return error("Invalid record");
Gabor Greife9ecc682008-04-06 20:25:17 +00003670 I = InsertElementInst::Create(Vec, Elt, Idx);
Devang Patelaf206b82009-09-18 19:26:43 +00003671 InstructionList.push_back(I);
Chris Lattner1fc27f02007-05-02 05:16:49 +00003672 break;
3673 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003674
Chris Lattnere9759c22007-05-06 00:21:25 +00003675 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
3676 unsigned OpNum = 0;
3677 Value *Vec1, *Vec2, *Mask;
3678 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
Jan Wen Voungafaced02012-10-11 20:20:40 +00003679 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003680 return error("Invalid record");
Chris Lattnere9759c22007-05-06 00:21:25 +00003681
Mon P Wang25f01062008-11-10 04:46:22 +00003682 if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003683 return error("Invalid record");
Filipe Cabecinhasff1e2342015-04-24 11:30:15 +00003684 if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003685 return error("Invalid type for value");
Chris Lattner1fc27f02007-05-02 05:16:49 +00003686 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
Devang Patelaf206b82009-09-18 19:26:43 +00003687 InstructionList.push_back(I);
Chris Lattner1fc27f02007-05-02 05:16:49 +00003688 break;
3689 }
Mon P Wang25f01062008-11-10 04:46:22 +00003690
Nick Lewyckya21d3da2009-07-08 03:04:38 +00003691 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
3692 // Old form of ICmp/FCmp returning bool
3693 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
3694 // both legal on vectors but had different behaviour.
3695 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
3696 // FCmp/ICmp returning bool or vector of bool
3697
Chris Lattnerdf1233d2007-05-06 00:00:00 +00003698 unsigned OpNum = 0;
3699 Value *LHS, *RHS;
3700 if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
James Molloy88eb5352015-07-10 12:52:00 +00003701 popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS))
3702 return error("Invalid record");
3703
3704 unsigned PredVal = Record[OpNum];
3705 bool IsFP = LHS->getType()->isFPOrFPVectorTy();
3706 FastMathFlags FMF;
3707 if (IsFP && Record.size() > OpNum+1)
3708 FMF = getDecodedFastMathFlags(Record[++OpNum]);
3709
3710 if (OpNum+1 != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003711 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003712
Duncan Sands9dff9be2010-02-15 16:12:20 +00003713 if (LHS->getType()->isFPOrFPVectorTy())
James Molloy88eb5352015-07-10 12:52:00 +00003714 I = new FCmpInst((FCmpInst::Predicate)PredVal, LHS, RHS);
Nick Lewyckya21d3da2009-07-08 03:04:38 +00003715 else
James Molloy88eb5352015-07-10 12:52:00 +00003716 I = new ICmpInst((ICmpInst::Predicate)PredVal, LHS, RHS);
3717
3718 if (FMF.any())
3719 I->setFastMathFlags(FMF);
Devang Patelaf206b82009-09-18 19:26:43 +00003720 InstructionList.push_back(I);
Dan Gohmanc579d972008-09-09 01:02:47 +00003721 break;
3722 }
Nick Lewyckya21d3da2009-07-08 03:04:38 +00003723
Chris Lattnere53603e2007-05-02 04:27:25 +00003724 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
Devang Patelbbfd8742008-02-26 01:29:32 +00003725 {
3726 unsigned Size = Record.size();
3727 if (Size == 0) {
Owen Anderson55f1c092009-08-13 21:58:54 +00003728 I = ReturnInst::Create(Context);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003729 InstructionList.push_back(I);
Devang Patelbbfd8742008-02-26 01:29:32 +00003730 break;
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003731 }
Devang Patelbbfd8742008-02-26 01:29:32 +00003732
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003733 unsigned OpNum = 0;
Craig Topper2617dcc2014-04-15 06:32:26 +00003734 Value *Op = nullptr;
Chris Lattnerf1c87102011-06-17 18:09:11 +00003735 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003736 return error("Invalid record");
Chris Lattnerf1c87102011-06-17 18:09:11 +00003737 if (OpNum != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003738 return error("Invalid record");
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003739
Chris Lattnerf1c87102011-06-17 18:09:11 +00003740 I = ReturnInst::Create(Context, Op);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003741 InstructionList.push_back(I);
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003742 break;
Chris Lattnere53603e2007-05-02 04:27:25 +00003743 }
Chris Lattner5285b5e2007-05-02 05:46:45 +00003744 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
Chris Lattner6ce15cb2007-05-03 22:09:51 +00003745 if (Record.size() != 1 && Record.size() != 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003746 return error("Invalid record");
Chris Lattner5285b5e2007-05-02 05:46:45 +00003747 BasicBlock *TrueDest = getBasicBlock(Record[0]);
Craig Topper2617dcc2014-04-15 06:32:26 +00003748 if (!TrueDest)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003749 return error("Invalid record");
Chris Lattner5285b5e2007-05-02 05:46:45 +00003750
Devang Patelaf206b82009-09-18 19:26:43 +00003751 if (Record.size() == 1) {
Gabor Greife9ecc682008-04-06 20:25:17 +00003752 I = BranchInst::Create(TrueDest);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003753 InstructionList.push_back(I);
Devang Patelaf206b82009-09-18 19:26:43 +00003754 }
Chris Lattner5285b5e2007-05-02 05:46:45 +00003755 else {
3756 BasicBlock *FalseDest = getBasicBlock(Record[1]);
Jan Wen Voungafaced02012-10-11 20:20:40 +00003757 Value *Cond = getValue(Record, 2, NextValueNo,
3758 Type::getInt1Ty(Context));
Craig Topper2617dcc2014-04-15 06:32:26 +00003759 if (!FalseDest || !Cond)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003760 return error("Invalid record");
Gabor Greife9ecc682008-04-06 20:25:17 +00003761 I = BranchInst::Create(TrueDest, FalseDest, Cond);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003762 InstructionList.push_back(I);
Chris Lattner5285b5e2007-05-02 05:46:45 +00003763 }
3764 break;
3765 }
David Majnemerb01aa9f2015-08-23 19:22:31 +00003766 case bitc::FUNC_CODE_INST_CLEANUPRET: { // CLEANUPRET: [val] or [val,bb#]
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003767 if (Record.size() != 1 && Record.size() != 2)
David Majnemer654e1302015-07-31 17:58:14 +00003768 return error("Invalid record");
3769 unsigned Idx = 0;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003770 Value *CleanupPad =
3771 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003772 if (!CleanupPad)
David Majnemer654e1302015-07-31 17:58:14 +00003773 return error("Invalid record");
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003774 BasicBlock *UnwindDest = nullptr;
3775 if (Record.size() == 2) {
David Majnemer654e1302015-07-31 17:58:14 +00003776 UnwindDest = getBasicBlock(Record[Idx++]);
3777 if (!UnwindDest)
3778 return error("Invalid record");
3779 }
3780
David Majnemer8a1c45d2015-12-12 05:38:55 +00003781 I = CleanupReturnInst::Create(CleanupPad, UnwindDest);
David Majnemer654e1302015-07-31 17:58:14 +00003782 InstructionList.push_back(I);
3783 break;
3784 }
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003785 case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [val,bb#]
3786 if (Record.size() != 2)
David Majnemer654e1302015-07-31 17:58:14 +00003787 return error("Invalid record");
David Majnemer0bc0eef2015-08-15 02:46:08 +00003788 unsigned Idx = 0;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003789 Value *CatchPad =
3790 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003791 if (!CatchPad)
3792 return error("Invalid record");
David Majnemer0bc0eef2015-08-15 02:46:08 +00003793 BasicBlock *BB = getBasicBlock(Record[Idx++]);
David Majnemer654e1302015-07-31 17:58:14 +00003794 if (!BB)
3795 return error("Invalid record");
David Majnemer0bc0eef2015-08-15 02:46:08 +00003796
David Majnemer8a1c45d2015-12-12 05:38:55 +00003797 I = CatchReturnInst::Create(CatchPad, BB);
David Majnemer654e1302015-07-31 17:58:14 +00003798 InstructionList.push_back(I);
3799 break;
3800 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003801 case bitc::FUNC_CODE_INST_CATCHSWITCH: { // CATCHSWITCH: [tok,num,(bb)*,bb?]
3802 // We must have, at minimum, the outer scope and the number of arguments.
3803 if (Record.size() < 2)
David Majnemer654e1302015-07-31 17:58:14 +00003804 return error("Invalid record");
3805
David Majnemer654e1302015-07-31 17:58:14 +00003806 unsigned Idx = 0;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003807
3808 Value *ParentPad =
3809 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
3810
3811 unsigned NumHandlers = Record[Idx++];
3812
3813 SmallVector<BasicBlock *, 2> Handlers;
3814 for (unsigned Op = 0; Op != NumHandlers; ++Op) {
3815 BasicBlock *BB = getBasicBlock(Record[Idx++]);
3816 if (!BB)
David Majnemer654e1302015-07-31 17:58:14 +00003817 return error("Invalid record");
David Majnemer8a1c45d2015-12-12 05:38:55 +00003818 Handlers.push_back(BB);
3819 }
3820
3821 BasicBlock *UnwindDest = nullptr;
3822 if (Idx + 1 == Record.size()) {
David Majnemer654e1302015-07-31 17:58:14 +00003823 UnwindDest = getBasicBlock(Record[Idx++]);
3824 if (!UnwindDest)
3825 return error("Invalid record");
3826 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003827
3828 if (Record.size() != Idx)
3829 return error("Invalid record");
3830
3831 auto *CatchSwitch =
3832 CatchSwitchInst::Create(ParentPad, UnwindDest, NumHandlers);
3833 for (BasicBlock *Handler : Handlers)
3834 CatchSwitch->addHandler(Handler);
3835 I = CatchSwitch;
3836 InstructionList.push_back(I);
3837 break;
3838 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003839 case bitc::FUNC_CODE_INST_CATCHPAD:
3840 case bitc::FUNC_CODE_INST_CLEANUPPAD: { // [tok,num,(ty,val)*]
3841 // We must have, at minimum, the outer scope and the number of arguments.
3842 if (Record.size() < 2)
David Majnemer654e1302015-07-31 17:58:14 +00003843 return error("Invalid record");
David Majnemer8a1c45d2015-12-12 05:38:55 +00003844
David Majnemer654e1302015-07-31 17:58:14 +00003845 unsigned Idx = 0;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003846
3847 Value *ParentPad =
3848 getValue(Record, Idx++, NextValueNo, Type::getTokenTy(Context));
3849
David Majnemer654e1302015-07-31 17:58:14 +00003850 unsigned NumArgOperands = Record[Idx++];
David Majnemer8a1c45d2015-12-12 05:38:55 +00003851
David Majnemer654e1302015-07-31 17:58:14 +00003852 SmallVector<Value *, 2> Args;
3853 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
3854 Value *Val;
3855 if (getValueTypePair(Record, Idx, NextValueNo, Val))
3856 return error("Invalid record");
3857 Args.push_back(Val);
3858 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003859
David Majnemer654e1302015-07-31 17:58:14 +00003860 if (Record.size() != Idx)
3861 return error("Invalid record");
3862
David Majnemer8a1c45d2015-12-12 05:38:55 +00003863 if (BitCode == bitc::FUNC_CODE_INST_CLEANUPPAD)
3864 I = CleanupPadInst::Create(ParentPad, Args);
3865 else
3866 I = CatchPadInst::Create(ParentPad, Args);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003867 InstructionList.push_back(I);
3868 break;
3869 }
Chris Lattner3ed871f2009-10-27 19:13:16 +00003870 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003871 // Check magic
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003872 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
Bob Wilsone4077362013-09-09 19:14:35 +00003873 // "New" SwitchInst format with case ranges. The changes to write this
3874 // format were reverted but we still recognize bitcode that uses it.
3875 // Hopefully someday we will have support for case ranges and can use
3876 // this format again.
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003877
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003878 Type *OpTy = getTypeByID(Record[1]);
3879 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
3880
Jan Wen Voungafaced02012-10-11 20:20:40 +00003881 Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003882 BasicBlock *Default = getBasicBlock(Record[3]);
Craig Topper2617dcc2014-04-15 06:32:26 +00003883 if (!OpTy || !Cond || !Default)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003884 return error("Invalid record");
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003885
3886 unsigned NumCases = Record[4];
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003887
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003888 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
3889 InstructionList.push_back(SI);
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003890
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003891 unsigned CurIdx = 5;
3892 for (unsigned i = 0; i != NumCases; ++i) {
Bob Wilsone4077362013-09-09 19:14:35 +00003893 SmallVector<ConstantInt*, 1> CaseVals;
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003894 unsigned NumItems = Record[CurIdx++];
3895 for (unsigned ci = 0; ci != NumItems; ++ci) {
3896 bool isSingleNumber = Record[CurIdx++];
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003897
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003898 APInt Low;
3899 unsigned ActiveWords = 1;
3900 if (ValueBitWidth > 64)
3901 ActiveWords = Record[CurIdx++];
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003902 Low = readWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
Benjamin Kramer9704ed02012-05-28 14:10:31 +00003903 ValueBitWidth);
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003904 CurIdx += ActiveWords;
Stepan Dyatkovskiye3e19cb2012-05-28 12:39:09 +00003905
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003906 if (!isSingleNumber) {
3907 ActiveWords = 1;
3908 if (ValueBitWidth > 64)
3909 ActiveWords = Record[CurIdx++];
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003910 APInt High = readWideAPInt(
3911 makeArrayRef(&Record[CurIdx], ActiveWords), ValueBitWidth);
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003912 CurIdx += ActiveWords;
Bob Wilsone4077362013-09-09 19:14:35 +00003913
3914 // FIXME: It is not clear whether values in the range should be
3915 // compared as signed or unsigned values. The partially
3916 // implemented changes that used this format in the past used
3917 // unsigned comparisons.
3918 for ( ; Low.ule(High); ++Low)
3919 CaseVals.push_back(ConstantInt::get(Context, Low));
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003920 } else
Bob Wilsone4077362013-09-09 19:14:35 +00003921 CaseVals.push_back(ConstantInt::get(Context, Low));
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003922 }
3923 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
Bob Wilsone4077362013-09-09 19:14:35 +00003924 for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
3925 cve = CaseVals.end(); cvi != cve; ++cvi)
3926 SI->addCase(*cvi, DestBB);
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003927 }
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003928 I = SI;
3929 break;
3930 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003931
Stepan Dyatkovskiy0beab5e2012-05-12 10:48:17 +00003932 // Old SwitchInst format without case ranges.
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003933
Chris Lattner5285b5e2007-05-02 05:46:45 +00003934 if (Record.size() < 3 || (Record.size() & 1) == 0)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003935 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00003936 Type *OpTy = getTypeByID(Record[0]);
Jan Wen Voungafaced02012-10-11 20:20:40 +00003937 Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
Chris Lattner5285b5e2007-05-02 05:46:45 +00003938 BasicBlock *Default = getBasicBlock(Record[2]);
Craig Topper2617dcc2014-04-15 06:32:26 +00003939 if (!OpTy || !Cond || !Default)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003940 return error("Invalid record");
Chris Lattner5285b5e2007-05-02 05:46:45 +00003941 unsigned NumCases = (Record.size()-3)/2;
Gabor Greife9ecc682008-04-06 20:25:17 +00003942 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
Devang Patelaf206b82009-09-18 19:26:43 +00003943 InstructionList.push_back(SI);
Chris Lattner5285b5e2007-05-02 05:46:45 +00003944 for (unsigned i = 0, e = NumCases; i != e; ++i) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003945 ConstantInt *CaseVal =
Chris Lattner5285b5e2007-05-02 05:46:45 +00003946 dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
3947 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
Craig Topper2617dcc2014-04-15 06:32:26 +00003948 if (!CaseVal || !DestBB) {
Chris Lattner5285b5e2007-05-02 05:46:45 +00003949 delete SI;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003950 return error("Invalid record");
Chris Lattner5285b5e2007-05-02 05:46:45 +00003951 }
3952 SI->addCase(CaseVal, DestBB);
3953 }
3954 I = SI;
3955 break;
3956 }
Chris Lattnerd04cb6d2009-10-28 00:19:10 +00003957 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
Chris Lattner3ed871f2009-10-27 19:13:16 +00003958 if (Record.size() < 2)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003959 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00003960 Type *OpTy = getTypeByID(Record[0]);
Jan Wen Voungafaced02012-10-11 20:20:40 +00003961 Value *Address = getValue(Record, 1, NextValueNo, OpTy);
Craig Topper2617dcc2014-04-15 06:32:26 +00003962 if (!OpTy || !Address)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003963 return error("Invalid record");
Chris Lattner3ed871f2009-10-27 19:13:16 +00003964 unsigned NumDests = Record.size()-2;
Chris Lattnerd04cb6d2009-10-28 00:19:10 +00003965 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
Chris Lattner3ed871f2009-10-27 19:13:16 +00003966 InstructionList.push_back(IBI);
3967 for (unsigned i = 0, e = NumDests; i != e; ++i) {
3968 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
3969 IBI->addDestination(DestBB);
3970 } else {
3971 delete IBI;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003972 return error("Invalid record");
Chris Lattner3ed871f2009-10-27 19:13:16 +00003973 }
3974 }
3975 I = IBI;
3976 break;
3977 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00003978
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00003979 case bitc::FUNC_CODE_INST_INVOKE: {
3980 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
Rafael Espindola48da4f42013-11-04 16:16:24 +00003981 if (Record.size() < 4)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003982 return error("Invalid record");
David Blaikie5ea1f7b2015-04-24 18:06:06 +00003983 unsigned OpNum = 0;
Reid Klecknerb5180542017-03-21 16:57:19 +00003984 AttributeList PAL = getAttributes(Record[OpNum++]);
David Blaikie5ea1f7b2015-04-24 18:06:06 +00003985 unsigned CCInfo = Record[OpNum++];
3986 BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);
3987 BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003988
David Blaikie5ea1f7b2015-04-24 18:06:06 +00003989 FunctionType *FTy = nullptr;
3990 if (CCInfo >> 13 & 1 &&
3991 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003992 return error("Explicit invoke type is not a function type");
David Blaikie5ea1f7b2015-04-24 18:06:06 +00003993
Chris Lattnerdf1233d2007-05-06 00:00:00 +00003994 Value *Callee;
3995 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00003996 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003997
Chris Lattner229907c2011-07-18 04:54:35 +00003998 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
David Blaikie5ea1f7b2015-04-24 18:06:06 +00003999 if (!CalleeTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004000 return error("Callee is not a pointer");
David Blaikie5ea1f7b2015-04-24 18:06:06 +00004001 if (!FTy) {
4002 FTy = dyn_cast<FunctionType>(CalleeTy->getElementType());
4003 if (!FTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004004 return error("Callee is not of pointer to function type");
David Blaikie5ea1f7b2015-04-24 18:06:06 +00004005 } else if (CalleeTy->getElementType() != FTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004006 return error("Explicit invoke type does not match pointee type of "
David Blaikie5ea1f7b2015-04-24 18:06:06 +00004007 "callee operand");
4008 if (Record.size() < FTy->getNumParams() + OpNum)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004009 return error("Insufficient operands to call");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004010
Chris Lattner5285b5e2007-05-02 05:46:45 +00004011 SmallVector<Value*, 16> Ops;
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004012 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
Jan Wen Voungafaced02012-10-11 20:20:40 +00004013 Ops.push_back(getValue(Record, OpNum, NextValueNo,
4014 FTy->getParamType(i)));
Craig Topper2617dcc2014-04-15 06:32:26 +00004015 if (!Ops.back())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004016 return error("Invalid record");
Chris Lattner5285b5e2007-05-02 05:46:45 +00004017 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004018
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004019 if (!FTy->isVarArg()) {
4020 if (Record.size() != OpNum)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004021 return error("Invalid record");
Chris Lattner5285b5e2007-05-02 05:46:45 +00004022 } else {
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004023 // Read type/value pairs for varargs params.
4024 while (OpNum != Record.size()) {
4025 Value *Op;
4026 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004027 return error("Invalid record");
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004028 Ops.push_back(Op);
4029 }
Chris Lattner5285b5e2007-05-02 05:46:45 +00004030 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004031
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004032 I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops, OperandBundles);
4033 OperandBundles.clear();
Devang Patelaf206b82009-09-18 19:26:43 +00004034 InstructionList.push_back(I);
Vedant Kumarad6d6e72015-10-27 21:17:06 +00004035 cast<InvokeInst>(I)->setCallingConv(
4036 static_cast<CallingConv::ID>(CallingConv::MaxID & CCInfo));
Devang Patel4c758ea2008-09-25 21:00:45 +00004037 cast<InvokeInst>(I)->setAttributes(PAL);
Chris Lattner5285b5e2007-05-02 05:46:45 +00004038 break;
4039 }
Bill Wendlingf891bf82011-07-31 06:30:59 +00004040 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
4041 unsigned Idx = 0;
Craig Topper2617dcc2014-04-15 06:32:26 +00004042 Value *Val = nullptr;
Bill Wendlingf891bf82011-07-31 06:30:59 +00004043 if (getValueTypePair(Record, Idx, NextValueNo, Val))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004044 return error("Invalid record");
Bill Wendlingf891bf82011-07-31 06:30:59 +00004045 I = ResumeInst::Create(Val);
Bill Wendlingb9a89992011-09-01 00:50:20 +00004046 InstructionList.push_back(I);
Bill Wendlingf891bf82011-07-31 06:30:59 +00004047 break;
4048 }
Chris Lattnere53603e2007-05-02 04:27:25 +00004049 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
Owen Anderson55f1c092009-08-13 21:58:54 +00004050 I = new UnreachableInst(Context);
Devang Patelaf206b82009-09-18 19:26:43 +00004051 InstructionList.push_back(I);
Chris Lattnere53603e2007-05-02 04:27:25 +00004052 break;
Chris Lattnere9759c22007-05-06 00:21:25 +00004053 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
Chris Lattnere14cb882007-05-04 19:11:41 +00004054 if (Record.size() < 1 || ((Record.size()-1)&1))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004055 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00004056 Type *Ty = getTypeByID(Record[0]);
Rafael Espindola48da4f42013-11-04 16:16:24 +00004057 if (!Ty)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004058 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004059
Jay Foad52131342011-03-30 11:28:46 +00004060 PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
Devang Patelaf206b82009-09-18 19:26:43 +00004061 InstructionList.push_back(PN);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004062
Chris Lattnere14cb882007-05-04 19:11:41 +00004063 for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
Jan Wen Voungafaced02012-10-11 20:20:40 +00004064 Value *V;
4065 // With the new function encoding, it is possible that operands have
4066 // negative IDs (for forward references). Use a signed VBR
4067 // representation to keep the encoding small.
4068 if (UseRelativeIDs)
4069 V = getValueSigned(Record, 1+i, NextValueNo, Ty);
4070 else
4071 V = getValue(Record, 1+i, NextValueNo, Ty);
Chris Lattnere14cb882007-05-04 19:11:41 +00004072 BasicBlock *BB = getBasicBlock(Record[2+i]);
Rafael Espindola48da4f42013-11-04 16:16:24 +00004073 if (!V || !BB)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004074 return error("Invalid record");
Chris Lattnerc332bba2007-05-03 18:58:09 +00004075 PN->addIncoming(V, BB);
4076 }
4077 I = PN;
4078 break;
4079 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004080
David Majnemer7fddecc2015-06-17 20:52:32 +00004081 case bitc::FUNC_CODE_INST_LANDINGPAD:
4082 case bitc::FUNC_CODE_INST_LANDINGPAD_OLD: {
Bill Wendlingfae14752011-08-12 20:24:12 +00004083 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
4084 unsigned Idx = 0;
David Majnemer7fddecc2015-06-17 20:52:32 +00004085 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {
4086 if (Record.size() < 3)
4087 return error("Invalid record");
4088 } else {
4089 assert(BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD);
4090 if (Record.size() < 4)
4091 return error("Invalid record");
4092 }
Bill Wendlingfae14752011-08-12 20:24:12 +00004093 Type *Ty = getTypeByID(Record[Idx++]);
Rafael Espindola48da4f42013-11-04 16:16:24 +00004094 if (!Ty)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004095 return error("Invalid record");
David Majnemer7fddecc2015-06-17 20:52:32 +00004096 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {
4097 Value *PersFn = nullptr;
4098 if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
4099 return error("Invalid record");
4100
4101 if (!F->hasPersonalityFn())
4102 F->setPersonalityFn(cast<Constant>(PersFn));
4103 else if (F->getPersonalityFn() != cast<Constant>(PersFn))
4104 return error("Personality function mismatch");
4105 }
Bill Wendlingfae14752011-08-12 20:24:12 +00004106
4107 bool IsCleanup = !!Record[Idx++];
4108 unsigned NumClauses = Record[Idx++];
David Majnemer7fddecc2015-06-17 20:52:32 +00004109 LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);
Bill Wendlingfae14752011-08-12 20:24:12 +00004110 LP->setCleanup(IsCleanup);
4111 for (unsigned J = 0; J != NumClauses; ++J) {
4112 LandingPadInst::ClauseType CT =
4113 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
4114 Value *Val;
4115
4116 if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
4117 delete LP;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004118 return error("Invalid record");
Bill Wendlingfae14752011-08-12 20:24:12 +00004119 }
4120
4121 assert((CT != LandingPadInst::Catch ||
4122 !isa<ArrayType>(Val->getType())) &&
4123 "Catch clause has a invalid type!");
4124 assert((CT != LandingPadInst::Filter ||
4125 isa<ArrayType>(Val->getType())) &&
4126 "Filter clause has invalid type!");
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00004127 LP->addClause(cast<Constant>(Val));
Bill Wendlingfae14752011-08-12 20:24:12 +00004128 }
4129
4130 I = LP;
Bill Wendlingb9a89992011-09-01 00:50:20 +00004131 InstructionList.push_back(I);
Bill Wendlingfae14752011-08-12 20:24:12 +00004132 break;
4133 }
4134
Chris Lattnerf1c87102011-06-17 18:09:11 +00004135 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
4136 if (Record.size() != 4)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004137 return error("Invalid record");
JF Bastien30bf96b2015-02-22 19:32:03 +00004138 uint64_t AlignRecord = Record[3];
4139 const uint64_t InAllocaMask = uint64_t(1) << 5;
David Blaikiebdb49102015-04-28 16:51:01 +00004140 const uint64_t ExplicitTypeMask = uint64_t(1) << 6;
Manman Ren9bfd0d02016-04-01 21:41:15 +00004141 const uint64_t SwiftErrorMask = uint64_t(1) << 7;
4142 const uint64_t FlagMask = InAllocaMask | ExplicitTypeMask |
4143 SwiftErrorMask;
JF Bastien30bf96b2015-02-22 19:32:03 +00004144 bool InAlloca = AlignRecord & InAllocaMask;
Manman Ren9bfd0d02016-04-01 21:41:15 +00004145 bool SwiftError = AlignRecord & SwiftErrorMask;
David Blaikiebdb49102015-04-28 16:51:01 +00004146 Type *Ty = getTypeByID(Record[0]);
4147 if ((AlignRecord & ExplicitTypeMask) == 0) {
4148 auto *PTy = dyn_cast_or_null<PointerType>(Ty);
4149 if (!PTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004150 return error("Old-style alloca with a non-pointer type");
David Blaikiebdb49102015-04-28 16:51:01 +00004151 Ty = PTy->getElementType();
4152 }
4153 Type *OpTy = getTypeByID(Record[1]);
4154 Value *Size = getFnValueByID(Record[2], OpTy);
JF Bastien30bf96b2015-02-22 19:32:03 +00004155 unsigned Align;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004156 if (Error Err = parseAlignmentValue(AlignRecord & ~FlagMask, Align)) {
4157 return Err;
JF Bastien30bf96b2015-02-22 19:32:03 +00004158 }
Rafael Espindola48da4f42013-11-04 16:16:24 +00004159 if (!Ty || !Size)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004160 return error("Invalid record");
Matt Arsenault3c1fc762017-04-10 22:27:50 +00004161
4162 // FIXME: Make this an optional field.
4163 const DataLayout &DL = TheModule->getDataLayout();
4164 unsigned AS = DL.getAllocaAddrSpace();
4165
4166 AllocaInst *AI = new AllocaInst(Ty, AS, Size, Align);
Reid Kleckner56b56ea2014-07-16 01:34:27 +00004167 AI->setUsedWithInAlloca(InAlloca);
Manman Ren9bfd0d02016-04-01 21:41:15 +00004168 AI->setSwiftError(SwiftError);
Reid Kleckner56b56ea2014-07-16 01:34:27 +00004169 I = AI;
Devang Patelaf206b82009-09-18 19:26:43 +00004170 InstructionList.push_back(I);
Chris Lattnerc332bba2007-05-03 18:58:09 +00004171 break;
4172 }
Chris Lattner9f600c52007-05-03 22:04:19 +00004173 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004174 unsigned OpNum = 0;
4175 Value *Op;
4176 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
David Blaikie85035652015-02-25 01:07:20 +00004177 (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004178 return error("Invalid record");
David Blaikie85035652015-02-25 01:07:20 +00004179
4180 Type *Ty = nullptr;
4181 if (OpNum + 3 == Record.size())
4182 Ty = getTypeByID(Record[OpNum++]);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004183 if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))
4184 return Err;
David Blaikieb7a029872015-04-17 19:56:21 +00004185 if (!Ty)
4186 Ty = cast<PointerType>(Op->getType())->getElementType();
David Blaikie85035652015-02-25 01:07:20 +00004187
JF Bastien30bf96b2015-02-22 19:32:03 +00004188 unsigned Align;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004189 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4190 return Err;
David Blaikieb7a029872015-04-17 19:56:21 +00004191 I = new LoadInst(Ty, Op, "", Record[OpNum + 1], Align);
David Blaikie85035652015-02-25 01:07:20 +00004192
Devang Patelaf206b82009-09-18 19:26:43 +00004193 InstructionList.push_back(I);
Chris Lattner83930552007-05-01 07:01:57 +00004194 break;
Chris Lattner9f600c52007-05-03 22:04:19 +00004195 }
Eli Friedman59b66882011-08-09 23:02:53 +00004196 case bitc::FUNC_CODE_INST_LOADATOMIC: {
4197 // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
4198 unsigned OpNum = 0;
4199 Value *Op;
4200 if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
David Blaikie85035652015-02-25 01:07:20 +00004201 (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004202 return error("Invalid record");
Eli Friedman59b66882011-08-09 23:02:53 +00004203
David Blaikie85035652015-02-25 01:07:20 +00004204 Type *Ty = nullptr;
4205 if (OpNum + 5 == Record.size())
4206 Ty = getTypeByID(Record[OpNum++]);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004207 if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))
4208 return Err;
Filipe Cabecinhas11bb8492015-05-18 21:48:55 +00004209 if (!Ty)
4210 Ty = cast<PointerType>(Op->getType())->getElementType();
David Blaikie85035652015-02-25 01:07:20 +00004211
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004212 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
JF Bastien800f87a2016-04-06 21:19:33 +00004213 if (Ordering == AtomicOrdering::NotAtomic ||
4214 Ordering == AtomicOrdering::Release ||
4215 Ordering == AtomicOrdering::AcquireRelease)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004216 return error("Invalid record");
JF Bastien800f87a2016-04-06 21:19:33 +00004217 if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004218 return error("Invalid record");
4219 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
Eli Friedman59b66882011-08-09 23:02:53 +00004220
JF Bastien30bf96b2015-02-22 19:32:03 +00004221 unsigned Align;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004222 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4223 return Err;
JF Bastien30bf96b2015-02-22 19:32:03 +00004224 I = new LoadInst(Op, "", Record[OpNum+1], Align, Ordering, SynchScope);
David Blaikie85035652015-02-25 01:07:20 +00004225
Eli Friedman59b66882011-08-09 23:02:53 +00004226 InstructionList.push_back(I);
4227 break;
4228 }
David Blaikie612ddbf2015-04-22 04:14:42 +00004229 case bitc::FUNC_CODE_INST_STORE:
4230 case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]
Christopher Lamb54dd24c2007-12-11 08:59:05 +00004231 unsigned OpNum = 0;
4232 Value *Val, *Ptr;
4233 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
David Blaikie612ddbf2015-04-22 04:14:42 +00004234 (BitCode == bitc::FUNC_CODE_INST_STORE
4235 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4236 : popValue(Record, OpNum, NextValueNo,
4237 cast<PointerType>(Ptr->getType())->getElementType(),
4238 Val)) ||
4239 OpNum + 2 != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004240 return error("Invalid record");
Filipe Cabecinhas11bb8492015-05-18 21:48:55 +00004241
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004242 if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
4243 return Err;
JF Bastien30bf96b2015-02-22 19:32:03 +00004244 unsigned Align;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004245 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4246 return Err;
JF Bastien30bf96b2015-02-22 19:32:03 +00004247 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align);
Devang Patelaf206b82009-09-18 19:26:43 +00004248 InstructionList.push_back(I);
Christopher Lamb54dd24c2007-12-11 08:59:05 +00004249 break;
4250 }
David Blaikie50a06152015-04-22 04:14:46 +00004251 case bitc::FUNC_CODE_INST_STOREATOMIC:
4252 case bitc::FUNC_CODE_INST_STOREATOMIC_OLD: {
Eli Friedman59b66882011-08-09 23:02:53 +00004253 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
4254 unsigned OpNum = 0;
4255 Value *Val, *Ptr;
4256 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
Filipe Cabecinhas036e73c2016-06-05 18:43:33 +00004257 !isa<PointerType>(Ptr->getType()) ||
David Blaikie50a06152015-04-22 04:14:46 +00004258 (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC
4259 ? getValueTypePair(Record, OpNum, NextValueNo, Val)
4260 : popValue(Record, OpNum, NextValueNo,
4261 cast<PointerType>(Ptr->getType())->getElementType(),
4262 Val)) ||
4263 OpNum + 4 != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004264 return error("Invalid record");
Eli Friedman59b66882011-08-09 23:02:53 +00004265
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004266 if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
4267 return Err;
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004268 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
JF Bastien800f87a2016-04-06 21:19:33 +00004269 if (Ordering == AtomicOrdering::NotAtomic ||
4270 Ordering == AtomicOrdering::Acquire ||
4271 Ordering == AtomicOrdering::AcquireRelease)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004272 return error("Invalid record");
4273 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
JF Bastien800f87a2016-04-06 21:19:33 +00004274 if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004275 return error("Invalid record");
Eli Friedman59b66882011-08-09 23:02:53 +00004276
JF Bastien30bf96b2015-02-22 19:32:03 +00004277 unsigned Align;
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004278 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
4279 return Err;
JF Bastien30bf96b2015-02-22 19:32:03 +00004280 I = new StoreInst(Val, Ptr, Record[OpNum+1], Align, Ordering, SynchScope);
Eli Friedman59b66882011-08-09 23:02:53 +00004281 InstructionList.push_back(I);
4282 break;
4283 }
David Blaikie2a661cd2015-04-28 04:30:29 +00004284 case bitc::FUNC_CODE_INST_CMPXCHG_OLD:
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004285 case bitc::FUNC_CODE_INST_CMPXCHG: {
Tim Northovere94a5182014-03-11 10:48:52 +00004286 // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
Tim Northover420a2162014-06-13 14:24:07 +00004287 // failureordering?, isweak?]
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004288 unsigned OpNum = 0;
4289 Value *Ptr, *Cmp, *New;
4290 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
David Blaikie2a661cd2015-04-28 04:30:29 +00004291 (BitCode == bitc::FUNC_CODE_INST_CMPXCHG
4292 ? getValueTypePair(Record, OpNum, NextValueNo, Cmp)
4293 : popValue(Record, OpNum, NextValueNo,
4294 cast<PointerType>(Ptr->getType())->getElementType(),
4295 Cmp)) ||
4296 popValue(Record, OpNum, NextValueNo, Cmp->getType(), New) ||
4297 Record.size() < OpNum + 3 || Record.size() > OpNum + 5)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004298 return error("Invalid record");
4299 AtomicOrdering SuccessOrdering = getDecodedOrdering(Record[OpNum + 1]);
JF Bastien800f87a2016-04-06 21:19:33 +00004300 if (SuccessOrdering == AtomicOrdering::NotAtomic ||
4301 SuccessOrdering == AtomicOrdering::Unordered)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004302 return error("Invalid record");
4303 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 2]);
Tim Northovere94a5182014-03-11 10:48:52 +00004304
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004305 if (Error Err = typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))
4306 return Err;
Tim Northovere94a5182014-03-11 10:48:52 +00004307 AtomicOrdering FailureOrdering;
4308 if (Record.size() < 7)
4309 FailureOrdering =
4310 AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
4311 else
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004312 FailureOrdering = getDecodedOrdering(Record[OpNum + 3]);
Tim Northovere94a5182014-03-11 10:48:52 +00004313
4314 I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
4315 SynchScope);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004316 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
Tim Northover420a2162014-06-13 14:24:07 +00004317
4318 if (Record.size() < 8) {
4319 // Before weak cmpxchgs existed, the instruction simply returned the
4320 // value loaded from memory, so bitcode files from that era will be
4321 // expecting the first component of a modern cmpxchg.
4322 CurBB->getInstList().push_back(I);
4323 I = ExtractValueInst::Create(I, 0);
4324 } else {
4325 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
4326 }
4327
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004328 InstructionList.push_back(I);
4329 break;
4330 }
4331 case bitc::FUNC_CODE_INST_ATOMICRMW: {
4332 // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
4333 unsigned OpNum = 0;
4334 Value *Ptr, *Val;
4335 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
Filipe Cabecinhas6328f8e2016-06-05 18:43:40 +00004336 !isa<PointerType>(Ptr->getType()) ||
Jan Wen Voungafaced02012-10-11 20:20:40 +00004337 popValue(Record, OpNum, NextValueNo,
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004338 cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
4339 OpNum+4 != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004340 return error("Invalid record");
4341 AtomicRMWInst::BinOp Operation = getDecodedRMWOperation(Record[OpNum]);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004342 if (Operation < AtomicRMWInst::FIRST_BINOP ||
4343 Operation > AtomicRMWInst::LAST_BINOP)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004344 return error("Invalid record");
4345 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
JF Bastien800f87a2016-04-06 21:19:33 +00004346 if (Ordering == AtomicOrdering::NotAtomic ||
4347 Ordering == AtomicOrdering::Unordered)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004348 return error("Invalid record");
4349 SynchronizationScope SynchScope = getDecodedSynchScope(Record[OpNum + 3]);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00004350 I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
4351 cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
4352 InstructionList.push_back(I);
4353 break;
4354 }
Eli Friedmanfee02c62011-07-25 23:16:38 +00004355 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
4356 if (2 != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004357 return error("Invalid record");
4358 AtomicOrdering Ordering = getDecodedOrdering(Record[0]);
JF Bastien800f87a2016-04-06 21:19:33 +00004359 if (Ordering == AtomicOrdering::NotAtomic ||
4360 Ordering == AtomicOrdering::Unordered ||
4361 Ordering == AtomicOrdering::Monotonic)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004362 return error("Invalid record");
4363 SynchronizationScope SynchScope = getDecodedSynchScope(Record[1]);
Eli Friedmanfee02c62011-07-25 23:16:38 +00004364 I = new FenceInst(Context, Ordering, SynchScope);
4365 InstructionList.push_back(I);
4366 break;
4367 }
Chris Lattnerc44070802011-06-17 18:17:37 +00004368 case bitc::FUNC_CODE_INST_CALL: {
Sanjay Patelfa54ace2015-12-14 21:59:03 +00004369 // CALL: [paramattrs, cc, fmf, fnty, fnid, arg0, arg1...]
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00004370 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004371 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004372
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004373 unsigned OpNum = 0;
Reid Klecknerb5180542017-03-21 16:57:19 +00004374 AttributeList PAL = getAttributes(Record[OpNum++]);
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004375 unsigned CCInfo = Record[OpNum++];
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004376
Sanjay Patelfa54ace2015-12-14 21:59:03 +00004377 FastMathFlags FMF;
4378 if ((CCInfo >> bitc::CALL_FMF) & 1) {
4379 FMF = getDecodedFastMathFlags(Record[OpNum++]);
4380 if (!FMF.any())
4381 return error("Fast math flags indicator set for call with no FMF");
4382 }
4383
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004384 FunctionType *FTy = nullptr;
Akira Hatanaka97cb3972015-11-07 02:48:49 +00004385 if (CCInfo >> bitc::CALL_EXPLICIT_TYPE & 1 &&
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004386 !(FTy = dyn_cast<FunctionType>(getTypeByID(Record[OpNum++]))))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004387 return error("Explicit call type is not a function type");
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004388
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004389 Value *Callee;
4390 if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004391 return error("Invalid record");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004392
Chris Lattner229907c2011-07-18 04:54:35 +00004393 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004394 if (!OpTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004395 return error("Callee is not a pointer type");
David Blaikie348de692015-04-23 21:36:23 +00004396 if (!FTy) {
4397 FTy = dyn_cast<FunctionType>(OpTy->getElementType());
4398 if (!FTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004399 return error("Callee is not of pointer to function type");
David Blaikie348de692015-04-23 21:36:23 +00004400 } else if (OpTy->getElementType() != FTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004401 return error("Explicit call type does not match pointee type of "
David Blaikiedbe6e0f2015-04-17 06:40:14 +00004402 "callee operand");
4403 if (Record.size() < FTy->getNumParams() + OpNum)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004404 return error("Insufficient operands to call");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004405
Chris Lattner9f600c52007-05-03 22:04:19 +00004406 SmallVector<Value*, 16> Args;
4407 // Read the fixed params.
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004408 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00004409 if (FTy->getParamType(i)->isLabelTy())
Dale Johannesen4646aa32007-11-05 21:20:28 +00004410 Args.push_back(getBasicBlock(Record[OpNum]));
Dan Gohmanbbcd04d2010-09-13 18:00:48 +00004411 else
Jan Wen Voungafaced02012-10-11 20:20:40 +00004412 Args.push_back(getValue(Record, OpNum, NextValueNo,
4413 FTy->getParamType(i)));
Craig Topper2617dcc2014-04-15 06:32:26 +00004414 if (!Args.back())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004415 return error("Invalid record");
Chris Lattner9f600c52007-05-03 22:04:19 +00004416 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004417
Chris Lattner9f600c52007-05-03 22:04:19 +00004418 // Read type/value pairs for varargs params.
Chris Lattner9f600c52007-05-03 22:04:19 +00004419 if (!FTy->isVarArg()) {
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004420 if (OpNum != Record.size())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004421 return error("Invalid record");
Chris Lattner9f600c52007-05-03 22:04:19 +00004422 } else {
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004423 while (OpNum != Record.size()) {
4424 Value *Op;
4425 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004426 return error("Invalid record");
Chris Lattnerdf1233d2007-05-06 00:00:00 +00004427 Args.push_back(Op);
Chris Lattner9f600c52007-05-03 22:04:19 +00004428 }
4429 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004430
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004431 I = CallInst::Create(FTy, Callee, Args, OperandBundles);
4432 OperandBundles.clear();
Devang Patelaf206b82009-09-18 19:26:43 +00004433 InstructionList.push_back(I);
Sandeep Patel68c5f472009-09-02 08:44:58 +00004434 cast<CallInst>(I)->setCallingConv(
Akira Hatanaka97cb3972015-11-07 02:48:49 +00004435 static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));
Reid Kleckner5772b772014-04-24 20:14:34 +00004436 CallInst::TailCallKind TCK = CallInst::TCK_None;
Akira Hatanaka97cb3972015-11-07 02:48:49 +00004437 if (CCInfo & 1 << bitc::CALL_TAIL)
Reid Kleckner5772b772014-04-24 20:14:34 +00004438 TCK = CallInst::TCK_Tail;
Akira Hatanaka97cb3972015-11-07 02:48:49 +00004439 if (CCInfo & (1 << bitc::CALL_MUSTTAIL))
Reid Kleckner5772b772014-04-24 20:14:34 +00004440 TCK = CallInst::TCK_MustTail;
Akira Hatanaka97cb3972015-11-07 02:48:49 +00004441 if (CCInfo & (1 << bitc::CALL_NOTAIL))
Akira Hatanaka5cfcce122015-11-06 23:55:38 +00004442 TCK = CallInst::TCK_NoTail;
Reid Kleckner5772b772014-04-24 20:14:34 +00004443 cast<CallInst>(I)->setTailCallKind(TCK);
Devang Patel4c758ea2008-09-25 21:00:45 +00004444 cast<CallInst>(I)->setAttributes(PAL);
Sanjay Patelfa54ace2015-12-14 21:59:03 +00004445 if (FMF.any()) {
4446 if (!isa<FPMathOperator>(I))
4447 return error("Fast-math-flags specified for call without "
4448 "floating-point scalar or vector return type");
4449 I->setFastMathFlags(FMF);
4450 }
Chris Lattner9f600c52007-05-03 22:04:19 +00004451 break;
4452 }
4453 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
4454 if (Record.size() < 3)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004455 return error("Invalid record");
Chris Lattner229907c2011-07-18 04:54:35 +00004456 Type *OpTy = getTypeByID(Record[0]);
Jan Wen Voungafaced02012-10-11 20:20:40 +00004457 Value *Op = getValue(Record, 1, NextValueNo, OpTy);
Chris Lattner229907c2011-07-18 04:54:35 +00004458 Type *ResTy = getTypeByID(Record[2]);
Chris Lattner9f600c52007-05-03 22:04:19 +00004459 if (!OpTy || !Op || !ResTy)
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004460 return error("Invalid record");
Chris Lattner9f600c52007-05-03 22:04:19 +00004461 I = new VAArgInst(Op, ResTy);
Devang Patelaf206b82009-09-18 19:26:43 +00004462 InstructionList.push_back(I);
Chris Lattner9f600c52007-05-03 22:04:19 +00004463 break;
4464 }
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004465
4466 case bitc::FUNC_CODE_OPERAND_BUNDLE: {
4467 // A call or an invoke can be optionally prefixed with some variable
4468 // number of operand bundle blocks. These blocks are read into
4469 // OperandBundles and consumed at the next call or invoke instruction.
4470
4471 if (Record.size() < 1 || Record[0] >= BundleTags.size())
4472 return error("Invalid record");
4473
Sanjoy Dasf79d3442015-11-18 08:30:07 +00004474 std::vector<Value *> Inputs;
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004475
4476 unsigned OpNum = 1;
4477 while (OpNum != Record.size()) {
4478 Value *Op;
4479 if (getValueTypePair(Record, OpNum, NextValueNo, Op))
4480 return error("Invalid record");
4481 Inputs.push_back(Op);
4482 }
4483
Sanjoy Dasf79d3442015-11-18 08:30:07 +00004484 OperandBundles.emplace_back(BundleTags[Record[0]], std::move(Inputs));
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004485 continue;
4486 }
Chris Lattner83930552007-05-01 07:01:57 +00004487 }
4488
4489 // Add instruction to end of current BB. If there is no current BB, reject
4490 // this file.
Craig Topper2617dcc2014-04-15 06:32:26 +00004491 if (!CurBB) {
Reid Kleckner96ab8722017-05-18 17:24:10 +00004492 I->deleteValue();
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004493 return error("Invalid instruction with no BB");
Chris Lattner83930552007-05-01 07:01:57 +00004494 }
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004495 if (!OperandBundles.empty()) {
Reid Kleckner96ab8722017-05-18 17:24:10 +00004496 I->deleteValue();
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004497 return error("Operand bundles found with no consumer");
4498 }
Chris Lattner83930552007-05-01 07:01:57 +00004499 CurBB->getInstList().push_back(I);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004500
Chris Lattner83930552007-05-01 07:01:57 +00004501 // If this was a terminator instruction, move to the next block.
4502 if (isa<TerminatorInst>(I)) {
4503 ++CurBBNo;
Craig Topper2617dcc2014-04-15 06:32:26 +00004504 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
Chris Lattner83930552007-05-01 07:01:57 +00004505 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004506
Chris Lattner83930552007-05-01 07:01:57 +00004507 // Non-void values get registered in the value table for future use.
Benjamin Kramerccce8ba2010-01-05 13:12:22 +00004508 if (I && !I->getType()->isVoidTy())
David Majnemer8a1c45d2015-12-12 05:38:55 +00004509 ValueList.assignValue(I, NextValueNo++);
Chris Lattner85b7b402007-05-01 05:52:21 +00004510 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004511
Chris Lattner27d38752013-01-20 02:13:19 +00004512OutOfRecordLoop:
Joe Abbey97b7a172013-02-06 22:14:06 +00004513
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00004514 if (!OperandBundles.empty())
4515 return error("Operand bundles found with no consumer");
4516
Chris Lattner83930552007-05-01 07:01:57 +00004517 // Check the function list for unresolved values.
4518 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
Craig Topper2617dcc2014-04-15 06:32:26 +00004519 if (!A->getParent()) {
Chris Lattner83930552007-05-01 07:01:57 +00004520 // We found at least one unresolved value. Nuke them all to avoid leaks.
4521 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
Craig Topper2617dcc2014-04-15 06:32:26 +00004522 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
Owen Andersonb292b8c2009-07-30 23:03:37 +00004523 A->replaceAllUsesWith(UndefValue::get(A->getType()));
Chris Lattner83930552007-05-01 07:01:57 +00004524 delete A;
4525 }
4526 }
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004527 return error("Never resolved value found in function");
Chris Lattner83930552007-05-01 07:01:57 +00004528 }
Chris Lattner83930552007-05-01 07:01:57 +00004529 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004530
Duncan P. N. Exon Smith8742de92016-04-02 14:55:01 +00004531 // Unexpected unresolved metadata about to be dropped.
Mehdi Aminief27db82016-12-12 19:34:26 +00004532 if (MDLoader->hasFwdRefs())
Duncan P. N. Exon Smith8742de92016-04-02 14:55:01 +00004533 return error("Invalid function metadata: outgoing forward refs");
Dan Gohman9b9ff462010-08-25 20:23:38 +00004534
Chris Lattner85b7b402007-05-01 05:52:21 +00004535 // Trim the value list down to the size it was before we parsed this function.
4536 ValueList.shrinkTo(ModuleValueListSize);
Mehdi Aminief27db82016-12-12 19:34:26 +00004537 MDLoader->shrinkTo(ModuleMDLoaderSize);
Chris Lattner85b7b402007-05-01 05:52:21 +00004538 std::vector<BasicBlock*>().swap(FunctionBBs);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004539 return Error::success();
Chris Lattner51ffe7c2007-05-01 04:59:48 +00004540}
4541
Rafael Espindola7d712032013-11-05 17:16:08 +00004542/// Find the function body in the bitcode stream
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004543Error BitcodeReader::findFunctionInStream(
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +00004544 Function *F,
4545 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
Derek Schuff8b2dcad2012-02-06 22:30:29 +00004546 while (DeferredFunctionInfoIterator->second == 0) {
Teresa Johnsonff642b92015-09-17 20:12:00 +00004547 // This is the fallback handling for the old format bitcode that
Teresa Johnson1493ad92015-10-10 14:18:36 +00004548 // didn't contain the function index in the VST, or when we have
4549 // an anonymous function which would not have a VST entry.
4550 // Assert that we have one of those two cases.
4551 assert(VSTOffset == 0 || !F->hasName());
4552 // Parse the next body in the stream and set its position in the
4553 // DeferredFunctionInfo map.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004554 if (Error Err = rememberAndSkipFunctionBodies())
4555 return Err;
Derek Schuff8b2dcad2012-02-06 22:30:29 +00004556 }
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004557 return Error::success();
Derek Schuff8b2dcad2012-02-06 22:30:29 +00004558}
4559
Chris Lattner9eeada92007-05-18 04:02:46 +00004560//===----------------------------------------------------------------------===//
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00004561// GVMaterializer implementation
Chris Lattner9eeada92007-05-18 04:02:46 +00004562//===----------------------------------------------------------------------===//
4563
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +00004564Error BitcodeReader::materialize(GlobalValue *GV) {
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00004565 Function *F = dyn_cast<Function>(GV);
4566 // If it's not a function or is already material, ignore the request.
Rafael Espindola2b11ad42013-11-05 19:36:34 +00004567 if (!F || !F->isMaterializable())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004568 return Error::success();
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00004569
4570 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
Chris Lattner9eeada92007-05-18 04:02:46 +00004571 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
Derek Schuff8b2dcad2012-02-06 22:30:29 +00004572 // If its position is recorded as 0, its body is somewhere in the stream
4573 // but we haven't seen it yet.
Rafael Espindola1c863ca2015-06-22 18:06:15 +00004574 if (DFII->second == 0)
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004575 if (Error Err = findFunctionInStream(F, DFII))
4576 return Err;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004577
Duncan P. N. Exon Smith03a04a52016-04-24 15:04:28 +00004578 // Materialize metadata before parsing any function bodies.
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +00004579 if (Error Err = materializeMetadata())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004580 return Err;
Duncan P. N. Exon Smith03a04a52016-04-24 15:04:28 +00004581
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00004582 // Move the bit stream to the saved position of the deferred function body.
4583 Stream.JumpToBit(DFII->second);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004584
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004585 if (Error Err = parseFunctionBody(F))
4586 return Err;
Rafael Espindolad4bcefc2014-10-24 18:13:04 +00004587 F->setIsMaterializable(false);
Chandler Carruth7132e002007-08-04 01:51:18 +00004588
Rafael Espindola0d68b4c2015-03-30 21:36:43 +00004589 if (StripDebugInfo)
4590 stripDebugInfo(*F);
4591
Chandler Carruth7132e002007-08-04 01:51:18 +00004592 // Upgrade any old intrinsic calls in the function.
Rafael Espindola86e33402015-07-02 15:55:09 +00004593 for (auto &I : UpgradedIntrinsics) {
Rafael Espindola257a3532016-01-15 19:00:20 +00004594 for (auto UI = I.first->materialized_user_begin(), UE = I.first->user_end();
4595 UI != UE;) {
Filipe Cabecinhas0011c582015-07-03 20:12:01 +00004596 User *U = *UI;
4597 ++UI;
4598 if (CallInst *CI = dyn_cast<CallInst>(U))
4599 UpgradeIntrinsicCall(CI, I.second);
Chandler Carruth7132e002007-08-04 01:51:18 +00004600 }
4601 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004602
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00004603 // Update calls to the remangled intrinsics
4604 for (auto &I : RemangledIntrinsics)
4605 for (auto UI = I.first->materialized_user_begin(), UE = I.first->user_end();
4606 UI != UE;)
4607 // Don't expect any other users than call sites
4608 CallSite(*UI++).setCalledFunction(I.second);
4609
Peter Collingbourned4bff302015-11-05 22:03:56 +00004610 // Finish fn->subprogram upgrade for materialized functions.
Mehdi Aminief27db82016-12-12 19:34:26 +00004611 if (DISubprogram *SP = MDLoader->lookupSubprogramForFunction(F))
Peter Collingbourned4bff302015-11-05 22:03:56 +00004612 F->setSubprogram(SP);
4613
Mehdi Amini86623052016-12-16 19:16:29 +00004614 // Check if the TBAA Metadata are valid, otherwise we will need to strip them.
4615 if (!MDLoader->isStrippingTBAA()) {
4616 for (auto &I : instructions(F)) {
4617 MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa);
4618 if (!TBAA || TBAAVerifyHelper.visitTBAAMetadata(I, TBAA))
4619 continue;
4620 MDLoader->setStripTBAA(true);
4621 stripTBAA(F->getParent());
4622 }
4623 }
4624
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +00004625 // Bring in any functions that this function forward-referenced via
4626 // blockaddresses.
4627 return materializeForwardReferencedFunctions();
Chris Lattner9eeada92007-05-18 04:02:46 +00004628}
4629
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +00004630Error BitcodeReader::materializeModule() {
4631 if (Error Err = materializeMetadata())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004632 return Err;
Manman Ren4a9b0eb2015-03-13 19:24:30 +00004633
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +00004634 // Promise to materialize all forward references.
4635 WillMaterializeAllForwardRefs = true;
4636
Chris Lattner06310bf2009-06-16 05:15:21 +00004637 // Iterate over the module, deserializing any functions that are still on
4638 // disk.
Duncan P. N. Exon Smithfb1743a32015-10-13 16:48:55 +00004639 for (Function &F : *TheModule) {
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +00004640 if (Error Err = materialize(&F))
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004641 return Err;
Rafael Espindola2b11ad42013-11-05 19:36:34 +00004642 }
Teresa Johnson1493ad92015-10-10 14:18:36 +00004643 // At this point, if there are any function bodies, parse the rest of
4644 // the bits in the module past the last function block we have recorded
4645 // through either lazy scanning or the VST.
4646 if (LastFunctionBlockBit || NextUnreadBit)
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004647 if (Error Err = parseModule(LastFunctionBlockBit > NextUnreadBit
4648 ? LastFunctionBlockBit
4649 : NextUnreadBit))
4650 return Err;
Derek Schuff92ef9752012-02-29 00:07:09 +00004651
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +00004652 // Check that all block address forward references got resolved (as we
4653 // promised above).
Duncan P. N. Exon Smith00f20ac2014-08-01 21:51:52 +00004654 if (!BasicBlockFwdRefs.empty())
Rafael Espindolacbdcb502015-06-15 20:55:37 +00004655 return error("Never resolved function from blockaddress");
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +00004656
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00004657 // Upgrade any intrinsic calls that slipped through (should not happen!) and
4658 // delete the old functions to clean up. We can't do this unless the entire
4659 // module is materialized because there could always be another function body
Chandler Carruth7132e002007-08-04 01:51:18 +00004660 // with calls to the old function.
Rafael Espindola86e33402015-07-02 15:55:09 +00004661 for (auto &I : UpgradedIntrinsics) {
Filipe Cabecinhas0011c582015-07-03 20:12:01 +00004662 for (auto *U : I.first->users()) {
4663 if (CallInst *CI = dyn_cast<CallInst>(U))
4664 UpgradeIntrinsicCall(CI, I.second);
Chandler Carruth7132e002007-08-04 01:51:18 +00004665 }
Filipe Cabecinhas0011c582015-07-03 20:12:01 +00004666 if (!I.first->use_empty())
4667 I.first->replaceAllUsesWith(I.second);
4668 I.first->eraseFromParent();
Chandler Carruth7132e002007-08-04 01:51:18 +00004669 }
Rafael Espindola4e721212015-07-02 16:22:40 +00004670 UpgradedIntrinsics.clear();
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00004671 // Do the same for remangled intrinsics
4672 for (auto &I : RemangledIntrinsics) {
4673 I.first->replaceAllUsesWith(I.second);
4674 I.first->eraseFromParent();
4675 }
4676 RemangledIntrinsics.clear();
Devang Patel80ae3492009-08-28 23:24:31 +00004677
Rafael Espindola79753a02015-12-18 21:18:57 +00004678 UpgradeDebugInfo(*TheModule);
Manman Renb5d7ff42016-05-25 23:14:48 +00004679
4680 UpgradeModuleFlags(*TheModule);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004681 return Error::success();
Chris Lattner9eeada92007-05-18 04:02:46 +00004682}
4683
Rafael Espindola2fa1e432014-12-03 07:18:23 +00004684std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
4685 return IdentifiedStructTypes;
4686}
4687
Teresa Johnson26ab5772016-03-15 00:04:37 +00004688ModuleSummaryIndexBitcodeReader::ModuleSummaryIndexBitcodeReader(
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00004689 BitstreamCursor Cursor, StringRef Strtab, ModuleSummaryIndex &TheIndex,
4690 StringRef ModulePath, unsigned ModuleId)
4691 : BitcodeReaderBase(std::move(Cursor), Strtab), TheIndex(TheIndex),
4692 ModulePath(ModulePath), ModuleId(ModuleId) {}
4693
4694ModulePathStringTableTy::iterator
4695ModuleSummaryIndexBitcodeReader::addThisModulePath() {
4696 return TheIndex.addModulePath(ModulePath, ModuleId);
4697}
Teresa Johnson403a7872015-10-04 14:33:43 +00004698
Peter Collingbourne9667b912017-05-04 18:03:25 +00004699std::pair<ValueInfo, GlobalValue::GUID>
4700ModuleSummaryIndexBitcodeReader::getValueInfoFromValueId(unsigned ValueId) {
4701 auto VGI = ValueIdToValueInfoMap[ValueId];
4702 assert(VGI.first);
4703 return VGI;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004704}
4705
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004706void ModuleSummaryIndexBitcodeReader::setValueGUID(
4707 uint64_t ValueID, StringRef ValueName, GlobalValue::LinkageTypes Linkage,
4708 StringRef SourceFileName) {
4709 std::string GlobalId =
4710 GlobalValue::getGlobalIdentifier(ValueName, Linkage, SourceFileName);
4711 auto ValueGUID = GlobalValue::getGUID(GlobalId);
4712 auto OriginalNameID = ValueGUID;
4713 if (GlobalValue::isLocalLinkage(Linkage))
4714 OriginalNameID = GlobalValue::getGUID(ValueName);
4715 if (PrintSummaryGUIDs)
4716 dbgs() << "GUID " << ValueGUID << "(" << OriginalNameID << ") is "
4717 << ValueName << "\n";
Peter Collingbourne9667b912017-05-04 18:03:25 +00004718 ValueIdToValueInfoMap[ValueID] =
4719 std::make_pair(TheIndex.getOrInsertValueInfo(ValueGUID), OriginalNameID);
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004720}
4721
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004722// Specialized value symbol table parser used when reading module index
Teresa Johnson28e457b2016-04-24 14:57:11 +00004723// blocks where we don't actually create global values. The parsed information
4724// is saved in the bitcode reader for use when later parsing summaries.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004725Error ModuleSummaryIndexBitcodeReader::parseValueSymbolTable(
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004726 uint64_t Offset,
4727 DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap) {
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004728 // With a strtab the VST is not required to parse the summary.
4729 if (UseStrtab)
4730 return Error::success();
4731
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004732 assert(Offset > 0 && "Expected non-zero VST offset");
4733 uint64_t CurrentBit = jumpToValueSymbolTable(Offset, Stream);
4734
Teresa Johnson403a7872015-10-04 14:33:43 +00004735 if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
4736 return error("Invalid record");
4737
4738 SmallVector<uint64_t, 64> Record;
4739
4740 // Read all the records for this value table.
4741 SmallString<128> ValueName;
Eugene Zelenko1804a772016-08-25 00:45:04 +00004742
4743 while (true) {
Teresa Johnson403a7872015-10-04 14:33:43 +00004744 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4745
4746 switch (Entry.Kind) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004747 case BitstreamEntry::SubBlock: // Handled for us already.
4748 case BitstreamEntry::Error:
4749 return error("Malformed block");
4750 case BitstreamEntry::EndBlock:
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004751 // Done parsing VST, jump back to wherever we came from.
4752 Stream.JumpToBit(CurrentBit);
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004753 return Error::success();
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004754 case BitstreamEntry::Record:
4755 // The interesting case.
4756 break;
Teresa Johnson403a7872015-10-04 14:33:43 +00004757 }
4758
4759 // Read a record.
4760 Record.clear();
4761 switch (Stream.readRecord(Entry.ID, Record)) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004762 default: // Default behavior: ignore (e.g. VST_CODE_BBENTRY records).
4763 break;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004764 case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]
4765 if (convertToString(Record, 1, ValueName))
4766 return error("Invalid record");
4767 unsigned ValueID = Record[0];
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004768 assert(!SourceFileName.empty());
4769 auto VLI = ValueIdToLinkageMap.find(ValueID);
4770 assert(VLI != ValueIdToLinkageMap.end() &&
4771 "No linkage found for VST entry?");
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00004772 auto Linkage = VLI->second;
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004773 setValueGUID(ValueID, ValueName, Linkage, SourceFileName);
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004774 ValueName.clear();
4775 break;
4776 }
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004777 case bitc::VST_CODE_FNENTRY: {
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00004778 // VST_CODE_FNENTRY: [valueid, offset, namechar x N]
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004779 if (convertToString(Record, 2, ValueName))
4780 return error("Invalid record");
4781 unsigned ValueID = Record[0];
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004782 assert(!SourceFileName.empty());
4783 auto VLI = ValueIdToLinkageMap.find(ValueID);
4784 assert(VLI != ValueIdToLinkageMap.end() &&
4785 "No linkage found for VST entry?");
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00004786 auto Linkage = VLI->second;
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004787 setValueGUID(ValueID, ValueName, Linkage, SourceFileName);
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004788 ValueName.clear();
4789 break;
4790 }
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004791 case bitc::VST_CODE_COMBINED_ENTRY: {
4792 // VST_CODE_COMBINED_ENTRY: [valueid, refguid]
4793 unsigned ValueID = Record[0];
Mehdi Aminiad5741b2016-04-02 05:07:53 +00004794 GlobalValue::GUID RefGUID = Record[1];
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00004795 // The "original name", which is the second value of the pair will be
4796 // overriden later by a FS_COMBINED_ORIGINAL_NAME in the combined index.
Peter Collingbourne9667b912017-05-04 18:03:25 +00004797 ValueIdToValueInfoMap[ValueID] =
4798 std::make_pair(TheIndex.getOrInsertValueInfo(RefGUID), RefGUID);
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004799 break;
4800 }
Teresa Johnson403a7872015-10-04 14:33:43 +00004801 }
4802 }
4803}
4804
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004805// Parse just the blocks needed for building the index out of the module.
4806// At the end of this routine the module Index is populated with a map
Teresa Johnson28e457b2016-04-24 14:57:11 +00004807// from global value id to GlobalValueSummary objects.
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00004808Error ModuleSummaryIndexBitcodeReader::parseModule() {
Teresa Johnson403a7872015-10-04 14:33:43 +00004809 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
4810 return error("Invalid record");
4811
Teresa Johnsone1164de2016-02-10 21:55:02 +00004812 SmallVector<uint64_t, 64> Record;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004813 DenseMap<unsigned, GlobalValue::LinkageTypes> ValueIdToLinkageMap;
4814 unsigned ValueId = 0;
Teresa Johnsone1164de2016-02-10 21:55:02 +00004815
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004816 // Read the index for this module.
Eugene Zelenko1804a772016-08-25 00:45:04 +00004817 while (true) {
Teresa Johnson403a7872015-10-04 14:33:43 +00004818 BitstreamEntry Entry = Stream.advance();
4819
4820 switch (Entry.Kind) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004821 case BitstreamEntry::Error:
4822 return error("Malformed block");
4823 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004824 return Error::success();
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004825
4826 case BitstreamEntry::SubBlock:
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004827 switch (Entry.ID) {
4828 default: // Skip unknown content.
4829 if (Stream.SkipBlock())
4830 return error("Invalid record");
4831 break;
4832 case bitc::BLOCKINFO_BLOCK_ID:
4833 // Need to parse these to get abbrev ids (e.g. for VST)
Peter Collingbourne939c7d92016-11-08 04:16:57 +00004834 if (readBlockInfo())
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004835 return error("Malformed block");
4836 break;
4837 case bitc::VALUE_SYMTAB_BLOCK_ID:
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004838 // Should have been parsed earlier via VSTOffset, unless there
4839 // is no summary section.
4840 assert(((SeenValueSymbolTable && VSTOffset > 0) ||
4841 !SeenGlobalValSummary) &&
4842 "Expected early VST parse via VSTOffset record");
4843 if (Stream.SkipBlock())
4844 return error("Invalid record");
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004845 break;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004846 case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004847 assert(!SeenValueSymbolTable &&
4848 "Already read VST when parsing summary block?");
Teresa Johnson620c1402016-09-20 23:07:17 +00004849 // We might not have a VST if there were no values in the
4850 // summary. An empty summary block generated when we are
4851 // performing ThinLTO compiles so we don't later invoke
4852 // the regular LTO process on them.
4853 if (VSTOffset > 0) {
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004854 if (Error Err = parseValueSymbolTable(VSTOffset, ValueIdToLinkageMap))
4855 return Err;
Teresa Johnson620c1402016-09-20 23:07:17 +00004856 SeenValueSymbolTable = true;
4857 }
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004858 SeenGlobalValSummary = true;
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00004859 if (Error Err = parseEntireSummary())
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004860 return Err;
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004861 break;
4862 case bitc::MODULE_STRTAB_BLOCK_ID:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00004863 if (Error Err = parseModuleStringTable())
4864 return Err;
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004865 break;
4866 }
4867 continue;
Teresa Johnson403a7872015-10-04 14:33:43 +00004868
Mehdi Aminid7ad2212016-04-01 05:33:11 +00004869 case BitstreamEntry::Record: {
Teresa Johnsone1164de2016-02-10 21:55:02 +00004870 Record.clear();
4871 auto BitCode = Stream.readRecord(Entry.ID, Record);
4872 switch (BitCode) {
4873 default:
4874 break; // Default behavior, ignore unknown content.
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004875 case bitc::MODULE_CODE_VERSION: {
4876 if (Error Err = parseVersionRecord(Record).takeError())
4877 return Err;
4878 break;
4879 }
Teresa Johnsone1164de2016-02-10 21:55:02 +00004880 /// MODULE_CODE_SOURCE_FILENAME: [namechar x N]
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004881 case bitc::MODULE_CODE_SOURCE_FILENAME: {
Teresa Johnsone1164de2016-02-10 21:55:02 +00004882 SmallString<128> ValueName;
4883 if (convertToString(Record, 0, ValueName))
4884 return error("Invalid record");
4885 SourceFileName = ValueName.c_str();
4886 break;
4887 }
Mehdi Aminid7ad2212016-04-01 05:33:11 +00004888 /// MODULE_CODE_HASH: [5*i32]
4889 case bitc::MODULE_CODE_HASH: {
4890 if (Record.size() != 5)
4891 return error("Invalid hash length " + Twine(Record.size()).str());
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00004892 auto &Hash = addThisModulePath()->second.second;
Mehdi Aminid7ad2212016-04-01 05:33:11 +00004893 int Pos = 0;
4894 for (auto &Val : Record) {
4895 assert(!(Val >> 32) && "Unexpected high bits set");
4896 Hash[Pos++] = Val;
4897 }
4898 break;
4899 }
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004900 /// MODULE_CODE_VSTOFFSET: [offset]
4901 case bitc::MODULE_CODE_VSTOFFSET:
4902 if (Record.size() < 1)
4903 return error("Invalid record");
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00004904 // Note that we subtract 1 here because the offset is relative to one
4905 // word before the start of the identification or module block, which
4906 // was historically always the start of the regular bitcode header.
4907 VSTOffset = Record[0] - 1;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004908 break;
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004909 // v1 GLOBALVAR: [pointer type, isconst, initid, linkage, ...]
4910 // v1 FUNCTION: [type, callingconv, isproto, linkage, ...]
4911 // v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, ...]
4912 // v2: [strtab offset, strtab size, v1]
Peter Collingbournef43e0ae2017-04-10 21:17:54 +00004913 case bitc::MODULE_CODE_GLOBALVAR:
4914 case bitc::MODULE_CODE_FUNCTION:
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004915 case bitc::MODULE_CODE_ALIAS: {
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004916 StringRef Name;
4917 ArrayRef<uint64_t> GVRecord;
4918 std::tie(Name, GVRecord) = readNameFromStrtab(Record);
4919 if (GVRecord.size() <= 3)
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004920 return error("Invalid record");
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004921 uint64_t RawLinkage = GVRecord[3];
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004922 GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
Peter Collingbournea0f371a2017-04-17 17:51:36 +00004923 if (!UseStrtab) {
4924 ValueIdToLinkageMap[ValueId++] = Linkage;
4925 break;
4926 }
4927
4928 setValueGUID(ValueId++, Name, Linkage, SourceFileName);
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004929 break;
4930 }
4931 }
Teresa Johnsone1164de2016-02-10 21:55:02 +00004932 }
Teresa Johnsonf72278f2015-11-02 18:02:11 +00004933 continue;
Teresa Johnson403a7872015-10-04 14:33:43 +00004934 }
4935 }
4936}
4937
Peter Collingbourne0c30f082016-12-20 21:12:28 +00004938std::vector<ValueInfo>
4939ModuleSummaryIndexBitcodeReader::makeRefList(ArrayRef<uint64_t> Record) {
4940 std::vector<ValueInfo> Ret;
4941 Ret.reserve(Record.size());
4942 for (uint64_t RefValueId : Record)
Peter Collingbourne9667b912017-05-04 18:03:25 +00004943 Ret.push_back(getValueInfoFromValueId(RefValueId).first);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00004944 return Ret;
4945}
4946
4947std::vector<FunctionSummary::EdgeTy> ModuleSummaryIndexBitcodeReader::makeCallList(
4948 ArrayRef<uint64_t> Record, bool IsOldProfileFormat, bool HasProfile) {
4949 std::vector<FunctionSummary::EdgeTy> Ret;
4950 Ret.reserve(Record.size());
4951 for (unsigned I = 0, E = Record.size(); I != E; ++I) {
4952 CalleeInfo::HotnessType Hotness = CalleeInfo::HotnessType::Unknown;
Peter Collingbourne9667b912017-05-04 18:03:25 +00004953 ValueInfo Callee = getValueInfoFromValueId(Record[I]).first;
Peter Collingbourne0c30f082016-12-20 21:12:28 +00004954 if (IsOldProfileFormat) {
4955 I += 1; // Skip old callsitecount field
4956 if (HasProfile)
4957 I += 1; // Skip old profilecount field
4958 } else if (HasProfile)
4959 Hotness = static_cast<CalleeInfo::HotnessType>(Record[++I]);
Peter Collingbourne9667b912017-05-04 18:03:25 +00004960 Ret.push_back(FunctionSummary::EdgeTy{Callee, CalleeInfo{Hotness}});
Peter Collingbourne0c30f082016-12-20 21:12:28 +00004961 }
4962 return Ret;
4963}
4964
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004965// Eagerly parse the entire summary block. This populates the GlobalValueSummary
4966// objects in the index.
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00004967Error ModuleSummaryIndexBitcodeReader::parseEntireSummary() {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00004968 if (Stream.EnterSubBlock(bitc::GLOBALVAL_SUMMARY_BLOCK_ID))
Teresa Johnson403a7872015-10-04 14:33:43 +00004969 return error("Invalid record");
Teresa Johnson403a7872015-10-04 14:33:43 +00004970 SmallVector<uint64_t, 64> Record;
Mehdi Amini8fe69362016-04-24 03:18:11 +00004971
4972 // Parse version
4973 {
4974 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4975 if (Entry.Kind != BitstreamEntry::Record)
4976 return error("Invalid Summary Block: record for version expected");
4977 if (Stream.readRecord(Entry.ID, Record) != bitc::FS_VERSION)
4978 return error("Invalid Summary Block: version expected");
4979 }
4980 const uint64_t Version = Record[0];
Piotr Padlewskid9830eb2016-09-26 20:37:32 +00004981 const bool IsOldProfileFormat = Version == 1;
Teresa Johnson519465b2017-01-05 14:32:16 +00004982 if (Version < 1 || Version > 3)
Piotr Padlewskid9830eb2016-09-26 20:37:32 +00004983 return error("Invalid summary version " + Twine(Version) +
Teresa Johnson519465b2017-01-05 14:32:16 +00004984 ", 1, 2 or 3 expected");
Mehdi Amini8fe69362016-04-24 03:18:11 +00004985 Record.clear();
4986
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00004987 // Keep around the last seen summary to be used when we see an optional
4988 // "OriginalName" attachement.
4989 GlobalValueSummary *LastSeenSummary = nullptr;
Dehao Chen4a435e02017-03-14 17:33:01 +00004990 GlobalValue::GUID LastSeenGUID = 0;
Peter Collingbournefa3175f2017-02-11 03:19:22 +00004991
4992 // We can expect to see any number of type ID information records before
4993 // each function summary records; these variables store the information
4994 // collected so far so that it can be used to create the summary object.
Peter Collingbourne1b4137a72016-12-21 23:03:45 +00004995 std::vector<GlobalValue::GUID> PendingTypeTests;
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +00004996 std::vector<FunctionSummary::VFuncId> PendingTypeTestAssumeVCalls,
4997 PendingTypeCheckedLoadVCalls;
4998 std::vector<FunctionSummary::ConstVCall> PendingTypeTestAssumeConstVCalls,
4999 PendingTypeCheckedLoadConstVCalls;
Eugene Zelenko1804a772016-08-25 00:45:04 +00005000
5001 while (true) {
Teresa Johnson403a7872015-10-04 14:33:43 +00005002 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5003
5004 switch (Entry.Kind) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005005 case BitstreamEntry::SubBlock: // Handled for us already.
5006 case BitstreamEntry::Error:
5007 return error("Malformed block");
5008 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00005009 return Error::success();
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005010 case BitstreamEntry::Record:
5011 // The interesting case.
5012 break;
Teresa Johnson403a7872015-10-04 14:33:43 +00005013 }
5014
5015 // Read a record. The record format depends on whether this
5016 // is a per-module index or a combined index file. In the per-module
5017 // case the records contain the associated value's ID for correlation
5018 // with VST entries. In the combined index the correlation is done
5019 // via the bitcode offset of the summary records (which were saved
5020 // in the combined index VST entries). The records also contain
5021 // information used for ThinLTO renaming and importing.
5022 Record.clear();
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005023 auto BitCode = Stream.readRecord(Entry.ID, Record);
5024 switch (BitCode) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005025 default: // Default behavior: ignore.
5026 break;
Peter Collingbournea0f371a2017-04-17 17:51:36 +00005027 case bitc::FS_VALUE_GUID: { // [valueid, refguid]
5028 uint64_t ValueID = Record[0];
5029 GlobalValue::GUID RefGUID = Record[1];
Peter Collingbourne9667b912017-05-04 18:03:25 +00005030 ValueIdToValueInfoMap[ValueID] =
5031 std::make_pair(TheIndex.getOrInsertValueInfo(RefGUID), RefGUID);
Peter Collingbournea0f371a2017-04-17 17:51:36 +00005032 break;
5033 }
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005034 // FS_PERMODULE: [valueid, flags, instcount, numrefs, numrefs x valueid,
Piotr Padlewskid9830eb2016-09-26 20:37:32 +00005035 // n x (valueid)]
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005036 // FS_PERMODULE_PROFILE: [valueid, flags, instcount, numrefs,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005037 // numrefs x valueid,
Piotr Padlewskid9830eb2016-09-26 20:37:32 +00005038 // n x (valueid, hotness)]
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005039 case bitc::FS_PERMODULE:
5040 case bitc::FS_PERMODULE_PROFILE: {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005041 unsigned ValueID = Record[0];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005042 uint64_t RawFlags = Record[1];
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005043 unsigned InstCount = Record[2];
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005044 unsigned NumRefs = Record[3];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005045 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005046 // The module path string ref set in the summary must be owned by the
5047 // index's module string table. Since we don't have a module path
5048 // string table section in the per-module index, we create a single
5049 // module path string table entry with an empty (0) ID to take
5050 // ownership.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005051 static int RefListStartIndex = 4;
5052 int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;
5053 assert(Record.size() >= RefListStartIndex + NumRefs &&
5054 "Record size inconsistent with number of references");
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005055 std::vector<ValueInfo> Refs = makeRefList(
5056 ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005057 bool HasProfile = (BitCode == bitc::FS_PERMODULE_PROFILE);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005058 std::vector<FunctionSummary::EdgeTy> Calls = makeCallList(
5059 ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),
5060 IsOldProfileFormat, HasProfile);
5061 auto FS = llvm::make_unique<FunctionSummary>(
Peter Collingbourne1b4137a72016-12-21 23:03:45 +00005062 Flags, InstCount, std::move(Refs), std::move(Calls),
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +00005063 std::move(PendingTypeTests), std::move(PendingTypeTestAssumeVCalls),
5064 std::move(PendingTypeCheckedLoadVCalls),
5065 std::move(PendingTypeTestAssumeConstVCalls),
5066 std::move(PendingTypeCheckedLoadConstVCalls));
Peter Collingbourne704f8142016-12-22 02:52:23 +00005067 PendingTypeTests.clear();
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +00005068 PendingTypeTestAssumeVCalls.clear();
5069 PendingTypeCheckedLoadVCalls.clear();
5070 PendingTypeTestAssumeConstVCalls.clear();
5071 PendingTypeCheckedLoadConstVCalls.clear();
Peter Collingbourne9667b912017-05-04 18:03:25 +00005072 auto VIAndOriginalGUID = getValueInfoFromValueId(ValueID);
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005073 FS->setModulePath(addThisModulePath()->first());
Peter Collingbourne9667b912017-05-04 18:03:25 +00005074 FS->setOriginalName(VIAndOriginalGUID.second);
5075 TheIndex.addGlobalValueSummary(VIAndOriginalGUID.first, std::move(FS));
Teresa Johnsonbbe05452016-02-24 17:57:28 +00005076 break;
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005077 }
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005078 // FS_ALIAS: [valueid, flags, valueid]
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005079 // Aliases must be emitted (and parsed) after all FS_PERMODULE entries, as
5080 // they expect all aliasee summaries to be available.
5081 case bitc::FS_ALIAS: {
5082 unsigned ValueID = Record[0];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005083 uint64_t RawFlags = Record[1];
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005084 unsigned AliaseeID = Record[2];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005085 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005086 auto AS =
5087 llvm::make_unique<AliasSummary>(Flags, std::vector<ValueInfo>{});
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005088 // The module path string ref set in the summary must be owned by the
5089 // index's module string table. Since we don't have a module path
5090 // string table section in the per-module index, we create a single
5091 // module path string table entry with an empty (0) ID to take
5092 // ownership.
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005093 AS->setModulePath(addThisModulePath()->first());
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005094
Peter Collingbourne9667b912017-05-04 18:03:25 +00005095 GlobalValue::GUID AliaseeGUID =
5096 getValueInfoFromValueId(AliaseeID).first.getGUID();
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005097 auto AliaseeInModule =
5098 TheIndex.findSummaryInModule(AliaseeGUID, ModulePath);
5099 if (!AliaseeInModule)
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005100 return error("Alias expects aliasee summary to be parsed");
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005101 AS->setAliasee(AliaseeInModule);
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005102
Peter Collingbourne9667b912017-05-04 18:03:25 +00005103 auto GUID = getValueInfoFromValueId(ValueID);
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005104 AS->setOriginalName(GUID.second);
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +00005105 TheIndex.addGlobalValueSummary(GUID.first, std::move(AS));
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005106 break;
5107 }
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005108 // FS_PERMODULE_GLOBALVAR_INIT_REFS: [valueid, flags, n x valueid]
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005109 case bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS: {
5110 unsigned ValueID = Record[0];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005111 uint64_t RawFlags = Record[1];
5112 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005113 std::vector<ValueInfo> Refs =
5114 makeRefList(ArrayRef<uint64_t>(Record).slice(2));
5115 auto FS = llvm::make_unique<GlobalVarSummary>(Flags, std::move(Refs));
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005116 FS->setModulePath(addThisModulePath()->first());
Peter Collingbourne9667b912017-05-04 18:03:25 +00005117 auto GUID = getValueInfoFromValueId(ValueID);
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005118 FS->setOriginalName(GUID.second);
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +00005119 TheIndex.addGlobalValueSummary(GUID.first, std::move(FS));
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005120 break;
5121 }
Teresa Johnson02e98332016-04-27 13:28:35 +00005122 // FS_COMBINED: [valueid, modid, flags, instcount, numrefs,
Piotr Padlewskid9830eb2016-09-26 20:37:32 +00005123 // numrefs x valueid, n x (valueid)]
Teresa Johnson02e98332016-04-27 13:28:35 +00005124 // FS_COMBINED_PROFILE: [valueid, modid, flags, instcount, numrefs,
Piotr Padlewskid9830eb2016-09-26 20:37:32 +00005125 // numrefs x valueid, n x (valueid, hotness)]
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005126 case bitc::FS_COMBINED:
5127 case bitc::FS_COMBINED_PROFILE: {
Teresa Johnson02e98332016-04-27 13:28:35 +00005128 unsigned ValueID = Record[0];
5129 uint64_t ModuleId = Record[1];
5130 uint64_t RawFlags = Record[2];
5131 unsigned InstCount = Record[3];
5132 unsigned NumRefs = Record[4];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005133 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
Teresa Johnson02e98332016-04-27 13:28:35 +00005134 static int RefListStartIndex = 5;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005135 int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;
5136 assert(Record.size() >= RefListStartIndex + NumRefs &&
5137 "Record size inconsistent with number of references");
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005138 std::vector<ValueInfo> Refs = makeRefList(
5139 ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005140 bool HasProfile = (BitCode == bitc::FS_COMBINED_PROFILE);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005141 std::vector<FunctionSummary::EdgeTy> Edges = makeCallList(
5142 ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),
5143 IsOldProfileFormat, HasProfile);
Peter Collingbourne9667b912017-05-04 18:03:25 +00005144 ValueInfo VI = getValueInfoFromValueId(ValueID).first;
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005145 auto FS = llvm::make_unique<FunctionSummary>(
Peter Collingbourne1b4137a72016-12-21 23:03:45 +00005146 Flags, InstCount, std::move(Refs), std::move(Edges),
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +00005147 std::move(PendingTypeTests), std::move(PendingTypeTestAssumeVCalls),
5148 std::move(PendingTypeCheckedLoadVCalls),
5149 std::move(PendingTypeTestAssumeConstVCalls),
5150 std::move(PendingTypeCheckedLoadConstVCalls));
Peter Collingbourne704f8142016-12-22 02:52:23 +00005151 PendingTypeTests.clear();
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +00005152 PendingTypeTestAssumeVCalls.clear();
5153 PendingTypeCheckedLoadVCalls.clear();
5154 PendingTypeTestAssumeConstVCalls.clear();
5155 PendingTypeCheckedLoadConstVCalls.clear();
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005156 LastSeenSummary = FS.get();
Peter Collingbourne9667b912017-05-04 18:03:25 +00005157 LastSeenGUID = VI.getGUID();
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005158 FS->setModulePath(ModuleIdMap[ModuleId]);
Peter Collingbourne9667b912017-05-04 18:03:25 +00005159 TheIndex.addGlobalValueSummary(VI, std::move(FS));
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005160 break;
5161 }
Teresa Johnson02e98332016-04-27 13:28:35 +00005162 // FS_COMBINED_ALIAS: [valueid, modid, flags, valueid]
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005163 // Aliases must be emitted (and parsed) after all FS_COMBINED entries, as
5164 // they expect all aliasee summaries to be available.
5165 case bitc::FS_COMBINED_ALIAS: {
Teresa Johnson02e98332016-04-27 13:28:35 +00005166 unsigned ValueID = Record[0];
5167 uint64_t ModuleId = Record[1];
5168 uint64_t RawFlags = Record[2];
5169 unsigned AliaseeValueId = Record[3];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005170 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005171 auto AS = llvm::make_unique<AliasSummary>(Flags, std::vector<ValueInfo>{});
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005172 LastSeenSummary = AS.get();
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005173 AS->setModulePath(ModuleIdMap[ModuleId]);
5174
Peter Collingbourne9667b912017-05-04 18:03:25 +00005175 auto AliaseeGUID =
5176 getValueInfoFromValueId(AliaseeValueId).first.getGUID();
Teresa Johnson02e98332016-04-27 13:28:35 +00005177 auto AliaseeInModule =
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +00005178 TheIndex.findSummaryInModule(AliaseeGUID, AS->modulePath());
Teresa Johnson02e98332016-04-27 13:28:35 +00005179 if (!AliaseeInModule)
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005180 return error("Alias expects aliasee summary to be parsed");
Teresa Johnson02e98332016-04-27 13:28:35 +00005181 AS->setAliasee(AliaseeInModule);
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005182
Peter Collingbourne9667b912017-05-04 18:03:25 +00005183 ValueInfo VI = getValueInfoFromValueId(ValueID).first;
5184 LastSeenGUID = VI.getGUID();
5185 TheIndex.addGlobalValueSummary(VI, std::move(AS));
Mehdi Amini2d28f7a2016-04-16 06:56:44 +00005186 break;
5187 }
Teresa Johnson02e98332016-04-27 13:28:35 +00005188 // FS_COMBINED_GLOBALVAR_INIT_REFS: [valueid, modid, flags, n x valueid]
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005189 case bitc::FS_COMBINED_GLOBALVAR_INIT_REFS: {
Teresa Johnson02e98332016-04-27 13:28:35 +00005190 unsigned ValueID = Record[0];
5191 uint64_t ModuleId = Record[1];
5192 uint64_t RawFlags = Record[2];
Mehdi Aminic3ed48c2016-04-24 03:18:18 +00005193 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
Peter Collingbourne0c30f082016-12-20 21:12:28 +00005194 std::vector<ValueInfo> Refs =
5195 makeRefList(ArrayRef<uint64_t>(Record).slice(3));
5196 auto FS = llvm::make_unique<GlobalVarSummary>(Flags, std::move(Refs));
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005197 LastSeenSummary = FS.get();
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00005198 FS->setModulePath(ModuleIdMap[ModuleId]);
Peter Collingbourne9667b912017-05-04 18:03:25 +00005199 ValueInfo VI = getValueInfoFromValueId(ValueID).first;
5200 LastSeenGUID = VI.getGUID();
5201 TheIndex.addGlobalValueSummary(VI, std::move(FS));
Teresa Johnsonbbe05452016-02-24 17:57:28 +00005202 break;
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005203 }
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005204 // FS_COMBINED_ORIGINAL_NAME: [original_name]
5205 case bitc::FS_COMBINED_ORIGINAL_NAME: {
5206 uint64_t OriginalName = Record[0];
5207 if (!LastSeenSummary)
5208 return error("Name attachment that does not follow a combined record");
5209 LastSeenSummary->setOriginalName(OriginalName);
Dehao Chen4a435e02017-03-14 17:33:01 +00005210 TheIndex.addOriginalName(LastSeenGUID, OriginalName);
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005211 // Reset the LastSeenSummary
5212 LastSeenSummary = nullptr;
Dehao Chen4a435e02017-03-14 17:33:01 +00005213 LastSeenGUID = 0;
Peter Collingbourne1b4137a72016-12-21 23:03:45 +00005214 break;
5215 }
5216 case bitc::FS_TYPE_TESTS: {
5217 assert(PendingTypeTests.empty());
5218 PendingTypeTests.insert(PendingTypeTests.end(), Record.begin(),
5219 Record.end());
5220 break;
Mehdi Aminiae64eaf2016-04-23 23:38:17 +00005221 }
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +00005222 case bitc::FS_TYPE_TEST_ASSUME_VCALLS: {
5223 assert(PendingTypeTestAssumeVCalls.empty());
5224 for (unsigned I = 0; I != Record.size(); I += 2)
5225 PendingTypeTestAssumeVCalls.push_back({Record[I], Record[I+1]});
5226 break;
5227 }
5228 case bitc::FS_TYPE_CHECKED_LOAD_VCALLS: {
5229 assert(PendingTypeCheckedLoadVCalls.empty());
5230 for (unsigned I = 0; I != Record.size(); I += 2)
5231 PendingTypeCheckedLoadVCalls.push_back({Record[I], Record[I+1]});
5232 break;
5233 }
5234 case bitc::FS_TYPE_TEST_ASSUME_CONST_VCALL: {
5235 PendingTypeTestAssumeConstVCalls.push_back(
5236 {{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});
5237 break;
5238 }
5239 case bitc::FS_TYPE_CHECKED_LOAD_CONST_VCALL: {
5240 PendingTypeCheckedLoadConstVCalls.push_back(
5241 {{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});
5242 break;
5243 }
Teresa Johnson403a7872015-10-04 14:33:43 +00005244 }
5245 }
5246 llvm_unreachable("Exit infinite loop");
5247}
5248
5249// Parse the module string table block into the Index.
5250// This populates the ModulePathStringTable map in the index.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00005251Error ModuleSummaryIndexBitcodeReader::parseModuleStringTable() {
Teresa Johnson403a7872015-10-04 14:33:43 +00005252 if (Stream.EnterSubBlock(bitc::MODULE_STRTAB_BLOCK_ID))
5253 return error("Invalid record");
5254
5255 SmallVector<uint64_t, 64> Record;
5256
5257 SmallString<128> ModulePath;
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005258 ModulePathStringTableTy::iterator LastSeenModulePath;
Eugene Zelenko1804a772016-08-25 00:45:04 +00005259
5260 while (true) {
Teresa Johnson403a7872015-10-04 14:33:43 +00005261 BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
5262
5263 switch (Entry.Kind) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005264 case BitstreamEntry::SubBlock: // Handled for us already.
5265 case BitstreamEntry::Error:
5266 return error("Malformed block");
5267 case BitstreamEntry::EndBlock:
Peter Collingbourne58f7f072016-11-09 00:51:04 +00005268 return Error::success();
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005269 case BitstreamEntry::Record:
5270 // The interesting case.
5271 break;
Teresa Johnson403a7872015-10-04 14:33:43 +00005272 }
5273
5274 Record.clear();
5275 switch (Stream.readRecord(Entry.ID, Record)) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005276 default: // Default behavior: ignore.
5277 break;
5278 case bitc::MST_CODE_ENTRY: {
5279 // MST_ENTRY: [modid, namechar x N]
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005280 uint64_t ModuleId = Record[0];
5281
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005282 if (convertToString(Record, 1, ModulePath))
5283 return error("Invalid record");
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005284
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +00005285 LastSeenModulePath = TheIndex.addModulePath(ModulePath, ModuleId);
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005286 ModuleIdMap[ModuleId] = LastSeenModulePath->first();
5287
Teresa Johnsonf72278f2015-11-02 18:02:11 +00005288 ModulePath.clear();
5289 break;
5290 }
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005291 /// MST_CODE_HASH: [5*i32]
5292 case bitc::MST_CODE_HASH: {
5293 if (Record.size() != 5)
5294 return error("Invalid hash length " + Twine(Record.size()).str());
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +00005295 if (LastSeenModulePath == TheIndex.modulePaths().end())
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005296 return error("Invalid hash that does not follow a module path");
5297 int Pos = 0;
5298 for (auto &Val : Record) {
5299 assert(!(Val >> 32) && "Unexpected high bits set");
5300 LastSeenModulePath->second.second[Pos++] = Val;
5301 }
5302 // Reset LastSeenModulePath to avoid overriding the hash unexpectedly.
Peter Collingbourne57f9b8c2016-12-01 06:21:08 +00005303 LastSeenModulePath = TheIndex.modulePaths().end();
Mehdi Aminid7ad2212016-04-01 05:33:11 +00005304 break;
5305 }
Teresa Johnson403a7872015-10-04 14:33:43 +00005306 }
5307 }
5308 llvm_unreachable("Exit infinite loop");
5309}
5310
Rafael Espindola48da4f42013-11-04 16:16:24 +00005311namespace {
Eugene Zelenko1804a772016-08-25 00:45:04 +00005312
Peter Collingbourne4718f8b2016-05-24 20:13:46 +00005313// FIXME: This class is only here to support the transition to llvm::Error. It
5314// will be removed once this transition is complete. Clients should prefer to
5315// deal with the Error value directly, rather than converting to error_code.
Rafael Espindola25188c92014-06-12 01:45:43 +00005316class BitcodeErrorCategoryType : public std::error_category {
Reid Kleckner990504e2016-10-19 23:52:38 +00005317 const char *name() const noexcept override {
Rafael Espindola48da4f42013-11-04 16:16:24 +00005318 return "llvm.bitcode";
5319 }
Craig Topper73156022014-03-02 09:09:27 +00005320 std::string message(int IE) const override {
Rafael Espindolac3f2e732014-07-29 20:22:46 +00005321 BitcodeError E = static_cast<BitcodeError>(IE);
Rafael Espindola48da4f42013-11-04 16:16:24 +00005322 switch (E) {
Rafael Espindolad0b23be2015-01-10 00:07:30 +00005323 case BitcodeError::CorruptedBitcode:
5324 return "Corrupted bitcode";
Rafael Espindola48da4f42013-11-04 16:16:24 +00005325 }
Benjamin Kramer77db1632013-11-05 13:45:09 +00005326 llvm_unreachable("Unknown error type!");
Rafael Espindola48da4f42013-11-04 16:16:24 +00005327 }
5328};
Eugene Zelenko1804a772016-08-25 00:45:04 +00005329
Eugene Zelenko6ac3f732016-01-26 18:48:36 +00005330} // end anonymous namespace
Rafael Espindola48da4f42013-11-04 16:16:24 +00005331
Chris Bieneman770163e2014-09-19 20:29:02 +00005332static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
5333
Rafael Espindolac3f2e732014-07-29 20:22:46 +00005334const std::error_category &llvm::BitcodeErrorCategory() {
Chris Bieneman770163e2014-09-19 20:29:02 +00005335 return *ErrorCategory;
Derek Schuff8b2dcad2012-02-06 22:30:29 +00005336}
Chris Lattner51ffe7c2007-05-01 04:59:48 +00005337
Peter Collingbournea0f371a2017-04-17 17:51:36 +00005338static Expected<StringRef> readStrtab(BitstreamCursor &Stream) {
5339 if (Stream.EnterSubBlock(bitc::STRTAB_BLOCK_ID))
5340 return error("Invalid record");
5341
5342 StringRef Strtab;
5343 while (1) {
5344 BitstreamEntry Entry = Stream.advance();
5345 switch (Entry.Kind) {
5346 case BitstreamEntry::EndBlock:
5347 return Strtab;
5348
5349 case BitstreamEntry::Error:
5350 return error("Malformed block");
5351
5352 case BitstreamEntry::SubBlock:
5353 if (Stream.SkipBlock())
5354 return error("Malformed block");
5355 break;
5356
5357 case BitstreamEntry::Record:
5358 StringRef Blob;
5359 SmallVector<uint64_t, 1> Record;
5360 if (Stream.readRecord(Entry.ID, Record, &Blob) == bitc::STRTAB_BLOB)
5361 Strtab = Blob;
5362 break;
5363 }
5364 }
5365}
5366
Chris Lattner6694f602007-04-29 07:54:31 +00005367//===----------------------------------------------------------------------===//
5368// External interface
5369//===----------------------------------------------------------------------===//
5370
Peter Collingbourne7a748032016-11-16 21:44:45 +00005371Expected<std::vector<BitcodeModule>>
5372llvm::getBitcodeModuleList(MemoryBufferRef Buffer) {
5373 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
5374 if (!StreamOrErr)
5375 return StreamOrErr.takeError();
5376 BitstreamCursor &Stream = *StreamOrErr;
5377
Peter Collingbourne7a748032016-11-16 21:44:45 +00005378 std::vector<BitcodeModule> Modules;
5379 while (true) {
Peter Collingbournebfcf9802016-11-29 02:27:04 +00005380 uint64_t BCBegin = Stream.getCurrentByteNo();
5381
Peter Collingbourne7a748032016-11-16 21:44:45 +00005382 // We may be consuming bitcode from a client that leaves garbage at the end
5383 // of the bitcode stream (e.g. Apple's ar tool). If we are close enough to
5384 // the end that there cannot possibly be another module, stop looking.
Peter Collingbournebfcf9802016-11-29 02:27:04 +00005385 if (BCBegin + 8 >= Stream.getBitcodeBytes().size())
Peter Collingbourne7a748032016-11-16 21:44:45 +00005386 return Modules;
5387
5388 BitstreamEntry Entry = Stream.advance();
5389 switch (Entry.Kind) {
5390 case BitstreamEntry::EndBlock:
5391 case BitstreamEntry::Error:
5392 return error("Malformed block");
5393
Peter Collingbournebfcf9802016-11-29 02:27:04 +00005394 case BitstreamEntry::SubBlock: {
5395 uint64_t IdentificationBit = -1ull;
5396 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {
5397 IdentificationBit = Stream.GetCurrentBitNo() - BCBegin * 8;
5398 if (Stream.SkipBlock())
5399 return error("Malformed block");
5400
5401 Entry = Stream.advance();
5402 if (Entry.Kind != BitstreamEntry::SubBlock ||
5403 Entry.ID != bitc::MODULE_BLOCK_ID)
5404 return error("Malformed block");
5405 }
5406
5407 if (Entry.ID == bitc::MODULE_BLOCK_ID) {
5408 uint64_t ModuleBit = Stream.GetCurrentBitNo() - BCBegin * 8;
5409 if (Stream.SkipBlock())
5410 return error("Malformed block");
5411
5412 Modules.push_back({Stream.getBitcodeBytes().slice(
5413 BCBegin, Stream.getCurrentByteNo() - BCBegin),
Peter Collingbourne7a748032016-11-16 21:44:45 +00005414 Buffer.getBufferIdentifier(), IdentificationBit,
Peter Collingbournebfcf9802016-11-29 02:27:04 +00005415 ModuleBit});
5416 continue;
5417 }
Peter Collingbourne7a748032016-11-16 21:44:45 +00005418
Peter Collingbournea0f371a2017-04-17 17:51:36 +00005419 if (Entry.ID == bitc::STRTAB_BLOCK_ID) {
5420 Expected<StringRef> Strtab = readStrtab(Stream);
5421 if (!Strtab)
5422 return Strtab.takeError();
5423 // This string table is used by every preceding bitcode module that does
5424 // not have its own string table. A bitcode file may have multiple
5425 // string tables if it was created by binary concatenation, for example
5426 // with "llvm-cat -b".
5427 for (auto I = Modules.rbegin(), E = Modules.rend(); I != E; ++I) {
5428 if (!I->Strtab.empty())
5429 break;
5430 I->Strtab = *Strtab;
5431 }
5432 continue;
5433 }
5434
Peter Collingbourne7a748032016-11-16 21:44:45 +00005435 if (Stream.SkipBlock())
5436 return error("Malformed block");
5437 continue;
Peter Collingbournebfcf9802016-11-29 02:27:04 +00005438 }
Peter Collingbourne7a748032016-11-16 21:44:45 +00005439 case BitstreamEntry::Record:
5440 Stream.skipRecord(Entry.ID);
5441 continue;
5442 }
5443 }
5444}
5445
Duncan P. N. Exon Smith6e1009b2014-08-01 22:27:19 +00005446/// \brief Get a lazy one-at-time loading module from bitcode.
Chris Lattner6694f602007-04-29 07:54:31 +00005447///
Duncan P. N. Exon Smith6e1009b2014-08-01 22:27:19 +00005448/// This isn't always used in a lazy context. In particular, it's also used by
Peter Collingbourne7a748032016-11-16 21:44:45 +00005449/// \a parseModule(). If this is truly lazy, then we need to eagerly pull
Duncan P. N. Exon Smith6e1009b2014-08-01 22:27:19 +00005450/// in forward-referenced functions from block address references.
5451///
Rafael Espindola728074b2015-06-17 00:40:56 +00005452/// \param[in] MaterializeAll Set to \c true if we should materialize
5453/// everything.
Peter Collingbourne7a748032016-11-16 21:44:45 +00005454Expected<std::unique_ptr<Module>>
5455BitcodeModule::getModuleImpl(LLVMContext &Context, bool MaterializeAll,
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005456 bool ShouldLazyLoadMetadata, bool IsImporting) {
Peter Collingbourne7a748032016-11-16 21:44:45 +00005457 BitstreamCursor Stream(Buffer);
Peter Collingbournec0032b72016-11-11 19:50:10 +00005458
Peter Collingbourne7a748032016-11-16 21:44:45 +00005459 std::string ProducerIdentification;
5460 if (IdentificationBit != -1ull) {
5461 Stream.JumpToBit(IdentificationBit);
5462 Expected<std::string> ProducerIdentificationOrErr =
5463 readIdentificationBlock(Stream);
5464 if (!ProducerIdentificationOrErr)
5465 return ProducerIdentificationOrErr.takeError();
5466
5467 ProducerIdentification = *ProducerIdentificationOrErr;
5468 }
5469
5470 Stream.JumpToBit(ModuleBit);
Peter Collingbournea0f371a2017-04-17 17:51:36 +00005471 auto *R = new BitcodeReader(std::move(Stream), Strtab, ProducerIdentification,
5472 Context);
Duncan P. N. Exon Smith908d8092014-08-01 21:11:34 +00005473
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005474 std::unique_ptr<Module> M =
Peter Collingbourne7a748032016-11-16 21:44:45 +00005475 llvm::make_unique<Module>(ModuleIdentifier, Context);
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005476 M->setMaterializer(R);
Rafael Espindolab7993462012-01-02 07:49:53 +00005477
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005478 // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005479 if (Error Err =
5480 R->parseBitcodeInto(M.get(), ShouldLazyLoadMetadata, IsImporting))
Peter Collingbourned9445c42016-11-13 07:00:17 +00005481 return std::move(Err);
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005482
5483 if (MaterializeAll) {
5484 // Read in the entire module, and destroy the BitcodeReader.
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +00005485 if (Error Err = M->materializeAll())
Peter Collingbourned9445c42016-11-13 07:00:17 +00005486 return std::move(Err);
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005487 } else {
5488 // Resolve forward references from blockaddresses.
Peter Collingbourne58f7f072016-11-09 00:51:04 +00005489 if (Error Err = R->materializeForwardReferencedFunctions())
Peter Collingbourned9445c42016-11-13 07:00:17 +00005490 return std::move(Err);
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005491 }
5492 return std::move(M);
Chris Lattner6694f602007-04-29 07:54:31 +00005493}
5494
Peter Collingbourned9445c42016-11-13 07:00:17 +00005495Expected<std::unique_ptr<Module>>
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005496BitcodeModule::getLazyModule(LLVMContext &Context, bool ShouldLazyLoadMetadata,
5497 bool IsImporting) {
5498 return getModuleImpl(Context, false, ShouldLazyLoadMetadata, IsImporting);
Peter Collingbourne7a748032016-11-16 21:44:45 +00005499}
5500
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005501// Parse the specified bitcode buffer and merge the index into CombinedIndex.
5502Error BitcodeModule::readSummary(ModuleSummaryIndex &CombinedIndex,
5503 unsigned ModuleId) {
5504 BitstreamCursor Stream(Buffer);
5505 Stream.JumpToBit(ModuleBit);
5506
5507 ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, CombinedIndex,
5508 ModuleIdentifier, ModuleId);
Peter Collingbourne440e2042017-05-01 22:48:10 +00005509 return R.parseModule();
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005510}
5511
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005512// Parse the specified bitcode buffer, returning the function info index.
5513Expected<std::unique_ptr<ModuleSummaryIndex>> BitcodeModule::getSummary() {
5514 BitstreamCursor Stream(Buffer);
5515 Stream.JumpToBit(ModuleBit);
5516
5517 auto Index = llvm::make_unique<ModuleSummaryIndex>();
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005518 ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, *Index,
5519 ModuleIdentifier, 0);
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005520
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005521 if (Error Err = R.parseModule())
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005522 return std::move(Err);
5523
5524 return std::move(Index);
5525}
5526
5527// Check if the given bitcode buffer contains a global value summary block.
5528Expected<bool> BitcodeModule::hasSummary() {
5529 BitstreamCursor Stream(Buffer);
5530 Stream.JumpToBit(ModuleBit);
5531
5532 if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
5533 return error("Invalid record");
5534
5535 while (true) {
5536 BitstreamEntry Entry = Stream.advance();
5537
5538 switch (Entry.Kind) {
5539 case BitstreamEntry::Error:
5540 return error("Malformed block");
5541 case BitstreamEntry::EndBlock:
5542 return false;
5543
5544 case BitstreamEntry::SubBlock:
5545 if (Entry.ID == bitc::GLOBALVAL_SUMMARY_BLOCK_ID)
5546 return true;
5547
5548 // Ignore other sub-blocks.
5549 if (Stream.SkipBlock())
5550 return error("Malformed block");
5551 continue;
5552
5553 case BitstreamEntry::Record:
5554 Stream.skipRecord(Entry.ID);
5555 continue;
5556 }
5557 }
5558}
5559
5560static Expected<BitcodeModule> getSingleModule(MemoryBufferRef Buffer) {
Peter Collingbourne7a748032016-11-16 21:44:45 +00005561 Expected<std::vector<BitcodeModule>> MsOrErr = getBitcodeModuleList(Buffer);
5562 if (!MsOrErr)
5563 return MsOrErr.takeError();
5564
5565 if (MsOrErr->size() != 1)
5566 return error("Expected a single module");
5567
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005568 return (*MsOrErr)[0];
5569}
5570
5571Expected<std::unique_ptr<Module>>
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005572llvm::getLazyBitcodeModule(MemoryBufferRef Buffer, LLVMContext &Context,
5573 bool ShouldLazyLoadMetadata, bool IsImporting) {
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005574 Expected<BitcodeModule> BM = getSingleModule(Buffer);
5575 if (!BM)
5576 return BM.takeError();
5577
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005578 return BM->getLazyModule(Context, ShouldLazyLoadMetadata, IsImporting);
Duncan P. N. Exon Smith6e1009b2014-08-01 22:27:19 +00005579}
Derek Schuff8b2dcad2012-02-06 22:30:29 +00005580
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005581Expected<std::unique_ptr<Module>> llvm::getOwningLazyBitcodeModule(
5582 std::unique_ptr<MemoryBuffer> &&Buffer, LLVMContext &Context,
5583 bool ShouldLazyLoadMetadata, bool IsImporting) {
5584 auto MOrErr = getLazyBitcodeModule(*Buffer, Context, ShouldLazyLoadMetadata,
5585 IsImporting);
Peter Collingbournee2dcf7c2016-11-08 06:03:43 +00005586 if (MOrErr)
5587 (*MOrErr)->setOwnedMemoryBuffer(std::move(Buffer));
5588 return MOrErr;
5589}
5590
Peter Collingbourne7a748032016-11-16 21:44:45 +00005591Expected<std::unique_ptr<Module>>
5592BitcodeModule::parseModule(LLVMContext &Context) {
Teresa Johnsona61f5e32016-12-16 21:25:01 +00005593 return getModuleImpl(Context, true, false, false);
Chad Rosierca2567b2011-12-07 21:44:12 +00005594 // TODO: Restore the use-lists to the in-memory state when the bitcode was
5595 // written. We must defer until the Module has been fully materialized.
Chris Lattner6694f602007-04-29 07:54:31 +00005596}
Bill Wendling0198ce02010-10-06 01:22:42 +00005597
Peter Collingbourne7a748032016-11-16 21:44:45 +00005598Expected<std::unique_ptr<Module>> llvm::parseBitcodeFile(MemoryBufferRef Buffer,
5599 LLVMContext &Context) {
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005600 Expected<BitcodeModule> BM = getSingleModule(Buffer);
5601 if (!BM)
5602 return BM.takeError();
Peter Collingbourne7a748032016-11-16 21:44:45 +00005603
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005604 return BM->parseModule(Context);
Peter Collingbourne7a748032016-11-16 21:44:45 +00005605}
5606
Peter Collingbournecd513a42016-11-11 19:50:24 +00005607Expected<std::string> llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer) {
5608 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
Peter Collingbournec0032b72016-11-11 19:50:10 +00005609 if (!StreamOrErr)
Peter Collingbournecd513a42016-11-11 19:50:24 +00005610 return StreamOrErr.takeError();
Peter Collingbournec0032b72016-11-11 19:50:10 +00005611
Peter Collingbournecd513a42016-11-11 19:50:24 +00005612 return readTriple(*StreamOrErr);
Bill Wendling0198ce02010-10-06 01:22:42 +00005613}
Teresa Johnson403a7872015-10-04 14:33:43 +00005614
Peter Collingbournecd513a42016-11-11 19:50:24 +00005615Expected<bool> llvm::isBitcodeContainingObjCCategory(MemoryBufferRef Buffer) {
5616 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
Peter Collingbournec0032b72016-11-11 19:50:10 +00005617 if (!StreamOrErr)
Peter Collingbournecd513a42016-11-11 19:50:24 +00005618 return StreamOrErr.takeError();
Peter Collingbournec0032b72016-11-11 19:50:10 +00005619
Peter Collingbournecd513a42016-11-11 19:50:24 +00005620 return hasObjCCategory(*StreamOrErr);
Mehdi Aminie75aa6f2016-07-11 23:10:18 +00005621}
5622
Peter Collingbournecd513a42016-11-11 19:50:24 +00005623Expected<std::string> llvm::getBitcodeProducerString(MemoryBufferRef Buffer) {
5624 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
Peter Collingbournec0032b72016-11-11 19:50:10 +00005625 if (!StreamOrErr)
Peter Collingbournecd513a42016-11-11 19:50:24 +00005626 return StreamOrErr.takeError();
5627
5628 return readIdentificationCode(*StreamOrErr);
Mehdi Amini3383ccc2015-11-09 02:46:41 +00005629}
5630
Peter Collingbourne74d22dd2017-05-01 22:04:36 +00005631Error llvm::readModuleSummaryIndex(MemoryBufferRef Buffer,
5632 ModuleSummaryIndex &CombinedIndex,
5633 unsigned ModuleId) {
5634 Expected<BitcodeModule> BM = getSingleModule(Buffer);
5635 if (!BM)
5636 return BM.takeError();
5637
5638 return BM->readSummary(CombinedIndex, ModuleId);
5639}
5640
Peter Collingbourne6de481a2016-11-11 19:50:39 +00005641Expected<std::unique_ptr<ModuleSummaryIndex>>
5642llvm::getModuleSummaryIndex(MemoryBufferRef Buffer) {
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005643 Expected<BitcodeModule> BM = getSingleModule(Buffer);
5644 if (!BM)
5645 return BM.takeError();
Peter Collingbournec0032b72016-11-11 19:50:10 +00005646
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005647 return BM->getSummary();
Teresa Johnson403a7872015-10-04 14:33:43 +00005648}
5649
Peter Collingbournecd513a42016-11-11 19:50:24 +00005650Expected<bool> llvm::hasGlobalValueSummary(MemoryBufferRef Buffer) {
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005651 Expected<BitcodeModule> BM = getSingleModule(Buffer);
5652 if (!BM)
5653 return BM.takeError();
Teresa Johnson403a7872015-10-04 14:33:43 +00005654
Peter Collingbournea46ec9f2016-12-01 06:00:53 +00005655 return BM->hasSummary();
Teresa Johnson403a7872015-10-04 14:33:43 +00005656}
Peter Collingbournec15d60b2017-05-01 20:42:32 +00005657
5658Expected<std::unique_ptr<ModuleSummaryIndex>>
Teresa Johnson4cd12ce2017-05-12 19:32:11 +00005659llvm::getModuleSummaryIndexForFile(StringRef Path,
5660 bool IgnoreEmptyThinLTOIndexFile) {
Peter Collingbournec15d60b2017-05-01 20:42:32 +00005661 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
5662 MemoryBuffer::getFileOrSTDIN(Path);
5663 if (!FileOrErr)
5664 return errorCodeToError(FileOrErr.getError());
5665 if (IgnoreEmptyThinLTOIndexFile && !(*FileOrErr)->getBufferSize())
5666 return nullptr;
5667 return getModuleSummaryIndex(**FileOrErr);
5668}