LLVM 23.0.0git
BitcodeReader.cpp
Go to the documentation of this file.
1//===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
10#include "MetadataLoader.h"
11#include "ValueList.h"
12#include "llvm/ADT/APFloat.h"
13#include "llvm/ADT/APInt.h"
14#include "llvm/ADT/ArrayRef.h"
15#include "llvm/ADT/DenseMap.h"
16#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/ADT/Twine.h"
24#include "llvm/Config/llvm-config.h"
25#include "llvm/IR/Argument.h"
27#include "llvm/IR/Attributes.h"
28#include "llvm/IR/AutoUpgrade.h"
29#include "llvm/IR/BasicBlock.h"
30#include "llvm/IR/CallingConv.h"
31#include "llvm/IR/Comdat.h"
32#include "llvm/IR/Constant.h"
34#include "llvm/IR/Constants.h"
35#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/DebugInfo.h"
38#include "llvm/IR/DebugLoc.h"
40#include "llvm/IR/Function.h"
43#include "llvm/IR/GlobalAlias.h"
44#include "llvm/IR/GlobalIFunc.h"
46#include "llvm/IR/GlobalValue.h"
48#include "llvm/IR/InlineAsm.h"
50#include "llvm/IR/InstrTypes.h"
51#include "llvm/IR/Instruction.h"
53#include "llvm/IR/Intrinsics.h"
54#include "llvm/IR/IntrinsicsAArch64.h"
55#include "llvm/IR/IntrinsicsARM.h"
56#include "llvm/IR/LLVMContext.h"
57#include "llvm/IR/Metadata.h"
58#include "llvm/IR/Module.h"
60#include "llvm/IR/Operator.h"
62#include "llvm/IR/Type.h"
63#include "llvm/IR/Value.h"
64#include "llvm/IR/Verifier.h"
69#include "llvm/Support/Debug.h"
70#include "llvm/Support/Error.h"
75#include "llvm/Support/ModRef.h"
79#include <algorithm>
80#include <cassert>
81#include <cstddef>
82#include <cstdint>
83#include <deque>
84#include <map>
85#include <memory>
86#include <optional>
87#include <string>
88#include <system_error>
89#include <tuple>
90#include <utility>
91#include <vector>
92
93using namespace llvm;
94
96 "print-summary-global-ids", cl::init(false), cl::Hidden,
98 "Print the global id for each value when reading the module summary"));
99
101 "expand-constant-exprs", cl::Hidden,
102 cl::desc(
103 "Expand constant expressions to instructions for testing purposes"));
104
105namespace {
106
107enum {
108 SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
109};
110
111} // end anonymous namespace
112
113static Error error(const Twine &Message) {
116}
117
119 if (!Stream.canSkipToPos(4))
120 return createStringError(std::errc::illegal_byte_sequence,
121 "file too small to contain bitcode header");
122 for (unsigned C : {'B', 'C'})
123 if (Expected<SimpleBitstreamCursor::word_t> Res = Stream.Read(8)) {
124 if (Res.get() != C)
125 return createStringError(std::errc::illegal_byte_sequence,
126 "file doesn't start with bitcode header");
127 } else
128 return Res.takeError();
129 for (unsigned C : {0x0, 0xC, 0xE, 0xD})
130 if (Expected<SimpleBitstreamCursor::word_t> Res = Stream.Read(4)) {
131 if (Res.get() != C)
132 return createStringError(std::errc::illegal_byte_sequence,
133 "file doesn't start with bitcode header");
134 } else
135 return Res.takeError();
136 return Error::success();
137}
138
140 const unsigned char *BufPtr = (const unsigned char *)Buffer.getBufferStart();
141 const unsigned char *BufEnd = BufPtr + Buffer.getBufferSize();
142
143 if (Buffer.getBufferSize() & 3)
144 return error("Invalid bitcode signature");
145
146 // If we have a wrapper header, parse it and ignore the non-bc file contents.
147 // The magic number is 0x0B17C0DE stored in little endian.
148 if (isBitcodeWrapper(BufPtr, BufEnd))
149 if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
150 return error("Invalid bitcode wrapper header");
151
152 BitstreamCursor Stream(ArrayRef<uint8_t>(BufPtr, BufEnd));
153 if (Error Err = hasInvalidBitcodeHeader(Stream))
154 return std::move(Err);
155
156 return std::move(Stream);
157}
158
159/// Convert a string from a record into an std::string, return true on failure.
160template <typename StrTy>
161static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,
162 StrTy &Result) {
163 if (Idx > Record.size())
164 return true;
165
166 Result.append(Record.begin() + Idx, Record.end());
167 return false;
168}
169
170// Strip all the TBAA attachment for the module.
171static void stripTBAA(Module *M) {
172 for (auto &F : *M) {
173 if (F.isMaterializable())
174 continue;
175 for (auto &I : instructions(F))
176 I.setMetadata(LLVMContext::MD_tbaa, nullptr);
177 }
178}
179
180/// Read the "IDENTIFICATION_BLOCK_ID" block, do some basic enforcement on the
181/// "epoch" encoded in the bitcode, and return the producer name if any.
184 return std::move(Err);
185
186 // Read all the records.
188
189 std::string ProducerIdentification;
190
191 while (true) {
192 BitstreamEntry Entry;
193 if (Error E = Stream.advance().moveInto(Entry))
194 return std::move(E);
195
196 switch (Entry.Kind) {
197 default:
199 return error("Malformed block");
201 return ProducerIdentification;
203 // The interesting case.
204 break;
205 }
206
207 // Read a record.
208 Record.clear();
209 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
210 if (!MaybeBitCode)
211 return MaybeBitCode.takeError();
212 switch (MaybeBitCode.get()) {
213 default: // Default behavior: reject
214 return error("Invalid value");
215 case bitc::IDENTIFICATION_CODE_STRING: // IDENTIFICATION: [strchr x N]
216 convertToString(Record, 0, ProducerIdentification);
217 break;
218 case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH: [epoch#]
219 unsigned epoch = (unsigned)Record[0];
220 if (epoch != bitc::BITCODE_CURRENT_EPOCH) {
221 return error(
222 Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +
223 "' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");
224 }
225 }
226 }
227 }
228}
229
231 // We expect a number of well-defined blocks, though we don't necessarily
232 // need to understand them all.
233 while (true) {
234 if (Stream.AtEndOfStream())
235 return "";
236
237 BitstreamEntry Entry;
238 if (Error E = Stream.advance().moveInto(Entry))
239 return std::move(E);
240
241 switch (Entry.Kind) {
244 return error("Malformed block");
245
247 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID)
248 return readIdentificationBlock(Stream);
249
250 // Ignore other sub-blocks.
251 if (Error Err = Stream.SkipBlock())
252 return std::move(Err);
253 continue;
255 if (Error E = Stream.skipRecord(Entry.ID).takeError())
256 return std::move(E);
257 continue;
258 }
259 }
260}
261
263 if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
264 return std::move(Err);
265
267 // Read all the records for this module.
268
269 while (true) {
271 if (!MaybeEntry)
272 return MaybeEntry.takeError();
273 BitstreamEntry Entry = MaybeEntry.get();
274
275 switch (Entry.Kind) {
276 case BitstreamEntry::SubBlock: // Handled for us already.
278 return error("Malformed block");
280 return false;
282 // The interesting case.
283 break;
284 }
285
286 // Read a record.
287 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
288 if (!MaybeRecord)
289 return MaybeRecord.takeError();
290 switch (MaybeRecord.get()) {
291 default:
292 break; // Default behavior, ignore unknown content.
293 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
294 std::string S;
295 if (convertToString(Record, 0, S))
296 return error("Invalid section name record");
297
298 // Check for the i386 and other (x86_64, ARM) conventions
299
300 auto [Segment, Section] = StringRef(S).split(",");
301 Segment = Segment.trim();
302 Section = Section.trim();
303
304 if (Segment == "__DATA" && Section.starts_with("__objc_catlist"))
305 return true;
306 if (Segment == "__OBJC" && Section.starts_with("__category"))
307 return true;
308 if (Segment == "__TEXT" && Section.starts_with("__swift"))
309 return true;
310 break;
311 }
312 }
313 Record.clear();
314 }
315 llvm_unreachable("Exit infinite loop");
316}
317
319 // We expect a number of well-defined blocks, though we don't necessarily
320 // need to understand them all.
321 while (true) {
322 BitstreamEntry Entry;
323 if (Error E = Stream.advance().moveInto(Entry))
324 return std::move(E);
325
326 switch (Entry.Kind) {
328 return error("Malformed block");
330 return false;
331
333 if (Entry.ID == bitc::MODULE_BLOCK_ID)
334 return hasObjCCategoryInModule(Stream);
335
336 // Ignore other sub-blocks.
337 if (Error Err = Stream.SkipBlock())
338 return std::move(Err);
339 continue;
340
342 if (Error E = Stream.skipRecord(Entry.ID).takeError())
343 return std::move(E);
344 continue;
345 }
346 }
347}
348
350 if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
351 return std::move(Err);
352
354
355 std::string Triple;
356
357 // Read all the records for this module.
358 while (true) {
360 if (!MaybeEntry)
361 return MaybeEntry.takeError();
362 BitstreamEntry Entry = MaybeEntry.get();
363
364 switch (Entry.Kind) {
365 case BitstreamEntry::SubBlock: // Handled for us already.
367 return error("Malformed block");
369 return Triple;
371 // The interesting case.
372 break;
373 }
374
375 // Read a record.
376 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
377 if (!MaybeRecord)
378 return MaybeRecord.takeError();
379 switch (MaybeRecord.get()) {
380 default: break; // Default behavior, ignore unknown content.
381 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
382 std::string S;
383 if (convertToString(Record, 0, S))
384 return error("Invalid triple record");
385 Triple = S;
386 break;
387 }
388 }
389 Record.clear();
390 }
391 llvm_unreachable("Exit infinite loop");
392}
393
395 // We expect a number of well-defined blocks, though we don't necessarily
396 // need to understand them all.
397 while (true) {
398 Expected<BitstreamEntry> MaybeEntry = Stream.advance();
399 if (!MaybeEntry)
400 return MaybeEntry.takeError();
401 BitstreamEntry Entry = MaybeEntry.get();
402
403 switch (Entry.Kind) {
405 return error("Malformed block");
407 return "";
408
410 if (Entry.ID == bitc::MODULE_BLOCK_ID)
411 return readModuleTriple(Stream);
412
413 // Ignore other sub-blocks.
414 if (Error Err = Stream.SkipBlock())
415 return std::move(Err);
416 continue;
417
419 if (llvm::Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID))
420 continue;
421 else
422 return Skipped.takeError();
423 }
424 }
425}
426
427namespace {
428
429class BitcodeReaderBase {
430protected:
431 BitcodeReaderBase(BitstreamCursor Stream, StringRef Strtab)
432 : Stream(std::move(Stream)), Strtab(Strtab) {
433 this->Stream.setBlockInfo(&BlockInfo);
434 }
435
436 BitstreamBlockInfo BlockInfo;
437 BitstreamCursor Stream;
438 StringRef Strtab;
439
440 /// In version 2 of the bitcode we store names of global values and comdats in
441 /// a string table rather than in the VST.
442 bool UseStrtab = false;
443
444 Expected<unsigned> parseVersionRecord(ArrayRef<uint64_t> Record);
445
446 /// If this module uses a string table, pop the reference to the string table
447 /// and return the referenced string and the rest of the record. Otherwise
448 /// just return the record itself.
449 std::pair<StringRef, ArrayRef<uint64_t>>
450 readNameFromStrtab(ArrayRef<uint64_t> Record);
451
452 Error readBlockInfo();
453
454 // Contains an arbitrary and optional string identifying the bitcode producer
455 std::string ProducerIdentification;
456
457 Error error(const Twine &Message);
458};
459
460} // end anonymous namespace
461
462Error BitcodeReaderBase::error(const Twine &Message) {
463 std::string FullMsg = Message.str();
464 if (!ProducerIdentification.empty())
465 FullMsg += " (Producer: '" + ProducerIdentification + "' Reader: 'LLVM " +
466 LLVM_VERSION_STRING "')";
467 return ::error(FullMsg);
468}
469
470Expected<unsigned>
471BitcodeReaderBase::parseVersionRecord(ArrayRef<uint64_t> Record) {
472 if (Record.empty())
473 return error("Invalid version record");
474 unsigned ModuleVersion = Record[0];
475 if (ModuleVersion > 2)
476 return error("Invalid value");
477 UseStrtab = ModuleVersion >= 2;
478 return ModuleVersion;
479}
480
481std::pair<StringRef, ArrayRef<uint64_t>>
482BitcodeReaderBase::readNameFromStrtab(ArrayRef<uint64_t> Record) {
483 if (!UseStrtab)
484 return {"", Record};
485 // Invalid reference. Let the caller complain about the record being empty.
486 if (Record[0] + Record[1] > Strtab.size())
487 return {"", {}};
488 return {StringRef(Strtab.data() + Record[0], Record[1]), Record.slice(2)};
489}
490
491namespace {
492
493/// This represents a constant expression or constant aggregate using a custom
494/// structure internal to the bitcode reader. Later, this structure will be
495/// expanded by materializeValue() either into a constant expression/aggregate,
496/// or into an instruction sequence at the point of use. This allows us to
497/// upgrade bitcode using constant expressions even if this kind of constant
498/// expression is no longer supported.
499class BitcodeConstant final : public Value,
500 TrailingObjects<BitcodeConstant, unsigned> {
501 friend TrailingObjects;
502
503 // Value subclass ID: Pick largest possible value to avoid any clashes.
504 static constexpr uint8_t SubclassID = 255;
505
506public:
507 // Opcodes used for non-expressions. This includes constant aggregates
508 // (struct, array, vector) that might need expansion, as well as non-leaf
509 // constants that don't need expansion (no_cfi, dso_local, blockaddress),
510 // but still go through BitcodeConstant to avoid different uselist orders
511 // between the two cases.
512 static constexpr uint8_t ConstantStructOpcode = 255;
513 static constexpr uint8_t ConstantArrayOpcode = 254;
514 static constexpr uint8_t ConstantVectorOpcode = 253;
515 static constexpr uint8_t NoCFIOpcode = 252;
516 static constexpr uint8_t DSOLocalEquivalentOpcode = 251;
517 static constexpr uint8_t BlockAddressOpcode = 250;
518 static constexpr uint8_t ConstantPtrAuthOpcode = 249;
519 static constexpr uint8_t FirstSpecialOpcode = ConstantPtrAuthOpcode;
520
521 // Separate struct to make passing different number of parameters to
522 // BitcodeConstant::create() more convenient.
523 struct ExtraInfo {
524 uint8_t Opcode;
525 uint8_t Flags;
526 unsigned BlockAddressBB = 0;
527 Type *SrcElemTy = nullptr;
528 std::optional<ConstantRange> InRange;
529
530 ExtraInfo(uint8_t Opcode, uint8_t Flags = 0, Type *SrcElemTy = nullptr,
531 std::optional<ConstantRange> InRange = std::nullopt)
532 : Opcode(Opcode), Flags(Flags), SrcElemTy(SrcElemTy),
533 InRange(std::move(InRange)) {}
534
535 ExtraInfo(uint8_t Opcode, uint8_t Flags, unsigned BlockAddressBB)
536 : Opcode(Opcode), Flags(Flags), BlockAddressBB(BlockAddressBB) {}
537 };
538
539 uint8_t Opcode;
540 uint8_t Flags;
541 unsigned NumOperands;
542 unsigned BlockAddressBB;
543 Type *SrcElemTy; // GEP source element type.
544 std::optional<ConstantRange> InRange; // GEP inrange attribute.
545
546private:
547 BitcodeConstant(Type *Ty, const ExtraInfo &Info, ArrayRef<unsigned> OpIDs)
548 : Value(Ty, SubclassID), Opcode(Info.Opcode), Flags(Info.Flags),
549 NumOperands(OpIDs.size()), BlockAddressBB(Info.BlockAddressBB),
550 SrcElemTy(Info.SrcElemTy), InRange(Info.InRange) {
551 llvm::uninitialized_copy(OpIDs, getTrailingObjects());
552 }
553
554 BitcodeConstant &operator=(const BitcodeConstant &) = delete;
555
556public:
557 static BitcodeConstant *create(BumpPtrAllocator &A, Type *Ty,
558 const ExtraInfo &Info,
559 ArrayRef<unsigned> OpIDs) {
560 void *Mem = A.Allocate(totalSizeToAlloc<unsigned>(OpIDs.size()),
561 alignof(BitcodeConstant));
562 return new (Mem) BitcodeConstant(Ty, Info, OpIDs);
563 }
564
565 static bool classof(const Value *V) { return V->getValueID() == SubclassID; }
566
567 ArrayRef<unsigned> getOperandIDs() const {
568 return ArrayRef(getTrailingObjects(), NumOperands);
569 }
570
571 std::optional<ConstantRange> getInRange() const {
572 assert(Opcode == Instruction::GetElementPtr);
573 return InRange;
574 }
575
576 const char *getOpcodeName() const {
577 return Instruction::getOpcodeName(Opcode);
578 }
579};
580
581class BitcodeReader : public BitcodeReaderBase, public GVMaterializer {
582 LLVMContext &Context;
583 Module *TheModule = nullptr;
584 // Next offset to start scanning for lazy parsing of function bodies.
585 uint64_t NextUnreadBit = 0;
586 // Last function offset found in the VST.
587 uint64_t LastFunctionBlockBit = 0;
588 bool SeenValueSymbolTable = false;
589 uint64_t VSTOffset = 0;
590
591 std::vector<std::string> SectionTable;
592 std::vector<std::string> GCTable;
593
594 std::vector<Type *> TypeList;
595 /// Track type IDs of contained types. Order is the same as the contained
596 /// types of a Type*. This is used during upgrades of typed pointer IR in
597 /// opaque pointer mode.
598 DenseMap<unsigned, SmallVector<unsigned, 1>> ContainedTypeIDs;
599 /// In some cases, we need to create a type ID for a type that was not
600 /// explicitly encoded in the bitcode, or we don't know about at the current
601 /// point. For example, a global may explicitly encode the value type ID, but
602 /// not have a type ID for the pointer to value type, for which we create a
603 /// virtual type ID instead. This map stores the new type ID that was created
604 /// for the given pair of Type and contained type ID.
605 DenseMap<std::pair<Type *, unsigned>, unsigned> VirtualTypeIDs;
606 DenseMap<Function *, unsigned> FunctionTypeIDs;
607 /// Allocator for BitcodeConstants. This should come before ValueList,
608 /// because the ValueList might hold ValueHandles to these constants, so
609 /// ValueList must be destroyed before Alloc.
611 BitcodeReaderValueList ValueList;
612 std::optional<MetadataLoader> MDLoader;
613 std::vector<Comdat *> ComdatList;
614 DenseSet<GlobalObject *> ImplicitComdatObjects;
615 SmallVector<Instruction *, 64> InstructionList;
616
617 std::vector<std::pair<GlobalVariable *, unsigned>> GlobalInits;
618 std::vector<std::pair<GlobalValue *, unsigned>> IndirectSymbolInits;
619
620 struct FunctionOperandInfo {
621 Function *F;
622 unsigned PersonalityFn;
623 unsigned Prefix;
624 unsigned Prologue;
625 };
626 std::vector<FunctionOperandInfo> FunctionOperands;
627
628 /// The set of attributes by index. Index zero in the file is for null, and
629 /// is thus not represented here. As such all indices are off by one.
630 std::vector<AttributeList> MAttributes;
631
632 /// The set of attribute groups.
633 std::map<unsigned, AttributeList> MAttributeGroups;
634
635 /// While parsing a function body, this is a list of the basic blocks for the
636 /// function.
637 std::vector<BasicBlock*> FunctionBBs;
638
639 // When reading the module header, this list is populated with functions that
640 // have bodies later in the file.
641 std::vector<Function*> FunctionsWithBodies;
642
643 // When intrinsic functions are encountered which require upgrading they are
644 // stored here with their replacement function.
645 using UpdatedIntrinsicMap = DenseMap<Function *, Function *>;
646 UpdatedIntrinsicMap UpgradedIntrinsics;
647
648 // Several operations happen after the module header has been read, but
649 // before function bodies are processed. This keeps track of whether
650 // we've done this yet.
651 bool SeenFirstFunctionBody = false;
652
653 /// When function bodies are initially scanned, this map contains info about
654 /// where to find deferred function body in the stream.
655 DenseMap<Function*, uint64_t> DeferredFunctionInfo;
656
657 /// When Metadata block is initially scanned when parsing the module, we may
658 /// choose to defer parsing of the metadata. This vector contains info about
659 /// which Metadata blocks are deferred.
660 std::vector<uint64_t> DeferredMetadataInfo;
661
662 /// These are basic blocks forward-referenced by block addresses. They are
663 /// inserted lazily into functions when they're loaded. The basic block ID is
664 /// its index into the vector.
665 DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;
666 std::deque<Function *> BasicBlockFwdRefQueue;
667
668 /// These are Functions that contain BlockAddresses which refer a different
669 /// Function. When parsing the different Function, queue Functions that refer
670 /// to the different Function. Those Functions must be materialized in order
671 /// to resolve their BlockAddress constants before the different Function
672 /// gets moved into another Module.
673 std::vector<Function *> BackwardRefFunctions;
674
675 /// Indicates that we are using a new encoding for instruction operands where
676 /// most operands in the current FUNCTION_BLOCK are encoded relative to the
677 /// instruction number, for a more compact encoding. Some instruction
678 /// operands are not relative to the instruction ID: basic block numbers, and
679 /// types. Once the old style function blocks have been phased out, we would
680 /// not need this flag.
681 bool UseRelativeIDs = false;
682
683 /// True if all functions will be materialized, negating the need to process
684 /// (e.g.) blockaddress forward references.
685 bool WillMaterializeAllForwardRefs = false;
686
687 /// Tracks whether we have seen debug intrinsics or records in this bitcode;
688 /// seeing both in a single module is currently a fatal error.
689 bool SeenDebugIntrinsic = false;
690 bool SeenDebugRecord = false;
691
692 bool StripDebugInfo = false;
693 TBAAVerifier TBAAVerifyHelper;
694
695 std::vector<std::string> BundleTags;
697
698 std::optional<ValueTypeCallbackTy> ValueTypeCallback;
699
700public:
701 BitcodeReader(BitstreamCursor Stream, StringRef Strtab,
702 StringRef ProducerIdentification, LLVMContext &Context);
703
704 Error materializeForwardReferencedFunctions();
705
706 Error materialize(GlobalValue *GV) override;
707 Error materializeModule() override;
708 std::vector<StructType *> getIdentifiedStructTypes() const override;
709
710 /// Main interface to parsing a bitcode buffer.
711 /// \returns true if an error occurred.
712 Error parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata,
713 bool IsImporting, ParserCallbacks Callbacks = {});
714
715 static uint64_t decodeSignRotatedValue(uint64_t V);
716
717 /// Materialize any deferred Metadata block.
718 Error materializeMetadata() override;
719
720 void setStripDebugInfo() override;
721
722private:
723 std::vector<StructType *> IdentifiedStructTypes;
724 StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);
725 StructType *createIdentifiedStructType(LLVMContext &Context);
726
727 static constexpr unsigned InvalidTypeID = ~0u;
728
729 Type *getTypeByID(unsigned ID);
730 Type *getPtrElementTypeByID(unsigned ID);
731 unsigned getContainedTypeID(unsigned ID, unsigned Idx = 0);
732 unsigned getVirtualTypeID(Type *Ty, ArrayRef<unsigned> ContainedTypeIDs = {});
733
734 void callValueTypeCallback(Value *F, unsigned TypeID);
735 Expected<Value *> materializeValue(unsigned ValID, BasicBlock *InsertBB);
736 Expected<Constant *> getValueForInitializer(unsigned ID);
737
738 Value *getFnValueByID(unsigned ID, Type *Ty, unsigned TyID,
739 BasicBlock *ConstExprInsertBB) {
740 if (Ty && Ty->isMetadataTy())
741 return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));
742 return ValueList.getValueFwdRef(ID, Ty, TyID, ConstExprInsertBB);
743 }
744
745 Metadata *getFnMetadataByID(unsigned ID) {
746 return MDLoader->getMetadataFwdRefOrLoad(ID);
747 }
748
749 BasicBlock *getBasicBlock(unsigned ID) const {
750 if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID
751 return FunctionBBs[ID];
752 }
753
754 AttributeList getAttributes(unsigned i) const {
755 if (i-1 < MAttributes.size())
756 return MAttributes[i-1];
757 return AttributeList();
758 }
759
760 /// Read a value/type pair out of the specified record from slot 'Slot'.
761 /// Increment Slot past the number of slots used in the record. Return true on
762 /// failure.
763 bool getValueTypePair(const SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
764 unsigned InstNum, Value *&ResVal, unsigned &TypeID,
765 BasicBlock *ConstExprInsertBB) {
766 if (Slot == Record.size()) return true;
767 unsigned ValNo = (unsigned)Record[Slot++];
768 // Adjust the ValNo, if it was encoded relative to the InstNum.
769 if (UseRelativeIDs)
770 ValNo = InstNum - ValNo;
771 if (ValNo < InstNum) {
772 // If this is not a forward reference, just return the value we already
773 // have.
774 TypeID = ValueList.getTypeID(ValNo);
775 ResVal = getFnValueByID(ValNo, nullptr, TypeID, ConstExprInsertBB);
776 assert((!ResVal || ResVal->getType() == getTypeByID(TypeID)) &&
777 "Incorrect type ID stored for value");
778 return ResVal == nullptr;
779 }
780 if (Slot == Record.size())
781 return true;
782
783 TypeID = (unsigned)Record[Slot++];
784 ResVal = getFnValueByID(ValNo, getTypeByID(TypeID), TypeID,
785 ConstExprInsertBB);
786 return ResVal == nullptr;
787 }
788
789 bool getValueOrMetadata(const SmallVectorImpl<uint64_t> &Record,
790 unsigned &Slot, unsigned InstNum, Value *&ResVal,
791 BasicBlock *ConstExprInsertBB) {
792 if (Slot == Record.size())
793 return true;
794 unsigned ValID = Record[Slot++];
795 if (ValID != static_cast<unsigned>(bitc::OB_METADATA)) {
796 unsigned TypeId;
797 return getValueTypePair(Record, --Slot, InstNum, ResVal, TypeId,
798 ConstExprInsertBB);
799 }
800 if (Slot == Record.size())
801 return true;
802 unsigned ValNo = InstNum - (unsigned)Record[Slot++];
803 ResVal = MetadataAsValue::get(Context, getFnMetadataByID(ValNo));
804 return false;
805 }
806
807 /// Read a value out of the specified record from slot 'Slot'. Increment Slot
808 /// past the number of slots used by the value in the record. Return true if
809 /// there is an error.
810 bool popValue(const SmallVectorImpl<uint64_t> &Record, unsigned &Slot,
811 unsigned InstNum, Type *Ty, unsigned TyID, Value *&ResVal,
812 BasicBlock *ConstExprInsertBB) {
813 if (getValue(Record, Slot, InstNum, Ty, TyID, ResVal, ConstExprInsertBB))
814 return true;
815 // All values currently take a single record slot.
816 ++Slot;
817 return false;
818 }
819
820 /// Like popValue, but does not increment the Slot number.
821 bool getValue(const SmallVectorImpl<uint64_t> &Record, unsigned Slot,
822 unsigned InstNum, Type *Ty, unsigned TyID, Value *&ResVal,
823 BasicBlock *ConstExprInsertBB) {
824 ResVal = getValue(Record, Slot, InstNum, Ty, TyID, ConstExprInsertBB);
825 return ResVal == nullptr;
826 }
827
828 /// Version of getValue that returns ResVal directly, or 0 if there is an
829 /// error.
830 Value *getValue(const SmallVectorImpl<uint64_t> &Record, unsigned Slot,
831 unsigned InstNum, Type *Ty, unsigned TyID,
832 BasicBlock *ConstExprInsertBB) {
833 if (Slot == Record.size()) return nullptr;
834 unsigned ValNo = (unsigned)Record[Slot];
835 // Adjust the ValNo, if it was encoded relative to the InstNum.
836 if (UseRelativeIDs)
837 ValNo = InstNum - ValNo;
838 return getFnValueByID(ValNo, Ty, TyID, ConstExprInsertBB);
839 }
840
841 /// Like getValue, but decodes signed VBRs.
842 Value *getValueSigned(const SmallVectorImpl<uint64_t> &Record, unsigned Slot,
843 unsigned InstNum, Type *Ty, unsigned TyID,
844 BasicBlock *ConstExprInsertBB) {
845 if (Slot == Record.size()) return nullptr;
846 unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);
847 // Adjust the ValNo, if it was encoded relative to the InstNum.
848 if (UseRelativeIDs)
849 ValNo = InstNum - ValNo;
850 return getFnValueByID(ValNo, Ty, TyID, ConstExprInsertBB);
851 }
852
853 Expected<ConstantRange> readConstantRange(ArrayRef<uint64_t> Record,
854 unsigned &OpNum,
855 unsigned BitWidth) {
856 if (Record.size() - OpNum < 2)
857 return error("Too few records for range");
858 if (BitWidth > 64) {
859 unsigned LowerActiveWords = Record[OpNum];
860 unsigned UpperActiveWords = Record[OpNum++] >> 32;
861 if (Record.size() - OpNum < LowerActiveWords + UpperActiveWords)
862 return error("Too few records for range");
863 APInt Lower =
864 readWideAPInt(ArrayRef(&Record[OpNum], LowerActiveWords), BitWidth);
865 OpNum += LowerActiveWords;
866 APInt Upper =
867 readWideAPInt(ArrayRef(&Record[OpNum], UpperActiveWords), BitWidth);
868 OpNum += UpperActiveWords;
869 return ConstantRange(Lower, Upper);
870 } else {
871 int64_t Start = BitcodeReader::decodeSignRotatedValue(Record[OpNum++]);
872 int64_t End = BitcodeReader::decodeSignRotatedValue(Record[OpNum++]);
873 return ConstantRange(APInt(BitWidth, Start, true),
874 APInt(BitWidth, End, true));
875 }
876 }
877
878 Expected<ConstantRange>
879 readBitWidthAndConstantRange(ArrayRef<uint64_t> Record, unsigned &OpNum) {
880 if (Record.size() - OpNum < 1)
881 return error("Too few records for range");
882 unsigned BitWidth = Record[OpNum++];
883 return readConstantRange(Record, OpNum, BitWidth);
884 }
885
886 /// Upgrades old-style typeless byval/sret/inalloca attributes by adding the
887 /// corresponding argument's pointee type. Also upgrades intrinsics that now
888 /// require an elementtype attribute.
889 Error propagateAttributeTypes(CallBase *CB, ArrayRef<unsigned> ArgsTys);
890
891 /// Converts alignment exponent (i.e. power of two (or zero)) to the
892 /// corresponding alignment to use. If alignment is too large, returns
893 /// a corresponding error code.
894 Error parseAlignmentValue(uint64_t Exponent, MaybeAlign &Alignment);
895 Error parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);
896 Error parseModule(uint64_t ResumeBit, bool ShouldLazyLoadMetadata = false,
897 ParserCallbacks Callbacks = {});
898
899 Error parseComdatRecord(ArrayRef<uint64_t> Record);
900 Error parseGlobalVarRecord(ArrayRef<uint64_t> Record);
901 Error parseFunctionRecord(ArrayRef<uint64_t> Record);
902 Error parseGlobalIndirectSymbolRecord(unsigned BitCode,
903 ArrayRef<uint64_t> Record);
904
905 Error parseAttributeBlock();
906 Error parseAttributeGroupBlock();
907 Error parseTypeTable();
908 Error parseTypeTableBody();
909 Error parseOperandBundleTags();
910 Error parseSyncScopeNames();
911
912 Expected<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,
913 unsigned NameIndex, Triple &TT);
914 void setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta, Function *F,
915 ArrayRef<uint64_t> Record);
916 Error parseValueSymbolTable(uint64_t Offset = 0);
917 Error parseGlobalValueSymbolTable();
918 Error parseConstants();
919 Error rememberAndSkipFunctionBodies();
920 Error rememberAndSkipFunctionBody();
921 /// Save the positions of the Metadata blocks and skip parsing the blocks.
922 Error rememberAndSkipMetadata();
923 Error typeCheckLoadStoreInst(Type *ValType, Type *PtrType);
924 Error parseFunctionBody(Function *F);
925 Error globalCleanup();
926 Error resolveGlobalAndIndirectSymbolInits();
927 Error parseUseLists();
928 Error findFunctionInStream(
929 Function *F,
930 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);
931
932 SyncScope::ID getDecodedSyncScopeID(unsigned Val);
933};
934
935/// Class to manage reading and parsing function summary index bitcode
936/// files/sections.
937class ModuleSummaryIndexBitcodeReader : public BitcodeReaderBase {
938 /// The module index built during parsing.
939 ModuleSummaryIndex &TheIndex;
940
941 /// Indicates whether we have encountered a global value summary section
942 /// yet during parsing.
943 bool SeenGlobalValSummary = false;
944
945 /// Indicates whether we have already parsed the VST, used for error checking.
946 bool SeenValueSymbolTable = false;
947
948 /// Set to the offset of the VST recorded in the MODULE_CODE_VSTOFFSET record.
949 /// Used to enable on-demand parsing of the VST.
950 uint64_t VSTOffset = 0;
951
952 // Map to save ValueId to ValueInfo association that was recorded in the
953 // ValueSymbolTable. It is used after the VST is parsed to convert
954 // call graph edges read from the function summary from referencing
955 // callees by their ValueId to using the ValueInfo instead, which is how
956 // they are recorded in the summary index being built.
957 // We save a GUID which refers to the same global as the ValueInfo, but
958 // ignoring the linkage, i.e. for values other than local linkage they are
959 // identical (this is the second member). ValueInfo has the real GUID.
960 DenseMap<unsigned, std::pair<ValueInfo, GlobalValue::GUID>>
961 ValueIdToValueInfoMap;
962
963 /// Map populated during module path string table parsing, from the
964 /// module ID to a string reference owned by the index's module
965 /// path string table, used to correlate with combined index
966 /// summary records.
967 DenseMap<uint64_t, StringRef> ModuleIdMap;
968
969 /// Original source file name recorded in a bitcode record.
970 std::string SourceFileName;
971
972 /// The string identifier given to this module by the client, normally the
973 /// path to the bitcode file.
974 StringRef ModulePath;
975
976 /// Callback to ask whether a symbol is the prevailing copy when invoked
977 /// during combined index building.
978 std::function<bool(GlobalValue::GUID)> IsPrevailing;
979
980 /// Saves the stack ids from the STACK_IDS record to consult when adding stack
981 /// ids from the lists in the callsite and alloc entries to the index.
982 std::vector<uint64_t> StackIds;
983
984 /// Linearized radix tree of allocation contexts. See the description above
985 /// the CallStackRadixTreeBuilder class in ProfileData/MemProf.h for format.
986 std::vector<uint64_t> RadixArray;
987
988 /// Map from the module's stack id index to the index in the
989 /// ModuleSummaryIndex's StackIds vector. Populated lazily from the StackIds
990 /// list and used to avoid repeated hash lookups.
991 std::vector<unsigned> StackIdToIndex;
992
993public:
994 ModuleSummaryIndexBitcodeReader(
995 BitstreamCursor Stream, StringRef Strtab, ModuleSummaryIndex &TheIndex,
996 StringRef ModulePath,
997 std::function<bool(GlobalValue::GUID)> IsPrevailing = nullptr);
998
1000
1001private:
1002 void setValueGUID(uint64_t ValueID, StringRef ValueName,
1004 StringRef SourceFileName);
1005 Error parseValueSymbolTable(
1006 uint64_t Offset,
1007 DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap);
1008 SmallVector<ValueInfo, 0> makeRefList(ArrayRef<uint64_t> Record);
1010 makeCallList(ArrayRef<uint64_t> Record, bool IsOldProfileFormat,
1011 bool HasProfile, bool HasRelBF);
1012 Error parseEntireSummary(unsigned ID);
1013 Error parseModuleStringTable();
1014 void parseTypeIdCompatibleVtableSummaryRecord(ArrayRef<uint64_t> Record);
1015 void parseTypeIdCompatibleVtableInfo(ArrayRef<uint64_t> Record, size_t &Slot,
1017 std::vector<FunctionSummary::ParamAccess>
1018 parseParamAccesses(ArrayRef<uint64_t> Record);
1019 SmallVector<unsigned> parseAllocInfoContext(ArrayRef<uint64_t> Record,
1020 unsigned &I);
1021
1022 // Mark uninitialized stack ID mappings for lazy population.
1023 static constexpr unsigned UninitializedStackIdIndex =
1024 std::numeric_limits<unsigned>::max();
1025
1026 unsigned getStackIdIndex(unsigned LocalIndex) {
1027 unsigned &Index = StackIdToIndex[LocalIndex];
1028 // Add the stack id to the ModuleSummaryIndex map only when first requested
1029 // and cache the result in the local StackIdToIndex map.
1030 if (Index == UninitializedStackIdIndex)
1031 Index = TheIndex.addOrGetStackIdIndex(StackIds[LocalIndex]);
1032 return Index;
1033 }
1034
1035 template <bool AllowNullValueInfo = false>
1036 std::pair<ValueInfo, GlobalValue::GUID>
1037 getValueInfoFromValueId(unsigned ValueId);
1038
1039 void addThisModule();
1040 ModuleSummaryIndex::ModuleInfo *getThisModule();
1041};
1042
1043} // end anonymous namespace
1044
1046 Error Err) {
1047 if (Err) {
1048 std::error_code EC;
1049 handleAllErrors(std::move(Err), [&](ErrorInfoBase &EIB) {
1050 EC = EIB.convertToErrorCode();
1051 Ctx.emitError(EIB.message());
1052 });
1053 return EC;
1054 }
1055 return std::error_code();
1056}
1057
1058BitcodeReader::BitcodeReader(BitstreamCursor Stream, StringRef Strtab,
1059 StringRef ProducerIdentification,
1060 LLVMContext &Context)
1061 : BitcodeReaderBase(std::move(Stream), Strtab), Context(Context),
1062 ValueList(this->Stream.SizeInBytes(),
1063 [this](unsigned ValID, BasicBlock *InsertBB) {
1064 return materializeValue(ValID, InsertBB);
1065 }) {
1066 this->ProducerIdentification = std::string(ProducerIdentification);
1067}
1068
1069Error BitcodeReader::materializeForwardReferencedFunctions() {
1070 if (WillMaterializeAllForwardRefs)
1071 return Error::success();
1072
1073 // Prevent recursion.
1074 WillMaterializeAllForwardRefs = true;
1075
1076 while (!BasicBlockFwdRefQueue.empty()) {
1077 Function *F = BasicBlockFwdRefQueue.front();
1078 BasicBlockFwdRefQueue.pop_front();
1079 assert(F && "Expected valid function");
1080 if (!BasicBlockFwdRefs.count(F))
1081 // Already materialized.
1082 continue;
1083
1084 // Check for a function that isn't materializable to prevent an infinite
1085 // loop. When parsing a blockaddress stored in a global variable, there
1086 // isn't a trivial way to check if a function will have a body without a
1087 // linear search through FunctionsWithBodies, so just check it here.
1088 if (!F->isMaterializable())
1089 return error("Never resolved function from blockaddress");
1090
1091 // Try to materialize F.
1092 if (Error Err = materialize(F))
1093 return Err;
1094 }
1095 assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
1096
1097 for (Function *F : BackwardRefFunctions)
1098 if (Error Err = materialize(F))
1099 return Err;
1100 BackwardRefFunctions.clear();
1101
1102 // Reset state.
1103 WillMaterializeAllForwardRefs = false;
1104 return Error::success();
1105}
1106
1107//===----------------------------------------------------------------------===//
1108// Helper functions to implement forward reference resolution, etc.
1109//===----------------------------------------------------------------------===//
1110
1111static bool hasImplicitComdat(size_t Val) {
1112 switch (Val) {
1113 default:
1114 return false;
1115 case 1: // Old WeakAnyLinkage
1116 case 4: // Old LinkOnceAnyLinkage
1117 case 10: // Old WeakODRLinkage
1118 case 11: // Old LinkOnceODRLinkage
1119 return true;
1120 }
1121}
1122
1124 switch (Val) {
1125 default: // Map unknown/new linkages to external
1126 case 0:
1128 case 2:
1130 case 3:
1132 case 5:
1133 return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
1134 case 6:
1135 return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
1136 case 7:
1138 case 8:
1140 case 9:
1142 case 12:
1144 case 13:
1145 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
1146 case 14:
1147 return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
1148 case 15:
1149 return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
1150 case 1: // Old value with implicit comdat.
1151 case 16:
1153 case 10: // Old value with implicit comdat.
1154 case 17:
1156 case 4: // Old value with implicit comdat.
1157 case 18:
1159 case 11: // Old value with implicit comdat.
1160 case 19:
1162 }
1163}
1164
1167 Flags.ReadNone = RawFlags & 0x1;
1168 Flags.ReadOnly = (RawFlags >> 1) & 0x1;
1169 Flags.NoRecurse = (RawFlags >> 2) & 0x1;
1170 Flags.ReturnDoesNotAlias = (RawFlags >> 3) & 0x1;
1171 Flags.NoInline = (RawFlags >> 4) & 0x1;
1172 Flags.AlwaysInline = (RawFlags >> 5) & 0x1;
1173 Flags.NoUnwind = (RawFlags >> 6) & 0x1;
1174 Flags.MayThrow = (RawFlags >> 7) & 0x1;
1175 Flags.HasUnknownCall = (RawFlags >> 8) & 0x1;
1176 Flags.MustBeUnreachable = (RawFlags >> 9) & 0x1;
1177 return Flags;
1178}
1179
1180// Decode the flags for GlobalValue in the summary. The bits for each attribute:
1181//
1182// linkage: [0,4), notEligibleToImport: 4, live: 5, local: 6, canAutoHide: 7,
1183// visibility: [8, 10).
1185 uint64_t Version) {
1186 // Summary were not emitted before LLVM 3.9, we don't need to upgrade Linkage
1187 // like getDecodedLinkage() above. Any future change to the linkage enum and
1188 // to getDecodedLinkage() will need to be taken into account here as above.
1189 auto Linkage = GlobalValue::LinkageTypes(RawFlags & 0xF); // 4 bits
1190 auto Visibility = GlobalValue::VisibilityTypes((RawFlags >> 8) & 3); // 2 bits
1191 auto IK = GlobalValueSummary::ImportKind((RawFlags >> 10) & 1); // 1 bit
1192 bool NoRenameOnPromotion = ((RawFlags >> 11) & 1); // 1 bit
1193 RawFlags = RawFlags >> 4;
1194 bool NotEligibleToImport = (RawFlags & 0x1) || Version < 3;
1195 // The Live flag wasn't introduced until version 3. For dead stripping
1196 // to work correctly on earlier versions, we must conservatively treat all
1197 // values as live.
1198 bool Live = (RawFlags & 0x2) || Version < 3;
1199 bool Local = (RawFlags & 0x4);
1200 bool AutoHide = (RawFlags & 0x8);
1201
1202 return GlobalValueSummary::GVFlags(Linkage, Visibility, NotEligibleToImport,
1203 Live, Local, AutoHide, IK,
1204 NoRenameOnPromotion);
1205}
1206
1207// Decode the flags for GlobalVariable in the summary
1210 (RawFlags & 0x1) ? true : false, (RawFlags & 0x2) ? true : false,
1211 (RawFlags & 0x4) ? true : false,
1212 (GlobalObject::VCallVisibility)(RawFlags >> 3));
1213}
1214
1215static std::pair<CalleeInfo::HotnessType, bool>
1217 CalleeInfo::HotnessType Hotness =
1218 static_cast<CalleeInfo::HotnessType>(RawFlags & 0x7); // 3 bits
1219 bool HasTailCall = (RawFlags & 0x8); // 1 bit
1220 return {Hotness, HasTailCall};
1221}
1222
1223// Deprecated, but still needed to read old bitcode files.
1224static void getDecodedRelBFCallEdgeInfo(uint64_t RawFlags, uint64_t &RelBF,
1225 bool &HasTailCall) {
1226 static constexpr unsigned RelBlockFreqBits = 28;
1227 static constexpr uint64_t RelBlockFreqMask = (1 << RelBlockFreqBits) - 1;
1228 RelBF = RawFlags & RelBlockFreqMask; // RelBlockFreqBits bits
1229 HasTailCall = (RawFlags & (1 << RelBlockFreqBits)); // 1 bit
1230}
1231
1233 switch (Val) {
1234 default: // Map unknown visibilities to default.
1235 case 0: return GlobalValue::DefaultVisibility;
1236 case 1: return GlobalValue::HiddenVisibility;
1237 case 2: return GlobalValue::ProtectedVisibility;
1238 }
1239}
1240
1243 switch (Val) {
1244 default: // Map unknown values to default.
1245 case 0: return GlobalValue::DefaultStorageClass;
1248 }
1249}
1250
1251static bool getDecodedDSOLocal(unsigned Val) {
1252 switch(Val) {
1253 default: // Map unknown values to preemptable.
1254 case 0: return false;
1255 case 1: return true;
1256 }
1257}
1258
1259static std::optional<CodeModel::Model> getDecodedCodeModel(unsigned Val) {
1260 switch (Val) {
1261 case 1:
1262 return CodeModel::Tiny;
1263 case 2:
1264 return CodeModel::Small;
1265 case 3:
1266 return CodeModel::Kernel;
1267 case 4:
1268 return CodeModel::Medium;
1269 case 5:
1270 return CodeModel::Large;
1271 }
1272
1273 return {};
1274}
1275
1277 switch (Val) {
1278 case 0: return GlobalVariable::NotThreadLocal;
1279 default: // Map unknown non-zero value to general dynamic.
1283 case 4: return GlobalVariable::LocalExecTLSModel;
1284 }
1285}
1286
1288 switch (Val) {
1289 default: // Map unknown to UnnamedAddr::None.
1290 case 0: return GlobalVariable::UnnamedAddr::None;
1293 }
1294}
1295
1296static int getDecodedCastOpcode(unsigned Val) {
1297 switch (Val) {
1298 default: return -1;
1299 case bitc::CAST_TRUNC : return Instruction::Trunc;
1300 case bitc::CAST_ZEXT : return Instruction::ZExt;
1301 case bitc::CAST_SEXT : return Instruction::SExt;
1302 case bitc::CAST_FPTOUI : return Instruction::FPToUI;
1303 case bitc::CAST_FPTOSI : return Instruction::FPToSI;
1304 case bitc::CAST_UITOFP : return Instruction::UIToFP;
1305 case bitc::CAST_SITOFP : return Instruction::SIToFP;
1306 case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
1307 case bitc::CAST_FPEXT : return Instruction::FPExt;
1308 case bitc::CAST_PTRTOADDR: return Instruction::PtrToAddr;
1309 case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
1310 case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
1311 case bitc::CAST_BITCAST : return Instruction::BitCast;
1312 case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
1313 }
1314}
1315
1316static int getDecodedUnaryOpcode(unsigned Val, Type *Ty) {
1317 bool IsFP = Ty->isFPOrFPVectorTy();
1318 // UnOps are only valid for int/fp or vector of int/fp types
1319 if (!IsFP && !Ty->isIntOrIntVectorTy())
1320 return -1;
1321
1322 switch (Val) {
1323 default:
1324 return -1;
1325 case bitc::UNOP_FNEG:
1326 return IsFP ? Instruction::FNeg : -1;
1327 }
1328}
1329
1330static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {
1331 bool IsFP = Ty->isFPOrFPVectorTy();
1332 // BinOps are only valid for int/fp or vector of int/fp types
1333 if (!IsFP && !Ty->isIntOrIntVectorTy())
1334 return -1;
1335
1336 switch (Val) {
1337 default:
1338 return -1;
1339 case bitc::BINOP_ADD:
1340 return IsFP ? Instruction::FAdd : Instruction::Add;
1341 case bitc::BINOP_SUB:
1342 return IsFP ? Instruction::FSub : Instruction::Sub;
1343 case bitc::BINOP_MUL:
1344 return IsFP ? Instruction::FMul : Instruction::Mul;
1345 case bitc::BINOP_UDIV:
1346 return IsFP ? -1 : Instruction::UDiv;
1347 case bitc::BINOP_SDIV:
1348 return IsFP ? Instruction::FDiv : Instruction::SDiv;
1349 case bitc::BINOP_UREM:
1350 return IsFP ? -1 : Instruction::URem;
1351 case bitc::BINOP_SREM:
1352 return IsFP ? Instruction::FRem : Instruction::SRem;
1353 case bitc::BINOP_SHL:
1354 return IsFP ? -1 : Instruction::Shl;
1355 case bitc::BINOP_LSHR:
1356 return IsFP ? -1 : Instruction::LShr;
1357 case bitc::BINOP_ASHR:
1358 return IsFP ? -1 : Instruction::AShr;
1359 case bitc::BINOP_AND:
1360 return IsFP ? -1 : Instruction::And;
1361 case bitc::BINOP_OR:
1362 return IsFP ? -1 : Instruction::Or;
1363 case bitc::BINOP_XOR:
1364 return IsFP ? -1 : Instruction::Xor;
1365 }
1366}
1367
1369 bool &IsElementwise) {
1370 IsElementwise = Val & bitc::RMW_ELEMENTWISE_FLAG;
1371 switch (Val & ~bitc::RMW_ELEMENTWISE_FLAG) {
1372 default: return AtomicRMWInst::BAD_BINOP;
1374 case bitc::RMW_ADD: return AtomicRMWInst::Add;
1375 case bitc::RMW_SUB: return AtomicRMWInst::Sub;
1376 case bitc::RMW_AND: return AtomicRMWInst::And;
1378 case bitc::RMW_OR: return AtomicRMWInst::Or;
1379 case bitc::RMW_XOR: return AtomicRMWInst::Xor;
1380 case bitc::RMW_MAX: return AtomicRMWInst::Max;
1381 case bitc::RMW_MIN: return AtomicRMWInst::Min;
1388 case bitc::RMW_FMAXIMUM:
1390 case bitc::RMW_FMINIMUM:
1402 case bitc::RMW_USUB_SAT:
1404 }
1405}
1406
1408 switch (Val) {
1415 default: // Map unknown orderings to sequentially-consistent.
1417 }
1418}
1419
1421 switch (Val) {
1422 default: // Map unknown selection kinds to any.
1424 return Comdat::Any;
1426 return Comdat::ExactMatch;
1428 return Comdat::Largest;
1430 return Comdat::NoDeduplicate;
1432 return Comdat::SameSize;
1433 }
1434}
1435
1437 FastMathFlags FMF;
1438 if (0 != (Val & bitc::UnsafeAlgebra))
1439 FMF.setFast();
1440 if (0 != (Val & bitc::AllowReassoc))
1441 FMF.setAllowReassoc();
1442 if (0 != (Val & bitc::NoNaNs))
1443 FMF.setNoNaNs();
1444 if (0 != (Val & bitc::NoInfs))
1445 FMF.setNoInfs();
1446 if (0 != (Val & bitc::NoSignedZeros))
1447 FMF.setNoSignedZeros();
1448 if (0 != (Val & bitc::AllowReciprocal))
1449 FMF.setAllowReciprocal();
1450 if (0 != (Val & bitc::AllowContract))
1451 FMF.setAllowContract(true);
1452 if (0 != (Val & bitc::ApproxFunc))
1453 FMF.setApproxFunc();
1454 return FMF;
1455}
1456
1457static void upgradeDLLImportExportLinkage(GlobalValue *GV, unsigned Val) {
1458 // A GlobalValue with local linkage cannot have a DLL storage class.
1459 if (GV->hasLocalLinkage())
1460 return;
1461 switch (Val) {
1464 }
1465}
1466
1467Type *BitcodeReader::getTypeByID(unsigned ID) {
1468 // The type table size is always specified correctly.
1469 if (ID >= TypeList.size())
1470 return nullptr;
1471
1472 if (Type *Ty = TypeList[ID])
1473 return Ty;
1474
1475 // If we have a forward reference, the only possible case is when it is to a
1476 // named struct. Just create a placeholder for now.
1477 return TypeList[ID] = createIdentifiedStructType(Context);
1478}
1479
1480unsigned BitcodeReader::getContainedTypeID(unsigned ID, unsigned Idx) {
1481 auto It = ContainedTypeIDs.find(ID);
1482 if (It == ContainedTypeIDs.end())
1483 return InvalidTypeID;
1484
1485 if (Idx >= It->second.size())
1486 return InvalidTypeID;
1487
1488 return It->second[Idx];
1489}
1490
1491Type *BitcodeReader::getPtrElementTypeByID(unsigned ID) {
1492 if (ID >= TypeList.size())
1493 return nullptr;
1494
1495 Type *Ty = TypeList[ID];
1496 if (!Ty->isPointerTy())
1497 return nullptr;
1498
1499 return getTypeByID(getContainedTypeID(ID, 0));
1500}
1501
1502unsigned BitcodeReader::getVirtualTypeID(Type *Ty,
1503 ArrayRef<unsigned> ChildTypeIDs) {
1504 unsigned ChildTypeID = ChildTypeIDs.empty() ? InvalidTypeID : ChildTypeIDs[0];
1505 auto CacheKey = std::make_pair(Ty, ChildTypeID);
1506 auto It = VirtualTypeIDs.find(CacheKey);
1507 if (It != VirtualTypeIDs.end()) {
1508 // The cmpxchg return value is the only place we need more than one
1509 // contained type ID, however the second one will always be the same (i1),
1510 // so we don't need to include it in the cache key. This asserts that the
1511 // contained types are indeed as expected and there are no collisions.
1512 assert((ChildTypeIDs.empty() ||
1513 ContainedTypeIDs[It->second] == ChildTypeIDs) &&
1514 "Incorrect cached contained type IDs");
1515 return It->second;
1516 }
1517
1518 unsigned TypeID = TypeList.size();
1519 TypeList.push_back(Ty);
1520 if (!ChildTypeIDs.empty())
1521 append_range(ContainedTypeIDs[TypeID], ChildTypeIDs);
1522 VirtualTypeIDs.insert({CacheKey, TypeID});
1523 return TypeID;
1524}
1525
1527 GEPNoWrapFlags NW;
1528 if (Flags & (1 << bitc::GEP_INBOUNDS))
1530 if (Flags & (1 << bitc::GEP_NUSW))
1532 if (Flags & (1 << bitc::GEP_NUW))
1534 return NW;
1535}
1536
1537static bool isConstExprSupported(const BitcodeConstant *BC) {
1538 uint8_t Opcode = BC->Opcode;
1539
1540 // These are not real constant expressions, always consider them supported.
1541 if (Opcode >= BitcodeConstant::FirstSpecialOpcode)
1542 return true;
1543
1544 // If -expand-constant-exprs is set, we want to consider all expressions
1545 // as unsupported.
1547 return false;
1548
1549 if (Instruction::isBinaryOp(Opcode))
1550 return ConstantExpr::isSupportedBinOp(Opcode);
1551
1552 if (Instruction::isCast(Opcode))
1553 return ConstantExpr::isSupportedCastOp(Opcode);
1554
1555 if (Opcode == Instruction::GetElementPtr)
1556 return ConstantExpr::isSupportedGetElementPtr(BC->SrcElemTy);
1557
1558 switch (Opcode) {
1559 case Instruction::FNeg:
1560 case Instruction::Select:
1561 case Instruction::ICmp:
1562 case Instruction::FCmp:
1563 return false;
1564 default:
1565 return true;
1566 }
1567}
1568
1569Expected<Value *> BitcodeReader::materializeValue(unsigned StartValID,
1570 BasicBlock *InsertBB) {
1571 // Quickly handle the case where there is no BitcodeConstant to resolve.
1572 if (StartValID < ValueList.size() && ValueList[StartValID] &&
1573 !isa<BitcodeConstant>(ValueList[StartValID]))
1574 return ValueList[StartValID];
1575
1576 SmallDenseMap<unsigned, Value *> MaterializedValues;
1577 SmallVector<unsigned> Worklist;
1578 Worklist.push_back(StartValID);
1579 while (!Worklist.empty()) {
1580 unsigned ValID = Worklist.back();
1581 if (MaterializedValues.count(ValID)) {
1582 // Duplicate expression that was already handled.
1583 Worklist.pop_back();
1584 continue;
1585 }
1586
1587 if (ValID >= ValueList.size() || !ValueList[ValID])
1588 return error("Invalid value ID");
1589
1590 Value *V = ValueList[ValID];
1591 auto *BC = dyn_cast<BitcodeConstant>(V);
1592 if (!BC) {
1593 MaterializedValues.insert({ValID, V});
1594 Worklist.pop_back();
1595 continue;
1596 }
1597
1598 // Iterate in reverse, so values will get popped from the worklist in
1599 // expected order.
1601 for (unsigned OpID : reverse(BC->getOperandIDs())) {
1602 auto It = MaterializedValues.find(OpID);
1603 if (It != MaterializedValues.end())
1604 Ops.push_back(It->second);
1605 else
1606 Worklist.push_back(OpID);
1607 }
1608
1609 // Some expressions have not been resolved yet, handle them first and then
1610 // revisit this one.
1611 if (Ops.size() != BC->getOperandIDs().size())
1612 continue;
1613 std::reverse(Ops.begin(), Ops.end());
1614
1615 SmallVector<Constant *> ConstOps;
1616 for (Value *Op : Ops)
1617 if (auto *C = dyn_cast<Constant>(Op))
1618 ConstOps.push_back(C);
1619
1620 // Materialize as constant expression if possible.
1621 if (isConstExprSupported(BC) && ConstOps.size() == Ops.size()) {
1622 Constant *C;
1623 if (Instruction::isCast(BC->Opcode)) {
1624 C = UpgradeBitCastExpr(BC->Opcode, ConstOps[0], BC->getType());
1625 if (!C)
1626 C = ConstantExpr::getCast(BC->Opcode, ConstOps[0], BC->getType());
1627 } else if (Instruction::isBinaryOp(BC->Opcode)) {
1628 C = ConstantExpr::get(BC->Opcode, ConstOps[0], ConstOps[1], BC->Flags);
1629 } else {
1630 switch (BC->Opcode) {
1631 case BitcodeConstant::ConstantPtrAuthOpcode: {
1632 auto *Key = dyn_cast<ConstantInt>(ConstOps[1]);
1633 if (!Key)
1634 return error("ptrauth key operand must be ConstantInt");
1635
1636 auto *Disc = dyn_cast<ConstantInt>(ConstOps[2]);
1637 if (!Disc)
1638 return error("ptrauth disc operand must be ConstantInt");
1639
1640 Constant *DeactivationSymbol =
1641 ConstOps.size() > 4 ? ConstOps[4]
1643 ConstOps[3]->getType()));
1644 if (!DeactivationSymbol->getType()->isPointerTy())
1645 return error(
1646 "ptrauth deactivation symbol operand must be a pointer");
1647
1648 C = ConstantPtrAuth::get(ConstOps[0], Key, Disc, ConstOps[3],
1649 DeactivationSymbol);
1650 break;
1651 }
1652 case BitcodeConstant::NoCFIOpcode: {
1653 auto *GV = dyn_cast<GlobalValue>(ConstOps[0]);
1654 if (!GV)
1655 return error("no_cfi operand must be GlobalValue");
1656 C = NoCFIValue::get(GV);
1657 break;
1658 }
1659 case BitcodeConstant::DSOLocalEquivalentOpcode: {
1660 auto *GV = dyn_cast<GlobalValue>(ConstOps[0]);
1661 if (!GV)
1662 return error("dso_local operand must be GlobalValue");
1664 break;
1665 }
1666 case BitcodeConstant::BlockAddressOpcode: {
1667 Function *Fn = dyn_cast<Function>(ConstOps[0]);
1668 if (!Fn)
1669 return error("blockaddress operand must be a function");
1670
1671 // If the function is already parsed we can insert the block address
1672 // right away.
1673 BasicBlock *BB;
1674 unsigned BBID = BC->BlockAddressBB;
1675 if (!BBID)
1676 // Invalid reference to entry block.
1677 return error("Invalid ID");
1678 if (!Fn->empty()) {
1679 Function::iterator BBI = Fn->begin(), BBE = Fn->end();
1680 for (size_t I = 0, E = BBID; I != E; ++I) {
1681 if (BBI == BBE)
1682 return error("Invalid ID");
1683 ++BBI;
1684 }
1685 BB = &*BBI;
1686 } else {
1687 // Otherwise insert a placeholder and remember it so it can be
1688 // inserted when the function is parsed.
1689 auto &FwdBBs = BasicBlockFwdRefs[Fn];
1690 if (FwdBBs.empty())
1691 BasicBlockFwdRefQueue.push_back(Fn);
1692 if (FwdBBs.size() < BBID + 1)
1693 FwdBBs.resize(BBID + 1);
1694 if (!FwdBBs[BBID])
1695 FwdBBs[BBID] = BasicBlock::Create(Context);
1696 BB = FwdBBs[BBID];
1697 }
1698 C = BlockAddress::get(Fn->getType(), BB);
1699 break;
1700 }
1701 case BitcodeConstant::ConstantStructOpcode: {
1702 auto *ST = cast<StructType>(BC->getType());
1703 if (ST->getNumElements() != ConstOps.size())
1704 return error("Invalid number of elements in struct initializer");
1705
1706 for (const auto [Ty, Op] : zip(ST->elements(), ConstOps))
1707 if (Op->getType() != Ty)
1708 return error("Incorrect type in struct initializer");
1709
1710 C = ConstantStruct::get(ST, ConstOps);
1711 break;
1712 }
1713 case BitcodeConstant::ConstantArrayOpcode: {
1714 auto *AT = cast<ArrayType>(BC->getType());
1715 if (AT->getNumElements() != ConstOps.size())
1716 return error("Invalid number of elements in array initializer");
1717
1718 for (Constant *Op : ConstOps)
1719 if (Op->getType() != AT->getElementType())
1720 return error("Incorrect type in array initializer");
1721
1722 C = ConstantArray::get(AT, ConstOps);
1723 break;
1724 }
1725 case BitcodeConstant::ConstantVectorOpcode: {
1726 auto *VT = cast<FixedVectorType>(BC->getType());
1727 if (VT->getNumElements() != ConstOps.size())
1728 return error("Invalid number of elements in vector initializer");
1729
1730 for (Constant *Op : ConstOps)
1731 if (Op->getType() != VT->getElementType())
1732 return error("Incorrect type in vector initializer");
1733
1734 C = ConstantVector::get(ConstOps);
1735 break;
1736 }
1737 case Instruction::GetElementPtr:
1739 BC->SrcElemTy, ConstOps[0], ArrayRef(ConstOps).drop_front(),
1740 toGEPNoWrapFlags(BC->Flags), BC->getInRange());
1741 break;
1742 case Instruction::ExtractElement:
1743 C = ConstantExpr::getExtractElement(ConstOps[0], ConstOps[1]);
1744 break;
1745 case Instruction::InsertElement:
1746 C = ConstantExpr::getInsertElement(ConstOps[0], ConstOps[1],
1747 ConstOps[2]);
1748 break;
1749 case Instruction::ShuffleVector: {
1750 SmallVector<int, 16> Mask;
1751 ShuffleVectorInst::getShuffleMask(ConstOps[2], Mask);
1752 C = ConstantExpr::getShuffleVector(ConstOps[0], ConstOps[1], Mask);
1753 break;
1754 }
1755 default:
1756 llvm_unreachable("Unhandled bitcode constant");
1757 }
1758 }
1759
1760 // Cache resolved constant.
1761 ValueList.replaceValueWithoutRAUW(ValID, C);
1762 MaterializedValues.insert({ValID, C});
1763 Worklist.pop_back();
1764 continue;
1765 }
1766
1767 if (!InsertBB)
1768 return error(Twine("Value referenced by initializer is an unsupported "
1769 "constant expression of type ") +
1770 BC->getOpcodeName());
1771
1772 // Materialize as instructions if necessary.
1773 Instruction *I;
1774 if (Instruction::isCast(BC->Opcode)) {
1775 I = CastInst::Create((Instruction::CastOps)BC->Opcode, Ops[0],
1776 BC->getType(), "constexpr", InsertBB);
1777 } else if (Instruction::isUnaryOp(BC->Opcode)) {
1779 "constexpr", InsertBB);
1780 } else if (Instruction::isBinaryOp(BC->Opcode)) {
1782 Ops[1], "constexpr", InsertBB);
1785 I->setHasNoSignedWrap();
1787 I->setHasNoUnsignedWrap();
1788 }
1790 (BC->Flags & PossiblyExactOperator::IsExact))
1791 I->setIsExact();
1792 } else {
1793 switch (BC->Opcode) {
1794 case BitcodeConstant::ConstantVectorOpcode: {
1795 Type *IdxTy = Type::getInt32Ty(BC->getContext());
1796 Value *V = PoisonValue::get(BC->getType());
1797 for (auto Pair : enumerate(Ops)) {
1798 Value *Idx = ConstantInt::get(IdxTy, Pair.index());
1799 V = InsertElementInst::Create(V, Pair.value(), Idx, "constexpr.ins",
1800 InsertBB);
1801 }
1802 I = cast<Instruction>(V);
1803 break;
1804 }
1805 case BitcodeConstant::ConstantStructOpcode:
1806 case BitcodeConstant::ConstantArrayOpcode: {
1807 Value *V = PoisonValue::get(BC->getType());
1808 for (auto Pair : enumerate(Ops))
1809 V = InsertValueInst::Create(V, Pair.value(), Pair.index(),
1810 "constexpr.ins", InsertBB);
1811 I = cast<Instruction>(V);
1812 break;
1813 }
1814 case Instruction::ICmp:
1815 case Instruction::FCmp:
1817 (CmpInst::Predicate)BC->Flags, Ops[0], Ops[1],
1818 "constexpr", InsertBB);
1819 break;
1820 case Instruction::GetElementPtr:
1821 I = GetElementPtrInst::Create(BC->SrcElemTy, Ops[0],
1822 ArrayRef(Ops).drop_front(), "constexpr",
1823 InsertBB);
1824 cast<GetElementPtrInst>(I)->setNoWrapFlags(toGEPNoWrapFlags(BC->Flags));
1825 break;
1826 case Instruction::Select:
1827 I = SelectInst::Create(Ops[0], Ops[1], Ops[2], "constexpr", InsertBB);
1828 break;
1829 case Instruction::ExtractElement:
1830 I = ExtractElementInst::Create(Ops[0], Ops[1], "constexpr", InsertBB);
1831 break;
1832 case Instruction::InsertElement:
1833 I = InsertElementInst::Create(Ops[0], Ops[1], Ops[2], "constexpr",
1834 InsertBB);
1835 break;
1836 case Instruction::ShuffleVector:
1837 I = new ShuffleVectorInst(Ops[0], Ops[1], Ops[2], "constexpr",
1838 InsertBB);
1839 break;
1840 default:
1841 llvm_unreachable("Unhandled bitcode constant");
1842 }
1843 }
1844
1845 MaterializedValues.insert({ValID, I});
1846 Worklist.pop_back();
1847 }
1848
1849 return MaterializedValues[StartValID];
1850}
1851
1852Expected<Constant *> BitcodeReader::getValueForInitializer(unsigned ID) {
1853 Expected<Value *> MaybeV = materializeValue(ID, /* InsertBB */ nullptr);
1854 if (!MaybeV)
1855 return MaybeV.takeError();
1856
1857 // Result must be Constant if InsertBB is nullptr.
1858 return cast<Constant>(MaybeV.get());
1859}
1860
1861StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
1862 StringRef Name) {
1863 auto *Ret = StructType::create(Context, Name);
1864 IdentifiedStructTypes.push_back(Ret);
1865 return Ret;
1866}
1867
1868StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
1869 auto *Ret = StructType::create(Context);
1870 IdentifiedStructTypes.push_back(Ret);
1871 return Ret;
1872}
1873
1874//===----------------------------------------------------------------------===//
1875// Functions for parsing blocks from the bitcode file
1876//===----------------------------------------------------------------------===//
1877
1879 switch (Val) {
1883 llvm_unreachable("Synthetic enumerators which should never get here");
1884
1885 case Attribute::None: return 0;
1886 case Attribute::ZExt: return 1 << 0;
1887 case Attribute::SExt: return 1 << 1;
1888 case Attribute::NoReturn: return 1 << 2;
1889 case Attribute::InReg: return 1 << 3;
1890 case Attribute::StructRet: return 1 << 4;
1891 case Attribute::NoUnwind: return 1 << 5;
1892 case Attribute::NoAlias: return 1 << 6;
1893 case Attribute::ByVal: return 1 << 7;
1894 case Attribute::Nest: return 1 << 8;
1895 case Attribute::ReadNone: return 1 << 9;
1896 case Attribute::ReadOnly: return 1 << 10;
1897 case Attribute::NoInline: return 1 << 11;
1898 case Attribute::AlwaysInline: return 1 << 12;
1899 case Attribute::OptimizeForSize: return 1 << 13;
1900 case Attribute::StackProtect: return 1 << 14;
1901 case Attribute::StackProtectReq: return 1 << 15;
1902 case Attribute::Alignment: return 31 << 16;
1903 // 1ULL << 21 is NoCapture, which is upgraded separately.
1904 case Attribute::NoRedZone: return 1 << 22;
1905 case Attribute::NoImplicitFloat: return 1 << 23;
1906 case Attribute::Naked: return 1 << 24;
1907 case Attribute::InlineHint: return 1 << 25;
1908 case Attribute::StackAlignment: return 7 << 26;
1909 case Attribute::ReturnsTwice: return 1 << 29;
1910 case Attribute::UWTable: return 1 << 30;
1911 case Attribute::NonLazyBind: return 1U << 31;
1912 case Attribute::SanitizeAddress: return 1ULL << 32;
1913 case Attribute::MinSize: return 1ULL << 33;
1914 case Attribute::NoDuplicate: return 1ULL << 34;
1915 case Attribute::StackProtectStrong: return 1ULL << 35;
1916 case Attribute::SanitizeThread: return 1ULL << 36;
1917 case Attribute::SanitizeMemory: return 1ULL << 37;
1918 case Attribute::NoBuiltin: return 1ULL << 38;
1919 case Attribute::Returned: return 1ULL << 39;
1920 case Attribute::Cold: return 1ULL << 40;
1921 case Attribute::Builtin: return 1ULL << 41;
1922 case Attribute::OptimizeNone: return 1ULL << 42;
1923 case Attribute::InAlloca: return 1ULL << 43;
1924 case Attribute::NonNull: return 1ULL << 44;
1925 case Attribute::JumpTable: return 1ULL << 45;
1926 case Attribute::Convergent: return 1ULL << 46;
1927 case Attribute::SafeStack: return 1ULL << 47;
1928 case Attribute::NoRecurse: return 1ULL << 48;
1929 // 1ULL << 49 is InaccessibleMemOnly, which is upgraded separately.
1930 // 1ULL << 50 is InaccessibleMemOrArgMemOnly, which is upgraded separately.
1931 case Attribute::SwiftSelf: return 1ULL << 51;
1932 case Attribute::SwiftError: return 1ULL << 52;
1933 case Attribute::WriteOnly: return 1ULL << 53;
1934 case Attribute::Speculatable: return 1ULL << 54;
1935 case Attribute::StrictFP: return 1ULL << 55;
1936 case Attribute::SanitizeHWAddress: return 1ULL << 56;
1937 case Attribute::NoCfCheck: return 1ULL << 57;
1938 case Attribute::OptForFuzzing: return 1ULL << 58;
1939 case Attribute::ShadowCallStack: return 1ULL << 59;
1940 case Attribute::SpeculativeLoadHardening:
1941 return 1ULL << 60;
1942 case Attribute::ImmArg:
1943 return 1ULL << 61;
1944 case Attribute::WillReturn:
1945 return 1ULL << 62;
1946 case Attribute::NoFree:
1947 return 1ULL << 63;
1948 default:
1949 // Other attributes are not supported in the raw format,
1950 // as we ran out of space.
1951 return 0;
1952 }
1953 llvm_unreachable("Unsupported attribute type");
1954}
1955
1956static void addRawAttributeValue(AttrBuilder &B, uint64_t Val) {
1957 if (!Val) return;
1958
1960 I = Attribute::AttrKind(I + 1)) {
1961 if (uint64_t A = (Val & getRawAttributeMask(I))) {
1962 if (I == Attribute::Alignment)
1963 B.addAlignmentAttr(1ULL << ((A >> 16) - 1));
1964 else if (I == Attribute::StackAlignment)
1965 B.addStackAlignmentAttr(1ULL << ((A >> 26)-1));
1966 else if (Attribute::isTypeAttrKind(I))
1967 B.addTypeAttr(I, nullptr); // Type will be auto-upgraded.
1968 else
1969 B.addAttribute(I);
1970 }
1971 }
1972}
1973
1974/// This fills an AttrBuilder object with the LLVM attributes that have
1975/// been decoded from the given integer.
1976static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
1977 uint64_t EncodedAttrs,
1978 uint64_t AttrIdx) {
1979 // The alignment is stored as a 16-bit raw value from bits 31--16. We shift
1980 // the bits above 31 down by 11 bits.
1981 unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
1982 assert((!Alignment || isPowerOf2_32(Alignment)) &&
1983 "Alignment must be a power of two.");
1984
1985 if (Alignment)
1986 B.addAlignmentAttr(Alignment);
1987
1988 uint64_t Attrs = ((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
1989 (EncodedAttrs & 0xffff);
1990
1991 if (AttrIdx == AttributeList::FunctionIndex) {
1992 // Upgrade old memory attributes.
1994 if (Attrs & (1ULL << 9)) {
1995 // ReadNone
1996 Attrs &= ~(1ULL << 9);
1997 ME &= MemoryEffects::none();
1998 }
1999 if (Attrs & (1ULL << 10)) {
2000 // ReadOnly
2001 Attrs &= ~(1ULL << 10);
2003 }
2004 if (Attrs & (1ULL << 49)) {
2005 // InaccessibleMemOnly
2006 Attrs &= ~(1ULL << 49);
2008 }
2009 if (Attrs & (1ULL << 50)) {
2010 // InaccessibleMemOrArgMemOnly
2011 Attrs &= ~(1ULL << 50);
2013 }
2014 if (Attrs & (1ULL << 53)) {
2015 // WriteOnly
2016 Attrs &= ~(1ULL << 53);
2018 }
2019 if (ME != MemoryEffects::unknown())
2020 B.addMemoryAttr(ME);
2021 }
2022
2023 // Upgrade nocapture to captures(none).
2024 if (Attrs & (1ULL << 21)) {
2025 Attrs &= ~(1ULL << 21);
2026 B.addCapturesAttr(CaptureInfo::none());
2027 }
2028
2029 addRawAttributeValue(B, Attrs);
2030}
2031
2032Error BitcodeReader::parseAttributeBlock() {
2034 return Err;
2035
2036 if (!MAttributes.empty())
2037 return error("Invalid multiple blocks");
2038
2039 SmallVector<uint64_t, 64> Record;
2040
2042
2043 // Read all the records.
2044 while (true) {
2045 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2046 if (!MaybeEntry)
2047 return MaybeEntry.takeError();
2048 BitstreamEntry Entry = MaybeEntry.get();
2049
2050 switch (Entry.Kind) {
2051 case BitstreamEntry::SubBlock: // Handled for us already.
2053 return error("Malformed block");
2055 return Error::success();
2057 // The interesting case.
2058 break;
2059 }
2060
2061 // Read a record.
2062 Record.clear();
2063 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2064 if (!MaybeRecord)
2065 return MaybeRecord.takeError();
2066 switch (MaybeRecord.get()) {
2067 default: // Default behavior: ignore.
2068 break;
2069 case bitc::PARAMATTR_CODE_ENTRY_OLD: // ENTRY: [paramidx0, attr0, ...]
2070 // Deprecated, but still needed to read old bitcode files.
2071 if (Record.size() & 1)
2072 return error("Invalid parameter attribute record");
2073
2074 for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
2075 AttrBuilder B(Context);
2076 decodeLLVMAttributesForBitcode(B, Record[i+1], Record[i]);
2077 Attrs.push_back(AttributeList::get(Context, Record[i], B));
2078 }
2079
2080 MAttributes.push_back(AttributeList::get(Context, Attrs));
2081 Attrs.clear();
2082 break;
2083 case bitc::PARAMATTR_CODE_ENTRY: // ENTRY: [attrgrp0, attrgrp1, ...]
2084 for (uint64_t Val : Record)
2085 Attrs.push_back(MAttributeGroups[Val]);
2086
2087 MAttributes.push_back(AttributeList::get(Context, Attrs));
2088 Attrs.clear();
2089 break;
2090 }
2091 }
2092}
2093
2094// Returns Attribute::None on unrecognized codes.
2096 switch (Code) {
2097 default:
2098 return Attribute::None;
2100 return Attribute::Alignment;
2102 return Attribute::AlwaysInline;
2104 return Attribute::Builtin;
2106 return Attribute::ByVal;
2108 return Attribute::InAlloca;
2110 return Attribute::Cold;
2112 return Attribute::Convergent;
2114 return Attribute::DisableSanitizerInstrumentation;
2116 return Attribute::ElementType;
2118 return Attribute::FnRetThunkExtern;
2120 return Attribute::Flatten;
2122 return Attribute::InlineHint;
2124 return Attribute::InReg;
2126 return Attribute::JumpTable;
2128 return Attribute::Memory;
2130 return Attribute::NoFPClass;
2132 return Attribute::MinSize;
2134 return Attribute::Naked;
2136 return Attribute::Nest;
2138 return Attribute::NoAlias;
2140 return Attribute::NoBuiltin;
2142 return Attribute::NoCallback;
2144 return Attribute::NoDivergenceSource;
2146 return Attribute::NoDuplicate;
2148 return Attribute::NoFree;
2150 return Attribute::NoImplicitFloat;
2152 return Attribute::NoInline;
2154 return Attribute::NoRecurse;
2156 return Attribute::NoMerge;
2158 return Attribute::NonLazyBind;
2160 return Attribute::NonNull;
2162 return Attribute::Dereferenceable;
2164 return Attribute::DereferenceableOrNull;
2166 return Attribute::AllocAlign;
2168 return Attribute::AllocKind;
2170 return Attribute::AllocSize;
2172 return Attribute::AllocatedPointer;
2174 return Attribute::NoRedZone;
2176 return Attribute::NoReturn;
2178 return Attribute::NoSync;
2180 return Attribute::NoCfCheck;
2182 return Attribute::NoProfile;
2184 return Attribute::SkipProfile;
2186 return Attribute::NoUnwind;
2188 return Attribute::NoSanitizeBounds;
2190 return Attribute::NoSanitizeCoverage;
2192 return Attribute::NullPointerIsValid;
2194 return Attribute::OptimizeForDebugging;
2196 return Attribute::OptForFuzzing;
2198 return Attribute::OptimizeForSize;
2200 return Attribute::OptimizeNone;
2202 return Attribute::ReadNone;
2204 return Attribute::ReadOnly;
2206 return Attribute::Returned;
2208 return Attribute::ReturnsTwice;
2210 return Attribute::SExt;
2212 return Attribute::Speculatable;
2214 return Attribute::StackAlignment;
2216 return Attribute::StackProtect;
2218 return Attribute::StackProtectReq;
2220 return Attribute::StackProtectStrong;
2222 return Attribute::SafeStack;
2224 return Attribute::ShadowCallStack;
2226 return Attribute::StrictFP;
2228 return Attribute::StructRet;
2230 return Attribute::SanitizeAddress;
2232 return Attribute::SanitizeHWAddress;
2234 return Attribute::SanitizeThread;
2236 return Attribute::SanitizeType;
2238 return Attribute::SanitizeMemory;
2240 return Attribute::SanitizeNumericalStability;
2242 return Attribute::SanitizeRealtime;
2244 return Attribute::SanitizeRealtimeBlocking;
2246 return Attribute::SanitizeAllocToken;
2248 return Attribute::SpeculativeLoadHardening;
2250 return Attribute::SwiftError;
2252 return Attribute::SwiftSelf;
2254 return Attribute::SwiftAsync;
2256 return Attribute::UWTable;
2258 return Attribute::VScaleRange;
2260 return Attribute::WillReturn;
2262 return Attribute::WriteOnly;
2264 return Attribute::ZExt;
2266 return Attribute::ImmArg;
2268 return Attribute::SanitizeMemTag;
2270 return Attribute::Preallocated;
2272 return Attribute::NoUndef;
2274 return Attribute::ByRef;
2276 return Attribute::MustProgress;
2278 return Attribute::Hot;
2280 return Attribute::PresplitCoroutine;
2282 return Attribute::Writable;
2284 return Attribute::CoroDestroyOnlyWhenComplete;
2286 return Attribute::DeadOnUnwind;
2288 return Attribute::Range;
2290 return Attribute::Initializes;
2292 return Attribute::CoroElideSafe;
2294 return Attribute::NoExt;
2296 return Attribute::Captures;
2298 return Attribute::DeadOnReturn;
2300 return Attribute::NoCreateUndefOrPoison;
2302 return Attribute::DenormalFPEnv;
2304 return Attribute::NoOutline;
2305 }
2306}
2307
2308Error BitcodeReader::parseAlignmentValue(uint64_t Exponent,
2309 MaybeAlign &Alignment) {
2310 // Note: Alignment in bitcode files is incremented by 1, so that zero
2311 // can be used for default alignment.
2312 if (Exponent > Value::MaxAlignmentExponent + 1)
2313 return error("Invalid alignment value");
2314 Alignment = decodeMaybeAlign(Exponent);
2315 return Error::success();
2316}
2317
2318Error BitcodeReader::parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind) {
2319 *Kind = getAttrFromCode(Code);
2320 if (*Kind == Attribute::None)
2321 return error("Unknown attribute kind (" + Twine(Code) + ")");
2322 return Error::success();
2323}
2324
2325static bool upgradeOldMemoryAttribute(MemoryEffects &ME, uint64_t EncodedKind) {
2326 switch (EncodedKind) {
2328 ME &= MemoryEffects::none();
2329 return true;
2332 return true;
2335 return true;
2338 return true;
2341 return true;
2344 return true;
2345 default:
2346 return false;
2347 }
2348}
2349
2350Error BitcodeReader::parseAttributeGroupBlock() {
2352 return Err;
2353
2354 if (!MAttributeGroups.empty())
2355 return error("Invalid multiple blocks");
2356
2357 SmallVector<uint64_t, 64> Record;
2358
2359 // Read all the records.
2360 while (true) {
2361 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2362 if (!MaybeEntry)
2363 return MaybeEntry.takeError();
2364 BitstreamEntry Entry = MaybeEntry.get();
2365
2366 switch (Entry.Kind) {
2367 case BitstreamEntry::SubBlock: // Handled for us already.
2369 return error("Malformed block");
2371 return Error::success();
2373 // The interesting case.
2374 break;
2375 }
2376
2377 // Read a record.
2378 Record.clear();
2379 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2380 if (!MaybeRecord)
2381 return MaybeRecord.takeError();
2382 switch (MaybeRecord.get()) {
2383 default: // Default behavior: ignore.
2384 break;
2385 case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
2386 if (Record.size() < 3)
2387 return error("Invalid grp record");
2388
2389 uint64_t GrpID = Record[0];
2390 uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
2391
2392 AttrBuilder B(Context);
2394 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
2395 if (Record[i] == 0) { // Enum attribute
2396 Attribute::AttrKind Kind;
2397 uint64_t EncodedKind = Record[++i];
2398 if (Idx == AttributeList::FunctionIndex &&
2399 upgradeOldMemoryAttribute(ME, EncodedKind))
2400 continue;
2401
2402 if (EncodedKind == bitc::ATTR_KIND_NO_CAPTURE) {
2403 B.addCapturesAttr(CaptureInfo::none());
2404 continue;
2405 }
2406
2407 if (Error Err = parseAttrKind(EncodedKind, &Kind))
2408 return Err;
2409
2410 // Upgrade old-style byval attribute to one with a type, even if it's
2411 // nullptr. We will have to insert the real type when we associate
2412 // this AttributeList with a function.
2413 if (Kind == Attribute::ByVal)
2414 B.addByValAttr(nullptr);
2415 else if (Kind == Attribute::StructRet)
2416 B.addStructRetAttr(nullptr);
2417 else if (Kind == Attribute::InAlloca)
2418 B.addInAllocaAttr(nullptr);
2419 else if (Kind == Attribute::UWTable)
2420 B.addUWTableAttr(UWTableKind::Default);
2421 else if (Kind == Attribute::DeadOnReturn)
2422 B.addDeadOnReturnAttr(DeadOnReturnInfo());
2423 else if (Attribute::isEnumAttrKind(Kind))
2424 B.addAttribute(Kind);
2425 else
2426 return error("Not an enum attribute");
2427 } else if (Record[i] == 1) { // Integer attribute
2428 Attribute::AttrKind Kind;
2429 if (Error Err = parseAttrKind(Record[++i], &Kind))
2430 return Err;
2431 if (!Attribute::isIntAttrKind(Kind))
2432 return error("Not an int attribute");
2433 if (Kind == Attribute::Alignment)
2434 B.addAlignmentAttr(Record[++i]);
2435 else if (Kind == Attribute::StackAlignment)
2436 B.addStackAlignmentAttr(Record[++i]);
2437 else if (Kind == Attribute::Dereferenceable)
2438 B.addDereferenceableAttr(Record[++i]);
2439 else if (Kind == Attribute::DereferenceableOrNull)
2440 B.addDereferenceableOrNullAttr(Record[++i]);
2441 else if (Kind == Attribute::DeadOnReturn)
2442 B.addDeadOnReturnAttr(
2444 else if (Kind == Attribute::AllocSize)
2445 B.addAllocSizeAttrFromRawRepr(Record[++i]);
2446 else if (Kind == Attribute::VScaleRange)
2447 B.addVScaleRangeAttrFromRawRepr(Record[++i]);
2448 else if (Kind == Attribute::UWTable)
2449 B.addUWTableAttr(UWTableKind(Record[++i]));
2450 else if (Kind == Attribute::AllocKind)
2451 B.addAllocKindAttr(static_cast<AllocFnKind>(Record[++i]));
2452 else if (Kind == Attribute::Memory) {
2453 uint64_t EncodedME = Record[++i];
2454 const uint8_t Version = (EncodedME >> 56);
2455 if (Version == 0) {
2456 // Errno memory location was previously encompassed into default
2457 // memory. Ensure this is taken into account while reconstructing
2458 // the memory attribute prior to its introduction.
2459 ModRefInfo ArgMem = ModRefInfo((EncodedME >> 0) & 3);
2460 ModRefInfo InaccessibleMem = ModRefInfo((EncodedME >> 2) & 3);
2461 ModRefInfo OtherMem = ModRefInfo((EncodedME >> 4) & 3);
2464 MemoryEffects::errnoMemOnly(OtherMem) |
2466 B.addMemoryAttr(ME);
2467 } else {
2468 // Construct the memory attribute directly from the encoded base
2469 // on newer versions.
2471 EncodedME & 0x00FFFFFFFFFFFFFFULL));
2472 }
2473 } else if (Kind == Attribute::Captures)
2474 B.addCapturesAttr(CaptureInfo::createFromIntValue(Record[++i]));
2475 else if (Kind == Attribute::NoFPClass)
2476 B.addNoFPClassAttr(
2477 static_cast<FPClassTest>(Record[++i] & fcAllFlags));
2478 else if (Kind == Attribute::DenormalFPEnv) {
2479 B.addDenormalFPEnvAttr(
2481 }
2482 } else if (Record[i] == 3 || Record[i] == 4) { // String attribute
2483 bool HasValue = (Record[i++] == 4);
2484 SmallString<64> KindStr;
2485 SmallString<64> ValStr;
2486
2487 while (Record[i] != 0 && i != e)
2488 KindStr += Record[i++];
2489 assert(Record[i] == 0 && "Kind string not null terminated");
2490
2491 if (HasValue) {
2492 // Has a value associated with it.
2493 ++i; // Skip the '0' that terminates the "kind" string.
2494 while (Record[i] != 0 && i != e)
2495 ValStr += Record[i++];
2496 assert(Record[i] == 0 && "Value string not null terminated");
2497 }
2498
2499 B.addAttribute(KindStr.str(), ValStr.str());
2500 } else if (Record[i] == 5 || Record[i] == 6) {
2501 bool HasType = Record[i] == 6;
2502 Attribute::AttrKind Kind;
2503 if (Error Err = parseAttrKind(Record[++i], &Kind))
2504 return Err;
2505 if (!Attribute::isTypeAttrKind(Kind))
2506 return error("Not a type attribute");
2507
2508 B.addTypeAttr(Kind, HasType ? getTypeByID(Record[++i]) : nullptr);
2509 } else if (Record[i] == 7) {
2510 Attribute::AttrKind Kind;
2511
2512 i++;
2513 if (Error Err = parseAttrKind(Record[i++], &Kind))
2514 return Err;
2515 if (!Attribute::isConstantRangeAttrKind(Kind))
2516 return error("Not a ConstantRange attribute");
2517
2518 Expected<ConstantRange> MaybeCR =
2519 readBitWidthAndConstantRange(Record, i);
2520 if (!MaybeCR)
2521 return MaybeCR.takeError();
2522 i--;
2523
2524 B.addConstantRangeAttr(Kind, MaybeCR.get());
2525 } else if (Record[i] == 8) {
2526 Attribute::AttrKind Kind;
2527
2528 i++;
2529 if (Error Err = parseAttrKind(Record[i++], &Kind))
2530 return Err;
2531 if (!Attribute::isConstantRangeListAttrKind(Kind))
2532 return error("Not a constant range list attribute");
2533
2535 if (i + 2 > e)
2536 return error("Too few records for constant range list");
2537 unsigned RangeSize = Record[i++];
2538 unsigned BitWidth = Record[i++];
2539 for (unsigned Idx = 0; Idx < RangeSize; ++Idx) {
2540 Expected<ConstantRange> MaybeCR =
2541 readConstantRange(Record, i, BitWidth);
2542 if (!MaybeCR)
2543 return MaybeCR.takeError();
2544 Val.push_back(MaybeCR.get());
2545 }
2546 i--;
2547
2549 return error("Invalid (unordered or overlapping) range list");
2550 B.addConstantRangeListAttr(Kind, Val);
2551 } else {
2552 return error("Invalid attribute group entry");
2553 }
2554 }
2555
2556 if (ME != MemoryEffects::unknown())
2557 B.addMemoryAttr(ME);
2558
2560 MAttributeGroups[GrpID] = AttributeList::get(Context, Idx, B);
2561 break;
2562 }
2563 }
2564 }
2565}
2566
2567Error BitcodeReader::parseTypeTable() {
2569 return Err;
2570
2571 return parseTypeTableBody();
2572}
2573
2574Error BitcodeReader::parseTypeTableBody() {
2575 if (!TypeList.empty())
2576 return error("Invalid multiple blocks");
2577
2578 SmallVector<uint64_t, 64> Record;
2579 unsigned NumRecords = 0;
2580
2581 SmallString<64> TypeName;
2582
2583 // Read all the records for this type table.
2584 while (true) {
2585 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2586 if (!MaybeEntry)
2587 return MaybeEntry.takeError();
2588 BitstreamEntry Entry = MaybeEntry.get();
2589
2590 switch (Entry.Kind) {
2591 case BitstreamEntry::SubBlock: // Handled for us already.
2593 return error("Malformed block");
2595 if (NumRecords != TypeList.size())
2596 return error("Malformed block");
2597 return Error::success();
2599 // The interesting case.
2600 break;
2601 }
2602
2603 // Read a record.
2604 Record.clear();
2605 Type *ResultTy = nullptr;
2606 SmallVector<unsigned> ContainedIDs;
2607 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2608 if (!MaybeRecord)
2609 return MaybeRecord.takeError();
2610 switch (MaybeRecord.get()) {
2611 default:
2612 return error("Invalid value");
2613 case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
2614 // TYPE_CODE_NUMENTRY contains a count of the number of types in the
2615 // type list. This allows us to reserve space.
2616 if (Record.empty())
2617 return error("Invalid numentry record");
2618 TypeList.resize(Record[0]);
2619 continue;
2620 case bitc::TYPE_CODE_VOID: // VOID
2621 ResultTy = Type::getVoidTy(Context);
2622 break;
2623 case bitc::TYPE_CODE_HALF: // HALF
2624 ResultTy = Type::getHalfTy(Context);
2625 break;
2626 case bitc::TYPE_CODE_BFLOAT: // BFLOAT
2627 ResultTy = Type::getBFloatTy(Context);
2628 break;
2629 case bitc::TYPE_CODE_FLOAT: // FLOAT
2630 ResultTy = Type::getFloatTy(Context);
2631 break;
2632 case bitc::TYPE_CODE_DOUBLE: // DOUBLE
2633 ResultTy = Type::getDoubleTy(Context);
2634 break;
2635 case bitc::TYPE_CODE_X86_FP80: // X86_FP80
2636 ResultTy = Type::getX86_FP80Ty(Context);
2637 break;
2638 case bitc::TYPE_CODE_FP128: // FP128
2639 ResultTy = Type::getFP128Ty(Context);
2640 break;
2641 case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
2642 ResultTy = Type::getPPC_FP128Ty(Context);
2643 break;
2644 case bitc::TYPE_CODE_LABEL: // LABEL
2645 ResultTy = Type::getLabelTy(Context);
2646 break;
2647 case bitc::TYPE_CODE_METADATA: // METADATA
2648 ResultTy = Type::getMetadataTy(Context);
2649 break;
2650 case bitc::TYPE_CODE_X86_MMX: // X86_MMX
2651 // Deprecated: decodes as <1 x i64>
2652 ResultTy =
2654 break;
2655 case bitc::TYPE_CODE_X86_AMX: // X86_AMX
2656 ResultTy = Type::getX86_AMXTy(Context);
2657 break;
2658 case bitc::TYPE_CODE_TOKEN: // TOKEN
2659 ResultTy = Type::getTokenTy(Context);
2660 break;
2661 case bitc::TYPE_CODE_BYTE: { // BYTE: [width]
2662 if (Record.empty())
2663 return error("Invalid record");
2664
2665 uint64_t NumBits = Record[0];
2666 if (NumBits < ByteType::MIN_BYTE_BITS ||
2667 NumBits > ByteType::MAX_BYTE_BITS)
2668 return error("Bitwidth for byte type out of range");
2669 ResultTy = ByteType::get(Context, NumBits);
2670 break;
2671 }
2672 case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
2673 if (Record.empty())
2674 return error("Invalid integer record");
2675
2676 uint64_t NumBits = Record[0];
2677 if (NumBits < IntegerType::MIN_INT_BITS ||
2678 NumBits > IntegerType::MAX_INT_BITS)
2679 return error("Bitwidth for integer type out of range");
2680 ResultTy = IntegerType::get(Context, NumBits);
2681 break;
2682 }
2683 case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
2684 // [pointee type, address space]
2685 if (Record.empty())
2686 return error("Invalid pointer record");
2687 unsigned AddressSpace = 0;
2688 if (Record.size() == 2)
2689 AddressSpace = Record[1];
2690 ResultTy = getTypeByID(Record[0]);
2691 if (!ResultTy ||
2692 !PointerType::isValidElementType(ResultTy))
2693 return error("Invalid type");
2694 ContainedIDs.push_back(Record[0]);
2695 ResultTy = PointerType::get(ResultTy->getContext(), AddressSpace);
2696 break;
2697 }
2698 case bitc::TYPE_CODE_OPAQUE_POINTER: { // OPAQUE_POINTER: [addrspace]
2699 if (Record.size() != 1)
2700 return error("Invalid opaque pointer record");
2701 unsigned AddressSpace = Record[0];
2702 ResultTy = PointerType::get(Context, AddressSpace);
2703 break;
2704 }
2706 // Deprecated, but still needed to read old bitcode files.
2707 // FUNCTION: [vararg, attrid, retty, paramty x N]
2708 if (Record.size() < 3)
2709 return error("Invalid function record");
2710 SmallVector<Type*, 8> ArgTys;
2711 for (unsigned i = 3, e = Record.size(); i != e; ++i) {
2712 if (Type *T = getTypeByID(Record[i]))
2713 ArgTys.push_back(T);
2714 else
2715 break;
2716 }
2717
2718 ResultTy = getTypeByID(Record[2]);
2719 if (!ResultTy || ArgTys.size() < Record.size()-3)
2720 return error("Invalid type");
2721
2722 ContainedIDs.append(Record.begin() + 2, Record.end());
2723 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
2724 break;
2725 }
2727 // FUNCTION: [vararg, retty, paramty x N]
2728 if (Record.size() < 2)
2729 return error("Invalid function record");
2730 SmallVector<Type*, 8> ArgTys;
2731 for (unsigned i = 2, e = Record.size(); i != e; ++i) {
2732 if (Type *T = getTypeByID(Record[i])) {
2733 if (!FunctionType::isValidArgumentType(T))
2734 return error("Invalid function argument type");
2735 ArgTys.push_back(T);
2736 }
2737 else
2738 break;
2739 }
2740
2741 ResultTy = getTypeByID(Record[1]);
2742 if (!ResultTy || ArgTys.size() < Record.size()-2)
2743 return error("Invalid type");
2744
2745 ContainedIDs.append(Record.begin() + 1, Record.end());
2746 ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
2747 break;
2748 }
2749 case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]
2750 if (Record.empty())
2751 return error("Invalid anon struct record");
2752 SmallVector<Type*, 8> EltTys;
2753 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
2754 if (Type *T = getTypeByID(Record[i]))
2755 EltTys.push_back(T);
2756 else
2757 break;
2758 }
2759 if (EltTys.size() != Record.size()-1)
2760 return error("Invalid type");
2761 ContainedIDs.append(Record.begin() + 1, Record.end());
2762 ResultTy = StructType::get(Context, EltTys, Record[0]);
2763 break;
2764 }
2765 case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]
2766 if (convertToString(Record, 0, TypeName))
2767 return error("Invalid struct name record");
2768 continue;
2769
2770 case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
2771 if (Record.empty())
2772 return error("Invalid named struct record");
2773
2774 if (NumRecords >= TypeList.size())
2775 return error("Invalid TYPE table");
2776
2777 // Check to see if this was forward referenced, if so fill in the temp.
2778 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
2779 if (Res) {
2780 Res->setName(TypeName);
2781 TypeList[NumRecords] = nullptr;
2782 } else // Otherwise, create a new struct.
2783 Res = createIdentifiedStructType(Context, TypeName);
2784 TypeName.clear();
2785
2786 SmallVector<Type*, 8> EltTys;
2787 for (unsigned i = 1, e = Record.size(); i != e; ++i) {
2788 if (Type *T = getTypeByID(Record[i]))
2789 EltTys.push_back(T);
2790 else
2791 break;
2792 }
2793 if (EltTys.size() != Record.size()-1)
2794 return error("Invalid named struct record");
2795 if (auto E = Res->setBodyOrError(EltTys, Record[0]))
2796 return E;
2797 ContainedIDs.append(Record.begin() + 1, Record.end());
2798 ResultTy = Res;
2799 break;
2800 }
2801 case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []
2802 if (Record.size() != 1)
2803 return error("Invalid opaque type record");
2804
2805 if (NumRecords >= TypeList.size())
2806 return error("Invalid TYPE table");
2807
2808 // Check to see if this was forward referenced, if so fill in the temp.
2809 StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
2810 if (Res) {
2811 Res->setName(TypeName);
2812 TypeList[NumRecords] = nullptr;
2813 } else // Otherwise, create a new struct with no body.
2814 Res = createIdentifiedStructType(Context, TypeName);
2815 TypeName.clear();
2816 ResultTy = Res;
2817 break;
2818 }
2819 case bitc::TYPE_CODE_TARGET_TYPE: { // TARGET_TYPE: [NumTy, Tys..., Ints...]
2820 if (Record.size() < 1)
2821 return error("Invalid target extension type record");
2822
2823 if (NumRecords >= TypeList.size())
2824 return error("Invalid TYPE table");
2825
2826 if (Record[0] >= Record.size())
2827 return error("Too many type parameters");
2828
2829 unsigned NumTys = Record[0];
2830 SmallVector<Type *, 4> TypeParams;
2831 SmallVector<unsigned, 8> IntParams;
2832 for (unsigned i = 0; i < NumTys; i++) {
2833 if (Type *T = getTypeByID(Record[i + 1]))
2834 TypeParams.push_back(T);
2835 else
2836 return error("Invalid type");
2837 }
2838
2839 for (unsigned i = NumTys + 1, e = Record.size(); i < e; i++) {
2840 if (Record[i] > UINT_MAX)
2841 return error("Integer parameter too large");
2842 IntParams.push_back(Record[i]);
2843 }
2844 auto TTy =
2845 TargetExtType::getOrError(Context, TypeName, TypeParams, IntParams);
2846 if (auto E = TTy.takeError())
2847 return E;
2848 ResultTy = *TTy;
2849 TypeName.clear();
2850 break;
2851 }
2852 case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]
2853 if (Record.size() < 2)
2854 return error("Invalid array type record");
2855 ResultTy = getTypeByID(Record[1]);
2856 if (!ResultTy || !ArrayType::isValidElementType(ResultTy))
2857 return error("Invalid type");
2858 ContainedIDs.push_back(Record[1]);
2859 ResultTy = ArrayType::get(ResultTy, Record[0]);
2860 break;
2861 case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty] or
2862 // [numelts, eltty, scalable]
2863 if (Record.size() < 2)
2864 return error("Invalid vector type record");
2865 if (Record[0] == 0)
2866 return error("Invalid vector length");
2867 ResultTy = getTypeByID(Record[1]);
2868 if (!ResultTy || !VectorType::isValidElementType(ResultTy))
2869 return error("Invalid type");
2870 bool Scalable = Record.size() > 2 ? Record[2] : false;
2871 ContainedIDs.push_back(Record[1]);
2872 ResultTy = VectorType::get(ResultTy, Record[0], Scalable);
2873 break;
2874 }
2875
2876 if (NumRecords >= TypeList.size())
2877 return error("Invalid TYPE table");
2878 if (TypeList[NumRecords])
2879 return error(
2880 "Invalid TYPE table: Only named structs can be forward referenced");
2881 assert(ResultTy && "Didn't read a type?");
2882 TypeList[NumRecords] = ResultTy;
2883 if (!ContainedIDs.empty())
2884 ContainedTypeIDs[NumRecords] = std::move(ContainedIDs);
2885 ++NumRecords;
2886 }
2887}
2888
2889Error BitcodeReader::parseOperandBundleTags() {
2891 return Err;
2892
2893 if (!BundleTags.empty())
2894 return error("Invalid multiple blocks");
2895
2896 SmallVector<uint64_t, 64> Record;
2897
2898 while (true) {
2899 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2900 if (!MaybeEntry)
2901 return MaybeEntry.takeError();
2902 BitstreamEntry Entry = MaybeEntry.get();
2903
2904 switch (Entry.Kind) {
2905 case BitstreamEntry::SubBlock: // Handled for us already.
2907 return error("Malformed block");
2909 return Error::success();
2911 // The interesting case.
2912 break;
2913 }
2914
2915 // Tags are implicitly mapped to integers by their order.
2916
2917 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2918 if (!MaybeRecord)
2919 return MaybeRecord.takeError();
2920 if (MaybeRecord.get() != bitc::OPERAND_BUNDLE_TAG)
2921 return error("Invalid operand bundle record");
2922
2923 // OPERAND_BUNDLE_TAG: [strchr x N]
2924 BundleTags.emplace_back();
2925 if (convertToString(Record, 0, BundleTags.back()))
2926 return error("Invalid operand bundle record");
2927 Record.clear();
2928 }
2929}
2930
2931Error BitcodeReader::parseSyncScopeNames() {
2933 return Err;
2934
2935 if (!SSIDs.empty())
2936 return error("Invalid multiple synchronization scope names blocks");
2937
2938 SmallVector<uint64_t, 64> Record;
2939 while (true) {
2940 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
2941 if (!MaybeEntry)
2942 return MaybeEntry.takeError();
2943 BitstreamEntry Entry = MaybeEntry.get();
2944
2945 switch (Entry.Kind) {
2946 case BitstreamEntry::SubBlock: // Handled for us already.
2948 return error("Malformed block");
2950 if (SSIDs.empty())
2951 return error("Invalid empty synchronization scope names block");
2952 return Error::success();
2954 // The interesting case.
2955 break;
2956 }
2957
2958 // Synchronization scope names are implicitly mapped to synchronization
2959 // scope IDs by their order.
2960
2961 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
2962 if (!MaybeRecord)
2963 return MaybeRecord.takeError();
2964 if (MaybeRecord.get() != bitc::SYNC_SCOPE_NAME)
2965 return error("Invalid sync scope record");
2966
2967 SmallString<16> SSN;
2968 if (convertToString(Record, 0, SSN))
2969 return error("Invalid sync scope record");
2970
2971 SSIDs.push_back(Context.getOrInsertSyncScopeID(SSN));
2972 Record.clear();
2973 }
2974}
2975
2976/// Associate a value with its name from the given index in the provided record.
2977Expected<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,
2978 unsigned NameIndex, Triple &TT) {
2979 SmallString<128> ValueName;
2980 if (convertToString(Record, NameIndex, ValueName))
2981 return error("Invalid record");
2982 unsigned ValueID = Record[0];
2983 if (ValueID >= ValueList.size() || !ValueList[ValueID])
2984 return error("Invalid record");
2985 Value *V = ValueList[ValueID];
2986
2987 StringRef NameStr(ValueName.data(), ValueName.size());
2988 if (NameStr.contains(0))
2989 return error("Invalid value name");
2990 V->setName(NameStr);
2991 auto *GO = dyn_cast<GlobalObject>(V);
2992 if (GO && ImplicitComdatObjects.contains(GO) && TT.supportsCOMDAT())
2993 GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
2994 return V;
2995}
2996
2997/// Helper to note and return the current location, and jump to the given
2998/// offset.
3000 BitstreamCursor &Stream) {
3001 // Save the current parsing location so we can jump back at the end
3002 // of the VST read.
3003 uint64_t CurrentBit = Stream.GetCurrentBitNo();
3004 if (Error JumpFailed = Stream.JumpToBit(Offset * 32))
3005 return std::move(JumpFailed);
3006 Expected<BitstreamEntry> MaybeEntry = Stream.advance();
3007 if (!MaybeEntry)
3008 return MaybeEntry.takeError();
3009 if (MaybeEntry.get().Kind != BitstreamEntry::SubBlock ||
3010 MaybeEntry.get().ID != bitc::VALUE_SYMTAB_BLOCK_ID)
3011 return error("Expected value symbol table subblock");
3012 return CurrentBit;
3013}
3014
3015void BitcodeReader::setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta,
3016 Function *F,
3017 ArrayRef<uint64_t> Record) {
3018 // Note that we subtract 1 here because the offset is relative to one word
3019 // before the start of the identification or module block, which was
3020 // historically always the start of the regular bitcode header.
3021 uint64_t FuncWordOffset = Record[1] - 1;
3022 uint64_t FuncBitOffset = FuncWordOffset * 32;
3023 DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;
3024 // Set the LastFunctionBlockBit to point to the last function block.
3025 // Later when parsing is resumed after function materialization,
3026 // we can simply skip that last function block.
3027 if (FuncBitOffset > LastFunctionBlockBit)
3028 LastFunctionBlockBit = FuncBitOffset;
3029}
3030
3031/// Read a new-style GlobalValue symbol table.
3032Error BitcodeReader::parseGlobalValueSymbolTable() {
3033 unsigned FuncBitcodeOffsetDelta =
3035
3037 return Err;
3038
3039 SmallVector<uint64_t, 64> Record;
3040 while (true) {
3041 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
3042 if (!MaybeEntry)
3043 return MaybeEntry.takeError();
3044 BitstreamEntry Entry = MaybeEntry.get();
3045
3046 switch (Entry.Kind) {
3049 return error("Malformed block");
3051 return Error::success();
3053 break;
3054 }
3055
3056 Record.clear();
3057 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
3058 if (!MaybeRecord)
3059 return MaybeRecord.takeError();
3060 switch (MaybeRecord.get()) {
3061 case bitc::VST_CODE_FNENTRY: { // [valueid, offset]
3062 unsigned ValueID = Record[0];
3063 if (ValueID >= ValueList.size() || !ValueList[ValueID])
3064 return error("Invalid value reference in symbol table");
3065 setDeferredFunctionInfo(FuncBitcodeOffsetDelta,
3066 cast<Function>(ValueList[ValueID]), Record);
3067 break;
3068 }
3069 }
3070 }
3071}
3072
3073/// Parse the value symbol table at either the current parsing location or
3074/// at the given bit offset if provided.
3075Error BitcodeReader::parseValueSymbolTable(uint64_t Offset) {
3076 uint64_t CurrentBit;
3077 // Pass in the Offset to distinguish between calling for the module-level
3078 // VST (where we want to jump to the VST offset) and the function-level
3079 // VST (where we don't).
3080 if (Offset > 0) {
3081 Expected<uint64_t> MaybeCurrentBit = jumpToValueSymbolTable(Offset, Stream);
3082 if (!MaybeCurrentBit)
3083 return MaybeCurrentBit.takeError();
3084 CurrentBit = MaybeCurrentBit.get();
3085 // If this module uses a string table, read this as a module-level VST.
3086 if (UseStrtab) {
3087 if (Error Err = parseGlobalValueSymbolTable())
3088 return Err;
3089 if (Error JumpFailed = Stream.JumpToBit(CurrentBit))
3090 return JumpFailed;
3091 return Error::success();
3092 }
3093 // Otherwise, the VST will be in a similar format to a function-level VST,
3094 // and will contain symbol names.
3095 }
3096
3097 // Compute the delta between the bitcode indices in the VST (the word offset
3098 // to the word-aligned ENTER_SUBBLOCK for the function block, and that
3099 // expected by the lazy reader. The reader's EnterSubBlock expects to have
3100 // already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID
3101 // (size BlockIDWidth). Note that we access the stream's AbbrevID width here
3102 // just before entering the VST subblock because: 1) the EnterSubBlock
3103 // changes the AbbrevID width; 2) the VST block is nested within the same
3104 // outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same
3105 // AbbrevID width before calling EnterSubBlock; and 3) when we want to
3106 // jump to the FUNCTION_BLOCK using this offset later, we don't want
3107 // to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.
3108 unsigned FuncBitcodeOffsetDelta =
3110
3112 return Err;
3113
3114 SmallVector<uint64_t, 64> Record;
3115
3116 Triple TT(TheModule->getTargetTriple());
3117
3118 // Read all the records for this value table.
3119 SmallString<128> ValueName;
3120
3121 while (true) {
3122 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
3123 if (!MaybeEntry)
3124 return MaybeEntry.takeError();
3125 BitstreamEntry Entry = MaybeEntry.get();
3126
3127 switch (Entry.Kind) {
3128 case BitstreamEntry::SubBlock: // Handled for us already.
3130 return error("Malformed block");
3132 if (Offset > 0)
3133 if (Error JumpFailed = Stream.JumpToBit(CurrentBit))
3134 return JumpFailed;
3135 return Error::success();
3137 // The interesting case.
3138 break;
3139 }
3140
3141 // Read a record.
3142 Record.clear();
3143 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
3144 if (!MaybeRecord)
3145 return MaybeRecord.takeError();
3146 switch (MaybeRecord.get()) {
3147 default: // Default behavior: unknown type.
3148 break;
3149 case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]
3150 Expected<Value *> ValOrErr = recordValue(Record, 1, TT);
3151 if (Error Err = ValOrErr.takeError())
3152 return Err;
3153 ValOrErr.get();
3154 break;
3155 }
3157 // VST_CODE_FNENTRY: [valueid, offset, namechar x N]
3158 Expected<Value *> ValOrErr = recordValue(Record, 2, TT);
3159 if (Error Err = ValOrErr.takeError())
3160 return Err;
3161 Value *V = ValOrErr.get();
3162
3163 // Ignore function offsets emitted for aliases of functions in older
3164 // versions of LLVM.
3165 if (auto *F = dyn_cast<Function>(V))
3166 setDeferredFunctionInfo(FuncBitcodeOffsetDelta, F, Record);
3167 break;
3168 }
3170 if (convertToString(Record, 1, ValueName))
3171 return error("Invalid bbentry record");
3172 BasicBlock *BB = getBasicBlock(Record[0]);
3173 if (!BB)
3174 return error("Invalid bbentry record");
3175
3176 BB->setName(ValueName.str());
3177 ValueName.clear();
3178 break;
3179 }
3180 }
3181 }
3182}
3183
3184/// Decode a signed value stored with the sign bit in the LSB for dense VBR
3185/// encoding.
3186uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
3187 if ((V & 1) == 0)
3188 return V >> 1;
3189 if (V != 1)
3190 return -(V >> 1);
3191 // There is no such thing as -0 with integers. "-0" really means MININT.
3192 return 1ULL << 63;
3193}
3194
3195/// Resolve all of the initializers for global values and aliases that we can.
3196Error BitcodeReader::resolveGlobalAndIndirectSymbolInits() {
3197 std::vector<std::pair<GlobalVariable *, unsigned>> GlobalInitWorklist;
3198 std::vector<std::pair<GlobalValue *, unsigned>> IndirectSymbolInitWorklist;
3199 std::vector<FunctionOperandInfo> FunctionOperandWorklist;
3200
3201 GlobalInitWorklist.swap(GlobalInits);
3202 IndirectSymbolInitWorklist.swap(IndirectSymbolInits);
3203 FunctionOperandWorklist.swap(FunctionOperands);
3204
3205 while (!GlobalInitWorklist.empty()) {
3206 unsigned ValID = GlobalInitWorklist.back().second;
3207 if (ValID >= ValueList.size()) {
3208 // Not ready to resolve this yet, it requires something later in the file.
3209 GlobalInits.push_back(GlobalInitWorklist.back());
3210 } else {
3211 Expected<Constant *> MaybeC = getValueForInitializer(ValID);
3212 if (!MaybeC)
3213 return MaybeC.takeError();
3214 GlobalInitWorklist.back().first->setInitializer(MaybeC.get());
3215 }
3216 GlobalInitWorklist.pop_back();
3217 }
3218
3219 while (!IndirectSymbolInitWorklist.empty()) {
3220 unsigned ValID = IndirectSymbolInitWorklist.back().second;
3221 if (ValID >= ValueList.size()) {
3222 IndirectSymbolInits.push_back(IndirectSymbolInitWorklist.back());
3223 } else {
3224 Expected<Constant *> MaybeC = getValueForInitializer(ValID);
3225 if (!MaybeC)
3226 return MaybeC.takeError();
3227 Constant *C = MaybeC.get();
3228 GlobalValue *GV = IndirectSymbolInitWorklist.back().first;
3229 if (auto *GA = dyn_cast<GlobalAlias>(GV)) {
3230 if (C->getType() != GV->getType())
3231 return error("Alias and aliasee types don't match");
3232 GA->setAliasee(C);
3233 } else if (auto *GI = dyn_cast<GlobalIFunc>(GV)) {
3234 GI->setResolver(C);
3235 } else {
3236 return error("Expected an alias or an ifunc");
3237 }
3238 }
3239 IndirectSymbolInitWorklist.pop_back();
3240 }
3241
3242 while (!FunctionOperandWorklist.empty()) {
3243 FunctionOperandInfo &Info = FunctionOperandWorklist.back();
3244 if (Info.PersonalityFn) {
3245 unsigned ValID = Info.PersonalityFn - 1;
3246 if (ValID < ValueList.size()) {
3247 Expected<Constant *> MaybeC = getValueForInitializer(ValID);
3248 if (!MaybeC)
3249 return MaybeC.takeError();
3250 Info.F->setPersonalityFn(MaybeC.get());
3251 Info.PersonalityFn = 0;
3252 }
3253 }
3254 if (Info.Prefix) {
3255 unsigned ValID = Info.Prefix - 1;
3256 if (ValID < ValueList.size()) {
3257 Expected<Constant *> MaybeC = getValueForInitializer(ValID);
3258 if (!MaybeC)
3259 return MaybeC.takeError();
3260 Info.F->setPrefixData(MaybeC.get());
3261 Info.Prefix = 0;
3262 }
3263 }
3264 if (Info.Prologue) {
3265 unsigned ValID = Info.Prologue - 1;
3266 if (ValID < ValueList.size()) {
3267 Expected<Constant *> MaybeC = getValueForInitializer(ValID);
3268 if (!MaybeC)
3269 return MaybeC.takeError();
3270 Info.F->setPrologueData(MaybeC.get());
3271 Info.Prologue = 0;
3272 }
3273 }
3274 if (Info.PersonalityFn || Info.Prefix || Info.Prologue)
3275 FunctionOperands.push_back(Info);
3276 FunctionOperandWorklist.pop_back();
3277 }
3278
3279 return Error::success();
3280}
3281
3283 SmallVector<uint64_t, 8> Words(Vals.size());
3284 transform(Vals, Words.begin(),
3285 BitcodeReader::decodeSignRotatedValue);
3286
3287 return APInt(TypeBits, Words);
3288}
3289
3290Error BitcodeReader::parseConstants() {
3292 return Err;
3293
3295
3296 // Read all the records for this value table.
3297 Type *CurTy = Type::getInt32Ty(Context);
3298 unsigned Int32TyID = getVirtualTypeID(CurTy);
3299 unsigned CurTyID = Int32TyID;
3300 Type *CurElemTy = nullptr;
3301 unsigned NextCstNo = ValueList.size();
3302
3303 while (true) {
3305 if (!MaybeEntry)
3306 return MaybeEntry.takeError();
3307 BitstreamEntry Entry = MaybeEntry.get();
3308
3309 switch (Entry.Kind) {
3310 case BitstreamEntry::SubBlock: // Handled for us already.
3312 return error("Malformed block");
3314 if (NextCstNo != ValueList.size())
3315 return error("Invalid constant reference");
3316 return Error::success();
3318 // The interesting case.
3319 break;
3320 }
3321
3322 // Read a record.
3323 Record.clear();
3324 Type *VoidType = Type::getVoidTy(Context);
3325 Value *V = nullptr;
3326 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
3327 if (!MaybeBitCode)
3328 return MaybeBitCode.takeError();
3329 switch (unsigned BitCode = MaybeBitCode.get()) {
3330 default: // Default behavior: unknown constant
3331 case bitc::CST_CODE_UNDEF: // UNDEF
3332 V = UndefValue::get(CurTy);
3333 break;
3334 case bitc::CST_CODE_POISON: // POISON
3335 V = PoisonValue::get(CurTy);
3336 break;
3337 case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]
3338 if (Record.empty())
3339 return error("Invalid settype record");
3340 if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
3341 return error("Invalid settype record");
3342 if (TypeList[Record[0]] == VoidType)
3343 return error("Invalid constant type");
3344 CurTyID = Record[0];
3345 CurTy = TypeList[CurTyID];
3346 CurElemTy = getPtrElementTypeByID(CurTyID);
3347 continue; // Skip the ValueList manipulation.
3348 case bitc::CST_CODE_NULL: // NULL
3349 if (CurTy->isVoidTy() || CurTy->isFunctionTy() || CurTy->isLabelTy())
3350 return error("Invalid type for a constant null value");
3351 if (auto *TETy = dyn_cast<TargetExtType>(CurTy))
3352 if (!TETy->hasProperty(TargetExtType::HasZeroInit))
3353 return error("Invalid type for a constant null value");
3354 V = Constant::getNullValue(CurTy);
3355 break;
3356 case bitc::CST_CODE_INTEGER: // INTEGER: [intval]
3357 if (!CurTy->isIntOrIntVectorTy() || Record.empty())
3358 return error("Invalid integer const record");
3359 V = ConstantInt::getSigned(CurTy, decodeSignRotatedValue(Record[0]));
3360 break;
3361 case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
3362 if (!CurTy->isIntOrIntVectorTy() || Record.empty())
3363 return error("Invalid wide integer const record");
3364
3365 auto *ScalarTy = cast<IntegerType>(CurTy->getScalarType());
3366 APInt VInt = readWideAPInt(Record, ScalarTy->getBitWidth());
3367 V = ConstantInt::get(CurTy, VInt);
3368 break;
3369 }
3370 case bitc::CST_CODE_BYTE: // BYTE: [byteval]
3371 if (!CurTy->isByteOrByteVectorTy() || Record.empty())
3372 return error("Invalid byte const record");
3373 V = ConstantByte::get(CurTy, decodeSignRotatedValue(Record[0]));
3374 break;
3375 case bitc::CST_CODE_WIDE_BYTE: { // WIDE_BYTE: [n x byteval]
3376 if (!CurTy->isByteOrByteVectorTy() || Record.empty())
3377 return error("Invalid wide byte const record");
3378
3379 auto *ScalarTy = cast<ByteType>(CurTy->getScalarType());
3380 APInt VByte = readWideAPInt(Record, ScalarTy->getBitWidth());
3381 V = ConstantByte::get(CurTy, VByte);
3382 break;
3383 }
3384 case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]
3385 if (Record.empty())
3386 return error("Invalid float const record");
3387
3388 auto *ScalarTy = CurTy->getScalarType();
3389 if (ScalarTy->isHalfTy())
3390 V = ConstantFP::get(CurTy, APFloat(APFloat::IEEEhalf(),
3391 APInt(16, (uint16_t)Record[0])));
3392 else if (ScalarTy->isBFloatTy())
3393 V = ConstantFP::get(
3394 CurTy, APFloat(APFloat::BFloat(), APInt(16, (uint32_t)Record[0])));
3395 else if (ScalarTy->isFloatTy())
3396 V = ConstantFP::get(CurTy, APFloat(APFloat::IEEEsingle(),
3397 APInt(32, (uint32_t)Record[0])));
3398 else if (ScalarTy->isDoubleTy())
3399 V = ConstantFP::get(
3400 CurTy, APFloat(APFloat::IEEEdouble(), APInt(64, Record[0])));
3401 else if (ScalarTy->isX86_FP80Ty()) {
3402 // Bits are not stored the same way as a normal i80 APInt, compensate.
3403 uint64_t Rearrange[2];
3404 Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
3405 Rearrange[1] = Record[0] >> 48;
3406 V = ConstantFP::get(
3407 CurTy, APFloat(APFloat::x87DoubleExtended(), APInt(80, Rearrange)));
3408 } else if (ScalarTy->isFP128Ty())
3409 V = ConstantFP::get(CurTy,
3410 APFloat(APFloat::IEEEquad(), APInt(128, Record)));
3411 else if (ScalarTy->isPPC_FP128Ty())
3412 V = ConstantFP::get(
3413 CurTy, APFloat(APFloat::PPCDoubleDouble(), APInt(128, Record)));
3414 else
3415 V = PoisonValue::get(CurTy);
3416 break;
3417 }
3418
3419 case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
3420 if (Record.empty())
3421 return error("Invalid aggregate record");
3422
3423 SmallVector<unsigned, 16> Elts;
3424 llvm::append_range(Elts, Record);
3425
3426 if (isa<StructType>(CurTy)) {
3427 V = BitcodeConstant::create(
3428 Alloc, CurTy, BitcodeConstant::ConstantStructOpcode, Elts);
3429 } else if (isa<ArrayType>(CurTy)) {
3430 V = BitcodeConstant::create(Alloc, CurTy,
3431 BitcodeConstant::ConstantArrayOpcode, Elts);
3432 } else if (isa<VectorType>(CurTy)) {
3433 V = BitcodeConstant::create(
3434 Alloc, CurTy, BitcodeConstant::ConstantVectorOpcode, Elts);
3435 } else {
3436 V = PoisonValue::get(CurTy);
3437 }
3438 break;
3439 }
3440 case bitc::CST_CODE_STRING: // STRING: [values]
3441 case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
3442 if (Record.empty())
3443 return error("Invalid string record");
3444
3445 SmallString<16> Elts(Record.begin(), Record.end());
3447 Context, Elts, BitCode == bitc::CST_CODE_CSTRING,
3448 cast<ArrayType>(CurTy)->getElementType()->isByteTy());
3449 break;
3450 }
3451 case bitc::CST_CODE_DATA: {// DATA: [n x value]
3452 if (Record.empty())
3453 return error("Invalid data record");
3454
3455 Type *EltTy = CurTy->getContainedType(0);
3457 return error("Invalid type for value");
3458
3459 const unsigned EltBytes = EltTy->getScalarSizeInBits() / 8;
3460 SmallString<128> RawData;
3461 RawData.reserve(Record.size() * EltBytes);
3462 for (uint64_t Val : Record) {
3463 const char *Src = reinterpret_cast<const char *>(&Val);
3464 if constexpr (sys::IsBigEndianHost)
3465 Src += sizeof(uint64_t) - EltBytes;
3466 RawData.append(Src, Src + EltBytes);
3467 }
3468
3469 V = isa<VectorType>(CurTy)
3470 ? ConstantDataVector::getRaw(RawData.str(), Record.size(), EltTy)
3471 : ConstantDataArray::getRaw(RawData.str(), Record.size(), EltTy);
3472 break;
3473 }
3474 case bitc::CST_CODE_CE_UNOP: { // CE_UNOP: [opcode, opval]
3475 if (Record.size() < 2)
3476 return error("Invalid unary op constexpr record");
3477 int Opc = getDecodedUnaryOpcode(Record[0], CurTy);
3478 if (Opc < 0) {
3479 V = PoisonValue::get(CurTy); // Unknown unop.
3480 } else {
3481 V = BitcodeConstant::create(Alloc, CurTy, Opc, (unsigned)Record[1]);
3482 }
3483 break;
3484 }
3485 case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]
3486 if (Record.size() < 3)
3487 return error("Invalid binary op constexpr record");
3488 int Opc = getDecodedBinaryOpcode(Record[0], CurTy);
3489 if (Opc < 0) {
3490 V = PoisonValue::get(CurTy); // Unknown binop.
3491 } else {
3492 uint8_t Flags = 0;
3493 if (Record.size() >= 4) {
3494 if (Opc == Instruction::Add ||
3495 Opc == Instruction::Sub ||
3496 Opc == Instruction::Mul ||
3497 Opc == Instruction::Shl) {
3498 if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
3500 if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
3502 } else if (Opc == Instruction::SDiv ||
3503 Opc == Instruction::UDiv ||
3504 Opc == Instruction::LShr ||
3505 Opc == Instruction::AShr) {
3506 if (Record[3] & (1 << bitc::PEO_EXACT))
3508 }
3509 }
3510 V = BitcodeConstant::create(Alloc, CurTy, {(uint8_t)Opc, Flags},
3511 {(unsigned)Record[1], (unsigned)Record[2]});
3512 }
3513 break;
3514 }
3515 case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]
3516 if (Record.size() < 3)
3517 return error("Invalid cast constexpr record");
3518 int Opc = getDecodedCastOpcode(Record[0]);
3519 if (Opc < 0) {
3520 V = PoisonValue::get(CurTy); // Unknown cast.
3521 } else {
3522 unsigned OpTyID = Record[1];
3523 Type *OpTy = getTypeByID(OpTyID);
3524 if (!OpTy)
3525 return error("Invalid cast constexpr record");
3526 V = BitcodeConstant::create(Alloc, CurTy, Opc, (unsigned)Record[2]);
3527 }
3528 break;
3529 }
3530 case bitc::CST_CODE_CE_INBOUNDS_GEP: // [ty, n x operands]
3531 case bitc::CST_CODE_CE_GEP_OLD: // [ty, n x operands]
3532 case bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX_OLD: // [ty, flags, n x
3533 // operands]
3534 case bitc::CST_CODE_CE_GEP: // [ty, flags, n x operands]
3535 case bitc::CST_CODE_CE_GEP_WITH_INRANGE: { // [ty, flags, start, end, n x
3536 // operands]
3537 if (Record.size() < 2)
3538 return error("Constant GEP record must have at least two elements");
3539 unsigned OpNum = 0;
3540 Type *PointeeType = nullptr;
3543 BitCode == bitc::CST_CODE_CE_GEP || Record.size() % 2)
3544 PointeeType = getTypeByID(Record[OpNum++]);
3545
3546 uint64_t Flags = 0;
3547 std::optional<ConstantRange> InRange;
3549 uint64_t Op = Record[OpNum++];
3550 Flags = Op & 1; // inbounds
3551 unsigned InRangeIndex = Op >> 1;
3552 // "Upgrade" inrange by dropping it. The feature is too niche to
3553 // bother.
3554 (void)InRangeIndex;
3555 } else if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE) {
3556 Flags = Record[OpNum++];
3557 Expected<ConstantRange> MaybeInRange =
3558 readBitWidthAndConstantRange(Record, OpNum);
3559 if (!MaybeInRange)
3560 return MaybeInRange.takeError();
3561 InRange = MaybeInRange.get();
3562 } else if (BitCode == bitc::CST_CODE_CE_GEP) {
3563 Flags = Record[OpNum++];
3564 } else if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)
3565 Flags = (1 << bitc::GEP_INBOUNDS);
3566
3567 SmallVector<unsigned, 16> Elts;
3568 unsigned BaseTypeID = Record[OpNum];
3569 while (OpNum != Record.size()) {
3570 unsigned ElTyID = Record[OpNum++];
3571 Type *ElTy = getTypeByID(ElTyID);
3572 if (!ElTy)
3573 return error("Invalid getelementptr constexpr record");
3574 Elts.push_back(Record[OpNum++]);
3575 }
3576
3577 if (Elts.size() < 1)
3578 return error("Invalid gep with no operands");
3579
3580 Type *BaseType = getTypeByID(BaseTypeID);
3582 BaseTypeID = getContainedTypeID(BaseTypeID, 0);
3583 BaseType = getTypeByID(BaseTypeID);
3584 }
3585
3587 if (!OrigPtrTy)
3588 return error("GEP base operand must be pointer or vector of pointer");
3589
3590 if (!PointeeType) {
3591 PointeeType = getPtrElementTypeByID(BaseTypeID);
3592 if (!PointeeType)
3593 return error("Missing element type for old-style constant GEP");
3594 }
3595
3596 V = BitcodeConstant::create(
3597 Alloc, CurTy,
3598 {Instruction::GetElementPtr, uint8_t(Flags), PointeeType, InRange},
3599 Elts);
3600 break;
3601 }
3602 case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]
3603 if (Record.size() < 3)
3604 return error("Invalid select constexpr record");
3605
3606 V = BitcodeConstant::create(
3607 Alloc, CurTy, Instruction::Select,
3608 {(unsigned)Record[0], (unsigned)Record[1], (unsigned)Record[2]});
3609 break;
3610 }
3612 : { // CE_EXTRACTELT: [opty, opval, opty, opval]
3613 if (Record.size() < 3)
3614 return error("Invalid extractelement constexpr record");
3615 unsigned OpTyID = Record[0];
3616 VectorType *OpTy =
3617 dyn_cast_or_null<VectorType>(getTypeByID(OpTyID));
3618 if (!OpTy)
3619 return error("Invalid extractelement constexpr record");
3620 unsigned IdxRecord;
3621 if (Record.size() == 4) {
3622 unsigned IdxTyID = Record[2];
3623 Type *IdxTy = getTypeByID(IdxTyID);
3624 if (!IdxTy)
3625 return error("Invalid extractelement constexpr record");
3626 IdxRecord = Record[3];
3627 } else {
3628 // Deprecated, but still needed to read old bitcode files.
3629 IdxRecord = Record[2];
3630 }
3631 V = BitcodeConstant::create(Alloc, CurTy, Instruction::ExtractElement,
3632 {(unsigned)Record[1], IdxRecord});
3633 break;
3634 }
3636 : { // CE_INSERTELT: [opval, opval, opty, opval]
3637 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
3638 if (Record.size() < 3 || !OpTy)
3639 return error("Invalid insertelement constexpr record");
3640 unsigned IdxRecord;
3641 if (Record.size() == 4) {
3642 unsigned IdxTyID = Record[2];
3643 Type *IdxTy = getTypeByID(IdxTyID);
3644 if (!IdxTy)
3645 return error("Invalid insertelement constexpr record");
3646 IdxRecord = Record[3];
3647 } else {
3648 // Deprecated, but still needed to read old bitcode files.
3649 IdxRecord = Record[2];
3650 }
3651 V = BitcodeConstant::create(
3652 Alloc, CurTy, Instruction::InsertElement,
3653 {(unsigned)Record[0], (unsigned)Record[1], IdxRecord});
3654 break;
3655 }
3656 case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
3657 VectorType *OpTy = dyn_cast<VectorType>(CurTy);
3658 if (Record.size() < 3 || !OpTy)
3659 return error("Invalid shufflevector constexpr record");
3660 V = BitcodeConstant::create(
3661 Alloc, CurTy, Instruction::ShuffleVector,
3662 {(unsigned)Record[0], (unsigned)Record[1], (unsigned)Record[2]});
3663 break;
3664 }
3665 case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
3666 VectorType *RTy = dyn_cast<VectorType>(CurTy);
3667 VectorType *OpTy =
3668 dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
3669 if (Record.size() < 4 || !RTy || !OpTy)
3670 return error("Invalid shufflevector constexpr record");
3671 V = BitcodeConstant::create(
3672 Alloc, CurTy, Instruction::ShuffleVector,
3673 {(unsigned)Record[1], (unsigned)Record[2], (unsigned)Record[3]});
3674 break;
3675 }
3676 case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]
3677 if (Record.size() < 4)
3678 return error("Invalid cmp constexpt record");
3679 unsigned OpTyID = Record[0];
3680 Type *OpTy = getTypeByID(OpTyID);
3681 if (!OpTy)
3682 return error("Invalid cmp constexpr record");
3683 V = BitcodeConstant::create(
3684 Alloc, CurTy,
3685 {(uint8_t)(OpTy->isFPOrFPVectorTy() ? Instruction::FCmp
3686 : Instruction::ICmp),
3687 (uint8_t)Record[3]},
3688 {(unsigned)Record[1], (unsigned)Record[2]});
3689 break;
3690 }
3691 // This maintains backward compatibility, pre-asm dialect keywords.
3692 // Deprecated, but still needed to read old bitcode files.
3694 if (Record.size() < 2)
3695 return error("Invalid inlineasm record");
3696 std::string AsmStr, ConstrStr;
3697 bool HasSideEffects = Record[0] & 1;
3698 bool IsAlignStack = Record[0] >> 1;
3699 unsigned AsmStrSize = Record[1];
3700 if (2+AsmStrSize >= Record.size())
3701 return error("Invalid inlineasm record");
3702 unsigned ConstStrSize = Record[2+AsmStrSize];
3703 if (3+AsmStrSize+ConstStrSize > Record.size())
3704 return error("Invalid inlineasm record");
3705
3706 for (unsigned i = 0; i != AsmStrSize; ++i)
3707 AsmStr += (char)Record[2+i];
3708 for (unsigned i = 0; i != ConstStrSize; ++i)
3709 ConstrStr += (char)Record[3+AsmStrSize+i];
3710 UpgradeInlineAsmString(&AsmStr);
3711 if (!CurElemTy)
3712 return error("Missing element type for old-style inlineasm");
3713 V = InlineAsm::get(cast<FunctionType>(CurElemTy), AsmStr, ConstrStr,
3714 HasSideEffects, IsAlignStack);
3715 break;
3716 }
3717 // This version adds support for the asm dialect keywords (e.g.,
3718 // inteldialect).
3720 if (Record.size() < 2)
3721 return error("Invalid inlineasm record");
3722 std::string AsmStr, ConstrStr;
3723 bool HasSideEffects = Record[0] & 1;
3724 bool IsAlignStack = (Record[0] >> 1) & 1;
3725 unsigned AsmDialect = Record[0] >> 2;
3726 unsigned AsmStrSize = Record[1];
3727 if (2+AsmStrSize >= Record.size())
3728 return error("Invalid inlineasm record");
3729 unsigned ConstStrSize = Record[2+AsmStrSize];
3730 if (3+AsmStrSize+ConstStrSize > Record.size())
3731 return error("Invalid inlineasm record");
3732
3733 for (unsigned i = 0; i != AsmStrSize; ++i)
3734 AsmStr += (char)Record[2+i];
3735 for (unsigned i = 0; i != ConstStrSize; ++i)
3736 ConstrStr += (char)Record[3+AsmStrSize+i];
3737 UpgradeInlineAsmString(&AsmStr);
3738 if (!CurElemTy)
3739 return error("Missing element type for old-style inlineasm");
3740 V = InlineAsm::get(cast<FunctionType>(CurElemTy), AsmStr, ConstrStr,
3741 HasSideEffects, IsAlignStack,
3742 InlineAsm::AsmDialect(AsmDialect));
3743 break;
3744 }
3745 // This version adds support for the unwind keyword.
3747 if (Record.size() < 2)
3748 return error("Invalid inlineasm record");
3749 unsigned OpNum = 0;
3750 std::string AsmStr, ConstrStr;
3751 bool HasSideEffects = Record[OpNum] & 1;
3752 bool IsAlignStack = (Record[OpNum] >> 1) & 1;
3753 unsigned AsmDialect = (Record[OpNum] >> 2) & 1;
3754 bool CanThrow = (Record[OpNum] >> 3) & 1;
3755 ++OpNum;
3756 unsigned AsmStrSize = Record[OpNum];
3757 ++OpNum;
3758 if (OpNum + AsmStrSize >= Record.size())
3759 return error("Invalid inlineasm record");
3760 unsigned ConstStrSize = Record[OpNum + AsmStrSize];
3761 if (OpNum + 1 + AsmStrSize + ConstStrSize > Record.size())
3762 return error("Invalid inlineasm record");
3763
3764 for (unsigned i = 0; i != AsmStrSize; ++i)
3765 AsmStr += (char)Record[OpNum + i];
3766 ++OpNum;
3767 for (unsigned i = 0; i != ConstStrSize; ++i)
3768 ConstrStr += (char)Record[OpNum + AsmStrSize + i];
3769 UpgradeInlineAsmString(&AsmStr);
3770 if (!CurElemTy)
3771 return error("Missing element type for old-style inlineasm");
3772 V = InlineAsm::get(cast<FunctionType>(CurElemTy), AsmStr, ConstrStr,
3773 HasSideEffects, IsAlignStack,
3774 InlineAsm::AsmDialect(AsmDialect), CanThrow);
3775 break;
3776 }
3777 // This version adds explicit function type.
3779 if (Record.size() < 3)
3780 return error("Invalid inlineasm record");
3781 unsigned OpNum = 0;
3782 auto *FnTy = dyn_cast_or_null<FunctionType>(getTypeByID(Record[OpNum]));
3783 ++OpNum;
3784 if (!FnTy)
3785 return error("Invalid inlineasm record");
3786 std::string AsmStr, ConstrStr;
3787 bool HasSideEffects = Record[OpNum] & 1;
3788 bool IsAlignStack = (Record[OpNum] >> 1) & 1;
3789 unsigned AsmDialect = (Record[OpNum] >> 2) & 1;
3790 bool CanThrow = (Record[OpNum] >> 3) & 1;
3791 ++OpNum;
3792 unsigned AsmStrSize = Record[OpNum];
3793 ++OpNum;
3794 if (OpNum + AsmStrSize >= Record.size())
3795 return error("Invalid inlineasm record");
3796 unsigned ConstStrSize = Record[OpNum + AsmStrSize];
3797 if (OpNum + 1 + AsmStrSize + ConstStrSize > Record.size())
3798 return error("Invalid inlineasm record");
3799
3800 for (unsigned i = 0; i != AsmStrSize; ++i)
3801 AsmStr += (char)Record[OpNum + i];
3802 ++OpNum;
3803 for (unsigned i = 0; i != ConstStrSize; ++i)
3804 ConstrStr += (char)Record[OpNum + AsmStrSize + i];
3805 UpgradeInlineAsmString(&AsmStr);
3806 V = InlineAsm::get(FnTy, AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
3807 InlineAsm::AsmDialect(AsmDialect), CanThrow);
3808 break;
3809 }
3811 if (Record.size() < 3)
3812 return error("Invalid blockaddress record");
3813 unsigned FnTyID = Record[0];
3814 Type *FnTy = getTypeByID(FnTyID);
3815 if (!FnTy)
3816 return error("Invalid blockaddress record");
3817 V = BitcodeConstant::create(
3818 Alloc, CurTy,
3819 {BitcodeConstant::BlockAddressOpcode, 0, (unsigned)Record[2]},
3820 Record[1]);
3821 break;
3822 }
3824 if (Record.size() < 2)
3825 return error("Invalid dso_local record");
3826 unsigned GVTyID = Record[0];
3827 Type *GVTy = getTypeByID(GVTyID);
3828 if (!GVTy)
3829 return error("Invalid dso_local record");
3830 V = BitcodeConstant::create(
3831 Alloc, CurTy, BitcodeConstant::DSOLocalEquivalentOpcode, Record[1]);
3832 break;
3833 }
3835 if (Record.size() < 2)
3836 return error("Invalid no_cfi record");
3837 unsigned GVTyID = Record[0];
3838 Type *GVTy = getTypeByID(GVTyID);
3839 if (!GVTy)
3840 return error("Invalid no_cfi record");
3841 V = BitcodeConstant::create(Alloc, CurTy, BitcodeConstant::NoCFIOpcode,
3842 Record[1]);
3843 break;
3844 }
3846 if (Record.size() < 4)
3847 return error("Invalid ptrauth record");
3848 // Ptr, Key, Disc, AddrDisc
3849 V = BitcodeConstant::create(Alloc, CurTy,
3850 BitcodeConstant::ConstantPtrAuthOpcode,
3851 {(unsigned)Record[0], (unsigned)Record[1],
3852 (unsigned)Record[2], (unsigned)Record[3]});
3853 break;
3854 }
3856 if (Record.size() < 5)
3857 return error("Invalid ptrauth record");
3858 // Ptr, Key, Disc, AddrDisc, DeactivationSymbol
3859 V = BitcodeConstant::create(
3860 Alloc, CurTy, BitcodeConstant::ConstantPtrAuthOpcode,
3861 {(unsigned)Record[0], (unsigned)Record[1], (unsigned)Record[2],
3862 (unsigned)Record[3], (unsigned)Record[4]});
3863 break;
3864 }
3865 }
3866
3867 assert(V->getType() == getTypeByID(CurTyID) && "Incorrect result type ID");
3868 if (Error Err = ValueList.assignValue(NextCstNo, V, CurTyID))
3869 return Err;
3870 ++NextCstNo;
3871 }
3872}
3873
3874Error BitcodeReader::parseUseLists() {
3875 if (Error Err = Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
3876 return Err;
3877
3878 // Read all the records.
3879 SmallVector<uint64_t, 64> Record;
3880
3881 while (true) {
3882 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
3883 if (!MaybeEntry)
3884 return MaybeEntry.takeError();
3885 BitstreamEntry Entry = MaybeEntry.get();
3886
3887 switch (Entry.Kind) {
3888 case BitstreamEntry::SubBlock: // Handled for us already.
3890 return error("Malformed block");
3892 return Error::success();
3894 // The interesting case.
3895 break;
3896 }
3897
3898 // Read a use list record.
3899 Record.clear();
3900 bool IsBB = false;
3901 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
3902 if (!MaybeRecord)
3903 return MaybeRecord.takeError();
3904 switch (MaybeRecord.get()) {
3905 default: // Default behavior: unknown type.
3906 break;
3908 IsBB = true;
3909 [[fallthrough]];
3911 unsigned RecordLength = Record.size();
3912 if (RecordLength < 3)
3913 // Records should have at least an ID and two indexes.
3914 return error("Invalid uselist record");
3915 unsigned ID = Record.pop_back_val();
3916
3917 Value *V;
3918 if (IsBB) {
3919 assert(ID < FunctionBBs.size() && "Basic block not found");
3920 V = FunctionBBs[ID];
3921 } else
3922 V = ValueList[ID];
3923
3924 if (!V->hasUseList())
3925 break;
3926
3927 unsigned NumUses = 0;
3928 SmallDenseMap<const Use *, unsigned, 16> Order;
3929 for (const Use &U : V->materialized_uses()) {
3930 if (++NumUses > Record.size())
3931 break;
3932 Order[&U] = Record[NumUses - 1];
3933 }
3934 if (Order.size() != Record.size() || NumUses > Record.size())
3935 // Mismatches can happen if the functions are being materialized lazily
3936 // (out-of-order), or a value has been upgraded.
3937 break;
3938
3939 V->sortUseList([&](const Use &L, const Use &R) {
3940 return Order.lookup(&L) < Order.lookup(&R);
3941 });
3942 break;
3943 }
3944 }
3945 }
3946}
3947
3948/// When we see the block for metadata, remember where it is and then skip it.
3949/// This lets us lazily deserialize the metadata.
3950Error BitcodeReader::rememberAndSkipMetadata() {
3951 // Save the current stream state.
3952 uint64_t CurBit = Stream.GetCurrentBitNo();
3953 DeferredMetadataInfo.push_back(CurBit);
3954
3955 // Skip over the block for now.
3956 if (Error Err = Stream.SkipBlock())
3957 return Err;
3958 return Error::success();
3959}
3960
3961Error BitcodeReader::materializeMetadata() {
3962 for (uint64_t BitPos : DeferredMetadataInfo) {
3963 // Move the bit stream to the saved position.
3964 if (Error JumpFailed = Stream.JumpToBit(BitPos))
3965 return JumpFailed;
3966 if (Error Err = MDLoader->parseModuleMetadata())
3967 return Err;
3968 }
3969
3970 // Upgrade "Linker Options" module flag to "llvm.linker.options" module-level
3971 // metadata. Only upgrade if the new option doesn't exist to avoid upgrade
3972 // multiple times.
3973 if (!TheModule->getNamedMetadata("llvm.linker.options")) {
3974 if (Metadata *Val = TheModule->getModuleFlag("Linker Options")) {
3975 NamedMDNode *LinkerOpts =
3976 TheModule->getOrInsertNamedMetadata("llvm.linker.options");
3977 for (const MDOperand &MDOptions : cast<MDNode>(Val)->operands())
3978 LinkerOpts->addOperand(cast<MDNode>(MDOptions));
3979 }
3980 }
3981
3982 DeferredMetadataInfo.clear();
3983 return Error::success();
3984}
3985
3986void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }
3987
3988/// When we see the block for a function body, remember where it is and then
3989/// skip it. This lets us lazily deserialize the functions.
3990Error BitcodeReader::rememberAndSkipFunctionBody() {
3991 // Get the function we are talking about.
3992 if (FunctionsWithBodies.empty())
3993 return error("Insufficient function protos");
3994
3995 Function *Fn = FunctionsWithBodies.back();
3996 FunctionsWithBodies.pop_back();
3997
3998 // Save the current stream state.
3999 uint64_t CurBit = Stream.GetCurrentBitNo();
4000 assert(
4001 (DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&
4002 "Mismatch between VST and scanned function offsets");
4003 DeferredFunctionInfo[Fn] = CurBit;
4004
4005 // Skip over the function block for now.
4006 if (Error Err = Stream.SkipBlock())
4007 return Err;
4008 return Error::success();
4009}
4010
4011Error BitcodeReader::globalCleanup() {
4012 // Patch the initializers for globals and aliases up.
4013 if (Error Err = resolveGlobalAndIndirectSymbolInits())
4014 return Err;
4015 if (!GlobalInits.empty() || !IndirectSymbolInits.empty())
4016 return error("Malformed global initializer set");
4017
4018 // Look for intrinsic functions which need to be upgraded at some point
4019 // and functions that need to have their function attributes upgraded.
4020 for (Function &F : *TheModule) {
4021 MDLoader->upgradeDebugIntrinsics(F);
4022 Function *NewFn;
4023 if (UpgradeIntrinsicFunction(&F, NewFn))
4024 UpgradedIntrinsics[&F] = NewFn;
4025 // Look for functions that rely on old function attribute behavior.
4027 }
4028
4029 // Look for global variables which need to be renamed.
4030 std::vector<std::pair<GlobalVariable *, GlobalVariable *>> UpgradedVariables;
4031 for (GlobalVariable &GV : TheModule->globals())
4032 if (GlobalVariable *Upgraded = UpgradeGlobalVariable(&GV))
4033 UpgradedVariables.emplace_back(&GV, Upgraded);
4034 for (auto &Pair : UpgradedVariables) {
4035 Pair.first->eraseFromParent();
4036 TheModule->insertGlobalVariable(Pair.second);
4037 }
4038
4039 // Force deallocation of memory for these vectors to favor the client that
4040 // want lazy deserialization.
4041 std::vector<std::pair<GlobalVariable *, unsigned>>().swap(GlobalInits);
4042 std::vector<std::pair<GlobalValue *, unsigned>>().swap(IndirectSymbolInits);
4043 return Error::success();
4044}
4045
4046/// Support for lazy parsing of function bodies. This is required if we
4047/// either have an old bitcode file without a VST forward declaration record,
4048/// or if we have an anonymous function being materialized, since anonymous
4049/// functions do not have a name and are therefore not in the VST.
4050Error BitcodeReader::rememberAndSkipFunctionBodies() {
4051 if (Error JumpFailed = Stream.JumpToBit(NextUnreadBit))
4052 return JumpFailed;
4053
4054 if (Stream.AtEndOfStream())
4055 return error("Could not find function in stream");
4056
4057 if (!SeenFirstFunctionBody)
4058 return error("Trying to materialize functions before seeing function blocks");
4059
4060 // An old bitcode file with the symbol table at the end would have
4061 // finished the parse greedily.
4062 assert(SeenValueSymbolTable);
4063
4064 while (true) {
4065 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
4066 if (!MaybeEntry)
4067 return MaybeEntry.takeError();
4068 llvm::BitstreamEntry Entry = MaybeEntry.get();
4069
4070 switch (Entry.Kind) {
4071 default:
4072 return error("Expect SubBlock");
4074 switch (Entry.ID) {
4075 default:
4076 return error("Expect function block");
4078 if (Error Err = rememberAndSkipFunctionBody())
4079 return Err;
4080 NextUnreadBit = Stream.GetCurrentBitNo();
4081 return Error::success();
4082 }
4083 }
4084 }
4085}
4086
4087Error BitcodeReaderBase::readBlockInfo() {
4088 Expected<std::optional<BitstreamBlockInfo>> MaybeNewBlockInfo =
4089 Stream.ReadBlockInfoBlock();
4090 if (!MaybeNewBlockInfo)
4091 return MaybeNewBlockInfo.takeError();
4092 std::optional<BitstreamBlockInfo> NewBlockInfo =
4093 std::move(MaybeNewBlockInfo.get());
4094 if (!NewBlockInfo)
4095 return error("Malformed block");
4096 BlockInfo = std::move(*NewBlockInfo);
4097 return Error::success();
4098}
4099
4100Error BitcodeReader::parseComdatRecord(ArrayRef<uint64_t> Record) {
4101 // v1: [selection_kind, name]
4102 // v2: [strtab_offset, strtab_size, selection_kind]
4103 StringRef Name;
4104 std::tie(Name, Record) = readNameFromStrtab(Record);
4105
4106 if (Record.empty())
4107 return error("Invalid comdat record");
4109 std::string OldFormatName;
4110 if (!UseStrtab) {
4111 if (Record.size() < 2)
4112 return error("Invalid comdat record");
4113 unsigned ComdatNameSize = Record[1];
4114 if (ComdatNameSize > Record.size() - 2)
4115 return error("Comdat name size too large");
4116 OldFormatName.reserve(ComdatNameSize);
4117 for (unsigned i = 0; i != ComdatNameSize; ++i)
4118 OldFormatName += (char)Record[2 + i];
4119 Name = OldFormatName;
4120 }
4121 Comdat *C = TheModule->getOrInsertComdat(Name);
4122 C->setSelectionKind(SK);
4123 ComdatList.push_back(C);
4124 return Error::success();
4125}
4126
4127static void inferDSOLocal(GlobalValue *GV) {
4128 // infer dso_local from linkage and visibility if it is not encoded.
4129 if (GV->hasLocalLinkage() ||
4131 GV->setDSOLocal(true);
4132}
4133
4136 if (V & (1 << 0))
4137 Meta.NoAddress = true;
4138 if (V & (1 << 1))
4139 Meta.NoHWAddress = true;
4140 if (V & (1 << 2))
4141 Meta.Memtag = true;
4142 if (V & (1 << 3))
4143 Meta.IsDynInit = true;
4144 return Meta;
4145}
4146
4147Error BitcodeReader::parseGlobalVarRecord(ArrayRef<uint64_t> Record) {
4148 // v1: [pointer type, isconst, initid, linkage, alignment, section,
4149 // visibility, threadlocal, unnamed_addr, externally_initialized,
4150 // dllstorageclass, comdat, attributes, preemption specifier,
4151 // partition strtab offset, partition strtab size] (name in VST)
4152 // v2: [strtab_offset, strtab_size, v1]
4153 // v3: [v2, code_model]
4154 StringRef Name;
4155 std::tie(Name, Record) = readNameFromStrtab(Record);
4156
4157 if (Record.size() < 6)
4158 return error("Invalid global variable record");
4159 unsigned TyID = Record[0];
4160 Type *Ty = getTypeByID(TyID);
4161 if (!Ty)
4162 return error("Invalid global variable record");
4163 bool isConstant = Record[1] & 1;
4164 bool explicitType = Record[1] & 2;
4165 unsigned AddressSpace;
4166 if (explicitType) {
4167 AddressSpace = Record[1] >> 2;
4168 } else {
4169 if (!Ty->isPointerTy())
4170 return error("Invalid type for value");
4171 AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
4172 TyID = getContainedTypeID(TyID);
4173 Ty = getTypeByID(TyID);
4174 if (!Ty)
4175 return error("Missing element type for old-style global");
4176 }
4177
4178 uint64_t RawLinkage = Record[3];
4180 MaybeAlign Alignment;
4181 if (Error Err = parseAlignmentValue(Record[4], Alignment))
4182 return Err;
4183 std::string Section;
4184 if (Record[5]) {
4185 if (Record[5] - 1 >= SectionTable.size())
4186 return error("Invalid ID");
4187 Section = SectionTable[Record[5] - 1];
4188 }
4190 // Local linkage must have default visibility.
4191 // auto-upgrade `hidden` and `protected` for old bitcode.
4192 if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
4193 Visibility = getDecodedVisibility(Record[6]);
4194
4195 GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
4196 if (Record.size() > 7)
4197 TLM = getDecodedThreadLocalMode(Record[7]);
4198
4199 GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;
4200 if (Record.size() > 8)
4201 UnnamedAddr = getDecodedUnnamedAddrType(Record[8]);
4202
4203 bool ExternallyInitialized = false;
4204 if (Record.size() > 9)
4205 ExternallyInitialized = Record[9];
4206
4207 GlobalVariable *NewGV =
4208 new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, Name,
4209 nullptr, TLM, AddressSpace, ExternallyInitialized);
4210 if (Alignment)
4211 NewGV->setAlignment(*Alignment);
4212 if (!Section.empty())
4213 NewGV->setSection(Section);
4214 NewGV->setVisibility(Visibility);
4215 NewGV->setUnnamedAddr(UnnamedAddr);
4216
4217 if (Record.size() > 10) {
4218 // A GlobalValue with local linkage cannot have a DLL storage class.
4219 if (!NewGV->hasLocalLinkage()) {
4221 }
4222 } else {
4223 upgradeDLLImportExportLinkage(NewGV, RawLinkage);
4224 }
4225
4226 ValueList.push_back(NewGV, getVirtualTypeID(NewGV->getType(), TyID));
4227
4228 // Remember which value to use for the global initializer.
4229 if (unsigned InitID = Record[2])
4230 GlobalInits.push_back(std::make_pair(NewGV, InitID - 1));
4231
4232 if (Record.size() > 11) {
4233 if (unsigned ComdatID = Record[11]) {
4234 if (ComdatID > ComdatList.size())
4235 return error("Invalid global variable comdat ID");
4236 NewGV->setComdat(ComdatList[ComdatID - 1]);
4237 }
4238 } else if (hasImplicitComdat(RawLinkage)) {
4239 ImplicitComdatObjects.insert(NewGV);
4240 }
4241
4242 if (Record.size() > 12) {
4243 auto AS = getAttributes(Record[12]).getFnAttrs();
4244 NewGV->setAttributes(AS);
4245 }
4246
4247 if (Record.size() > 13) {
4248 NewGV->setDSOLocal(getDecodedDSOLocal(Record[13]));
4249 }
4250 inferDSOLocal(NewGV);
4251
4252 // Check whether we have enough values to read a partition name.
4253 if (Record.size() > 15)
4254 NewGV->setPartition(StringRef(Strtab.data() + Record[14], Record[15]));
4255
4256 if (Record.size() > 16 && Record[16]) {
4257 llvm::GlobalValue::SanitizerMetadata Meta =
4258 deserializeSanitizerMetadata(Record[16]);
4259 NewGV->setSanitizerMetadata(Meta);
4260 }
4261
4262 if (Record.size() > 17 && Record[17]) {
4263 if (auto CM = getDecodedCodeModel(Record[17]))
4264 NewGV->setCodeModel(*CM);
4265 else
4266 return error("Invalid global variable code model");
4267 }
4268
4269 return Error::success();
4270}
4271
4272void BitcodeReader::callValueTypeCallback(Value *F, unsigned TypeID) {
4273 if (ValueTypeCallback) {
4274 (*ValueTypeCallback)(
4275 F, TypeID, [this](unsigned I) { return getTypeByID(I); },
4276 [this](unsigned I, unsigned J) { return getContainedTypeID(I, J); });
4277 }
4278}
4279
4280Error BitcodeReader::parseFunctionRecord(ArrayRef<uint64_t> Record) {
4281 // v1: [type, callingconv, isproto, linkage, paramattr, alignment, section,
4282 // visibility, gc, unnamed_addr, prologuedata, dllstorageclass, comdat,
4283 // prefixdata, personalityfn, preemption specifier, addrspace] (name in VST)
4284 // v2: [strtab_offset, strtab_size, v1]
4285 StringRef Name;
4286 std::tie(Name, Record) = readNameFromStrtab(Record);
4287
4288 if (Record.size() < 8)
4289 return error("Invalid function record");
4290 unsigned FTyID = Record[0];
4291 Type *FTy = getTypeByID(FTyID);
4292 if (!FTy)
4293 return error("Invalid function record");
4294 if (isa<PointerType>(FTy)) {
4295 FTyID = getContainedTypeID(FTyID, 0);
4296 FTy = getTypeByID(FTyID);
4297 if (!FTy)
4298 return error("Missing element type for old-style function");
4299 }
4300
4301 if (!isa<FunctionType>(FTy))
4302 return error("Invalid type for value");
4303 auto CC = static_cast<CallingConv::ID>(Record[1]);
4304 if (CC & ~CallingConv::MaxID)
4305 return error("Invalid calling convention ID");
4306
4307 unsigned AddrSpace = TheModule->getDataLayout().getProgramAddressSpace();
4308 if (Record.size() > 16)
4309 AddrSpace = Record[16];
4310
4311 Function *Func =
4313 AddrSpace, Name, TheModule);
4314
4315 assert(Func->getFunctionType() == FTy &&
4316 "Incorrect fully specified type provided for function");
4317 FunctionTypeIDs[Func] = FTyID;
4318
4319 Func->setCallingConv(CC);
4320 bool isProto = Record[2];
4321 uint64_t RawLinkage = Record[3];
4322 Func->setLinkage(getDecodedLinkage(RawLinkage));
4323 Func->setAttributes(getAttributes(Record[4]));
4324 callValueTypeCallback(Func, FTyID);
4325
4326 // Upgrade any old-style byval or sret without a type by propagating the
4327 // argument's pointee type. There should be no opaque pointers where the byval
4328 // type is implicit.
4329 for (unsigned i = 0; i != Func->arg_size(); ++i) {
4330 for (Attribute::AttrKind Kind : {Attribute::ByVal, Attribute::StructRet,
4331 Attribute::InAlloca}) {
4332 if (!Func->hasParamAttribute(i, Kind))
4333 continue;
4334
4335 if (Func->getParamAttribute(i, Kind).getValueAsType())
4336 continue;
4337
4338 Func->removeParamAttr(i, Kind);
4339
4340 unsigned ParamTypeID = getContainedTypeID(FTyID, i + 1);
4341 Type *PtrEltTy = getPtrElementTypeByID(ParamTypeID);
4342 if (!PtrEltTy)
4343 return error("Missing param element type for attribute upgrade");
4344
4345 Attribute NewAttr;
4346 switch (Kind) {
4347 case Attribute::ByVal:
4348 NewAttr = Attribute::getWithByValType(Context, PtrEltTy);
4349 break;
4350 case Attribute::StructRet:
4351 NewAttr = Attribute::getWithStructRetType(Context, PtrEltTy);
4352 break;
4353 case Attribute::InAlloca:
4354 NewAttr = Attribute::getWithInAllocaType(Context, PtrEltTy);
4355 break;
4356 default:
4357 llvm_unreachable("not an upgraded type attribute");
4358 }
4359
4360 Func->addParamAttr(i, NewAttr);
4361 }
4362 }
4363
4364 if (Func->getCallingConv() == CallingConv::X86_INTR &&
4365 !Func->arg_empty() && !Func->hasParamAttribute(0, Attribute::ByVal)) {
4366 unsigned ParamTypeID = getContainedTypeID(FTyID, 1);
4367 Type *ByValTy = getPtrElementTypeByID(ParamTypeID);
4368 if (!ByValTy)
4369 return error("Missing param element type for x86_intrcc upgrade");
4370 Attribute NewAttr = Attribute::getWithByValType(Context, ByValTy);
4371 Func->addParamAttr(0, NewAttr);
4372 }
4373
4374 MaybeAlign Alignment;
4375 if (Error Err = parseAlignmentValue(Record[5], Alignment))
4376 return Err;
4377 if (Alignment)
4378 Func->setAlignment(*Alignment);
4379 if (Record[6]) {
4380 if (Record[6] - 1 >= SectionTable.size())
4381 return error("Invalid ID");
4382 Func->setSection(SectionTable[Record[6] - 1]);
4383 }
4384 // Local linkage must have default visibility.
4385 // auto-upgrade `hidden` and `protected` for old bitcode.
4386 if (!Func->hasLocalLinkage())
4387 Func->setVisibility(getDecodedVisibility(Record[7]));
4388 if (Record.size() > 8 && Record[8]) {
4389 if (Record[8] - 1 >= GCTable.size())
4390 return error("Invalid ID");
4391 Func->setGC(GCTable[Record[8] - 1]);
4392 }
4393 GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;
4394 if (Record.size() > 9)
4395 UnnamedAddr = getDecodedUnnamedAddrType(Record[9]);
4396 Func->setUnnamedAddr(UnnamedAddr);
4397
4398 FunctionOperandInfo OperandInfo = {Func, 0, 0, 0};
4399 if (Record.size() > 10)
4400 OperandInfo.Prologue = Record[10];
4401
4402 if (Record.size() > 11) {
4403 // A GlobalValue with local linkage cannot have a DLL storage class.
4404 if (!Func->hasLocalLinkage()) {
4405 Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));
4406 }
4407 } else {
4408 upgradeDLLImportExportLinkage(Func, RawLinkage);
4409 }
4410
4411 if (Record.size() > 12) {
4412 if (unsigned ComdatID = Record[12]) {
4413 if (ComdatID > ComdatList.size())
4414 return error("Invalid function comdat ID");
4415 Func->setComdat(ComdatList[ComdatID - 1]);
4416 }
4417 } else if (hasImplicitComdat(RawLinkage)) {
4418 ImplicitComdatObjects.insert(Func);
4419 }
4420
4421 if (Record.size() > 13)
4422 OperandInfo.Prefix = Record[13];
4423
4424 if (Record.size() > 14)
4425 OperandInfo.PersonalityFn = Record[14];
4426
4427 if (Record.size() > 15) {
4428 Func->setDSOLocal(getDecodedDSOLocal(Record[15]));
4429 }
4430 inferDSOLocal(Func);
4431
4432 // Record[16] is the address space number.
4433
4434 // Check whether we have enough values to read a partition name. Also make
4435 // sure Strtab has enough values.
4436 if (Record.size() > 18 && Strtab.data() &&
4437 Record[17] + Record[18] <= Strtab.size()) {
4438 Func->setPartition(StringRef(Strtab.data() + Record[17], Record[18]));
4439 }
4440
4441 if (Record.size() > 19) {
4442 MaybeAlign PrefAlignment;
4443 if (Error Err = parseAlignmentValue(Record[19], PrefAlignment))
4444 return Err;
4445 Func->setPreferredAlignment(PrefAlignment);
4446 }
4447
4448 ValueList.push_back(Func, getVirtualTypeID(Func->getType(), FTyID));
4449
4450 if (OperandInfo.PersonalityFn || OperandInfo.Prefix || OperandInfo.Prologue)
4451 FunctionOperands.push_back(OperandInfo);
4452
4453 // If this is a function with a body, remember the prototype we are
4454 // creating now, so that we can match up the body with them later.
4455 if (!isProto) {
4456 Func->setIsMaterializable(true);
4457 FunctionsWithBodies.push_back(Func);
4458 DeferredFunctionInfo[Func] = 0;
4459 }
4460 return Error::success();
4461}
4462
4463Error BitcodeReader::parseGlobalIndirectSymbolRecord(
4464 unsigned BitCode, ArrayRef<uint64_t> Record) {
4465 // v1 ALIAS_OLD: [alias type, aliasee val#, linkage] (name in VST)
4466 // v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, visibility,
4467 // dllstorageclass, threadlocal, unnamed_addr,
4468 // preemption specifier] (name in VST)
4469 // v1 IFUNC: [alias type, addrspace, aliasee val#, linkage,
4470 // visibility, dllstorageclass, threadlocal, unnamed_addr,
4471 // preemption specifier] (name in VST)
4472 // v2: [strtab_offset, strtab_size, v1]
4473 StringRef Name;
4474 std::tie(Name, Record) = readNameFromStrtab(Record);
4475
4476 bool NewRecord = BitCode != bitc::MODULE_CODE_ALIAS_OLD;
4477 if (Record.size() < (3 + (unsigned)NewRecord))
4478 return error("Invalid global indirect symbol record");
4479 unsigned OpNum = 0;
4480 unsigned TypeID = Record[OpNum++];
4481 Type *Ty = getTypeByID(TypeID);
4482 if (!Ty)
4483 return error("Invalid global indirect symbol record");
4484
4485 unsigned AddrSpace;
4486 if (!NewRecord) {
4487 auto *PTy = dyn_cast<PointerType>(Ty);
4488 if (!PTy)
4489 return error("Invalid type for value");
4490 AddrSpace = PTy->getAddressSpace();
4491 TypeID = getContainedTypeID(TypeID);
4492 Ty = getTypeByID(TypeID);
4493 if (!Ty)
4494 return error("Missing element type for old-style indirect symbol");
4495 } else {
4496 AddrSpace = Record[OpNum++];
4497 }
4498
4499 auto Val = Record[OpNum++];
4500 auto Linkage = Record[OpNum++];
4501 GlobalValue *NewGA;
4502 if (BitCode == bitc::MODULE_CODE_ALIAS ||
4503 BitCode == bitc::MODULE_CODE_ALIAS_OLD)
4504 NewGA = GlobalAlias::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,
4505 TheModule);
4506 else
4507 NewGA = GlobalIFunc::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,
4508 nullptr, TheModule);
4509
4510 // Local linkage must have default visibility.
4511 // auto-upgrade `hidden` and `protected` for old bitcode.
4512 if (OpNum != Record.size()) {
4513 auto VisInd = OpNum++;
4514 if (!NewGA->hasLocalLinkage())
4515 NewGA->setVisibility(getDecodedVisibility(Record[VisInd]));
4516 }
4517 if (BitCode == bitc::MODULE_CODE_ALIAS ||
4518 BitCode == bitc::MODULE_CODE_ALIAS_OLD) {
4519 if (OpNum != Record.size()) {
4520 auto S = Record[OpNum++];
4521 // A GlobalValue with local linkage cannot have a DLL storage class.
4522 if (!NewGA->hasLocalLinkage())
4524 }
4525 else
4527 if (OpNum != Record.size())
4528 NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[OpNum++]));
4529 if (OpNum != Record.size())
4530 NewGA->setUnnamedAddr(getDecodedUnnamedAddrType(Record[OpNum++]));
4531 }
4532 if (OpNum != Record.size())
4533 NewGA->setDSOLocal(getDecodedDSOLocal(Record[OpNum++]));
4534 inferDSOLocal(NewGA);
4535
4536 // Check whether we have enough values to read a partition name.
4537 if (OpNum + 1 < Record.size()) {
4538 // Check Strtab has enough values for the partition.
4539 if (Record[OpNum] + Record[OpNum + 1] > Strtab.size())
4540 return error("Malformed partition, too large.");
4541 NewGA->setPartition(
4542 StringRef(Strtab.data() + Record[OpNum], Record[OpNum + 1]));
4543 }
4544
4545 ValueList.push_back(NewGA, getVirtualTypeID(NewGA->getType(), TypeID));
4546 IndirectSymbolInits.push_back(std::make_pair(NewGA, Val));
4547 return Error::success();
4548}
4549
4550Error BitcodeReader::parseModule(uint64_t ResumeBit,
4551 bool ShouldLazyLoadMetadata,
4552 ParserCallbacks Callbacks) {
4553 this->ValueTypeCallback = std::move(Callbacks.ValueType);
4554 if (ResumeBit) {
4555 if (Error JumpFailed = Stream.JumpToBit(ResumeBit))
4556 return JumpFailed;
4557 } else if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
4558 return Err;
4559
4560 SmallVector<uint64_t, 64> Record;
4561
4562 // Parts of bitcode parsing depend on the datalayout. Make sure we
4563 // finalize the datalayout before we run any of that code.
4564 bool ResolvedDataLayout = false;
4565 // In order to support importing modules with illegal data layout strings,
4566 // delay parsing the data layout string until after upgrades and overrides
4567 // have been applied, allowing to fix illegal data layout strings.
4568 // Initialize to the current module's layout string in case none is specified.
4569 std::string TentativeDataLayoutStr = TheModule->getDataLayoutStr();
4570
4571 auto ResolveDataLayout = [&]() -> Error {
4572 if (ResolvedDataLayout)
4573 return Error::success();
4574
4575 // Datalayout and triple can't be parsed after this point.
4576 ResolvedDataLayout = true;
4577
4578 // Auto-upgrade the layout string
4579 TentativeDataLayoutStr = llvm::UpgradeDataLayoutString(
4580 TentativeDataLayoutStr, TheModule->getTargetTriple().str());
4581
4582 // Apply override
4583 if (Callbacks.DataLayout) {
4584 if (auto LayoutOverride = (*Callbacks.DataLayout)(
4585 TheModule->getTargetTriple().str(), TentativeDataLayoutStr))
4586 TentativeDataLayoutStr = *LayoutOverride;
4587 }
4588
4589 // Now the layout string is finalized in TentativeDataLayoutStr. Parse it.
4590 Expected<DataLayout> MaybeDL = DataLayout::parse(TentativeDataLayoutStr);
4591 if (!MaybeDL)
4592 return MaybeDL.takeError();
4593
4594 TheModule->setDataLayout(MaybeDL.get());
4595 return Error::success();
4596 };
4597
4598 // Read all the records for this module.
4599 while (true) {
4600 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
4601 if (!MaybeEntry)
4602 return MaybeEntry.takeError();
4603 llvm::BitstreamEntry Entry = MaybeEntry.get();
4604
4605 switch (Entry.Kind) {
4607 return error("Malformed block");
4609 if (Error Err = ResolveDataLayout())
4610 return Err;
4611 return globalCleanup();
4612
4614 switch (Entry.ID) {
4615 default: // Skip unknown content.
4616 if (Error Err = Stream.SkipBlock())
4617 return Err;
4618 break;
4620 if (Error Err = readBlockInfo())
4621 return Err;
4622 break;
4624 if (Error Err = parseAttributeBlock())
4625 return Err;
4626 break;
4628 if (Error Err = parseAttributeGroupBlock())
4629 return Err;
4630 break;
4632 if (Error Err = parseTypeTable())
4633 return Err;
4634 break;
4636 if (!SeenValueSymbolTable) {
4637 // Either this is an old form VST without function index and an
4638 // associated VST forward declaration record (which would have caused
4639 // the VST to be jumped to and parsed before it was encountered
4640 // normally in the stream), or there were no function blocks to
4641 // trigger an earlier parsing of the VST.
4642 assert(VSTOffset == 0 || FunctionsWithBodies.empty());
4643 if (Error Err = parseValueSymbolTable())
4644 return Err;
4645 SeenValueSymbolTable = true;
4646 } else {
4647 // We must have had a VST forward declaration record, which caused
4648 // the parser to jump to and parse the VST earlier.
4649 assert(VSTOffset > 0);
4650 if (Error Err = Stream.SkipBlock())
4651 return Err;
4652 }
4653 break;
4655 if (Error Err = parseConstants())
4656 return Err;
4657 if (Error Err = resolveGlobalAndIndirectSymbolInits())
4658 return Err;
4659 break;
4661 if (ShouldLazyLoadMetadata) {
4662 if (Error Err = rememberAndSkipMetadata())
4663 return Err;
4664 break;
4665 }
4666 assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");
4667 if (Error Err = MDLoader->parseModuleMetadata())
4668 return Err;
4669 break;
4671 if (Error Err = MDLoader->parseMetadataKinds())
4672 return Err;
4673 break;
4675 if (Error Err = ResolveDataLayout())
4676 return Err;
4677
4678 // If this is the first function body we've seen, reverse the
4679 // FunctionsWithBodies list.
4680 if (!SeenFirstFunctionBody) {
4681 std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
4682 if (Error Err = globalCleanup())
4683 return Err;
4684 SeenFirstFunctionBody = true;
4685 }
4686
4687 if (VSTOffset > 0) {
4688 // If we have a VST forward declaration record, make sure we
4689 // parse the VST now if we haven't already. It is needed to
4690 // set up the DeferredFunctionInfo vector for lazy reading.
4691 if (!SeenValueSymbolTable) {
4692 if (Error Err = BitcodeReader::parseValueSymbolTable(VSTOffset))
4693 return Err;
4694 SeenValueSymbolTable = true;
4695 // Fall through so that we record the NextUnreadBit below.
4696 // This is necessary in case we have an anonymous function that
4697 // is later materialized. Since it will not have a VST entry we
4698 // need to fall back to the lazy parse to find its offset.
4699 } else {
4700 // If we have a VST forward declaration record, but have already
4701 // parsed the VST (just above, when the first function body was
4702 // encountered here), then we are resuming the parse after
4703 // materializing functions. The ResumeBit points to the
4704 // start of the last function block recorded in the
4705 // DeferredFunctionInfo map. Skip it.
4706 if (Error Err = Stream.SkipBlock())
4707 return Err;
4708 continue;
4709 }
4710 }
4711
4712 // Support older bitcode files that did not have the function
4713 // index in the VST, nor a VST forward declaration record, as
4714 // well as anonymous functions that do not have VST entries.
4715 // Build the DeferredFunctionInfo vector on the fly.
4716 if (Error Err = rememberAndSkipFunctionBody())
4717 return Err;
4718
4719 // Suspend parsing when we reach the function bodies. Subsequent
4720 // materialization calls will resume it when necessary. If the bitcode
4721 // file is old, the symbol table will be at the end instead and will not
4722 // have been seen yet. In this case, just finish the parse now.
4723 if (SeenValueSymbolTable) {
4724 NextUnreadBit = Stream.GetCurrentBitNo();
4725 // After the VST has been parsed, we need to make sure intrinsic name
4726 // are auto-upgraded.
4727 return globalCleanup();
4728 }
4729 break;
4731 if (Error Err = parseUseLists())
4732 return Err;
4733 break;
4735 if (Error Err = parseOperandBundleTags())
4736 return Err;
4737 break;
4739 if (Error Err = parseSyncScopeNames())
4740 return Err;
4741 break;
4742 }
4743 continue;
4744
4746 // The interesting case.
4747 break;
4748 }
4749
4750 // Read a record.
4751 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
4752 if (!MaybeBitCode)
4753 return MaybeBitCode.takeError();
4754 switch (unsigned BitCode = MaybeBitCode.get()) {
4755 default: break; // Default behavior, ignore unknown content.
4757 Expected<unsigned> VersionOrErr = parseVersionRecord(Record);
4758 if (!VersionOrErr)
4759 return VersionOrErr.takeError();
4760 UseRelativeIDs = *VersionOrErr >= 1;
4761 break;
4762 }
4763 case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]
4764 if (ResolvedDataLayout)
4765 return error("target triple too late in module");
4766 std::string S;
4767 if (convertToString(Record, 0, S))
4768 return error("Invalid triple record");
4769 TheModule->setTargetTriple(Triple(std::move(S)));
4770 break;
4771 }
4772 case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]
4773 if (ResolvedDataLayout)
4774 return error("datalayout too late in module");
4775 if (convertToString(Record, 0, TentativeDataLayoutStr))
4776 return error("Invalid data layout record");
4777 break;
4778 }
4779 case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]
4780 std::string S;
4781 if (convertToString(Record, 0, S))
4782 return error("Invalid asm record");
4783 TheModule->setModuleInlineAsm(S);
4784 break;
4785 }
4786 case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]
4787 // Deprecated, but still needed to read old bitcode files.
4788 std::string S;
4789 if (convertToString(Record, 0, S))
4790 return error("Invalid deplib record");
4791 // Ignore value.
4792 break;
4793 }
4794 case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]
4795 std::string S;
4796 if (convertToString(Record, 0, S))
4797 return error("Invalid section name record");
4798 SectionTable.push_back(S);
4799 break;
4800 }
4801 case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]
4802 std::string S;
4803 if (convertToString(Record, 0, S))
4804 return error("Invalid gcname record");
4805 GCTable.push_back(S);
4806 break;
4807 }
4809 if (Error Err = parseComdatRecord(Record))
4810 return Err;
4811 break;
4812 // FIXME: BitcodeReader should handle {GLOBALVAR, FUNCTION, ALIAS, IFUNC}
4813 // written by ThinLinkBitcodeWriter. See
4814 // `ThinLinkBitcodeWriter::writeSimplifiedModuleInfo` for the format of each
4815 // record
4816 // (https://github.com/llvm/llvm-project/blob/b6a93967d9c11e79802b5e75cec1584d6c8aa472/llvm/lib/Bitcode/Writer/BitcodeWriter.cpp#L4714)
4818 if (Error Err = parseGlobalVarRecord(Record))
4819 return Err;
4820 break;
4822 if (Error Err = ResolveDataLayout())
4823 return Err;
4824 if (Error Err = parseFunctionRecord(Record))
4825 return Err;
4826 break;
4830 if (Error Err = parseGlobalIndirectSymbolRecord(BitCode, Record))
4831 return Err;
4832 break;
4833 /// MODULE_CODE_VSTOFFSET: [offset]
4835 if (Record.empty())
4836 return error("Invalid vstoffset record");
4837 // Note that we subtract 1 here because the offset is relative to one word
4838 // before the start of the identification or module block, which was
4839 // historically always the start of the regular bitcode header.
4840 VSTOffset = Record[0] - 1;
4841 break;
4842 /// MODULE_CODE_SOURCE_FILENAME: [namechar x N]
4844 SmallString<128> ValueName;
4845 if (convertToString(Record, 0, ValueName))
4846 return error("Invalid source filename record");
4847 TheModule->setSourceFileName(ValueName);
4848 break;
4849 }
4850 Record.clear();
4851 }
4852 this->ValueTypeCallback = std::nullopt;
4853 return Error::success();
4854}
4855
4856Error BitcodeReader::parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata,
4857 bool IsImporting,
4858 ParserCallbacks Callbacks) {
4859 TheModule = M;
4860 MetadataLoaderCallbacks MDCallbacks;
4861 MDCallbacks.GetTypeByID = [&](unsigned ID) { return getTypeByID(ID); };
4862 MDCallbacks.GetContainedTypeID = [&](unsigned I, unsigned J) {
4863 return getContainedTypeID(I, J);
4864 };
4865 MDCallbacks.MDType = Callbacks.MDType;
4866 MDLoader = MetadataLoader(Stream, *M, ValueList, IsImporting, MDCallbacks);
4867 return parseModule(0, ShouldLazyLoadMetadata, Callbacks);
4868}
4869
4870Error BitcodeReader::typeCheckLoadStoreInst(Type *ValType, Type *PtrType) {
4871 if (!isa<PointerType>(PtrType))
4872 return error("Load/Store operand is not a pointer type");
4873 if (!PointerType::isLoadableOrStorableType(ValType))
4874 return error("Cannot load/store from pointer");
4875 return Error::success();
4876}
4877
4878Error BitcodeReader::propagateAttributeTypes(CallBase *CB,
4879 ArrayRef<unsigned> ArgTyIDs) {
4880 AttributeList Attrs = CB->getAttributes();
4881 for (unsigned i = 0; i != CB->arg_size(); ++i) {
4882 for (Attribute::AttrKind Kind : {Attribute::ByVal, Attribute::StructRet,
4883 Attribute::InAlloca}) {
4884 if (!Attrs.hasParamAttr(i, Kind) ||
4885 Attrs.getParamAttr(i, Kind).getValueAsType())
4886 continue;
4887
4888 Type *PtrEltTy = getPtrElementTypeByID(ArgTyIDs[i]);
4889 if (!PtrEltTy)
4890 return error("Missing element type for typed attribute upgrade");
4891
4892 Attribute NewAttr;
4893 switch (Kind) {
4894 case Attribute::ByVal:
4895 NewAttr = Attribute::getWithByValType(Context, PtrEltTy);
4896 break;
4897 case Attribute::StructRet:
4898 NewAttr = Attribute::getWithStructRetType(Context, PtrEltTy);
4899 break;
4900 case Attribute::InAlloca:
4901 NewAttr = Attribute::getWithInAllocaType(Context, PtrEltTy);
4902 break;
4903 default:
4904 llvm_unreachable("not an upgraded type attribute");
4905 }
4906
4907 Attrs = Attrs.addParamAttribute(Context, i, NewAttr);
4908 }
4909 }
4910
4911 if (CB->isInlineAsm()) {
4912 const InlineAsm *IA = cast<InlineAsm>(CB->getCalledOperand());
4913 unsigned ArgNo = 0;
4914 for (const InlineAsm::ConstraintInfo &CI : IA->ParseConstraints()) {
4915 if (!CI.hasArg())
4916 continue;
4917
4918 if (CI.isIndirect && !Attrs.getParamElementType(ArgNo)) {
4919 Type *ElemTy = getPtrElementTypeByID(ArgTyIDs[ArgNo]);
4920 if (!ElemTy)
4921 return error("Missing element type for inline asm upgrade");
4922 Attrs = Attrs.addParamAttribute(
4923 Context, ArgNo,
4924 Attribute::get(Context, Attribute::ElementType, ElemTy));
4925 }
4926
4927 ArgNo++;
4928 }
4929 }
4930
4931 switch (CB->getIntrinsicID()) {
4932 case Intrinsic::preserve_array_access_index:
4933 case Intrinsic::preserve_struct_access_index:
4934 case Intrinsic::aarch64_ldaxr:
4935 case Intrinsic::aarch64_ldxr:
4936 case Intrinsic::aarch64_stlxr:
4937 case Intrinsic::aarch64_stxr:
4938 case Intrinsic::arm_ldaex:
4939 case Intrinsic::arm_ldrex:
4940 case Intrinsic::arm_stlex:
4941 case Intrinsic::arm_strex: {
4942 unsigned ArgNo;
4943 switch (CB->getIntrinsicID()) {
4944 case Intrinsic::aarch64_stlxr:
4945 case Intrinsic::aarch64_stxr:
4946 case Intrinsic::arm_stlex:
4947 case Intrinsic::arm_strex:
4948 ArgNo = 1;
4949 break;
4950 default:
4951 ArgNo = 0;
4952 break;
4953 }
4954 if (!Attrs.getParamElementType(ArgNo)) {
4955 Type *ElTy = getPtrElementTypeByID(ArgTyIDs[ArgNo]);
4956 if (!ElTy)
4957 return error("Missing element type for elementtype upgrade");
4958 Attribute NewAttr = Attribute::get(Context, Attribute::ElementType, ElTy);
4959 Attrs = Attrs.addParamAttribute(Context, ArgNo, NewAttr);
4960 }
4961 break;
4962 }
4963 default:
4964 break;
4965 }
4966
4967 CB->setAttributes(Attrs);
4968 return Error::success();
4969}
4970
4971/// Lazily parse the specified function body block.
4972Error BitcodeReader::parseFunctionBody(Function *F) {
4974 return Err;
4975
4976 // Unexpected unresolved metadata when parsing function.
4977 if (MDLoader->hasFwdRefs())
4978 return error("Invalid function metadata: incoming forward references");
4979
4980 InstructionList.clear();
4981 unsigned ModuleValueListSize = ValueList.size();
4982 unsigned ModuleMDLoaderSize = MDLoader->size();
4983
4984 // Add all the function arguments to the value table.
4985 unsigned ArgNo = 0;
4986 unsigned FTyID = FunctionTypeIDs[F];
4987 for (Argument &I : F->args()) {
4988 unsigned ArgTyID = getContainedTypeID(FTyID, ArgNo + 1);
4989 assert(I.getType() == getTypeByID(ArgTyID) &&
4990 "Incorrect fully specified type for Function Argument");
4991 ValueList.push_back(&I, ArgTyID);
4992 ++ArgNo;
4993 }
4994 unsigned NextValueNo = ValueList.size();
4995 BasicBlock *CurBB = nullptr;
4996 unsigned CurBBNo = 0;
4997 // Block into which constant expressions from phi nodes are materialized.
4998 BasicBlock *PhiConstExprBB = nullptr;
4999 // Edge blocks for phi nodes into which constant expressions have been
5000 // expanded.
5001 SmallMapVector<std::pair<BasicBlock *, BasicBlock *>, BasicBlock *, 4>
5002 ConstExprEdgeBBs;
5003
5004 DebugLoc LastLoc;
5005 auto getLastInstruction = [&]() -> Instruction * {
5006 if (CurBB && !CurBB->empty())
5007 return &CurBB->back();
5008 else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
5009 !FunctionBBs[CurBBNo - 1]->empty())
5010 return &FunctionBBs[CurBBNo - 1]->back();
5011 return nullptr;
5012 };
5013
5014 std::vector<OperandBundleDef> OperandBundles;
5015
5016 // Read all the records.
5017 SmallVector<uint64_t, 64> Record;
5018
5019 while (true) {
5020 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
5021 if (!MaybeEntry)
5022 return MaybeEntry.takeError();
5023 llvm::BitstreamEntry Entry = MaybeEntry.get();
5024
5025 switch (Entry.Kind) {
5027 return error("Malformed block");
5029 goto OutOfRecordLoop;
5030
5032 switch (Entry.ID) {
5033 default: // Skip unknown content.
5034 if (Error Err = Stream.SkipBlock())
5035 return Err;
5036 break;
5038 if (Error Err = parseConstants())
5039 return Err;
5040 NextValueNo = ValueList.size();
5041 break;
5043 if (Error Err = parseValueSymbolTable())
5044 return Err;
5045 break;
5047 if (Error Err = MDLoader->parseMetadataAttachment(*F, InstructionList))
5048 return Err;
5049 break;
5051 assert(DeferredMetadataInfo.empty() &&
5052 "Must read all module-level metadata before function-level");
5053 if (Error Err = MDLoader->parseFunctionMetadata())
5054 return Err;
5055 break;
5057 if (Error Err = parseUseLists())
5058 return Err;
5059 break;
5060 }
5061 continue;
5062
5064 // The interesting case.
5065 break;
5066 }
5067
5068 // Read a record.
5069 Record.clear();
5070 Instruction *I = nullptr;
5071 unsigned ResTypeID = InvalidTypeID;
5072 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
5073 if (!MaybeBitCode)
5074 return MaybeBitCode.takeError();
5075 switch (unsigned BitCode = MaybeBitCode.get()) {
5076 default: // Default behavior: reject
5077 return error("Invalid value");
5078 case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]
5079 if (Record.empty() || Record[0] == 0)
5080 return error("Invalid declareblocks record");
5081 // Create all the basic blocks for the function.
5082 FunctionBBs.resize(Record[0]);
5083
5084 // See if anything took the address of blocks in this function.
5085 auto BBFRI = BasicBlockFwdRefs.find(F);
5086 if (BBFRI == BasicBlockFwdRefs.end()) {
5087 for (BasicBlock *&BB : FunctionBBs)
5088 BB = BasicBlock::Create(Context, "", F);
5089 } else {
5090 auto &BBRefs = BBFRI->second;
5091 // Check for invalid basic block references.
5092 if (BBRefs.size() > FunctionBBs.size())
5093 return error("Invalid ID");
5094 assert(!BBRefs.empty() && "Unexpected empty array");
5095 assert(!BBRefs.front() && "Invalid reference to entry block");
5096 for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
5097 ++I)
5098 if (I < RE && BBRefs[I]) {
5099 BBRefs[I]->insertInto(F);
5100 FunctionBBs[I] = BBRefs[I];
5101 } else {
5102 FunctionBBs[I] = BasicBlock::Create(Context, "", F);
5103 }
5104
5105 // Erase from the table.
5106 BasicBlockFwdRefs.erase(BBFRI);
5107 }
5108
5109 CurBB = FunctionBBs[0];
5110 continue;
5111 }
5112
5113 case bitc::FUNC_CODE_BLOCKADDR_USERS: // BLOCKADDR_USERS: [vals...]
5114 // The record should not be emitted if it's an empty list.
5115 if (Record.empty())
5116 return error("Invalid blockaddr users record");
5117 // When we have the RARE case of a BlockAddress Constant that is not
5118 // scoped to the Function it refers to, we need to conservatively
5119 // materialize the referred to Function, regardless of whether or not
5120 // that Function will ultimately be linked, otherwise users of
5121 // BitcodeReader might start splicing out Function bodies such that we
5122 // might no longer be able to materialize the BlockAddress since the
5123 // BasicBlock (and entire body of the Function) the BlockAddress refers
5124 // to may have been moved. In the case that the user of BitcodeReader
5125 // decides ultimately not to link the Function body, materializing here
5126 // could be considered wasteful, but it's better than a deserialization
5127 // failure as described. This keeps BitcodeReader unaware of complex
5128 // linkage policy decisions such as those use by LTO, leaving those
5129 // decisions "one layer up."
5130 for (uint64_t ValID : Record)
5131 if (auto *F = dyn_cast<Function>(ValueList[ValID]))
5132 BackwardRefFunctions.push_back(F);
5133 else
5134 return error("Invalid blockaddr users record");
5135
5136 continue;
5137
5138 case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN
5139 // This record indicates that the last instruction is at the same
5140 // location as the previous instruction with a location.
5141 I = getLastInstruction();
5142
5143 if (!I)
5144 return error("Invalid debug_loc_again record");
5145 I->setDebugLoc(LastLoc);
5146 I = nullptr;
5147 continue;
5148
5149 case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]
5150 I = getLastInstruction();
5151 if (!I || Record.size() < 4)
5152 return error("Invalid debug loc record");
5153
5154 unsigned Line = Record[0], Col = Record[1];
5155 unsigned ScopeID = Record[2], IAID = Record[3];
5156 bool isImplicitCode = Record.size() >= 5 && Record[4];
5157 uint64_t AtomGroup = Record.size() == 7 ? Record[5] : 0;
5158 uint8_t AtomRank = Record.size() == 7 ? Record[6] : 0;
5159
5160 MDNode *Scope = nullptr, *IA = nullptr;
5161 if (ScopeID) {
5163 MDLoader->getMetadataFwdRefOrLoad(ScopeID - 1));
5164 if (!Scope)
5165 return error("Invalid debug loc record");
5166 }
5167 if (IAID) {
5169 MDLoader->getMetadataFwdRefOrLoad(IAID - 1));
5170 if (!IA)
5171 return error("Invalid debug loc record");
5172 }
5173
5174 LastLoc = DILocation::get(Scope->getContext(), Line, Col, Scope, IA,
5175 isImplicitCode, AtomGroup, AtomRank);
5176 I->setDebugLoc(LastLoc);
5177 I = nullptr;
5178 continue;
5179 }
5180 case bitc::FUNC_CODE_INST_UNOP: { // UNOP: [opval, ty, opcode]
5181 unsigned OpNum = 0;
5182 Value *LHS;
5183 unsigned TypeID;
5184 if (getValueTypePair(Record, OpNum, NextValueNo, LHS, TypeID, CurBB) ||
5185 OpNum+1 > Record.size())
5186 return error("Invalid unary operator record");
5187
5188 int Opc = getDecodedUnaryOpcode(Record[OpNum++], LHS->getType());
5189 if (Opc == -1)
5190 return error("Invalid unary operator record");
5192 ResTypeID = TypeID;
5193 InstructionList.push_back(I);
5194 if (OpNum < Record.size()) {
5195 if (isa<FPMathOperator>(I)) {
5196 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
5197 if (FMF.any())
5198 I->setFastMathFlags(FMF);
5199 }
5200 }
5201 break;
5202 }
5203 case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]
5204 unsigned OpNum = 0;
5205 Value *LHS, *RHS;
5206 unsigned TypeID;
5207 if (getValueTypePair(Record, OpNum, NextValueNo, LHS, TypeID, CurBB) ||
5208 popValue(Record, OpNum, NextValueNo, LHS->getType(), TypeID, RHS,
5209 CurBB) ||
5210 OpNum+1 > Record.size())
5211 return error("Invalid binary operator record");
5212
5213 int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
5214 if (Opc == -1)
5215 return error("Invalid binary operator record");
5217 ResTypeID = TypeID;
5218 InstructionList.push_back(I);
5219 if (OpNum < Record.size()) {
5220 if (Opc == Instruction::Add ||
5221 Opc == Instruction::Sub ||
5222 Opc == Instruction::Mul ||
5223 Opc == Instruction::Shl) {
5224 if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
5225 cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
5226 if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
5227 cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
5228 } else if (Opc == Instruction::SDiv ||
5229 Opc == Instruction::UDiv ||
5230 Opc == Instruction::LShr ||
5231 Opc == Instruction::AShr) {
5232 if (Record[OpNum] & (1 << bitc::PEO_EXACT))
5233 cast<BinaryOperator>(I)->setIsExact(true);
5234 } else if (Opc == Instruction::Or) {
5235 if (Record[OpNum] & (1 << bitc::PDI_DISJOINT))
5236 cast<PossiblyDisjointInst>(I)->setIsDisjoint(true);
5237 } else if (isa<FPMathOperator>(I)) {
5238 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
5239 if (FMF.any())
5240 I->setFastMathFlags(FMF);
5241 }
5242 }
5243 break;
5244 }
5245 case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]
5246 unsigned OpNum = 0;
5247 Value *Op;
5248 unsigned OpTypeID;
5249 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB) ||
5250 OpNum + 1 > Record.size())
5251 return error("Invalid cast record");
5252
5253 ResTypeID = Record[OpNum++];
5254 Type *ResTy = getTypeByID(ResTypeID);
5255 int Opc = getDecodedCastOpcode(Record[OpNum++]);
5256
5257 if (Opc == -1 || !ResTy)
5258 return error("Invalid cast record");
5259 Instruction *Temp = nullptr;
5260 if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
5261 if (Temp) {
5262 InstructionList.push_back(Temp);
5263 assert(CurBB && "No current BB?");
5264 Temp->insertInto(CurBB, CurBB->end());
5265 }
5266 } else {
5267 auto CastOp = (Instruction::CastOps)Opc;
5268 if (!CastInst::castIsValid(CastOp, Op, ResTy))
5269 return error("Invalid cast");
5270 I = CastInst::Create(CastOp, Op, ResTy);
5271 }
5272
5273 if (OpNum < Record.size()) {
5274 if (Opc == Instruction::ZExt || Opc == Instruction::UIToFP) {
5275 if (Record[OpNum] & (1 << bitc::PNNI_NON_NEG))
5276 cast<PossiblyNonNegInst>(I)->setNonNeg(true);
5277 } else if (Opc == Instruction::Trunc) {
5278 if (Record[OpNum] & (1 << bitc::TIO_NO_UNSIGNED_WRAP))
5279 cast<TruncInst>(I)->setHasNoUnsignedWrap(true);
5280 if (Record[OpNum] & (1 << bitc::TIO_NO_SIGNED_WRAP))
5281 cast<TruncInst>(I)->setHasNoSignedWrap(true);
5282 }
5283 if (isa<FPMathOperator>(I)) {
5284 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
5285 if (FMF.any())
5286 I->setFastMathFlags(FMF);
5287 }
5288 }
5289
5290 InstructionList.push_back(I);
5291 break;
5292 }
5295 case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]
5296 unsigned OpNum = 0;
5297
5298 unsigned TyID;
5299 Type *Ty;
5300 GEPNoWrapFlags NW;
5301
5302 if (BitCode == bitc::FUNC_CODE_INST_GEP) {
5303 NW = toGEPNoWrapFlags(Record[OpNum++]);
5304 TyID = Record[OpNum++];
5305 Ty = getTypeByID(TyID);
5306 } else {
5309 TyID = InvalidTypeID;
5310 Ty = nullptr;
5311 }
5312
5313 Value *BasePtr;
5314 unsigned BasePtrTypeID;
5315 if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr, BasePtrTypeID,
5316 CurBB))
5317 return error("Invalid gep record");
5318
5319 if (!Ty) {
5320 TyID = getContainedTypeID(BasePtrTypeID);
5321 if (BasePtr->getType()->isVectorTy())
5322 TyID = getContainedTypeID(TyID);
5323 Ty = getTypeByID(TyID);
5324 }
5325
5326 SmallVector<Value*, 16> GEPIdx;
5327 while (OpNum != Record.size()) {
5328 Value *Op;
5329 unsigned OpTypeID;
5330 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))
5331 return error("Invalid gep record");
5332 GEPIdx.push_back(Op);
5333 }
5334
5335 auto *GEP = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);
5336 I = GEP;
5337
5338 ResTypeID = TyID;
5339 if (cast<GEPOperator>(I)->getNumIndices() != 0) {
5340 auto GTI = std::next(gep_type_begin(I));
5341 for (Value *Idx : drop_begin(cast<GEPOperator>(I)->indices())) {
5342 unsigned SubType = 0;
5343 if (GTI.isStruct()) {
5344 ConstantInt *IdxC =
5345 Idx->getType()->isVectorTy()
5347 : cast<ConstantInt>(Idx);
5348 SubType = IdxC->getZExtValue();
5349 }
5350 ResTypeID = getContainedTypeID(ResTypeID, SubType);
5351 ++GTI;
5352 }
5353 }
5354
5355 // At this point ResTypeID is the result element type. We need a pointer
5356 // or vector of pointer to it.
5357 ResTypeID = getVirtualTypeID(I->getType()->getScalarType(), ResTypeID);
5358 if (I->getType()->isVectorTy())
5359 ResTypeID = getVirtualTypeID(I->getType(), ResTypeID);
5360
5361 InstructionList.push_back(I);
5362 GEP->setNoWrapFlags(NW);
5363 break;
5364 }
5365
5367 // EXTRACTVAL: [opty, opval, n x indices]
5368 unsigned OpNum = 0;
5369 Value *Agg;
5370 unsigned AggTypeID;
5371 if (getValueTypePair(Record, OpNum, NextValueNo, Agg, AggTypeID, CurBB))
5372 return error("Invalid extractvalue record");
5373 Type *Ty = Agg->getType();
5374
5375 unsigned RecSize = Record.size();
5376 if (OpNum == RecSize)
5377 return error("EXTRACTVAL: Invalid instruction with 0 indices");
5378
5379 SmallVector<unsigned, 4> EXTRACTVALIdx;
5380 ResTypeID = AggTypeID;
5381 for (; OpNum != RecSize; ++OpNum) {
5382 bool IsArray = Ty->isArrayTy();
5383 bool IsStruct = Ty->isStructTy();
5384 uint64_t Index = Record[OpNum];
5385
5386 if (!IsStruct && !IsArray)
5387 return error("EXTRACTVAL: Invalid type");
5388 if ((unsigned)Index != Index)
5389 return error("Invalid value");
5390 if (IsStruct && Index >= Ty->getStructNumElements())
5391 return error("EXTRACTVAL: Invalid struct index");
5392 if (IsArray && Index >= Ty->getArrayNumElements())
5393 return error("EXTRACTVAL: Invalid array index");
5394 EXTRACTVALIdx.push_back((unsigned)Index);
5395
5396 if (IsStruct) {
5397 Ty = Ty->getStructElementType(Index);
5398 ResTypeID = getContainedTypeID(ResTypeID, Index);
5399 } else {
5400 Ty = Ty->getArrayElementType();
5401 ResTypeID = getContainedTypeID(ResTypeID);
5402 }
5403 }
5404
5405 I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
5406 InstructionList.push_back(I);
5407 break;
5408 }
5409
5411 // INSERTVAL: [opty, opval, opty, opval, n x indices]
5412 unsigned OpNum = 0;
5413 Value *Agg;
5414 unsigned AggTypeID;
5415 if (getValueTypePair(Record, OpNum, NextValueNo, Agg, AggTypeID, CurBB))
5416 return error("Invalid insertvalue record");
5417 Value *Val;
5418 unsigned ValTypeID;
5419 if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))
5420 return error("Invalid insertvalue record");
5421
5422 unsigned RecSize = Record.size();
5423 if (OpNum == RecSize)
5424 return error("INSERTVAL: Invalid instruction with 0 indices");
5425
5426 SmallVector<unsigned, 4> INSERTVALIdx;
5427 Type *CurTy = Agg->getType();
5428 for (; OpNum != RecSize; ++OpNum) {
5429 bool IsArray = CurTy->isArrayTy();
5430 bool IsStruct = CurTy->isStructTy();
5431 uint64_t Index = Record[OpNum];
5432
5433 if (!IsStruct && !IsArray)
5434 return error("INSERTVAL: Invalid type");
5435 if ((unsigned)Index != Index)
5436 return error("Invalid value");
5437 if (IsStruct && Index >= CurTy->getStructNumElements())
5438 return error("INSERTVAL: Invalid struct index");
5439 if (IsArray && Index >= CurTy->getArrayNumElements())
5440 return error("INSERTVAL: Invalid array index");
5441
5442 INSERTVALIdx.push_back((unsigned)Index);
5443 if (IsStruct)
5444 CurTy = CurTy->getStructElementType(Index);
5445 else
5446 CurTy = CurTy->getArrayElementType();
5447 }
5448
5449 if (CurTy != Val->getType())
5450 return error("Inserted value type doesn't match aggregate type");
5451
5452 I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
5453 ResTypeID = AggTypeID;
5454 InstructionList.push_back(I);
5455 break;
5456 }
5457
5458 case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
5459 // obsolete form of select
5460 // handles select i1 ... in old bitcode
5461 unsigned OpNum = 0;
5463 unsigned TypeID;
5464 Type *CondType = Type::getInt1Ty(Context);
5465 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal, TypeID,
5466 CurBB) ||
5467 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), TypeID,
5468 FalseVal, CurBB) ||
5469 popValue(Record, OpNum, NextValueNo, CondType,
5470 getVirtualTypeID(CondType), Cond, CurBB))
5471 return error("Invalid select record");
5472
5473 I = SelectInst::Create(Cond, TrueVal, FalseVal);
5474 ResTypeID = TypeID;
5475 InstructionList.push_back(I);
5476 break;
5477 }
5478
5479 case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
5480 // new form of select
5481 // handles select i1 or select [N x i1]
5482 unsigned OpNum = 0;
5484 unsigned ValTypeID, CondTypeID;
5485 if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal, ValTypeID,
5486 CurBB) ||
5487 popValue(Record, OpNum, NextValueNo, TrueVal->getType(), ValTypeID,
5488 FalseVal, CurBB) ||
5489 getValueTypePair(Record, OpNum, NextValueNo, Cond, CondTypeID, CurBB))
5490 return error("Invalid vector select record");
5491
5492 // select condition can be either i1 or [N x i1]
5493 if (VectorType* vector_type =
5494 dyn_cast<VectorType>(Cond->getType())) {
5495 // expect <n x i1>
5496 if (vector_type->getElementType() != Type::getInt1Ty(Context))
5497 return error("Invalid type for value");
5498 } else {
5499 // expect i1
5500 if (Cond->getType() != Type::getInt1Ty(Context))
5501 return error("Invalid type for value");
5502 }
5503
5504 I = SelectInst::Create(Cond, TrueVal, FalseVal);
5505 ResTypeID = ValTypeID;
5506 InstructionList.push_back(I);
5507 if (OpNum < Record.size() && isa<FPMathOperator>(I)) {
5508 FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);
5509 if (FMF.any())
5510 I->setFastMathFlags(FMF);
5511 }
5512 break;
5513 }
5514
5515 case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
5516 unsigned OpNum = 0;
5517 Value *Vec, *Idx;
5518 unsigned VecTypeID, IdxTypeID;
5519 if (getValueTypePair(Record, OpNum, NextValueNo, Vec, VecTypeID, CurBB) ||
5520 getValueTypePair(Record, OpNum, NextValueNo, Idx, IdxTypeID, CurBB))
5521 return error("Invalid extractelement record");
5522 if (!Vec->getType()->isVectorTy())
5523 return error("Invalid type for value");
5524 I = ExtractElementInst::Create(Vec, Idx);
5525 ResTypeID = getContainedTypeID(VecTypeID);
5526 InstructionList.push_back(I);
5527 break;
5528 }
5529
5530 case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
5531 unsigned OpNum = 0;
5532 Value *Vec, *Elt, *Idx;
5533 unsigned VecTypeID, IdxTypeID;
5534 if (getValueTypePair(Record, OpNum, NextValueNo, Vec, VecTypeID, CurBB))
5535 return error("Invalid insertelement record");
5536 if (!Vec->getType()->isVectorTy())
5537 return error("Invalid type for value");
5538 if (popValue(Record, OpNum, NextValueNo,
5539 cast<VectorType>(Vec->getType())->getElementType(),
5540 getContainedTypeID(VecTypeID), Elt, CurBB) ||
5541 getValueTypePair(Record, OpNum, NextValueNo, Idx, IdxTypeID, CurBB))
5542 return error("Invalid insert element record");
5543 I = InsertElementInst::Create(Vec, Elt, Idx);
5544 ResTypeID = VecTypeID;
5545 InstructionList.push_back(I);
5546 break;
5547 }
5548
5549 case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
5550 unsigned OpNum = 0;
5551 Value *Vec1, *Vec2, *Mask;
5552 unsigned Vec1TypeID;
5553 if (getValueTypePair(Record, OpNum, NextValueNo, Vec1, Vec1TypeID,
5554 CurBB) ||
5555 popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec1TypeID,
5556 Vec2, CurBB))
5557 return error("Invalid shufflevector record");
5558
5559 unsigned MaskTypeID;
5560 if (getValueTypePair(Record, OpNum, NextValueNo, Mask, MaskTypeID, CurBB))
5561 return error("Invalid shufflevector record");
5562 if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())
5563 return error("Invalid type for value");
5564
5565 I = new ShuffleVectorInst(Vec1, Vec2, Mask);
5566 ResTypeID =
5567 getVirtualTypeID(I->getType(), getContainedTypeID(Vec1TypeID));
5568 InstructionList.push_back(I);
5569 break;
5570 }
5571
5572 case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]
5573 // Old form of ICmp/FCmp returning bool
5574 // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
5575 // both legal on vectors but had different behaviour.
5576 case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
5577 // FCmp/ICmp returning bool or vector of bool
5578
5579 unsigned OpNum = 0;
5580 Value *LHS, *RHS;
5581 unsigned LHSTypeID;
5582 if (getValueTypePair(Record, OpNum, NextValueNo, LHS, LHSTypeID, CurBB) ||
5583 popValue(Record, OpNum, NextValueNo, LHS->getType(), LHSTypeID, RHS,
5584 CurBB))
5585 return error("Invalid comparison record");
5586
5587 if (OpNum >= Record.size())
5588 return error(
5589 "Invalid record: operand number exceeded available operands");
5590
5591 CmpInst::Predicate PredVal = CmpInst::Predicate(Record[OpNum]);
5592 bool IsFP = LHS->getType()->isFPOrFPVectorTy();
5593 FastMathFlags FMF;
5594 if (IsFP && Record.size() > OpNum+1)
5595 FMF = getDecodedFastMathFlags(Record[++OpNum]);
5596
5597 if (IsFP) {
5598 if (!CmpInst::isFPPredicate(PredVal))
5599 return error("Invalid fcmp predicate");
5600 I = new FCmpInst(PredVal, LHS, RHS);
5601 } else {
5602 if (!CmpInst::isIntPredicate(PredVal))
5603 return error("Invalid icmp predicate");
5604 I = new ICmpInst(PredVal, LHS, RHS);
5605 if (Record.size() > OpNum + 1 &&
5606 (Record[++OpNum] & (1 << bitc::ICMP_SAME_SIGN)))
5607 cast<ICmpInst>(I)->setSameSign();
5608 }
5609
5610 if (OpNum + 1 != Record.size())
5611 return error("Invalid comparison record");
5612
5613 ResTypeID = getVirtualTypeID(I->getType()->getScalarType());
5614 if (LHS->getType()->isVectorTy())
5615 ResTypeID = getVirtualTypeID(I->getType(), ResTypeID);
5616
5617 if (FMF.any())
5618 I->setFastMathFlags(FMF);
5619 InstructionList.push_back(I);
5620 break;
5621 }
5622
5623 case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
5624 {
5625 unsigned Size = Record.size();
5626 if (Size == 0) {
5628 InstructionList.push_back(I);
5629 break;
5630 }
5631
5632 unsigned OpNum = 0;
5633 Value *Op = nullptr;
5634 unsigned OpTypeID;
5635 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))
5636 return error("Invalid ret record");
5637 if (OpNum != Record.size())
5638 return error("Invalid ret record");
5639
5641 InstructionList.push_back(I);
5642 break;
5643 }
5644 case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
5645 if (Record.size() != 1 && Record.size() != 3)
5646 return error("Invalid br record");
5647 BasicBlock *TrueDest = getBasicBlock(Record[0]);
5648 if (!TrueDest)
5649 return error("Invalid br record");
5650
5651 if (Record.size() == 1) {
5652 I = UncondBrInst::Create(TrueDest);
5653 InstructionList.push_back(I);
5654 }
5655 else {
5656 BasicBlock *FalseDest = getBasicBlock(Record[1]);
5657 Type *CondType = Type::getInt1Ty(Context);
5658 Value *Cond = getValue(Record, 2, NextValueNo, CondType,
5659 getVirtualTypeID(CondType), CurBB);
5660 if (!FalseDest || !Cond)
5661 return error("Invalid br record");
5662 I = CondBrInst::Create(Cond, TrueDest, FalseDest);
5663 InstructionList.push_back(I);
5664 }
5665 break;
5666 }
5667 case bitc::FUNC_CODE_INST_CLEANUPRET: { // CLEANUPRET: [val] or [val,bb#]
5668 if (Record.size() != 1 && Record.size() != 2)
5669 return error("Invalid cleanupret record");
5670 unsigned Idx = 0;
5671 Type *TokenTy = Type::getTokenTy(Context);
5672 Value *CleanupPad = getValue(Record, Idx++, NextValueNo, TokenTy,
5673 getVirtualTypeID(TokenTy), CurBB);
5674 if (!CleanupPad)
5675 return error("Invalid cleanupret record");
5676 BasicBlock *UnwindDest = nullptr;
5677 if (Record.size() == 2) {
5678 UnwindDest = getBasicBlock(Record[Idx++]);
5679 if (!UnwindDest)
5680 return error("Invalid cleanupret record");
5681 }
5682
5683 I = CleanupReturnInst::Create(CleanupPad, UnwindDest);
5684 InstructionList.push_back(I);
5685 break;
5686 }
5687 case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [val,bb#]
5688 if (Record.size() != 2)
5689 return error("Invalid catchret record");
5690 unsigned Idx = 0;
5691 Type *TokenTy = Type::getTokenTy(Context);
5692 Value *CatchPad = getValue(Record, Idx++, NextValueNo, TokenTy,
5693 getVirtualTypeID(TokenTy), CurBB);
5694 if (!CatchPad)
5695 return error("Invalid catchret record");
5696 BasicBlock *BB = getBasicBlock(Record[Idx++]);
5697 if (!BB)
5698 return error("Invalid catchret record");
5699
5700 I = CatchReturnInst::Create(CatchPad, BB);
5701 InstructionList.push_back(I);
5702 break;
5703 }
5704 case bitc::FUNC_CODE_INST_CATCHSWITCH: { // CATCHSWITCH: [tok,num,(bb)*,bb?]
5705 // We must have, at minimum, the outer scope and the number of arguments.
5706 if (Record.size() < 2)
5707 return error("Invalid catchswitch record");
5708
5709 unsigned Idx = 0;
5710
5711 Type *TokenTy = Type::getTokenTy(Context);
5712 Value *ParentPad = getValue(Record, Idx++, NextValueNo, TokenTy,
5713 getVirtualTypeID(TokenTy), CurBB);
5714 if (!ParentPad)
5715 return error("Invalid catchswitch record");
5716
5717 unsigned NumHandlers = Record[Idx++];
5718
5720 for (unsigned Op = 0; Op != NumHandlers; ++Op) {
5721 BasicBlock *BB = getBasicBlock(Record[Idx++]);
5722 if (!BB)
5723 return error("Invalid catchswitch record");
5724 Handlers.push_back(BB);
5725 }
5726
5727 BasicBlock *UnwindDest = nullptr;
5728 if (Idx + 1 == Record.size()) {
5729 UnwindDest = getBasicBlock(Record[Idx++]);
5730 if (!UnwindDest)
5731 return error("Invalid catchswitch record");
5732 }
5733
5734 if (Record.size() != Idx)
5735 return error("Invalid catchswitch record");
5736
5737 auto *CatchSwitch =
5738 CatchSwitchInst::Create(ParentPad, UnwindDest, NumHandlers);
5739 for (BasicBlock *Handler : Handlers)
5740 CatchSwitch->addHandler(Handler);
5741 I = CatchSwitch;
5742 ResTypeID = getVirtualTypeID(I->getType());
5743 InstructionList.push_back(I);
5744 break;
5745 }
5747 case bitc::FUNC_CODE_INST_CLEANUPPAD: { // [tok,num,(ty,val)*]
5748 // We must have, at minimum, the outer scope and the number of arguments.
5749 if (Record.size() < 2)
5750 return error("Invalid catchpad/cleanuppad record");
5751
5752 unsigned Idx = 0;
5753
5754 Type *TokenTy = Type::getTokenTy(Context);
5755 Value *ParentPad = getValue(Record, Idx++, NextValueNo, TokenTy,
5756 getVirtualTypeID(TokenTy), CurBB);
5757 if (!ParentPad)
5758 return error("Invalid catchpad/cleanuppad record");
5759
5760 unsigned NumArgOperands = Record[Idx++];
5761
5762 SmallVector<Value *, 2> Args;
5763 for (unsigned Op = 0; Op != NumArgOperands; ++Op) {
5764 Value *Val;
5765 unsigned ValTypeID;
5766 if (getValueTypePair(Record, Idx, NextValueNo, Val, ValTypeID, nullptr))
5767 return error("Invalid catchpad/cleanuppad record");
5768 Args.push_back(Val);
5769 }
5770
5771 if (Record.size() != Idx)
5772 return error("Invalid catchpad/cleanuppad record");
5773
5774 if (BitCode == bitc::FUNC_CODE_INST_CLEANUPPAD)
5775 I = CleanupPadInst::Create(ParentPad, Args);
5776 else
5777 I = CatchPadInst::Create(ParentPad, Args);
5778 ResTypeID = getVirtualTypeID(I->getType());
5779 InstructionList.push_back(I);
5780 break;
5781 }
5782 case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
5783 // Check magic
5784 if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
5785 // "New" SwitchInst format with case ranges. The changes to write this
5786 // format were reverted but we still recognize bitcode that uses it.
5787 // Hopefully someday we will have support for case ranges and can use
5788 // this format again.
5789
5790 unsigned OpTyID = Record[1];
5791 Type *OpTy = getTypeByID(OpTyID);
5792 unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
5793
5794 Value *Cond = getValue(Record, 2, NextValueNo, OpTy, OpTyID, CurBB);
5795 BasicBlock *Default = getBasicBlock(Record[3]);
5796 if (!OpTy || !Cond || !Default)
5797 return error("Invalid switch record");
5798
5799 unsigned NumCases = Record[4];
5800
5801 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
5802 InstructionList.push_back(SI);
5803
5804 unsigned CurIdx = 5;
5805 for (unsigned i = 0; i != NumCases; ++i) {
5807 unsigned NumItems = Record[CurIdx++];
5808 for (unsigned ci = 0; ci != NumItems; ++ci) {
5809 bool isSingleNumber = Record[CurIdx++];
5810
5811 APInt Low;
5812 unsigned ActiveWords = 1;
5813 if (ValueBitWidth > 64)
5814 ActiveWords = Record[CurIdx++];
5815 Low = readWideAPInt(ArrayRef(&Record[CurIdx], ActiveWords),
5816 ValueBitWidth);
5817 CurIdx += ActiveWords;
5818
5819 if (!isSingleNumber) {
5820 ActiveWords = 1;
5821 if (ValueBitWidth > 64)
5822 ActiveWords = Record[CurIdx++];
5823 APInt High = readWideAPInt(ArrayRef(&Record[CurIdx], ActiveWords),
5824 ValueBitWidth);
5825 CurIdx += ActiveWords;
5826
5827 // FIXME: It is not clear whether values in the range should be
5828 // compared as signed or unsigned values. The partially
5829 // implemented changes that used this format in the past used
5830 // unsigned comparisons.
5831 for ( ; Low.ule(High); ++Low)
5832 CaseVals.push_back(ConstantInt::get(Context, Low));
5833 } else
5834 CaseVals.push_back(ConstantInt::get(Context, Low));
5835 }
5836 BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
5837 for (ConstantInt *Cst : CaseVals)
5838 SI->addCase(Cst, DestBB);
5839 }
5840 I = SI;
5841 break;
5842 }
5843
5844 // Old SwitchInst format without case ranges.
5845
5846 if (Record.size() < 3 || (Record.size() & 1) == 0)
5847 return error("Invalid switch record");
5848 unsigned OpTyID = Record[0];
5849 Type *OpTy = getTypeByID(OpTyID);
5850 Value *Cond = getValue(Record, 1, NextValueNo, OpTy, OpTyID, CurBB);
5851 BasicBlock *Default = getBasicBlock(Record[2]);
5852 if (!OpTy || !Cond || !Default)
5853 return error("Invalid switch record");
5854 unsigned NumCases = (Record.size()-3)/2;
5855 SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
5856 InstructionList.push_back(SI);
5857 for (unsigned i = 0, e = NumCases; i != e; ++i) {
5858 ConstantInt *CaseVal = dyn_cast_or_null<ConstantInt>(
5859 getFnValueByID(Record[3+i*2], OpTy, OpTyID, nullptr));
5860 BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
5861 if (!CaseVal || !DestBB) {
5862 delete SI;
5863 return error("Invalid switch record");
5864 }
5865 SI->addCase(CaseVal, DestBB);
5866 }
5867 I = SI;
5868 break;
5869 }
5870 case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
5871 if (Record.size() < 2)
5872 return error("Invalid indirectbr record");
5873 unsigned OpTyID = Record[0];
5874 Type *OpTy = getTypeByID(OpTyID);
5875 Value *Address = getValue(Record, 1, NextValueNo, OpTy, OpTyID, CurBB);
5876 if (!OpTy || !Address)
5877 return error("Invalid indirectbr record");
5878 unsigned NumDests = Record.size()-2;
5879 IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
5880 InstructionList.push_back(IBI);
5881 for (unsigned i = 0, e = NumDests; i != e; ++i) {
5882 if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
5883 IBI->addDestination(DestBB);
5884 } else {
5885 delete IBI;
5886 return error("Invalid indirectbr record");
5887 }
5888 }
5889 I = IBI;
5890 break;
5891 }
5892
5894 // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
5895 if (Record.size() < 4)
5896 return error("Invalid invoke record");
5897 unsigned OpNum = 0;
5898 AttributeList PAL = getAttributes(Record[OpNum++]);
5899 unsigned CCInfo = Record[OpNum++];
5900 BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);
5901 BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);
5902
5903 unsigned FTyID = InvalidTypeID;
5904 FunctionType *FTy = nullptr;
5905 if ((CCInfo >> 13) & 1) {
5906 FTyID = Record[OpNum++];
5907 FTy = dyn_cast<FunctionType>(getTypeByID(FTyID));
5908 if (!FTy)
5909 return error("Explicit invoke type is not a function type");
5910 }
5911
5912 Value *Callee;
5913 unsigned CalleeTypeID;
5914 if (getValueTypePair(Record, OpNum, NextValueNo, Callee, CalleeTypeID,
5915 CurBB))
5916 return error("Invalid invoke record");
5917
5918 PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
5919 if (!CalleeTy)
5920 return error("Callee is not a pointer");
5921 if (!FTy) {
5922 FTyID = getContainedTypeID(CalleeTypeID);
5923 FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));
5924 if (!FTy)
5925 return error("Callee is not of pointer to function type");
5926 }
5927 if (Record.size() < FTy->getNumParams() + OpNum)
5928 return error("Insufficient operands to call");
5929
5930 SmallVector<Value*, 16> Ops;
5931 SmallVector<unsigned, 16> ArgTyIDs;
5932 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
5933 unsigned ArgTyID = getContainedTypeID(FTyID, i + 1);
5934 Ops.push_back(getValue(Record, OpNum, NextValueNo, FTy->getParamType(i),
5935 ArgTyID, CurBB));
5936 ArgTyIDs.push_back(ArgTyID);
5937 if (!Ops.back())
5938 return error("Invalid invoke record");
5939 }
5940
5941 if (!FTy->isVarArg()) {
5942 if (Record.size() != OpNum)
5943 return error("Invalid invoke record");
5944 } else {
5945 // Read type/value pairs for varargs params.
5946 while (OpNum != Record.size()) {
5947 Value *Op;
5948 unsigned OpTypeID;
5949 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))
5950 return error("Invalid invoke record");
5951 Ops.push_back(Op);
5952 ArgTyIDs.push_back(OpTypeID);
5953 }
5954 }
5955
5956 // Upgrade the bundles if needed.
5957 if (!OperandBundles.empty())
5958 UpgradeOperandBundles(OperandBundles);
5959
5960 I = InvokeInst::Create(FTy, Callee, NormalBB, UnwindBB, Ops,
5961 OperandBundles);
5962 ResTypeID = getContainedTypeID(FTyID);
5963 OperandBundles.clear();
5964 InstructionList.push_back(I);
5965 cast<InvokeInst>(I)->setCallingConv(
5966 static_cast<CallingConv::ID>(CallingConv::MaxID & CCInfo));
5967 cast<InvokeInst>(I)->setAttributes(PAL);
5968 if (Error Err = propagateAttributeTypes(cast<CallBase>(I), ArgTyIDs)) {
5969 I->deleteValue();
5970 return Err;
5971 }
5972
5973 break;
5974 }
5975 case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
5976 unsigned Idx = 0;
5977 Value *Val = nullptr;
5978 unsigned ValTypeID;
5979 if (getValueTypePair(Record, Idx, NextValueNo, Val, ValTypeID, CurBB))
5980 return error("Invalid resume record");
5981 I = ResumeInst::Create(Val);
5982 InstructionList.push_back(I);
5983 break;
5984 }
5986 // CALLBR: [attr, cc, norm, transfs, fty, fnid, args]
5987 unsigned OpNum = 0;
5988 AttributeList PAL = getAttributes(Record[OpNum++]);
5989 unsigned CCInfo = Record[OpNum++];
5990
5991 BasicBlock *DefaultDest = getBasicBlock(Record[OpNum++]);
5992 unsigned NumIndirectDests = Record[OpNum++];
5993 SmallVector<BasicBlock *, 16> IndirectDests;
5994 for (unsigned i = 0, e = NumIndirectDests; i != e; ++i)
5995 IndirectDests.push_back(getBasicBlock(Record[OpNum++]));
5996
5997 unsigned FTyID = InvalidTypeID;
5998 FunctionType *FTy = nullptr;
5999 if ((CCInfo >> bitc::CALL_EXPLICIT_TYPE) & 1) {
6000 FTyID = Record[OpNum++];
6001 FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));
6002 if (!FTy)
6003 return error("Explicit call type is not a function type");
6004 }
6005
6006 Value *Callee;
6007 unsigned CalleeTypeID;
6008 if (getValueTypePair(Record, OpNum, NextValueNo, Callee, CalleeTypeID,
6009 CurBB))
6010 return error("Invalid callbr record");
6011
6012 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
6013 if (!OpTy)
6014 return error("Callee is not a pointer type");
6015 if (!FTy) {
6016 FTyID = getContainedTypeID(CalleeTypeID);
6017 FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));
6018 if (!FTy)
6019 return error("Callee is not of pointer to function type");
6020 }
6021 if (Record.size() < FTy->getNumParams() + OpNum)
6022 return error("Insufficient operands to call");
6023
6024 SmallVector<Value*, 16> Args;
6025 SmallVector<unsigned, 16> ArgTyIDs;
6026 // Read the fixed params.
6027 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
6028 Value *Arg;
6029 unsigned ArgTyID = getContainedTypeID(FTyID, i + 1);
6030 if (FTy->getParamType(i)->isLabelTy())
6031 Arg = getBasicBlock(Record[OpNum]);
6032 else
6033 Arg = getValue(Record, OpNum, NextValueNo, FTy->getParamType(i),
6034 ArgTyID, CurBB);
6035 if (!Arg)
6036 return error("Invalid callbr record");
6037 Args.push_back(Arg);
6038 ArgTyIDs.push_back(ArgTyID);
6039 }
6040
6041 // Read type/value pairs for varargs params.
6042 if (!FTy->isVarArg()) {
6043 if (OpNum != Record.size())
6044 return error("Invalid callbr record");
6045 } else {
6046 while (OpNum != Record.size()) {
6047 Value *Op;
6048 unsigned OpTypeID;
6049 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))
6050 return error("Invalid callbr record");
6051 Args.push_back(Op);
6052 ArgTyIDs.push_back(OpTypeID);
6053 }
6054 }
6055
6056 // Upgrade the bundles if needed.
6057 if (!OperandBundles.empty())
6058 UpgradeOperandBundles(OperandBundles);
6059
6060 if (auto *IA = dyn_cast<InlineAsm>(Callee)) {
6061 InlineAsm::ConstraintInfoVector ConstraintInfo = IA->ParseConstraints();
6062 auto IsLabelConstraint = [](const InlineAsm::ConstraintInfo &CI) {
6063 return CI.Type == InlineAsm::isLabel;
6064 };
6065 if (none_of(ConstraintInfo, IsLabelConstraint)) {
6066 // Upgrade explicit blockaddress arguments to label constraints.
6067 // Verify that the last arguments are blockaddress arguments that
6068 // match the indirect destinations. Clang always generates callbr
6069 // in this form. We could support reordering with more effort.
6070 unsigned FirstBlockArg = Args.size() - IndirectDests.size();
6071 for (unsigned ArgNo = FirstBlockArg; ArgNo < Args.size(); ++ArgNo) {
6072 unsigned LabelNo = ArgNo - FirstBlockArg;
6073 auto *BA = dyn_cast<BlockAddress>(Args[ArgNo]);
6074 if (!BA || BA->getFunction() != F ||
6075 LabelNo > IndirectDests.size() ||
6076 BA->getBasicBlock() != IndirectDests[LabelNo])
6077 return error("callbr argument does not match indirect dest");
6078 }
6079
6080 // Remove blockaddress arguments.
6081 Args.erase(Args.begin() + FirstBlockArg, Args.end());
6082 ArgTyIDs.erase(ArgTyIDs.begin() + FirstBlockArg, ArgTyIDs.end());
6083
6084 // Recreate the function type with less arguments.
6085 SmallVector<Type *> ArgTys;
6086 for (Value *Arg : Args)
6087 ArgTys.push_back(Arg->getType());
6088 FTy =
6089 FunctionType::get(FTy->getReturnType(), ArgTys, FTy->isVarArg());
6090
6091 // Update constraint string to use label constraints.
6092 std::string Constraints = IA->getConstraintString().str();
6093 unsigned ArgNo = 0;
6094 size_t Pos = 0;
6095 for (const auto &CI : ConstraintInfo) {
6096 if (CI.hasArg()) {
6097 if (ArgNo >= FirstBlockArg)
6098 Constraints.insert(Pos, "!");
6099 ++ArgNo;
6100 }
6101
6102 // Go to next constraint in string.
6103 Pos = Constraints.find(',', Pos);
6104 if (Pos == std::string::npos)
6105 break;
6106 ++Pos;
6107 }
6108
6109 Callee = InlineAsm::get(FTy, IA->getAsmString(), Constraints,
6110 IA->hasSideEffects(), IA->isAlignStack(),
6111 IA->getDialect(), IA->canThrow());
6112 }
6113 }
6114
6115 I = CallBrInst::Create(FTy, Callee, DefaultDest, IndirectDests, Args,
6116 OperandBundles);
6117 ResTypeID = getContainedTypeID(FTyID);
6118 OperandBundles.clear();
6119 InstructionList.push_back(I);
6120 cast<CallBrInst>(I)->setCallingConv(
6121 static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));
6122 cast<CallBrInst>(I)->setAttributes(PAL);
6123 if (Error Err = propagateAttributeTypes(cast<CallBase>(I), ArgTyIDs)) {
6124 I->deleteValue();
6125 return Err;
6126 }
6127 break;
6128 }
6129 case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
6130 I = new UnreachableInst(Context);
6131 InstructionList.push_back(I);
6132 break;
6133 case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
6134 if (Record.empty())
6135 return error("Invalid phi record");
6136 // The first record specifies the type.
6137 unsigned TyID = Record[0];
6138 Type *Ty = getTypeByID(TyID);
6139 if (!Ty)
6140 return error("Invalid phi record");
6141
6142 // Phi arguments are pairs of records of [value, basic block].
6143 // There is an optional final record for fast-math-flags if this phi has a
6144 // floating-point type.
6145 size_t NumArgs = (Record.size() - 1) / 2;
6146 PHINode *PN = PHINode::Create(Ty, NumArgs);
6147 if ((Record.size() - 1) % 2 == 1 && !isa<FPMathOperator>(PN)) {
6148 PN->deleteValue();
6149 return error("Invalid phi record");
6150 }
6151 InstructionList.push_back(PN);
6152
6153 SmallDenseMap<BasicBlock *, Value *> Args;
6154 for (unsigned i = 0; i != NumArgs; i++) {
6155 BasicBlock *BB = getBasicBlock(Record[i * 2 + 2]);
6156 if (!BB) {
6157 PN->deleteValue();
6158 return error("Invalid phi BB");
6159 }
6160
6161 // Phi nodes may contain the same predecessor multiple times, in which
6162 // case the incoming value must be identical. Directly reuse the already
6163 // seen value here, to avoid expanding a constant expression multiple
6164 // times.
6165 auto It = Args.find(BB);
6166 BasicBlock *EdgeBB = ConstExprEdgeBBs.lookup({BB, CurBB});
6167 if (It != Args.end()) {
6168 // If this predecessor was also replaced with a constexpr basic
6169 // block, it must be de-duplicated.
6170 if (!EdgeBB) {
6171 PN->addIncoming(It->second, BB);
6172 }
6173 continue;
6174 }
6175
6176 // If there already is a block for this edge (from a different phi),
6177 // use it.
6178 if (!EdgeBB) {
6179 // Otherwise, use a temporary block (that we will discard if it
6180 // turns out to be unnecessary).
6181 if (!PhiConstExprBB)
6182 PhiConstExprBB = BasicBlock::Create(Context, "phi.constexpr", F);
6183 EdgeBB = PhiConstExprBB;
6184 }
6185
6186 // With the new function encoding, it is possible that operands have
6187 // negative IDs (for forward references). Use a signed VBR
6188 // representation to keep the encoding small.
6189 Value *V;
6190 if (UseRelativeIDs)
6191 V = getValueSigned(Record, i * 2 + 1, NextValueNo, Ty, TyID, EdgeBB);
6192 else
6193 V = getValue(Record, i * 2 + 1, NextValueNo, Ty, TyID, EdgeBB);
6194 if (!V) {
6195 PN->deleteValue();
6196 PhiConstExprBB->eraseFromParent();
6197 return error("Invalid phi record");
6198 }
6199
6200 if (EdgeBB == PhiConstExprBB && !EdgeBB->empty()) {
6201 ConstExprEdgeBBs.insert({{BB, CurBB}, EdgeBB});
6202 PhiConstExprBB = nullptr;
6203 }
6204 PN->addIncoming(V, BB);
6205 Args.insert({BB, V});
6206 }
6207 I = PN;
6208 ResTypeID = TyID;
6209
6210 // If there are an even number of records, the final record must be FMF.
6211 if (Record.size() % 2 == 0) {
6212 assert(isa<FPMathOperator>(I) && "Unexpected phi type");
6213 FastMathFlags FMF = getDecodedFastMathFlags(Record[Record.size() - 1]);
6214 if (FMF.any())
6215 I->setFastMathFlags(FMF);
6216 }
6217
6218 break;
6219 }
6220
6223 // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
6224 unsigned Idx = 0;
6225 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {
6226 if (Record.size() < 3)
6227 return error("Invalid landingpad record");
6228 } else {
6230 if (Record.size() < 4)
6231 return error("Invalid landingpad record");
6232 }
6233 ResTypeID = Record[Idx++];
6234 Type *Ty = getTypeByID(ResTypeID);
6235 if (!Ty)
6236 return error("Invalid landingpad record");
6237 if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {
6238 Value *PersFn = nullptr;
6239 unsigned PersFnTypeID;
6240 if (getValueTypePair(Record, Idx, NextValueNo, PersFn, PersFnTypeID,
6241 nullptr))
6242 return error("Invalid landingpad record");
6243
6244 if (!F->hasPersonalityFn())
6245 F->setPersonalityFn(cast<Constant>(PersFn));
6246 else if (F->getPersonalityFn() != cast<Constant>(PersFn))
6247 return error("Personality function mismatch");
6248 }
6249
6250 bool IsCleanup = !!Record[Idx++];
6251 unsigned NumClauses = Record[Idx++];
6252 LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);
6253 LP->setCleanup(IsCleanup);
6254 for (unsigned J = 0; J != NumClauses; ++J) {
6256 LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
6257 Value *Val;
6258 unsigned ValTypeID;
6259
6260 if (getValueTypePair(Record, Idx, NextValueNo, Val, ValTypeID,
6261 nullptr)) {
6262 delete LP;
6263 return error("Invalid landingpad record");
6264 }
6265
6267 !isa<ArrayType>(Val->getType())) &&
6268 "Catch clause has a invalid type!");
6270 isa<ArrayType>(Val->getType())) &&
6271 "Filter clause has invalid type!");
6272 LP->addClause(cast<Constant>(Val));
6273 }
6274
6275 I = LP;
6276 InstructionList.push_back(I);
6277 break;
6278 }
6279
6280 case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
6281 if (Record.size() != 4 && Record.size() != 5)
6282 return error("Invalid alloca record");
6283 using APV = AllocaPackedValues;
6284 const uint64_t Rec = Record[3];
6285 const bool InAlloca = Bitfield::get<APV::UsedWithInAlloca>(Rec);
6286 const bool SwiftError = Bitfield::get<APV::SwiftError>(Rec);
6287 unsigned TyID = Record[0];
6288 Type *Ty = getTypeByID(TyID);
6290 TyID = getContainedTypeID(TyID);
6291 Ty = getTypeByID(TyID);
6292 if (!Ty)
6293 return error("Missing element type for old-style alloca");
6294 }
6295 unsigned OpTyID = Record[1];
6296 Type *OpTy = getTypeByID(OpTyID);
6297 Value *Size = getFnValueByID(Record[2], OpTy, OpTyID, CurBB);
6298 MaybeAlign Align;
6299 uint64_t AlignExp =
6301 (Bitfield::get<APV::AlignUpper>(Rec) << APV::AlignLower::Bits);
6302 if (Error Err = parseAlignmentValue(AlignExp, Align)) {
6303 return Err;
6304 }
6305 if (!Ty || !Size)
6306 return error("Invalid alloca record");
6307
6308 const DataLayout &DL = TheModule->getDataLayout();
6309 unsigned AS = Record.size() == 5 ? Record[4] : DL.getAllocaAddrSpace();
6310
6311 SmallPtrSet<Type *, 4> Visited;
6312 if (!Align && !Ty->isSized(&Visited))
6313 return error("alloca of unsized type");
6314 if (!Align)
6315 Align = DL.getPrefTypeAlign(Ty);
6316
6317 if (!Size->getType()->isIntegerTy())
6318 return error("alloca element count must have integer type");
6319
6320 AllocaInst *AI = new AllocaInst(Ty, AS, Size, *Align);
6321 AI->setUsedWithInAlloca(InAlloca);
6322 AI->setSwiftError(SwiftError);
6323 I = AI;
6324 ResTypeID = getVirtualTypeID(AI->getType(), TyID);
6325 InstructionList.push_back(I);
6326 break;
6327 }
6328 case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
6329 unsigned OpNum = 0;
6330 Value *Op;
6331 unsigned OpTypeID;
6332 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB) ||
6333 (OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))
6334 return error("Invalid load record");
6335
6336 if (!isa<PointerType>(Op->getType()))
6337 return error("Load operand is not a pointer type");
6338
6339 Type *Ty = nullptr;
6340 if (OpNum + 3 == Record.size()) {
6341 ResTypeID = Record[OpNum++];
6342 Ty = getTypeByID(ResTypeID);
6343 } else {
6344 ResTypeID = getContainedTypeID(OpTypeID);
6345 Ty = getTypeByID(ResTypeID);
6346 }
6347
6348 if (!Ty)
6349 return error("Missing load type");
6350
6351 if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))
6352 return Err;
6353
6354 MaybeAlign Align;
6355 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
6356 return Err;
6357 SmallPtrSet<Type *, 4> Visited;
6358 if (!Align && !Ty->isSized(&Visited))
6359 return error("load of unsized type");
6360 if (!Align)
6361 Align = TheModule->getDataLayout().getABITypeAlign(Ty);
6362 I = new LoadInst(Ty, Op, "", Record[OpNum + 1], *Align);
6363 InstructionList.push_back(I);
6364 break;
6365 }
6367 // LOADATOMIC: [opty, op, align, vol, ordering, ssid]
6368 unsigned OpNum = 0;
6369 Value *Op;
6370 unsigned OpTypeID;
6371 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB) ||
6372 (OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))
6373 return error("Invalid load atomic record");
6374
6375 if (!isa<PointerType>(Op->getType()))
6376 return error("Load operand is not a pointer type");
6377
6378 Type *Ty = nullptr;
6379 if (OpNum + 5 == Record.size()) {
6380 ResTypeID = Record[OpNum++];
6381 Ty = getTypeByID(ResTypeID);
6382 } else {
6383 ResTypeID = getContainedTypeID(OpTypeID);
6384 Ty = getTypeByID(ResTypeID);
6385 }
6386
6387 if (!Ty)
6388 return error("Missing atomic load type");
6389
6390 if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))
6391 return Err;
6392
6393 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
6394 if (Ordering == AtomicOrdering::NotAtomic ||
6395 Ordering == AtomicOrdering::Release ||
6396 Ordering == AtomicOrdering::AcquireRelease)
6397 return error("Invalid load atomic record");
6398 if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)
6399 return error("Invalid load atomic record");
6400 SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);
6401
6402 MaybeAlign Align;
6403 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
6404 return Err;
6405 if (!Align)
6406 return error("Alignment missing from atomic load");
6407 I = new LoadInst(Ty, Op, "", Record[OpNum + 1], *Align, Ordering, SSID);
6408 InstructionList.push_back(I);
6409 break;
6410 }
6412 case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]
6413 unsigned OpNum = 0;
6414 Value *Val, *Ptr;
6415 unsigned PtrTypeID, ValTypeID;
6416 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))
6417 return error("Invalid store record");
6418
6419 if (BitCode == bitc::FUNC_CODE_INST_STORE) {
6420 if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))
6421 return error("Invalid store record");
6422 } else {
6423 ValTypeID = getContainedTypeID(PtrTypeID);
6424 if (popValue(Record, OpNum, NextValueNo, getTypeByID(ValTypeID),
6425 ValTypeID, Val, CurBB))
6426 return error("Invalid store record");
6427 }
6428
6429 if (OpNum + 2 != Record.size())
6430 return error("Invalid store record");
6431
6432 if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
6433 return Err;
6434 MaybeAlign Align;
6435 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
6436 return Err;
6437 SmallPtrSet<Type *, 4> Visited;
6438 if (!Align && !Val->getType()->isSized(&Visited))
6439 return error("store of unsized type");
6440 if (!Align)
6441 Align = TheModule->getDataLayout().getABITypeAlign(Val->getType());
6442 I = new StoreInst(Val, Ptr, Record[OpNum + 1], *Align);
6443 InstructionList.push_back(I);
6444 break;
6445 }
6448 // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, ssid]
6449 unsigned OpNum = 0;
6450 Value *Val, *Ptr;
6451 unsigned PtrTypeID, ValTypeID;
6452 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB) ||
6453 !isa<PointerType>(Ptr->getType()))
6454 return error("Invalid store atomic record");
6455 if (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC) {
6456 if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))
6457 return error("Invalid store atomic record");
6458 } else {
6459 ValTypeID = getContainedTypeID(PtrTypeID);
6460 if (popValue(Record, OpNum, NextValueNo, getTypeByID(ValTypeID),
6461 ValTypeID, Val, CurBB))
6462 return error("Invalid store atomic record");
6463 }
6464
6465 if (OpNum + 4 != Record.size())
6466 return error("Invalid store atomic record");
6467
6468 if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))
6469 return Err;
6470 AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
6471 if (Ordering == AtomicOrdering::NotAtomic ||
6472 Ordering == AtomicOrdering::Acquire ||
6473 Ordering == AtomicOrdering::AcquireRelease)
6474 return error("Invalid store atomic record");
6475 SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);
6476 if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)
6477 return error("Invalid store atomic record");
6478
6479 MaybeAlign Align;
6480 if (Error Err = parseAlignmentValue(Record[OpNum], Align))
6481 return Err;
6482 if (!Align)
6483 return error("Alignment missing from atomic store");
6484 I = new StoreInst(Val, Ptr, Record[OpNum + 1], *Align, Ordering, SSID);
6485 InstructionList.push_back(I);
6486 break;
6487 }
6489 // CMPXCHG_OLD: [ptrty, ptr, cmp, val, vol, ordering, syncscope,
6490 // failure_ordering?, weak?]
6491 const size_t NumRecords = Record.size();
6492 unsigned OpNum = 0;
6493 Value *Ptr = nullptr;
6494 unsigned PtrTypeID;
6495 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))
6496 return error("Invalid cmpxchg record");
6497
6498 if (!isa<PointerType>(Ptr->getType()))
6499 return error("Cmpxchg operand is not a pointer type");
6500
6501 Value *Cmp = nullptr;
6502 unsigned CmpTypeID = getContainedTypeID(PtrTypeID);
6503 if (popValue(Record, OpNum, NextValueNo, getTypeByID(CmpTypeID),
6504 CmpTypeID, Cmp, CurBB))
6505 return error("Invalid cmpxchg record");
6506
6507 Value *New = nullptr;
6508 if (popValue(Record, OpNum, NextValueNo, Cmp->getType(), CmpTypeID,
6509 New, CurBB) ||
6510 NumRecords < OpNum + 3 || NumRecords > OpNum + 5)
6511 return error("Invalid cmpxchg record");
6512
6513 const AtomicOrdering SuccessOrdering =
6514 getDecodedOrdering(Record[OpNum + 1]);
6515 if (SuccessOrdering == AtomicOrdering::NotAtomic ||
6516 SuccessOrdering == AtomicOrdering::Unordered)
6517 return error("Invalid cmpxchg record");
6518
6519 const SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 2]);
6520
6521 if (Error Err = typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))
6522 return Err;
6523
6524 const AtomicOrdering FailureOrdering =
6525 NumRecords < 7
6527 : getDecodedOrdering(Record[OpNum + 3]);
6528
6529 if (FailureOrdering == AtomicOrdering::NotAtomic ||
6530 FailureOrdering == AtomicOrdering::Unordered)
6531 return error("Invalid cmpxchg record");
6532
6533 const Align Alignment(
6534 TheModule->getDataLayout().getTypeStoreSize(Cmp->getType()));
6535
6536 I = new AtomicCmpXchgInst(Ptr, Cmp, New, Alignment, SuccessOrdering,
6537 FailureOrdering, SSID);
6538 cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
6539
6540 if (NumRecords < 8) {
6541 // Before weak cmpxchgs existed, the instruction simply returned the
6542 // value loaded from memory, so bitcode files from that era will be
6543 // expecting the first component of a modern cmpxchg.
6544 I->insertInto(CurBB, CurBB->end());
6546 ResTypeID = CmpTypeID;
6547 } else {
6548 cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum + 4]);
6549 unsigned I1TypeID = getVirtualTypeID(Type::getInt1Ty(Context));
6550 ResTypeID = getVirtualTypeID(I->getType(), {CmpTypeID, I1TypeID});
6551 }
6552
6553 InstructionList.push_back(I);
6554 break;
6555 }
6557 // CMPXCHG: [ptrty, ptr, cmp, val, vol, success_ordering, syncscope,
6558 // failure_ordering, weak, align?]
6559 const size_t NumRecords = Record.size();
6560 unsigned OpNum = 0;
6561 Value *Ptr = nullptr;
6562 unsigned PtrTypeID;
6563 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))
6564 return error("Invalid cmpxchg record");
6565
6566 if (!isa<PointerType>(Ptr->getType()))
6567 return error("Cmpxchg operand is not a pointer type");
6568
6569 Value *Cmp = nullptr;
6570 unsigned CmpTypeID;
6571 if (getValueTypePair(Record, OpNum, NextValueNo, Cmp, CmpTypeID, CurBB))
6572 return error("Invalid cmpxchg record");
6573
6574 Value *Val = nullptr;
6575 if (popValue(Record, OpNum, NextValueNo, Cmp->getType(), CmpTypeID, Val,
6576 CurBB))
6577 return error("Invalid cmpxchg record");
6578
6579 if (NumRecords < OpNum + 3 || NumRecords > OpNum + 6)
6580 return error("Invalid cmpxchg record");
6581
6582 const bool IsVol = Record[OpNum];
6583
6584 const AtomicOrdering SuccessOrdering =
6585 getDecodedOrdering(Record[OpNum + 1]);
6586 if (!AtomicCmpXchgInst::isValidSuccessOrdering(SuccessOrdering))
6587 return error("Invalid cmpxchg success ordering");
6588
6589 const SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 2]);
6590
6591 if (Error Err = typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))
6592 return Err;
6593
6594 const AtomicOrdering FailureOrdering =
6595 getDecodedOrdering(Record[OpNum + 3]);
6596 if (!AtomicCmpXchgInst::isValidFailureOrdering(FailureOrdering))
6597 return error("Invalid cmpxchg failure ordering");
6598
6599 const bool IsWeak = Record[OpNum + 4];
6600
6601 MaybeAlign Alignment;
6602
6603 if (NumRecords == (OpNum + 6)) {
6604 if (Error Err = parseAlignmentValue(Record[OpNum + 5], Alignment))
6605 return Err;
6606 }
6607 if (!Alignment)
6608 Alignment =
6609 Align(TheModule->getDataLayout().getTypeStoreSize(Cmp->getType()));
6610
6611 I = new AtomicCmpXchgInst(Ptr, Cmp, Val, *Alignment, SuccessOrdering,
6612 FailureOrdering, SSID);
6613 cast<AtomicCmpXchgInst>(I)->setVolatile(IsVol);
6614 cast<AtomicCmpXchgInst>(I)->setWeak(IsWeak);
6615
6616 unsigned I1TypeID = getVirtualTypeID(Type::getInt1Ty(Context));
6617 ResTypeID = getVirtualTypeID(I->getType(), {CmpTypeID, I1TypeID});
6618
6619 InstructionList.push_back(I);
6620 break;
6621 }
6624 // ATOMICRMW_OLD: [ptrty, ptr, val, op, vol, ordering, ssid, align?]
6625 // ATOMICRMW: [ptrty, ptr, valty, val, op, vol, ordering, ssid, align?]
6626 const size_t NumRecords = Record.size();
6627 unsigned OpNum = 0;
6628
6629 Value *Ptr = nullptr;
6630 unsigned PtrTypeID;
6631 if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))
6632 return error("Invalid atomicrmw record");
6633
6634 if (!isa<PointerType>(Ptr->getType()))
6635 return error("Invalid atomicrmw record");
6636
6637 Value *Val = nullptr;
6638 unsigned ValTypeID = InvalidTypeID;
6639 if (BitCode == bitc::FUNC_CODE_INST_ATOMICRMW_OLD) {
6640 ValTypeID = getContainedTypeID(PtrTypeID);
6641 if (popValue(Record, OpNum, NextValueNo,
6642 getTypeByID(ValTypeID), ValTypeID, Val, CurBB))
6643 return error("Invalid atomicrmw record");
6644 } else {
6645 if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))
6646 return error("Invalid atomicrmw record");
6647 }
6648
6649 if (!(NumRecords == (OpNum + 4) || NumRecords == (OpNum + 5)))
6650 return error("Invalid atomicrmw record");
6651
6652 bool IsElementwise = false;
6654 getDecodedRMWOperation(Record[OpNum], IsElementwise);
6657 return error("Invalid atomicrmw record");
6658
6659 const bool IsVol = Record[OpNum + 1];
6660
6661 const AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);
6662 if (Ordering == AtomicOrdering::NotAtomic ||
6663 Ordering == AtomicOrdering::Unordered)
6664 return error("Invalid atomicrmw record");
6665
6666 const SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);
6667
6668 MaybeAlign Alignment;
6669
6670 if (NumRecords == (OpNum + 5)) {
6671 if (Error Err = parseAlignmentValue(Record[OpNum + 4], Alignment))
6672 return Err;
6673 }
6674
6675 if (!Alignment)
6676 Alignment =
6677 Align(TheModule->getDataLayout().getTypeStoreSize(Val->getType()));
6678
6679 I = new AtomicRMWInst(Operation, Ptr, Val, *Alignment, Ordering, SSID,
6680 IsElementwise);
6681 ResTypeID = ValTypeID;
6682 cast<AtomicRMWInst>(I)->setVolatile(IsVol);
6683
6684 InstructionList.push_back(I);
6685 break;
6686 }
6687 case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, ssid]
6688 if (2 != Record.size())
6689 return error("Invalid fence record");
6691 if (Ordering == AtomicOrdering::NotAtomic ||
6692 Ordering == AtomicOrdering::Unordered ||
6693 Ordering == AtomicOrdering::Monotonic)
6694 return error("Invalid fence record");
6695 SyncScope::ID SSID = getDecodedSyncScopeID(Record[1]);
6696 I = new FenceInst(Context, Ordering, SSID);
6697 InstructionList.push_back(I);
6698 break;
6699 }
6701 // DbgLabelRecords are placed after the Instructions that they are
6702 // attached to.
6703 SeenDebugRecord = true;
6704 Instruction *Inst = getLastInstruction();
6705 if (!Inst)
6706 return error("Invalid dbg record: missing instruction");
6707 DILocation *DIL = cast<DILocation>(getFnMetadataByID(Record[0]));
6708 DILabel *Label = cast<DILabel>(getFnMetadataByID(Record[1]));
6709 Inst->getParent()->insertDbgRecordBefore(
6710 new DbgLabelRecord(Label, DebugLoc(DIL)), Inst->getIterator());
6711 continue; // This isn't an instruction.
6712 }
6718 // DbgVariableRecords are placed after the Instructions that they are
6719 // attached to.
6720 SeenDebugRecord = true;
6721 Instruction *Inst = getLastInstruction();
6722 if (!Inst)
6723 return error("Invalid dbg record: missing instruction");
6724
6725 // First 3 fields are common to all kinds:
6726 // DILocation, DILocalVariable, DIExpression
6727 // dbg_value (FUNC_CODE_DEBUG_RECORD_VALUE)
6728 // ..., LocationMetadata
6729 // dbg_value (FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE - abbrev'd)
6730 // ..., Value
6731 // dbg_declare (FUNC_CODE_DEBUG_RECORD_DECLARE)
6732 // ..., LocationMetadata
6733 // dbg_declare_value (FUNC_CODE_DEBUG_RECORD_DECLARE_VALUE)
6734 // ..., LocationMetadata
6735 // dbg_assign (FUNC_CODE_DEBUG_RECORD_ASSIGN)
6736 // ..., LocationMetadata, DIAssignID, DIExpression, LocationMetadata
6737 unsigned Slot = 0;
6738 // Common fields (0-2).
6739 DILocation *DIL = cast<DILocation>(getFnMetadataByID(Record[Slot++]));
6740 DILocalVariable *Var =
6741 cast<DILocalVariable>(getFnMetadataByID(Record[Slot++]));
6742 DIExpression *Expr =
6743 cast<DIExpression>(getFnMetadataByID(Record[Slot++]));
6744
6745 // Union field (3: LocationMetadata | Value).
6746 Metadata *RawLocation = nullptr;
6748 Value *V = nullptr;
6749 unsigned TyID = 0;
6750 // We never expect to see a fwd reference value here because
6751 // use-before-defs are encoded with the standard non-abbrev record
6752 // type (they'd require encoding the type too, and they're rare). As a
6753 // result, getValueTypePair only ever increments Slot by one here (once
6754 // for the value, never twice for value and type).
6755 unsigned SlotBefore = Slot;
6756 if (getValueTypePair(Record, Slot, NextValueNo, V, TyID, CurBB))
6757 return error("Invalid dbg record: invalid value");
6758 (void)SlotBefore;
6759 assert((SlotBefore == Slot - 1) && "unexpected fwd ref");
6760 RawLocation = ValueAsMetadata::get(V);
6761 } else {
6762 RawLocation = getFnMetadataByID(Record[Slot++]);
6763 }
6764
6765 DbgVariableRecord *DVR = nullptr;
6766 switch (BitCode) {
6769 DVR = new DbgVariableRecord(RawLocation, Var, Expr, DIL,
6770 DbgVariableRecord::LocationType::Value);
6771 break;
6773 DVR = new DbgVariableRecord(RawLocation, Var, Expr, DIL,
6774 DbgVariableRecord::LocationType::Declare);
6775 break;
6777 DVR = new DbgVariableRecord(
6778 RawLocation, Var, Expr, DIL,
6779 DbgVariableRecord::LocationType::DeclareValue);
6780 break;
6782 DIAssignID *ID = cast<DIAssignID>(getFnMetadataByID(Record[Slot++]));
6783 DIExpression *AddrExpr =
6784 cast<DIExpression>(getFnMetadataByID(Record[Slot++]));
6785 Metadata *Addr = getFnMetadataByID(Record[Slot++]);
6786 DVR = new DbgVariableRecord(RawLocation, Var, Expr, ID, Addr, AddrExpr,
6787 DIL);
6788 break;
6789 }
6790 default:
6791 llvm_unreachable("Unknown DbgVariableRecord bitcode");
6792 }
6793 Inst->getParent()->insertDbgRecordBefore(DVR, Inst->getIterator());
6794 continue; // This isn't an instruction.
6795 }
6797 // CALL: [paramattrs, cc, fmf, fnty, fnid, arg0, arg1...]
6798 if (Record.size() < 3)
6799 return error("Invalid call record");
6800
6801 unsigned OpNum = 0;
6802 AttributeList PAL = getAttributes(Record[OpNum++]);
6803 unsigned CCInfo = Record[OpNum++];
6804
6805 FastMathFlags FMF;
6806 if ((CCInfo >> bitc::CALL_FMF) & 1) {
6807 FMF = getDecodedFastMathFlags(Record[OpNum++]);
6808 if (!FMF.any())
6809 return error("Fast math flags indicator set for call with no FMF");
6810 }
6811
6812 unsigned FTyID = InvalidTypeID;
6813 FunctionType *FTy = nullptr;
6814 if ((CCInfo >> bitc::CALL_EXPLICIT_TYPE) & 1) {
6815 FTyID = Record[OpNum++];
6816 FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));
6817 if (!FTy)
6818 return error("Explicit call type is not a function type");
6819 }
6820
6821 Value *Callee;
6822 unsigned CalleeTypeID;
6823 if (getValueTypePair(Record, OpNum, NextValueNo, Callee, CalleeTypeID,
6824 CurBB))
6825 return error("Invalid call record");
6826
6827 PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
6828 if (!OpTy)
6829 return error("Callee is not a pointer type");
6830 if (!FTy) {
6831 FTyID = getContainedTypeID(CalleeTypeID);
6832 FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));
6833 if (!FTy)
6834 return error("Callee is not of pointer to function type");
6835 }
6836 if (Record.size() < FTy->getNumParams() + OpNum)
6837 return error("Insufficient operands to call");
6838
6839 SmallVector<Value*, 16> Args;
6840 SmallVector<unsigned, 16> ArgTyIDs;
6841 // Read the fixed params.
6842 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
6843 unsigned ArgTyID = getContainedTypeID(FTyID, i + 1);
6844 if (FTy->getParamType(i)->isLabelTy())
6845 Args.push_back(getBasicBlock(Record[OpNum]));
6846 else
6847 Args.push_back(getValue(Record, OpNum, NextValueNo,
6848 FTy->getParamType(i), ArgTyID, CurBB));
6849 ArgTyIDs.push_back(ArgTyID);
6850 if (!Args.back())
6851 return error("Invalid call record");
6852 }
6853
6854 // Read type/value pairs for varargs params.
6855 if (!FTy->isVarArg()) {
6856 if (OpNum != Record.size())
6857 return error("Invalid call record");
6858 } else {
6859 while (OpNum != Record.size()) {
6860 Value *Op;
6861 unsigned OpTypeID;
6862 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))
6863 return error("Invalid call record");
6864 Args.push_back(Op);
6865 ArgTyIDs.push_back(OpTypeID);
6866 }
6867 }
6868
6869 // Upgrade the bundles if needed.
6870 if (!OperandBundles.empty())
6871 UpgradeOperandBundles(OperandBundles);
6872
6873 I = CallInst::Create(FTy, Callee, Args, OperandBundles);
6874 ResTypeID = getContainedTypeID(FTyID);
6875 OperandBundles.clear();
6876 InstructionList.push_back(I);
6877 cast<CallInst>(I)->setCallingConv(
6878 static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));
6880 if (CCInfo & (1 << bitc::CALL_TAIL))
6881 TCK = CallInst::TCK_Tail;
6882 if (CCInfo & (1 << bitc::CALL_MUSTTAIL))
6884 if (CCInfo & (1 << bitc::CALL_NOTAIL))
6886 cast<CallInst>(I)->setTailCallKind(TCK);
6887 cast<CallInst>(I)->setAttributes(PAL);
6889 SeenDebugIntrinsic = true;
6890 if (Error Err = propagateAttributeTypes(cast<CallBase>(I), ArgTyIDs)) {
6891 I->deleteValue();
6892 return Err;
6893 }
6894 if (FMF.any()) {
6895 if (!isa<FPMathOperator>(I))
6896 return error("Fast-math-flags specified for call without "
6897 "floating-point scalar or vector return type");
6898 I->setFastMathFlags(FMF);
6899 }
6900 break;
6901 }
6902 case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
6903 if (Record.size() < 3)
6904 return error("Invalid va_arg record");
6905 unsigned OpTyID = Record[0];
6906 Type *OpTy = getTypeByID(OpTyID);
6907 Value *Op = getValue(Record, 1, NextValueNo, OpTy, OpTyID, CurBB);
6908 ResTypeID = Record[2];
6909 Type *ResTy = getTypeByID(ResTypeID);
6910 if (!OpTy || !Op || !ResTy)
6911 return error("Invalid va_arg record");
6912 I = new VAArgInst(Op, ResTy);
6913 InstructionList.push_back(I);
6914 break;
6915 }
6916
6918 // A call or an invoke can be optionally prefixed with some variable
6919 // number of operand bundle blocks. These blocks are read into
6920 // OperandBundles and consumed at the next call or invoke instruction.
6921
6922 if (Record.empty() || Record[0] >= BundleTags.size())
6923 return error("Invalid operand bundle record");
6924
6925 std::vector<Value *> Inputs;
6926
6927 unsigned OpNum = 1;
6928 while (OpNum != Record.size()) {
6929 Value *Op;
6930 if (getValueOrMetadata(Record, OpNum, NextValueNo, Op, CurBB))
6931 return error("Invalid operand bundle record");
6932 Inputs.push_back(Op);
6933 }
6934
6935 OperandBundles.emplace_back(BundleTags[Record[0]], std::move(Inputs));
6936 continue;
6937 }
6938
6939 case bitc::FUNC_CODE_INST_FREEZE: { // FREEZE: [opty,opval]
6940 unsigned OpNum = 0;
6941 Value *Op = nullptr;
6942 unsigned OpTypeID;
6943 if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))
6944 return error("Invalid freeze record");
6945 if (OpNum != Record.size())
6946 return error("Invalid freeze record");
6947
6948 I = new FreezeInst(Op);
6949 ResTypeID = OpTypeID;
6950 InstructionList.push_back(I);
6951 break;
6952 }
6953 }
6954
6955 // Add instruction to end of current BB. If there is no current BB, reject
6956 // this file.
6957 if (!CurBB) {
6958 I->deleteValue();
6959 return error("Invalid instruction with no BB");
6960 }
6961 if (!OperandBundles.empty()) {
6962 I->deleteValue();
6963 return error("Operand bundles found with no consumer");
6964 }
6965 I->insertInto(CurBB, CurBB->end());
6966
6967 // If this was a terminator instruction, move to the next block.
6968 if (I->isTerminator()) {
6969 ++CurBBNo;
6970 CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
6971 }
6972
6973 // Non-void values get registered in the value table for future use.
6974 if (!I->getType()->isVoidTy()) {
6975 assert(I->getType() == getTypeByID(ResTypeID) &&
6976 "Incorrect result type ID");
6977 if (Error Err = ValueList.assignValue(NextValueNo++, I, ResTypeID))
6978 return Err;
6979 }
6980 }
6981
6982OutOfRecordLoop:
6983
6984 if (!OperandBundles.empty())
6985 return error("Operand bundles found with no consumer");
6986
6987 // Check the function list for unresolved values.
6988 if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
6989 if (!A->getParent()) {
6990 // We found at least one unresolved value. Nuke them all to avoid leaks.
6991 for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
6992 if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
6993 A->replaceAllUsesWith(PoisonValue::get(A->getType()));
6994 delete A;
6995 }
6996 }
6997 return error("Never resolved value found in function");
6998 }
6999 }
7000
7001 // Unexpected unresolved metadata about to be dropped.
7002 if (MDLoader->hasFwdRefs())
7003 return error("Invalid function metadata: outgoing forward refs");
7004
7005 if (PhiConstExprBB)
7006 PhiConstExprBB->eraseFromParent();
7007
7008 for (const auto &Pair : ConstExprEdgeBBs) {
7009 BasicBlock *From = Pair.first.first;
7010 BasicBlock *To = Pair.first.second;
7011 BasicBlock *EdgeBB = Pair.second;
7012 UncondBrInst::Create(To, EdgeBB);
7013 From->getTerminator()->replaceSuccessorWith(To, EdgeBB);
7014 To->replacePhiUsesWith(From, EdgeBB);
7015 EdgeBB->moveBefore(To);
7016 }
7017
7018 // Trim the value list down to the size it was before we parsed this function.
7019 ValueList.shrinkTo(ModuleValueListSize);
7020 MDLoader->shrinkTo(ModuleMDLoaderSize);
7021 std::vector<BasicBlock*>().swap(FunctionBBs);
7022 return Error::success();
7023}
7024
7025/// Find the function body in the bitcode stream
7026Error BitcodeReader::findFunctionInStream(
7027 Function *F,
7028 DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
7029 while (DeferredFunctionInfoIterator->second == 0) {
7030 // This is the fallback handling for the old format bitcode that
7031 // didn't contain the function index in the VST, or when we have
7032 // an anonymous function which would not have a VST entry.
7033 // Assert that we have one of those two cases.
7034 assert(VSTOffset == 0 || !F->hasName());
7035 // Parse the next body in the stream and set its position in the
7036 // DeferredFunctionInfo map.
7037 if (Error Err = rememberAndSkipFunctionBodies())
7038 return Err;
7039 }
7040 return Error::success();
7041}
7042
7043SyncScope::ID BitcodeReader::getDecodedSyncScopeID(unsigned Val) {
7044 if (Val == SyncScope::SingleThread || Val == SyncScope::System)
7045 return SyncScope::ID(Val);
7046 if (Val >= SSIDs.size())
7047 return SyncScope::System; // Map unknown synchronization scopes to system.
7048 return SSIDs[Val];
7049}
7050
7051//===----------------------------------------------------------------------===//
7052// GVMaterializer implementation
7053//===----------------------------------------------------------------------===//
7054
7055Error BitcodeReader::materialize(GlobalValue *GV) {
7057 // If it's not a function or is already material, ignore the request.
7058 if (!F || !F->isMaterializable())
7059 return Error::success();
7060
7061 DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
7062 assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
7063 // If its position is recorded as 0, its body is somewhere in the stream
7064 // but we haven't seen it yet.
7065 if (DFII->second == 0)
7066 if (Error Err = findFunctionInStream(F, DFII))
7067 return Err;
7068
7069 // Materialize metadata before parsing any function bodies.
7070 if (Error Err = materializeMetadata())
7071 return Err;
7072
7073 // Move the bit stream to the saved position of the deferred function body.
7074 if (Error JumpFailed = Stream.JumpToBit(DFII->second))
7075 return JumpFailed;
7076
7077 if (Error Err = parseFunctionBody(F))
7078 return Err;
7079 F->setIsMaterializable(false);
7080
7081 // All parsed Functions should load into the debug info format dictated by the
7082 // Module.
7083 if (SeenDebugIntrinsic && SeenDebugRecord)
7084 return error("Mixed debug intrinsics and debug records in bitcode module!");
7085
7086 if (StripDebugInfo)
7087 stripDebugInfo(*F);
7088
7089 // Finish fn->subprogram upgrade for materialized functions.
7090 if (DISubprogram *SP = MDLoader->lookupSubprogramForFunction(F))
7091 F->setSubprogram(SP);
7092
7093 // Check if the TBAA Metadata are valid, otherwise we will need to strip them.
7094 if (!MDLoader->isStrippingTBAA()) {
7095 for (auto &I : instructions(F)) {
7096 MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa);
7097 if (!TBAA || TBAAVerifyHelper.visitTBAAMetadata(&I, TBAA))
7098 continue;
7099 MDLoader->setStripTBAA(true);
7100 stripTBAA(F->getParent());
7101 }
7102 }
7103
7104 for (auto &I : make_early_inc_range(instructions(F))) {
7105 // "Upgrade" older incorrect branch weights by dropping them.
7106 if (auto *MD = I.getMetadata(LLVMContext::MD_prof)) {
7107 if (MD->getOperand(0) != nullptr && isa<MDString>(MD->getOperand(0))) {
7108 MDString *MDS = cast<MDString>(MD->getOperand(0));
7109 StringRef ProfName = MDS->getString();
7110 // Check consistency of !prof branch_weights metadata.
7111 if (ProfName != MDProfLabels::BranchWeights)
7112 continue;
7113 unsigned ExpectedNumOperands = 0;
7114 if (isa<CondBrInst>(&I))
7115 ExpectedNumOperands = 2;
7116 else if (SwitchInst *SI = dyn_cast<SwitchInst>(&I))
7117 ExpectedNumOperands = SI->getNumSuccessors();
7118 else if (isa<CallInst>(&I))
7119 ExpectedNumOperands = 1;
7120 else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(&I))
7121 ExpectedNumOperands = IBI->getNumDestinations();
7122 else if (isa<SelectInst>(&I))
7123 ExpectedNumOperands = 2;
7124 else
7125 continue; // ignore and continue.
7126
7127 unsigned Offset = getBranchWeightOffset(MD);
7128
7129 // If branch weight doesn't match, just strip branch weight.
7130 if (MD->getNumOperands() != Offset + ExpectedNumOperands)
7131 I.setMetadata(LLVMContext::MD_prof, nullptr);
7132 }
7133 }
7134
7135 if (auto *CI = dyn_cast<CallBase>(&I)) {
7136 // Remove incompatible attributes on function calls.
7137 CI->removeRetAttrs(AttributeFuncs::typeIncompatible(
7138 CI->getFunctionType()->getReturnType(), CI->getRetAttributes()));
7139
7140 for (unsigned ArgNo = 0; ArgNo < CI->arg_size(); ++ArgNo)
7141 CI->removeParamAttrs(ArgNo, AttributeFuncs::typeIncompatible(
7142 CI->getArgOperand(ArgNo)->getType(),
7143 CI->getParamAttributes(ArgNo)));
7144
7145 // Upgrade intrinsics.
7146 if (Function *OldFn = CI->getCalledFunction()) {
7147 auto It = UpgradedIntrinsics.find(OldFn);
7148 if (It != UpgradedIntrinsics.end())
7149 UpgradeIntrinsicCall(CI, It->second);
7150 }
7151 }
7152 }
7153
7154 // Look for functions that rely on old function attribute behavior.
7156
7157 // Bring in any functions that this function forward-referenced via
7158 // blockaddresses.
7159 return materializeForwardReferencedFunctions();
7160}
7161
7162Error BitcodeReader::materializeModule() {
7163 if (Error Err = materializeMetadata())
7164 return Err;
7165
7166 // Promise to materialize all forward references.
7167 WillMaterializeAllForwardRefs = true;
7168
7169 // Iterate over the module, deserializing any functions that are still on
7170 // disk.
7171 for (Function &F : *TheModule) {
7172 if (Error Err = materialize(&F))
7173 return Err;
7174 }
7175 // At this point, if there are any function bodies, parse the rest of
7176 // the bits in the module past the last function block we have recorded
7177 // through either lazy scanning or the VST.
7178 if (LastFunctionBlockBit || NextUnreadBit)
7179 if (Error Err = parseModule(LastFunctionBlockBit > NextUnreadBit
7180 ? LastFunctionBlockBit
7181 : NextUnreadBit))
7182 return Err;
7183
7184 // Check that all block address forward references got resolved (as we
7185 // promised above).
7186 if (!BasicBlockFwdRefs.empty())
7187 return error("Never resolved function from blockaddress");
7188
7189 // Upgrade any intrinsic calls that slipped through (should not happen!) and
7190 // delete the old functions to clean up. We can't do this unless the entire
7191 // module is materialized because there could always be another function body
7192 // with calls to the old function.
7193 for (auto &I : UpgradedIntrinsics) {
7194 for (auto *U : I.first->users()) {
7195 if (CallInst *CI = dyn_cast<CallInst>(U))
7196 UpgradeIntrinsicCall(CI, I.second);
7197 }
7198 if (I.first != I.second) {
7199 if (!I.first->use_empty())
7200 I.first->replaceAllUsesWith(I.second);
7201 I.first->eraseFromParent();
7202 }
7203 }
7204 UpgradedIntrinsics.clear();
7205
7206 UpgradeDebugInfo(*TheModule);
7207
7208 UpgradeModuleFlags(*TheModule);
7209
7210 UpgradeNVVMAnnotations(*TheModule);
7211
7212 UpgradeARCRuntime(*TheModule);
7213
7214 copyModuleAttrToFunctions(*TheModule);
7215
7216 return Error::success();
7217}
7218
7219std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
7220 return IdentifiedStructTypes;
7221}
7222
7223ModuleSummaryIndexBitcodeReader::ModuleSummaryIndexBitcodeReader(
7224 BitstreamCursor Cursor, StringRef Strtab, ModuleSummaryIndex &TheIndex,
7225 StringRef ModulePath, std::function<bool(GlobalValue::GUID)> IsPrevailing)
7226 : BitcodeReaderBase(std::move(Cursor), Strtab), TheIndex(TheIndex),
7227 ModulePath(ModulePath), IsPrevailing(IsPrevailing) {}
7228
7229void ModuleSummaryIndexBitcodeReader::addThisModule() {
7230 TheIndex.addModule(ModulePath);
7231}
7232
7234ModuleSummaryIndexBitcodeReader::getThisModule() {
7235 return TheIndex.getModule(ModulePath);
7236}
7237
7238template <bool AllowNullValueInfo>
7239std::pair<ValueInfo, GlobalValue::GUID>
7240ModuleSummaryIndexBitcodeReader::getValueInfoFromValueId(unsigned ValueId) {
7241 auto VGI = ValueIdToValueInfoMap[ValueId];
7242 // We can have a null value info in distributed ThinLTO index files:
7243 // - For memprof callsite info records when the callee function summary is not
7244 // included in the index.
7245 // - For alias summary when its aliasee summary is not included in the index.
7246 // The bitcode writer records 0 in these cases,
7247 // and the caller of this helper will set AllowNullValueInfo to true.
7248 assert(AllowNullValueInfo || std::get<0>(VGI));
7249 return VGI;
7250}
7251
7252void ModuleSummaryIndexBitcodeReader::setValueGUID(
7253 uint64_t ValueID, StringRef ValueName, GlobalValue::LinkageTypes Linkage,
7254 StringRef SourceFileName) {
7255 std::string GlobalId =
7257 auto ValueGUID = GlobalValue::getGUIDAssumingExternalLinkage(GlobalId);
7258 auto OriginalNameID = ValueGUID;
7262 dbgs() << "GUID " << ValueGUID << "(" << OriginalNameID << ") is "
7263 << ValueName << "\n";
7264
7265 // UseStrtab is false for legacy summary formats and value names are
7266 // created on stack. In that case we save the name in a string saver in
7267 // the index so that the value name can be recorded.
7268 ValueIdToValueInfoMap[ValueID] = std::make_pair(
7269 TheIndex.getOrInsertValueInfo(
7270 ValueGUID, UseStrtab ? ValueName : TheIndex.saveString(ValueName)),
7271 OriginalNameID);
7272}
7273
7274// Specialized value symbol table parser used when reading module index
7275// blocks where we don't actually create global values. The parsed information
7276// is saved in the bitcode reader for use when later parsing summaries.
7277Error ModuleSummaryIndexBitcodeReader::parseValueSymbolTable(
7278 uint64_t Offset,
7279 DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap) {
7280 // With a strtab the VST is not required to parse the summary.
7281 if (UseStrtab)
7282 return Error::success();
7283
7284 assert(Offset > 0 && "Expected non-zero VST offset");
7285 Expected<uint64_t> MaybeCurrentBit = jumpToValueSymbolTable(Offset, Stream);
7286 if (!MaybeCurrentBit)
7287 return MaybeCurrentBit.takeError();
7288 uint64_t CurrentBit = MaybeCurrentBit.get();
7289
7291 return Err;
7292
7293 SmallVector<uint64_t, 64> Record;
7294
7295 // Read all the records for this value table.
7296 SmallString<128> ValueName;
7297
7298 while (true) {
7299 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
7300 if (!MaybeEntry)
7301 return MaybeEntry.takeError();
7302 BitstreamEntry Entry = MaybeEntry.get();
7303
7304 switch (Entry.Kind) {
7305 case BitstreamEntry::SubBlock: // Handled for us already.
7307 return error("Malformed block");
7309 // Done parsing VST, jump back to wherever we came from.
7310 if (Error JumpFailed = Stream.JumpToBit(CurrentBit))
7311 return JumpFailed;
7312 return Error::success();
7314 // The interesting case.
7315 break;
7316 }
7317
7318 // Read a record.
7319 Record.clear();
7320 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
7321 if (!MaybeRecord)
7322 return MaybeRecord.takeError();
7323 switch (MaybeRecord.get()) {
7324 default: // Default behavior: ignore (e.g. VST_CODE_BBENTRY records).
7325 break;
7326 case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]
7327 if (convertToString(Record, 1, ValueName))
7328 return error("Invalid vst_code_entry record");
7329 unsigned ValueID = Record[0];
7330 assert(!SourceFileName.empty());
7331 auto VLI = ValueIdToLinkageMap.find(ValueID);
7332 assert(VLI != ValueIdToLinkageMap.end() &&
7333 "No linkage found for VST entry?");
7334 auto Linkage = VLI->second;
7335 setValueGUID(ValueID, ValueName, Linkage, SourceFileName);
7336 ValueName.clear();
7337 break;
7338 }
7340 // VST_CODE_FNENTRY: [valueid, offset, namechar x N]
7341 if (convertToString(Record, 2, ValueName))
7342 return error("Invalid vst_code_fnentry record");
7343 unsigned ValueID = Record[0];
7344 assert(!SourceFileName.empty());
7345 auto VLI = ValueIdToLinkageMap.find(ValueID);
7346 assert(VLI != ValueIdToLinkageMap.end() &&
7347 "No linkage found for VST entry?");
7348 auto Linkage = VLI->second;
7349 setValueGUID(ValueID, ValueName, Linkage, SourceFileName);
7350 ValueName.clear();
7351 break;
7352 }
7354 // VST_CODE_COMBINED_ENTRY: [valueid, refguid]
7355 unsigned ValueID = Record[0];
7356 GlobalValue::GUID RefGUID = Record[1];
7357 // The "original name", which is the second value of the pair will be
7358 // overriden later by a FS_COMBINED_ORIGINAL_NAME in the combined index.
7359 ValueIdToValueInfoMap[ValueID] =
7360 std::make_pair(TheIndex.getOrInsertValueInfo(RefGUID), RefGUID);
7361 break;
7362 }
7363 }
7364 }
7365}
7366
7367// Parse just the blocks needed for building the index out of the module.
7368// At the end of this routine the module Index is populated with a map
7369// from global value id to GlobalValueSummary objects.
7370Error ModuleSummaryIndexBitcodeReader::parseModule() {
7371 if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
7372 return Err;
7373
7374 SmallVector<uint64_t, 64> Record;
7375 DenseMap<unsigned, GlobalValue::LinkageTypes> ValueIdToLinkageMap;
7376 unsigned ValueId = 0;
7377
7378 // Read the index for this module.
7379 while (true) {
7380 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
7381 if (!MaybeEntry)
7382 return MaybeEntry.takeError();
7383 llvm::BitstreamEntry Entry = MaybeEntry.get();
7384
7385 switch (Entry.Kind) {
7387 return error("Malformed block");
7389 return Error::success();
7390
7392 switch (Entry.ID) {
7393 default: // Skip unknown content.
7394 if (Error Err = Stream.SkipBlock())
7395 return Err;
7396 break;
7398 // Need to parse these to get abbrev ids (e.g. for VST)
7399 if (Error Err = readBlockInfo())
7400 return Err;
7401 break;
7403 // Should have been parsed earlier via VSTOffset, unless there
7404 // is no summary section.
7405 assert(((SeenValueSymbolTable && VSTOffset > 0) ||
7406 !SeenGlobalValSummary) &&
7407 "Expected early VST parse via VSTOffset record");
7408 if (Error Err = Stream.SkipBlock())
7409 return Err;
7410 break;
7413 // Add the module if it is a per-module index (has a source file name).
7414 if (!SourceFileName.empty())
7415 addThisModule();
7416 assert(!SeenValueSymbolTable &&
7417 "Already read VST when parsing summary block?");
7418 // We might not have a VST if there were no values in the
7419 // summary. An empty summary block generated when we are
7420 // performing ThinLTO compiles so we don't later invoke
7421 // the regular LTO process on them.
7422 if (VSTOffset > 0) {
7423 if (Error Err = parseValueSymbolTable(VSTOffset, ValueIdToLinkageMap))
7424 return Err;
7425 SeenValueSymbolTable = true;
7426 }
7427 SeenGlobalValSummary = true;
7428 if (Error Err = parseEntireSummary(Entry.ID))
7429 return Err;
7430 break;
7432 if (Error Err = parseModuleStringTable())
7433 return Err;
7434 break;
7435 }
7436 continue;
7437
7439 Record.clear();
7440 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
7441 if (!MaybeBitCode)
7442 return MaybeBitCode.takeError();
7443 switch (MaybeBitCode.get()) {
7444 default:
7445 break; // Default behavior, ignore unknown content.
7447 if (Error Err = parseVersionRecord(Record).takeError())
7448 return Err;
7449 break;
7450 }
7451 /// MODULE_CODE_SOURCE_FILENAME: [namechar x N]
7453 SmallString<128> ValueName;
7454 if (convertToString(Record, 0, ValueName))
7455 return error("Invalid source filename record");
7456 SourceFileName = ValueName.c_str();
7457 break;
7458 }
7459 /// MODULE_CODE_HASH: [5*i32]
7461 if (Record.size() != 5)
7462 return error("Invalid hash length " + Twine(Record.size()).str());
7463 auto &Hash = getThisModule()->second;
7464 int Pos = 0;
7465 for (auto &Val : Record) {
7466 assert(!(Val >> 32) && "Unexpected high bits set");
7467 Hash[Pos++] = Val;
7468 }
7469 break;
7470 }
7471 /// MODULE_CODE_VSTOFFSET: [offset]
7473 if (Record.empty())
7474 return error("Invalid vstoffset record");
7475 // Note that we subtract 1 here because the offset is relative to one
7476 // word before the start of the identification or module block, which
7477 // was historically always the start of the regular bitcode header.
7478 VSTOffset = Record[0] - 1;
7479 break;
7480 // v1 GLOBALVAR: [pointer type, isconst, initid, linkage, ...]
7481 // v1 FUNCTION: [type, callingconv, isproto, linkage, ...]
7482 // v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, ...]
7483 // v2: [strtab offset, strtab size, v1]
7487 StringRef Name;
7488 ArrayRef<uint64_t> GVRecord;
7489 std::tie(Name, GVRecord) = readNameFromStrtab(Record);
7490 if (GVRecord.size() <= 3)
7491 return error("Invalid global record");
7492 uint64_t RawLinkage = GVRecord[3];
7494 if (!UseStrtab) {
7495 ValueIdToLinkageMap[ValueId++] = Linkage;
7496 break;
7497 }
7498
7499 setValueGUID(ValueId++, Name, Linkage, SourceFileName);
7500 break;
7501 }
7502 }
7503 }
7504 continue;
7505 }
7506 }
7507}
7508
7510ModuleSummaryIndexBitcodeReader::makeRefList(ArrayRef<uint64_t> Record) {
7512 Ret.reserve(Record.size());
7513 for (uint64_t RefValueId : Record)
7514 Ret.push_back(std::get<0>(getValueInfoFromValueId(RefValueId)));
7515 return Ret;
7516}
7517
7519ModuleSummaryIndexBitcodeReader::makeCallList(ArrayRef<uint64_t> Record,
7520 bool IsOldProfileFormat,
7521 bool HasProfile, bool HasRelBF) {
7523 // In the case of new profile formats, there are two Record entries per
7524 // Edge. Otherwise, conservatively reserve up to Record.size.
7525 if (!IsOldProfileFormat && (HasProfile || HasRelBF))
7526 Ret.reserve(Record.size() / 2);
7527 else
7528 Ret.reserve(Record.size());
7529
7530 for (unsigned I = 0, E = Record.size(); I != E; ++I) {
7531 CalleeInfo::HotnessType Hotness = CalleeInfo::HotnessType::Unknown;
7532 bool HasTailCall = false;
7533 uint64_t RelBF = 0;
7534 ValueInfo Callee = std::get<0>(getValueInfoFromValueId(Record[I]));
7535 if (IsOldProfileFormat) {
7536 I += 1; // Skip old callsitecount field
7537 if (HasProfile)
7538 I += 1; // Skip old profilecount field
7539 } else if (HasProfile)
7540 std::tie(Hotness, HasTailCall) =
7542 // Deprecated, but still needed to read old bitcode files.
7543 else if (HasRelBF)
7544 getDecodedRelBFCallEdgeInfo(Record[++I], RelBF, HasTailCall);
7545 Ret.push_back(
7546 FunctionSummary::EdgeTy{Callee, CalleeInfo(Hotness, HasTailCall)});
7547 }
7548 return Ret;
7549}
7550
7551static void
7554 uint64_t ArgNum = Record[Slot++];
7556 Wpd.ResByArg[{Record.begin() + Slot, Record.begin() + Slot + ArgNum}];
7557 Slot += ArgNum;
7558
7559 B.TheKind =
7561 B.Info = Record[Slot++];
7562 B.Byte = Record[Slot++];
7563 B.Bit = Record[Slot++];
7564}
7565
7567 StringRef Strtab, size_t &Slot,
7568 TypeIdSummary &TypeId) {
7569 uint64_t Id = Record[Slot++];
7570 WholeProgramDevirtResolution &Wpd = TypeId.WPDRes[Id];
7571
7572 Wpd.TheKind = static_cast<WholeProgramDevirtResolution::Kind>(Record[Slot++]);
7573 Wpd.SingleImplName = {Strtab.data() + Record[Slot],
7574 static_cast<size_t>(Record[Slot + 1])};
7575 Slot += 2;
7576
7577 uint64_t ResByArgNum = Record[Slot++];
7578 for (uint64_t I = 0; I != ResByArgNum; ++I)
7580}
7581
7583 StringRef Strtab,
7584 ModuleSummaryIndex &TheIndex) {
7585 size_t Slot = 0;
7586 TypeIdSummary &TypeId = TheIndex.getOrInsertTypeIdSummary(
7587 {Strtab.data() + Record[Slot], static_cast<size_t>(Record[Slot + 1])});
7588 Slot += 2;
7589
7590 TypeId.TTRes.TheKind = static_cast<TypeTestResolution::Kind>(Record[Slot++]);
7591 TypeId.TTRes.SizeM1BitWidth = Record[Slot++];
7592 TypeId.TTRes.AlignLog2 = Record[Slot++];
7593 TypeId.TTRes.SizeM1 = Record[Slot++];
7594 TypeId.TTRes.BitMask = Record[Slot++];
7595 TypeId.TTRes.InlineBits = Record[Slot++];
7596
7597 while (Slot < Record.size())
7598 parseWholeProgramDevirtResolution(Record, Strtab, Slot, TypeId);
7599}
7600
7601std::vector<FunctionSummary::ParamAccess>
7602ModuleSummaryIndexBitcodeReader::parseParamAccesses(ArrayRef<uint64_t> Record) {
7603 auto ReadRange = [&]() {
7605 BitcodeReader::decodeSignRotatedValue(Record.consume_front()));
7607 BitcodeReader::decodeSignRotatedValue(Record.consume_front()));
7608 ConstantRange Range{Lower, Upper};
7611 return Range;
7612 };
7613
7614 std::vector<FunctionSummary::ParamAccess> PendingParamAccesses;
7615 while (!Record.empty()) {
7616 PendingParamAccesses.emplace_back();
7617 FunctionSummary::ParamAccess &ParamAccess = PendingParamAccesses.back();
7618 ParamAccess.ParamNo = Record.consume_front();
7619 ParamAccess.Use = ReadRange();
7620 ParamAccess.Calls.resize(Record.consume_front());
7621 for (auto &Call : ParamAccess.Calls) {
7622 Call.ParamNo = Record.consume_front();
7623 Call.Callee =
7624 std::get<0>(getValueInfoFromValueId(Record.consume_front()));
7625 Call.Offsets = ReadRange();
7626 }
7627 }
7628 return PendingParamAccesses;
7629}
7630
7631void ModuleSummaryIndexBitcodeReader::parseTypeIdCompatibleVtableInfo(
7632 ArrayRef<uint64_t> Record, size_t &Slot,
7634 uint64_t Offset = Record[Slot++];
7635 ValueInfo Callee = std::get<0>(getValueInfoFromValueId(Record[Slot++]));
7636 TypeId.push_back({Offset, Callee});
7637}
7638
7639void ModuleSummaryIndexBitcodeReader::parseTypeIdCompatibleVtableSummaryRecord(
7640 ArrayRef<uint64_t> Record) {
7641 size_t Slot = 0;
7644 {Strtab.data() + Record[Slot],
7645 static_cast<size_t>(Record[Slot + 1])});
7646 Slot += 2;
7647
7648 while (Slot < Record.size())
7649 parseTypeIdCompatibleVtableInfo(Record, Slot, TypeId);
7650}
7651
7652SmallVector<unsigned> ModuleSummaryIndexBitcodeReader::parseAllocInfoContext(
7653 ArrayRef<uint64_t> Record, unsigned &I) {
7654 SmallVector<unsigned> StackIdList;
7655 // For backwards compatibility with old format before radix tree was
7656 // used, simply see if we found a radix tree array record (and thus if
7657 // the RadixArray is non-empty).
7658 if (RadixArray.empty()) {
7659 unsigned NumStackEntries = Record[I++];
7660 assert(Record.size() - I >= NumStackEntries);
7661 StackIdList.reserve(NumStackEntries);
7662 for (unsigned J = 0; J < NumStackEntries; J++) {
7663 assert(Record[I] < StackIds.size());
7664 StackIdList.push_back(getStackIdIndex(Record[I++]));
7665 }
7666 } else {
7667 unsigned RadixIndex = Record[I++];
7668 // See the comments above CallStackRadixTreeBuilder in ProfileData/MemProf.h
7669 // for a detailed description of the radix tree array format. Briefly, the
7670 // first entry will be the number of frames, any negative values are the
7671 // negative of the offset of the next frame, and otherwise the frames are in
7672 // increasing linear order.
7673 assert(RadixIndex < RadixArray.size());
7674 unsigned NumStackIds = RadixArray[RadixIndex++];
7675 StackIdList.reserve(NumStackIds);
7676 while (NumStackIds--) {
7677 assert(RadixIndex < RadixArray.size());
7678 unsigned Elem = RadixArray[RadixIndex];
7679 if (static_cast<std::make_signed_t<unsigned>>(Elem) < 0) {
7680 RadixIndex = RadixIndex - Elem;
7681 assert(RadixIndex < RadixArray.size());
7682 Elem = RadixArray[RadixIndex];
7683 // We shouldn't encounter a second offset in a row.
7684 assert(static_cast<std::make_signed_t<unsigned>>(Elem) >= 0);
7685 }
7686 RadixIndex++;
7687 StackIdList.push_back(getStackIdIndex(Elem));
7688 }
7689 }
7690 return StackIdList;
7691}
7692
7693static void setSpecialRefs(SmallVectorImpl<ValueInfo> &Refs, unsigned ROCnt,
7694 unsigned WOCnt) {
7695 // Readonly and writeonly refs are in the end of the refs list.
7696 assert(ROCnt + WOCnt <= Refs.size());
7697 unsigned FirstWORef = Refs.size() - WOCnt;
7698 unsigned RefNo = FirstWORef - ROCnt;
7699 for (; RefNo < FirstWORef; ++RefNo)
7700 Refs[RefNo].setReadOnly();
7701 for (; RefNo < Refs.size(); ++RefNo)
7702 Refs[RefNo].setWriteOnly();
7703}
7704
7705// Eagerly parse the entire summary block. This populates the GlobalValueSummary
7706// objects in the index.
7707Error ModuleSummaryIndexBitcodeReader::parseEntireSummary(unsigned ID) {
7708 if (Error Err = Stream.EnterSubBlock(ID))
7709 return Err;
7710 SmallVector<uint64_t, 64> Record;
7711
7712 // Parse version
7713 {
7714 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
7715 if (!MaybeEntry)
7716 return MaybeEntry.takeError();
7717 BitstreamEntry Entry = MaybeEntry.get();
7718
7719 if (Entry.Kind != BitstreamEntry::Record)
7720 return error("Invalid Summary Block: record for version expected");
7721 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
7722 if (!MaybeRecord)
7723 return MaybeRecord.takeError();
7724 if (MaybeRecord.get() != bitc::FS_VERSION)
7725 return error("Invalid Summary Block: version expected");
7726 }
7727 const uint64_t Version = Record[0];
7728 const bool IsOldProfileFormat = Version == 1;
7729 // Starting with bitcode summary version 13, MemProf records follow the
7730 // corresponding function summary.
7731 const bool MemProfAfterFunctionSummary = Version >= 13;
7733 return error("Invalid summary version " + Twine(Version) +
7734 ". Version should be in the range [1-" +
7736 "].");
7737 Record.clear();
7738
7739 // Keep around the last seen summary to be used when we see an optional
7740 // "OriginalName" attachement.
7741 GlobalValueSummary *LastSeenSummary = nullptr;
7742 GlobalValue::GUID LastSeenGUID = 0;
7743
7744 // Track the most recent function summary if it was prevailing, and while we
7745 // are not done processing any subsequent memprof records. Starting with
7746 // summary version 13 (tracked by MemProfAfterFunctionSummary), MemProf
7747 // records follow the function summary and we skip processing them when the
7748 // summary is not prevailing. Note that when reading a combined index we don't
7749 // know what is prevailing so this should always be set in the new format when
7750 // we encounter MemProf records.
7751 FunctionSummary *CurrentPrevailingFS = nullptr;
7752
7753 // We can expect to see any number of type ID information records before
7754 // each function summary records; these variables store the information
7755 // collected so far so that it can be used to create the summary object.
7756 std::vector<GlobalValue::GUID> PendingTypeTests;
7757 std::vector<FunctionSummary::VFuncId> PendingTypeTestAssumeVCalls,
7758 PendingTypeCheckedLoadVCalls;
7759 std::vector<FunctionSummary::ConstVCall> PendingTypeTestAssumeConstVCalls,
7760 PendingTypeCheckedLoadConstVCalls;
7761 std::vector<FunctionSummary::ParamAccess> PendingParamAccesses;
7762
7763 std::vector<CallsiteInfo> PendingCallsites;
7764 std::vector<AllocInfo> PendingAllocs;
7765 std::vector<uint64_t> PendingContextIds;
7766
7767 while (true) {
7768 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
7769 if (!MaybeEntry)
7770 return MaybeEntry.takeError();
7771 BitstreamEntry Entry = MaybeEntry.get();
7772
7773 switch (Entry.Kind) {
7774 case BitstreamEntry::SubBlock: // Handled for us already.
7776 return error("Malformed block");
7778 return Error::success();
7780 // The interesting case.
7781 break;
7782 }
7783
7784 // Read a record. The record format depends on whether this
7785 // is a per-module index or a combined index file. In the per-module
7786 // case the records contain the associated value's ID for correlation
7787 // with VST entries. In the combined index the correlation is done
7788 // via the bitcode offset of the summary records (which were saved
7789 // in the combined index VST entries). The records also contain
7790 // information used for ThinLTO renaming and importing.
7791 Record.clear();
7792 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
7793 if (!MaybeBitCode)
7794 return MaybeBitCode.takeError();
7795 unsigned BitCode = MaybeBitCode.get();
7796
7797 switch (BitCode) {
7798 default: // Default behavior: ignore.
7799 break;
7800 case bitc::FS_FLAGS: { // [flags]
7801 TheIndex.setFlags(Record[0]);
7802 break;
7803 }
7804 case bitc::FS_VALUE_GUID: { // [valueid, refguid_upper32, refguid_lower32]
7805 uint64_t ValueID = Record[0];
7806 GlobalValue::GUID RefGUID;
7807 if (Version >= 11) {
7808 RefGUID = Record[1] << 32 | Record[2];
7809 } else {
7810 RefGUID = Record[1];
7811 }
7812 ValueIdToValueInfoMap[ValueID] =
7813 std::make_pair(TheIndex.getOrInsertValueInfo(RefGUID), RefGUID);
7814 break;
7815 }
7816 // FS_PERMODULE is legacy and does not have support for the tail call flag.
7817 // FS_PERMODULE: [valueid, flags, instcount, fflags, numrefs,
7818 // numrefs x valueid, n x (valueid)]
7819 // FS_PERMODULE_PROFILE: [valueid, flags, instcount, fflags, numrefs,
7820 // numrefs x valueid,
7821 // n x (valueid, hotness+tailcall flags)]
7822 // Deprecated, but still needed to read old bitcode files.
7823 // FS_PERMODULE_RELBF: [valueid, flags, instcount, fflags, numrefs,
7824 // numrefs x valueid,
7825 // n x (valueid, relblockfreq+tailcall)]
7826 case bitc::FS_PERMODULE:
7828 // Deprecated, but still needed to read old bitcode files.
7830 unsigned ValueID = Record[0];
7831 uint64_t RawFlags = Record[1];
7832 unsigned InstCount = Record[2];
7833 uint64_t RawFunFlags = 0;
7834 unsigned NumRefs = Record[3];
7835 unsigned NumRORefs = 0, NumWORefs = 0;
7836 int RefListStartIndex = 4;
7837 if (Version >= 4) {
7838 RawFunFlags = Record[3];
7839 NumRefs = Record[4];
7840 RefListStartIndex = 5;
7841 if (Version >= 5) {
7842 NumRORefs = Record[5];
7843 RefListStartIndex = 6;
7844 if (Version >= 7) {
7845 NumWORefs = Record[6];
7846 RefListStartIndex = 7;
7847 }
7848 }
7849 }
7850
7851 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
7852 // The module path string ref set in the summary must be owned by the
7853 // index's module string table. Since we don't have a module path
7854 // string table section in the per-module index, we create a single
7855 // module path string table entry with an empty (0) ID to take
7856 // ownership.
7857 int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;
7858 assert(Record.size() >= RefListStartIndex + NumRefs &&
7859 "Record size inconsistent with number of references");
7860 SmallVector<ValueInfo, 0> Refs = makeRefList(
7861 ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
7862 bool HasProfile = (BitCode == bitc::FS_PERMODULE_PROFILE);
7863 // Deprecated, but still needed to read old bitcode files.
7864 bool HasRelBF = (BitCode == bitc::FS_PERMODULE_RELBF);
7865 SmallVector<FunctionSummary::EdgeTy, 0> Calls = makeCallList(
7866 ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),
7867 IsOldProfileFormat, HasProfile, HasRelBF);
7868 setSpecialRefs(Refs, NumRORefs, NumWORefs);
7869 auto [VI, GUID] = getValueInfoFromValueId(ValueID);
7870
7871 // The linker doesn't resolve local linkage values so don't check whether
7872 // those are prevailing (set IsPrevailingSym so they are always processed
7873 // and kept).
7874 auto LT = (GlobalValue::LinkageTypes)Flags.Linkage;
7875 bool IsPrevailingSym = !IsPrevailing || GlobalValue::isLocalLinkage(LT) ||
7876 IsPrevailing(VI.getGUID());
7877
7878 // If this is not the prevailing copy, and the records are in the "old"
7879 // order (preceding), clear them now. They should already be empty in
7880 // the new order (following), as they are processed or skipped immediately
7881 // when they follow the summary.
7882 assert(!MemProfAfterFunctionSummary ||
7883 (PendingCallsites.empty() && PendingAllocs.empty()));
7884 if (!IsPrevailingSym && !MemProfAfterFunctionSummary) {
7885 PendingCallsites.clear();
7886 PendingAllocs.clear();
7887 }
7888
7889 auto FS = std::make_unique<FunctionSummary>(
7890 Flags, InstCount, getDecodedFFlags(RawFunFlags), std::move(Refs),
7891 std::move(Calls), std::move(PendingTypeTests),
7892 std::move(PendingTypeTestAssumeVCalls),
7893 std::move(PendingTypeCheckedLoadVCalls),
7894 std::move(PendingTypeTestAssumeConstVCalls),
7895 std::move(PendingTypeCheckedLoadConstVCalls),
7896 std::move(PendingParamAccesses), std::move(PendingCallsites),
7897 std::move(PendingAllocs));
7898 FS->setModulePath(getThisModule()->first());
7899 FS->setOriginalName(GUID);
7900 // Set CurrentPrevailingFS only if prevailing, so subsequent MemProf
7901 // records are attached (new order) or skipped.
7902 if (MemProfAfterFunctionSummary) {
7903 if (IsPrevailingSym)
7904 CurrentPrevailingFS = FS.get();
7905 else
7906 CurrentPrevailingFS = nullptr;
7907 }
7908 TheIndex.addGlobalValueSummary(VI, std::move(FS));
7909 break;
7910 }
7911 // FS_ALIAS: [valueid, flags, valueid]
7912 // Aliases must be emitted (and parsed) after all FS_PERMODULE entries, as
7913 // they expect all aliasee summaries to be available.
7914 case bitc::FS_ALIAS: {
7915 unsigned ValueID = Record[0];
7916 uint64_t RawFlags = Record[1];
7917 unsigned AliaseeID = Record[2];
7918 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
7919 auto AS = std::make_unique<AliasSummary>(Flags);
7920 // The module path string ref set in the summary must be owned by the
7921 // index's module string table. Since we don't have a module path
7922 // string table section in the per-module index, we create a single
7923 // module path string table entry with an empty (0) ID to take
7924 // ownership.
7925 AS->setModulePath(getThisModule()->first());
7926
7927 auto AliaseeVI = std::get<0>(getValueInfoFromValueId(AliaseeID));
7928 auto AliaseeInModule = TheIndex.findSummaryInModule(AliaseeVI, ModulePath);
7929 if (!AliaseeInModule)
7930 return error("Alias expects aliasee summary to be parsed");
7931 AS->setAliasee(AliaseeVI, AliaseeInModule);
7932
7933 auto GUID = getValueInfoFromValueId(ValueID);
7934 AS->setOriginalName(std::get<1>(GUID));
7935 TheIndex.addGlobalValueSummary(std::get<0>(GUID), std::move(AS));
7936 break;
7937 }
7938 // FS_PERMODULE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags, n x valueid]
7940 unsigned ValueID = Record[0];
7941 uint64_t RawFlags = Record[1];
7942 unsigned RefArrayStart = 2;
7943 GlobalVarSummary::GVarFlags GVF(/* ReadOnly */ false,
7944 /* WriteOnly */ false,
7945 /* Constant */ false,
7947 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
7948 if (Version >= 5) {
7949 GVF = getDecodedGVarFlags(Record[2]);
7950 RefArrayStart = 3;
7951 }
7953 makeRefList(ArrayRef<uint64_t>(Record).slice(RefArrayStart));
7954 auto FS =
7955 std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));
7956 FS->setModulePath(getThisModule()->first());
7957 auto GUID = getValueInfoFromValueId(ValueID);
7958 FS->setOriginalName(std::get<1>(GUID));
7959 TheIndex.addGlobalValueSummary(std::get<0>(GUID), std::move(FS));
7960 break;
7961 }
7962 // FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags,
7963 // numrefs, numrefs x valueid,
7964 // n x (valueid, offset)]
7966 unsigned ValueID = Record[0];
7967 uint64_t RawFlags = Record[1];
7968 GlobalVarSummary::GVarFlags GVF = getDecodedGVarFlags(Record[2]);
7969 unsigned NumRefs = Record[3];
7970 unsigned RefListStartIndex = 4;
7971 unsigned VTableListStartIndex = RefListStartIndex + NumRefs;
7972 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
7973 SmallVector<ValueInfo, 0> Refs = makeRefList(
7974 ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
7975 VTableFuncList VTableFuncs;
7976 for (unsigned I = VTableListStartIndex, E = Record.size(); I != E; ++I) {
7977 ValueInfo Callee = std::get<0>(getValueInfoFromValueId(Record[I]));
7978 uint64_t Offset = Record[++I];
7979 VTableFuncs.push_back({Callee, Offset});
7980 }
7981 auto VS =
7982 std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));
7983 VS->setModulePath(getThisModule()->first());
7984 VS->setVTableFuncs(VTableFuncs);
7985 auto GUID = getValueInfoFromValueId(ValueID);
7986 VS->setOriginalName(std::get<1>(GUID));
7987 TheIndex.addGlobalValueSummary(std::get<0>(GUID), std::move(VS));
7988 break;
7989 }
7990 // FS_COMBINED is legacy and does not have support for the tail call flag.
7991 // FS_COMBINED: [valueid, modid, flags, instcount, fflags, numrefs,
7992 // numrefs x valueid, n x (valueid)]
7993 // FS_COMBINED_PROFILE: [valueid, modid, flags, instcount, fflags, numrefs,
7994 // numrefs x valueid,
7995 // n x (valueid, hotness+tailcall flags)]
7996 case bitc::FS_COMBINED:
7998 unsigned ValueID = Record[0];
7999 uint64_t ModuleId = Record[1];
8000 uint64_t RawFlags = Record[2];
8001 unsigned InstCount = Record[3];
8002 uint64_t RawFunFlags = 0;
8003 unsigned NumRefs = Record[4];
8004 unsigned NumRORefs = 0, NumWORefs = 0;
8005 int RefListStartIndex = 5;
8006
8007 if (Version >= 4) {
8008 RawFunFlags = Record[4];
8009 RefListStartIndex = 6;
8010 size_t NumRefsIndex = 5;
8011 if (Version >= 5) {
8012 unsigned NumRORefsOffset = 1;
8013 RefListStartIndex = 7;
8014 if (Version >= 6) {
8015 NumRefsIndex = 6;
8016 RefListStartIndex = 8;
8017 if (Version >= 7) {
8018 RefListStartIndex = 9;
8019 NumWORefs = Record[8];
8020 NumRORefsOffset = 2;
8021 }
8022 }
8023 NumRORefs = Record[RefListStartIndex - NumRORefsOffset];
8024 }
8025 NumRefs = Record[NumRefsIndex];
8026 }
8027
8028 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
8029 int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;
8030 assert(Record.size() >= RefListStartIndex + NumRefs &&
8031 "Record size inconsistent with number of references");
8032 SmallVector<ValueInfo, 0> Refs = makeRefList(
8033 ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));
8034 bool HasProfile = (BitCode == bitc::FS_COMBINED_PROFILE);
8035 SmallVector<FunctionSummary::EdgeTy, 0> Edges = makeCallList(
8036 ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),
8037 IsOldProfileFormat, HasProfile, false);
8038 ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));
8039 setSpecialRefs(Refs, NumRORefs, NumWORefs);
8040 auto FS = std::make_unique<FunctionSummary>(
8041 Flags, InstCount, getDecodedFFlags(RawFunFlags), std::move(Refs),
8042 std::move(Edges), std::move(PendingTypeTests),
8043 std::move(PendingTypeTestAssumeVCalls),
8044 std::move(PendingTypeCheckedLoadVCalls),
8045 std::move(PendingTypeTestAssumeConstVCalls),
8046 std::move(PendingTypeCheckedLoadConstVCalls),
8047 std::move(PendingParamAccesses), std::move(PendingCallsites),
8048 std::move(PendingAllocs));
8049 LastSeenSummary = FS.get();
8050 if (MemProfAfterFunctionSummary)
8051 CurrentPrevailingFS = FS.get();
8052 LastSeenGUID = VI.getGUID();
8053 FS->setModulePath(ModuleIdMap[ModuleId]);
8054 TheIndex.addGlobalValueSummary(VI, std::move(FS));
8055 break;
8056 }
8057 // FS_COMBINED_ALIAS: [valueid, modid, flags, valueid]
8058 // Aliases must be emitted (and parsed) after all FS_COMBINED entries, as
8059 // they expect all aliasee summaries to be available.
8061 unsigned ValueID = Record[0];
8062 uint64_t ModuleId = Record[1];
8063 uint64_t RawFlags = Record[2];
8064 unsigned AliaseeValueId = Record[3];
8065 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
8066 auto AS = std::make_unique<AliasSummary>(Flags);
8067 LastSeenSummary = AS.get();
8068 AS->setModulePath(ModuleIdMap[ModuleId]);
8069
8070 auto AliaseeVI = std::get<0>(
8071 getValueInfoFromValueId</*AllowNullValueInfo*/ true>(AliaseeValueId));
8072 if (AliaseeVI) {
8073 auto AliaseeInModule =
8074 TheIndex.findSummaryInModule(AliaseeVI, AS->modulePath());
8075 AS->setAliasee(AliaseeVI, AliaseeInModule);
8076 }
8077 ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));
8078 LastSeenGUID = VI.getGUID();
8079 TheIndex.addGlobalValueSummary(VI, std::move(AS));
8080 break;
8081 }
8082 // FS_COMBINED_GLOBALVAR_INIT_REFS: [valueid, modid, flags, n x valueid]
8084 unsigned ValueID = Record[0];
8085 uint64_t ModuleId = Record[1];
8086 uint64_t RawFlags = Record[2];
8087 unsigned RefArrayStart = 3;
8088 GlobalVarSummary::GVarFlags GVF(/* ReadOnly */ false,
8089 /* WriteOnly */ false,
8090 /* Constant */ false,
8092 auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);
8093 if (Version >= 5) {
8094 GVF = getDecodedGVarFlags(Record[3]);
8095 RefArrayStart = 4;
8096 }
8098 makeRefList(ArrayRef<uint64_t>(Record).slice(RefArrayStart));
8099 auto FS =
8100 std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));
8101 LastSeenSummary = FS.get();
8102 FS->setModulePath(ModuleIdMap[ModuleId]);
8103 ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));
8104 LastSeenGUID = VI.getGUID();
8105 TheIndex.addGlobalValueSummary(VI, std::move(FS));
8106 break;
8107 }
8108 // FS_COMBINED_ORIGINAL_NAME: [original_name]
8110 uint64_t OriginalName = Record[0];
8111 if (!LastSeenSummary)
8112 return error("Name attachment that does not follow a combined record");
8113 LastSeenSummary->setOriginalName(OriginalName);
8114 TheIndex.addOriginalName(LastSeenGUID, OriginalName);
8115 // Reset the LastSeenSummary
8116 LastSeenSummary = nullptr;
8117 LastSeenGUID = 0;
8118 break;
8119 }
8121 assert(PendingTypeTests.empty());
8122 llvm::append_range(PendingTypeTests, Record);
8123 break;
8124
8126 assert(PendingTypeTestAssumeVCalls.empty());
8127 for (unsigned I = 0; I != Record.size(); I += 2)
8128 PendingTypeTestAssumeVCalls.push_back({Record[I], Record[I+1]});
8129 break;
8130
8132 assert(PendingTypeCheckedLoadVCalls.empty());
8133 for (unsigned I = 0; I != Record.size(); I += 2)
8134 PendingTypeCheckedLoadVCalls.push_back({Record[I], Record[I+1]});
8135 break;
8136
8138 PendingTypeTestAssumeConstVCalls.push_back(
8139 {{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});
8140 break;
8141
8143 PendingTypeCheckedLoadConstVCalls.push_back(
8144 {{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});
8145 break;
8146
8148 auto &CfiFunctionDefs = TheIndex.cfiFunctionDefs();
8149 for (unsigned I = 0; I != Record.size(); I += 2)
8150 CfiFunctionDefs.emplace(Strtab.data() + Record[I],
8151 static_cast<size_t>(Record[I + 1]));
8152 break;
8153 }
8154
8156 auto &CfiFunctionDecls = TheIndex.cfiFunctionDecls();
8157 for (unsigned I = 0; I != Record.size(); I += 2)
8158 CfiFunctionDecls.emplace(Strtab.data() + Record[I],
8159 static_cast<size_t>(Record[I + 1]));
8160 break;
8161 }
8162
8163 case bitc::FS_TYPE_ID:
8164 parseTypeIdSummaryRecord(Record, Strtab, TheIndex);
8165 break;
8166
8168 parseTypeIdCompatibleVtableSummaryRecord(Record);
8169 break;
8170
8172 TheIndex.addBlockCount(Record[0]);
8173 break;
8174
8175 case bitc::FS_PARAM_ACCESS: {
8176 PendingParamAccesses = parseParamAccesses(Record);
8177 break;
8178 }
8179
8180 case bitc::FS_STACK_IDS: { // [n x stackid]
8181 // Save stack ids in the reader to consult when adding stack ids from the
8182 // lists in the stack node and alloc node entries.
8183 assert(StackIds.empty());
8184 if (Version <= 11) {
8185 StackIds = ArrayRef<uint64_t>(Record);
8186 } else {
8187 // This is an array of 32-bit fixed-width values, holding each 64-bit
8188 // context id as a pair of adjacent (most significant first) 32-bit
8189 // words.
8190 assert(Record.size() % 2 == 0);
8191 StackIds.reserve(Record.size() / 2);
8192 for (auto R = Record.begin(); R != Record.end(); R += 2)
8193 StackIds.push_back(*R << 32 | *(R + 1));
8194 }
8195 assert(StackIdToIndex.empty());
8196 // Initialize with a marker to support lazy population.
8197 StackIdToIndex.resize(StackIds.size(), UninitializedStackIdIndex);
8198 break;
8199 }
8200
8201 case bitc::FS_CONTEXT_RADIX_TREE_ARRAY: { // [n x entry]
8202 RadixArray = ArrayRef<uint64_t>(Record);
8203 break;
8204 }
8205
8207 // If they are in the new order (following), they are skipped when they
8208 // follow a non-prevailing summary (CurrentPrevailingFS will be null).
8209 if (MemProfAfterFunctionSummary && !CurrentPrevailingFS)
8210 break;
8211 unsigned ValueID = Record[0];
8212 SmallVector<unsigned> StackIdList;
8213 for (uint64_t R : drop_begin(Record)) {
8214 assert(R < StackIds.size());
8215 StackIdList.push_back(getStackIdIndex(R));
8216 }
8217 ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));
8218 if (MemProfAfterFunctionSummary)
8219 CurrentPrevailingFS->addCallsite(
8220 CallsiteInfo({VI, std::move(StackIdList)}));
8221 else
8222 PendingCallsites.push_back(CallsiteInfo({VI, std::move(StackIdList)}));
8223 break;
8224 }
8225
8227 // In the combined index case we don't have a prevailing check,
8228 // so we should always have a CurrentPrevailingFS.
8229 assert(!MemProfAfterFunctionSummary || CurrentPrevailingFS);
8230 auto RecordIter = Record.begin();
8231 unsigned ValueID = *RecordIter++;
8232 unsigned NumStackIds = *RecordIter++;
8233 unsigned NumVersions = *RecordIter++;
8234 assert(Record.size() == 3 + NumStackIds + NumVersions);
8235 SmallVector<unsigned> StackIdList;
8236 for (unsigned J = 0; J < NumStackIds; J++) {
8237 assert(*RecordIter < StackIds.size());
8238 StackIdList.push_back(getStackIdIndex(*RecordIter++));
8239 }
8240 SmallVector<unsigned> Versions;
8241 for (unsigned J = 0; J < NumVersions; J++)
8242 Versions.push_back(*RecordIter++);
8243 ValueInfo VI = std::get<0>(
8244 getValueInfoFromValueId</*AllowNullValueInfo*/ true>(ValueID));
8245 if (MemProfAfterFunctionSummary)
8246 CurrentPrevailingFS->addCallsite(
8247 CallsiteInfo({VI, std::move(Versions), std::move(StackIdList)}));
8248 else
8249 PendingCallsites.push_back(
8250 CallsiteInfo({VI, std::move(Versions), std::move(StackIdList)}));
8251 break;
8252 }
8253
8255 // If they are in the new order (following), they are skipped when they
8256 // follow a non-prevailing summary (CurrentPrevailingFS will be null).
8257 if (MemProfAfterFunctionSummary && !CurrentPrevailingFS)
8258 break;
8259 // This is an array of 32-bit fixed-width values, holding each 64-bit
8260 // context id as a pair of adjacent (most significant first) 32-bit words.
8261 assert(Record.size() % 2 == 0);
8262 PendingContextIds.reserve(Record.size() / 2);
8263 for (auto R = Record.begin(); R != Record.end(); R += 2)
8264 PendingContextIds.push_back(*R << 32 | *(R + 1));
8265 break;
8266 }
8267
8269 // If they are in the new order (following), they are skipped when they
8270 // follow a non-prevailing summary (CurrentPrevailingFS will be null).
8271 if (MemProfAfterFunctionSummary && !CurrentPrevailingFS) {
8272 PendingContextIds.clear();
8273 break;
8274 }
8275 unsigned I = 0;
8276 std::vector<MIBInfo> MIBs;
8277 unsigned NumMIBs = 0;
8278 if (Version >= 10)
8279 NumMIBs = Record[I++];
8280 unsigned MIBsRead = 0;
8281 while ((Version >= 10 && MIBsRead++ < NumMIBs) ||
8282 (Version < 10 && I < Record.size())) {
8283 assert(Record.size() - I >= 2);
8285 auto StackIdList = parseAllocInfoContext(Record, I);
8286 MIBs.push_back(MIBInfo(AllocType, std::move(StackIdList)));
8287 }
8288 // We either have nothing left or at least NumMIBs context size info
8289 // indices left (for the total sizes included when reporting of hinted
8290 // bytes is enabled).
8291 assert(I == Record.size() || Record.size() - I >= NumMIBs);
8292 std::vector<std::vector<ContextTotalSize>> AllContextSizes;
8293 if (I < Record.size()) {
8294 assert(!PendingContextIds.empty() &&
8295 "Missing context ids for alloc sizes");
8296 unsigned ContextIdIndex = 0;
8297 MIBsRead = 0;
8298 // The sizes are a linearized array of sizes, where for each MIB there
8299 // is 1 or more sizes (due to context trimming, each MIB in the metadata
8300 // and summarized here can correspond to more than one original context
8301 // from the profile).
8302 while (MIBsRead++ < NumMIBs) {
8303 // First read the number of contexts recorded for this MIB.
8304 unsigned NumContextSizeInfoEntries = Record[I++];
8305 assert(Record.size() - I >= NumContextSizeInfoEntries);
8306 std::vector<ContextTotalSize> ContextSizes;
8307 ContextSizes.reserve(NumContextSizeInfoEntries);
8308 for (unsigned J = 0; J < NumContextSizeInfoEntries; J++) {
8309 assert(ContextIdIndex < PendingContextIds.size());
8310 // Skip any 0 entries for MIBs without the context size info.
8311 if (PendingContextIds[ContextIdIndex] == 0) {
8312 // The size should also be 0 if the context was 0.
8313 assert(!Record[I]);
8314 ContextIdIndex++;
8315 I++;
8316 continue;
8317 }
8318 // PendingContextIds read from the preceding FS_ALLOC_CONTEXT_IDS
8319 // should be in the same order as the total sizes.
8320 ContextSizes.push_back(
8321 {PendingContextIds[ContextIdIndex++], Record[I++]});
8322 }
8323 AllContextSizes.push_back(std::move(ContextSizes));
8324 }
8325 PendingContextIds.clear();
8326 }
8327 AllocInfo AI(std::move(MIBs));
8328 if (!AllContextSizes.empty()) {
8329 assert(AI.MIBs.size() == AllContextSizes.size());
8330 AI.ContextSizeInfos = std::move(AllContextSizes);
8331 }
8332
8333 if (MemProfAfterFunctionSummary)
8334 CurrentPrevailingFS->addAlloc(std::move(AI));
8335 else
8336 PendingAllocs.push_back(std::move(AI));
8337 break;
8338 }
8339
8342 // In the combined index case we don't have a prevailing check,
8343 // so we should always have a CurrentPrevailingFS.
8344 assert(!MemProfAfterFunctionSummary || CurrentPrevailingFS);
8345 unsigned I = 0;
8346 std::vector<MIBInfo> MIBs;
8347 unsigned NumMIBs = Record[I++];
8348 unsigned NumVersions = Record[I++];
8349 unsigned MIBsRead = 0;
8350 while (MIBsRead++ < NumMIBs) {
8351 assert(Record.size() - I >= 2);
8353 SmallVector<unsigned> StackIdList;
8354 if (BitCode == bitc::FS_COMBINED_ALLOC_INFO)
8355 StackIdList = parseAllocInfoContext(Record, I);
8356 MIBs.push_back(MIBInfo(AllocType, std::move(StackIdList)));
8357 }
8358 assert(Record.size() - I >= NumVersions);
8359 SmallVector<uint8_t> Versions;
8360 for (unsigned J = 0; J < NumVersions; J++)
8361 Versions.push_back(Record[I++]);
8362 assert(I == Record.size());
8363 AllocInfo AI(std::move(Versions), std::move(MIBs));
8364 if (MemProfAfterFunctionSummary)
8365 CurrentPrevailingFS->addAlloc(std::move(AI));
8366 else
8367 PendingAllocs.push_back(std::move(AI));
8368 break;
8369 }
8370 }
8371 }
8372 llvm_unreachable("Exit infinite loop");
8373}
8374
8375// Parse the module string table block into the Index.
8376// This populates the ModulePathStringTable map in the index.
8377Error ModuleSummaryIndexBitcodeReader::parseModuleStringTable() {
8379 return Err;
8380
8381 SmallVector<uint64_t, 64> Record;
8382
8383 SmallString<128> ModulePath;
8384 ModuleSummaryIndex::ModuleInfo *LastSeenModule = nullptr;
8385
8386 while (true) {
8387 Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();
8388 if (!MaybeEntry)
8389 return MaybeEntry.takeError();
8390 BitstreamEntry Entry = MaybeEntry.get();
8391
8392 switch (Entry.Kind) {
8393 case BitstreamEntry::SubBlock: // Handled for us already.
8395 return error("Malformed block");
8397 return Error::success();
8399 // The interesting case.
8400 break;
8401 }
8402
8403 Record.clear();
8404 Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);
8405 if (!MaybeRecord)
8406 return MaybeRecord.takeError();
8407 switch (MaybeRecord.get()) {
8408 default: // Default behavior: ignore.
8409 break;
8410 case bitc::MST_CODE_ENTRY: {
8411 // MST_ENTRY: [modid, namechar x N]
8412 uint64_t ModuleId = Record[0];
8413
8414 if (convertToString(Record, 1, ModulePath))
8415 return error("Invalid code_entry record");
8416
8417 LastSeenModule = TheIndex.addModule(ModulePath);
8418 ModuleIdMap[ModuleId] = LastSeenModule->first();
8419
8420 ModulePath.clear();
8421 break;
8422 }
8423 /// MST_CODE_HASH: [5*i32]
8424 case bitc::MST_CODE_HASH: {
8425 if (Record.size() != 5)
8426 return error("Invalid hash length " + Twine(Record.size()).str());
8427 if (!LastSeenModule)
8428 return error("Invalid hash that does not follow a module path");
8429 int Pos = 0;
8430 for (auto &Val : Record) {
8431 assert(!(Val >> 32) && "Unexpected high bits set");
8432 LastSeenModule->second[Pos++] = Val;
8433 }
8434 // Reset LastSeenModule to avoid overriding the hash unexpectedly.
8435 LastSeenModule = nullptr;
8436 break;
8437 }
8438 }
8439 }
8440 llvm_unreachable("Exit infinite loop");
8441}
8442
8443namespace {
8444
8445// FIXME: This class is only here to support the transition to llvm::Error. It
8446// will be removed once this transition is complete. Clients should prefer to
8447// deal with the Error value directly, rather than converting to error_code.
8448class BitcodeErrorCategoryType : public std::error_category {
8449 const char *name() const noexcept override {
8450 return "llvm.bitcode";
8451 }
8452
8453 std::string message(int IE) const override {
8454 BitcodeError E = static_cast<BitcodeError>(IE);
8455 switch (E) {
8456 case BitcodeError::CorruptedBitcode:
8457 return "Corrupted bitcode";
8458 }
8459 llvm_unreachable("Unknown error type!");
8460 }
8461};
8462
8463} // end anonymous namespace
8464
8465const std::error_category &llvm::BitcodeErrorCategory() {
8466 static BitcodeErrorCategoryType ErrorCategory;
8467 return ErrorCategory;
8468}
8469
8471 unsigned Block, unsigned RecordID) {
8472 if (Error Err = Stream.EnterSubBlock(Block))
8473 return std::move(Err);
8474
8475 StringRef Strtab;
8476 while (true) {
8477 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
8478 if (!MaybeEntry)
8479 return MaybeEntry.takeError();
8480 llvm::BitstreamEntry Entry = MaybeEntry.get();
8481
8482 switch (Entry.Kind) {
8484 return Strtab;
8485
8487 return error("Malformed block");
8488
8490 if (Error Err = Stream.SkipBlock())
8491 return std::move(Err);
8492 break;
8493
8495 StringRef Blob;
8497 Expected<unsigned> MaybeRecord =
8498 Stream.readRecord(Entry.ID, Record, &Blob);
8499 if (!MaybeRecord)
8500 return MaybeRecord.takeError();
8501 if (MaybeRecord.get() == RecordID)
8502 Strtab = Blob;
8503 break;
8504 }
8505 }
8506}
8507
8508//===----------------------------------------------------------------------===//
8509// External interface
8510//===----------------------------------------------------------------------===//
8511
8512Expected<std::vector<BitcodeModule>>
8514 auto FOrErr = getBitcodeFileContents(Buffer);
8515 if (!FOrErr)
8516 return FOrErr.takeError();
8517 return std::move(FOrErr->Mods);
8518}
8519
8522 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
8523 if (!StreamOrErr)
8524 return StreamOrErr.takeError();
8525 BitstreamCursor &Stream = *StreamOrErr;
8526
8528 while (true) {
8529 uint64_t BCBegin = Stream.getCurrentByteNo();
8530
8531 // We may be consuming bitcode from a client that leaves garbage at the end
8532 // of the bitcode stream (e.g. Apple's ar tool). If we are close enough to
8533 // the end that there cannot possibly be another module, stop looking.
8534 if (BCBegin + 8 >= Stream.getBitcodeBytes().size())
8535 return F;
8536
8537 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
8538 if (!MaybeEntry)
8539 return MaybeEntry.takeError();
8540 llvm::BitstreamEntry Entry = MaybeEntry.get();
8541
8542 switch (Entry.Kind) {
8545 return error("Malformed block");
8546
8548 uint64_t IdentificationBit = -1ull;
8549 if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {
8550 IdentificationBit = Stream.GetCurrentBitNo() - BCBegin * 8;
8551 if (Error Err = Stream.SkipBlock())
8552 return std::move(Err);
8553
8554 {
8555 Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();
8556 if (!MaybeEntry)
8557 return MaybeEntry.takeError();
8558 Entry = MaybeEntry.get();
8559 }
8560
8561 if (Entry.Kind != BitstreamEntry::SubBlock ||
8562 Entry.ID != bitc::MODULE_BLOCK_ID)
8563 return error("Malformed block");
8564 }
8565
8566 if (Entry.ID == bitc::MODULE_BLOCK_ID) {
8567 uint64_t ModuleBit = Stream.GetCurrentBitNo() - BCBegin * 8;
8568 if (Error Err = Stream.SkipBlock())
8569 return std::move(Err);
8570
8571 F.Mods.push_back({Stream.getBitcodeBytes().slice(
8572 BCBegin, Stream.getCurrentByteNo() - BCBegin),
8573 Buffer.getBufferIdentifier(), IdentificationBit,
8574 ModuleBit});
8575 continue;
8576 }
8577
8578 if (Entry.ID == bitc::STRTAB_BLOCK_ID) {
8579 Expected<StringRef> Strtab =
8581 if (!Strtab)
8582 return Strtab.takeError();
8583 // This string table is used by every preceding bitcode module that does
8584 // not have its own string table. A bitcode file may have multiple
8585 // string tables if it was created by binary concatenation, for example
8586 // with "llvm-cat -b".
8587 for (BitcodeModule &I : llvm::reverse(F.Mods)) {
8588 if (!I.Strtab.empty())
8589 break;
8590 I.Strtab = *Strtab;
8591 }
8592 // Similarly, the string table is used by every preceding symbol table;
8593 // normally there will be just one unless the bitcode file was created
8594 // by binary concatenation.
8595 if (!F.Symtab.empty() && F.StrtabForSymtab.empty())
8596 F.StrtabForSymtab = *Strtab;
8597 continue;
8598 }
8599
8600 if (Entry.ID == bitc::SYMTAB_BLOCK_ID) {
8601 Expected<StringRef> SymtabOrErr =
8603 if (!SymtabOrErr)
8604 return SymtabOrErr.takeError();
8605
8606 // We can expect the bitcode file to have multiple symbol tables if it
8607 // was created by binary concatenation. In that case we silently
8608 // ignore any subsequent symbol tables, which is fine because this is a
8609 // low level function. The client is expected to notice that the number
8610 // of modules in the symbol table does not match the number of modules
8611 // in the input file and regenerate the symbol table.
8612 if (F.Symtab.empty())
8613 F.Symtab = *SymtabOrErr;
8614 continue;
8615 }
8616
8617 if (Error Err = Stream.SkipBlock())
8618 return std::move(Err);
8619 continue;
8620 }
8622 if (Error E = Stream.skipRecord(Entry.ID).takeError())
8623 return std::move(E);
8624 continue;
8625 }
8626 }
8627}
8628
8629/// Get a lazy one-at-time loading module from bitcode.
8630///
8631/// This isn't always used in a lazy context. In particular, it's also used by
8632/// \a parseModule(). If this is truly lazy, then we need to eagerly pull
8633/// in forward-referenced functions from block address references.
8634///
8635/// \param[in] MaterializeAll Set to \c true if we should materialize
8636/// everything.
8638BitcodeModule::getModuleImpl(LLVMContext &Context, bool MaterializeAll,
8639 bool ShouldLazyLoadMetadata, bool IsImporting,
8640 ParserCallbacks Callbacks) {
8641 BitstreamCursor Stream(Buffer);
8642
8643 std::string ProducerIdentification;
8644 if (IdentificationBit != -1ull) {
8645 if (Error JumpFailed = Stream.JumpToBit(IdentificationBit))
8646 return std::move(JumpFailed);
8647 if (Error E =
8648 readIdentificationBlock(Stream).moveInto(ProducerIdentification))
8649 return std::move(E);
8650 }
8651
8652 if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
8653 return std::move(JumpFailed);
8654 auto *R = new BitcodeReader(std::move(Stream), Strtab, ProducerIdentification,
8655 Context);
8656
8657 std::unique_ptr<Module> M =
8658 std::make_unique<Module>(ModuleIdentifier, Context);
8659 M->setMaterializer(R);
8660
8661 // Delay parsing Metadata if ShouldLazyLoadMetadata is true.
8662 if (Error Err = R->parseBitcodeInto(M.get(), ShouldLazyLoadMetadata,
8663 IsImporting, Callbacks))
8664 return std::move(Err);
8665
8666 if (MaterializeAll) {
8667 // Read in the entire module, and destroy the BitcodeReader.
8668 if (Error Err = M->materializeAll())
8669 return std::move(Err);
8670 } else {
8671 // Resolve forward references from blockaddresses.
8672 if (Error Err = R->materializeForwardReferencedFunctions())
8673 return std::move(Err);
8674 }
8675
8676 return std::move(M);
8677}
8678
8679Expected<std::unique_ptr<Module>>
8680BitcodeModule::getLazyModule(LLVMContext &Context, bool ShouldLazyLoadMetadata,
8681 bool IsImporting, ParserCallbacks Callbacks) {
8682 return getModuleImpl(Context, false, ShouldLazyLoadMetadata, IsImporting,
8683 Callbacks);
8684}
8685
8686// Parse the specified bitcode buffer and merge the index into CombinedIndex.
8687// We don't use ModuleIdentifier here because the client may need to control the
8688// module path used in the combined summary (e.g. when reading summaries for
8689// regular LTO modules).
8691 ModuleSummaryIndex &CombinedIndex, StringRef ModulePath,
8692 std::function<bool(GlobalValue::GUID)> IsPrevailing) {
8693 BitstreamCursor Stream(Buffer);
8694 if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
8695 return JumpFailed;
8696
8697 ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, CombinedIndex,
8698 ModulePath, IsPrevailing);
8699 return R.parseModule();
8700}
8701
8702// Parse the specified bitcode buffer, returning the function info index.
8704 BitstreamCursor Stream(Buffer);
8705 if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
8706 return std::move(JumpFailed);
8707
8708 auto Index = std::make_unique<ModuleSummaryIndex>(/*HaveGVs=*/false);
8709 ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, *Index,
8710 ModuleIdentifier, 0);
8711
8712 if (Error Err = R.parseModule())
8713 return std::move(Err);
8714
8715 return std::move(Index);
8716}
8717
8720 if (Error Err = Stream.EnterSubBlock(ID))
8721 return std::move(Err);
8722
8724 while (true) {
8725 BitstreamEntry Entry;
8726 if (Error E = Stream.advanceSkippingSubblocks().moveInto(Entry))
8727 return std::move(E);
8728
8729 switch (Entry.Kind) {
8730 case BitstreamEntry::SubBlock: // Handled for us already.
8732 return error("Malformed block");
8734 // If no flags record found, return both flags as false.
8735 return std::make_pair(false, false);
8736 }
8738 // The interesting case.
8739 break;
8740 }
8741
8742 // Look for the FS_FLAGS record.
8743 Record.clear();
8744 Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);
8745 if (!MaybeBitCode)
8746 return MaybeBitCode.takeError();
8747 switch (MaybeBitCode.get()) {
8748 default: // Default behavior: ignore.
8749 break;
8750 case bitc::FS_FLAGS: { // [flags]
8751 uint64_t Flags = Record[0];
8752 // Scan flags.
8753 assert(Flags <= 0x7ff && "Unexpected bits in flag");
8754
8755 bool EnableSplitLTOUnit = Flags & 0x8;
8756 bool UnifiedLTO = Flags & 0x200;
8757 return std::make_pair(EnableSplitLTOUnit, UnifiedLTO);
8758 }
8759 }
8760 }
8761 llvm_unreachable("Exit infinite loop");
8762}
8763
8764// Check if the given bitcode buffer contains a global value summary block.
8766 BitstreamCursor Stream(Buffer);
8767 if (Error JumpFailed = Stream.JumpToBit(ModuleBit))
8768 return std::move(JumpFailed);
8769
8770 if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
8771 return std::move(Err);
8772
8773 while (true) {
8775 if (Error E = Stream.advance().moveInto(Entry))
8776 return std::move(E);
8777
8778 switch (Entry.Kind) {
8780 return error("Malformed block");
8782 return BitcodeLTOInfo{/*IsThinLTO=*/false, /*HasSummary=*/false,
8783 /*EnableSplitLTOUnit=*/false, /*UnifiedLTO=*/false};
8784
8786 if (Entry.ID == bitc::GLOBALVAL_SUMMARY_BLOCK_ID ||
8789 getEnableSplitLTOUnitAndUnifiedFlag(Stream, Entry.ID);
8790 if (!Flags)
8791 return Flags.takeError();
8792 BitcodeLTOInfo LTOInfo;
8793 std::tie(LTOInfo.EnableSplitLTOUnit, LTOInfo.UnifiedLTO) = Flags.get();
8794 LTOInfo.IsThinLTO = (Entry.ID == bitc::GLOBALVAL_SUMMARY_BLOCK_ID);
8795 LTOInfo.HasSummary = true;
8796 return LTOInfo;
8797 }
8798
8799 // Ignore other sub-blocks.
8800 if (Error Err = Stream.SkipBlock())
8801 return std::move(Err);
8802 continue;
8803
8805 if (Expected<unsigned> StreamFailed = Stream.skipRecord(Entry.ID))
8806 continue;
8807 else
8808 return StreamFailed.takeError();
8809 }
8810 }
8811}
8812
8815 if (!MsOrErr)
8816 return MsOrErr.takeError();
8817
8818 if (MsOrErr->size() != 1)
8819 return error("Expected a single module");
8820
8821 return (*MsOrErr)[0];
8822}
8823
8824Expected<std::unique_ptr<Module>>
8826 bool ShouldLazyLoadMetadata, bool IsImporting,
8827 ParserCallbacks Callbacks) {
8829 if (!BM)
8830 return BM.takeError();
8831
8832 return BM->getLazyModule(Context, ShouldLazyLoadMetadata, IsImporting,
8833 Callbacks);
8834}
8835
8837 std::unique_ptr<MemoryBuffer> &&Buffer, LLVMContext &Context,
8838 bool ShouldLazyLoadMetadata, bool IsImporting, ParserCallbacks Callbacks) {
8839 auto MOrErr = getLazyBitcodeModule(*Buffer, Context, ShouldLazyLoadMetadata,
8840 IsImporting, Callbacks);
8841 if (MOrErr)
8842 (*MOrErr)->setOwnedMemoryBuffer(std::move(Buffer));
8843 return MOrErr;
8844}
8845
8848 return getModuleImpl(Context, true, false, false, Callbacks);
8849 // TODO: Restore the use-lists to the in-memory state when the bitcode was
8850 // written. We must defer until the Module has been fully materialized.
8851}
8852
8855 ParserCallbacks Callbacks) {
8857 if (!BM)
8858 return BM.takeError();
8859
8860 return BM->parseModule(Context, Callbacks);
8861}
8862
8864 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
8865 if (!StreamOrErr)
8866 return StreamOrErr.takeError();
8867
8868 return readTriple(*StreamOrErr);
8869}
8870
8872 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
8873 if (!StreamOrErr)
8874 return StreamOrErr.takeError();
8875
8876 return hasObjCCategory(*StreamOrErr);
8877}
8878
8880 Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);
8881 if (!StreamOrErr)
8882 return StreamOrErr.takeError();
8883
8884 return readIdentificationCode(*StreamOrErr);
8885}
8886
8888 ModuleSummaryIndex &CombinedIndex) {
8890 if (!BM)
8891 return BM.takeError();
8892
8893 return BM->readSummary(CombinedIndex, BM->getModuleIdentifier());
8894}
8895
8899 if (!BM)
8900 return BM.takeError();
8901
8902 return BM->getSummary();
8903}
8904
8907 if (!BM)
8908 return BM.takeError();
8909
8910 return BM->getLTOInfo();
8911}
8912
8915 bool IgnoreEmptyThinLTOIndexFile) {
8918 if (!FileOrErr)
8919 return errorCodeToError(FileOrErr.getError());
8920 if (IgnoreEmptyThinLTOIndexFile && !(*FileOrErr)->getBufferSize())
8921 return nullptr;
8922 return getModuleSummaryIndex(**FileOrErr);
8923}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
aarch64 promote const
static bool isConstant(const MachineInstr &MI)
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
Expand Atomic instructions
Atomic ordering constants.
This file contains the simple types necessary to represent the attributes associated with functions a...
static void getDecodedRelBFCallEdgeInfo(uint64_t RawFlags, uint64_t &RelBF, bool &HasTailCall)
static void upgradeDLLImportExportLinkage(GlobalValue *GV, unsigned Val)
static cl::opt< bool > PrintSummaryGUIDs("print-summary-global-ids", cl::init(false), cl::Hidden, cl::desc("Print the global id for each value when reading the module summary"))
static AtomicOrdering getDecodedOrdering(unsigned Val)
static std::pair< CalleeInfo::HotnessType, bool > getDecodedHotnessCallEdgeInfo(uint64_t RawFlags)
static FunctionSummary::FFlags getDecodedFFlags(uint64_t RawFlags)
static std::optional< CodeModel::Model > getDecodedCodeModel(unsigned Val)
static void setSpecialRefs(SmallVectorImpl< ValueInfo > &Refs, unsigned ROCnt, unsigned WOCnt)
static bool getDecodedDSOLocal(unsigned Val)
static bool convertToString(ArrayRef< uint64_t > Record, unsigned Idx, StrTy &Result)
Convert a string from a record into an std::string, return true on failure.
static GlobalVariable::UnnamedAddr getDecodedUnnamedAddrType(unsigned Val)
static void stripTBAA(Module *M)
static int getDecodedUnaryOpcode(unsigned Val, Type *Ty)
static Expected< std::string > readTriple(BitstreamCursor &Stream)
static void parseWholeProgramDevirtResolutionByArg(ArrayRef< uint64_t > Record, size_t &Slot, WholeProgramDevirtResolution &Wpd)
static uint64_t getRawAttributeMask(Attribute::AttrKind Val)
static GlobalValueSummary::GVFlags getDecodedGVSummaryFlags(uint64_t RawFlags, uint64_t Version)
static GlobalVarSummary::GVarFlags getDecodedGVarFlags(uint64_t RawFlags)
static Attribute::AttrKind getAttrFromCode(uint64_t Code)
static Expected< uint64_t > jumpToValueSymbolTable(uint64_t Offset, BitstreamCursor &Stream)
Helper to note and return the current location, and jump to the given offset.
static Expected< bool > hasObjCCategoryInModule(BitstreamCursor &Stream)
static GlobalValue::DLLStorageClassTypes getDecodedDLLStorageClass(unsigned Val)
static GEPNoWrapFlags toGEPNoWrapFlags(uint64_t Flags)
static void decodeLLVMAttributesForBitcode(AttrBuilder &B, uint64_t EncodedAttrs, uint64_t AttrIdx)
This fills an AttrBuilder object with the LLVM attributes that have been decoded from the given integ...
static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val, bool &IsElementwise)
static void parseTypeIdSummaryRecord(ArrayRef< uint64_t > Record, StringRef Strtab, ModuleSummaryIndex &TheIndex)
static void addRawAttributeValue(AttrBuilder &B, uint64_t Val)
static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val)
static bool hasImplicitComdat(size_t Val)
static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val)
static Error hasInvalidBitcodeHeader(BitstreamCursor &Stream)
static Expected< std::string > readIdentificationCode(BitstreamCursor &Stream)
static int getDecodedBinaryOpcode(unsigned Val, Type *Ty)
static Expected< BitcodeModule > getSingleModule(MemoryBufferRef Buffer)
static Expected< bool > hasObjCCategory(BitstreamCursor &Stream)
static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val)
static void parseWholeProgramDevirtResolution(ArrayRef< uint64_t > Record, StringRef Strtab, size_t &Slot, TypeIdSummary &TypeId)
static void inferDSOLocal(GlobalValue *GV)
static FastMathFlags getDecodedFastMathFlags(unsigned Val)
GlobalValue::SanitizerMetadata deserializeSanitizerMetadata(unsigned V)
static Expected< BitstreamCursor > initStream(MemoryBufferRef Buffer)
static cl::opt< bool > ExpandConstantExprs("expand-constant-exprs", cl::Hidden, cl::desc("Expand constant expressions to instructions for testing purposes"))
static bool upgradeOldMemoryAttribute(MemoryEffects &ME, uint64_t EncodedKind)
static Expected< StringRef > readBlobInRecord(BitstreamCursor &Stream, unsigned Block, unsigned RecordID)
static Expected< std::string > readIdentificationBlock(BitstreamCursor &Stream)
Read the "IDENTIFICATION_BLOCK_ID" block, do some basic enforcement on the "epoch" encoded in the bit...
static Expected< std::pair< bool, bool > > getEnableSplitLTOUnitAndUnifiedFlag(BitstreamCursor &Stream, unsigned ID)
static bool isConstExprSupported(const BitcodeConstant *BC)
static int getDecodedCastOpcode(unsigned Val)
static Expected< std::string > readModuleTriple(BitstreamCursor &Stream)
static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val)
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
static StringRef getOpcodeName(uint8_t Opcode, uint8_t OpcodeBase)
DXIL Finalize Linkage
dxil translate DXIL Translate Metadata
This file defines the DenseMap class.
@ Default
Provides ErrorOr<T> smart pointer.
This file contains the declaration of the GlobalIFunc class, which represents a single indirect funct...
Hexagon Common GEP
Module.h This file contains the declarations for the Module class.
const AbstractManglingParser< Derived, Alloc >::OperatorInfo AbstractManglingParser< Derived, Alloc >::Ops[]
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Machine Check Debug Module
AllocType
This file contains the declarations for metadata subclasses.
static bool InRange(int64_t Value, unsigned short Shift, int LBound, int HBound)
Type::TypeID TypeID
#define T
ModuleSummaryIndex.h This file contains the declarations the classes that hold the module index and s...
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
uint64_t High
PowerPC Reduce CR logical Operation
This file contains the declarations for profiling metadata utility functions.
const SmallVectorImpl< MachineOperand > & Cond
This file contains some templates that are useful if you are working with the STL at all.
static const char * name
BaseType
A given derived pointer can have multiple base pointers through phi/selects.
This file defines the SmallString class.
This file defines the SmallVector class.
#define error(X)
static SymbolRef::Type getType(const Symbol *Sym)
Definition TapiFile.cpp:39
Value * RHS
Value * LHS
Class for arbitrary precision integers.
Definition APInt.h:78
void setSwiftError(bool V)
Specify whether this alloca is used to represent a swifterror.
PointerType * getType() const
Overload to return most specific pointer type.
void setUsedWithInAlloca(bool V)
Specify whether this alloca is used to represent the arguments to a call.
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:39
size_t size() const
Get the array size.
Definition ArrayRef.h:140
bool empty() const
Check if the array is empty.
Definition ArrayRef.h:135
ArrayRef< T > slice(size_t N, size_t M) const
slice(n, m) - Chop off the first N elements of the array, and keep M elements in the array.
Definition ArrayRef.h:184
static bool isValidFailureOrdering(AtomicOrdering Ordering)
static AtomicOrdering getStrongestFailureOrdering(AtomicOrdering SuccessOrdering)
Returns the strongest permitted ordering on failure, given the desired ordering on success.
static bool isValidSuccessOrdering(AtomicOrdering Ordering)
BinOp
This enumeration lists the possible modifications atomicrmw can make.
@ Add
*p = old + v
@ FAdd
*p = old + v
@ USubCond
Subtract only if no unsigned overflow.
@ FMinimum
*p = minimum(old, v) minimum matches the behavior of llvm.minimum.
@ Min
*p = old <signed v ? old : v
@ Sub
*p = old - v
@ And
*p = old & v
@ Xor
*p = old ^ v
@ USubSat
*p = usub.sat(old, v) usub.sat matches the behavior of llvm.usub.sat.
@ FMaximum
*p = maximum(old, v) maximum matches the behavior of llvm.maximum.
@ FSub
*p = old - v
@ UIncWrap
Increment one up to a maximum value.
@ Max
*p = old >signed v ? old : v
@ UMin
*p = old <unsigned v ? old : v
@ FMin
*p = minnum(old, v) minnum matches the behavior of llvm.minnum.
@ UMax
*p = old >unsigned v ? old : v
@ FMaximumNum
*p = maximumnum(old, v) maximumnum matches the behavior of llvm.maximumnum.
@ FMax
*p = maxnum(old, v) maxnum matches the behavior of llvm.maxnum.
@ UDecWrap
Decrement one until a minimum value or zero.
@ FMinimumNum
*p = minimumnum(old, v) minimumnum matches the behavior of llvm.minimumnum.
@ Nand
*p = ~(old & v)
static bool isTypeAttrKind(AttrKind Kind)
Definition Attributes.h:143
AttrKind
This enumeration lists the attributes that can be associated with parameters, function results,...
Definition Attributes.h:124
@ TombstoneKey
Use as Tombstone key for DenseMap of AttrKind.
Definition Attributes.h:131
@ None
No attributes have been set.
Definition Attributes.h:126
@ EmptyKey
Use as Empty key for DenseMap of AttrKind.
Definition Attributes.h:130
@ EndAttrKinds
Sentinel value useful for loops.
Definition Attributes.h:129
LLVM Basic Block Representation.
Definition BasicBlock.h:62
iterator end()
Definition BasicBlock.h:474
bool empty() const
Definition BasicBlock.h:483
const Instruction & back() const
Definition BasicBlock.h:486
static BasicBlock * Create(LLVMContext &Context, const Twine &Name="", Function *Parent=nullptr, BasicBlock *InsertBefore=nullptr)
Creates a new BasicBlock.
Definition BasicBlock.h:206
LLVM_ABI void replacePhiUsesWith(BasicBlock *Old, BasicBlock *New)
Update all phi nodes in this basic block to refer to basic block New instead of basic block Old.
LLVM_ABI SymbolTableList< BasicBlock >::iterator eraseFromParent()
Unlink 'this' from the containing function and delete it.
void moveBefore(BasicBlock *MovePos)
Unlink this basic block from its current function and insert it into the function that MovePos lives ...
Definition BasicBlock.h:388
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction; assumes that the block is well-formed.
Definition BasicBlock.h:237
static LLVM_ABI BinaryOperator * Create(BinaryOps Op, Value *S1, Value *S2, const Twine &Name=Twine(), InsertPosition InsertBefore=nullptr)
Construct a binary instruction, given the opcode and the two operands.
Represents a module in a bitcode file.
LLVM_ABI Expected< std::unique_ptr< ModuleSummaryIndex > > getSummary()
Parse the specified bitcode buffer, returning the module summary index.
LLVM_ABI Expected< BitcodeLTOInfo > getLTOInfo()
Returns information about the module to be used for LTO: whether to compile with ThinLTO,...
LLVM_ABI Error readSummary(ModuleSummaryIndex &CombinedIndex, StringRef ModulePath, std::function< bool(GlobalValue::GUID)> IsPrevailing=nullptr)
Parse the specified bitcode buffer and merge its module summary index into CombinedIndex.
LLVM_ABI Expected< std::unique_ptr< Module > > parseModule(LLVMContext &Context, ParserCallbacks Callbacks={})
Read the entire bitcode module and return it.
LLVM_ABI Expected< std::unique_ptr< Module > > getLazyModule(LLVMContext &Context, bool ShouldLazyLoadMetadata, bool IsImporting, ParserCallbacks Callbacks={})
Read the bitcode module and prepare for lazy deserialization of function bodies.
Value * getValueFwdRef(unsigned Idx, Type *Ty, unsigned TyID, BasicBlock *ConstExprInsertBB)
Definition ValueList.cpp:50
void push_back(Value *V, unsigned TypeID)
Definition ValueList.h:52
void replaceValueWithoutRAUW(unsigned ValNo, Value *NewV)
Definition ValueList.h:81
Error assignValue(unsigned Idx, Value *V, unsigned TypeID)
Definition ValueList.cpp:21
void shrinkTo(unsigned N)
Definition ValueList.h:76
unsigned getTypeID(unsigned ValNo) const
Definition ValueList.h:65
unsigned size() const
Definition ValueList.h:48
This represents a position within a bitcode file, implemented on top of a SimpleBitstreamCursor.
Error JumpToBit(uint64_t BitNo)
Reset the stream to the specified bit number.
uint64_t GetCurrentBitNo() const
Return the bit # of the bit we are reading.
ArrayRef< uint8_t > getBitcodeBytes() const
Expected< word_t > Read(unsigned NumBits)
Expected< BitstreamEntry > advance(unsigned Flags=0)
Advance the current bitstream, returning the next entry in the stream.
Expected< BitstreamEntry > advanceSkippingSubblocks(unsigned Flags=0)
This is a convenience function for clients that don't expect any subblocks.
LLVM_ABI Expected< unsigned > readRecord(unsigned AbbrevID, SmallVectorImpl< uint64_t > &Vals, StringRef *Blob=nullptr)
LLVM_ABI Error EnterSubBlock(unsigned BlockID, unsigned *NumWordsP=nullptr)
Having read the ENTER_SUBBLOCK abbrevid, and enter the block.
Error SkipBlock()
Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body of this block.
LLVM_ABI Expected< unsigned > skipRecord(unsigned AbbrevID)
Read the current record and discard it, returning the code for the record.
uint64_t getCurrentByteNo() const
LLVM_ABI Expected< std::optional< BitstreamBlockInfo > > ReadBlockInfoBlock(bool ReadBlockInfoNames=false)
Read and return a block info block from the bitstream.
unsigned getAbbrevIDWidth() const
Return the number of bits used to encode an abbrev #.
bool canSkipToPos(size_t pos) const
static LLVM_ABI BlockAddress * get(Function *F, BasicBlock *BB)
Return a BlockAddress for the specified function and basic block.
@ MIN_BYTE_BITS
Minimum number of bits that can be specified.
@ MAX_BYTE_BITS
Maximum number of bits that can be specified Note that bit width is stored in the Type classes Subcla...
static LLVM_ABI ByteType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing a ByteType.
Definition Type.cpp:384
bool isInlineAsm() const
Check if this call is an inline asm statement.
Value * getCalledOperand() const
void setAttributes(AttributeList A)
Set the attributes for this call.
LLVM_ABI Intrinsic::ID getIntrinsicID() const
Returns the intrinsic ID of the intrinsic called or Intrinsic::not_intrinsic if the called function i...
unsigned arg_size() const
AttributeList getAttributes() const
Return the attributes for this call.
static CallBrInst * Create(FunctionType *Ty, Value *Func, BasicBlock *DefaultDest, ArrayRef< BasicBlock * > IndirectDests, ArrayRef< Value * > Args, const Twine &NameStr, InsertPosition InsertBefore=nullptr)
static CallInst * Create(FunctionType *Ty, Value *F, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static CaptureInfo createFromIntValue(uint32_t Data)
Definition ModRef.h:485
static CaptureInfo none()
Create CaptureInfo that does not capture any components of the pointer.
Definition ModRef.h:427
static LLVM_ABI CastInst * Create(Instruction::CastOps, Value *S, Type *Ty, const Twine &Name="", InsertPosition InsertBefore=nullptr)
Provides a way to construct any of the CastInst subclasses using an opcode instead of the subclass's ...
static LLVM_ABI bool castIsValid(Instruction::CastOps op, Type *SrcTy, Type *DstTy)
This method can be used to determine if a cast from SrcTy to DstTy using Opcode op is valid or not.
static CatchPadInst * Create(Value *CatchSwitch, ArrayRef< Value * > Args, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static CatchReturnInst * Create(Value *CatchPad, BasicBlock *BB, InsertPosition InsertBefore=nullptr)
static CatchSwitchInst * Create(Value *ParentPad, BasicBlock *UnwindDest, unsigned NumHandlers, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static CleanupPadInst * Create(Value *ParentPad, ArrayRef< Value * > Args={}, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static CleanupReturnInst * Create(Value *CleanupPad, BasicBlock *UnwindBB=nullptr, InsertPosition InsertBefore=nullptr)
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
Definition InstrTypes.h:676
static LLVM_ABI CmpInst * Create(OtherOps Op, Predicate Pred, Value *S1, Value *S2, const Twine &Name="", InsertPosition InsertBefore=nullptr)
Construct a compare instruction, given the opcode, the predicate and the two operands.
bool isFPPredicate() const
Definition InstrTypes.h:782
bool isIntPredicate() const
Definition InstrTypes.h:783
@ Largest
The linker will choose the largest COMDAT.
Definition Comdat.h:39
@ SameSize
The data referenced by the COMDAT must be the same size.
Definition Comdat.h:41
@ Any
The linker may choose any COMDAT.
Definition Comdat.h:37
@ NoDeduplicate
No deduplication is performed.
Definition Comdat.h:40
@ ExactMatch
The data referenced by the COMDAT must be the same.
Definition Comdat.h:38
static CondBrInst * Create(Value *Cond, BasicBlock *IfTrue, BasicBlock *IfFalse, InsertPosition InsertBefore=nullptr)
static LLVM_ABI Constant * get(ArrayType *T, ArrayRef< Constant * > V)
static LLVM_ABI Constant * getString(LLVMContext &Context, StringRef Initializer, bool AddNull=true, bool ByteString=false)
This method constructs a CDS and initializes it with a text string.
static LLVM_ABI bool isElementTypeCompatible(Type *Ty)
Return true if a ConstantDataSequential can be formed with a vector or array of the specified element...
static Constant * getRaw(StringRef Data, uint64_t NumElements, Type *ElementTy)
getRaw() constructor - Return a constant with vector type with an element count and element type matc...
Definition Constants.h:968
static LLVM_ABI Constant * getExtractElement(Constant *Vec, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
static LLVM_ABI Constant * getCast(unsigned ops, Constant *C, Type *Ty, bool OnlyIfReduced=false)
Convenience function for getting a Cast operation.
static LLVM_ABI Constant * getInsertElement(Constant *Vec, Constant *Elt, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
static LLVM_ABI Constant * getShuffleVector(Constant *V1, Constant *V2, ArrayRef< int > Mask, Type *OnlyIfReducedTy=nullptr)
static bool isSupportedGetElementPtr(const Type *SrcElemTy)
Whether creating a constant expression for this getelementptr type is supported.
Definition Constants.h:1579
static LLVM_ABI Constant * get(unsigned Opcode, Constant *C1, Constant *C2, unsigned Flags=0, Type *OnlyIfReducedTy=nullptr)
get - Return a binary or shift operator constant expression, folding if possible.
static LLVM_ABI bool isSupportedBinOp(unsigned Opcode)
Whether creating a constant expression for this binary operator is supported.
static Constant * getGetElementPtr(Type *Ty, Constant *C, ArrayRef< Constant * > IdxList, GEPNoWrapFlags NW=GEPNoWrapFlags::none(), std::optional< ConstantRange > InRange=std::nullopt, Type *OnlyIfReducedTy=nullptr)
Getelementptr form.
Definition Constants.h:1451
static LLVM_ABI bool isSupportedCastOp(unsigned Opcode)
Whether creating a constant expression for this cast is supported.
static ConstantInt * getSigned(IntegerType *Ty, int64_t V, bool ImplicitTrunc=false)
Return a ConstantInt with the specified value for the specified type.
Definition Constants.h:135
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition Constants.h:168
static LLVM_ABI ConstantPointerNull * get(PointerType *T)
Static factory methods - Return objects of the specified value.
static LLVM_ABI ConstantPtrAuth * get(Constant *Ptr, ConstantInt *Key, ConstantInt *Disc, Constant *AddrDisc, Constant *DeactivationSymbol)
Return a pointer signed with the specified parameters.
static LLVM_ABI bool isOrderedRanges(ArrayRef< ConstantRange > RangesRef)
LLVM_ABI bool isUpperSignWrapped() const
Return true if the (exclusive) upper bound wraps around the signed domain.
LLVM_ABI bool isFullSet() const
Return true if this set contains all of the elements possible for this data-type.
static LLVM_ABI Constant * get(StructType *T, ArrayRef< Constant * > V)
static LLVM_ABI Constant * get(ArrayRef< Constant * > V)
static LLVM_ABI Constant * getNullValue(Type *Ty)
Constructor to create a '0' constant of arbitrary type.
static LLVM_ABI DSOLocalEquivalent * get(GlobalValue *GV)
Return a DSOLocalEquivalent for the specified global value.
static LLVM_ABI Expected< DataLayout > parse(StringRef LayoutString)
Parse a data layout string and return the layout.
static DeadOnReturnInfo createFromIntValue(uint64_t Data)
Definition Attributes.h:79
ValueT lookup(const_arg_type_t< KeyT > Val) const
Return the entry for the specified key, or a default constructed value if no such entry exists.
Definition DenseMap.h:205
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:178
bool erase(const KeyT &Val)
Definition DenseMap.h:328
unsigned size() const
Definition DenseMap.h:110
bool empty() const
Definition DenseMap.h:109
size_type count(const_arg_type_t< KeyT > Val) const
Return 1 if the specified key is in the map, 0 otherwise.
Definition DenseMap.h:174
iterator end()
Definition DenseMap.h:81
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition DenseMap.h:239
Base class for error info classes.
Definition Error.h:44
virtual std::string message() const
Return the error message as a string.
Definition Error.h:52
virtual std::error_code convertToErrorCode() const =0
Convert this error to a std::error_code.
Represents either an error or a value T.
Definition ErrorOr.h:56
std::error_code getError() const
Definition ErrorOr.h:152
Lightweight error class with error context and mandatory checking.
Definition Error.h:159
static ErrorSuccess success()
Create a success value.
Definition Error.h:336
Tagged union holding either a T or a Error.
Definition Error.h:485
Error takeError()
Take ownership of the stored error.
Definition Error.h:612
reference get()
Returns a reference to the stored T value.
Definition Error.h:582
static ExtractElementInst * Create(Value *Vec, Value *Idx, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static ExtractValueInst * Create(Value *Agg, ArrayRef< unsigned > Idxs, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
Convenience struct for specifying and reasoning about fast-math flags.
Definition FMF.h:23
void setFast(bool B=true)
Definition FMF.h:99
bool any() const
Definition FMF.h:59
void setAllowContract(bool B=true)
Definition FMF.h:93
void setAllowReciprocal(bool B=true)
Definition FMF.h:90
void setNoSignedZeros(bool B=true)
Definition FMF.h:87
void setNoNaNs(bool B=true)
Definition FMF.h:81
void setAllowReassoc(bool B=true)
Flag setters.
Definition FMF.h:78
void setApproxFunc(bool B=true)
Definition FMF.h:96
void setNoInfs(bool B=true)
Definition FMF.h:84
static LLVM_ABI FixedVectorType * get(Type *ElementType, unsigned NumElts)
Definition Type.cpp:873
void addCallsite(CallsiteInfo &&Callsite)
std::pair< ValueInfo, CalleeInfo > EdgeTy
<CalleeValueInfo, CalleeInfo> call edge pair.
void addAlloc(AllocInfo &&Alloc)
static Function * Create(FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace, const Twine &N="", Module *M=nullptr)
Definition Function.h:168
BasicBlockListType::iterator iterator
Definition Function.h:70
bool empty() const
Definition Function.h:859
iterator begin()
Definition Function.h:853
iterator end()
Definition Function.h:855
Represents flags for the getelementptr instruction/expression.
static GEPNoWrapFlags inBounds()
static GEPNoWrapFlags noUnsignedWrap()
static GEPNoWrapFlags noUnsignedSignedWrap()
static GetElementPtrInst * Create(Type *PointeeType, Value *Ptr, ArrayRef< Value * > IdxList, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static LLVM_ABI GlobalAlias * create(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage, const Twine &Name, Constant *Aliasee, Module *Parent)
If a parent module is specified, the alias is automatically inserted into the end of the specified mo...
Definition Globals.cpp:621
static LLVM_ABI GlobalIFunc * create(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage, const Twine &Name, Constant *Resolver, Module *Parent)
If a parent module is specified, the ifunc is automatically inserted into the end of the specified mo...
Definition Globals.cpp:678
LLVM_ABI void setComdat(Comdat *C)
Definition Globals.cpp:223
LLVM_ABI void setSection(StringRef S)
Change the section for this global.
Definition Globals.cpp:284
void setOriginalName(GlobalValue::GUID Name)
Initialize the original name hash in this summary.
static LLVM_ABI GUID getGUIDAssumingExternalLinkage(StringRef GlobalName)
Return a 64-bit global unique ID constructed from the name of a global symbol.
Definition Globals.cpp:80
static bool isLocalLinkage(LinkageTypes Linkage)
void setUnnamedAddr(UnnamedAddr Val)
uint64_t GUID
Declare a type to represent a global unique identifier for a global value.
bool hasLocalLinkage() const
bool hasDefaultVisibility() const
void setDLLStorageClass(DLLStorageClassTypes C)
void setThreadLocalMode(ThreadLocalMode Val)
bool hasExternalWeakLinkage() const
DLLStorageClassTypes
Storage classes of global values for PE targets.
Definition GlobalValue.h:74
@ DLLExportStorageClass
Function to be accessible from DLL.
Definition GlobalValue.h:77
@ DLLImportStorageClass
Function to be imported from DLL.
Definition GlobalValue.h:76
void setDSOLocal(bool Local)
PointerType * getType() const
Global values are always pointers.
VisibilityTypes
An enumeration for the kinds of visibility of global values.
Definition GlobalValue.h:67
@ DefaultVisibility
The GV is visible.
Definition GlobalValue.h:68
@ HiddenVisibility
The GV is hidden.
Definition GlobalValue.h:69
@ ProtectedVisibility
The GV is protected.
Definition GlobalValue.h:70
static LLVM_ABI std::string getGlobalIdentifier(StringRef Name, GlobalValue::LinkageTypes Linkage, StringRef FileName)
Return the modified name for a global value suitable to be used as the key for a global lookup (e....
Definition Globals.cpp:170
void setVisibility(VisibilityTypes V)
LLVM_ABI void setSanitizerMetadata(SanitizerMetadata Meta)
Definition Globals.cpp:260
LinkageTypes
An enumeration for the kinds of linkage for global values.
Definition GlobalValue.h:52
@ PrivateLinkage
Like Internal, but omit from symbol table.
Definition GlobalValue.h:61
@ CommonLinkage
Tentative definitions.
Definition GlobalValue.h:63
@ InternalLinkage
Rename collisions when linking (static functions).
Definition GlobalValue.h:60
@ LinkOnceAnyLinkage
Keep one copy of function when linking (inline)
Definition GlobalValue.h:55
@ WeakODRLinkage
Same, but only replaced by something equivalent.
Definition GlobalValue.h:58
@ ExternalLinkage
Externally visible function.
Definition GlobalValue.h:53
@ WeakAnyLinkage
Keep one copy of named function when linking (weak)
Definition GlobalValue.h:57
@ AppendingLinkage
Special purpose, only applies to global arrays.
Definition GlobalValue.h:59
@ AvailableExternallyLinkage
Available for inspection, not emission.
Definition GlobalValue.h:54
@ ExternalWeakLinkage
ExternalWeak linkage description.
Definition GlobalValue.h:62
@ LinkOnceODRLinkage
Same, but only replaced by something equivalent.
Definition GlobalValue.h:56
LLVM_ABI void setPartition(StringRef Part)
Definition Globals.cpp:237
void setAttributes(AttributeSet A)
Set attribute list for this global.
LLVM_ABI void setCodeModel(CodeModel::Model CM)
Change the code model for this global.
Definition Globals.cpp:589
void setAlignment(Align Align)
Sets the alignment attribute of the GlobalVariable.
LLVM_ABI void addDestination(BasicBlock *Dest)
Add a destination.
static IndirectBrInst * Create(Value *Address, unsigned NumDests, InsertPosition InsertBefore=nullptr)
unsigned getNumDestinations() const
return the number of possible destinations in this indirectbr instruction.
static LLVM_ABI InlineAsm * get(FunctionType *Ty, StringRef AsmString, StringRef Constraints, bool hasSideEffects, bool isAlignStack=false, AsmDialect asmDialect=AD_ATT, bool canThrow=false)
InlineAsm::get - Return the specified uniqued inline asm string.
Definition InlineAsm.cpp:43
std::vector< ConstraintInfo > ConstraintInfoVector
Definition InlineAsm.h:123
static InsertElementInst * Create(Value *Vec, Value *NewElt, Value *Idx, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static InsertValueInst * Create(Value *Agg, Value *Val, ArrayRef< unsigned > Idxs, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
bool isCast() const
bool isBinaryOp() const
LLVM_ABI void replaceSuccessorWith(BasicBlock *OldBB, BasicBlock *NewBB)
Replace specified successor OldBB to point at the provided block.
const char * getOpcodeName() const
bool isUnaryOp() const
LLVM_ABI InstListType::iterator insertInto(BasicBlock *ParentBB, InstListType::iterator It)
Inserts an unlinked instruction into ParentBB at position It and returns the iterator of the inserted...
static LLVM_ABI IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
Definition Type.cpp:354
@ MIN_INT_BITS
Minimum number of bits that can be specified.
@ MAX_INT_BITS
Maximum number of bits that can be specified.
static InvokeInst * Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, BasicBlock *IfException, ArrayRef< Value * > Args, const Twine &NameStr, InsertPosition InsertBefore=nullptr)
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
static LLVM_ABI LandingPadInst * Create(Type *RetTy, unsigned NumReservedClauses, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
Constructors - NumReservedClauses is a hint for the number of incoming clauses that this landingpad w...
LLVM_ABI void addClause(Constant *ClauseVal)
Add a catch or filter clause to the landing pad.
void setCleanup(bool V)
Indicate that this landingpad instruction is a cleanup.
LLVM_ABI StringRef getString() const
Definition Metadata.cpp:632
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition MapVector.h:124
ValueT lookup(const KeyT &Key) const
Definition MapVector.h:108
size_t getBufferSize() const
StringRef getBufferIdentifier() const
const char * getBufferStart() const
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileOrSTDIN(const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, std::optional< Align > Alignment=std::nullopt)
Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-".
static MemoryEffectsBase readOnly()
Definition ModRef.h:133
static MemoryEffectsBase argMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:143
static MemoryEffectsBase inaccessibleMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:149
static MemoryEffectsBase errnoMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:154
static MemoryEffectsBase createFromIntValue(uint32_t Data)
Definition ModRef.h:208
static MemoryEffectsBase writeOnly()
Definition ModRef.h:138
static MemoryEffectsBase otherMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:159
static MemoryEffectsBase inaccessibleOrArgMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:166
static MemoryEffectsBase none()
Definition ModRef.h:128
static MemoryEffectsBase unknown()
Definition ModRef.h:123
static LLVM_ABI MetadataAsValue * get(LLVMContext &Context, Metadata *MD)
Definition Metadata.cpp:110
Class to hold module path string table and global value map, and encapsulate methods for operating on...
TypeIdSummary & getOrInsertTypeIdSummary(StringRef TypeId)
Return an existing or new TypeIdSummary entry for TypeId.
ModulePathStringTableTy::value_type ModuleInfo
ValueInfo getOrInsertValueInfo(GlobalValue::GUID GUID)
Return a ValueInfo for GUID.
static constexpr uint64_t BitcodeSummaryVersion
StringRef saveString(StringRef String)
LLVM_ABI void setFlags(uint64_t Flags)
CfiFunctionIndex & cfiFunctionDecls()
ModuleInfo * addModule(StringRef ModPath, ModuleHash Hash=ModuleHash{{0}})
Add a new module with the given Hash, mapped to the given ModID, and return a reference to the module...
void addGlobalValueSummary(const GlobalValue &GV, std::unique_ptr< GlobalValueSummary > Summary)
Add a global value summary for a value.
CfiFunctionIndex & cfiFunctionDefs()
GlobalValueSummary * findSummaryInModule(ValueInfo VI, StringRef ModuleId) const
Find the summary for ValueInfo VI in module ModuleId, or nullptr if not found.
unsigned addOrGetStackIdIndex(uint64_t StackId)
ModuleInfo * getModule(StringRef ModPath)
Return module entry for module with the given ModPath.
void addOriginalName(GlobalValue::GUID ValueGUID, GlobalValue::GUID OrigGUID)
Add an original name for the value of the given GUID.
TypeIdCompatibleVtableInfo & getOrInsertTypeIdCompatibleVtableSummary(StringRef TypeId)
Return an existing or new TypeIdCompatibleVtableMap entry for TypeId.
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
const Triple & getTargetTriple() const
Get the target triple which is a string describing the target host.
Definition Module.h:283
NamedMDNode * getNamedMetadata(StringRef Name) const
Return the first NamedMDNode in the module with the specified name.
Definition Module.cpp:301
NamedMDNode * getOrInsertNamedMetadata(StringRef Name)
Return the named MDNode in the module with the specified name.
Definition Module.cpp:308
Comdat * getOrInsertComdat(StringRef Name)
Return the Comdat in the module with the specified name.
Definition Module.cpp:621
Metadata * getModuleFlag(StringRef Key) const
Return the corresponding value if Key appears in module flags, otherwise return null.
Definition Module.cpp:358
LLVM_ABI void addOperand(MDNode *M)
static LLVM_ABI NoCFIValue * get(GlobalValue *GV)
Return a NoCFIValue for the specified function.
void addIncoming(Value *V, BasicBlock *BB)
Add an incoming value to the end of the PHI list.
static PHINode * Create(Type *Ty, unsigned NumReservedValues, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
Constructors - NumReservedValues is a hint for the number of incoming edges that this phi node will h...
static LLVM_ABI PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
static ResumeInst * Create(Value *Exn, InsertPosition InsertBefore=nullptr)
static ReturnInst * Create(LLVMContext &C, Value *retVal=nullptr, InsertPosition InsertBefore=nullptr)
static SelectInst * Create(Value *C, Value *S1, Value *S2, const Twine &NameStr="", InsertPosition InsertBefore=nullptr, const Instruction *MDFrom=nullptr)
ArrayRef< int > getShuffleMask() const
void append(StringRef RHS)
Append from a StringRef.
Definition SmallString.h:68
StringRef str() const
Explicit conversion to StringRef.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
void reserve(size_type N)
iterator erase(const_iterator CI)
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef first() const
Represent a constant reference to a string, i.e.
Definition StringRef.h:55
std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition StringRef.h:729
constexpr bool empty() const
Check if the string is empty.
Definition StringRef.h:140
constexpr size_t size() const
Get the string size.
Definition StringRef.h:143
constexpr const char * data() const
Get a pointer to the start of the string (which may not be null terminated).
Definition StringRef.h:137
static LLVM_ABI StructType * get(LLVMContext &Context, ArrayRef< Type * > Elements, bool isPacked=false)
This static method is the primary way to create a literal StructType.
Definition Type.cpp:483
static LLVM_ABI StructType * create(LLVMContext &Context, StringRef Name)
This creates an identified struct.
Definition Type.cpp:689
LLVM_ABI void setName(StringRef Name)
Change the name of this type to the specified name, or to a name with a suffix if there is a collisio...
Definition Type.cpp:638
LLVM_ABI Error setBodyOrError(ArrayRef< Type * > Elements, bool isPacked=false)
Specify a body for an opaque identified type or return an error if it would make the type recursive.
Definition Type.cpp:608
static SwitchInst * Create(Value *Value, BasicBlock *Default, unsigned NumCases, InsertPosition InsertBefore=nullptr)
LLVM_ABI bool visitTBAAMetadata(const Instruction *I, const MDNode *MD)
Visit an instruction, or a TBAA node itself as part of a metadata, and return true if it is valid,...
@ HasZeroInit
zeroinitializer is valid for this target extension type.
static LLVM_ABI Expected< TargetExtType * > getOrError(LLVMContext &Context, StringRef Name, ArrayRef< Type * > Types={}, ArrayRef< unsigned > Ints={})
Return a target extension type having the specified name and optional type and integer parameters,...
Definition Type.cpp:984
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
LLVM_ABI std::string str() const
Return the twine contents as a std::string.
Definition Twine.cpp:17
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
LLVM_ABI Type * getStructElementType(unsigned N) const
bool isVectorTy() const
True if this is an instance of VectorType.
Definition Type.h:290
bool isArrayTy() const
True if this is an instance of ArrayType.
Definition Type.h:281
static LLVM_ABI IntegerType * getInt32Ty(LLVMContext &C)
Definition Type.cpp:313
bool isLabelTy() const
Return true if this is 'label'.
Definition Type.h:230
bool isIntOrIntVectorTy() const
Return true if this is an integer type or a vector of integer types.
Definition Type.h:263
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:284
Type * getArrayElementType() const
Definition Type.h:427
LLVM_ABI unsigned getStructNumElements() const
LLVM_ABI uint64_t getArrayNumElements() const
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition Type.h:370
bool isStructTy() const
True if this is an instance of StructType.
Definition Type.h:278
bool isByteOrByteVectorTy() const
Return true if this is a byte type or a vector of byte types.
Definition Type.h:248
bool isSized(SmallPtrSetImpl< Type * > *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition Type.h:328
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
Definition Type.h:130
LLVM_ABI unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
Definition Type.cpp:236
bool isFunctionTy() const
True if this is an instance of FunctionType.
Definition Type.h:275
bool isFPOrFPVectorTy() const
Return true if this is a FP type or a vector of FP.
Definition Type.h:227
Type * getContainedType(unsigned i) const
This method is used to implement the type iterator (defined at the end of the file).
Definition Type.h:399
bool isVoidTy() const
Return true if this is 'void'.
Definition Type.h:141
bool isMetadataTy() const
Return true if this is 'metadata'.
Definition Type.h:233
static LLVM_ABI UnaryOperator * Create(UnaryOps Op, Value *S, const Twine &Name=Twine(), InsertPosition InsertBefore=nullptr)
Construct a unary instruction, given the opcode and an operand.
static UncondBrInst * Create(BasicBlock *Target, InsertPosition InsertBefore=nullptr)
static LLVM_ABI UndefValue * get(Type *T)
Static factory methods - Return an 'undef' object of the specified type.
static LLVM_ABI ValueAsMetadata * get(Value *V)
Definition Metadata.cpp:509
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
LLVM_ABI void setName(const Twine &Name)
Change the name of the value.
Definition Value.cpp:393
LLVM_ABI void deleteValue()
Delete a pointer to a generic Value.
Definition Value.cpp:107
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:202
bool contains(const_arg_type_t< ValueT > V) const
Check if the set contains the given element.
Definition DenseSet.h:175
const ParentTy * getParent() const
Definition ilist_node.h:34
self_iterator getIterator()
Definition ilist_node.h:123
CallInst * Call
This file contains the declaration of the Comdat class, which represents a single COMDAT in LLVM.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
constexpr char TypeName[]
Key for Kernel::Arg::Metadata::mTypeName.
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
constexpr char Attrs[]
Key for Kernel::Metadata::mAttrs.
constexpr std::underlying_type_t< E > Mask()
Get a bitmask with 1s in all places up to the high-order bit of E's largest value.
@ Entry
Definition COFF.h:862
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition CallingConv.h:24
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
constexpr uint8_t RecordLength
Length of the parts of a physical GOFF record.
Definition GOFF.h:28
@ BasicBlock
Various leaf nodes.
Definition ISDOpcodes.h:81
LLVM_ABI AttributeList getAttributes(LLVMContext &C, ID id, FunctionType *FT)
Return the attributes for an intrinsic.
@ SingleThread
Synchronized with respect to signal handlers executing in the same thread.
Definition LLVMContext.h:55
@ System
Synchronized with respect to all concurrently executing threads.
Definition LLVMContext.h:58
@ TYPE_CODE_TARGET_TYPE
@ TYPE_CODE_STRUCT_ANON
@ TYPE_CODE_STRUCT_NAME
@ TYPE_CODE_OPAQUE_POINTER
@ TYPE_CODE_FUNCTION_OLD
@ TYPE_CODE_STRUCT_NAMED
@ FS_CONTEXT_RADIX_TREE_ARRAY
@ FS_COMBINED_GLOBALVAR_INIT_REFS
@ FS_TYPE_CHECKED_LOAD_VCALLS
@ FS_COMBINED_ORIGINAL_NAME
@ FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS
@ FS_TYPE_TEST_ASSUME_CONST_VCALL
@ FS_PERMODULE_GLOBALVAR_INIT_REFS
@ FS_TYPE_TEST_ASSUME_VCALLS
@ FS_COMBINED_ALLOC_INFO_NO_CONTEXT
@ FS_CFI_FUNCTION_DECLS
@ FS_COMBINED_CALLSITE_INFO
@ FS_COMBINED_ALLOC_INFO
@ FS_PERMODULE_CALLSITE_INFO
@ FS_PERMODULE_ALLOC_INFO
@ FS_TYPE_CHECKED_LOAD_CONST_VCALL
@ BITCODE_CURRENT_EPOCH
@ IDENTIFICATION_CODE_EPOCH
@ IDENTIFICATION_CODE_STRING
@ CST_CODE_CE_INBOUNDS_GEP
@ CST_CODE_INLINEASM_OLD3
@ CST_CODE_BLOCKADDRESS
@ CST_CODE_NO_CFI_VALUE
@ CST_CODE_CE_SHUFVEC_EX
@ CST_CODE_CE_EXTRACTELT
@ CST_CODE_INLINEASM_OLD
@ CST_CODE_CE_GEP_WITH_INRANGE_INDEX_OLD
@ CST_CODE_CE_SHUFFLEVEC
@ CST_CODE_WIDE_INTEGER
@ CST_CODE_DSO_LOCAL_EQUIVALENT
@ CST_CODE_CE_INSERTELT
@ CST_CODE_INLINEASM_OLD2
@ CST_CODE_CE_GEP_WITH_INRANGE
@ VST_CODE_COMBINED_ENTRY
@ COMDAT_SELECTION_KIND_LARGEST
@ COMDAT_SELECTION_KIND_ANY
@ COMDAT_SELECTION_KIND_SAME_SIZE
@ COMDAT_SELECTION_KIND_EXACT_MATCH
@ COMDAT_SELECTION_KIND_NO_DUPLICATES
@ ATTR_KIND_STACK_PROTECT
@ ATTR_KIND_STACK_PROTECT_STRONG
@ ATTR_KIND_SANITIZE_MEMORY
@ ATTR_KIND_OPTIMIZE_FOR_SIZE
@ ATTR_KIND_SWIFT_ERROR
@ ATTR_KIND_INACCESSIBLEMEM_ONLY
@ ATTR_KIND_NO_CALLBACK
@ ATTR_KIND_FNRETTHUNK_EXTERN
@ ATTR_KIND_NO_DIVERGENCE_SOURCE
@ ATTR_KIND_SANITIZE_ADDRESS
@ ATTR_KIND_NO_IMPLICIT_FLOAT
@ ATTR_KIND_DEAD_ON_UNWIND
@ ATTR_KIND_STACK_ALIGNMENT
@ ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY
@ ATTR_KIND_STACK_PROTECT_REQ
@ ATTR_KIND_INLINE_HINT
@ ATTR_KIND_NULL_POINTER_IS_VALID
@ ATTR_KIND_SANITIZE_HWADDRESS
@ ATTR_KIND_MUSTPROGRESS
@ ATTR_KIND_RETURNS_TWICE
@ ATTR_KIND_SHADOWCALLSTACK
@ ATTR_KIND_OPT_FOR_FUZZING
@ ATTR_KIND_DENORMAL_FPENV
@ ATTR_KIND_SANITIZE_NUMERICAL_STABILITY
@ ATTR_KIND_INITIALIZES
@ ATTR_KIND_ALLOCATED_POINTER
@ ATTR_KIND_DISABLE_SANITIZER_INSTRUMENTATION
@ ATTR_KIND_SKIP_PROFILE
@ ATTR_KIND_ELEMENTTYPE
@ ATTR_KIND_CORO_ELIDE_SAFE
@ ATTR_KIND_NO_DUPLICATE
@ ATTR_KIND_ALLOC_ALIGN
@ ATTR_KIND_NON_LAZY_BIND
@ ATTR_KIND_DEREFERENCEABLE
@ ATTR_KIND_OPTIMIZE_NONE
@ ATTR_KIND_NO_RED_ZONE
@ ATTR_KIND_DEREFERENCEABLE_OR_NULL
@ ATTR_KIND_SANITIZE_REALTIME
@ ATTR_KIND_SPECULATIVE_LOAD_HARDENING
@ ATTR_KIND_ALWAYS_INLINE
@ ATTR_KIND_SANITIZE_TYPE
@ ATTR_KIND_PRESPLIT_COROUTINE
@ ATTR_KIND_VSCALE_RANGE
@ ATTR_KIND_SANITIZE_ALLOC_TOKEN
@ ATTR_KIND_NO_SANITIZE_COVERAGE
@ ATTR_KIND_NO_CREATE_UNDEF_OR_POISON
@ ATTR_KIND_SPECULATABLE
@ ATTR_KIND_DEAD_ON_RETURN
@ ATTR_KIND_SANITIZE_REALTIME_BLOCKING
@ ATTR_KIND_NO_SANITIZE_BOUNDS
@ ATTR_KIND_SANITIZE_MEMTAG
@ ATTR_KIND_CORO_ONLY_DESTROY_WHEN_COMPLETE
@ ATTR_KIND_SANITIZE_THREAD
@ ATTR_KIND_OPTIMIZE_FOR_DEBUGGING
@ ATTR_KIND_PREALLOCATED
@ ATTR_KIND_SWIFT_ASYNC
@ SYNC_SCOPE_NAMES_BLOCK_ID
@ PARAMATTR_GROUP_BLOCK_ID
@ METADATA_KIND_BLOCK_ID
@ IDENTIFICATION_BLOCK_ID
@ GLOBALVAL_SUMMARY_BLOCK_ID
@ METADATA_ATTACHMENT_ID
@ FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID
@ MODULE_STRTAB_BLOCK_ID
@ VALUE_SYMTAB_BLOCK_ID
@ OPERAND_BUNDLE_TAGS_BLOCK_ID
@ BLOCKINFO_BLOCK_ID
BLOCKINFO_BLOCK is used to define metadata about blocks, for example, standard abbrevs that should be...
@ MODULE_CODE_VERSION
@ MODULE_CODE_SOURCE_FILENAME
@ MODULE_CODE_SECTIONNAME
@ MODULE_CODE_DATALAYOUT
@ MODULE_CODE_GLOBALVAR
@ MODULE_CODE_ALIAS_OLD
@ MODULE_CODE_VSTOFFSET
@ FUNC_CODE_INST_ATOMICRMW_OLD
@ FUNC_CODE_INST_CATCHRET
@ FUNC_CODE_INST_LANDINGPAD
@ FUNC_CODE_INST_EXTRACTVAL
@ FUNC_CODE_INST_CATCHPAD
@ FUNC_CODE_INST_RESUME
@ FUNC_CODE_INST_CALLBR
@ FUNC_CODE_INST_CATCHSWITCH
@ FUNC_CODE_INST_INBOUNDS_GEP_OLD
@ FUNC_CODE_INST_VSELECT
@ FUNC_CODE_INST_GEP_OLD
@ FUNC_CODE_INST_STOREATOMIC_OLD
@ FUNC_CODE_INST_CLEANUPRET
@ FUNC_CODE_INST_LANDINGPAD_OLD
@ FUNC_CODE_DEBUG_RECORD_VALUE
@ FUNC_CODE_INST_LOADATOMIC
@ FUNC_CODE_DEBUG_RECORD_ASSIGN
@ FUNC_CODE_INST_STOREATOMIC
@ FUNC_CODE_INST_ATOMICRMW
@ FUNC_CODE_DEBUG_RECORD_DECLARE_VALUE
@ FUNC_CODE_DEBUG_LOC_AGAIN
@ FUNC_CODE_INST_EXTRACTELT
@ FUNC_CODE_INST_INDIRECTBR
@ FUNC_CODE_INST_INVOKE
@ FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE
@ FUNC_CODE_INST_INSERTVAL
@ FUNC_CODE_DECLAREBLOCKS
@ FUNC_CODE_DEBUG_RECORD_LABEL
@ FUNC_CODE_INST_SWITCH
@ FUNC_CODE_INST_ALLOCA
@ FUNC_CODE_INST_INSERTELT
@ FUNC_CODE_INST_SELECT
@ FUNC_CODE_BLOCKADDR_USERS
@ FUNC_CODE_INST_CLEANUPPAD
@ FUNC_CODE_INST_SHUFFLEVEC
@ FUNC_CODE_INST_STORE_OLD
@ FUNC_CODE_INST_FREEZE
@ FUNC_CODE_INST_CMPXCHG
@ FUNC_CODE_INST_UNREACHABLE
@ FUNC_CODE_INST_CMPXCHG_OLD
@ FUNC_CODE_DEBUG_RECORD_DECLARE
@ FUNC_CODE_OPERAND_BUNDLE
@ PARAMATTR_CODE_ENTRY_OLD
@ PARAMATTR_GRP_CODE_ENTRY
initializer< Ty > init(const Ty &Val)
constexpr double e
NodeAddr< FuncNode * > Func
Definition RDFGraph.h:393
bool empty() const
Definition BasicBlock.h:101
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
constexpr bool IsBigEndianHost
This is an optimization pass for GlobalISel generic memory operations.
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition STLExtras.h:315
@ Low
Lower the current thread's priority such that it does not affect foreground tasks significantly.
Definition Threading.h:280
@ Offset
Definition DWP.cpp:557
detail::zippy< detail::zip_shortest, T, U, Args... > zip(T &&t, U &&u, Args &&...args)
zip iterator for two or more iteratable types.
Definition STLExtras.h:830
FunctionAddr VTableAddr Value
Definition InstrProf.h:137
LLVM_ABI void UpgradeIntrinsicCall(CallBase *CB, Function *NewFn)
This is the complement to the above, replacing a specific call to an intrinsic function with a call t...
StringMapEntry< Value * > ValueName
Definition Value.h:56
std::vector< VirtFuncOffset > VTableFuncList
List of functions referenced by a particular vtable definition.
LLVM_ABI const std::error_category & BitcodeErrorCategory()
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Definition STLExtras.h:1668
LLVM_ABI Expected< std::unique_ptr< Module > > parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context, ParserCallbacks Callbacks={})
Read the specified bitcode file, returning the module.
LLVM_ABI unsigned getBranchWeightOffset(const MDNode *ProfileData)
Return the offset to the first branch weight data.
LLVM_ABI void UpgradeInlineAsmString(std::string *AsmStr)
Upgrade comment in call to inline asm that represents an objc retain release marker.
auto enumerate(FirstRange &&First, RestRanges &&...Rest)
Given two or more input ranges, returns a new range whose values are tuples (A, B,...
Definition STLExtras.h:2553
std::error_code make_error_code(BitcodeError E)
LLVM_ABI bool stripDebugInfo(Function &F)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
AllocFnKind
Definition Attributes.h:53
LLVM_ABI Expected< bool > isBitcodeContainingObjCCategory(MemoryBufferRef Buffer)
Return true if Buffer contains a bitcode file with ObjC code (category or class) in it.
void handleAllErrors(Error E, HandlerTs &&... Handlers)
Behaves the same as handleErrors, except that by contract all errors must be handled by the given han...
Definition Error.h:1013
LLVM_ABI bool UpgradeIntrinsicFunction(Function *F, Function *&NewFn, bool CanUpgradeDebugIntrinsicsToRecords=true)
This is a more granular function that simply checks an intrinsic function for upgrading,...
LLVM_ABI void UpgradeAttributes(AttrBuilder &B)
Upgrade attributes that changed format or kind.
LLVM_ABI Expected< std::string > getBitcodeTargetTriple(MemoryBufferRef Buffer)
Read the header of the specified bitcode buffer and extract just the triple information.
LLVM_ABI std::unique_ptr< Module > parseModule(const uint8_t *Data, size_t Size, LLVMContext &Context)
Fuzzer friendly interface for the llvm bitcode parser.
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition STLExtras.h:2207
LLVM_ABI Expected< BitcodeFileContents > getBitcodeFileContents(MemoryBufferRef Buffer)
Returns the contents of a bitcode file.
LLVM_ABI void UpgradeNVVMAnnotations(Module &M)
Convert legacy nvvm.annotations metadata to appropriate function attributes.
iterator_range< early_inc_iterator_impl< detail::IterOfRange< RangeT > > > make_early_inc_range(RangeT &&Range)
Make a range that does early increment to allow mutation of the underlying range without disrupting i...
Definition STLExtras.h:633
auto cast_or_null(const Y &Val)
Definition Casting.h:714
LLVM_ABI bool UpgradeModuleFlags(Module &M)
This checks for module flags which should be upgraded.
MemoryEffectsBase< IRMemLocation > MemoryEffects
Summary of how a function affects memory in the program.
Definition ModRef.h:356
void copyModuleAttrToFunctions(Module &M)
Copies module attributes to the functions in the module.
auto uninitialized_copy(R &&Src, IterTy Dst)
Definition STLExtras.h:2110
LLVM_ABI Value * getSplatValue(const Value *V)
Get splat value if the input is a splat vector or return nullptr.
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition Error.h:1321
LLVM_ABI void UpgradeOperandBundles(std::vector< OperandBundleDef > &OperandBundles)
Upgrade operand bundles (without knowing about their user instruction).
LLVM_ABI Constant * UpgradeBitCastExpr(unsigned Opc, Constant *C, Type *DestTy)
This is an auto-upgrade for bitcast constant expression between pointers with different address space...
LLVM_ABI Expected< std::unique_ptr< ModuleSummaryIndex > > getModuleSummaryIndex(MemoryBufferRef Buffer)
Parse the specified bitcode buffer, returning the module summary index.
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
OutputIt transform(R &&Range, OutputIt d_first, UnaryFunction F)
Wrapper function around std::transform to apply a function to a range and store the result elsewhere.
Definition STLExtras.h:2025
FunctionAddr VTableAddr uintptr_t uintptr_t Version
Definition InstrProf.h:334
LLVM_ABI Expected< std::string > getBitcodeProducerString(MemoryBufferRef Buffer)
Read the header of the specified bitcode buffer and extract just the producer string information.
auto reverse(ContainerTy &&C)
Definition STLExtras.h:407
LLVM_ABI Expected< std::unique_ptr< Module > > getLazyBitcodeModule(MemoryBufferRef Buffer, LLVMContext &Context, bool ShouldLazyLoadMetadata=false, bool IsImporting=false, ParserCallbacks Callbacks={})
Read the header of the specified bitcode buffer and prepare for lazy deserialization of function bodi...
UWTableKind
Definition CodeGen.h:154
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition MathExtras.h:279
FPClassTest
Floating-point class tests, supported by 'is_fpclass' intrinsic.
detail::ValueMatchesPoly< M > HasValue(M Matcher)
Definition Error.h:221
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:207
LLVM_ABI std::string UpgradeDataLayoutString(StringRef DL, StringRef Triple)
Upgrade the datalayout string by adding a section for address space pointers.
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1752
LLVM_ABI Expected< std::vector< BitcodeModule > > getBitcodeModuleList(MemoryBufferRef Buffer)
Returns a list of modules in the specified bitcode buffer.
LLVM_ABI Expected< BitcodeLTOInfo > getBitcodeLTOInfo(MemoryBufferRef Buffer)
Returns LTO information for the specified bitcode file.
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI GlobalVariable * UpgradeGlobalVariable(GlobalVariable *GV)
This checks for global variables which should be upgraded.
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
Error make_error(ArgTs &&... Args)
Make a Error instance representing failure using the given error info type.
Definition Error.h:340
LLVM_ABI bool StripDebugInfo(Module &M)
Strip debug info in the module if it exists.
AtomicOrdering
Atomic ordering for LLVM's memory model.
ModRefInfo
Flags indicating whether a memory access modifies or references memory.
Definition ModRef.h:28
@ ArgMem
Access to memory via argument pointers.
Definition ModRef.h:62
@ InaccessibleMem
Memory that is inaccessible via LLVM IR.
Definition ModRef.h:64
LLVM_ABI Instruction * UpgradeBitCastInst(unsigned Opc, Value *V, Type *DestTy, Instruction *&Temp)
This is an auto-upgrade for bitcast between pointers with different address spaces: the instruction i...
MaybeAlign decodeMaybeAlign(unsigned Value)
Dual operation of the encode function above.
Definition Alignment.h:209
DWARFExpression::Operation Op
ArrayRef(const T &OneElt) -> ArrayRef< T >
constexpr unsigned BitWidth
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1916
bool SkipBitcodeWrapperHeader(const unsigned char *&BufPtr, const unsigned char *&BufEnd, bool VerifyBufferSize)
SkipBitcodeWrapperHeader - Some systems wrap bc files with a special header for padding or other reas...
bool isBitcodeWrapper(const unsigned char *BufPtr, const unsigned char *BufEnd)
isBitcodeWrapper - Return true if the given bytes are the magic bytes for an LLVM IR bitcode wrapper.
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
gep_type_iterator gep_type_begin(const User *GEP)
LLVM_ABI APInt readWideAPInt(ArrayRef< uint64_t > Vals, unsigned TypeBits)
LLVM_ABI Error errorCodeToError(std::error_code EC)
Helper for converting an std::error_code to a Error.
Definition Error.cpp:107
LLVM_ABI bool UpgradeDebugInfo(Module &M)
Check the debug info version number, if it is out-dated, drop the debug info.
LLVM_ABI void UpgradeFunctionAttributes(Function &F)
Correct any IR that is relying on old function attribute behavior.
std::vector< TypeIdOffsetVtableInfo > TypeIdCompatibleVtableInfo
List of vtable definitions decorated by a particular type identifier, and their corresponding offsets...
BumpPtrAllocatorImpl<> BumpPtrAllocator
The standard BumpPtrAllocator which just uses the default template parameters.
Definition Allocator.h:383
LLVM_ABI Error readModuleSummaryIndex(MemoryBufferRef Buffer, ModuleSummaryIndex &CombinedIndex)
Parse the specified bitcode buffer and merge the index into CombinedIndex.
LLVM_ABI void UpgradeARCRuntime(Module &M)
Convert calls to ARC runtime functions to intrinsic calls and upgrade the old retain release marker t...
LLVM_ABI Expected< std::unique_ptr< ModuleSummaryIndex > > getModuleSummaryIndexForFile(StringRef Path, bool IgnoreEmptyThinLTOIndexFile=false)
Parse the module summary index out of an IR file and return the module summary index object if found,...
LLVM_ABI Expected< std::unique_ptr< Module > > getOwningLazyBitcodeModule(std::unique_ptr< MemoryBuffer > &&Buffer, LLVMContext &Context, bool ShouldLazyLoadMetadata=false, bool IsImporting=false, ParserCallbacks Callbacks={})
Like getLazyBitcodeModule, except that the module takes ownership of the memory buffer if successful.
LLVM_ABI std::error_code errorToErrorCodeAndEmitErrors(LLVMContext &Ctx, Error Err)
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:874
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:876
Basic information extracted from a bitcode module to be used for LTO.
static Bitfield::Type get(StorageType Packed)
Unpacks the field from the Packed value.
Definition Bitfields.h:207
When advancing through a bitstream cursor, each advance can discover a few different kinds of entries...
static constexpr DenormalFPEnv createFromIntValue(uint32_t Data)
Flags specific to function summaries.
static constexpr uint32_t RangeWidth
std::vector< Call > Calls
In the per-module summary, it summarizes the byte offset applied to each pointer parameter before pas...
ConstantRange Use
The range contains byte offsets from the parameter pointer which accessed by the function.
Group flags (Linkage, NotEligibleToImport, etc.) as a bitfield.
static LLVM_ABI const char * BranchWeights
GetContainedTypeIDTy GetContainedTypeID
std::optional< MDTypeCallbackTy > MDType
std::optional< ValueTypeCallbackTy > ValueType
The ValueType callback is called for every function definition or declaration and allows accessing th...
std::optional< DataLayoutCallbackFuncTy > DataLayout
std::optional< MDTypeCallbackTy > MDType
The MDType callback is called for every value in metadata.
std::map< uint64_t, WholeProgramDevirtResolution > WPDRes
Mapping from byte offset to whole-program devirt resolution for that (typeid, byte offset) pair.
TypeTestResolution TTRes
Kind
Specifies which kind of type check we should emit for this byte array.
unsigned SizeM1BitWidth
Range of size-1 expressed as a bit width.
enum llvm::TypeTestResolution::Kind TheKind
ValID - Represents a reference of a definition of some sort with no type.
Definition LLParser.h:54
enum llvm::WholeProgramDevirtResolution::Kind TheKind
std::map< std::vector< uint64_t >, ByArg > ResByArg
Resolutions for calls with all constant integer arguments (excluding the first argument,...