Path: blob/main/contrib/llvm-project/llvm/lib/Bitcode/Reader/BitcodeReader.cpp
35291 views
//===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//1//2// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.3// See https://llvm.org/LICENSE.txt for license information.4// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception5//6//===----------------------------------------------------------------------===//78#include "llvm/Bitcode/BitcodeReader.h"9#include "MetadataLoader.h"10#include "ValueList.h"11#include "llvm/ADT/APFloat.h"12#include "llvm/ADT/APInt.h"13#include "llvm/ADT/ArrayRef.h"14#include "llvm/ADT/DenseMap.h"15#include "llvm/ADT/STLExtras.h"16#include "llvm/ADT/SmallString.h"17#include "llvm/ADT/SmallVector.h"18#include "llvm/ADT/StringRef.h"19#include "llvm/ADT/Twine.h"20#include "llvm/Bitcode/BitcodeCommon.h"21#include "llvm/Bitcode/LLVMBitCodes.h"22#include "llvm/Bitstream/BitstreamReader.h"23#include "llvm/Config/llvm-config.h"24#include "llvm/IR/Argument.h"25#include "llvm/IR/AttributeMask.h"26#include "llvm/IR/Attributes.h"27#include "llvm/IR/AutoUpgrade.h"28#include "llvm/IR/BasicBlock.h"29#include "llvm/IR/CallingConv.h"30#include "llvm/IR/Comdat.h"31#include "llvm/IR/Constant.h"32#include "llvm/IR/ConstantRangeList.h"33#include "llvm/IR/Constants.h"34#include "llvm/IR/DataLayout.h"35#include "llvm/IR/DebugInfo.h"36#include "llvm/IR/DebugInfoMetadata.h"37#include "llvm/IR/DebugLoc.h"38#include "llvm/IR/DerivedTypes.h"39#include "llvm/IR/Function.h"40#include "llvm/IR/GVMaterializer.h"41#include "llvm/IR/GetElementPtrTypeIterator.h"42#include "llvm/IR/GlobalAlias.h"43#include "llvm/IR/GlobalIFunc.h"44#include "llvm/IR/GlobalObject.h"45#include "llvm/IR/GlobalValue.h"46#include "llvm/IR/GlobalVariable.h"47#include "llvm/IR/InlineAsm.h"48#include "llvm/IR/InstIterator.h"49#include "llvm/IR/InstrTypes.h"50#include "llvm/IR/Instruction.h"51#include "llvm/IR/Instructions.h"52#include "llvm/IR/Intrinsics.h"53#include "llvm/IR/IntrinsicsAArch64.h"54#include "llvm/IR/IntrinsicsARM.h"55#include "llvm/IR/LLVMContext.h"56#include "llvm/IR/Metadata.h"57#include "llvm/IR/Module.h"58#include "llvm/IR/ModuleSummaryIndex.h"59#include "llvm/IR/Operator.h"60#include "llvm/IR/ProfDataUtils.h"61#include "llvm/IR/Type.h"62#include "llvm/IR/Value.h"63#include "llvm/IR/Verifier.h"64#include "llvm/Support/AtomicOrdering.h"65#include "llvm/Support/Casting.h"66#include "llvm/Support/CommandLine.h"67#include "llvm/Support/Compiler.h"68#include "llvm/Support/Debug.h"69#include "llvm/Support/Error.h"70#include "llvm/Support/ErrorHandling.h"71#include "llvm/Support/ErrorOr.h"72#include "llvm/Support/MathExtras.h"73#include "llvm/Support/MemoryBuffer.h"74#include "llvm/Support/ModRef.h"75#include "llvm/Support/raw_ostream.h"76#include "llvm/TargetParser/Triple.h"77#include <algorithm>78#include <cassert>79#include <cstddef>80#include <cstdint>81#include <deque>82#include <map>83#include <memory>84#include <optional>85#include <set>86#include <string>87#include <system_error>88#include <tuple>89#include <utility>90#include <vector>9192using namespace llvm;9394static cl::opt<bool> PrintSummaryGUIDs(95"print-summary-global-ids", cl::init(false), cl::Hidden,96cl::desc(97"Print the global id for each value when reading the module summary"));9899static cl::opt<bool> ExpandConstantExprs(100"expand-constant-exprs", cl::Hidden,101cl::desc(102"Expand constant expressions to instructions for testing purposes"));103104/// Load bitcode directly into RemoveDIs format (use debug records instead105/// of debug intrinsics). UNSET is treated as FALSE, so the default action106/// is to do nothing. Individual tools can override this to incrementally add107/// support for the RemoveDIs format.108cl::opt<cl::boolOrDefault> LoadBitcodeIntoNewDbgInfoFormat(109"load-bitcode-into-experimental-debuginfo-iterators", cl::Hidden,110cl::desc("Load bitcode directly into the new debug info format (regardless "111"of input format)"));112extern cl::opt<bool> UseNewDbgInfoFormat;113extern cl::opt<cl::boolOrDefault> PreserveInputDbgFormat;114extern bool WriteNewDbgInfoFormatToBitcode;115extern cl::opt<bool> WriteNewDbgInfoFormat;116117namespace {118119enum {120SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex121};122123} // end anonymous namespace124125static Error error(const Twine &Message) {126return make_error<StringError>(127Message, make_error_code(BitcodeError::CorruptedBitcode));128}129130static Error hasInvalidBitcodeHeader(BitstreamCursor &Stream) {131if (!Stream.canSkipToPos(4))132return createStringError(std::errc::illegal_byte_sequence,133"file too small to contain bitcode header");134for (unsigned C : {'B', 'C'})135if (Expected<SimpleBitstreamCursor::word_t> Res = Stream.Read(8)) {136if (Res.get() != C)137return createStringError(std::errc::illegal_byte_sequence,138"file doesn't start with bitcode header");139} else140return Res.takeError();141for (unsigned C : {0x0, 0xC, 0xE, 0xD})142if (Expected<SimpleBitstreamCursor::word_t> Res = Stream.Read(4)) {143if (Res.get() != C)144return createStringError(std::errc::illegal_byte_sequence,145"file doesn't start with bitcode header");146} else147return Res.takeError();148return Error::success();149}150151static Expected<BitstreamCursor> initStream(MemoryBufferRef Buffer) {152const unsigned char *BufPtr = (const unsigned char *)Buffer.getBufferStart();153const unsigned char *BufEnd = BufPtr + Buffer.getBufferSize();154155if (Buffer.getBufferSize() & 3)156return error("Invalid bitcode signature");157158// If we have a wrapper header, parse it and ignore the non-bc file contents.159// The magic number is 0x0B17C0DE stored in little endian.160if (isBitcodeWrapper(BufPtr, BufEnd))161if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))162return error("Invalid bitcode wrapper header");163164BitstreamCursor Stream(ArrayRef<uint8_t>(BufPtr, BufEnd));165if (Error Err = hasInvalidBitcodeHeader(Stream))166return std::move(Err);167168return std::move(Stream);169}170171/// Convert a string from a record into an std::string, return true on failure.172template <typename StrTy>173static bool convertToString(ArrayRef<uint64_t> Record, unsigned Idx,174StrTy &Result) {175if (Idx > Record.size())176return true;177178Result.append(Record.begin() + Idx, Record.end());179return false;180}181182// Strip all the TBAA attachment for the module.183static void stripTBAA(Module *M) {184for (auto &F : *M) {185if (F.isMaterializable())186continue;187for (auto &I : instructions(F))188I.setMetadata(LLVMContext::MD_tbaa, nullptr);189}190}191192/// Read the "IDENTIFICATION_BLOCK_ID" block, do some basic enforcement on the193/// "epoch" encoded in the bitcode, and return the producer name if any.194static Expected<std::string> readIdentificationBlock(BitstreamCursor &Stream) {195if (Error Err = Stream.EnterSubBlock(bitc::IDENTIFICATION_BLOCK_ID))196return std::move(Err);197198// Read all the records.199SmallVector<uint64_t, 64> Record;200201std::string ProducerIdentification;202203while (true) {204BitstreamEntry Entry;205if (Error E = Stream.advance().moveInto(Entry))206return std::move(E);207208switch (Entry.Kind) {209default:210case BitstreamEntry::Error:211return error("Malformed block");212case BitstreamEntry::EndBlock:213return ProducerIdentification;214case BitstreamEntry::Record:215// The interesting case.216break;217}218219// Read a record.220Record.clear();221Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);222if (!MaybeBitCode)223return MaybeBitCode.takeError();224switch (MaybeBitCode.get()) {225default: // Default behavior: reject226return error("Invalid value");227case bitc::IDENTIFICATION_CODE_STRING: // IDENTIFICATION: [strchr x N]228convertToString(Record, 0, ProducerIdentification);229break;230case bitc::IDENTIFICATION_CODE_EPOCH: { // EPOCH: [epoch#]231unsigned epoch = (unsigned)Record[0];232if (epoch != bitc::BITCODE_CURRENT_EPOCH) {233return error(234Twine("Incompatible epoch: Bitcode '") + Twine(epoch) +235"' vs current: '" + Twine(bitc::BITCODE_CURRENT_EPOCH) + "'");236}237}238}239}240}241242static Expected<std::string> readIdentificationCode(BitstreamCursor &Stream) {243// We expect a number of well-defined blocks, though we don't necessarily244// need to understand them all.245while (true) {246if (Stream.AtEndOfStream())247return "";248249BitstreamEntry Entry;250if (Error E = Stream.advance().moveInto(Entry))251return std::move(E);252253switch (Entry.Kind) {254case BitstreamEntry::EndBlock:255case BitstreamEntry::Error:256return error("Malformed block");257258case BitstreamEntry::SubBlock:259if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID)260return readIdentificationBlock(Stream);261262// Ignore other sub-blocks.263if (Error Err = Stream.SkipBlock())264return std::move(Err);265continue;266case BitstreamEntry::Record:267if (Error E = Stream.skipRecord(Entry.ID).takeError())268return std::move(E);269continue;270}271}272}273274static Expected<bool> hasObjCCategoryInModule(BitstreamCursor &Stream) {275if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))276return std::move(Err);277278SmallVector<uint64_t, 64> Record;279// Read all the records for this module.280281while (true) {282Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();283if (!MaybeEntry)284return MaybeEntry.takeError();285BitstreamEntry Entry = MaybeEntry.get();286287switch (Entry.Kind) {288case BitstreamEntry::SubBlock: // Handled for us already.289case BitstreamEntry::Error:290return error("Malformed block");291case BitstreamEntry::EndBlock:292return false;293case BitstreamEntry::Record:294// The interesting case.295break;296}297298// Read a record.299Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);300if (!MaybeRecord)301return MaybeRecord.takeError();302switch (MaybeRecord.get()) {303default:304break; // Default behavior, ignore unknown content.305case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]306std::string S;307if (convertToString(Record, 0, S))308return error("Invalid section name record");309// Check for the i386 and other (x86_64, ARM) conventions310if (S.find("__DATA,__objc_catlist") != std::string::npos ||311S.find("__OBJC,__category") != std::string::npos ||312S.find("__TEXT,__swift") != std::string::npos)313return true;314break;315}316}317Record.clear();318}319llvm_unreachable("Exit infinite loop");320}321322static Expected<bool> hasObjCCategory(BitstreamCursor &Stream) {323// We expect a number of well-defined blocks, though we don't necessarily324// need to understand them all.325while (true) {326BitstreamEntry Entry;327if (Error E = Stream.advance().moveInto(Entry))328return std::move(E);329330switch (Entry.Kind) {331case BitstreamEntry::Error:332return error("Malformed block");333case BitstreamEntry::EndBlock:334return false;335336case BitstreamEntry::SubBlock:337if (Entry.ID == bitc::MODULE_BLOCK_ID)338return hasObjCCategoryInModule(Stream);339340// Ignore other sub-blocks.341if (Error Err = Stream.SkipBlock())342return std::move(Err);343continue;344345case BitstreamEntry::Record:346if (Error E = Stream.skipRecord(Entry.ID).takeError())347return std::move(E);348continue;349}350}351}352353static Expected<std::string> readModuleTriple(BitstreamCursor &Stream) {354if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))355return std::move(Err);356357SmallVector<uint64_t, 64> Record;358359std::string Triple;360361// Read all the records for this module.362while (true) {363Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();364if (!MaybeEntry)365return MaybeEntry.takeError();366BitstreamEntry Entry = MaybeEntry.get();367368switch (Entry.Kind) {369case BitstreamEntry::SubBlock: // Handled for us already.370case BitstreamEntry::Error:371return error("Malformed block");372case BitstreamEntry::EndBlock:373return Triple;374case BitstreamEntry::Record:375// The interesting case.376break;377}378379// Read a record.380Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);381if (!MaybeRecord)382return MaybeRecord.takeError();383switch (MaybeRecord.get()) {384default: break; // Default behavior, ignore unknown content.385case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]386std::string S;387if (convertToString(Record, 0, S))388return error("Invalid triple record");389Triple = S;390break;391}392}393Record.clear();394}395llvm_unreachable("Exit infinite loop");396}397398static Expected<std::string> readTriple(BitstreamCursor &Stream) {399// We expect a number of well-defined blocks, though we don't necessarily400// need to understand them all.401while (true) {402Expected<BitstreamEntry> MaybeEntry = Stream.advance();403if (!MaybeEntry)404return MaybeEntry.takeError();405BitstreamEntry Entry = MaybeEntry.get();406407switch (Entry.Kind) {408case BitstreamEntry::Error:409return error("Malformed block");410case BitstreamEntry::EndBlock:411return "";412413case BitstreamEntry::SubBlock:414if (Entry.ID == bitc::MODULE_BLOCK_ID)415return readModuleTriple(Stream);416417// Ignore other sub-blocks.418if (Error Err = Stream.SkipBlock())419return std::move(Err);420continue;421422case BitstreamEntry::Record:423if (llvm::Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID))424continue;425else426return Skipped.takeError();427}428}429}430431namespace {432433class BitcodeReaderBase {434protected:435BitcodeReaderBase(BitstreamCursor Stream, StringRef Strtab)436: Stream(std::move(Stream)), Strtab(Strtab) {437this->Stream.setBlockInfo(&BlockInfo);438}439440BitstreamBlockInfo BlockInfo;441BitstreamCursor Stream;442StringRef Strtab;443444/// In version 2 of the bitcode we store names of global values and comdats in445/// a string table rather than in the VST.446bool UseStrtab = false;447448Expected<unsigned> parseVersionRecord(ArrayRef<uint64_t> Record);449450/// If this module uses a string table, pop the reference to the string table451/// and return the referenced string and the rest of the record. Otherwise452/// just return the record itself.453std::pair<StringRef, ArrayRef<uint64_t>>454readNameFromStrtab(ArrayRef<uint64_t> Record);455456Error readBlockInfo();457458// Contains an arbitrary and optional string identifying the bitcode producer459std::string ProducerIdentification;460461Error error(const Twine &Message);462};463464} // end anonymous namespace465466Error BitcodeReaderBase::error(const Twine &Message) {467std::string FullMsg = Message.str();468if (!ProducerIdentification.empty())469FullMsg += " (Producer: '" + ProducerIdentification + "' Reader: 'LLVM " +470LLVM_VERSION_STRING "')";471return ::error(FullMsg);472}473474Expected<unsigned>475BitcodeReaderBase::parseVersionRecord(ArrayRef<uint64_t> Record) {476if (Record.empty())477return error("Invalid version record");478unsigned ModuleVersion = Record[0];479if (ModuleVersion > 2)480return error("Invalid value");481UseStrtab = ModuleVersion >= 2;482return ModuleVersion;483}484485std::pair<StringRef, ArrayRef<uint64_t>>486BitcodeReaderBase::readNameFromStrtab(ArrayRef<uint64_t> Record) {487if (!UseStrtab)488return {"", Record};489// Invalid reference. Let the caller complain about the record being empty.490if (Record[0] + Record[1] > Strtab.size())491return {"", {}};492return {StringRef(Strtab.data() + Record[0], Record[1]), Record.slice(2)};493}494495namespace {496497/// This represents a constant expression or constant aggregate using a custom498/// structure internal to the bitcode reader. Later, this structure will be499/// expanded by materializeValue() either into a constant expression/aggregate,500/// or into an instruction sequence at the point of use. This allows us to501/// upgrade bitcode using constant expressions even if this kind of constant502/// expression is no longer supported.503class BitcodeConstant final : public Value,504TrailingObjects<BitcodeConstant, unsigned> {505friend TrailingObjects;506507// Value subclass ID: Pick largest possible value to avoid any clashes.508static constexpr uint8_t SubclassID = 255;509510public:511// Opcodes used for non-expressions. This includes constant aggregates512// (struct, array, vector) that might need expansion, as well as non-leaf513// constants that don't need expansion (no_cfi, dso_local, blockaddress),514// but still go through BitcodeConstant to avoid different uselist orders515// between the two cases.516static constexpr uint8_t ConstantStructOpcode = 255;517static constexpr uint8_t ConstantArrayOpcode = 254;518static constexpr uint8_t ConstantVectorOpcode = 253;519static constexpr uint8_t NoCFIOpcode = 252;520static constexpr uint8_t DSOLocalEquivalentOpcode = 251;521static constexpr uint8_t BlockAddressOpcode = 250;522static constexpr uint8_t ConstantPtrAuthOpcode = 249;523static constexpr uint8_t FirstSpecialOpcode = ConstantPtrAuthOpcode;524525// Separate struct to make passing different number of parameters to526// BitcodeConstant::create() more convenient.527struct ExtraInfo {528uint8_t Opcode;529uint8_t Flags;530unsigned BlockAddressBB = 0;531Type *SrcElemTy = nullptr;532std::optional<ConstantRange> InRange;533534ExtraInfo(uint8_t Opcode, uint8_t Flags = 0, Type *SrcElemTy = nullptr,535std::optional<ConstantRange> InRange = std::nullopt)536: Opcode(Opcode), Flags(Flags), SrcElemTy(SrcElemTy),537InRange(std::move(InRange)) {}538539ExtraInfo(uint8_t Opcode, uint8_t Flags, unsigned BlockAddressBB)540: Opcode(Opcode), Flags(Flags), BlockAddressBB(BlockAddressBB) {}541};542543uint8_t Opcode;544uint8_t Flags;545unsigned NumOperands;546unsigned BlockAddressBB;547Type *SrcElemTy; // GEP source element type.548std::optional<ConstantRange> InRange; // GEP inrange attribute.549550private:551BitcodeConstant(Type *Ty, const ExtraInfo &Info, ArrayRef<unsigned> OpIDs)552: Value(Ty, SubclassID), Opcode(Info.Opcode), Flags(Info.Flags),553NumOperands(OpIDs.size()), BlockAddressBB(Info.BlockAddressBB),554SrcElemTy(Info.SrcElemTy), InRange(Info.InRange) {555std::uninitialized_copy(OpIDs.begin(), OpIDs.end(),556getTrailingObjects<unsigned>());557}558559BitcodeConstant &operator=(const BitcodeConstant &) = delete;560561public:562static BitcodeConstant *create(BumpPtrAllocator &A, Type *Ty,563const ExtraInfo &Info,564ArrayRef<unsigned> OpIDs) {565void *Mem = A.Allocate(totalSizeToAlloc<unsigned>(OpIDs.size()),566alignof(BitcodeConstant));567return new (Mem) BitcodeConstant(Ty, Info, OpIDs);568}569570static bool classof(const Value *V) { return V->getValueID() == SubclassID; }571572ArrayRef<unsigned> getOperandIDs() const {573return ArrayRef(getTrailingObjects<unsigned>(), NumOperands);574}575576std::optional<ConstantRange> getInRange() const {577assert(Opcode == Instruction::GetElementPtr);578return InRange;579}580581const char *getOpcodeName() const {582return Instruction::getOpcodeName(Opcode);583}584};585586class BitcodeReader : public BitcodeReaderBase, public GVMaterializer {587LLVMContext &Context;588Module *TheModule = nullptr;589// Next offset to start scanning for lazy parsing of function bodies.590uint64_t NextUnreadBit = 0;591// Last function offset found in the VST.592uint64_t LastFunctionBlockBit = 0;593bool SeenValueSymbolTable = false;594uint64_t VSTOffset = 0;595596std::vector<std::string> SectionTable;597std::vector<std::string> GCTable;598599std::vector<Type *> TypeList;600/// Track type IDs of contained types. Order is the same as the contained601/// types of a Type*. This is used during upgrades of typed pointer IR in602/// opaque pointer mode.603DenseMap<unsigned, SmallVector<unsigned, 1>> ContainedTypeIDs;604/// In some cases, we need to create a type ID for a type that was not605/// explicitly encoded in the bitcode, or we don't know about at the current606/// point. For example, a global may explicitly encode the value type ID, but607/// not have a type ID for the pointer to value type, for which we create a608/// virtual type ID instead. This map stores the new type ID that was created609/// for the given pair of Type and contained type ID.610DenseMap<std::pair<Type *, unsigned>, unsigned> VirtualTypeIDs;611DenseMap<Function *, unsigned> FunctionTypeIDs;612/// Allocator for BitcodeConstants. This should come before ValueList,613/// because the ValueList might hold ValueHandles to these constants, so614/// ValueList must be destroyed before Alloc.615BumpPtrAllocator Alloc;616BitcodeReaderValueList ValueList;617std::optional<MetadataLoader> MDLoader;618std::vector<Comdat *> ComdatList;619DenseSet<GlobalObject *> ImplicitComdatObjects;620SmallVector<Instruction *, 64> InstructionList;621622std::vector<std::pair<GlobalVariable *, unsigned>> GlobalInits;623std::vector<std::pair<GlobalValue *, unsigned>> IndirectSymbolInits;624625struct FunctionOperandInfo {626Function *F;627unsigned PersonalityFn;628unsigned Prefix;629unsigned Prologue;630};631std::vector<FunctionOperandInfo> FunctionOperands;632633/// The set of attributes by index. Index zero in the file is for null, and634/// is thus not represented here. As such all indices are off by one.635std::vector<AttributeList> MAttributes;636637/// The set of attribute groups.638std::map<unsigned, AttributeList> MAttributeGroups;639640/// While parsing a function body, this is a list of the basic blocks for the641/// function.642std::vector<BasicBlock*> FunctionBBs;643644// When reading the module header, this list is populated with functions that645// have bodies later in the file.646std::vector<Function*> FunctionsWithBodies;647648// When intrinsic functions are encountered which require upgrading they are649// stored here with their replacement function.650using UpdatedIntrinsicMap = DenseMap<Function *, Function *>;651UpdatedIntrinsicMap UpgradedIntrinsics;652653// Several operations happen after the module header has been read, but654// before function bodies are processed. This keeps track of whether655// we've done this yet.656bool SeenFirstFunctionBody = false;657658/// When function bodies are initially scanned, this map contains info about659/// where to find deferred function body in the stream.660DenseMap<Function*, uint64_t> DeferredFunctionInfo;661662/// When Metadata block is initially scanned when parsing the module, we may663/// choose to defer parsing of the metadata. This vector contains info about664/// which Metadata blocks are deferred.665std::vector<uint64_t> DeferredMetadataInfo;666667/// These are basic blocks forward-referenced by block addresses. They are668/// inserted lazily into functions when they're loaded. The basic block ID is669/// its index into the vector.670DenseMap<Function *, std::vector<BasicBlock *>> BasicBlockFwdRefs;671std::deque<Function *> BasicBlockFwdRefQueue;672673/// These are Functions that contain BlockAddresses which refer a different674/// Function. When parsing the different Function, queue Functions that refer675/// to the different Function. Those Functions must be materialized in order676/// to resolve their BlockAddress constants before the different Function677/// gets moved into another Module.678std::vector<Function *> BackwardRefFunctions;679680/// Indicates that we are using a new encoding for instruction operands where681/// most operands in the current FUNCTION_BLOCK are encoded relative to the682/// instruction number, for a more compact encoding. Some instruction683/// operands are not relative to the instruction ID: basic block numbers, and684/// types. Once the old style function blocks have been phased out, we would685/// not need this flag.686bool UseRelativeIDs = false;687688/// True if all functions will be materialized, negating the need to process689/// (e.g.) blockaddress forward references.690bool WillMaterializeAllForwardRefs = false;691692/// Tracks whether we have seen debug intrinsics or records in this bitcode;693/// seeing both in a single module is currently a fatal error.694bool SeenDebugIntrinsic = false;695bool SeenDebugRecord = false;696697bool StripDebugInfo = false;698TBAAVerifier TBAAVerifyHelper;699700std::vector<std::string> BundleTags;701SmallVector<SyncScope::ID, 8> SSIDs;702703std::optional<ValueTypeCallbackTy> ValueTypeCallback;704705public:706BitcodeReader(BitstreamCursor Stream, StringRef Strtab,707StringRef ProducerIdentification, LLVMContext &Context);708709Error materializeForwardReferencedFunctions();710711Error materialize(GlobalValue *GV) override;712Error materializeModule() override;713std::vector<StructType *> getIdentifiedStructTypes() const override;714715/// Main interface to parsing a bitcode buffer.716/// \returns true if an error occurred.717Error parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata,718bool IsImporting, ParserCallbacks Callbacks = {});719720static uint64_t decodeSignRotatedValue(uint64_t V);721722/// Materialize any deferred Metadata block.723Error materializeMetadata() override;724725void setStripDebugInfo() override;726727private:728std::vector<StructType *> IdentifiedStructTypes;729StructType *createIdentifiedStructType(LLVMContext &Context, StringRef Name);730StructType *createIdentifiedStructType(LLVMContext &Context);731732static constexpr unsigned InvalidTypeID = ~0u;733734Type *getTypeByID(unsigned ID);735Type *getPtrElementTypeByID(unsigned ID);736unsigned getContainedTypeID(unsigned ID, unsigned Idx = 0);737unsigned getVirtualTypeID(Type *Ty, ArrayRef<unsigned> ContainedTypeIDs = {});738739void callValueTypeCallback(Value *F, unsigned TypeID);740Expected<Value *> materializeValue(unsigned ValID, BasicBlock *InsertBB);741Expected<Constant *> getValueForInitializer(unsigned ID);742743Value *getFnValueByID(unsigned ID, Type *Ty, unsigned TyID,744BasicBlock *ConstExprInsertBB) {745if (Ty && Ty->isMetadataTy())746return MetadataAsValue::get(Ty->getContext(), getFnMetadataByID(ID));747return ValueList.getValueFwdRef(ID, Ty, TyID, ConstExprInsertBB);748}749750Metadata *getFnMetadataByID(unsigned ID) {751return MDLoader->getMetadataFwdRefOrLoad(ID);752}753754BasicBlock *getBasicBlock(unsigned ID) const {755if (ID >= FunctionBBs.size()) return nullptr; // Invalid ID756return FunctionBBs[ID];757}758759AttributeList getAttributes(unsigned i) const {760if (i-1 < MAttributes.size())761return MAttributes[i-1];762return AttributeList();763}764765/// Read a value/type pair out of the specified record from slot 'Slot'.766/// Increment Slot past the number of slots used in the record. Return true on767/// failure.768bool getValueTypePair(const SmallVectorImpl<uint64_t> &Record, unsigned &Slot,769unsigned InstNum, Value *&ResVal, unsigned &TypeID,770BasicBlock *ConstExprInsertBB) {771if (Slot == Record.size()) return true;772unsigned ValNo = (unsigned)Record[Slot++];773// Adjust the ValNo, if it was encoded relative to the InstNum.774if (UseRelativeIDs)775ValNo = InstNum - ValNo;776if (ValNo < InstNum) {777// If this is not a forward reference, just return the value we already778// have.779TypeID = ValueList.getTypeID(ValNo);780ResVal = getFnValueByID(ValNo, nullptr, TypeID, ConstExprInsertBB);781assert((!ResVal || ResVal->getType() == getTypeByID(TypeID)) &&782"Incorrect type ID stored for value");783return ResVal == nullptr;784}785if (Slot == Record.size())786return true;787788TypeID = (unsigned)Record[Slot++];789ResVal = getFnValueByID(ValNo, getTypeByID(TypeID), TypeID,790ConstExprInsertBB);791return ResVal == nullptr;792}793794/// Read a value out of the specified record from slot 'Slot'. Increment Slot795/// past the number of slots used by the value in the record. Return true if796/// there is an error.797bool popValue(const SmallVectorImpl<uint64_t> &Record, unsigned &Slot,798unsigned InstNum, Type *Ty, unsigned TyID, Value *&ResVal,799BasicBlock *ConstExprInsertBB) {800if (getValue(Record, Slot, InstNum, Ty, TyID, ResVal, ConstExprInsertBB))801return true;802// All values currently take a single record slot.803++Slot;804return false;805}806807/// Like popValue, but does not increment the Slot number.808bool getValue(const SmallVectorImpl<uint64_t> &Record, unsigned Slot,809unsigned InstNum, Type *Ty, unsigned TyID, Value *&ResVal,810BasicBlock *ConstExprInsertBB) {811ResVal = getValue(Record, Slot, InstNum, Ty, TyID, ConstExprInsertBB);812return ResVal == nullptr;813}814815/// Version of getValue that returns ResVal directly, or 0 if there is an816/// error.817Value *getValue(const SmallVectorImpl<uint64_t> &Record, unsigned Slot,818unsigned InstNum, Type *Ty, unsigned TyID,819BasicBlock *ConstExprInsertBB) {820if (Slot == Record.size()) return nullptr;821unsigned ValNo = (unsigned)Record[Slot];822// Adjust the ValNo, if it was encoded relative to the InstNum.823if (UseRelativeIDs)824ValNo = InstNum - ValNo;825return getFnValueByID(ValNo, Ty, TyID, ConstExprInsertBB);826}827828/// Like getValue, but decodes signed VBRs.829Value *getValueSigned(const SmallVectorImpl<uint64_t> &Record, unsigned Slot,830unsigned InstNum, Type *Ty, unsigned TyID,831BasicBlock *ConstExprInsertBB) {832if (Slot == Record.size()) return nullptr;833unsigned ValNo = (unsigned)decodeSignRotatedValue(Record[Slot]);834// Adjust the ValNo, if it was encoded relative to the InstNum.835if (UseRelativeIDs)836ValNo = InstNum - ValNo;837return getFnValueByID(ValNo, Ty, TyID, ConstExprInsertBB);838}839840Expected<ConstantRange> readConstantRange(ArrayRef<uint64_t> Record,841unsigned &OpNum,842unsigned BitWidth) {843if (Record.size() - OpNum < 2)844return error("Too few records for range");845if (BitWidth > 64) {846unsigned LowerActiveWords = Record[OpNum];847unsigned UpperActiveWords = Record[OpNum++] >> 32;848if (Record.size() - OpNum < LowerActiveWords + UpperActiveWords)849return error("Too few records for range");850APInt Lower =851readWideAPInt(ArrayRef(&Record[OpNum], LowerActiveWords), BitWidth);852OpNum += LowerActiveWords;853APInt Upper =854readWideAPInt(ArrayRef(&Record[OpNum], UpperActiveWords), BitWidth);855OpNum += UpperActiveWords;856return ConstantRange(Lower, Upper);857} else {858int64_t Start = BitcodeReader::decodeSignRotatedValue(Record[OpNum++]);859int64_t End = BitcodeReader::decodeSignRotatedValue(Record[OpNum++]);860return ConstantRange(APInt(BitWidth, Start), APInt(BitWidth, End));861}862}863864Expected<ConstantRange>865readBitWidthAndConstantRange(ArrayRef<uint64_t> Record, unsigned &OpNum) {866if (Record.size() - OpNum < 1)867return error("Too few records for range");868unsigned BitWidth = Record[OpNum++];869return readConstantRange(Record, OpNum, BitWidth);870}871872/// Upgrades old-style typeless byval/sret/inalloca attributes by adding the873/// corresponding argument's pointee type. Also upgrades intrinsics that now874/// require an elementtype attribute.875Error propagateAttributeTypes(CallBase *CB, ArrayRef<unsigned> ArgsTys);876877/// Converts alignment exponent (i.e. power of two (or zero)) to the878/// corresponding alignment to use. If alignment is too large, returns879/// a corresponding error code.880Error parseAlignmentValue(uint64_t Exponent, MaybeAlign &Alignment);881Error parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind);882Error parseModule(uint64_t ResumeBit, bool ShouldLazyLoadMetadata = false,883ParserCallbacks Callbacks = {});884885Error parseComdatRecord(ArrayRef<uint64_t> Record);886Error parseGlobalVarRecord(ArrayRef<uint64_t> Record);887Error parseFunctionRecord(ArrayRef<uint64_t> Record);888Error parseGlobalIndirectSymbolRecord(unsigned BitCode,889ArrayRef<uint64_t> Record);890891Error parseAttributeBlock();892Error parseAttributeGroupBlock();893Error parseTypeTable();894Error parseTypeTableBody();895Error parseOperandBundleTags();896Error parseSyncScopeNames();897898Expected<Value *> recordValue(SmallVectorImpl<uint64_t> &Record,899unsigned NameIndex, Triple &TT);900void setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta, Function *F,901ArrayRef<uint64_t> Record);902Error parseValueSymbolTable(uint64_t Offset = 0);903Error parseGlobalValueSymbolTable();904Error parseConstants();905Error rememberAndSkipFunctionBodies();906Error rememberAndSkipFunctionBody();907/// Save the positions of the Metadata blocks and skip parsing the blocks.908Error rememberAndSkipMetadata();909Error typeCheckLoadStoreInst(Type *ValType, Type *PtrType);910Error parseFunctionBody(Function *F);911Error globalCleanup();912Error resolveGlobalAndIndirectSymbolInits();913Error parseUseLists();914Error findFunctionInStream(915Function *F,916DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator);917918SyncScope::ID getDecodedSyncScopeID(unsigned Val);919};920921/// Class to manage reading and parsing function summary index bitcode922/// files/sections.923class ModuleSummaryIndexBitcodeReader : public BitcodeReaderBase {924/// The module index built during parsing.925ModuleSummaryIndex &TheIndex;926927/// Indicates whether we have encountered a global value summary section928/// yet during parsing.929bool SeenGlobalValSummary = false;930931/// Indicates whether we have already parsed the VST, used for error checking.932bool SeenValueSymbolTable = false;933934/// Set to the offset of the VST recorded in the MODULE_CODE_VSTOFFSET record.935/// Used to enable on-demand parsing of the VST.936uint64_t VSTOffset = 0;937938// Map to save ValueId to ValueInfo association that was recorded in the939// ValueSymbolTable. It is used after the VST is parsed to convert940// call graph edges read from the function summary from referencing941// callees by their ValueId to using the ValueInfo instead, which is how942// they are recorded in the summary index being built.943// We save a GUID which refers to the same global as the ValueInfo, but944// ignoring the linkage, i.e. for values other than local linkage they are945// identical (this is the second tuple member).946// The third tuple member is the real GUID of the ValueInfo.947DenseMap<unsigned,948std::tuple<ValueInfo, GlobalValue::GUID, GlobalValue::GUID>>949ValueIdToValueInfoMap;950951/// Map populated during module path string table parsing, from the952/// module ID to a string reference owned by the index's module953/// path string table, used to correlate with combined index954/// summary records.955DenseMap<uint64_t, StringRef> ModuleIdMap;956957/// Original source file name recorded in a bitcode record.958std::string SourceFileName;959960/// The string identifier given to this module by the client, normally the961/// path to the bitcode file.962StringRef ModulePath;963964/// Callback to ask whether a symbol is the prevailing copy when invoked965/// during combined index building.966std::function<bool(GlobalValue::GUID)> IsPrevailing;967968/// Saves the stack ids from the STACK_IDS record to consult when adding stack969/// ids from the lists in the callsite and alloc entries to the index.970std::vector<uint64_t> StackIds;971972public:973ModuleSummaryIndexBitcodeReader(974BitstreamCursor Stream, StringRef Strtab, ModuleSummaryIndex &TheIndex,975StringRef ModulePath,976std::function<bool(GlobalValue::GUID)> IsPrevailing = nullptr);977978Error parseModule();979980private:981void setValueGUID(uint64_t ValueID, StringRef ValueName,982GlobalValue::LinkageTypes Linkage,983StringRef SourceFileName);984Error parseValueSymbolTable(985uint64_t Offset,986DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap);987std::vector<ValueInfo> makeRefList(ArrayRef<uint64_t> Record);988std::vector<FunctionSummary::EdgeTy> makeCallList(ArrayRef<uint64_t> Record,989bool IsOldProfileFormat,990bool HasProfile,991bool HasRelBF);992Error parseEntireSummary(unsigned ID);993Error parseModuleStringTable();994void parseTypeIdCompatibleVtableSummaryRecord(ArrayRef<uint64_t> Record);995void parseTypeIdCompatibleVtableInfo(ArrayRef<uint64_t> Record, size_t &Slot,996TypeIdCompatibleVtableInfo &TypeId);997std::vector<FunctionSummary::ParamAccess>998parseParamAccesses(ArrayRef<uint64_t> Record);9991000template <bool AllowNullValueInfo = false>1001std::tuple<ValueInfo, GlobalValue::GUID, GlobalValue::GUID>1002getValueInfoFromValueId(unsigned ValueId);10031004void addThisModule();1005ModuleSummaryIndex::ModuleInfo *getThisModule();1006};10071008} // end anonymous namespace10091010std::error_code llvm::errorToErrorCodeAndEmitErrors(LLVMContext &Ctx,1011Error Err) {1012if (Err) {1013std::error_code EC;1014handleAllErrors(std::move(Err), [&](ErrorInfoBase &EIB) {1015EC = EIB.convertToErrorCode();1016Ctx.emitError(EIB.message());1017});1018return EC;1019}1020return std::error_code();1021}10221023BitcodeReader::BitcodeReader(BitstreamCursor Stream, StringRef Strtab,1024StringRef ProducerIdentification,1025LLVMContext &Context)1026: BitcodeReaderBase(std::move(Stream), Strtab), Context(Context),1027ValueList(this->Stream.SizeInBytes(),1028[this](unsigned ValID, BasicBlock *InsertBB) {1029return materializeValue(ValID, InsertBB);1030}) {1031this->ProducerIdentification = std::string(ProducerIdentification);1032}10331034Error BitcodeReader::materializeForwardReferencedFunctions() {1035if (WillMaterializeAllForwardRefs)1036return Error::success();10371038// Prevent recursion.1039WillMaterializeAllForwardRefs = true;10401041while (!BasicBlockFwdRefQueue.empty()) {1042Function *F = BasicBlockFwdRefQueue.front();1043BasicBlockFwdRefQueue.pop_front();1044assert(F && "Expected valid function");1045if (!BasicBlockFwdRefs.count(F))1046// Already materialized.1047continue;10481049// Check for a function that isn't materializable to prevent an infinite1050// loop. When parsing a blockaddress stored in a global variable, there1051// isn't a trivial way to check if a function will have a body without a1052// linear search through FunctionsWithBodies, so just check it here.1053if (!F->isMaterializable())1054return error("Never resolved function from blockaddress");10551056// Try to materialize F.1057if (Error Err = materialize(F))1058return Err;1059}1060assert(BasicBlockFwdRefs.empty() && "Function missing from queue");10611062for (Function *F : BackwardRefFunctions)1063if (Error Err = materialize(F))1064return Err;1065BackwardRefFunctions.clear();10661067// Reset state.1068WillMaterializeAllForwardRefs = false;1069return Error::success();1070}10711072//===----------------------------------------------------------------------===//1073// Helper functions to implement forward reference resolution, etc.1074//===----------------------------------------------------------------------===//10751076static bool hasImplicitComdat(size_t Val) {1077switch (Val) {1078default:1079return false;1080case 1: // Old WeakAnyLinkage1081case 4: // Old LinkOnceAnyLinkage1082case 10: // Old WeakODRLinkage1083case 11: // Old LinkOnceODRLinkage1084return true;1085}1086}10871088static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {1089switch (Val) {1090default: // Map unknown/new linkages to external1091case 0:1092return GlobalValue::ExternalLinkage;1093case 2:1094return GlobalValue::AppendingLinkage;1095case 3:1096return GlobalValue::InternalLinkage;1097case 5:1098return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage1099case 6:1100return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage1101case 7:1102return GlobalValue::ExternalWeakLinkage;1103case 8:1104return GlobalValue::CommonLinkage;1105case 9:1106return GlobalValue::PrivateLinkage;1107case 12:1108return GlobalValue::AvailableExternallyLinkage;1109case 13:1110return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage1111case 14:1112return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage1113case 15:1114return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage1115case 1: // Old value with implicit comdat.1116case 16:1117return GlobalValue::WeakAnyLinkage;1118case 10: // Old value with implicit comdat.1119case 17:1120return GlobalValue::WeakODRLinkage;1121case 4: // Old value with implicit comdat.1122case 18:1123return GlobalValue::LinkOnceAnyLinkage;1124case 11: // Old value with implicit comdat.1125case 19:1126return GlobalValue::LinkOnceODRLinkage;1127}1128}11291130static FunctionSummary::FFlags getDecodedFFlags(uint64_t RawFlags) {1131FunctionSummary::FFlags Flags;1132Flags.ReadNone = RawFlags & 0x1;1133Flags.ReadOnly = (RawFlags >> 1) & 0x1;1134Flags.NoRecurse = (RawFlags >> 2) & 0x1;1135Flags.ReturnDoesNotAlias = (RawFlags >> 3) & 0x1;1136Flags.NoInline = (RawFlags >> 4) & 0x1;1137Flags.AlwaysInline = (RawFlags >> 5) & 0x1;1138Flags.NoUnwind = (RawFlags >> 6) & 0x1;1139Flags.MayThrow = (RawFlags >> 7) & 0x1;1140Flags.HasUnknownCall = (RawFlags >> 8) & 0x1;1141Flags.MustBeUnreachable = (RawFlags >> 9) & 0x1;1142return Flags;1143}11441145// Decode the flags for GlobalValue in the summary. The bits for each attribute:1146//1147// linkage: [0,4), notEligibleToImport: 4, live: 5, local: 6, canAutoHide: 7,1148// visibility: [8, 10).1149static GlobalValueSummary::GVFlags getDecodedGVSummaryFlags(uint64_t RawFlags,1150uint64_t Version) {1151// Summary were not emitted before LLVM 3.9, we don't need to upgrade Linkage1152// like getDecodedLinkage() above. Any future change to the linkage enum and1153// to getDecodedLinkage() will need to be taken into account here as above.1154auto Linkage = GlobalValue::LinkageTypes(RawFlags & 0xF); // 4 bits1155auto Visibility = GlobalValue::VisibilityTypes((RawFlags >> 8) & 3); // 2 bits1156auto IK = GlobalValueSummary::ImportKind((RawFlags >> 10) & 1); // 1 bit1157RawFlags = RawFlags >> 4;1158bool NotEligibleToImport = (RawFlags & 0x1) || Version < 3;1159// The Live flag wasn't introduced until version 3. For dead stripping1160// to work correctly on earlier versions, we must conservatively treat all1161// values as live.1162bool Live = (RawFlags & 0x2) || Version < 3;1163bool Local = (RawFlags & 0x4);1164bool AutoHide = (RawFlags & 0x8);11651166return GlobalValueSummary::GVFlags(Linkage, Visibility, NotEligibleToImport,1167Live, Local, AutoHide, IK);1168}11691170// Decode the flags for GlobalVariable in the summary1171static GlobalVarSummary::GVarFlags getDecodedGVarFlags(uint64_t RawFlags) {1172return GlobalVarSummary::GVarFlags(1173(RawFlags & 0x1) ? true : false, (RawFlags & 0x2) ? true : false,1174(RawFlags & 0x4) ? true : false,1175(GlobalObject::VCallVisibility)(RawFlags >> 3));1176}11771178static std::pair<CalleeInfo::HotnessType, bool>1179getDecodedHotnessCallEdgeInfo(uint64_t RawFlags) {1180CalleeInfo::HotnessType Hotness =1181static_cast<CalleeInfo::HotnessType>(RawFlags & 0x7); // 3 bits1182bool HasTailCall = (RawFlags & 0x8); // 1 bit1183return {Hotness, HasTailCall};1184}11851186static void getDecodedRelBFCallEdgeInfo(uint64_t RawFlags, uint64_t &RelBF,1187bool &HasTailCall) {1188static constexpr uint64_t RelBlockFreqMask =1189(1 << CalleeInfo::RelBlockFreqBits) - 1;1190RelBF = RawFlags & RelBlockFreqMask; // RelBlockFreqBits bits1191HasTailCall = (RawFlags & (1 << CalleeInfo::RelBlockFreqBits)); // 1 bit1192}11931194static GlobalValue::VisibilityTypes getDecodedVisibility(unsigned Val) {1195switch (Val) {1196default: // Map unknown visibilities to default.1197case 0: return GlobalValue::DefaultVisibility;1198case 1: return GlobalValue::HiddenVisibility;1199case 2: return GlobalValue::ProtectedVisibility;1200}1201}12021203static GlobalValue::DLLStorageClassTypes1204getDecodedDLLStorageClass(unsigned Val) {1205switch (Val) {1206default: // Map unknown values to default.1207case 0: return GlobalValue::DefaultStorageClass;1208case 1: return GlobalValue::DLLImportStorageClass;1209case 2: return GlobalValue::DLLExportStorageClass;1210}1211}12121213static bool getDecodedDSOLocal(unsigned Val) {1214switch(Val) {1215default: // Map unknown values to preemptable.1216case 0: return false;1217case 1: return true;1218}1219}12201221static std::optional<CodeModel::Model> getDecodedCodeModel(unsigned Val) {1222switch (Val) {1223case 1:1224return CodeModel::Tiny;1225case 2:1226return CodeModel::Small;1227case 3:1228return CodeModel::Kernel;1229case 4:1230return CodeModel::Medium;1231case 5:1232return CodeModel::Large;1233}12341235return {};1236}12371238static GlobalVariable::ThreadLocalMode getDecodedThreadLocalMode(unsigned Val) {1239switch (Val) {1240case 0: return GlobalVariable::NotThreadLocal;1241default: // Map unknown non-zero value to general dynamic.1242case 1: return GlobalVariable::GeneralDynamicTLSModel;1243case 2: return GlobalVariable::LocalDynamicTLSModel;1244case 3: return GlobalVariable::InitialExecTLSModel;1245case 4: return GlobalVariable::LocalExecTLSModel;1246}1247}12481249static GlobalVariable::UnnamedAddr getDecodedUnnamedAddrType(unsigned Val) {1250switch (Val) {1251default: // Map unknown to UnnamedAddr::None.1252case 0: return GlobalVariable::UnnamedAddr::None;1253case 1: return GlobalVariable::UnnamedAddr::Global;1254case 2: return GlobalVariable::UnnamedAddr::Local;1255}1256}12571258static int getDecodedCastOpcode(unsigned Val) {1259switch (Val) {1260default: return -1;1261case bitc::CAST_TRUNC : return Instruction::Trunc;1262case bitc::CAST_ZEXT : return Instruction::ZExt;1263case bitc::CAST_SEXT : return Instruction::SExt;1264case bitc::CAST_FPTOUI : return Instruction::FPToUI;1265case bitc::CAST_FPTOSI : return Instruction::FPToSI;1266case bitc::CAST_UITOFP : return Instruction::UIToFP;1267case bitc::CAST_SITOFP : return Instruction::SIToFP;1268case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;1269case bitc::CAST_FPEXT : return Instruction::FPExt;1270case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;1271case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;1272case bitc::CAST_BITCAST : return Instruction::BitCast;1273case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;1274}1275}12761277static int getDecodedUnaryOpcode(unsigned Val, Type *Ty) {1278bool IsFP = Ty->isFPOrFPVectorTy();1279// UnOps are only valid for int/fp or vector of int/fp types1280if (!IsFP && !Ty->isIntOrIntVectorTy())1281return -1;12821283switch (Val) {1284default:1285return -1;1286case bitc::UNOP_FNEG:1287return IsFP ? Instruction::FNeg : -1;1288}1289}12901291static int getDecodedBinaryOpcode(unsigned Val, Type *Ty) {1292bool IsFP = Ty->isFPOrFPVectorTy();1293// BinOps are only valid for int/fp or vector of int/fp types1294if (!IsFP && !Ty->isIntOrIntVectorTy())1295return -1;12961297switch (Val) {1298default:1299return -1;1300case bitc::BINOP_ADD:1301return IsFP ? Instruction::FAdd : Instruction::Add;1302case bitc::BINOP_SUB:1303return IsFP ? Instruction::FSub : Instruction::Sub;1304case bitc::BINOP_MUL:1305return IsFP ? Instruction::FMul : Instruction::Mul;1306case bitc::BINOP_UDIV:1307return IsFP ? -1 : Instruction::UDiv;1308case bitc::BINOP_SDIV:1309return IsFP ? Instruction::FDiv : Instruction::SDiv;1310case bitc::BINOP_UREM:1311return IsFP ? -1 : Instruction::URem;1312case bitc::BINOP_SREM:1313return IsFP ? Instruction::FRem : Instruction::SRem;1314case bitc::BINOP_SHL:1315return IsFP ? -1 : Instruction::Shl;1316case bitc::BINOP_LSHR:1317return IsFP ? -1 : Instruction::LShr;1318case bitc::BINOP_ASHR:1319return IsFP ? -1 : Instruction::AShr;1320case bitc::BINOP_AND:1321return IsFP ? -1 : Instruction::And;1322case bitc::BINOP_OR:1323return IsFP ? -1 : Instruction::Or;1324case bitc::BINOP_XOR:1325return IsFP ? -1 : Instruction::Xor;1326}1327}13281329static AtomicRMWInst::BinOp getDecodedRMWOperation(unsigned Val) {1330switch (Val) {1331default: return AtomicRMWInst::BAD_BINOP;1332case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;1333case bitc::RMW_ADD: return AtomicRMWInst::Add;1334case bitc::RMW_SUB: return AtomicRMWInst::Sub;1335case bitc::RMW_AND: return AtomicRMWInst::And;1336case bitc::RMW_NAND: return AtomicRMWInst::Nand;1337case bitc::RMW_OR: return AtomicRMWInst::Or;1338case bitc::RMW_XOR: return AtomicRMWInst::Xor;1339case bitc::RMW_MAX: return AtomicRMWInst::Max;1340case bitc::RMW_MIN: return AtomicRMWInst::Min;1341case bitc::RMW_UMAX: return AtomicRMWInst::UMax;1342case bitc::RMW_UMIN: return AtomicRMWInst::UMin;1343case bitc::RMW_FADD: return AtomicRMWInst::FAdd;1344case bitc::RMW_FSUB: return AtomicRMWInst::FSub;1345case bitc::RMW_FMAX: return AtomicRMWInst::FMax;1346case bitc::RMW_FMIN: return AtomicRMWInst::FMin;1347case bitc::RMW_UINC_WRAP:1348return AtomicRMWInst::UIncWrap;1349case bitc::RMW_UDEC_WRAP:1350return AtomicRMWInst::UDecWrap;1351}1352}13531354static AtomicOrdering getDecodedOrdering(unsigned Val) {1355switch (Val) {1356case bitc::ORDERING_NOTATOMIC: return AtomicOrdering::NotAtomic;1357case bitc::ORDERING_UNORDERED: return AtomicOrdering::Unordered;1358case bitc::ORDERING_MONOTONIC: return AtomicOrdering::Monotonic;1359case bitc::ORDERING_ACQUIRE: return AtomicOrdering::Acquire;1360case bitc::ORDERING_RELEASE: return AtomicOrdering::Release;1361case bitc::ORDERING_ACQREL: return AtomicOrdering::AcquireRelease;1362default: // Map unknown orderings to sequentially-consistent.1363case bitc::ORDERING_SEQCST: return AtomicOrdering::SequentiallyConsistent;1364}1365}13661367static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {1368switch (Val) {1369default: // Map unknown selection kinds to any.1370case bitc::COMDAT_SELECTION_KIND_ANY:1371return Comdat::Any;1372case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:1373return Comdat::ExactMatch;1374case bitc::COMDAT_SELECTION_KIND_LARGEST:1375return Comdat::Largest;1376case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:1377return Comdat::NoDeduplicate;1378case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:1379return Comdat::SameSize;1380}1381}13821383static FastMathFlags getDecodedFastMathFlags(unsigned Val) {1384FastMathFlags FMF;1385if (0 != (Val & bitc::UnsafeAlgebra))1386FMF.setFast();1387if (0 != (Val & bitc::AllowReassoc))1388FMF.setAllowReassoc();1389if (0 != (Val & bitc::NoNaNs))1390FMF.setNoNaNs();1391if (0 != (Val & bitc::NoInfs))1392FMF.setNoInfs();1393if (0 != (Val & bitc::NoSignedZeros))1394FMF.setNoSignedZeros();1395if (0 != (Val & bitc::AllowReciprocal))1396FMF.setAllowReciprocal();1397if (0 != (Val & bitc::AllowContract))1398FMF.setAllowContract(true);1399if (0 != (Val & bitc::ApproxFunc))1400FMF.setApproxFunc();1401return FMF;1402}14031404static void upgradeDLLImportExportLinkage(GlobalValue *GV, unsigned Val) {1405// A GlobalValue with local linkage cannot have a DLL storage class.1406if (GV->hasLocalLinkage())1407return;1408switch (Val) {1409case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;1410case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;1411}1412}14131414Type *BitcodeReader::getTypeByID(unsigned ID) {1415// The type table size is always specified correctly.1416if (ID >= TypeList.size())1417return nullptr;14181419if (Type *Ty = TypeList[ID])1420return Ty;14211422// If we have a forward reference, the only possible case is when it is to a1423// named struct. Just create a placeholder for now.1424return TypeList[ID] = createIdentifiedStructType(Context);1425}14261427unsigned BitcodeReader::getContainedTypeID(unsigned ID, unsigned Idx) {1428auto It = ContainedTypeIDs.find(ID);1429if (It == ContainedTypeIDs.end())1430return InvalidTypeID;14311432if (Idx >= It->second.size())1433return InvalidTypeID;14341435return It->second[Idx];1436}14371438Type *BitcodeReader::getPtrElementTypeByID(unsigned ID) {1439if (ID >= TypeList.size())1440return nullptr;14411442Type *Ty = TypeList[ID];1443if (!Ty->isPointerTy())1444return nullptr;14451446return getTypeByID(getContainedTypeID(ID, 0));1447}14481449unsigned BitcodeReader::getVirtualTypeID(Type *Ty,1450ArrayRef<unsigned> ChildTypeIDs) {1451unsigned ChildTypeID = ChildTypeIDs.empty() ? InvalidTypeID : ChildTypeIDs[0];1452auto CacheKey = std::make_pair(Ty, ChildTypeID);1453auto It = VirtualTypeIDs.find(CacheKey);1454if (It != VirtualTypeIDs.end()) {1455// The cmpxchg return value is the only place we need more than one1456// contained type ID, however the second one will always be the same (i1),1457// so we don't need to include it in the cache key. This asserts that the1458// contained types are indeed as expected and there are no collisions.1459assert((ChildTypeIDs.empty() ||1460ContainedTypeIDs[It->second] == ChildTypeIDs) &&1461"Incorrect cached contained type IDs");1462return It->second;1463}14641465unsigned TypeID = TypeList.size();1466TypeList.push_back(Ty);1467if (!ChildTypeIDs.empty())1468append_range(ContainedTypeIDs[TypeID], ChildTypeIDs);1469VirtualTypeIDs.insert({CacheKey, TypeID});1470return TypeID;1471}14721473static GEPNoWrapFlags toGEPNoWrapFlags(uint64_t Flags) {1474GEPNoWrapFlags NW;1475if (Flags & (1 << bitc::GEP_INBOUNDS))1476NW |= GEPNoWrapFlags::inBounds();1477if (Flags & (1 << bitc::GEP_NUSW))1478NW |= GEPNoWrapFlags::noUnsignedSignedWrap();1479if (Flags & (1 << bitc::GEP_NUW))1480NW |= GEPNoWrapFlags::noUnsignedWrap();1481return NW;1482}14831484static bool isConstExprSupported(const BitcodeConstant *BC) {1485uint8_t Opcode = BC->Opcode;14861487// These are not real constant expressions, always consider them supported.1488if (Opcode >= BitcodeConstant::FirstSpecialOpcode)1489return true;14901491// If -expand-constant-exprs is set, we want to consider all expressions1492// as unsupported.1493if (ExpandConstantExprs)1494return false;14951496if (Instruction::isBinaryOp(Opcode))1497return ConstantExpr::isSupportedBinOp(Opcode);14981499if (Instruction::isCast(Opcode))1500return ConstantExpr::isSupportedCastOp(Opcode);15011502if (Opcode == Instruction::GetElementPtr)1503return ConstantExpr::isSupportedGetElementPtr(BC->SrcElemTy);15041505switch (Opcode) {1506case Instruction::FNeg:1507case Instruction::Select:1508case Instruction::ICmp:1509case Instruction::FCmp:1510return false;1511default:1512return true;1513}1514}15151516Expected<Value *> BitcodeReader::materializeValue(unsigned StartValID,1517BasicBlock *InsertBB) {1518// Quickly handle the case where there is no BitcodeConstant to resolve.1519if (StartValID < ValueList.size() && ValueList[StartValID] &&1520!isa<BitcodeConstant>(ValueList[StartValID]))1521return ValueList[StartValID];15221523SmallDenseMap<unsigned, Value *> MaterializedValues;1524SmallVector<unsigned> Worklist;1525Worklist.push_back(StartValID);1526while (!Worklist.empty()) {1527unsigned ValID = Worklist.back();1528if (MaterializedValues.count(ValID)) {1529// Duplicate expression that was already handled.1530Worklist.pop_back();1531continue;1532}15331534if (ValID >= ValueList.size() || !ValueList[ValID])1535return error("Invalid value ID");15361537Value *V = ValueList[ValID];1538auto *BC = dyn_cast<BitcodeConstant>(V);1539if (!BC) {1540MaterializedValues.insert({ValID, V});1541Worklist.pop_back();1542continue;1543}15441545// Iterate in reverse, so values will get popped from the worklist in1546// expected order.1547SmallVector<Value *> Ops;1548for (unsigned OpID : reverse(BC->getOperandIDs())) {1549auto It = MaterializedValues.find(OpID);1550if (It != MaterializedValues.end())1551Ops.push_back(It->second);1552else1553Worklist.push_back(OpID);1554}15551556// Some expressions have not been resolved yet, handle them first and then1557// revisit this one.1558if (Ops.size() != BC->getOperandIDs().size())1559continue;1560std::reverse(Ops.begin(), Ops.end());15611562SmallVector<Constant *> ConstOps;1563for (Value *Op : Ops)1564if (auto *C = dyn_cast<Constant>(Op))1565ConstOps.push_back(C);15661567// Materialize as constant expression if possible.1568if (isConstExprSupported(BC) && ConstOps.size() == Ops.size()) {1569Constant *C;1570if (Instruction::isCast(BC->Opcode)) {1571C = UpgradeBitCastExpr(BC->Opcode, ConstOps[0], BC->getType());1572if (!C)1573C = ConstantExpr::getCast(BC->Opcode, ConstOps[0], BC->getType());1574} else if (Instruction::isBinaryOp(BC->Opcode)) {1575C = ConstantExpr::get(BC->Opcode, ConstOps[0], ConstOps[1], BC->Flags);1576} else {1577switch (BC->Opcode) {1578case BitcodeConstant::ConstantPtrAuthOpcode: {1579auto *Key = dyn_cast<ConstantInt>(ConstOps[1]);1580if (!Key)1581return error("ptrauth key operand must be ConstantInt");15821583auto *Disc = dyn_cast<ConstantInt>(ConstOps[2]);1584if (!Disc)1585return error("ptrauth disc operand must be ConstantInt");15861587C = ConstantPtrAuth::get(ConstOps[0], Key, Disc, ConstOps[3]);1588break;1589}1590case BitcodeConstant::NoCFIOpcode: {1591auto *GV = dyn_cast<GlobalValue>(ConstOps[0]);1592if (!GV)1593return error("no_cfi operand must be GlobalValue");1594C = NoCFIValue::get(GV);1595break;1596}1597case BitcodeConstant::DSOLocalEquivalentOpcode: {1598auto *GV = dyn_cast<GlobalValue>(ConstOps[0]);1599if (!GV)1600return error("dso_local operand must be GlobalValue");1601C = DSOLocalEquivalent::get(GV);1602break;1603}1604case BitcodeConstant::BlockAddressOpcode: {1605Function *Fn = dyn_cast<Function>(ConstOps[0]);1606if (!Fn)1607return error("blockaddress operand must be a function");16081609// If the function is already parsed we can insert the block address1610// right away.1611BasicBlock *BB;1612unsigned BBID = BC->BlockAddressBB;1613if (!BBID)1614// Invalid reference to entry block.1615return error("Invalid ID");1616if (!Fn->empty()) {1617Function::iterator BBI = Fn->begin(), BBE = Fn->end();1618for (size_t I = 0, E = BBID; I != E; ++I) {1619if (BBI == BBE)1620return error("Invalid ID");1621++BBI;1622}1623BB = &*BBI;1624} else {1625// Otherwise insert a placeholder and remember it so it can be1626// inserted when the function is parsed.1627auto &FwdBBs = BasicBlockFwdRefs[Fn];1628if (FwdBBs.empty())1629BasicBlockFwdRefQueue.push_back(Fn);1630if (FwdBBs.size() < BBID + 1)1631FwdBBs.resize(BBID + 1);1632if (!FwdBBs[BBID])1633FwdBBs[BBID] = BasicBlock::Create(Context);1634BB = FwdBBs[BBID];1635}1636C = BlockAddress::get(Fn, BB);1637break;1638}1639case BitcodeConstant::ConstantStructOpcode:1640C = ConstantStruct::get(cast<StructType>(BC->getType()), ConstOps);1641break;1642case BitcodeConstant::ConstantArrayOpcode:1643C = ConstantArray::get(cast<ArrayType>(BC->getType()), ConstOps);1644break;1645case BitcodeConstant::ConstantVectorOpcode:1646C = ConstantVector::get(ConstOps);1647break;1648case Instruction::GetElementPtr:1649C = ConstantExpr::getGetElementPtr(1650BC->SrcElemTy, ConstOps[0], ArrayRef(ConstOps).drop_front(),1651toGEPNoWrapFlags(BC->Flags), BC->getInRange());1652break;1653case Instruction::ExtractElement:1654C = ConstantExpr::getExtractElement(ConstOps[0], ConstOps[1]);1655break;1656case Instruction::InsertElement:1657C = ConstantExpr::getInsertElement(ConstOps[0], ConstOps[1],1658ConstOps[2]);1659break;1660case Instruction::ShuffleVector: {1661SmallVector<int, 16> Mask;1662ShuffleVectorInst::getShuffleMask(ConstOps[2], Mask);1663C = ConstantExpr::getShuffleVector(ConstOps[0], ConstOps[1], Mask);1664break;1665}1666default:1667llvm_unreachable("Unhandled bitcode constant");1668}1669}16701671// Cache resolved constant.1672ValueList.replaceValueWithoutRAUW(ValID, C);1673MaterializedValues.insert({ValID, C});1674Worklist.pop_back();1675continue;1676}16771678if (!InsertBB)1679return error(Twine("Value referenced by initializer is an unsupported "1680"constant expression of type ") +1681BC->getOpcodeName());16821683// Materialize as instructions if necessary.1684Instruction *I;1685if (Instruction::isCast(BC->Opcode)) {1686I = CastInst::Create((Instruction::CastOps)BC->Opcode, Ops[0],1687BC->getType(), "constexpr", InsertBB);1688} else if (Instruction::isUnaryOp(BC->Opcode)) {1689I = UnaryOperator::Create((Instruction::UnaryOps)BC->Opcode, Ops[0],1690"constexpr", InsertBB);1691} else if (Instruction::isBinaryOp(BC->Opcode)) {1692I = BinaryOperator::Create((Instruction::BinaryOps)BC->Opcode, Ops[0],1693Ops[1], "constexpr", InsertBB);1694if (isa<OverflowingBinaryOperator>(I)) {1695if (BC->Flags & OverflowingBinaryOperator::NoSignedWrap)1696I->setHasNoSignedWrap();1697if (BC->Flags & OverflowingBinaryOperator::NoUnsignedWrap)1698I->setHasNoUnsignedWrap();1699}1700if (isa<PossiblyExactOperator>(I) &&1701(BC->Flags & PossiblyExactOperator::IsExact))1702I->setIsExact();1703} else {1704switch (BC->Opcode) {1705case BitcodeConstant::ConstantVectorOpcode: {1706Type *IdxTy = Type::getInt32Ty(BC->getContext());1707Value *V = PoisonValue::get(BC->getType());1708for (auto Pair : enumerate(Ops)) {1709Value *Idx = ConstantInt::get(IdxTy, Pair.index());1710V = InsertElementInst::Create(V, Pair.value(), Idx, "constexpr.ins",1711InsertBB);1712}1713I = cast<Instruction>(V);1714break;1715}1716case BitcodeConstant::ConstantStructOpcode:1717case BitcodeConstant::ConstantArrayOpcode: {1718Value *V = PoisonValue::get(BC->getType());1719for (auto Pair : enumerate(Ops))1720V = InsertValueInst::Create(V, Pair.value(), Pair.index(),1721"constexpr.ins", InsertBB);1722I = cast<Instruction>(V);1723break;1724}1725case Instruction::ICmp:1726case Instruction::FCmp:1727I = CmpInst::Create((Instruction::OtherOps)BC->Opcode,1728(CmpInst::Predicate)BC->Flags, Ops[0], Ops[1],1729"constexpr", InsertBB);1730break;1731case Instruction::GetElementPtr:1732I = GetElementPtrInst::Create(BC->SrcElemTy, Ops[0],1733ArrayRef(Ops).drop_front(), "constexpr",1734InsertBB);1735cast<GetElementPtrInst>(I)->setNoWrapFlags(toGEPNoWrapFlags(BC->Flags));1736break;1737case Instruction::Select:1738I = SelectInst::Create(Ops[0], Ops[1], Ops[2], "constexpr", InsertBB);1739break;1740case Instruction::ExtractElement:1741I = ExtractElementInst::Create(Ops[0], Ops[1], "constexpr", InsertBB);1742break;1743case Instruction::InsertElement:1744I = InsertElementInst::Create(Ops[0], Ops[1], Ops[2], "constexpr",1745InsertBB);1746break;1747case Instruction::ShuffleVector:1748I = new ShuffleVectorInst(Ops[0], Ops[1], Ops[2], "constexpr",1749InsertBB);1750break;1751default:1752llvm_unreachable("Unhandled bitcode constant");1753}1754}17551756MaterializedValues.insert({ValID, I});1757Worklist.pop_back();1758}17591760return MaterializedValues[StartValID];1761}17621763Expected<Constant *> BitcodeReader::getValueForInitializer(unsigned ID) {1764Expected<Value *> MaybeV = materializeValue(ID, /* InsertBB */ nullptr);1765if (!MaybeV)1766return MaybeV.takeError();17671768// Result must be Constant if InsertBB is nullptr.1769return cast<Constant>(MaybeV.get());1770}17711772StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,1773StringRef Name) {1774auto *Ret = StructType::create(Context, Name);1775IdentifiedStructTypes.push_back(Ret);1776return Ret;1777}17781779StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {1780auto *Ret = StructType::create(Context);1781IdentifiedStructTypes.push_back(Ret);1782return Ret;1783}17841785//===----------------------------------------------------------------------===//1786// Functions for parsing blocks from the bitcode file1787//===----------------------------------------------------------------------===//17881789static uint64_t getRawAttributeMask(Attribute::AttrKind Val) {1790switch (Val) {1791case Attribute::EndAttrKinds:1792case Attribute::EmptyKey:1793case Attribute::TombstoneKey:1794llvm_unreachable("Synthetic enumerators which should never get here");17951796case Attribute::None: return 0;1797case Attribute::ZExt: return 1 << 0;1798case Attribute::SExt: return 1 << 1;1799case Attribute::NoReturn: return 1 << 2;1800case Attribute::InReg: return 1 << 3;1801case Attribute::StructRet: return 1 << 4;1802case Attribute::NoUnwind: return 1 << 5;1803case Attribute::NoAlias: return 1 << 6;1804case Attribute::ByVal: return 1 << 7;1805case Attribute::Nest: return 1 << 8;1806case Attribute::ReadNone: return 1 << 9;1807case Attribute::ReadOnly: return 1 << 10;1808case Attribute::NoInline: return 1 << 11;1809case Attribute::AlwaysInline: return 1 << 12;1810case Attribute::OptimizeForSize: return 1 << 13;1811case Attribute::StackProtect: return 1 << 14;1812case Attribute::StackProtectReq: return 1 << 15;1813case Attribute::Alignment: return 31 << 16;1814case Attribute::NoCapture: return 1 << 21;1815case Attribute::NoRedZone: return 1 << 22;1816case Attribute::NoImplicitFloat: return 1 << 23;1817case Attribute::Naked: return 1 << 24;1818case Attribute::InlineHint: return 1 << 25;1819case Attribute::StackAlignment: return 7 << 26;1820case Attribute::ReturnsTwice: return 1 << 29;1821case Attribute::UWTable: return 1 << 30;1822case Attribute::NonLazyBind: return 1U << 31;1823case Attribute::SanitizeAddress: return 1ULL << 32;1824case Attribute::MinSize: return 1ULL << 33;1825case Attribute::NoDuplicate: return 1ULL << 34;1826case Attribute::StackProtectStrong: return 1ULL << 35;1827case Attribute::SanitizeThread: return 1ULL << 36;1828case Attribute::SanitizeMemory: return 1ULL << 37;1829case Attribute::NoBuiltin: return 1ULL << 38;1830case Attribute::Returned: return 1ULL << 39;1831case Attribute::Cold: return 1ULL << 40;1832case Attribute::Builtin: return 1ULL << 41;1833case Attribute::OptimizeNone: return 1ULL << 42;1834case Attribute::InAlloca: return 1ULL << 43;1835case Attribute::NonNull: return 1ULL << 44;1836case Attribute::JumpTable: return 1ULL << 45;1837case Attribute::Convergent: return 1ULL << 46;1838case Attribute::SafeStack: return 1ULL << 47;1839case Attribute::NoRecurse: return 1ULL << 48;1840// 1ULL << 49 is InaccessibleMemOnly, which is upgraded separately.1841// 1ULL << 50 is InaccessibleMemOrArgMemOnly, which is upgraded separately.1842case Attribute::SwiftSelf: return 1ULL << 51;1843case Attribute::SwiftError: return 1ULL << 52;1844case Attribute::WriteOnly: return 1ULL << 53;1845case Attribute::Speculatable: return 1ULL << 54;1846case Attribute::StrictFP: return 1ULL << 55;1847case Attribute::SanitizeHWAddress: return 1ULL << 56;1848case Attribute::NoCfCheck: return 1ULL << 57;1849case Attribute::OptForFuzzing: return 1ULL << 58;1850case Attribute::ShadowCallStack: return 1ULL << 59;1851case Attribute::SpeculativeLoadHardening:1852return 1ULL << 60;1853case Attribute::ImmArg:1854return 1ULL << 61;1855case Attribute::WillReturn:1856return 1ULL << 62;1857case Attribute::NoFree:1858return 1ULL << 63;1859default:1860// Other attributes are not supported in the raw format,1861// as we ran out of space.1862return 0;1863}1864llvm_unreachable("Unsupported attribute type");1865}18661867static void addRawAttributeValue(AttrBuilder &B, uint64_t Val) {1868if (!Val) return;18691870for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;1871I = Attribute::AttrKind(I + 1)) {1872if (uint64_t A = (Val & getRawAttributeMask(I))) {1873if (I == Attribute::Alignment)1874B.addAlignmentAttr(1ULL << ((A >> 16) - 1));1875else if (I == Attribute::StackAlignment)1876B.addStackAlignmentAttr(1ULL << ((A >> 26)-1));1877else if (Attribute::isTypeAttrKind(I))1878B.addTypeAttr(I, nullptr); // Type will be auto-upgraded.1879else1880B.addAttribute(I);1881}1882}1883}18841885/// This fills an AttrBuilder object with the LLVM attributes that have1886/// been decoded from the given integer. This function must stay in sync with1887/// 'encodeLLVMAttributesForBitcode'.1888static void decodeLLVMAttributesForBitcode(AttrBuilder &B,1889uint64_t EncodedAttrs,1890uint64_t AttrIdx) {1891// The alignment is stored as a 16-bit raw value from bits 31--16. We shift1892// the bits above 31 down by 11 bits.1893unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;1894assert((!Alignment || isPowerOf2_32(Alignment)) &&1895"Alignment must be a power of two.");18961897if (Alignment)1898B.addAlignmentAttr(Alignment);18991900uint64_t Attrs = ((EncodedAttrs & (0xfffffULL << 32)) >> 11) |1901(EncodedAttrs & 0xffff);19021903if (AttrIdx == AttributeList::FunctionIndex) {1904// Upgrade old memory attributes.1905MemoryEffects ME = MemoryEffects::unknown();1906if (Attrs & (1ULL << 9)) {1907// ReadNone1908Attrs &= ~(1ULL << 9);1909ME &= MemoryEffects::none();1910}1911if (Attrs & (1ULL << 10)) {1912// ReadOnly1913Attrs &= ~(1ULL << 10);1914ME &= MemoryEffects::readOnly();1915}1916if (Attrs & (1ULL << 49)) {1917// InaccessibleMemOnly1918Attrs &= ~(1ULL << 49);1919ME &= MemoryEffects::inaccessibleMemOnly();1920}1921if (Attrs & (1ULL << 50)) {1922// InaccessibleMemOrArgMemOnly1923Attrs &= ~(1ULL << 50);1924ME &= MemoryEffects::inaccessibleOrArgMemOnly();1925}1926if (Attrs & (1ULL << 53)) {1927// WriteOnly1928Attrs &= ~(1ULL << 53);1929ME &= MemoryEffects::writeOnly();1930}1931if (ME != MemoryEffects::unknown())1932B.addMemoryAttr(ME);1933}19341935addRawAttributeValue(B, Attrs);1936}19371938Error BitcodeReader::parseAttributeBlock() {1939if (Error Err = Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))1940return Err;19411942if (!MAttributes.empty())1943return error("Invalid multiple blocks");19441945SmallVector<uint64_t, 64> Record;19461947SmallVector<AttributeList, 8> Attrs;19481949// Read all the records.1950while (true) {1951Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();1952if (!MaybeEntry)1953return MaybeEntry.takeError();1954BitstreamEntry Entry = MaybeEntry.get();19551956switch (Entry.Kind) {1957case BitstreamEntry::SubBlock: // Handled for us already.1958case BitstreamEntry::Error:1959return error("Malformed block");1960case BitstreamEntry::EndBlock:1961return Error::success();1962case BitstreamEntry::Record:1963// The interesting case.1964break;1965}19661967// Read a record.1968Record.clear();1969Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);1970if (!MaybeRecord)1971return MaybeRecord.takeError();1972switch (MaybeRecord.get()) {1973default: // Default behavior: ignore.1974break;1975case bitc::PARAMATTR_CODE_ENTRY_OLD: // ENTRY: [paramidx0, attr0, ...]1976// Deprecated, but still needed to read old bitcode files.1977if (Record.size() & 1)1978return error("Invalid parameter attribute record");19791980for (unsigned i = 0, e = Record.size(); i != e; i += 2) {1981AttrBuilder B(Context);1982decodeLLVMAttributesForBitcode(B, Record[i+1], Record[i]);1983Attrs.push_back(AttributeList::get(Context, Record[i], B));1984}19851986MAttributes.push_back(AttributeList::get(Context, Attrs));1987Attrs.clear();1988break;1989case bitc::PARAMATTR_CODE_ENTRY: // ENTRY: [attrgrp0, attrgrp1, ...]1990for (uint64_t Val : Record)1991Attrs.push_back(MAttributeGroups[Val]);19921993MAttributes.push_back(AttributeList::get(Context, Attrs));1994Attrs.clear();1995break;1996}1997}1998}19992000// Returns Attribute::None on unrecognized codes.2001static Attribute::AttrKind getAttrFromCode(uint64_t Code) {2002switch (Code) {2003default:2004return Attribute::None;2005case bitc::ATTR_KIND_ALIGNMENT:2006return Attribute::Alignment;2007case bitc::ATTR_KIND_ALWAYS_INLINE:2008return Attribute::AlwaysInline;2009case bitc::ATTR_KIND_BUILTIN:2010return Attribute::Builtin;2011case bitc::ATTR_KIND_BY_VAL:2012return Attribute::ByVal;2013case bitc::ATTR_KIND_IN_ALLOCA:2014return Attribute::InAlloca;2015case bitc::ATTR_KIND_COLD:2016return Attribute::Cold;2017case bitc::ATTR_KIND_CONVERGENT:2018return Attribute::Convergent;2019case bitc::ATTR_KIND_DISABLE_SANITIZER_INSTRUMENTATION:2020return Attribute::DisableSanitizerInstrumentation;2021case bitc::ATTR_KIND_ELEMENTTYPE:2022return Attribute::ElementType;2023case bitc::ATTR_KIND_FNRETTHUNK_EXTERN:2024return Attribute::FnRetThunkExtern;2025case bitc::ATTR_KIND_INLINE_HINT:2026return Attribute::InlineHint;2027case bitc::ATTR_KIND_IN_REG:2028return Attribute::InReg;2029case bitc::ATTR_KIND_JUMP_TABLE:2030return Attribute::JumpTable;2031case bitc::ATTR_KIND_MEMORY:2032return Attribute::Memory;2033case bitc::ATTR_KIND_NOFPCLASS:2034return Attribute::NoFPClass;2035case bitc::ATTR_KIND_MIN_SIZE:2036return Attribute::MinSize;2037case bitc::ATTR_KIND_NAKED:2038return Attribute::Naked;2039case bitc::ATTR_KIND_NEST:2040return Attribute::Nest;2041case bitc::ATTR_KIND_NO_ALIAS:2042return Attribute::NoAlias;2043case bitc::ATTR_KIND_NO_BUILTIN:2044return Attribute::NoBuiltin;2045case bitc::ATTR_KIND_NO_CALLBACK:2046return Attribute::NoCallback;2047case bitc::ATTR_KIND_NO_CAPTURE:2048return Attribute::NoCapture;2049case bitc::ATTR_KIND_NO_DUPLICATE:2050return Attribute::NoDuplicate;2051case bitc::ATTR_KIND_NOFREE:2052return Attribute::NoFree;2053case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:2054return Attribute::NoImplicitFloat;2055case bitc::ATTR_KIND_NO_INLINE:2056return Attribute::NoInline;2057case bitc::ATTR_KIND_NO_RECURSE:2058return Attribute::NoRecurse;2059case bitc::ATTR_KIND_NO_MERGE:2060return Attribute::NoMerge;2061case bitc::ATTR_KIND_NON_LAZY_BIND:2062return Attribute::NonLazyBind;2063case bitc::ATTR_KIND_NON_NULL:2064return Attribute::NonNull;2065case bitc::ATTR_KIND_DEREFERENCEABLE:2066return Attribute::Dereferenceable;2067case bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL:2068return Attribute::DereferenceableOrNull;2069case bitc::ATTR_KIND_ALLOC_ALIGN:2070return Attribute::AllocAlign;2071case bitc::ATTR_KIND_ALLOC_KIND:2072return Attribute::AllocKind;2073case bitc::ATTR_KIND_ALLOC_SIZE:2074return Attribute::AllocSize;2075case bitc::ATTR_KIND_ALLOCATED_POINTER:2076return Attribute::AllocatedPointer;2077case bitc::ATTR_KIND_NO_RED_ZONE:2078return Attribute::NoRedZone;2079case bitc::ATTR_KIND_NO_RETURN:2080return Attribute::NoReturn;2081case bitc::ATTR_KIND_NOSYNC:2082return Attribute::NoSync;2083case bitc::ATTR_KIND_NOCF_CHECK:2084return Attribute::NoCfCheck;2085case bitc::ATTR_KIND_NO_PROFILE:2086return Attribute::NoProfile;2087case bitc::ATTR_KIND_SKIP_PROFILE:2088return Attribute::SkipProfile;2089case bitc::ATTR_KIND_NO_UNWIND:2090return Attribute::NoUnwind;2091case bitc::ATTR_KIND_NO_SANITIZE_BOUNDS:2092return Attribute::NoSanitizeBounds;2093case bitc::ATTR_KIND_NO_SANITIZE_COVERAGE:2094return Attribute::NoSanitizeCoverage;2095case bitc::ATTR_KIND_NULL_POINTER_IS_VALID:2096return Attribute::NullPointerIsValid;2097case bitc::ATTR_KIND_OPTIMIZE_FOR_DEBUGGING:2098return Attribute::OptimizeForDebugging;2099case bitc::ATTR_KIND_OPT_FOR_FUZZING:2100return Attribute::OptForFuzzing;2101case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:2102return Attribute::OptimizeForSize;2103case bitc::ATTR_KIND_OPTIMIZE_NONE:2104return Attribute::OptimizeNone;2105case bitc::ATTR_KIND_READ_NONE:2106return Attribute::ReadNone;2107case bitc::ATTR_KIND_READ_ONLY:2108return Attribute::ReadOnly;2109case bitc::ATTR_KIND_RETURNED:2110return Attribute::Returned;2111case bitc::ATTR_KIND_RETURNS_TWICE:2112return Attribute::ReturnsTwice;2113case bitc::ATTR_KIND_S_EXT:2114return Attribute::SExt;2115case bitc::ATTR_KIND_SPECULATABLE:2116return Attribute::Speculatable;2117case bitc::ATTR_KIND_STACK_ALIGNMENT:2118return Attribute::StackAlignment;2119case bitc::ATTR_KIND_STACK_PROTECT:2120return Attribute::StackProtect;2121case bitc::ATTR_KIND_STACK_PROTECT_REQ:2122return Attribute::StackProtectReq;2123case bitc::ATTR_KIND_STACK_PROTECT_STRONG:2124return Attribute::StackProtectStrong;2125case bitc::ATTR_KIND_SAFESTACK:2126return Attribute::SafeStack;2127case bitc::ATTR_KIND_SHADOWCALLSTACK:2128return Attribute::ShadowCallStack;2129case bitc::ATTR_KIND_STRICT_FP:2130return Attribute::StrictFP;2131case bitc::ATTR_KIND_STRUCT_RET:2132return Attribute::StructRet;2133case bitc::ATTR_KIND_SANITIZE_ADDRESS:2134return Attribute::SanitizeAddress;2135case bitc::ATTR_KIND_SANITIZE_HWADDRESS:2136return Attribute::SanitizeHWAddress;2137case bitc::ATTR_KIND_SANITIZE_THREAD:2138return Attribute::SanitizeThread;2139case bitc::ATTR_KIND_SANITIZE_MEMORY:2140return Attribute::SanitizeMemory;2141case bitc::ATTR_KIND_SANITIZE_NUMERICAL_STABILITY:2142return Attribute::SanitizeNumericalStability;2143case bitc::ATTR_KIND_SPECULATIVE_LOAD_HARDENING:2144return Attribute::SpeculativeLoadHardening;2145case bitc::ATTR_KIND_SWIFT_ERROR:2146return Attribute::SwiftError;2147case bitc::ATTR_KIND_SWIFT_SELF:2148return Attribute::SwiftSelf;2149case bitc::ATTR_KIND_SWIFT_ASYNC:2150return Attribute::SwiftAsync;2151case bitc::ATTR_KIND_UW_TABLE:2152return Attribute::UWTable;2153case bitc::ATTR_KIND_VSCALE_RANGE:2154return Attribute::VScaleRange;2155case bitc::ATTR_KIND_WILLRETURN:2156return Attribute::WillReturn;2157case bitc::ATTR_KIND_WRITEONLY:2158return Attribute::WriteOnly;2159case bitc::ATTR_KIND_Z_EXT:2160return Attribute::ZExt;2161case bitc::ATTR_KIND_IMMARG:2162return Attribute::ImmArg;2163case bitc::ATTR_KIND_SANITIZE_MEMTAG:2164return Attribute::SanitizeMemTag;2165case bitc::ATTR_KIND_PREALLOCATED:2166return Attribute::Preallocated;2167case bitc::ATTR_KIND_NOUNDEF:2168return Attribute::NoUndef;2169case bitc::ATTR_KIND_BYREF:2170return Attribute::ByRef;2171case bitc::ATTR_KIND_MUSTPROGRESS:2172return Attribute::MustProgress;2173case bitc::ATTR_KIND_HOT:2174return Attribute::Hot;2175case bitc::ATTR_KIND_PRESPLIT_COROUTINE:2176return Attribute::PresplitCoroutine;2177case bitc::ATTR_KIND_WRITABLE:2178return Attribute::Writable;2179case bitc::ATTR_KIND_CORO_ONLY_DESTROY_WHEN_COMPLETE:2180return Attribute::CoroDestroyOnlyWhenComplete;2181case bitc::ATTR_KIND_DEAD_ON_UNWIND:2182return Attribute::DeadOnUnwind;2183case bitc::ATTR_KIND_RANGE:2184return Attribute::Range;2185case bitc::ATTR_KIND_INITIALIZES:2186return Attribute::Initializes;2187}2188}21892190Error BitcodeReader::parseAlignmentValue(uint64_t Exponent,2191MaybeAlign &Alignment) {2192// Note: Alignment in bitcode files is incremented by 1, so that zero2193// can be used for default alignment.2194if (Exponent > Value::MaxAlignmentExponent + 1)2195return error("Invalid alignment value");2196Alignment = decodeMaybeAlign(Exponent);2197return Error::success();2198}21992200Error BitcodeReader::parseAttrKind(uint64_t Code, Attribute::AttrKind *Kind) {2201*Kind = getAttrFromCode(Code);2202if (*Kind == Attribute::None)2203return error("Unknown attribute kind (" + Twine(Code) + ")");2204return Error::success();2205}22062207static bool upgradeOldMemoryAttribute(MemoryEffects &ME, uint64_t EncodedKind) {2208switch (EncodedKind) {2209case bitc::ATTR_KIND_READ_NONE:2210ME &= MemoryEffects::none();2211return true;2212case bitc::ATTR_KIND_READ_ONLY:2213ME &= MemoryEffects::readOnly();2214return true;2215case bitc::ATTR_KIND_WRITEONLY:2216ME &= MemoryEffects::writeOnly();2217return true;2218case bitc::ATTR_KIND_ARGMEMONLY:2219ME &= MemoryEffects::argMemOnly();2220return true;2221case bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY:2222ME &= MemoryEffects::inaccessibleMemOnly();2223return true;2224case bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY:2225ME &= MemoryEffects::inaccessibleOrArgMemOnly();2226return true;2227default:2228return false;2229}2230}22312232Error BitcodeReader::parseAttributeGroupBlock() {2233if (Error Err = Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))2234return Err;22352236if (!MAttributeGroups.empty())2237return error("Invalid multiple blocks");22382239SmallVector<uint64_t, 64> Record;22402241// Read all the records.2242while (true) {2243Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();2244if (!MaybeEntry)2245return MaybeEntry.takeError();2246BitstreamEntry Entry = MaybeEntry.get();22472248switch (Entry.Kind) {2249case BitstreamEntry::SubBlock: // Handled for us already.2250case BitstreamEntry::Error:2251return error("Malformed block");2252case BitstreamEntry::EndBlock:2253return Error::success();2254case BitstreamEntry::Record:2255// The interesting case.2256break;2257}22582259// Read a record.2260Record.clear();2261Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);2262if (!MaybeRecord)2263return MaybeRecord.takeError();2264switch (MaybeRecord.get()) {2265default: // Default behavior: ignore.2266break;2267case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]2268if (Record.size() < 3)2269return error("Invalid grp record");22702271uint64_t GrpID = Record[0];2272uint64_t Idx = Record[1]; // Index of the object this attribute refers to.22732274AttrBuilder B(Context);2275MemoryEffects ME = MemoryEffects::unknown();2276for (unsigned i = 2, e = Record.size(); i != e; ++i) {2277if (Record[i] == 0) { // Enum attribute2278Attribute::AttrKind Kind;2279uint64_t EncodedKind = Record[++i];2280if (Idx == AttributeList::FunctionIndex &&2281upgradeOldMemoryAttribute(ME, EncodedKind))2282continue;22832284if (Error Err = parseAttrKind(EncodedKind, &Kind))2285return Err;22862287// Upgrade old-style byval attribute to one with a type, even if it's2288// nullptr. We will have to insert the real type when we associate2289// this AttributeList with a function.2290if (Kind == Attribute::ByVal)2291B.addByValAttr(nullptr);2292else if (Kind == Attribute::StructRet)2293B.addStructRetAttr(nullptr);2294else if (Kind == Attribute::InAlloca)2295B.addInAllocaAttr(nullptr);2296else if (Kind == Attribute::UWTable)2297B.addUWTableAttr(UWTableKind::Default);2298else if (Attribute::isEnumAttrKind(Kind))2299B.addAttribute(Kind);2300else2301return error("Not an enum attribute");2302} else if (Record[i] == 1) { // Integer attribute2303Attribute::AttrKind Kind;2304if (Error Err = parseAttrKind(Record[++i], &Kind))2305return Err;2306if (!Attribute::isIntAttrKind(Kind))2307return error("Not an int attribute");2308if (Kind == Attribute::Alignment)2309B.addAlignmentAttr(Record[++i]);2310else if (Kind == Attribute::StackAlignment)2311B.addStackAlignmentAttr(Record[++i]);2312else if (Kind == Attribute::Dereferenceable)2313B.addDereferenceableAttr(Record[++i]);2314else if (Kind == Attribute::DereferenceableOrNull)2315B.addDereferenceableOrNullAttr(Record[++i]);2316else if (Kind == Attribute::AllocSize)2317B.addAllocSizeAttrFromRawRepr(Record[++i]);2318else if (Kind == Attribute::VScaleRange)2319B.addVScaleRangeAttrFromRawRepr(Record[++i]);2320else if (Kind == Attribute::UWTable)2321B.addUWTableAttr(UWTableKind(Record[++i]));2322else if (Kind == Attribute::AllocKind)2323B.addAllocKindAttr(static_cast<AllocFnKind>(Record[++i]));2324else if (Kind == Attribute::Memory)2325B.addMemoryAttr(MemoryEffects::createFromIntValue(Record[++i]));2326else if (Kind == Attribute::NoFPClass)2327B.addNoFPClassAttr(2328static_cast<FPClassTest>(Record[++i] & fcAllFlags));2329} else if (Record[i] == 3 || Record[i] == 4) { // String attribute2330bool HasValue = (Record[i++] == 4);2331SmallString<64> KindStr;2332SmallString<64> ValStr;23332334while (Record[i] != 0 && i != e)2335KindStr += Record[i++];2336assert(Record[i] == 0 && "Kind string not null terminated");23372338if (HasValue) {2339// Has a value associated with it.2340++i; // Skip the '0' that terminates the "kind" string.2341while (Record[i] != 0 && i != e)2342ValStr += Record[i++];2343assert(Record[i] == 0 && "Value string not null terminated");2344}23452346B.addAttribute(KindStr.str(), ValStr.str());2347} else if (Record[i] == 5 || Record[i] == 6) {2348bool HasType = Record[i] == 6;2349Attribute::AttrKind Kind;2350if (Error Err = parseAttrKind(Record[++i], &Kind))2351return Err;2352if (!Attribute::isTypeAttrKind(Kind))2353return error("Not a type attribute");23542355B.addTypeAttr(Kind, HasType ? getTypeByID(Record[++i]) : nullptr);2356} else if (Record[i] == 7) {2357Attribute::AttrKind Kind;23582359i++;2360if (Error Err = parseAttrKind(Record[i++], &Kind))2361return Err;2362if (!Attribute::isConstantRangeAttrKind(Kind))2363return error("Not a ConstantRange attribute");23642365Expected<ConstantRange> MaybeCR =2366readBitWidthAndConstantRange(Record, i);2367if (!MaybeCR)2368return MaybeCR.takeError();2369i--;23702371B.addConstantRangeAttr(Kind, MaybeCR.get());2372} else if (Record[i] == 8) {2373Attribute::AttrKind Kind;23742375i++;2376if (Error Err = parseAttrKind(Record[i++], &Kind))2377return Err;2378if (!Attribute::isConstantRangeListAttrKind(Kind))2379return error("Not a constant range list attribute");23802381SmallVector<ConstantRange, 2> Val;2382if (i + 2 > e)2383return error("Too few records for constant range list");2384unsigned RangeSize = Record[i++];2385unsigned BitWidth = Record[i++];2386for (unsigned Idx = 0; Idx < RangeSize; ++Idx) {2387Expected<ConstantRange> MaybeCR =2388readConstantRange(Record, i, BitWidth);2389if (!MaybeCR)2390return MaybeCR.takeError();2391Val.push_back(MaybeCR.get());2392}2393i--;23942395if (!ConstantRangeList::isOrderedRanges(Val))2396return error("Invalid (unordered or overlapping) range list");2397B.addConstantRangeListAttr(Kind, Val);2398} else {2399return error("Invalid attribute group entry");2400}2401}24022403if (ME != MemoryEffects::unknown())2404B.addMemoryAttr(ME);24052406UpgradeAttributes(B);2407MAttributeGroups[GrpID] = AttributeList::get(Context, Idx, B);2408break;2409}2410}2411}2412}24132414Error BitcodeReader::parseTypeTable() {2415if (Error Err = Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))2416return Err;24172418return parseTypeTableBody();2419}24202421Error BitcodeReader::parseTypeTableBody() {2422if (!TypeList.empty())2423return error("Invalid multiple blocks");24242425SmallVector<uint64_t, 64> Record;2426unsigned NumRecords = 0;24272428SmallString<64> TypeName;24292430// Read all the records for this type table.2431while (true) {2432Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();2433if (!MaybeEntry)2434return MaybeEntry.takeError();2435BitstreamEntry Entry = MaybeEntry.get();24362437switch (Entry.Kind) {2438case BitstreamEntry::SubBlock: // Handled for us already.2439case BitstreamEntry::Error:2440return error("Malformed block");2441case BitstreamEntry::EndBlock:2442if (NumRecords != TypeList.size())2443return error("Malformed block");2444return Error::success();2445case BitstreamEntry::Record:2446// The interesting case.2447break;2448}24492450// Read a record.2451Record.clear();2452Type *ResultTy = nullptr;2453SmallVector<unsigned> ContainedIDs;2454Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);2455if (!MaybeRecord)2456return MaybeRecord.takeError();2457switch (MaybeRecord.get()) {2458default:2459return error("Invalid value");2460case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]2461// TYPE_CODE_NUMENTRY contains a count of the number of types in the2462// type list. This allows us to reserve space.2463if (Record.empty())2464return error("Invalid numentry record");2465TypeList.resize(Record[0]);2466continue;2467case bitc::TYPE_CODE_VOID: // VOID2468ResultTy = Type::getVoidTy(Context);2469break;2470case bitc::TYPE_CODE_HALF: // HALF2471ResultTy = Type::getHalfTy(Context);2472break;2473case bitc::TYPE_CODE_BFLOAT: // BFLOAT2474ResultTy = Type::getBFloatTy(Context);2475break;2476case bitc::TYPE_CODE_FLOAT: // FLOAT2477ResultTy = Type::getFloatTy(Context);2478break;2479case bitc::TYPE_CODE_DOUBLE: // DOUBLE2480ResultTy = Type::getDoubleTy(Context);2481break;2482case bitc::TYPE_CODE_X86_FP80: // X86_FP802483ResultTy = Type::getX86_FP80Ty(Context);2484break;2485case bitc::TYPE_CODE_FP128: // FP1282486ResultTy = Type::getFP128Ty(Context);2487break;2488case bitc::TYPE_CODE_PPC_FP128: // PPC_FP1282489ResultTy = Type::getPPC_FP128Ty(Context);2490break;2491case bitc::TYPE_CODE_LABEL: // LABEL2492ResultTy = Type::getLabelTy(Context);2493break;2494case bitc::TYPE_CODE_METADATA: // METADATA2495ResultTy = Type::getMetadataTy(Context);2496break;2497case bitc::TYPE_CODE_X86_MMX: // X86_MMX2498ResultTy = Type::getX86_MMXTy(Context);2499break;2500case bitc::TYPE_CODE_X86_AMX: // X86_AMX2501ResultTy = Type::getX86_AMXTy(Context);2502break;2503case bitc::TYPE_CODE_TOKEN: // TOKEN2504ResultTy = Type::getTokenTy(Context);2505break;2506case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]2507if (Record.empty())2508return error("Invalid integer record");25092510uint64_t NumBits = Record[0];2511if (NumBits < IntegerType::MIN_INT_BITS ||2512NumBits > IntegerType::MAX_INT_BITS)2513return error("Bitwidth for integer type out of range");2514ResultTy = IntegerType::get(Context, NumBits);2515break;2516}2517case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or2518// [pointee type, address space]2519if (Record.empty())2520return error("Invalid pointer record");2521unsigned AddressSpace = 0;2522if (Record.size() == 2)2523AddressSpace = Record[1];2524ResultTy = getTypeByID(Record[0]);2525if (!ResultTy ||2526!PointerType::isValidElementType(ResultTy))2527return error("Invalid type");2528ContainedIDs.push_back(Record[0]);2529ResultTy = PointerType::get(ResultTy, AddressSpace);2530break;2531}2532case bitc::TYPE_CODE_OPAQUE_POINTER: { // OPAQUE_POINTER: [addrspace]2533if (Record.size() != 1)2534return error("Invalid opaque pointer record");2535unsigned AddressSpace = Record[0];2536ResultTy = PointerType::get(Context, AddressSpace);2537break;2538}2539case bitc::TYPE_CODE_FUNCTION_OLD: {2540// Deprecated, but still needed to read old bitcode files.2541// FUNCTION: [vararg, attrid, retty, paramty x N]2542if (Record.size() < 3)2543return error("Invalid function record");2544SmallVector<Type*, 8> ArgTys;2545for (unsigned i = 3, e = Record.size(); i != e; ++i) {2546if (Type *T = getTypeByID(Record[i]))2547ArgTys.push_back(T);2548else2549break;2550}25512552ResultTy = getTypeByID(Record[2]);2553if (!ResultTy || ArgTys.size() < Record.size()-3)2554return error("Invalid type");25552556ContainedIDs.append(Record.begin() + 2, Record.end());2557ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);2558break;2559}2560case bitc::TYPE_CODE_FUNCTION: {2561// FUNCTION: [vararg, retty, paramty x N]2562if (Record.size() < 2)2563return error("Invalid function record");2564SmallVector<Type*, 8> ArgTys;2565for (unsigned i = 2, e = Record.size(); i != e; ++i) {2566if (Type *T = getTypeByID(Record[i])) {2567if (!FunctionType::isValidArgumentType(T))2568return error("Invalid function argument type");2569ArgTys.push_back(T);2570}2571else2572break;2573}25742575ResultTy = getTypeByID(Record[1]);2576if (!ResultTy || ArgTys.size() < Record.size()-2)2577return error("Invalid type");25782579ContainedIDs.append(Record.begin() + 1, Record.end());2580ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);2581break;2582}2583case bitc::TYPE_CODE_STRUCT_ANON: { // STRUCT: [ispacked, eltty x N]2584if (Record.empty())2585return error("Invalid anon struct record");2586SmallVector<Type*, 8> EltTys;2587for (unsigned i = 1, e = Record.size(); i != e; ++i) {2588if (Type *T = getTypeByID(Record[i]))2589EltTys.push_back(T);2590else2591break;2592}2593if (EltTys.size() != Record.size()-1)2594return error("Invalid type");2595ContainedIDs.append(Record.begin() + 1, Record.end());2596ResultTy = StructType::get(Context, EltTys, Record[0]);2597break;2598}2599case bitc::TYPE_CODE_STRUCT_NAME: // STRUCT_NAME: [strchr x N]2600if (convertToString(Record, 0, TypeName))2601return error("Invalid struct name record");2602continue;26032604case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]2605if (Record.empty())2606return error("Invalid named struct record");26072608if (NumRecords >= TypeList.size())2609return error("Invalid TYPE table");26102611// Check to see if this was forward referenced, if so fill in the temp.2612StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);2613if (Res) {2614Res->setName(TypeName);2615TypeList[NumRecords] = nullptr;2616} else // Otherwise, create a new struct.2617Res = createIdentifiedStructType(Context, TypeName);2618TypeName.clear();26192620SmallVector<Type*, 8> EltTys;2621for (unsigned i = 1, e = Record.size(); i != e; ++i) {2622if (Type *T = getTypeByID(Record[i]))2623EltTys.push_back(T);2624else2625break;2626}2627if (EltTys.size() != Record.size()-1)2628return error("Invalid named struct record");2629Res->setBody(EltTys, Record[0]);2630ContainedIDs.append(Record.begin() + 1, Record.end());2631ResultTy = Res;2632break;2633}2634case bitc::TYPE_CODE_OPAQUE: { // OPAQUE: []2635if (Record.size() != 1)2636return error("Invalid opaque type record");26372638if (NumRecords >= TypeList.size())2639return error("Invalid TYPE table");26402641// Check to see if this was forward referenced, if so fill in the temp.2642StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);2643if (Res) {2644Res->setName(TypeName);2645TypeList[NumRecords] = nullptr;2646} else // Otherwise, create a new struct with no body.2647Res = createIdentifiedStructType(Context, TypeName);2648TypeName.clear();2649ResultTy = Res;2650break;2651}2652case bitc::TYPE_CODE_TARGET_TYPE: { // TARGET_TYPE: [NumTy, Tys..., Ints...]2653if (Record.size() < 1)2654return error("Invalid target extension type record");26552656if (NumRecords >= TypeList.size())2657return error("Invalid TYPE table");26582659if (Record[0] >= Record.size())2660return error("Too many type parameters");26612662unsigned NumTys = Record[0];2663SmallVector<Type *, 4> TypeParams;2664SmallVector<unsigned, 8> IntParams;2665for (unsigned i = 0; i < NumTys; i++) {2666if (Type *T = getTypeByID(Record[i + 1]))2667TypeParams.push_back(T);2668else2669return error("Invalid type");2670}26712672for (unsigned i = NumTys + 1, e = Record.size(); i < e; i++) {2673if (Record[i] > UINT_MAX)2674return error("Integer parameter too large");2675IntParams.push_back(Record[i]);2676}2677ResultTy = TargetExtType::get(Context, TypeName, TypeParams, IntParams);2678TypeName.clear();2679break;2680}2681case bitc::TYPE_CODE_ARRAY: // ARRAY: [numelts, eltty]2682if (Record.size() < 2)2683return error("Invalid array type record");2684ResultTy = getTypeByID(Record[1]);2685if (!ResultTy || !ArrayType::isValidElementType(ResultTy))2686return error("Invalid type");2687ContainedIDs.push_back(Record[1]);2688ResultTy = ArrayType::get(ResultTy, Record[0]);2689break;2690case bitc::TYPE_CODE_VECTOR: // VECTOR: [numelts, eltty] or2691// [numelts, eltty, scalable]2692if (Record.size() < 2)2693return error("Invalid vector type record");2694if (Record[0] == 0)2695return error("Invalid vector length");2696ResultTy = getTypeByID(Record[1]);2697if (!ResultTy || !VectorType::isValidElementType(ResultTy))2698return error("Invalid type");2699bool Scalable = Record.size() > 2 ? Record[2] : false;2700ContainedIDs.push_back(Record[1]);2701ResultTy = VectorType::get(ResultTy, Record[0], Scalable);2702break;2703}27042705if (NumRecords >= TypeList.size())2706return error("Invalid TYPE table");2707if (TypeList[NumRecords])2708return error(2709"Invalid TYPE table: Only named structs can be forward referenced");2710assert(ResultTy && "Didn't read a type?");2711TypeList[NumRecords] = ResultTy;2712if (!ContainedIDs.empty())2713ContainedTypeIDs[NumRecords] = std::move(ContainedIDs);2714++NumRecords;2715}2716}27172718Error BitcodeReader::parseOperandBundleTags() {2719if (Error Err = Stream.EnterSubBlock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID))2720return Err;27212722if (!BundleTags.empty())2723return error("Invalid multiple blocks");27242725SmallVector<uint64_t, 64> Record;27262727while (true) {2728Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();2729if (!MaybeEntry)2730return MaybeEntry.takeError();2731BitstreamEntry Entry = MaybeEntry.get();27322733switch (Entry.Kind) {2734case BitstreamEntry::SubBlock: // Handled for us already.2735case BitstreamEntry::Error:2736return error("Malformed block");2737case BitstreamEntry::EndBlock:2738return Error::success();2739case BitstreamEntry::Record:2740// The interesting case.2741break;2742}27432744// Tags are implicitly mapped to integers by their order.27452746Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);2747if (!MaybeRecord)2748return MaybeRecord.takeError();2749if (MaybeRecord.get() != bitc::OPERAND_BUNDLE_TAG)2750return error("Invalid operand bundle record");27512752// OPERAND_BUNDLE_TAG: [strchr x N]2753BundleTags.emplace_back();2754if (convertToString(Record, 0, BundleTags.back()))2755return error("Invalid operand bundle record");2756Record.clear();2757}2758}27592760Error BitcodeReader::parseSyncScopeNames() {2761if (Error Err = Stream.EnterSubBlock(bitc::SYNC_SCOPE_NAMES_BLOCK_ID))2762return Err;27632764if (!SSIDs.empty())2765return error("Invalid multiple synchronization scope names blocks");27662767SmallVector<uint64_t, 64> Record;2768while (true) {2769Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();2770if (!MaybeEntry)2771return MaybeEntry.takeError();2772BitstreamEntry Entry = MaybeEntry.get();27732774switch (Entry.Kind) {2775case BitstreamEntry::SubBlock: // Handled for us already.2776case BitstreamEntry::Error:2777return error("Malformed block");2778case BitstreamEntry::EndBlock:2779if (SSIDs.empty())2780return error("Invalid empty synchronization scope names block");2781return Error::success();2782case BitstreamEntry::Record:2783// The interesting case.2784break;2785}27862787// Synchronization scope names are implicitly mapped to synchronization2788// scope IDs by their order.27892790Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);2791if (!MaybeRecord)2792return MaybeRecord.takeError();2793if (MaybeRecord.get() != bitc::SYNC_SCOPE_NAME)2794return error("Invalid sync scope record");27952796SmallString<16> SSN;2797if (convertToString(Record, 0, SSN))2798return error("Invalid sync scope record");27992800SSIDs.push_back(Context.getOrInsertSyncScopeID(SSN));2801Record.clear();2802}2803}28042805/// Associate a value with its name from the given index in the provided record.2806Expected<Value *> BitcodeReader::recordValue(SmallVectorImpl<uint64_t> &Record,2807unsigned NameIndex, Triple &TT) {2808SmallString<128> ValueName;2809if (convertToString(Record, NameIndex, ValueName))2810return error("Invalid record");2811unsigned ValueID = Record[0];2812if (ValueID >= ValueList.size() || !ValueList[ValueID])2813return error("Invalid record");2814Value *V = ValueList[ValueID];28152816StringRef NameStr(ValueName.data(), ValueName.size());2817if (NameStr.contains(0))2818return error("Invalid value name");2819V->setName(NameStr);2820auto *GO = dyn_cast<GlobalObject>(V);2821if (GO && ImplicitComdatObjects.contains(GO) && TT.supportsCOMDAT())2822GO->setComdat(TheModule->getOrInsertComdat(V->getName()));2823return V;2824}28252826/// Helper to note and return the current location, and jump to the given2827/// offset.2828static Expected<uint64_t> jumpToValueSymbolTable(uint64_t Offset,2829BitstreamCursor &Stream) {2830// Save the current parsing location so we can jump back at the end2831// of the VST read.2832uint64_t CurrentBit = Stream.GetCurrentBitNo();2833if (Error JumpFailed = Stream.JumpToBit(Offset * 32))2834return std::move(JumpFailed);2835Expected<BitstreamEntry> MaybeEntry = Stream.advance();2836if (!MaybeEntry)2837return MaybeEntry.takeError();2838if (MaybeEntry.get().Kind != BitstreamEntry::SubBlock ||2839MaybeEntry.get().ID != bitc::VALUE_SYMTAB_BLOCK_ID)2840return error("Expected value symbol table subblock");2841return CurrentBit;2842}28432844void BitcodeReader::setDeferredFunctionInfo(unsigned FuncBitcodeOffsetDelta,2845Function *F,2846ArrayRef<uint64_t> Record) {2847// Note that we subtract 1 here because the offset is relative to one word2848// before the start of the identification or module block, which was2849// historically always the start of the regular bitcode header.2850uint64_t FuncWordOffset = Record[1] - 1;2851uint64_t FuncBitOffset = FuncWordOffset * 32;2852DeferredFunctionInfo[F] = FuncBitOffset + FuncBitcodeOffsetDelta;2853// Set the LastFunctionBlockBit to point to the last function block.2854// Later when parsing is resumed after function materialization,2855// we can simply skip that last function block.2856if (FuncBitOffset > LastFunctionBlockBit)2857LastFunctionBlockBit = FuncBitOffset;2858}28592860/// Read a new-style GlobalValue symbol table.2861Error BitcodeReader::parseGlobalValueSymbolTable() {2862unsigned FuncBitcodeOffsetDelta =2863Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;28642865if (Error Err = Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))2866return Err;28672868SmallVector<uint64_t, 64> Record;2869while (true) {2870Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();2871if (!MaybeEntry)2872return MaybeEntry.takeError();2873BitstreamEntry Entry = MaybeEntry.get();28742875switch (Entry.Kind) {2876case BitstreamEntry::SubBlock:2877case BitstreamEntry::Error:2878return error("Malformed block");2879case BitstreamEntry::EndBlock:2880return Error::success();2881case BitstreamEntry::Record:2882break;2883}28842885Record.clear();2886Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);2887if (!MaybeRecord)2888return MaybeRecord.takeError();2889switch (MaybeRecord.get()) {2890case bitc::VST_CODE_FNENTRY: { // [valueid, offset]2891unsigned ValueID = Record[0];2892if (ValueID >= ValueList.size() || !ValueList[ValueID])2893return error("Invalid value reference in symbol table");2894setDeferredFunctionInfo(FuncBitcodeOffsetDelta,2895cast<Function>(ValueList[ValueID]), Record);2896break;2897}2898}2899}2900}29012902/// Parse the value symbol table at either the current parsing location or2903/// at the given bit offset if provided.2904Error BitcodeReader::parseValueSymbolTable(uint64_t Offset) {2905uint64_t CurrentBit;2906// Pass in the Offset to distinguish between calling for the module-level2907// VST (where we want to jump to the VST offset) and the function-level2908// VST (where we don't).2909if (Offset > 0) {2910Expected<uint64_t> MaybeCurrentBit = jumpToValueSymbolTable(Offset, Stream);2911if (!MaybeCurrentBit)2912return MaybeCurrentBit.takeError();2913CurrentBit = MaybeCurrentBit.get();2914// If this module uses a string table, read this as a module-level VST.2915if (UseStrtab) {2916if (Error Err = parseGlobalValueSymbolTable())2917return Err;2918if (Error JumpFailed = Stream.JumpToBit(CurrentBit))2919return JumpFailed;2920return Error::success();2921}2922// Otherwise, the VST will be in a similar format to a function-level VST,2923// and will contain symbol names.2924}29252926// Compute the delta between the bitcode indices in the VST (the word offset2927// to the word-aligned ENTER_SUBBLOCK for the function block, and that2928// expected by the lazy reader. The reader's EnterSubBlock expects to have2929// already read the ENTER_SUBBLOCK code (size getAbbrevIDWidth) and BlockID2930// (size BlockIDWidth). Note that we access the stream's AbbrevID width here2931// just before entering the VST subblock because: 1) the EnterSubBlock2932// changes the AbbrevID width; 2) the VST block is nested within the same2933// outer MODULE_BLOCK as the FUNCTION_BLOCKs and therefore have the same2934// AbbrevID width before calling EnterSubBlock; and 3) when we want to2935// jump to the FUNCTION_BLOCK using this offset later, we don't want2936// to rely on the stream's AbbrevID width being that of the MODULE_BLOCK.2937unsigned FuncBitcodeOffsetDelta =2938Stream.getAbbrevIDWidth() + bitc::BlockIDWidth;29392940if (Error Err = Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))2941return Err;29422943SmallVector<uint64_t, 64> Record;29442945Triple TT(TheModule->getTargetTriple());29462947// Read all the records for this value table.2948SmallString<128> ValueName;29492950while (true) {2951Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();2952if (!MaybeEntry)2953return MaybeEntry.takeError();2954BitstreamEntry Entry = MaybeEntry.get();29552956switch (Entry.Kind) {2957case BitstreamEntry::SubBlock: // Handled for us already.2958case BitstreamEntry::Error:2959return error("Malformed block");2960case BitstreamEntry::EndBlock:2961if (Offset > 0)2962if (Error JumpFailed = Stream.JumpToBit(CurrentBit))2963return JumpFailed;2964return Error::success();2965case BitstreamEntry::Record:2966// The interesting case.2967break;2968}29692970// Read a record.2971Record.clear();2972Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);2973if (!MaybeRecord)2974return MaybeRecord.takeError();2975switch (MaybeRecord.get()) {2976default: // Default behavior: unknown type.2977break;2978case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]2979Expected<Value *> ValOrErr = recordValue(Record, 1, TT);2980if (Error Err = ValOrErr.takeError())2981return Err;2982ValOrErr.get();2983break;2984}2985case bitc::VST_CODE_FNENTRY: {2986// VST_CODE_FNENTRY: [valueid, offset, namechar x N]2987Expected<Value *> ValOrErr = recordValue(Record, 2, TT);2988if (Error Err = ValOrErr.takeError())2989return Err;2990Value *V = ValOrErr.get();29912992// Ignore function offsets emitted for aliases of functions in older2993// versions of LLVM.2994if (auto *F = dyn_cast<Function>(V))2995setDeferredFunctionInfo(FuncBitcodeOffsetDelta, F, Record);2996break;2997}2998case bitc::VST_CODE_BBENTRY: {2999if (convertToString(Record, 1, ValueName))3000return error("Invalid bbentry record");3001BasicBlock *BB = getBasicBlock(Record[0]);3002if (!BB)3003return error("Invalid bbentry record");30043005BB->setName(ValueName.str());3006ValueName.clear();3007break;3008}3009}3010}3011}30123013/// Decode a signed value stored with the sign bit in the LSB for dense VBR3014/// encoding.3015uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {3016if ((V & 1) == 0)3017return V >> 1;3018if (V != 1)3019return -(V >> 1);3020// There is no such thing as -0 with integers. "-0" really means MININT.3021return 1ULL << 63;3022}30233024/// Resolve all of the initializers for global values and aliases that we can.3025Error BitcodeReader::resolveGlobalAndIndirectSymbolInits() {3026std::vector<std::pair<GlobalVariable *, unsigned>> GlobalInitWorklist;3027std::vector<std::pair<GlobalValue *, unsigned>> IndirectSymbolInitWorklist;3028std::vector<FunctionOperandInfo> FunctionOperandWorklist;30293030GlobalInitWorklist.swap(GlobalInits);3031IndirectSymbolInitWorklist.swap(IndirectSymbolInits);3032FunctionOperandWorklist.swap(FunctionOperands);30333034while (!GlobalInitWorklist.empty()) {3035unsigned ValID = GlobalInitWorklist.back().second;3036if (ValID >= ValueList.size()) {3037// Not ready to resolve this yet, it requires something later in the file.3038GlobalInits.push_back(GlobalInitWorklist.back());3039} else {3040Expected<Constant *> MaybeC = getValueForInitializer(ValID);3041if (!MaybeC)3042return MaybeC.takeError();3043GlobalInitWorklist.back().first->setInitializer(MaybeC.get());3044}3045GlobalInitWorklist.pop_back();3046}30473048while (!IndirectSymbolInitWorklist.empty()) {3049unsigned ValID = IndirectSymbolInitWorklist.back().second;3050if (ValID >= ValueList.size()) {3051IndirectSymbolInits.push_back(IndirectSymbolInitWorklist.back());3052} else {3053Expected<Constant *> MaybeC = getValueForInitializer(ValID);3054if (!MaybeC)3055return MaybeC.takeError();3056Constant *C = MaybeC.get();3057GlobalValue *GV = IndirectSymbolInitWorklist.back().first;3058if (auto *GA = dyn_cast<GlobalAlias>(GV)) {3059if (C->getType() != GV->getType())3060return error("Alias and aliasee types don't match");3061GA->setAliasee(C);3062} else if (auto *GI = dyn_cast<GlobalIFunc>(GV)) {3063GI->setResolver(C);3064} else {3065return error("Expected an alias or an ifunc");3066}3067}3068IndirectSymbolInitWorklist.pop_back();3069}30703071while (!FunctionOperandWorklist.empty()) {3072FunctionOperandInfo &Info = FunctionOperandWorklist.back();3073if (Info.PersonalityFn) {3074unsigned ValID = Info.PersonalityFn - 1;3075if (ValID < ValueList.size()) {3076Expected<Constant *> MaybeC = getValueForInitializer(ValID);3077if (!MaybeC)3078return MaybeC.takeError();3079Info.F->setPersonalityFn(MaybeC.get());3080Info.PersonalityFn = 0;3081}3082}3083if (Info.Prefix) {3084unsigned ValID = Info.Prefix - 1;3085if (ValID < ValueList.size()) {3086Expected<Constant *> MaybeC = getValueForInitializer(ValID);3087if (!MaybeC)3088return MaybeC.takeError();3089Info.F->setPrefixData(MaybeC.get());3090Info.Prefix = 0;3091}3092}3093if (Info.Prologue) {3094unsigned ValID = Info.Prologue - 1;3095if (ValID < ValueList.size()) {3096Expected<Constant *> MaybeC = getValueForInitializer(ValID);3097if (!MaybeC)3098return MaybeC.takeError();3099Info.F->setPrologueData(MaybeC.get());3100Info.Prologue = 0;3101}3102}3103if (Info.PersonalityFn || Info.Prefix || Info.Prologue)3104FunctionOperands.push_back(Info);3105FunctionOperandWorklist.pop_back();3106}31073108return Error::success();3109}31103111APInt llvm::readWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {3112SmallVector<uint64_t, 8> Words(Vals.size());3113transform(Vals, Words.begin(),3114BitcodeReader::decodeSignRotatedValue);31153116return APInt(TypeBits, Words);3117}31183119Error BitcodeReader::parseConstants() {3120if (Error Err = Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))3121return Err;31223123SmallVector<uint64_t, 64> Record;31243125// Read all the records for this value table.3126Type *CurTy = Type::getInt32Ty(Context);3127unsigned Int32TyID = getVirtualTypeID(CurTy);3128unsigned CurTyID = Int32TyID;3129Type *CurElemTy = nullptr;3130unsigned NextCstNo = ValueList.size();31313132while (true) {3133Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();3134if (!MaybeEntry)3135return MaybeEntry.takeError();3136BitstreamEntry Entry = MaybeEntry.get();31373138switch (Entry.Kind) {3139case BitstreamEntry::SubBlock: // Handled for us already.3140case BitstreamEntry::Error:3141return error("Malformed block");3142case BitstreamEntry::EndBlock:3143if (NextCstNo != ValueList.size())3144return error("Invalid constant reference");3145return Error::success();3146case BitstreamEntry::Record:3147// The interesting case.3148break;3149}31503151// Read a record.3152Record.clear();3153Type *VoidType = Type::getVoidTy(Context);3154Value *V = nullptr;3155Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);3156if (!MaybeBitCode)3157return MaybeBitCode.takeError();3158switch (unsigned BitCode = MaybeBitCode.get()) {3159default: // Default behavior: unknown constant3160case bitc::CST_CODE_UNDEF: // UNDEF3161V = UndefValue::get(CurTy);3162break;3163case bitc::CST_CODE_POISON: // POISON3164V = PoisonValue::get(CurTy);3165break;3166case bitc::CST_CODE_SETTYPE: // SETTYPE: [typeid]3167if (Record.empty())3168return error("Invalid settype record");3169if (Record[0] >= TypeList.size() || !TypeList[Record[0]])3170return error("Invalid settype record");3171if (TypeList[Record[0]] == VoidType)3172return error("Invalid constant type");3173CurTyID = Record[0];3174CurTy = TypeList[CurTyID];3175CurElemTy = getPtrElementTypeByID(CurTyID);3176continue; // Skip the ValueList manipulation.3177case bitc::CST_CODE_NULL: // NULL3178if (CurTy->isVoidTy() || CurTy->isFunctionTy() || CurTy->isLabelTy())3179return error("Invalid type for a constant null value");3180if (auto *TETy = dyn_cast<TargetExtType>(CurTy))3181if (!TETy->hasProperty(TargetExtType::HasZeroInit))3182return error("Invalid type for a constant null value");3183V = Constant::getNullValue(CurTy);3184break;3185case bitc::CST_CODE_INTEGER: // INTEGER: [intval]3186if (!CurTy->isIntOrIntVectorTy() || Record.empty())3187return error("Invalid integer const record");3188V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));3189break;3190case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]3191if (!CurTy->isIntOrIntVectorTy() || Record.empty())3192return error("Invalid wide integer const record");31933194auto *ScalarTy = cast<IntegerType>(CurTy->getScalarType());3195APInt VInt = readWideAPInt(Record, ScalarTy->getBitWidth());3196V = ConstantInt::get(CurTy, VInt);3197break;3198}3199case bitc::CST_CODE_FLOAT: { // FLOAT: [fpval]3200if (Record.empty())3201return error("Invalid float const record");32023203auto *ScalarTy = CurTy->getScalarType();3204if (ScalarTy->isHalfTy())3205V = ConstantFP::get(CurTy, APFloat(APFloat::IEEEhalf(),3206APInt(16, (uint16_t)Record[0])));3207else if (ScalarTy->isBFloatTy())3208V = ConstantFP::get(3209CurTy, APFloat(APFloat::BFloat(), APInt(16, (uint32_t)Record[0])));3210else if (ScalarTy->isFloatTy())3211V = ConstantFP::get(CurTy, APFloat(APFloat::IEEEsingle(),3212APInt(32, (uint32_t)Record[0])));3213else if (ScalarTy->isDoubleTy())3214V = ConstantFP::get(3215CurTy, APFloat(APFloat::IEEEdouble(), APInt(64, Record[0])));3216else if (ScalarTy->isX86_FP80Ty()) {3217// Bits are not stored the same way as a normal i80 APInt, compensate.3218uint64_t Rearrange[2];3219Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);3220Rearrange[1] = Record[0] >> 48;3221V = ConstantFP::get(3222CurTy, APFloat(APFloat::x87DoubleExtended(), APInt(80, Rearrange)));3223} else if (ScalarTy->isFP128Ty())3224V = ConstantFP::get(CurTy,3225APFloat(APFloat::IEEEquad(), APInt(128, Record)));3226else if (ScalarTy->isPPC_FP128Ty())3227V = ConstantFP::get(3228CurTy, APFloat(APFloat::PPCDoubleDouble(), APInt(128, Record)));3229else3230V = PoisonValue::get(CurTy);3231break;3232}32333234case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]3235if (Record.empty())3236return error("Invalid aggregate record");32373238unsigned Size = Record.size();3239SmallVector<unsigned, 16> Elts;3240for (unsigned i = 0; i != Size; ++i)3241Elts.push_back(Record[i]);32423243if (isa<StructType>(CurTy)) {3244V = BitcodeConstant::create(3245Alloc, CurTy, BitcodeConstant::ConstantStructOpcode, Elts);3246} else if (isa<ArrayType>(CurTy)) {3247V = BitcodeConstant::create(Alloc, CurTy,3248BitcodeConstant::ConstantArrayOpcode, Elts);3249} else if (isa<VectorType>(CurTy)) {3250V = BitcodeConstant::create(3251Alloc, CurTy, BitcodeConstant::ConstantVectorOpcode, Elts);3252} else {3253V = PoisonValue::get(CurTy);3254}3255break;3256}3257case bitc::CST_CODE_STRING: // STRING: [values]3258case bitc::CST_CODE_CSTRING: { // CSTRING: [values]3259if (Record.empty())3260return error("Invalid string record");32613262SmallString<16> Elts(Record.begin(), Record.end());3263V = ConstantDataArray::getString(Context, Elts,3264BitCode == bitc::CST_CODE_CSTRING);3265break;3266}3267case bitc::CST_CODE_DATA: {// DATA: [n x value]3268if (Record.empty())3269return error("Invalid data record");32703271Type *EltTy;3272if (auto *Array = dyn_cast<ArrayType>(CurTy))3273EltTy = Array->getElementType();3274else3275EltTy = cast<VectorType>(CurTy)->getElementType();3276if (EltTy->isIntegerTy(8)) {3277SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());3278if (isa<VectorType>(CurTy))3279V = ConstantDataVector::get(Context, Elts);3280else3281V = ConstantDataArray::get(Context, Elts);3282} else if (EltTy->isIntegerTy(16)) {3283SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());3284if (isa<VectorType>(CurTy))3285V = ConstantDataVector::get(Context, Elts);3286else3287V = ConstantDataArray::get(Context, Elts);3288} else if (EltTy->isIntegerTy(32)) {3289SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());3290if (isa<VectorType>(CurTy))3291V = ConstantDataVector::get(Context, Elts);3292else3293V = ConstantDataArray::get(Context, Elts);3294} else if (EltTy->isIntegerTy(64)) {3295SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());3296if (isa<VectorType>(CurTy))3297V = ConstantDataVector::get(Context, Elts);3298else3299V = ConstantDataArray::get(Context, Elts);3300} else if (EltTy->isHalfTy()) {3301SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());3302if (isa<VectorType>(CurTy))3303V = ConstantDataVector::getFP(EltTy, Elts);3304else3305V = ConstantDataArray::getFP(EltTy, Elts);3306} else if (EltTy->isBFloatTy()) {3307SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());3308if (isa<VectorType>(CurTy))3309V = ConstantDataVector::getFP(EltTy, Elts);3310else3311V = ConstantDataArray::getFP(EltTy, Elts);3312} else if (EltTy->isFloatTy()) {3313SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());3314if (isa<VectorType>(CurTy))3315V = ConstantDataVector::getFP(EltTy, Elts);3316else3317V = ConstantDataArray::getFP(EltTy, Elts);3318} else if (EltTy->isDoubleTy()) {3319SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());3320if (isa<VectorType>(CurTy))3321V = ConstantDataVector::getFP(EltTy, Elts);3322else3323V = ConstantDataArray::getFP(EltTy, Elts);3324} else {3325return error("Invalid type for value");3326}3327break;3328}3329case bitc::CST_CODE_CE_UNOP: { // CE_UNOP: [opcode, opval]3330if (Record.size() < 2)3331return error("Invalid unary op constexpr record");3332int Opc = getDecodedUnaryOpcode(Record[0], CurTy);3333if (Opc < 0) {3334V = PoisonValue::get(CurTy); // Unknown unop.3335} else {3336V = BitcodeConstant::create(Alloc, CurTy, Opc, (unsigned)Record[1]);3337}3338break;3339}3340case bitc::CST_CODE_CE_BINOP: { // CE_BINOP: [opcode, opval, opval]3341if (Record.size() < 3)3342return error("Invalid binary op constexpr record");3343int Opc = getDecodedBinaryOpcode(Record[0], CurTy);3344if (Opc < 0) {3345V = PoisonValue::get(CurTy); // Unknown binop.3346} else {3347uint8_t Flags = 0;3348if (Record.size() >= 4) {3349if (Opc == Instruction::Add ||3350Opc == Instruction::Sub ||3351Opc == Instruction::Mul ||3352Opc == Instruction::Shl) {3353if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))3354Flags |= OverflowingBinaryOperator::NoSignedWrap;3355if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))3356Flags |= OverflowingBinaryOperator::NoUnsignedWrap;3357} else if (Opc == Instruction::SDiv ||3358Opc == Instruction::UDiv ||3359Opc == Instruction::LShr ||3360Opc == Instruction::AShr) {3361if (Record[3] & (1 << bitc::PEO_EXACT))3362Flags |= PossiblyExactOperator::IsExact;3363}3364}3365V = BitcodeConstant::create(Alloc, CurTy, {(uint8_t)Opc, Flags},3366{(unsigned)Record[1], (unsigned)Record[2]});3367}3368break;3369}3370case bitc::CST_CODE_CE_CAST: { // CE_CAST: [opcode, opty, opval]3371if (Record.size() < 3)3372return error("Invalid cast constexpr record");3373int Opc = getDecodedCastOpcode(Record[0]);3374if (Opc < 0) {3375V = PoisonValue::get(CurTy); // Unknown cast.3376} else {3377unsigned OpTyID = Record[1];3378Type *OpTy = getTypeByID(OpTyID);3379if (!OpTy)3380return error("Invalid cast constexpr record");3381V = BitcodeConstant::create(Alloc, CurTy, Opc, (unsigned)Record[2]);3382}3383break;3384}3385case bitc::CST_CODE_CE_INBOUNDS_GEP: // [ty, n x operands]3386case bitc::CST_CODE_CE_GEP_OLD: // [ty, n x operands]3387case bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX_OLD: // [ty, flags, n x3388// operands]3389case bitc::CST_CODE_CE_GEP: // [ty, flags, n x operands]3390case bitc::CST_CODE_CE_GEP_WITH_INRANGE: { // [ty, flags, start, end, n x3391// operands]3392if (Record.size() < 2)3393return error("Constant GEP record must have at least two elements");3394unsigned OpNum = 0;3395Type *PointeeType = nullptr;3396if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX_OLD ||3397BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE ||3398BitCode == bitc::CST_CODE_CE_GEP || Record.size() % 2)3399PointeeType = getTypeByID(Record[OpNum++]);34003401uint64_t Flags = 0;3402std::optional<ConstantRange> InRange;3403if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX_OLD) {3404uint64_t Op = Record[OpNum++];3405Flags = Op & 1; // inbounds3406unsigned InRangeIndex = Op >> 1;3407// "Upgrade" inrange by dropping it. The feature is too niche to3408// bother.3409(void)InRangeIndex;3410} else if (BitCode == bitc::CST_CODE_CE_GEP_WITH_INRANGE) {3411Flags = Record[OpNum++];3412Expected<ConstantRange> MaybeInRange =3413readBitWidthAndConstantRange(Record, OpNum);3414if (!MaybeInRange)3415return MaybeInRange.takeError();3416InRange = MaybeInRange.get();3417} else if (BitCode == bitc::CST_CODE_CE_GEP) {3418Flags = Record[OpNum++];3419} else if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)3420Flags = (1 << bitc::GEP_INBOUNDS);34213422SmallVector<unsigned, 16> Elts;3423unsigned BaseTypeID = Record[OpNum];3424while (OpNum != Record.size()) {3425unsigned ElTyID = Record[OpNum++];3426Type *ElTy = getTypeByID(ElTyID);3427if (!ElTy)3428return error("Invalid getelementptr constexpr record");3429Elts.push_back(Record[OpNum++]);3430}34313432if (Elts.size() < 1)3433return error("Invalid gep with no operands");34343435Type *BaseType = getTypeByID(BaseTypeID);3436if (isa<VectorType>(BaseType)) {3437BaseTypeID = getContainedTypeID(BaseTypeID, 0);3438BaseType = getTypeByID(BaseTypeID);3439}34403441PointerType *OrigPtrTy = dyn_cast_or_null<PointerType>(BaseType);3442if (!OrigPtrTy)3443return error("GEP base operand must be pointer or vector of pointer");34443445if (!PointeeType) {3446PointeeType = getPtrElementTypeByID(BaseTypeID);3447if (!PointeeType)3448return error("Missing element type for old-style constant GEP");3449}34503451V = BitcodeConstant::create(3452Alloc, CurTy,3453{Instruction::GetElementPtr, uint8_t(Flags), PointeeType, InRange},3454Elts);3455break;3456}3457case bitc::CST_CODE_CE_SELECT: { // CE_SELECT: [opval#, opval#, opval#]3458if (Record.size() < 3)3459return error("Invalid select constexpr record");34603461V = BitcodeConstant::create(3462Alloc, CurTy, Instruction::Select,3463{(unsigned)Record[0], (unsigned)Record[1], (unsigned)Record[2]});3464break;3465}3466case bitc::CST_CODE_CE_EXTRACTELT3467: { // CE_EXTRACTELT: [opty, opval, opty, opval]3468if (Record.size() < 3)3469return error("Invalid extractelement constexpr record");3470unsigned OpTyID = Record[0];3471VectorType *OpTy =3472dyn_cast_or_null<VectorType>(getTypeByID(OpTyID));3473if (!OpTy)3474return error("Invalid extractelement constexpr record");3475unsigned IdxRecord;3476if (Record.size() == 4) {3477unsigned IdxTyID = Record[2];3478Type *IdxTy = getTypeByID(IdxTyID);3479if (!IdxTy)3480return error("Invalid extractelement constexpr record");3481IdxRecord = Record[3];3482} else {3483// Deprecated, but still needed to read old bitcode files.3484IdxRecord = Record[2];3485}3486V = BitcodeConstant::create(Alloc, CurTy, Instruction::ExtractElement,3487{(unsigned)Record[1], IdxRecord});3488break;3489}3490case bitc::CST_CODE_CE_INSERTELT3491: { // CE_INSERTELT: [opval, opval, opty, opval]3492VectorType *OpTy = dyn_cast<VectorType>(CurTy);3493if (Record.size() < 3 || !OpTy)3494return error("Invalid insertelement constexpr record");3495unsigned IdxRecord;3496if (Record.size() == 4) {3497unsigned IdxTyID = Record[2];3498Type *IdxTy = getTypeByID(IdxTyID);3499if (!IdxTy)3500return error("Invalid insertelement constexpr record");3501IdxRecord = Record[3];3502} else {3503// Deprecated, but still needed to read old bitcode files.3504IdxRecord = Record[2];3505}3506V = BitcodeConstant::create(3507Alloc, CurTy, Instruction::InsertElement,3508{(unsigned)Record[0], (unsigned)Record[1], IdxRecord});3509break;3510}3511case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]3512VectorType *OpTy = dyn_cast<VectorType>(CurTy);3513if (Record.size() < 3 || !OpTy)3514return error("Invalid shufflevector constexpr record");3515V = BitcodeConstant::create(3516Alloc, CurTy, Instruction::ShuffleVector,3517{(unsigned)Record[0], (unsigned)Record[1], (unsigned)Record[2]});3518break;3519}3520case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]3521VectorType *RTy = dyn_cast<VectorType>(CurTy);3522VectorType *OpTy =3523dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));3524if (Record.size() < 4 || !RTy || !OpTy)3525return error("Invalid shufflevector constexpr record");3526V = BitcodeConstant::create(3527Alloc, CurTy, Instruction::ShuffleVector,3528{(unsigned)Record[1], (unsigned)Record[2], (unsigned)Record[3]});3529break;3530}3531case bitc::CST_CODE_CE_CMP: { // CE_CMP: [opty, opval, opval, pred]3532if (Record.size() < 4)3533return error("Invalid cmp constexpt record");3534unsigned OpTyID = Record[0];3535Type *OpTy = getTypeByID(OpTyID);3536if (!OpTy)3537return error("Invalid cmp constexpr record");3538V = BitcodeConstant::create(3539Alloc, CurTy,3540{(uint8_t)(OpTy->isFPOrFPVectorTy() ? Instruction::FCmp3541: Instruction::ICmp),3542(uint8_t)Record[3]},3543{(unsigned)Record[1], (unsigned)Record[2]});3544break;3545}3546// This maintains backward compatibility, pre-asm dialect keywords.3547// Deprecated, but still needed to read old bitcode files.3548case bitc::CST_CODE_INLINEASM_OLD: {3549if (Record.size() < 2)3550return error("Invalid inlineasm record");3551std::string AsmStr, ConstrStr;3552bool HasSideEffects = Record[0] & 1;3553bool IsAlignStack = Record[0] >> 1;3554unsigned AsmStrSize = Record[1];3555if (2+AsmStrSize >= Record.size())3556return error("Invalid inlineasm record");3557unsigned ConstStrSize = Record[2+AsmStrSize];3558if (3+AsmStrSize+ConstStrSize > Record.size())3559return error("Invalid inlineasm record");35603561for (unsigned i = 0; i != AsmStrSize; ++i)3562AsmStr += (char)Record[2+i];3563for (unsigned i = 0; i != ConstStrSize; ++i)3564ConstrStr += (char)Record[3+AsmStrSize+i];3565UpgradeInlineAsmString(&AsmStr);3566if (!CurElemTy)3567return error("Missing element type for old-style inlineasm");3568V = InlineAsm::get(cast<FunctionType>(CurElemTy), AsmStr, ConstrStr,3569HasSideEffects, IsAlignStack);3570break;3571}3572// This version adds support for the asm dialect keywords (e.g.,3573// inteldialect).3574case bitc::CST_CODE_INLINEASM_OLD2: {3575if (Record.size() < 2)3576return error("Invalid inlineasm record");3577std::string AsmStr, ConstrStr;3578bool HasSideEffects = Record[0] & 1;3579bool IsAlignStack = (Record[0] >> 1) & 1;3580unsigned AsmDialect = Record[0] >> 2;3581unsigned AsmStrSize = Record[1];3582if (2+AsmStrSize >= Record.size())3583return error("Invalid inlineasm record");3584unsigned ConstStrSize = Record[2+AsmStrSize];3585if (3+AsmStrSize+ConstStrSize > Record.size())3586return error("Invalid inlineasm record");35873588for (unsigned i = 0; i != AsmStrSize; ++i)3589AsmStr += (char)Record[2+i];3590for (unsigned i = 0; i != ConstStrSize; ++i)3591ConstrStr += (char)Record[3+AsmStrSize+i];3592UpgradeInlineAsmString(&AsmStr);3593if (!CurElemTy)3594return error("Missing element type for old-style inlineasm");3595V = InlineAsm::get(cast<FunctionType>(CurElemTy), AsmStr, ConstrStr,3596HasSideEffects, IsAlignStack,3597InlineAsm::AsmDialect(AsmDialect));3598break;3599}3600// This version adds support for the unwind keyword.3601case bitc::CST_CODE_INLINEASM_OLD3: {3602if (Record.size() < 2)3603return error("Invalid inlineasm record");3604unsigned OpNum = 0;3605std::string AsmStr, ConstrStr;3606bool HasSideEffects = Record[OpNum] & 1;3607bool IsAlignStack = (Record[OpNum] >> 1) & 1;3608unsigned AsmDialect = (Record[OpNum] >> 2) & 1;3609bool CanThrow = (Record[OpNum] >> 3) & 1;3610++OpNum;3611unsigned AsmStrSize = Record[OpNum];3612++OpNum;3613if (OpNum + AsmStrSize >= Record.size())3614return error("Invalid inlineasm record");3615unsigned ConstStrSize = Record[OpNum + AsmStrSize];3616if (OpNum + 1 + AsmStrSize + ConstStrSize > Record.size())3617return error("Invalid inlineasm record");36183619for (unsigned i = 0; i != AsmStrSize; ++i)3620AsmStr += (char)Record[OpNum + i];3621++OpNum;3622for (unsigned i = 0; i != ConstStrSize; ++i)3623ConstrStr += (char)Record[OpNum + AsmStrSize + i];3624UpgradeInlineAsmString(&AsmStr);3625if (!CurElemTy)3626return error("Missing element type for old-style inlineasm");3627V = InlineAsm::get(cast<FunctionType>(CurElemTy), AsmStr, ConstrStr,3628HasSideEffects, IsAlignStack,3629InlineAsm::AsmDialect(AsmDialect), CanThrow);3630break;3631}3632// This version adds explicit function type.3633case bitc::CST_CODE_INLINEASM: {3634if (Record.size() < 3)3635return error("Invalid inlineasm record");3636unsigned OpNum = 0;3637auto *FnTy = dyn_cast_or_null<FunctionType>(getTypeByID(Record[OpNum]));3638++OpNum;3639if (!FnTy)3640return error("Invalid inlineasm record");3641std::string AsmStr, ConstrStr;3642bool HasSideEffects = Record[OpNum] & 1;3643bool IsAlignStack = (Record[OpNum] >> 1) & 1;3644unsigned AsmDialect = (Record[OpNum] >> 2) & 1;3645bool CanThrow = (Record[OpNum] >> 3) & 1;3646++OpNum;3647unsigned AsmStrSize = Record[OpNum];3648++OpNum;3649if (OpNum + AsmStrSize >= Record.size())3650return error("Invalid inlineasm record");3651unsigned ConstStrSize = Record[OpNum + AsmStrSize];3652if (OpNum + 1 + AsmStrSize + ConstStrSize > Record.size())3653return error("Invalid inlineasm record");36543655for (unsigned i = 0; i != AsmStrSize; ++i)3656AsmStr += (char)Record[OpNum + i];3657++OpNum;3658for (unsigned i = 0; i != ConstStrSize; ++i)3659ConstrStr += (char)Record[OpNum + AsmStrSize + i];3660UpgradeInlineAsmString(&AsmStr);3661V = InlineAsm::get(FnTy, AsmStr, ConstrStr, HasSideEffects, IsAlignStack,3662InlineAsm::AsmDialect(AsmDialect), CanThrow);3663break;3664}3665case bitc::CST_CODE_BLOCKADDRESS:{3666if (Record.size() < 3)3667return error("Invalid blockaddress record");3668unsigned FnTyID = Record[0];3669Type *FnTy = getTypeByID(FnTyID);3670if (!FnTy)3671return error("Invalid blockaddress record");3672V = BitcodeConstant::create(3673Alloc, CurTy,3674{BitcodeConstant::BlockAddressOpcode, 0, (unsigned)Record[2]},3675Record[1]);3676break;3677}3678case bitc::CST_CODE_DSO_LOCAL_EQUIVALENT: {3679if (Record.size() < 2)3680return error("Invalid dso_local record");3681unsigned GVTyID = Record[0];3682Type *GVTy = getTypeByID(GVTyID);3683if (!GVTy)3684return error("Invalid dso_local record");3685V = BitcodeConstant::create(3686Alloc, CurTy, BitcodeConstant::DSOLocalEquivalentOpcode, Record[1]);3687break;3688}3689case bitc::CST_CODE_NO_CFI_VALUE: {3690if (Record.size() < 2)3691return error("Invalid no_cfi record");3692unsigned GVTyID = Record[0];3693Type *GVTy = getTypeByID(GVTyID);3694if (!GVTy)3695return error("Invalid no_cfi record");3696V = BitcodeConstant::create(Alloc, CurTy, BitcodeConstant::NoCFIOpcode,3697Record[1]);3698break;3699}3700case bitc::CST_CODE_PTRAUTH: {3701if (Record.size() < 4)3702return error("Invalid ptrauth record");3703// Ptr, Key, Disc, AddrDisc3704V = BitcodeConstant::create(Alloc, CurTy,3705BitcodeConstant::ConstantPtrAuthOpcode,3706{(unsigned)Record[0], (unsigned)Record[1],3707(unsigned)Record[2], (unsigned)Record[3]});3708break;3709}3710}37113712assert(V->getType() == getTypeByID(CurTyID) && "Incorrect result type ID");3713if (Error Err = ValueList.assignValue(NextCstNo, V, CurTyID))3714return Err;3715++NextCstNo;3716}3717}37183719Error BitcodeReader::parseUseLists() {3720if (Error Err = Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))3721return Err;37223723// Read all the records.3724SmallVector<uint64_t, 64> Record;37253726while (true) {3727Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();3728if (!MaybeEntry)3729return MaybeEntry.takeError();3730BitstreamEntry Entry = MaybeEntry.get();37313732switch (Entry.Kind) {3733case BitstreamEntry::SubBlock: // Handled for us already.3734case BitstreamEntry::Error:3735return error("Malformed block");3736case BitstreamEntry::EndBlock:3737return Error::success();3738case BitstreamEntry::Record:3739// The interesting case.3740break;3741}37423743// Read a use list record.3744Record.clear();3745bool IsBB = false;3746Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);3747if (!MaybeRecord)3748return MaybeRecord.takeError();3749switch (MaybeRecord.get()) {3750default: // Default behavior: unknown type.3751break;3752case bitc::USELIST_CODE_BB:3753IsBB = true;3754[[fallthrough]];3755case bitc::USELIST_CODE_DEFAULT: {3756unsigned RecordLength = Record.size();3757if (RecordLength < 3)3758// Records should have at least an ID and two indexes.3759return error("Invalid record");3760unsigned ID = Record.pop_back_val();37613762Value *V;3763if (IsBB) {3764assert(ID < FunctionBBs.size() && "Basic block not found");3765V = FunctionBBs[ID];3766} else3767V = ValueList[ID];3768unsigned NumUses = 0;3769SmallDenseMap<const Use *, unsigned, 16> Order;3770for (const Use &U : V->materialized_uses()) {3771if (++NumUses > Record.size())3772break;3773Order[&U] = Record[NumUses - 1];3774}3775if (Order.size() != Record.size() || NumUses > Record.size())3776// Mismatches can happen if the functions are being materialized lazily3777// (out-of-order), or a value has been upgraded.3778break;37793780V->sortUseList([&](const Use &L, const Use &R) {3781return Order.lookup(&L) < Order.lookup(&R);3782});3783break;3784}3785}3786}3787}37883789/// When we see the block for metadata, remember where it is and then skip it.3790/// This lets us lazily deserialize the metadata.3791Error BitcodeReader::rememberAndSkipMetadata() {3792// Save the current stream state.3793uint64_t CurBit = Stream.GetCurrentBitNo();3794DeferredMetadataInfo.push_back(CurBit);37953796// Skip over the block for now.3797if (Error Err = Stream.SkipBlock())3798return Err;3799return Error::success();3800}38013802Error BitcodeReader::materializeMetadata() {3803for (uint64_t BitPos : DeferredMetadataInfo) {3804// Move the bit stream to the saved position.3805if (Error JumpFailed = Stream.JumpToBit(BitPos))3806return JumpFailed;3807if (Error Err = MDLoader->parseModuleMetadata())3808return Err;3809}38103811// Upgrade "Linker Options" module flag to "llvm.linker.options" module-level3812// metadata. Only upgrade if the new option doesn't exist to avoid upgrade3813// multiple times.3814if (!TheModule->getNamedMetadata("llvm.linker.options")) {3815if (Metadata *Val = TheModule->getModuleFlag("Linker Options")) {3816NamedMDNode *LinkerOpts =3817TheModule->getOrInsertNamedMetadata("llvm.linker.options");3818for (const MDOperand &MDOptions : cast<MDNode>(Val)->operands())3819LinkerOpts->addOperand(cast<MDNode>(MDOptions));3820}3821}38223823DeferredMetadataInfo.clear();3824return Error::success();3825}38263827void BitcodeReader::setStripDebugInfo() { StripDebugInfo = true; }38283829/// When we see the block for a function body, remember where it is and then3830/// skip it. This lets us lazily deserialize the functions.3831Error BitcodeReader::rememberAndSkipFunctionBody() {3832// Get the function we are talking about.3833if (FunctionsWithBodies.empty())3834return error("Insufficient function protos");38353836Function *Fn = FunctionsWithBodies.back();3837FunctionsWithBodies.pop_back();38383839// Save the current stream state.3840uint64_t CurBit = Stream.GetCurrentBitNo();3841assert(3842(DeferredFunctionInfo[Fn] == 0 || DeferredFunctionInfo[Fn] == CurBit) &&3843"Mismatch between VST and scanned function offsets");3844DeferredFunctionInfo[Fn] = CurBit;38453846// Skip over the function block for now.3847if (Error Err = Stream.SkipBlock())3848return Err;3849return Error::success();3850}38513852Error BitcodeReader::globalCleanup() {3853// Patch the initializers for globals and aliases up.3854if (Error Err = resolveGlobalAndIndirectSymbolInits())3855return Err;3856if (!GlobalInits.empty() || !IndirectSymbolInits.empty())3857return error("Malformed global initializer set");38583859// Look for intrinsic functions which need to be upgraded at some point3860// and functions that need to have their function attributes upgraded.3861for (Function &F : *TheModule) {3862MDLoader->upgradeDebugIntrinsics(F);3863Function *NewFn;3864// If PreserveInputDbgFormat=true, then we don't know whether we want3865// intrinsics or records, and we won't perform any conversions in either3866// case, so don't upgrade intrinsics to records.3867if (UpgradeIntrinsicFunction(3868&F, NewFn, PreserveInputDbgFormat != cl::boolOrDefault::BOU_TRUE))3869UpgradedIntrinsics[&F] = NewFn;3870// Look for functions that rely on old function attribute behavior.3871UpgradeFunctionAttributes(F);3872}38733874// Look for global variables which need to be renamed.3875std::vector<std::pair<GlobalVariable *, GlobalVariable *>> UpgradedVariables;3876for (GlobalVariable &GV : TheModule->globals())3877if (GlobalVariable *Upgraded = UpgradeGlobalVariable(&GV))3878UpgradedVariables.emplace_back(&GV, Upgraded);3879for (auto &Pair : UpgradedVariables) {3880Pair.first->eraseFromParent();3881TheModule->insertGlobalVariable(Pair.second);3882}38833884// Force deallocation of memory for these vectors to favor the client that3885// want lazy deserialization.3886std::vector<std::pair<GlobalVariable *, unsigned>>().swap(GlobalInits);3887std::vector<std::pair<GlobalValue *, unsigned>>().swap(IndirectSymbolInits);3888return Error::success();3889}38903891/// Support for lazy parsing of function bodies. This is required if we3892/// either have an old bitcode file without a VST forward declaration record,3893/// or if we have an anonymous function being materialized, since anonymous3894/// functions do not have a name and are therefore not in the VST.3895Error BitcodeReader::rememberAndSkipFunctionBodies() {3896if (Error JumpFailed = Stream.JumpToBit(NextUnreadBit))3897return JumpFailed;38983899if (Stream.AtEndOfStream())3900return error("Could not find function in stream");39013902if (!SeenFirstFunctionBody)3903return error("Trying to materialize functions before seeing function blocks");39043905// An old bitcode file with the symbol table at the end would have3906// finished the parse greedily.3907assert(SeenValueSymbolTable);39083909SmallVector<uint64_t, 64> Record;39103911while (true) {3912Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();3913if (!MaybeEntry)3914return MaybeEntry.takeError();3915llvm::BitstreamEntry Entry = MaybeEntry.get();39163917switch (Entry.Kind) {3918default:3919return error("Expect SubBlock");3920case BitstreamEntry::SubBlock:3921switch (Entry.ID) {3922default:3923return error("Expect function block");3924case bitc::FUNCTION_BLOCK_ID:3925if (Error Err = rememberAndSkipFunctionBody())3926return Err;3927NextUnreadBit = Stream.GetCurrentBitNo();3928return Error::success();3929}3930}3931}3932}39333934Error BitcodeReaderBase::readBlockInfo() {3935Expected<std::optional<BitstreamBlockInfo>> MaybeNewBlockInfo =3936Stream.ReadBlockInfoBlock();3937if (!MaybeNewBlockInfo)3938return MaybeNewBlockInfo.takeError();3939std::optional<BitstreamBlockInfo> NewBlockInfo =3940std::move(MaybeNewBlockInfo.get());3941if (!NewBlockInfo)3942return error("Malformed block");3943BlockInfo = std::move(*NewBlockInfo);3944return Error::success();3945}39463947Error BitcodeReader::parseComdatRecord(ArrayRef<uint64_t> Record) {3948// v1: [selection_kind, name]3949// v2: [strtab_offset, strtab_size, selection_kind]3950StringRef Name;3951std::tie(Name, Record) = readNameFromStrtab(Record);39523953if (Record.empty())3954return error("Invalid record");3955Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);3956std::string OldFormatName;3957if (!UseStrtab) {3958if (Record.size() < 2)3959return error("Invalid record");3960unsigned ComdatNameSize = Record[1];3961if (ComdatNameSize > Record.size() - 2)3962return error("Comdat name size too large");3963OldFormatName.reserve(ComdatNameSize);3964for (unsigned i = 0; i != ComdatNameSize; ++i)3965OldFormatName += (char)Record[2 + i];3966Name = OldFormatName;3967}3968Comdat *C = TheModule->getOrInsertComdat(Name);3969C->setSelectionKind(SK);3970ComdatList.push_back(C);3971return Error::success();3972}39733974static void inferDSOLocal(GlobalValue *GV) {3975// infer dso_local from linkage and visibility if it is not encoded.3976if (GV->hasLocalLinkage() ||3977(!GV->hasDefaultVisibility() && !GV->hasExternalWeakLinkage()))3978GV->setDSOLocal(true);3979}39803981GlobalValue::SanitizerMetadata deserializeSanitizerMetadata(unsigned V) {3982GlobalValue::SanitizerMetadata Meta;3983if (V & (1 << 0))3984Meta.NoAddress = true;3985if (V & (1 << 1))3986Meta.NoHWAddress = true;3987if (V & (1 << 2))3988Meta.Memtag = true;3989if (V & (1 << 3))3990Meta.IsDynInit = true;3991return Meta;3992}39933994Error BitcodeReader::parseGlobalVarRecord(ArrayRef<uint64_t> Record) {3995// v1: [pointer type, isconst, initid, linkage, alignment, section,3996// visibility, threadlocal, unnamed_addr, externally_initialized,3997// dllstorageclass, comdat, attributes, preemption specifier,3998// partition strtab offset, partition strtab size] (name in VST)3999// v2: [strtab_offset, strtab_size, v1]4000// v3: [v2, code_model]4001StringRef Name;4002std::tie(Name, Record) = readNameFromStrtab(Record);40034004if (Record.size() < 6)4005return error("Invalid record");4006unsigned TyID = Record[0];4007Type *Ty = getTypeByID(TyID);4008if (!Ty)4009return error("Invalid record");4010bool isConstant = Record[1] & 1;4011bool explicitType = Record[1] & 2;4012unsigned AddressSpace;4013if (explicitType) {4014AddressSpace = Record[1] >> 2;4015} else {4016if (!Ty->isPointerTy())4017return error("Invalid type for value");4018AddressSpace = cast<PointerType>(Ty)->getAddressSpace();4019TyID = getContainedTypeID(TyID);4020Ty = getTypeByID(TyID);4021if (!Ty)4022return error("Missing element type for old-style global");4023}40244025uint64_t RawLinkage = Record[3];4026GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);4027MaybeAlign Alignment;4028if (Error Err = parseAlignmentValue(Record[4], Alignment))4029return Err;4030std::string Section;4031if (Record[5]) {4032if (Record[5] - 1 >= SectionTable.size())4033return error("Invalid ID");4034Section = SectionTable[Record[5] - 1];4035}4036GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;4037// Local linkage must have default visibility.4038// auto-upgrade `hidden` and `protected` for old bitcode.4039if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))4040Visibility = getDecodedVisibility(Record[6]);40414042GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;4043if (Record.size() > 7)4044TLM = getDecodedThreadLocalMode(Record[7]);40454046GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;4047if (Record.size() > 8)4048UnnamedAddr = getDecodedUnnamedAddrType(Record[8]);40494050bool ExternallyInitialized = false;4051if (Record.size() > 9)4052ExternallyInitialized = Record[9];40534054GlobalVariable *NewGV =4055new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, Name,4056nullptr, TLM, AddressSpace, ExternallyInitialized);4057if (Alignment)4058NewGV->setAlignment(*Alignment);4059if (!Section.empty())4060NewGV->setSection(Section);4061NewGV->setVisibility(Visibility);4062NewGV->setUnnamedAddr(UnnamedAddr);40634064if (Record.size() > 10) {4065// A GlobalValue with local linkage cannot have a DLL storage class.4066if (!NewGV->hasLocalLinkage()) {4067NewGV->setDLLStorageClass(getDecodedDLLStorageClass(Record[10]));4068}4069} else {4070upgradeDLLImportExportLinkage(NewGV, RawLinkage);4071}40724073ValueList.push_back(NewGV, getVirtualTypeID(NewGV->getType(), TyID));40744075// Remember which value to use for the global initializer.4076if (unsigned InitID = Record[2])4077GlobalInits.push_back(std::make_pair(NewGV, InitID - 1));40784079if (Record.size() > 11) {4080if (unsigned ComdatID = Record[11]) {4081if (ComdatID > ComdatList.size())4082return error("Invalid global variable comdat ID");4083NewGV->setComdat(ComdatList[ComdatID - 1]);4084}4085} else if (hasImplicitComdat(RawLinkage)) {4086ImplicitComdatObjects.insert(NewGV);4087}40884089if (Record.size() > 12) {4090auto AS = getAttributes(Record[12]).getFnAttrs();4091NewGV->setAttributes(AS);4092}40934094if (Record.size() > 13) {4095NewGV->setDSOLocal(getDecodedDSOLocal(Record[13]));4096}4097inferDSOLocal(NewGV);40984099// Check whether we have enough values to read a partition name.4100if (Record.size() > 15)4101NewGV->setPartition(StringRef(Strtab.data() + Record[14], Record[15]));41024103if (Record.size() > 16 && Record[16]) {4104llvm::GlobalValue::SanitizerMetadata Meta =4105deserializeSanitizerMetadata(Record[16]);4106NewGV->setSanitizerMetadata(Meta);4107}41084109if (Record.size() > 17 && Record[17]) {4110if (auto CM = getDecodedCodeModel(Record[17]))4111NewGV->setCodeModel(*CM);4112else4113return error("Invalid global variable code model");4114}41154116return Error::success();4117}41184119void BitcodeReader::callValueTypeCallback(Value *F, unsigned TypeID) {4120if (ValueTypeCallback) {4121(*ValueTypeCallback)(4122F, TypeID, [this](unsigned I) { return getTypeByID(I); },4123[this](unsigned I, unsigned J) { return getContainedTypeID(I, J); });4124}4125}41264127Error BitcodeReader::parseFunctionRecord(ArrayRef<uint64_t> Record) {4128// v1: [type, callingconv, isproto, linkage, paramattr, alignment, section,4129// visibility, gc, unnamed_addr, prologuedata, dllstorageclass, comdat,4130// prefixdata, personalityfn, preemption specifier, addrspace] (name in VST)4131// v2: [strtab_offset, strtab_size, v1]4132StringRef Name;4133std::tie(Name, Record) = readNameFromStrtab(Record);41344135if (Record.size() < 8)4136return error("Invalid record");4137unsigned FTyID = Record[0];4138Type *FTy = getTypeByID(FTyID);4139if (!FTy)4140return error("Invalid record");4141if (isa<PointerType>(FTy)) {4142FTyID = getContainedTypeID(FTyID, 0);4143FTy = getTypeByID(FTyID);4144if (!FTy)4145return error("Missing element type for old-style function");4146}41474148if (!isa<FunctionType>(FTy))4149return error("Invalid type for value");4150auto CC = static_cast<CallingConv::ID>(Record[1]);4151if (CC & ~CallingConv::MaxID)4152return error("Invalid calling convention ID");41534154unsigned AddrSpace = TheModule->getDataLayout().getProgramAddressSpace();4155if (Record.size() > 16)4156AddrSpace = Record[16];41574158Function *Func =4159Function::Create(cast<FunctionType>(FTy), GlobalValue::ExternalLinkage,4160AddrSpace, Name, TheModule);41614162assert(Func->getFunctionType() == FTy &&4163"Incorrect fully specified type provided for function");4164FunctionTypeIDs[Func] = FTyID;41654166Func->setCallingConv(CC);4167bool isProto = Record[2];4168uint64_t RawLinkage = Record[3];4169Func->setLinkage(getDecodedLinkage(RawLinkage));4170Func->setAttributes(getAttributes(Record[4]));4171callValueTypeCallback(Func, FTyID);41724173// Upgrade any old-style byval or sret without a type by propagating the4174// argument's pointee type. There should be no opaque pointers where the byval4175// type is implicit.4176for (unsigned i = 0; i != Func->arg_size(); ++i) {4177for (Attribute::AttrKind Kind : {Attribute::ByVal, Attribute::StructRet,4178Attribute::InAlloca}) {4179if (!Func->hasParamAttribute(i, Kind))4180continue;41814182if (Func->getParamAttribute(i, Kind).getValueAsType())4183continue;41844185Func->removeParamAttr(i, Kind);41864187unsigned ParamTypeID = getContainedTypeID(FTyID, i + 1);4188Type *PtrEltTy = getPtrElementTypeByID(ParamTypeID);4189if (!PtrEltTy)4190return error("Missing param element type for attribute upgrade");41914192Attribute NewAttr;4193switch (Kind) {4194case Attribute::ByVal:4195NewAttr = Attribute::getWithByValType(Context, PtrEltTy);4196break;4197case Attribute::StructRet:4198NewAttr = Attribute::getWithStructRetType(Context, PtrEltTy);4199break;4200case Attribute::InAlloca:4201NewAttr = Attribute::getWithInAllocaType(Context, PtrEltTy);4202break;4203default:4204llvm_unreachable("not an upgraded type attribute");4205}42064207Func->addParamAttr(i, NewAttr);4208}4209}42104211if (Func->getCallingConv() == CallingConv::X86_INTR &&4212!Func->arg_empty() && !Func->hasParamAttribute(0, Attribute::ByVal)) {4213unsigned ParamTypeID = getContainedTypeID(FTyID, 1);4214Type *ByValTy = getPtrElementTypeByID(ParamTypeID);4215if (!ByValTy)4216return error("Missing param element type for x86_intrcc upgrade");4217Attribute NewAttr = Attribute::getWithByValType(Context, ByValTy);4218Func->addParamAttr(0, NewAttr);4219}42204221MaybeAlign Alignment;4222if (Error Err = parseAlignmentValue(Record[5], Alignment))4223return Err;4224if (Alignment)4225Func->setAlignment(*Alignment);4226if (Record[6]) {4227if (Record[6] - 1 >= SectionTable.size())4228return error("Invalid ID");4229Func->setSection(SectionTable[Record[6] - 1]);4230}4231// Local linkage must have default visibility.4232// auto-upgrade `hidden` and `protected` for old bitcode.4233if (!Func->hasLocalLinkage())4234Func->setVisibility(getDecodedVisibility(Record[7]));4235if (Record.size() > 8 && Record[8]) {4236if (Record[8] - 1 >= GCTable.size())4237return error("Invalid ID");4238Func->setGC(GCTable[Record[8] - 1]);4239}4240GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None;4241if (Record.size() > 9)4242UnnamedAddr = getDecodedUnnamedAddrType(Record[9]);4243Func->setUnnamedAddr(UnnamedAddr);42444245FunctionOperandInfo OperandInfo = {Func, 0, 0, 0};4246if (Record.size() > 10)4247OperandInfo.Prologue = Record[10];42484249if (Record.size() > 11) {4250// A GlobalValue with local linkage cannot have a DLL storage class.4251if (!Func->hasLocalLinkage()) {4252Func->setDLLStorageClass(getDecodedDLLStorageClass(Record[11]));4253}4254} else {4255upgradeDLLImportExportLinkage(Func, RawLinkage);4256}42574258if (Record.size() > 12) {4259if (unsigned ComdatID = Record[12]) {4260if (ComdatID > ComdatList.size())4261return error("Invalid function comdat ID");4262Func->setComdat(ComdatList[ComdatID - 1]);4263}4264} else if (hasImplicitComdat(RawLinkage)) {4265ImplicitComdatObjects.insert(Func);4266}42674268if (Record.size() > 13)4269OperandInfo.Prefix = Record[13];42704271if (Record.size() > 14)4272OperandInfo.PersonalityFn = Record[14];42734274if (Record.size() > 15) {4275Func->setDSOLocal(getDecodedDSOLocal(Record[15]));4276}4277inferDSOLocal(Func);42784279// Record[16] is the address space number.42804281// Check whether we have enough values to read a partition name. Also make4282// sure Strtab has enough values.4283if (Record.size() > 18 && Strtab.data() &&4284Record[17] + Record[18] <= Strtab.size()) {4285Func->setPartition(StringRef(Strtab.data() + Record[17], Record[18]));4286}42874288ValueList.push_back(Func, getVirtualTypeID(Func->getType(), FTyID));42894290if (OperandInfo.PersonalityFn || OperandInfo.Prefix || OperandInfo.Prologue)4291FunctionOperands.push_back(OperandInfo);42924293// If this is a function with a body, remember the prototype we are4294// creating now, so that we can match up the body with them later.4295if (!isProto) {4296Func->setIsMaterializable(true);4297FunctionsWithBodies.push_back(Func);4298DeferredFunctionInfo[Func] = 0;4299}4300return Error::success();4301}43024303Error BitcodeReader::parseGlobalIndirectSymbolRecord(4304unsigned BitCode, ArrayRef<uint64_t> Record) {4305// v1 ALIAS_OLD: [alias type, aliasee val#, linkage] (name in VST)4306// v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, visibility,4307// dllstorageclass, threadlocal, unnamed_addr,4308// preemption specifier] (name in VST)4309// v1 IFUNC: [alias type, addrspace, aliasee val#, linkage,4310// visibility, dllstorageclass, threadlocal, unnamed_addr,4311// preemption specifier] (name in VST)4312// v2: [strtab_offset, strtab_size, v1]4313StringRef Name;4314std::tie(Name, Record) = readNameFromStrtab(Record);43154316bool NewRecord = BitCode != bitc::MODULE_CODE_ALIAS_OLD;4317if (Record.size() < (3 + (unsigned)NewRecord))4318return error("Invalid record");4319unsigned OpNum = 0;4320unsigned TypeID = Record[OpNum++];4321Type *Ty = getTypeByID(TypeID);4322if (!Ty)4323return error("Invalid record");43244325unsigned AddrSpace;4326if (!NewRecord) {4327auto *PTy = dyn_cast<PointerType>(Ty);4328if (!PTy)4329return error("Invalid type for value");4330AddrSpace = PTy->getAddressSpace();4331TypeID = getContainedTypeID(TypeID);4332Ty = getTypeByID(TypeID);4333if (!Ty)4334return error("Missing element type for old-style indirect symbol");4335} else {4336AddrSpace = Record[OpNum++];4337}43384339auto Val = Record[OpNum++];4340auto Linkage = Record[OpNum++];4341GlobalValue *NewGA;4342if (BitCode == bitc::MODULE_CODE_ALIAS ||4343BitCode == bitc::MODULE_CODE_ALIAS_OLD)4344NewGA = GlobalAlias::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,4345TheModule);4346else4347NewGA = GlobalIFunc::create(Ty, AddrSpace, getDecodedLinkage(Linkage), Name,4348nullptr, TheModule);43494350// Local linkage must have default visibility.4351// auto-upgrade `hidden` and `protected` for old bitcode.4352if (OpNum != Record.size()) {4353auto VisInd = OpNum++;4354if (!NewGA->hasLocalLinkage())4355NewGA->setVisibility(getDecodedVisibility(Record[VisInd]));4356}4357if (BitCode == bitc::MODULE_CODE_ALIAS ||4358BitCode == bitc::MODULE_CODE_ALIAS_OLD) {4359if (OpNum != Record.size()) {4360auto S = Record[OpNum++];4361// A GlobalValue with local linkage cannot have a DLL storage class.4362if (!NewGA->hasLocalLinkage())4363NewGA->setDLLStorageClass(getDecodedDLLStorageClass(S));4364}4365else4366upgradeDLLImportExportLinkage(NewGA, Linkage);4367if (OpNum != Record.size())4368NewGA->setThreadLocalMode(getDecodedThreadLocalMode(Record[OpNum++]));4369if (OpNum != Record.size())4370NewGA->setUnnamedAddr(getDecodedUnnamedAddrType(Record[OpNum++]));4371}4372if (OpNum != Record.size())4373NewGA->setDSOLocal(getDecodedDSOLocal(Record[OpNum++]));4374inferDSOLocal(NewGA);43754376// Check whether we have enough values to read a partition name.4377if (OpNum + 1 < Record.size()) {4378// Check Strtab has enough values for the partition.4379if (Record[OpNum] + Record[OpNum + 1] > Strtab.size())4380return error("Malformed partition, too large.");4381NewGA->setPartition(4382StringRef(Strtab.data() + Record[OpNum], Record[OpNum + 1]));4383}43844385ValueList.push_back(NewGA, getVirtualTypeID(NewGA->getType(), TypeID));4386IndirectSymbolInits.push_back(std::make_pair(NewGA, Val));4387return Error::success();4388}43894390Error BitcodeReader::parseModule(uint64_t ResumeBit,4391bool ShouldLazyLoadMetadata,4392ParserCallbacks Callbacks) {4393// Load directly into RemoveDIs format if LoadBitcodeIntoNewDbgInfoFormat4394// has been set to true and we aren't attempting to preserve the existing4395// format in the bitcode (default action: load into the old debug format).4396if (PreserveInputDbgFormat != cl::boolOrDefault::BOU_TRUE) {4397TheModule->IsNewDbgInfoFormat =4398UseNewDbgInfoFormat &&4399LoadBitcodeIntoNewDbgInfoFormat != cl::boolOrDefault::BOU_FALSE;4400}44014402this->ValueTypeCallback = std::move(Callbacks.ValueType);4403if (ResumeBit) {4404if (Error JumpFailed = Stream.JumpToBit(ResumeBit))4405return JumpFailed;4406} else if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))4407return Err;44084409SmallVector<uint64_t, 64> Record;44104411// Parts of bitcode parsing depend on the datalayout. Make sure we4412// finalize the datalayout before we run any of that code.4413bool ResolvedDataLayout = false;4414// In order to support importing modules with illegal data layout strings,4415// delay parsing the data layout string until after upgrades and overrides4416// have been applied, allowing to fix illegal data layout strings.4417// Initialize to the current module's layout string in case none is specified.4418std::string TentativeDataLayoutStr = TheModule->getDataLayoutStr();44194420auto ResolveDataLayout = [&]() -> Error {4421if (ResolvedDataLayout)4422return Error::success();44234424// Datalayout and triple can't be parsed after this point.4425ResolvedDataLayout = true;44264427// Auto-upgrade the layout string4428TentativeDataLayoutStr = llvm::UpgradeDataLayoutString(4429TentativeDataLayoutStr, TheModule->getTargetTriple());44304431// Apply override4432if (Callbacks.DataLayout) {4433if (auto LayoutOverride = (*Callbacks.DataLayout)(4434TheModule->getTargetTriple(), TentativeDataLayoutStr))4435TentativeDataLayoutStr = *LayoutOverride;4436}44374438// Now the layout string is finalized in TentativeDataLayoutStr. Parse it.4439Expected<DataLayout> MaybeDL = DataLayout::parse(TentativeDataLayoutStr);4440if (!MaybeDL)4441return MaybeDL.takeError();44424443TheModule->setDataLayout(MaybeDL.get());4444return Error::success();4445};44464447// Read all the records for this module.4448while (true) {4449Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();4450if (!MaybeEntry)4451return MaybeEntry.takeError();4452llvm::BitstreamEntry Entry = MaybeEntry.get();44534454switch (Entry.Kind) {4455case BitstreamEntry::Error:4456return error("Malformed block");4457case BitstreamEntry::EndBlock:4458if (Error Err = ResolveDataLayout())4459return Err;4460return globalCleanup();44614462case BitstreamEntry::SubBlock:4463switch (Entry.ID) {4464default: // Skip unknown content.4465if (Error Err = Stream.SkipBlock())4466return Err;4467break;4468case bitc::BLOCKINFO_BLOCK_ID:4469if (Error Err = readBlockInfo())4470return Err;4471break;4472case bitc::PARAMATTR_BLOCK_ID:4473if (Error Err = parseAttributeBlock())4474return Err;4475break;4476case bitc::PARAMATTR_GROUP_BLOCK_ID:4477if (Error Err = parseAttributeGroupBlock())4478return Err;4479break;4480case bitc::TYPE_BLOCK_ID_NEW:4481if (Error Err = parseTypeTable())4482return Err;4483break;4484case bitc::VALUE_SYMTAB_BLOCK_ID:4485if (!SeenValueSymbolTable) {4486// Either this is an old form VST without function index and an4487// associated VST forward declaration record (which would have caused4488// the VST to be jumped to and parsed before it was encountered4489// normally in the stream), or there were no function blocks to4490// trigger an earlier parsing of the VST.4491assert(VSTOffset == 0 || FunctionsWithBodies.empty());4492if (Error Err = parseValueSymbolTable())4493return Err;4494SeenValueSymbolTable = true;4495} else {4496// We must have had a VST forward declaration record, which caused4497// the parser to jump to and parse the VST earlier.4498assert(VSTOffset > 0);4499if (Error Err = Stream.SkipBlock())4500return Err;4501}4502break;4503case bitc::CONSTANTS_BLOCK_ID:4504if (Error Err = parseConstants())4505return Err;4506if (Error Err = resolveGlobalAndIndirectSymbolInits())4507return Err;4508break;4509case bitc::METADATA_BLOCK_ID:4510if (ShouldLazyLoadMetadata) {4511if (Error Err = rememberAndSkipMetadata())4512return Err;4513break;4514}4515assert(DeferredMetadataInfo.empty() && "Unexpected deferred metadata");4516if (Error Err = MDLoader->parseModuleMetadata())4517return Err;4518break;4519case bitc::METADATA_KIND_BLOCK_ID:4520if (Error Err = MDLoader->parseMetadataKinds())4521return Err;4522break;4523case bitc::FUNCTION_BLOCK_ID:4524if (Error Err = ResolveDataLayout())4525return Err;45264527// If this is the first function body we've seen, reverse the4528// FunctionsWithBodies list.4529if (!SeenFirstFunctionBody) {4530std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());4531if (Error Err = globalCleanup())4532return Err;4533SeenFirstFunctionBody = true;4534}45354536if (VSTOffset > 0) {4537// If we have a VST forward declaration record, make sure we4538// parse the VST now if we haven't already. It is needed to4539// set up the DeferredFunctionInfo vector for lazy reading.4540if (!SeenValueSymbolTable) {4541if (Error Err = BitcodeReader::parseValueSymbolTable(VSTOffset))4542return Err;4543SeenValueSymbolTable = true;4544// Fall through so that we record the NextUnreadBit below.4545// This is necessary in case we have an anonymous function that4546// is later materialized. Since it will not have a VST entry we4547// need to fall back to the lazy parse to find its offset.4548} else {4549// If we have a VST forward declaration record, but have already4550// parsed the VST (just above, when the first function body was4551// encountered here), then we are resuming the parse after4552// materializing functions. The ResumeBit points to the4553// start of the last function block recorded in the4554// DeferredFunctionInfo map. Skip it.4555if (Error Err = Stream.SkipBlock())4556return Err;4557continue;4558}4559}45604561// Support older bitcode files that did not have the function4562// index in the VST, nor a VST forward declaration record, as4563// well as anonymous functions that do not have VST entries.4564// Build the DeferredFunctionInfo vector on the fly.4565if (Error Err = rememberAndSkipFunctionBody())4566return Err;45674568// Suspend parsing when we reach the function bodies. Subsequent4569// materialization calls will resume it when necessary. If the bitcode4570// file is old, the symbol table will be at the end instead and will not4571// have been seen yet. In this case, just finish the parse now.4572if (SeenValueSymbolTable) {4573NextUnreadBit = Stream.GetCurrentBitNo();4574// After the VST has been parsed, we need to make sure intrinsic name4575// are auto-upgraded.4576return globalCleanup();4577}4578break;4579case bitc::USELIST_BLOCK_ID:4580if (Error Err = parseUseLists())4581return Err;4582break;4583case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:4584if (Error Err = parseOperandBundleTags())4585return Err;4586break;4587case bitc::SYNC_SCOPE_NAMES_BLOCK_ID:4588if (Error Err = parseSyncScopeNames())4589return Err;4590break;4591}4592continue;45934594case BitstreamEntry::Record:4595// The interesting case.4596break;4597}45984599// Read a record.4600Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);4601if (!MaybeBitCode)4602return MaybeBitCode.takeError();4603switch (unsigned BitCode = MaybeBitCode.get()) {4604default: break; // Default behavior, ignore unknown content.4605case bitc::MODULE_CODE_VERSION: {4606Expected<unsigned> VersionOrErr = parseVersionRecord(Record);4607if (!VersionOrErr)4608return VersionOrErr.takeError();4609UseRelativeIDs = *VersionOrErr >= 1;4610break;4611}4612case bitc::MODULE_CODE_TRIPLE: { // TRIPLE: [strchr x N]4613if (ResolvedDataLayout)4614return error("target triple too late in module");4615std::string S;4616if (convertToString(Record, 0, S))4617return error("Invalid record");4618TheModule->setTargetTriple(S);4619break;4620}4621case bitc::MODULE_CODE_DATALAYOUT: { // DATALAYOUT: [strchr x N]4622if (ResolvedDataLayout)4623return error("datalayout too late in module");4624if (convertToString(Record, 0, TentativeDataLayoutStr))4625return error("Invalid record");4626break;4627}4628case bitc::MODULE_CODE_ASM: { // ASM: [strchr x N]4629std::string S;4630if (convertToString(Record, 0, S))4631return error("Invalid record");4632TheModule->setModuleInlineAsm(S);4633break;4634}4635case bitc::MODULE_CODE_DEPLIB: { // DEPLIB: [strchr x N]4636// Deprecated, but still needed to read old bitcode files.4637std::string S;4638if (convertToString(Record, 0, S))4639return error("Invalid record");4640// Ignore value.4641break;4642}4643case bitc::MODULE_CODE_SECTIONNAME: { // SECTIONNAME: [strchr x N]4644std::string S;4645if (convertToString(Record, 0, S))4646return error("Invalid record");4647SectionTable.push_back(S);4648break;4649}4650case bitc::MODULE_CODE_GCNAME: { // SECTIONNAME: [strchr x N]4651std::string S;4652if (convertToString(Record, 0, S))4653return error("Invalid record");4654GCTable.push_back(S);4655break;4656}4657case bitc::MODULE_CODE_COMDAT:4658if (Error Err = parseComdatRecord(Record))4659return Err;4660break;4661// FIXME: BitcodeReader should handle {GLOBALVAR, FUNCTION, ALIAS, IFUNC}4662// written by ThinLinkBitcodeWriter. See4663// `ThinLinkBitcodeWriter::writeSimplifiedModuleInfo` for the format of each4664// record4665// (https://github.com/llvm/llvm-project/blob/b6a93967d9c11e79802b5e75cec1584d6c8aa472/llvm/lib/Bitcode/Writer/BitcodeWriter.cpp#L4714)4666case bitc::MODULE_CODE_GLOBALVAR:4667if (Error Err = parseGlobalVarRecord(Record))4668return Err;4669break;4670case bitc::MODULE_CODE_FUNCTION:4671if (Error Err = ResolveDataLayout())4672return Err;4673if (Error Err = parseFunctionRecord(Record))4674return Err;4675break;4676case bitc::MODULE_CODE_IFUNC:4677case bitc::MODULE_CODE_ALIAS:4678case bitc::MODULE_CODE_ALIAS_OLD:4679if (Error Err = parseGlobalIndirectSymbolRecord(BitCode, Record))4680return Err;4681break;4682/// MODULE_CODE_VSTOFFSET: [offset]4683case bitc::MODULE_CODE_VSTOFFSET:4684if (Record.empty())4685return error("Invalid record");4686// Note that we subtract 1 here because the offset is relative to one word4687// before the start of the identification or module block, which was4688// historically always the start of the regular bitcode header.4689VSTOffset = Record[0] - 1;4690break;4691/// MODULE_CODE_SOURCE_FILENAME: [namechar x N]4692case bitc::MODULE_CODE_SOURCE_FILENAME:4693SmallString<128> ValueName;4694if (convertToString(Record, 0, ValueName))4695return error("Invalid record");4696TheModule->setSourceFileName(ValueName);4697break;4698}4699Record.clear();4700}4701this->ValueTypeCallback = std::nullopt;4702return Error::success();4703}47044705Error BitcodeReader::parseBitcodeInto(Module *M, bool ShouldLazyLoadMetadata,4706bool IsImporting,4707ParserCallbacks Callbacks) {4708TheModule = M;4709MetadataLoaderCallbacks MDCallbacks;4710MDCallbacks.GetTypeByID = [&](unsigned ID) { return getTypeByID(ID); };4711MDCallbacks.GetContainedTypeID = [&](unsigned I, unsigned J) {4712return getContainedTypeID(I, J);4713};4714MDCallbacks.MDType = Callbacks.MDType;4715MDLoader = MetadataLoader(Stream, *M, ValueList, IsImporting, MDCallbacks);4716return parseModule(0, ShouldLazyLoadMetadata, Callbacks);4717}47184719Error BitcodeReader::typeCheckLoadStoreInst(Type *ValType, Type *PtrType) {4720if (!isa<PointerType>(PtrType))4721return error("Load/Store operand is not a pointer type");4722if (!PointerType::isLoadableOrStorableType(ValType))4723return error("Cannot load/store from pointer");4724return Error::success();4725}47264727Error BitcodeReader::propagateAttributeTypes(CallBase *CB,4728ArrayRef<unsigned> ArgTyIDs) {4729AttributeList Attrs = CB->getAttributes();4730for (unsigned i = 0; i != CB->arg_size(); ++i) {4731for (Attribute::AttrKind Kind : {Attribute::ByVal, Attribute::StructRet,4732Attribute::InAlloca}) {4733if (!Attrs.hasParamAttr(i, Kind) ||4734Attrs.getParamAttr(i, Kind).getValueAsType())4735continue;47364737Type *PtrEltTy = getPtrElementTypeByID(ArgTyIDs[i]);4738if (!PtrEltTy)4739return error("Missing element type for typed attribute upgrade");47404741Attribute NewAttr;4742switch (Kind) {4743case Attribute::ByVal:4744NewAttr = Attribute::getWithByValType(Context, PtrEltTy);4745break;4746case Attribute::StructRet:4747NewAttr = Attribute::getWithStructRetType(Context, PtrEltTy);4748break;4749case Attribute::InAlloca:4750NewAttr = Attribute::getWithInAllocaType(Context, PtrEltTy);4751break;4752default:4753llvm_unreachable("not an upgraded type attribute");4754}47554756Attrs = Attrs.addParamAttribute(Context, i, NewAttr);4757}4758}47594760if (CB->isInlineAsm()) {4761const InlineAsm *IA = cast<InlineAsm>(CB->getCalledOperand());4762unsigned ArgNo = 0;4763for (const InlineAsm::ConstraintInfo &CI : IA->ParseConstraints()) {4764if (!CI.hasArg())4765continue;47664767if (CI.isIndirect && !Attrs.getParamElementType(ArgNo)) {4768Type *ElemTy = getPtrElementTypeByID(ArgTyIDs[ArgNo]);4769if (!ElemTy)4770return error("Missing element type for inline asm upgrade");4771Attrs = Attrs.addParamAttribute(4772Context, ArgNo,4773Attribute::get(Context, Attribute::ElementType, ElemTy));4774}47754776ArgNo++;4777}4778}47794780switch (CB->getIntrinsicID()) {4781case Intrinsic::preserve_array_access_index:4782case Intrinsic::preserve_struct_access_index:4783case Intrinsic::aarch64_ldaxr:4784case Intrinsic::aarch64_ldxr:4785case Intrinsic::aarch64_stlxr:4786case Intrinsic::aarch64_stxr:4787case Intrinsic::arm_ldaex:4788case Intrinsic::arm_ldrex:4789case Intrinsic::arm_stlex:4790case Intrinsic::arm_strex: {4791unsigned ArgNo;4792switch (CB->getIntrinsicID()) {4793case Intrinsic::aarch64_stlxr:4794case Intrinsic::aarch64_stxr:4795case Intrinsic::arm_stlex:4796case Intrinsic::arm_strex:4797ArgNo = 1;4798break;4799default:4800ArgNo = 0;4801break;4802}4803if (!Attrs.getParamElementType(ArgNo)) {4804Type *ElTy = getPtrElementTypeByID(ArgTyIDs[ArgNo]);4805if (!ElTy)4806return error("Missing element type for elementtype upgrade");4807Attribute NewAttr = Attribute::get(Context, Attribute::ElementType, ElTy);4808Attrs = Attrs.addParamAttribute(Context, ArgNo, NewAttr);4809}4810break;4811}4812default:4813break;4814}48154816CB->setAttributes(Attrs);4817return Error::success();4818}48194820/// Lazily parse the specified function body block.4821Error BitcodeReader::parseFunctionBody(Function *F) {4822if (Error Err = Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))4823return Err;48244825// Unexpected unresolved metadata when parsing function.4826if (MDLoader->hasFwdRefs())4827return error("Invalid function metadata: incoming forward references");48284829InstructionList.clear();4830unsigned ModuleValueListSize = ValueList.size();4831unsigned ModuleMDLoaderSize = MDLoader->size();48324833// Add all the function arguments to the value table.4834unsigned ArgNo = 0;4835unsigned FTyID = FunctionTypeIDs[F];4836for (Argument &I : F->args()) {4837unsigned ArgTyID = getContainedTypeID(FTyID, ArgNo + 1);4838assert(I.getType() == getTypeByID(ArgTyID) &&4839"Incorrect fully specified type for Function Argument");4840ValueList.push_back(&I, ArgTyID);4841++ArgNo;4842}4843unsigned NextValueNo = ValueList.size();4844BasicBlock *CurBB = nullptr;4845unsigned CurBBNo = 0;4846// Block into which constant expressions from phi nodes are materialized.4847BasicBlock *PhiConstExprBB = nullptr;4848// Edge blocks for phi nodes into which constant expressions have been4849// expanded.4850SmallMapVector<std::pair<BasicBlock *, BasicBlock *>, BasicBlock *, 4>4851ConstExprEdgeBBs;48524853DebugLoc LastLoc;4854auto getLastInstruction = [&]() -> Instruction * {4855if (CurBB && !CurBB->empty())4856return &CurBB->back();4857else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&4858!FunctionBBs[CurBBNo - 1]->empty())4859return &FunctionBBs[CurBBNo - 1]->back();4860return nullptr;4861};48624863std::vector<OperandBundleDef> OperandBundles;48644865// Read all the records.4866SmallVector<uint64_t, 64> Record;48674868while (true) {4869Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();4870if (!MaybeEntry)4871return MaybeEntry.takeError();4872llvm::BitstreamEntry Entry = MaybeEntry.get();48734874switch (Entry.Kind) {4875case BitstreamEntry::Error:4876return error("Malformed block");4877case BitstreamEntry::EndBlock:4878goto OutOfRecordLoop;48794880case BitstreamEntry::SubBlock:4881switch (Entry.ID) {4882default: // Skip unknown content.4883if (Error Err = Stream.SkipBlock())4884return Err;4885break;4886case bitc::CONSTANTS_BLOCK_ID:4887if (Error Err = parseConstants())4888return Err;4889NextValueNo = ValueList.size();4890break;4891case bitc::VALUE_SYMTAB_BLOCK_ID:4892if (Error Err = parseValueSymbolTable())4893return Err;4894break;4895case bitc::METADATA_ATTACHMENT_ID:4896if (Error Err = MDLoader->parseMetadataAttachment(*F, InstructionList))4897return Err;4898break;4899case bitc::METADATA_BLOCK_ID:4900assert(DeferredMetadataInfo.empty() &&4901"Must read all module-level metadata before function-level");4902if (Error Err = MDLoader->parseFunctionMetadata())4903return Err;4904break;4905case bitc::USELIST_BLOCK_ID:4906if (Error Err = parseUseLists())4907return Err;4908break;4909}4910continue;49114912case BitstreamEntry::Record:4913// The interesting case.4914break;4915}49164917// Read a record.4918Record.clear();4919Instruction *I = nullptr;4920unsigned ResTypeID = InvalidTypeID;4921Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);4922if (!MaybeBitCode)4923return MaybeBitCode.takeError();4924switch (unsigned BitCode = MaybeBitCode.get()) {4925default: // Default behavior: reject4926return error("Invalid value");4927case bitc::FUNC_CODE_DECLAREBLOCKS: { // DECLAREBLOCKS: [nblocks]4928if (Record.empty() || Record[0] == 0)4929return error("Invalid record");4930// Create all the basic blocks for the function.4931FunctionBBs.resize(Record[0]);49324933// See if anything took the address of blocks in this function.4934auto BBFRI = BasicBlockFwdRefs.find(F);4935if (BBFRI == BasicBlockFwdRefs.end()) {4936for (BasicBlock *&BB : FunctionBBs)4937BB = BasicBlock::Create(Context, "", F);4938} else {4939auto &BBRefs = BBFRI->second;4940// Check for invalid basic block references.4941if (BBRefs.size() > FunctionBBs.size())4942return error("Invalid ID");4943assert(!BBRefs.empty() && "Unexpected empty array");4944assert(!BBRefs.front() && "Invalid reference to entry block");4945for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;4946++I)4947if (I < RE && BBRefs[I]) {4948BBRefs[I]->insertInto(F);4949FunctionBBs[I] = BBRefs[I];4950} else {4951FunctionBBs[I] = BasicBlock::Create(Context, "", F);4952}49534954// Erase from the table.4955BasicBlockFwdRefs.erase(BBFRI);4956}49574958CurBB = FunctionBBs[0];4959continue;4960}49614962case bitc::FUNC_CODE_BLOCKADDR_USERS: // BLOCKADDR_USERS: [vals...]4963// The record should not be emitted if it's an empty list.4964if (Record.empty())4965return error("Invalid record");4966// When we have the RARE case of a BlockAddress Constant that is not4967// scoped to the Function it refers to, we need to conservatively4968// materialize the referred to Function, regardless of whether or not4969// that Function will ultimately be linked, otherwise users of4970// BitcodeReader might start splicing out Function bodies such that we4971// might no longer be able to materialize the BlockAddress since the4972// BasicBlock (and entire body of the Function) the BlockAddress refers4973// to may have been moved. In the case that the user of BitcodeReader4974// decides ultimately not to link the Function body, materializing here4975// could be considered wasteful, but it's better than a deserialization4976// failure as described. This keeps BitcodeReader unaware of complex4977// linkage policy decisions such as those use by LTO, leaving those4978// decisions "one layer up."4979for (uint64_t ValID : Record)4980if (auto *F = dyn_cast<Function>(ValueList[ValID]))4981BackwardRefFunctions.push_back(F);4982else4983return error("Invalid record");49844985continue;49864987case bitc::FUNC_CODE_DEBUG_LOC_AGAIN: // DEBUG_LOC_AGAIN4988// This record indicates that the last instruction is at the same4989// location as the previous instruction with a location.4990I = getLastInstruction();49914992if (!I)4993return error("Invalid record");4994I->setDebugLoc(LastLoc);4995I = nullptr;4996continue;49974998case bitc::FUNC_CODE_DEBUG_LOC: { // DEBUG_LOC: [line, col, scope, ia]4999I = getLastInstruction();5000if (!I || Record.size() < 4)5001return error("Invalid record");50025003unsigned Line = Record[0], Col = Record[1];5004unsigned ScopeID = Record[2], IAID = Record[3];5005bool isImplicitCode = Record.size() == 5 && Record[4];50065007MDNode *Scope = nullptr, *IA = nullptr;5008if (ScopeID) {5009Scope = dyn_cast_or_null<MDNode>(5010MDLoader->getMetadataFwdRefOrLoad(ScopeID - 1));5011if (!Scope)5012return error("Invalid record");5013}5014if (IAID) {5015IA = dyn_cast_or_null<MDNode>(5016MDLoader->getMetadataFwdRefOrLoad(IAID - 1));5017if (!IA)5018return error("Invalid record");5019}5020LastLoc = DILocation::get(Scope->getContext(), Line, Col, Scope, IA,5021isImplicitCode);5022I->setDebugLoc(LastLoc);5023I = nullptr;5024continue;5025}5026case bitc::FUNC_CODE_INST_UNOP: { // UNOP: [opval, ty, opcode]5027unsigned OpNum = 0;5028Value *LHS;5029unsigned TypeID;5030if (getValueTypePair(Record, OpNum, NextValueNo, LHS, TypeID, CurBB) ||5031OpNum+1 > Record.size())5032return error("Invalid record");50335034int Opc = getDecodedUnaryOpcode(Record[OpNum++], LHS->getType());5035if (Opc == -1)5036return error("Invalid record");5037I = UnaryOperator::Create((Instruction::UnaryOps)Opc, LHS);5038ResTypeID = TypeID;5039InstructionList.push_back(I);5040if (OpNum < Record.size()) {5041if (isa<FPMathOperator>(I)) {5042FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);5043if (FMF.any())5044I->setFastMathFlags(FMF);5045}5046}5047break;5048}5049case bitc::FUNC_CODE_INST_BINOP: { // BINOP: [opval, ty, opval, opcode]5050unsigned OpNum = 0;5051Value *LHS, *RHS;5052unsigned TypeID;5053if (getValueTypePair(Record, OpNum, NextValueNo, LHS, TypeID, CurBB) ||5054popValue(Record, OpNum, NextValueNo, LHS->getType(), TypeID, RHS,5055CurBB) ||5056OpNum+1 > Record.size())5057return error("Invalid record");50585059int Opc = getDecodedBinaryOpcode(Record[OpNum++], LHS->getType());5060if (Opc == -1)5061return error("Invalid record");5062I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);5063ResTypeID = TypeID;5064InstructionList.push_back(I);5065if (OpNum < Record.size()) {5066if (Opc == Instruction::Add ||5067Opc == Instruction::Sub ||5068Opc == Instruction::Mul ||5069Opc == Instruction::Shl) {5070if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))5071cast<BinaryOperator>(I)->setHasNoSignedWrap(true);5072if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))5073cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);5074} else if (Opc == Instruction::SDiv ||5075Opc == Instruction::UDiv ||5076Opc == Instruction::LShr ||5077Opc == Instruction::AShr) {5078if (Record[OpNum] & (1 << bitc::PEO_EXACT))5079cast<BinaryOperator>(I)->setIsExact(true);5080} else if (Opc == Instruction::Or) {5081if (Record[OpNum] & (1 << bitc::PDI_DISJOINT))5082cast<PossiblyDisjointInst>(I)->setIsDisjoint(true);5083} else if (isa<FPMathOperator>(I)) {5084FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);5085if (FMF.any())5086I->setFastMathFlags(FMF);5087}5088}5089break;5090}5091case bitc::FUNC_CODE_INST_CAST: { // CAST: [opval, opty, destty, castopc]5092unsigned OpNum = 0;5093Value *Op;5094unsigned OpTypeID;5095if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB) ||5096OpNum + 1 > Record.size())5097return error("Invalid record");50985099ResTypeID = Record[OpNum++];5100Type *ResTy = getTypeByID(ResTypeID);5101int Opc = getDecodedCastOpcode(Record[OpNum++]);51025103if (Opc == -1 || !ResTy)5104return error("Invalid record");5105Instruction *Temp = nullptr;5106if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {5107if (Temp) {5108InstructionList.push_back(Temp);5109assert(CurBB && "No current BB?");5110Temp->insertInto(CurBB, CurBB->end());5111}5112} else {5113auto CastOp = (Instruction::CastOps)Opc;5114if (!CastInst::castIsValid(CastOp, Op, ResTy))5115return error("Invalid cast");5116I = CastInst::Create(CastOp, Op, ResTy);5117}51185119if (OpNum < Record.size()) {5120if (Opc == Instruction::ZExt || Opc == Instruction::UIToFP) {5121if (Record[OpNum] & (1 << bitc::PNNI_NON_NEG))5122cast<PossiblyNonNegInst>(I)->setNonNeg(true);5123} else if (Opc == Instruction::Trunc) {5124if (Record[OpNum] & (1 << bitc::TIO_NO_UNSIGNED_WRAP))5125cast<TruncInst>(I)->setHasNoUnsignedWrap(true);5126if (Record[OpNum] & (1 << bitc::TIO_NO_SIGNED_WRAP))5127cast<TruncInst>(I)->setHasNoSignedWrap(true);5128}5129}51305131InstructionList.push_back(I);5132break;5133}5134case bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD:5135case bitc::FUNC_CODE_INST_GEP_OLD:5136case bitc::FUNC_CODE_INST_GEP: { // GEP: type, [n x operands]5137unsigned OpNum = 0;51385139unsigned TyID;5140Type *Ty;5141GEPNoWrapFlags NW;51425143if (BitCode == bitc::FUNC_CODE_INST_GEP) {5144NW = toGEPNoWrapFlags(Record[OpNum++]);5145TyID = Record[OpNum++];5146Ty = getTypeByID(TyID);5147} else {5148if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP_OLD)5149NW = GEPNoWrapFlags::inBounds();5150TyID = InvalidTypeID;5151Ty = nullptr;5152}51535154Value *BasePtr;5155unsigned BasePtrTypeID;5156if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr, BasePtrTypeID,5157CurBB))5158return error("Invalid record");51595160if (!Ty) {5161TyID = getContainedTypeID(BasePtrTypeID);5162if (BasePtr->getType()->isVectorTy())5163TyID = getContainedTypeID(TyID);5164Ty = getTypeByID(TyID);5165}51665167SmallVector<Value*, 16> GEPIdx;5168while (OpNum != Record.size()) {5169Value *Op;5170unsigned OpTypeID;5171if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))5172return error("Invalid record");5173GEPIdx.push_back(Op);5174}51755176auto *GEP = GetElementPtrInst::Create(Ty, BasePtr, GEPIdx);5177I = GEP;51785179ResTypeID = TyID;5180if (cast<GEPOperator>(I)->getNumIndices() != 0) {5181auto GTI = std::next(gep_type_begin(I));5182for (Value *Idx : drop_begin(cast<GEPOperator>(I)->indices())) {5183unsigned SubType = 0;5184if (GTI.isStruct()) {5185ConstantInt *IdxC =5186Idx->getType()->isVectorTy()5187? cast<ConstantInt>(cast<Constant>(Idx)->getSplatValue())5188: cast<ConstantInt>(Idx);5189SubType = IdxC->getZExtValue();5190}5191ResTypeID = getContainedTypeID(ResTypeID, SubType);5192++GTI;5193}5194}51955196// At this point ResTypeID is the result element type. We need a pointer5197// or vector of pointer to it.5198ResTypeID = getVirtualTypeID(I->getType()->getScalarType(), ResTypeID);5199if (I->getType()->isVectorTy())5200ResTypeID = getVirtualTypeID(I->getType(), ResTypeID);52015202InstructionList.push_back(I);5203GEP->setNoWrapFlags(NW);5204break;5205}52065207case bitc::FUNC_CODE_INST_EXTRACTVAL: {5208// EXTRACTVAL: [opty, opval, n x indices]5209unsigned OpNum = 0;5210Value *Agg;5211unsigned AggTypeID;5212if (getValueTypePair(Record, OpNum, NextValueNo, Agg, AggTypeID, CurBB))5213return error("Invalid record");5214Type *Ty = Agg->getType();52155216unsigned RecSize = Record.size();5217if (OpNum == RecSize)5218return error("EXTRACTVAL: Invalid instruction with 0 indices");52195220SmallVector<unsigned, 4> EXTRACTVALIdx;5221ResTypeID = AggTypeID;5222for (; OpNum != RecSize; ++OpNum) {5223bool IsArray = Ty->isArrayTy();5224bool IsStruct = Ty->isStructTy();5225uint64_t Index = Record[OpNum];52265227if (!IsStruct && !IsArray)5228return error("EXTRACTVAL: Invalid type");5229if ((unsigned)Index != Index)5230return error("Invalid value");5231if (IsStruct && Index >= Ty->getStructNumElements())5232return error("EXTRACTVAL: Invalid struct index");5233if (IsArray && Index >= Ty->getArrayNumElements())5234return error("EXTRACTVAL: Invalid array index");5235EXTRACTVALIdx.push_back((unsigned)Index);52365237if (IsStruct) {5238Ty = Ty->getStructElementType(Index);5239ResTypeID = getContainedTypeID(ResTypeID, Index);5240} else {5241Ty = Ty->getArrayElementType();5242ResTypeID = getContainedTypeID(ResTypeID);5243}5244}52455246I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);5247InstructionList.push_back(I);5248break;5249}52505251case bitc::FUNC_CODE_INST_INSERTVAL: {5252// INSERTVAL: [opty, opval, opty, opval, n x indices]5253unsigned OpNum = 0;5254Value *Agg;5255unsigned AggTypeID;5256if (getValueTypePair(Record, OpNum, NextValueNo, Agg, AggTypeID, CurBB))5257return error("Invalid record");5258Value *Val;5259unsigned ValTypeID;5260if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))5261return error("Invalid record");52625263unsigned RecSize = Record.size();5264if (OpNum == RecSize)5265return error("INSERTVAL: Invalid instruction with 0 indices");52665267SmallVector<unsigned, 4> INSERTVALIdx;5268Type *CurTy = Agg->getType();5269for (; OpNum != RecSize; ++OpNum) {5270bool IsArray = CurTy->isArrayTy();5271bool IsStruct = CurTy->isStructTy();5272uint64_t Index = Record[OpNum];52735274if (!IsStruct && !IsArray)5275return error("INSERTVAL: Invalid type");5276if ((unsigned)Index != Index)5277return error("Invalid value");5278if (IsStruct && Index >= CurTy->getStructNumElements())5279return error("INSERTVAL: Invalid struct index");5280if (IsArray && Index >= CurTy->getArrayNumElements())5281return error("INSERTVAL: Invalid array index");52825283INSERTVALIdx.push_back((unsigned)Index);5284if (IsStruct)5285CurTy = CurTy->getStructElementType(Index);5286else5287CurTy = CurTy->getArrayElementType();5288}52895290if (CurTy != Val->getType())5291return error("Inserted value type doesn't match aggregate type");52925293I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);5294ResTypeID = AggTypeID;5295InstructionList.push_back(I);5296break;5297}52985299case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]5300// obsolete form of select5301// handles select i1 ... in old bitcode5302unsigned OpNum = 0;5303Value *TrueVal, *FalseVal, *Cond;5304unsigned TypeID;5305Type *CondType = Type::getInt1Ty(Context);5306if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal, TypeID,5307CurBB) ||5308popValue(Record, OpNum, NextValueNo, TrueVal->getType(), TypeID,5309FalseVal, CurBB) ||5310popValue(Record, OpNum, NextValueNo, CondType,5311getVirtualTypeID(CondType), Cond, CurBB))5312return error("Invalid record");53135314I = SelectInst::Create(Cond, TrueVal, FalseVal);5315ResTypeID = TypeID;5316InstructionList.push_back(I);5317break;5318}53195320case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]5321// new form of select5322// handles select i1 or select [N x i1]5323unsigned OpNum = 0;5324Value *TrueVal, *FalseVal, *Cond;5325unsigned ValTypeID, CondTypeID;5326if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal, ValTypeID,5327CurBB) ||5328popValue(Record, OpNum, NextValueNo, TrueVal->getType(), ValTypeID,5329FalseVal, CurBB) ||5330getValueTypePair(Record, OpNum, NextValueNo, Cond, CondTypeID, CurBB))5331return error("Invalid record");53325333// select condition can be either i1 or [N x i1]5334if (VectorType* vector_type =5335dyn_cast<VectorType>(Cond->getType())) {5336// expect <n x i1>5337if (vector_type->getElementType() != Type::getInt1Ty(Context))5338return error("Invalid type for value");5339} else {5340// expect i15341if (Cond->getType() != Type::getInt1Ty(Context))5342return error("Invalid type for value");5343}53445345I = SelectInst::Create(Cond, TrueVal, FalseVal);5346ResTypeID = ValTypeID;5347InstructionList.push_back(I);5348if (OpNum < Record.size() && isa<FPMathOperator>(I)) {5349FastMathFlags FMF = getDecodedFastMathFlags(Record[OpNum]);5350if (FMF.any())5351I->setFastMathFlags(FMF);5352}5353break;5354}53555356case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]5357unsigned OpNum = 0;5358Value *Vec, *Idx;5359unsigned VecTypeID, IdxTypeID;5360if (getValueTypePair(Record, OpNum, NextValueNo, Vec, VecTypeID, CurBB) ||5361getValueTypePair(Record, OpNum, NextValueNo, Idx, IdxTypeID, CurBB))5362return error("Invalid record");5363if (!Vec->getType()->isVectorTy())5364return error("Invalid type for value");5365I = ExtractElementInst::Create(Vec, Idx);5366ResTypeID = getContainedTypeID(VecTypeID);5367InstructionList.push_back(I);5368break;5369}53705371case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]5372unsigned OpNum = 0;5373Value *Vec, *Elt, *Idx;5374unsigned VecTypeID, IdxTypeID;5375if (getValueTypePair(Record, OpNum, NextValueNo, Vec, VecTypeID, CurBB))5376return error("Invalid record");5377if (!Vec->getType()->isVectorTy())5378return error("Invalid type for value");5379if (popValue(Record, OpNum, NextValueNo,5380cast<VectorType>(Vec->getType())->getElementType(),5381getContainedTypeID(VecTypeID), Elt, CurBB) ||5382getValueTypePair(Record, OpNum, NextValueNo, Idx, IdxTypeID, CurBB))5383return error("Invalid record");5384I = InsertElementInst::Create(Vec, Elt, Idx);5385ResTypeID = VecTypeID;5386InstructionList.push_back(I);5387break;5388}53895390case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]5391unsigned OpNum = 0;5392Value *Vec1, *Vec2, *Mask;5393unsigned Vec1TypeID;5394if (getValueTypePair(Record, OpNum, NextValueNo, Vec1, Vec1TypeID,5395CurBB) ||5396popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec1TypeID,5397Vec2, CurBB))5398return error("Invalid record");53995400unsigned MaskTypeID;5401if (getValueTypePair(Record, OpNum, NextValueNo, Mask, MaskTypeID, CurBB))5402return error("Invalid record");5403if (!Vec1->getType()->isVectorTy() || !Vec2->getType()->isVectorTy())5404return error("Invalid type for value");54055406I = new ShuffleVectorInst(Vec1, Vec2, Mask);5407ResTypeID =5408getVirtualTypeID(I->getType(), getContainedTypeID(Vec1TypeID));5409InstructionList.push_back(I);5410break;5411}54125413case bitc::FUNC_CODE_INST_CMP: // CMP: [opty, opval, opval, pred]5414// Old form of ICmp/FCmp returning bool5415// Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were5416// both legal on vectors but had different behaviour.5417case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]5418// FCmp/ICmp returning bool or vector of bool54195420unsigned OpNum = 0;5421Value *LHS, *RHS;5422unsigned LHSTypeID;5423if (getValueTypePair(Record, OpNum, NextValueNo, LHS, LHSTypeID, CurBB) ||5424popValue(Record, OpNum, NextValueNo, LHS->getType(), LHSTypeID, RHS,5425CurBB))5426return error("Invalid record");54275428if (OpNum >= Record.size())5429return error(5430"Invalid record: operand number exceeded available operands");54315432CmpInst::Predicate PredVal = CmpInst::Predicate(Record[OpNum]);5433bool IsFP = LHS->getType()->isFPOrFPVectorTy();5434FastMathFlags FMF;5435if (IsFP && Record.size() > OpNum+1)5436FMF = getDecodedFastMathFlags(Record[++OpNum]);54375438if (OpNum+1 != Record.size())5439return error("Invalid record");54405441if (IsFP) {5442if (!CmpInst::isFPPredicate(PredVal))5443return error("Invalid fcmp predicate");5444I = new FCmpInst(PredVal, LHS, RHS);5445} else {5446if (!CmpInst::isIntPredicate(PredVal))5447return error("Invalid icmp predicate");5448I = new ICmpInst(PredVal, LHS, RHS);5449}54505451ResTypeID = getVirtualTypeID(I->getType()->getScalarType());5452if (LHS->getType()->isVectorTy())5453ResTypeID = getVirtualTypeID(I->getType(), ResTypeID);54545455if (FMF.any())5456I->setFastMathFlags(FMF);5457InstructionList.push_back(I);5458break;5459}54605461case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]5462{5463unsigned Size = Record.size();5464if (Size == 0) {5465I = ReturnInst::Create(Context);5466InstructionList.push_back(I);5467break;5468}54695470unsigned OpNum = 0;5471Value *Op = nullptr;5472unsigned OpTypeID;5473if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))5474return error("Invalid record");5475if (OpNum != Record.size())5476return error("Invalid record");54775478I = ReturnInst::Create(Context, Op);5479InstructionList.push_back(I);5480break;5481}5482case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]5483if (Record.size() != 1 && Record.size() != 3)5484return error("Invalid record");5485BasicBlock *TrueDest = getBasicBlock(Record[0]);5486if (!TrueDest)5487return error("Invalid record");54885489if (Record.size() == 1) {5490I = BranchInst::Create(TrueDest);5491InstructionList.push_back(I);5492}5493else {5494BasicBlock *FalseDest = getBasicBlock(Record[1]);5495Type *CondType = Type::getInt1Ty(Context);5496Value *Cond = getValue(Record, 2, NextValueNo, CondType,5497getVirtualTypeID(CondType), CurBB);5498if (!FalseDest || !Cond)5499return error("Invalid record");5500I = BranchInst::Create(TrueDest, FalseDest, Cond);5501InstructionList.push_back(I);5502}5503break;5504}5505case bitc::FUNC_CODE_INST_CLEANUPRET: { // CLEANUPRET: [val] or [val,bb#]5506if (Record.size() != 1 && Record.size() != 2)5507return error("Invalid record");5508unsigned Idx = 0;5509Type *TokenTy = Type::getTokenTy(Context);5510Value *CleanupPad = getValue(Record, Idx++, NextValueNo, TokenTy,5511getVirtualTypeID(TokenTy), CurBB);5512if (!CleanupPad)5513return error("Invalid record");5514BasicBlock *UnwindDest = nullptr;5515if (Record.size() == 2) {5516UnwindDest = getBasicBlock(Record[Idx++]);5517if (!UnwindDest)5518return error("Invalid record");5519}55205521I = CleanupReturnInst::Create(CleanupPad, UnwindDest);5522InstructionList.push_back(I);5523break;5524}5525case bitc::FUNC_CODE_INST_CATCHRET: { // CATCHRET: [val,bb#]5526if (Record.size() != 2)5527return error("Invalid record");5528unsigned Idx = 0;5529Type *TokenTy = Type::getTokenTy(Context);5530Value *CatchPad = getValue(Record, Idx++, NextValueNo, TokenTy,5531getVirtualTypeID(TokenTy), CurBB);5532if (!CatchPad)5533return error("Invalid record");5534BasicBlock *BB = getBasicBlock(Record[Idx++]);5535if (!BB)5536return error("Invalid record");55375538I = CatchReturnInst::Create(CatchPad, BB);5539InstructionList.push_back(I);5540break;5541}5542case bitc::FUNC_CODE_INST_CATCHSWITCH: { // CATCHSWITCH: [tok,num,(bb)*,bb?]5543// We must have, at minimum, the outer scope and the number of arguments.5544if (Record.size() < 2)5545return error("Invalid record");55465547unsigned Idx = 0;55485549Type *TokenTy = Type::getTokenTy(Context);5550Value *ParentPad = getValue(Record, Idx++, NextValueNo, TokenTy,5551getVirtualTypeID(TokenTy), CurBB);5552if (!ParentPad)5553return error("Invalid record");55545555unsigned NumHandlers = Record[Idx++];55565557SmallVector<BasicBlock *, 2> Handlers;5558for (unsigned Op = 0; Op != NumHandlers; ++Op) {5559BasicBlock *BB = getBasicBlock(Record[Idx++]);5560if (!BB)5561return error("Invalid record");5562Handlers.push_back(BB);5563}55645565BasicBlock *UnwindDest = nullptr;5566if (Idx + 1 == Record.size()) {5567UnwindDest = getBasicBlock(Record[Idx++]);5568if (!UnwindDest)5569return error("Invalid record");5570}55715572if (Record.size() != Idx)5573return error("Invalid record");55745575auto *CatchSwitch =5576CatchSwitchInst::Create(ParentPad, UnwindDest, NumHandlers);5577for (BasicBlock *Handler : Handlers)5578CatchSwitch->addHandler(Handler);5579I = CatchSwitch;5580ResTypeID = getVirtualTypeID(I->getType());5581InstructionList.push_back(I);5582break;5583}5584case bitc::FUNC_CODE_INST_CATCHPAD:5585case bitc::FUNC_CODE_INST_CLEANUPPAD: { // [tok,num,(ty,val)*]5586// We must have, at minimum, the outer scope and the number of arguments.5587if (Record.size() < 2)5588return error("Invalid record");55895590unsigned Idx = 0;55915592Type *TokenTy = Type::getTokenTy(Context);5593Value *ParentPad = getValue(Record, Idx++, NextValueNo, TokenTy,5594getVirtualTypeID(TokenTy), CurBB);5595if (!ParentPad)5596return error("Invald record");55975598unsigned NumArgOperands = Record[Idx++];55995600SmallVector<Value *, 2> Args;5601for (unsigned Op = 0; Op != NumArgOperands; ++Op) {5602Value *Val;5603unsigned ValTypeID;5604if (getValueTypePair(Record, Idx, NextValueNo, Val, ValTypeID, nullptr))5605return error("Invalid record");5606Args.push_back(Val);5607}56085609if (Record.size() != Idx)5610return error("Invalid record");56115612if (BitCode == bitc::FUNC_CODE_INST_CLEANUPPAD)5613I = CleanupPadInst::Create(ParentPad, Args);5614else5615I = CatchPadInst::Create(ParentPad, Args);5616ResTypeID = getVirtualTypeID(I->getType());5617InstructionList.push_back(I);5618break;5619}5620case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]5621// Check magic5622if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {5623// "New" SwitchInst format with case ranges. The changes to write this5624// format were reverted but we still recognize bitcode that uses it.5625// Hopefully someday we will have support for case ranges and can use5626// this format again.56275628unsigned OpTyID = Record[1];5629Type *OpTy = getTypeByID(OpTyID);5630unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();56315632Value *Cond = getValue(Record, 2, NextValueNo, OpTy, OpTyID, CurBB);5633BasicBlock *Default = getBasicBlock(Record[3]);5634if (!OpTy || !Cond || !Default)5635return error("Invalid record");56365637unsigned NumCases = Record[4];56385639SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);5640InstructionList.push_back(SI);56415642unsigned CurIdx = 5;5643for (unsigned i = 0; i != NumCases; ++i) {5644SmallVector<ConstantInt*, 1> CaseVals;5645unsigned NumItems = Record[CurIdx++];5646for (unsigned ci = 0; ci != NumItems; ++ci) {5647bool isSingleNumber = Record[CurIdx++];56485649APInt Low;5650unsigned ActiveWords = 1;5651if (ValueBitWidth > 64)5652ActiveWords = Record[CurIdx++];5653Low = readWideAPInt(ArrayRef(&Record[CurIdx], ActiveWords),5654ValueBitWidth);5655CurIdx += ActiveWords;56565657if (!isSingleNumber) {5658ActiveWords = 1;5659if (ValueBitWidth > 64)5660ActiveWords = Record[CurIdx++];5661APInt High = readWideAPInt(ArrayRef(&Record[CurIdx], ActiveWords),5662ValueBitWidth);5663CurIdx += ActiveWords;56645665// FIXME: It is not clear whether values in the range should be5666// compared as signed or unsigned values. The partially5667// implemented changes that used this format in the past used5668// unsigned comparisons.5669for ( ; Low.ule(High); ++Low)5670CaseVals.push_back(ConstantInt::get(Context, Low));5671} else5672CaseVals.push_back(ConstantInt::get(Context, Low));5673}5674BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);5675for (ConstantInt *Cst : CaseVals)5676SI->addCase(Cst, DestBB);5677}5678I = SI;5679break;5680}56815682// Old SwitchInst format without case ranges.56835684if (Record.size() < 3 || (Record.size() & 1) == 0)5685return error("Invalid record");5686unsigned OpTyID = Record[0];5687Type *OpTy = getTypeByID(OpTyID);5688Value *Cond = getValue(Record, 1, NextValueNo, OpTy, OpTyID, CurBB);5689BasicBlock *Default = getBasicBlock(Record[2]);5690if (!OpTy || !Cond || !Default)5691return error("Invalid record");5692unsigned NumCases = (Record.size()-3)/2;5693SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);5694InstructionList.push_back(SI);5695for (unsigned i = 0, e = NumCases; i != e; ++i) {5696ConstantInt *CaseVal = dyn_cast_or_null<ConstantInt>(5697getFnValueByID(Record[3+i*2], OpTy, OpTyID, nullptr));5698BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);5699if (!CaseVal || !DestBB) {5700delete SI;5701return error("Invalid record");5702}5703SI->addCase(CaseVal, DestBB);5704}5705I = SI;5706break;5707}5708case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]5709if (Record.size() < 2)5710return error("Invalid record");5711unsigned OpTyID = Record[0];5712Type *OpTy = getTypeByID(OpTyID);5713Value *Address = getValue(Record, 1, NextValueNo, OpTy, OpTyID, CurBB);5714if (!OpTy || !Address)5715return error("Invalid record");5716unsigned NumDests = Record.size()-2;5717IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);5718InstructionList.push_back(IBI);5719for (unsigned i = 0, e = NumDests; i != e; ++i) {5720if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {5721IBI->addDestination(DestBB);5722} else {5723delete IBI;5724return error("Invalid record");5725}5726}5727I = IBI;5728break;5729}57305731case bitc::FUNC_CODE_INST_INVOKE: {5732// INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]5733if (Record.size() < 4)5734return error("Invalid record");5735unsigned OpNum = 0;5736AttributeList PAL = getAttributes(Record[OpNum++]);5737unsigned CCInfo = Record[OpNum++];5738BasicBlock *NormalBB = getBasicBlock(Record[OpNum++]);5739BasicBlock *UnwindBB = getBasicBlock(Record[OpNum++]);57405741unsigned FTyID = InvalidTypeID;5742FunctionType *FTy = nullptr;5743if ((CCInfo >> 13) & 1) {5744FTyID = Record[OpNum++];5745FTy = dyn_cast<FunctionType>(getTypeByID(FTyID));5746if (!FTy)5747return error("Explicit invoke type is not a function type");5748}57495750Value *Callee;5751unsigned CalleeTypeID;5752if (getValueTypePair(Record, OpNum, NextValueNo, Callee, CalleeTypeID,5753CurBB))5754return error("Invalid record");57555756PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());5757if (!CalleeTy)5758return error("Callee is not a pointer");5759if (!FTy) {5760FTyID = getContainedTypeID(CalleeTypeID);5761FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));5762if (!FTy)5763return error("Callee is not of pointer to function type");5764}5765if (Record.size() < FTy->getNumParams() + OpNum)5766return error("Insufficient operands to call");57675768SmallVector<Value*, 16> Ops;5769SmallVector<unsigned, 16> ArgTyIDs;5770for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {5771unsigned ArgTyID = getContainedTypeID(FTyID, i + 1);5772Ops.push_back(getValue(Record, OpNum, NextValueNo, FTy->getParamType(i),5773ArgTyID, CurBB));5774ArgTyIDs.push_back(ArgTyID);5775if (!Ops.back())5776return error("Invalid record");5777}57785779if (!FTy->isVarArg()) {5780if (Record.size() != OpNum)5781return error("Invalid record");5782} else {5783// Read type/value pairs for varargs params.5784while (OpNum != Record.size()) {5785Value *Op;5786unsigned OpTypeID;5787if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))5788return error("Invalid record");5789Ops.push_back(Op);5790ArgTyIDs.push_back(OpTypeID);5791}5792}57935794// Upgrade the bundles if needed.5795if (!OperandBundles.empty())5796UpgradeOperandBundles(OperandBundles);57975798I = InvokeInst::Create(FTy, Callee, NormalBB, UnwindBB, Ops,5799OperandBundles);5800ResTypeID = getContainedTypeID(FTyID);5801OperandBundles.clear();5802InstructionList.push_back(I);5803cast<InvokeInst>(I)->setCallingConv(5804static_cast<CallingConv::ID>(CallingConv::MaxID & CCInfo));5805cast<InvokeInst>(I)->setAttributes(PAL);5806if (Error Err = propagateAttributeTypes(cast<CallBase>(I), ArgTyIDs)) {5807I->deleteValue();5808return Err;5809}58105811break;5812}5813case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]5814unsigned Idx = 0;5815Value *Val = nullptr;5816unsigned ValTypeID;5817if (getValueTypePair(Record, Idx, NextValueNo, Val, ValTypeID, CurBB))5818return error("Invalid record");5819I = ResumeInst::Create(Val);5820InstructionList.push_back(I);5821break;5822}5823case bitc::FUNC_CODE_INST_CALLBR: {5824// CALLBR: [attr, cc, norm, transfs, fty, fnid, args]5825unsigned OpNum = 0;5826AttributeList PAL = getAttributes(Record[OpNum++]);5827unsigned CCInfo = Record[OpNum++];58285829BasicBlock *DefaultDest = getBasicBlock(Record[OpNum++]);5830unsigned NumIndirectDests = Record[OpNum++];5831SmallVector<BasicBlock *, 16> IndirectDests;5832for (unsigned i = 0, e = NumIndirectDests; i != e; ++i)5833IndirectDests.push_back(getBasicBlock(Record[OpNum++]));58345835unsigned FTyID = InvalidTypeID;5836FunctionType *FTy = nullptr;5837if ((CCInfo >> bitc::CALL_EXPLICIT_TYPE) & 1) {5838FTyID = Record[OpNum++];5839FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));5840if (!FTy)5841return error("Explicit call type is not a function type");5842}58435844Value *Callee;5845unsigned CalleeTypeID;5846if (getValueTypePair(Record, OpNum, NextValueNo, Callee, CalleeTypeID,5847CurBB))5848return error("Invalid record");58495850PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());5851if (!OpTy)5852return error("Callee is not a pointer type");5853if (!FTy) {5854FTyID = getContainedTypeID(CalleeTypeID);5855FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));5856if (!FTy)5857return error("Callee is not of pointer to function type");5858}5859if (Record.size() < FTy->getNumParams() + OpNum)5860return error("Insufficient operands to call");58615862SmallVector<Value*, 16> Args;5863SmallVector<unsigned, 16> ArgTyIDs;5864// Read the fixed params.5865for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {5866Value *Arg;5867unsigned ArgTyID = getContainedTypeID(FTyID, i + 1);5868if (FTy->getParamType(i)->isLabelTy())5869Arg = getBasicBlock(Record[OpNum]);5870else5871Arg = getValue(Record, OpNum, NextValueNo, FTy->getParamType(i),5872ArgTyID, CurBB);5873if (!Arg)5874return error("Invalid record");5875Args.push_back(Arg);5876ArgTyIDs.push_back(ArgTyID);5877}58785879// Read type/value pairs for varargs params.5880if (!FTy->isVarArg()) {5881if (OpNum != Record.size())5882return error("Invalid record");5883} else {5884while (OpNum != Record.size()) {5885Value *Op;5886unsigned OpTypeID;5887if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))5888return error("Invalid record");5889Args.push_back(Op);5890ArgTyIDs.push_back(OpTypeID);5891}5892}58935894// Upgrade the bundles if needed.5895if (!OperandBundles.empty())5896UpgradeOperandBundles(OperandBundles);58975898if (auto *IA = dyn_cast<InlineAsm>(Callee)) {5899InlineAsm::ConstraintInfoVector ConstraintInfo = IA->ParseConstraints();5900auto IsLabelConstraint = [](const InlineAsm::ConstraintInfo &CI) {5901return CI.Type == InlineAsm::isLabel;5902};5903if (none_of(ConstraintInfo, IsLabelConstraint)) {5904// Upgrade explicit blockaddress arguments to label constraints.5905// Verify that the last arguments are blockaddress arguments that5906// match the indirect destinations. Clang always generates callbr5907// in this form. We could support reordering with more effort.5908unsigned FirstBlockArg = Args.size() - IndirectDests.size();5909for (unsigned ArgNo = FirstBlockArg; ArgNo < Args.size(); ++ArgNo) {5910unsigned LabelNo = ArgNo - FirstBlockArg;5911auto *BA = dyn_cast<BlockAddress>(Args[ArgNo]);5912if (!BA || BA->getFunction() != F ||5913LabelNo > IndirectDests.size() ||5914BA->getBasicBlock() != IndirectDests[LabelNo])5915return error("callbr argument does not match indirect dest");5916}59175918// Remove blockaddress arguments.5919Args.erase(Args.begin() + FirstBlockArg, Args.end());5920ArgTyIDs.erase(ArgTyIDs.begin() + FirstBlockArg, ArgTyIDs.end());59215922// Recreate the function type with less arguments.5923SmallVector<Type *> ArgTys;5924for (Value *Arg : Args)5925ArgTys.push_back(Arg->getType());5926FTy =5927FunctionType::get(FTy->getReturnType(), ArgTys, FTy->isVarArg());59285929// Update constraint string to use label constraints.5930std::string Constraints = IA->getConstraintString();5931unsigned ArgNo = 0;5932size_t Pos = 0;5933for (const auto &CI : ConstraintInfo) {5934if (CI.hasArg()) {5935if (ArgNo >= FirstBlockArg)5936Constraints.insert(Pos, "!");5937++ArgNo;5938}59395940// Go to next constraint in string.5941Pos = Constraints.find(',', Pos);5942if (Pos == std::string::npos)5943break;5944++Pos;5945}59465947Callee = InlineAsm::get(FTy, IA->getAsmString(), Constraints,5948IA->hasSideEffects(), IA->isAlignStack(),5949IA->getDialect(), IA->canThrow());5950}5951}59525953I = CallBrInst::Create(FTy, Callee, DefaultDest, IndirectDests, Args,5954OperandBundles);5955ResTypeID = getContainedTypeID(FTyID);5956OperandBundles.clear();5957InstructionList.push_back(I);5958cast<CallBrInst>(I)->setCallingConv(5959static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));5960cast<CallBrInst>(I)->setAttributes(PAL);5961if (Error Err = propagateAttributeTypes(cast<CallBase>(I), ArgTyIDs)) {5962I->deleteValue();5963return Err;5964}5965break;5966}5967case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE5968I = new UnreachableInst(Context);5969InstructionList.push_back(I);5970break;5971case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]5972if (Record.empty())5973return error("Invalid phi record");5974// The first record specifies the type.5975unsigned TyID = Record[0];5976Type *Ty = getTypeByID(TyID);5977if (!Ty)5978return error("Invalid phi record");59795980// Phi arguments are pairs of records of [value, basic block].5981// There is an optional final record for fast-math-flags if this phi has a5982// floating-point type.5983size_t NumArgs = (Record.size() - 1) / 2;5984PHINode *PN = PHINode::Create(Ty, NumArgs);5985if ((Record.size() - 1) % 2 == 1 && !isa<FPMathOperator>(PN)) {5986PN->deleteValue();5987return error("Invalid phi record");5988}5989InstructionList.push_back(PN);59905991SmallDenseMap<BasicBlock *, Value *> Args;5992for (unsigned i = 0; i != NumArgs; i++) {5993BasicBlock *BB = getBasicBlock(Record[i * 2 + 2]);5994if (!BB) {5995PN->deleteValue();5996return error("Invalid phi BB");5997}59985999// Phi nodes may contain the same predecessor multiple times, in which6000// case the incoming value must be identical. Directly reuse the already6001// seen value here, to avoid expanding a constant expression multiple6002// times.6003auto It = Args.find(BB);6004if (It != Args.end()) {6005PN->addIncoming(It->second, BB);6006continue;6007}60086009// If there already is a block for this edge (from a different phi),6010// use it.6011BasicBlock *EdgeBB = ConstExprEdgeBBs.lookup({BB, CurBB});6012if (!EdgeBB) {6013// Otherwise, use a temporary block (that we will discard if it6014// turns out to be unnecessary).6015if (!PhiConstExprBB)6016PhiConstExprBB = BasicBlock::Create(Context, "phi.constexpr", F);6017EdgeBB = PhiConstExprBB;6018}60196020// With the new function encoding, it is possible that operands have6021// negative IDs (for forward references). Use a signed VBR6022// representation to keep the encoding small.6023Value *V;6024if (UseRelativeIDs)6025V = getValueSigned(Record, i * 2 + 1, NextValueNo, Ty, TyID, EdgeBB);6026else6027V = getValue(Record, i * 2 + 1, NextValueNo, Ty, TyID, EdgeBB);6028if (!V) {6029PN->deleteValue();6030PhiConstExprBB->eraseFromParent();6031return error("Invalid phi record");6032}60336034if (EdgeBB == PhiConstExprBB && !EdgeBB->empty()) {6035ConstExprEdgeBBs.insert({{BB, CurBB}, EdgeBB});6036PhiConstExprBB = nullptr;6037}6038PN->addIncoming(V, BB);6039Args.insert({BB, V});6040}6041I = PN;6042ResTypeID = TyID;60436044// If there are an even number of records, the final record must be FMF.6045if (Record.size() % 2 == 0) {6046assert(isa<FPMathOperator>(I) && "Unexpected phi type");6047FastMathFlags FMF = getDecodedFastMathFlags(Record[Record.size() - 1]);6048if (FMF.any())6049I->setFastMathFlags(FMF);6050}60516052break;6053}60546055case bitc::FUNC_CODE_INST_LANDINGPAD:6056case bitc::FUNC_CODE_INST_LANDINGPAD_OLD: {6057// LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]6058unsigned Idx = 0;6059if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD) {6060if (Record.size() < 3)6061return error("Invalid record");6062} else {6063assert(BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD);6064if (Record.size() < 4)6065return error("Invalid record");6066}6067ResTypeID = Record[Idx++];6068Type *Ty = getTypeByID(ResTypeID);6069if (!Ty)6070return error("Invalid record");6071if (BitCode == bitc::FUNC_CODE_INST_LANDINGPAD_OLD) {6072Value *PersFn = nullptr;6073unsigned PersFnTypeID;6074if (getValueTypePair(Record, Idx, NextValueNo, PersFn, PersFnTypeID,6075nullptr))6076return error("Invalid record");60776078if (!F->hasPersonalityFn())6079F->setPersonalityFn(cast<Constant>(PersFn));6080else if (F->getPersonalityFn() != cast<Constant>(PersFn))6081return error("Personality function mismatch");6082}60836084bool IsCleanup = !!Record[Idx++];6085unsigned NumClauses = Record[Idx++];6086LandingPadInst *LP = LandingPadInst::Create(Ty, NumClauses);6087LP->setCleanup(IsCleanup);6088for (unsigned J = 0; J != NumClauses; ++J) {6089LandingPadInst::ClauseType CT =6090LandingPadInst::ClauseType(Record[Idx++]); (void)CT;6091Value *Val;6092unsigned ValTypeID;60936094if (getValueTypePair(Record, Idx, NextValueNo, Val, ValTypeID,6095nullptr)) {6096delete LP;6097return error("Invalid record");6098}60996100assert((CT != LandingPadInst::Catch ||6101!isa<ArrayType>(Val->getType())) &&6102"Catch clause has a invalid type!");6103assert((CT != LandingPadInst::Filter ||6104isa<ArrayType>(Val->getType())) &&6105"Filter clause has invalid type!");6106LP->addClause(cast<Constant>(Val));6107}61086109I = LP;6110InstructionList.push_back(I);6111break;6112}61136114case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]6115if (Record.size() != 4 && Record.size() != 5)6116return error("Invalid record");6117using APV = AllocaPackedValues;6118const uint64_t Rec = Record[3];6119const bool InAlloca = Bitfield::get<APV::UsedWithInAlloca>(Rec);6120const bool SwiftError = Bitfield::get<APV::SwiftError>(Rec);6121unsigned TyID = Record[0];6122Type *Ty = getTypeByID(TyID);6123if (!Bitfield::get<APV::ExplicitType>(Rec)) {6124TyID = getContainedTypeID(TyID);6125Ty = getTypeByID(TyID);6126if (!Ty)6127return error("Missing element type for old-style alloca");6128}6129unsigned OpTyID = Record[1];6130Type *OpTy = getTypeByID(OpTyID);6131Value *Size = getFnValueByID(Record[2], OpTy, OpTyID, CurBB);6132MaybeAlign Align;6133uint64_t AlignExp =6134Bitfield::get<APV::AlignLower>(Rec) |6135(Bitfield::get<APV::AlignUpper>(Rec) << APV::AlignLower::Bits);6136if (Error Err = parseAlignmentValue(AlignExp, Align)) {6137return Err;6138}6139if (!Ty || !Size)6140return error("Invalid record");61416142const DataLayout &DL = TheModule->getDataLayout();6143unsigned AS = Record.size() == 5 ? Record[4] : DL.getAllocaAddrSpace();61446145SmallPtrSet<Type *, 4> Visited;6146if (!Align && !Ty->isSized(&Visited))6147return error("alloca of unsized type");6148if (!Align)6149Align = DL.getPrefTypeAlign(Ty);61506151if (!Size->getType()->isIntegerTy())6152return error("alloca element count must have integer type");61536154AllocaInst *AI = new AllocaInst(Ty, AS, Size, *Align);6155AI->setUsedWithInAlloca(InAlloca);6156AI->setSwiftError(SwiftError);6157I = AI;6158ResTypeID = getVirtualTypeID(AI->getType(), TyID);6159InstructionList.push_back(I);6160break;6161}6162case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]6163unsigned OpNum = 0;6164Value *Op;6165unsigned OpTypeID;6166if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB) ||6167(OpNum + 2 != Record.size() && OpNum + 3 != Record.size()))6168return error("Invalid record");61696170if (!isa<PointerType>(Op->getType()))6171return error("Load operand is not a pointer type");61726173Type *Ty = nullptr;6174if (OpNum + 3 == Record.size()) {6175ResTypeID = Record[OpNum++];6176Ty = getTypeByID(ResTypeID);6177} else {6178ResTypeID = getContainedTypeID(OpTypeID);6179Ty = getTypeByID(ResTypeID);6180}61816182if (!Ty)6183return error("Missing load type");61846185if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))6186return Err;61876188MaybeAlign Align;6189if (Error Err = parseAlignmentValue(Record[OpNum], Align))6190return Err;6191SmallPtrSet<Type *, 4> Visited;6192if (!Align && !Ty->isSized(&Visited))6193return error("load of unsized type");6194if (!Align)6195Align = TheModule->getDataLayout().getABITypeAlign(Ty);6196I = new LoadInst(Ty, Op, "", Record[OpNum + 1], *Align);6197InstructionList.push_back(I);6198break;6199}6200case bitc::FUNC_CODE_INST_LOADATOMIC: {6201// LOADATOMIC: [opty, op, align, vol, ordering, ssid]6202unsigned OpNum = 0;6203Value *Op;6204unsigned OpTypeID;6205if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB) ||6206(OpNum + 4 != Record.size() && OpNum + 5 != Record.size()))6207return error("Invalid record");62086209if (!isa<PointerType>(Op->getType()))6210return error("Load operand is not a pointer type");62116212Type *Ty = nullptr;6213if (OpNum + 5 == Record.size()) {6214ResTypeID = Record[OpNum++];6215Ty = getTypeByID(ResTypeID);6216} else {6217ResTypeID = getContainedTypeID(OpTypeID);6218Ty = getTypeByID(ResTypeID);6219}62206221if (!Ty)6222return error("Missing atomic load type");62236224if (Error Err = typeCheckLoadStoreInst(Ty, Op->getType()))6225return Err;62266227AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);6228if (Ordering == AtomicOrdering::NotAtomic ||6229Ordering == AtomicOrdering::Release ||6230Ordering == AtomicOrdering::AcquireRelease)6231return error("Invalid record");6232if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)6233return error("Invalid record");6234SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);62356236MaybeAlign Align;6237if (Error Err = parseAlignmentValue(Record[OpNum], Align))6238return Err;6239if (!Align)6240return error("Alignment missing from atomic load");6241I = new LoadInst(Ty, Op, "", Record[OpNum + 1], *Align, Ordering, SSID);6242InstructionList.push_back(I);6243break;6244}6245case bitc::FUNC_CODE_INST_STORE:6246case bitc::FUNC_CODE_INST_STORE_OLD: { // STORE2:[ptrty, ptr, val, align, vol]6247unsigned OpNum = 0;6248Value *Val, *Ptr;6249unsigned PtrTypeID, ValTypeID;6250if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))6251return error("Invalid record");62526253if (BitCode == bitc::FUNC_CODE_INST_STORE) {6254if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))6255return error("Invalid record");6256} else {6257ValTypeID = getContainedTypeID(PtrTypeID);6258if (popValue(Record, OpNum, NextValueNo, getTypeByID(ValTypeID),6259ValTypeID, Val, CurBB))6260return error("Invalid record");6261}62626263if (OpNum + 2 != Record.size())6264return error("Invalid record");62656266if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))6267return Err;6268MaybeAlign Align;6269if (Error Err = parseAlignmentValue(Record[OpNum], Align))6270return Err;6271SmallPtrSet<Type *, 4> Visited;6272if (!Align && !Val->getType()->isSized(&Visited))6273return error("store of unsized type");6274if (!Align)6275Align = TheModule->getDataLayout().getABITypeAlign(Val->getType());6276I = new StoreInst(Val, Ptr, Record[OpNum + 1], *Align);6277InstructionList.push_back(I);6278break;6279}6280case bitc::FUNC_CODE_INST_STOREATOMIC:6281case bitc::FUNC_CODE_INST_STOREATOMIC_OLD: {6282// STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, ssid]6283unsigned OpNum = 0;6284Value *Val, *Ptr;6285unsigned PtrTypeID, ValTypeID;6286if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB) ||6287!isa<PointerType>(Ptr->getType()))6288return error("Invalid record");6289if (BitCode == bitc::FUNC_CODE_INST_STOREATOMIC) {6290if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))6291return error("Invalid record");6292} else {6293ValTypeID = getContainedTypeID(PtrTypeID);6294if (popValue(Record, OpNum, NextValueNo, getTypeByID(ValTypeID),6295ValTypeID, Val, CurBB))6296return error("Invalid record");6297}62986299if (OpNum + 4 != Record.size())6300return error("Invalid record");63016302if (Error Err = typeCheckLoadStoreInst(Val->getType(), Ptr->getType()))6303return Err;6304AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);6305if (Ordering == AtomicOrdering::NotAtomic ||6306Ordering == AtomicOrdering::Acquire ||6307Ordering == AtomicOrdering::AcquireRelease)6308return error("Invalid record");6309SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);6310if (Ordering != AtomicOrdering::NotAtomic && Record[OpNum] == 0)6311return error("Invalid record");63126313MaybeAlign Align;6314if (Error Err = parseAlignmentValue(Record[OpNum], Align))6315return Err;6316if (!Align)6317return error("Alignment missing from atomic store");6318I = new StoreInst(Val, Ptr, Record[OpNum + 1], *Align, Ordering, SSID);6319InstructionList.push_back(I);6320break;6321}6322case bitc::FUNC_CODE_INST_CMPXCHG_OLD: {6323// CMPXCHG_OLD: [ptrty, ptr, cmp, val, vol, ordering, synchscope,6324// failure_ordering?, weak?]6325const size_t NumRecords = Record.size();6326unsigned OpNum = 0;6327Value *Ptr = nullptr;6328unsigned PtrTypeID;6329if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))6330return error("Invalid record");63316332if (!isa<PointerType>(Ptr->getType()))6333return error("Cmpxchg operand is not a pointer type");63346335Value *Cmp = nullptr;6336unsigned CmpTypeID = getContainedTypeID(PtrTypeID);6337if (popValue(Record, OpNum, NextValueNo, getTypeByID(CmpTypeID),6338CmpTypeID, Cmp, CurBB))6339return error("Invalid record");63406341Value *New = nullptr;6342if (popValue(Record, OpNum, NextValueNo, Cmp->getType(), CmpTypeID,6343New, CurBB) ||6344NumRecords < OpNum + 3 || NumRecords > OpNum + 5)6345return error("Invalid record");63466347const AtomicOrdering SuccessOrdering =6348getDecodedOrdering(Record[OpNum + 1]);6349if (SuccessOrdering == AtomicOrdering::NotAtomic ||6350SuccessOrdering == AtomicOrdering::Unordered)6351return error("Invalid record");63526353const SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 2]);63546355if (Error Err = typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))6356return Err;63576358const AtomicOrdering FailureOrdering =6359NumRecords < 76360? AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering)6361: getDecodedOrdering(Record[OpNum + 3]);63626363if (FailureOrdering == AtomicOrdering::NotAtomic ||6364FailureOrdering == AtomicOrdering::Unordered)6365return error("Invalid record");63666367const Align Alignment(6368TheModule->getDataLayout().getTypeStoreSize(Cmp->getType()));63696370I = new AtomicCmpXchgInst(Ptr, Cmp, New, Alignment, SuccessOrdering,6371FailureOrdering, SSID);6372cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);63736374if (NumRecords < 8) {6375// Before weak cmpxchgs existed, the instruction simply returned the6376// value loaded from memory, so bitcode files from that era will be6377// expecting the first component of a modern cmpxchg.6378I->insertInto(CurBB, CurBB->end());6379I = ExtractValueInst::Create(I, 0);6380ResTypeID = CmpTypeID;6381} else {6382cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum + 4]);6383unsigned I1TypeID = getVirtualTypeID(Type::getInt1Ty(Context));6384ResTypeID = getVirtualTypeID(I->getType(), {CmpTypeID, I1TypeID});6385}63866387InstructionList.push_back(I);6388break;6389}6390case bitc::FUNC_CODE_INST_CMPXCHG: {6391// CMPXCHG: [ptrty, ptr, cmp, val, vol, success_ordering, synchscope,6392// failure_ordering, weak, align?]6393const size_t NumRecords = Record.size();6394unsigned OpNum = 0;6395Value *Ptr = nullptr;6396unsigned PtrTypeID;6397if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))6398return error("Invalid record");63996400if (!isa<PointerType>(Ptr->getType()))6401return error("Cmpxchg operand is not a pointer type");64026403Value *Cmp = nullptr;6404unsigned CmpTypeID;6405if (getValueTypePair(Record, OpNum, NextValueNo, Cmp, CmpTypeID, CurBB))6406return error("Invalid record");64076408Value *Val = nullptr;6409if (popValue(Record, OpNum, NextValueNo, Cmp->getType(), CmpTypeID, Val,6410CurBB))6411return error("Invalid record");64126413if (NumRecords < OpNum + 3 || NumRecords > OpNum + 6)6414return error("Invalid record");64156416const bool IsVol = Record[OpNum];64176418const AtomicOrdering SuccessOrdering =6419getDecodedOrdering(Record[OpNum + 1]);6420if (!AtomicCmpXchgInst::isValidSuccessOrdering(SuccessOrdering))6421return error("Invalid cmpxchg success ordering");64226423const SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 2]);64246425if (Error Err = typeCheckLoadStoreInst(Cmp->getType(), Ptr->getType()))6426return Err;64276428const AtomicOrdering FailureOrdering =6429getDecodedOrdering(Record[OpNum + 3]);6430if (!AtomicCmpXchgInst::isValidFailureOrdering(FailureOrdering))6431return error("Invalid cmpxchg failure ordering");64326433const bool IsWeak = Record[OpNum + 4];64346435MaybeAlign Alignment;64366437if (NumRecords == (OpNum + 6)) {6438if (Error Err = parseAlignmentValue(Record[OpNum + 5], Alignment))6439return Err;6440}6441if (!Alignment)6442Alignment =6443Align(TheModule->getDataLayout().getTypeStoreSize(Cmp->getType()));64446445I = new AtomicCmpXchgInst(Ptr, Cmp, Val, *Alignment, SuccessOrdering,6446FailureOrdering, SSID);6447cast<AtomicCmpXchgInst>(I)->setVolatile(IsVol);6448cast<AtomicCmpXchgInst>(I)->setWeak(IsWeak);64496450unsigned I1TypeID = getVirtualTypeID(Type::getInt1Ty(Context));6451ResTypeID = getVirtualTypeID(I->getType(), {CmpTypeID, I1TypeID});64526453InstructionList.push_back(I);6454break;6455}6456case bitc::FUNC_CODE_INST_ATOMICRMW_OLD:6457case bitc::FUNC_CODE_INST_ATOMICRMW: {6458// ATOMICRMW_OLD: [ptrty, ptr, val, op, vol, ordering, ssid, align?]6459// ATOMICRMW: [ptrty, ptr, valty, val, op, vol, ordering, ssid, align?]6460const size_t NumRecords = Record.size();6461unsigned OpNum = 0;64626463Value *Ptr = nullptr;6464unsigned PtrTypeID;6465if (getValueTypePair(Record, OpNum, NextValueNo, Ptr, PtrTypeID, CurBB))6466return error("Invalid record");64676468if (!isa<PointerType>(Ptr->getType()))6469return error("Invalid record");64706471Value *Val = nullptr;6472unsigned ValTypeID = InvalidTypeID;6473if (BitCode == bitc::FUNC_CODE_INST_ATOMICRMW_OLD) {6474ValTypeID = getContainedTypeID(PtrTypeID);6475if (popValue(Record, OpNum, NextValueNo,6476getTypeByID(ValTypeID), ValTypeID, Val, CurBB))6477return error("Invalid record");6478} else {6479if (getValueTypePair(Record, OpNum, NextValueNo, Val, ValTypeID, CurBB))6480return error("Invalid record");6481}64826483if (!(NumRecords == (OpNum + 4) || NumRecords == (OpNum + 5)))6484return error("Invalid record");64856486const AtomicRMWInst::BinOp Operation =6487getDecodedRMWOperation(Record[OpNum]);6488if (Operation < AtomicRMWInst::FIRST_BINOP ||6489Operation > AtomicRMWInst::LAST_BINOP)6490return error("Invalid record");64916492const bool IsVol = Record[OpNum + 1];64936494const AtomicOrdering Ordering = getDecodedOrdering(Record[OpNum + 2]);6495if (Ordering == AtomicOrdering::NotAtomic ||6496Ordering == AtomicOrdering::Unordered)6497return error("Invalid record");64986499const SyncScope::ID SSID = getDecodedSyncScopeID(Record[OpNum + 3]);65006501MaybeAlign Alignment;65026503if (NumRecords == (OpNum + 5)) {6504if (Error Err = parseAlignmentValue(Record[OpNum + 4], Alignment))6505return Err;6506}65076508if (!Alignment)6509Alignment =6510Align(TheModule->getDataLayout().getTypeStoreSize(Val->getType()));65116512I = new AtomicRMWInst(Operation, Ptr, Val, *Alignment, Ordering, SSID);6513ResTypeID = ValTypeID;6514cast<AtomicRMWInst>(I)->setVolatile(IsVol);65156516InstructionList.push_back(I);6517break;6518}6519case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, ssid]6520if (2 != Record.size())6521return error("Invalid record");6522AtomicOrdering Ordering = getDecodedOrdering(Record[0]);6523if (Ordering == AtomicOrdering::NotAtomic ||6524Ordering == AtomicOrdering::Unordered ||6525Ordering == AtomicOrdering::Monotonic)6526return error("Invalid record");6527SyncScope::ID SSID = getDecodedSyncScopeID(Record[1]);6528I = new FenceInst(Context, Ordering, SSID);6529InstructionList.push_back(I);6530break;6531}6532case bitc::FUNC_CODE_DEBUG_RECORD_LABEL: {6533// DbgLabelRecords are placed after the Instructions that they are6534// attached to.6535SeenDebugRecord = true;6536Instruction *Inst = getLastInstruction();6537if (!Inst)6538return error("Invalid dbg record: missing instruction");6539DILocation *DIL = cast<DILocation>(getFnMetadataByID(Record[0]));6540DILabel *Label = cast<DILabel>(getFnMetadataByID(Record[1]));6541Inst->getParent()->insertDbgRecordBefore(6542new DbgLabelRecord(Label, DebugLoc(DIL)), Inst->getIterator());6543continue; // This isn't an instruction.6544}6545case bitc::FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE:6546case bitc::FUNC_CODE_DEBUG_RECORD_VALUE:6547case bitc::FUNC_CODE_DEBUG_RECORD_DECLARE:6548case bitc::FUNC_CODE_DEBUG_RECORD_ASSIGN: {6549// DbgVariableRecords are placed after the Instructions that they are6550// attached to.6551SeenDebugRecord = true;6552Instruction *Inst = getLastInstruction();6553if (!Inst)6554return error("Invalid dbg record: missing instruction");65556556// First 3 fields are common to all kinds:6557// DILocation, DILocalVariable, DIExpression6558// dbg_value (FUNC_CODE_DEBUG_RECORD_VALUE)6559// ..., LocationMetadata6560// dbg_value (FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE - abbrev'd)6561// ..., Value6562// dbg_declare (FUNC_CODE_DEBUG_RECORD_DECLARE)6563// ..., LocationMetadata6564// dbg_assign (FUNC_CODE_DEBUG_RECORD_ASSIGN)6565// ..., LocationMetadata, DIAssignID, DIExpression, LocationMetadata6566unsigned Slot = 0;6567// Common fields (0-2).6568DILocation *DIL = cast<DILocation>(getFnMetadataByID(Record[Slot++]));6569DILocalVariable *Var =6570cast<DILocalVariable>(getFnMetadataByID(Record[Slot++]));6571DIExpression *Expr =6572cast<DIExpression>(getFnMetadataByID(Record[Slot++]));65736574// Union field (3: LocationMetadata | Value).6575Metadata *RawLocation = nullptr;6576if (BitCode == bitc::FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE) {6577Value *V = nullptr;6578unsigned TyID = 0;6579// We never expect to see a fwd reference value here because6580// use-before-defs are encoded with the standard non-abbrev record6581// type (they'd require encoding the type too, and they're rare). As a6582// result, getValueTypePair only ever increments Slot by one here (once6583// for the value, never twice for value and type).6584unsigned SlotBefore = Slot;6585if (getValueTypePair(Record, Slot, NextValueNo, V, TyID, CurBB))6586return error("Invalid dbg record: invalid value");6587(void)SlotBefore;6588assert((SlotBefore == Slot - 1) && "unexpected fwd ref");6589RawLocation = ValueAsMetadata::get(V);6590} else {6591RawLocation = getFnMetadataByID(Record[Slot++]);6592}65936594DbgVariableRecord *DVR = nullptr;6595switch (BitCode) {6596case bitc::FUNC_CODE_DEBUG_RECORD_VALUE:6597case bitc::FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE:6598DVR = new DbgVariableRecord(RawLocation, Var, Expr, DIL,6599DbgVariableRecord::LocationType::Value);6600break;6601case bitc::FUNC_CODE_DEBUG_RECORD_DECLARE:6602DVR = new DbgVariableRecord(RawLocation, Var, Expr, DIL,6603DbgVariableRecord::LocationType::Declare);6604break;6605case bitc::FUNC_CODE_DEBUG_RECORD_ASSIGN: {6606DIAssignID *ID = cast<DIAssignID>(getFnMetadataByID(Record[Slot++]));6607DIExpression *AddrExpr =6608cast<DIExpression>(getFnMetadataByID(Record[Slot++]));6609Metadata *Addr = getFnMetadataByID(Record[Slot++]);6610DVR = new DbgVariableRecord(RawLocation, Var, Expr, ID, Addr, AddrExpr,6611DIL);6612break;6613}6614default:6615llvm_unreachable("Unknown DbgVariableRecord bitcode");6616}6617Inst->getParent()->insertDbgRecordBefore(DVR, Inst->getIterator());6618continue; // This isn't an instruction.6619}6620case bitc::FUNC_CODE_INST_CALL: {6621// CALL: [paramattrs, cc, fmf, fnty, fnid, arg0, arg1...]6622if (Record.size() < 3)6623return error("Invalid record");66246625unsigned OpNum = 0;6626AttributeList PAL = getAttributes(Record[OpNum++]);6627unsigned CCInfo = Record[OpNum++];66286629FastMathFlags FMF;6630if ((CCInfo >> bitc::CALL_FMF) & 1) {6631FMF = getDecodedFastMathFlags(Record[OpNum++]);6632if (!FMF.any())6633return error("Fast math flags indicator set for call with no FMF");6634}66356636unsigned FTyID = InvalidTypeID;6637FunctionType *FTy = nullptr;6638if ((CCInfo >> bitc::CALL_EXPLICIT_TYPE) & 1) {6639FTyID = Record[OpNum++];6640FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));6641if (!FTy)6642return error("Explicit call type is not a function type");6643}66446645Value *Callee;6646unsigned CalleeTypeID;6647if (getValueTypePair(Record, OpNum, NextValueNo, Callee, CalleeTypeID,6648CurBB))6649return error("Invalid record");66506651PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());6652if (!OpTy)6653return error("Callee is not a pointer type");6654if (!FTy) {6655FTyID = getContainedTypeID(CalleeTypeID);6656FTy = dyn_cast_or_null<FunctionType>(getTypeByID(FTyID));6657if (!FTy)6658return error("Callee is not of pointer to function type");6659}6660if (Record.size() < FTy->getNumParams() + OpNum)6661return error("Insufficient operands to call");66626663SmallVector<Value*, 16> Args;6664SmallVector<unsigned, 16> ArgTyIDs;6665// Read the fixed params.6666for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {6667unsigned ArgTyID = getContainedTypeID(FTyID, i + 1);6668if (FTy->getParamType(i)->isLabelTy())6669Args.push_back(getBasicBlock(Record[OpNum]));6670else6671Args.push_back(getValue(Record, OpNum, NextValueNo,6672FTy->getParamType(i), ArgTyID, CurBB));6673ArgTyIDs.push_back(ArgTyID);6674if (!Args.back())6675return error("Invalid record");6676}66776678// Read type/value pairs for varargs params.6679if (!FTy->isVarArg()) {6680if (OpNum != Record.size())6681return error("Invalid record");6682} else {6683while (OpNum != Record.size()) {6684Value *Op;6685unsigned OpTypeID;6686if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))6687return error("Invalid record");6688Args.push_back(Op);6689ArgTyIDs.push_back(OpTypeID);6690}6691}66926693// Upgrade the bundles if needed.6694if (!OperandBundles.empty())6695UpgradeOperandBundles(OperandBundles);66966697I = CallInst::Create(FTy, Callee, Args, OperandBundles);6698ResTypeID = getContainedTypeID(FTyID);6699OperandBundles.clear();6700InstructionList.push_back(I);6701cast<CallInst>(I)->setCallingConv(6702static_cast<CallingConv::ID>((0x7ff & CCInfo) >> bitc::CALL_CCONV));6703CallInst::TailCallKind TCK = CallInst::TCK_None;6704if (CCInfo & (1 << bitc::CALL_TAIL))6705TCK = CallInst::TCK_Tail;6706if (CCInfo & (1 << bitc::CALL_MUSTTAIL))6707TCK = CallInst::TCK_MustTail;6708if (CCInfo & (1 << bitc::CALL_NOTAIL))6709TCK = CallInst::TCK_NoTail;6710cast<CallInst>(I)->setTailCallKind(TCK);6711cast<CallInst>(I)->setAttributes(PAL);6712if (isa<DbgInfoIntrinsic>(I))6713SeenDebugIntrinsic = true;6714if (Error Err = propagateAttributeTypes(cast<CallBase>(I), ArgTyIDs)) {6715I->deleteValue();6716return Err;6717}6718if (FMF.any()) {6719if (!isa<FPMathOperator>(I))6720return error("Fast-math-flags specified for call without "6721"floating-point scalar or vector return type");6722I->setFastMathFlags(FMF);6723}6724break;6725}6726case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]6727if (Record.size() < 3)6728return error("Invalid record");6729unsigned OpTyID = Record[0];6730Type *OpTy = getTypeByID(OpTyID);6731Value *Op = getValue(Record, 1, NextValueNo, OpTy, OpTyID, CurBB);6732ResTypeID = Record[2];6733Type *ResTy = getTypeByID(ResTypeID);6734if (!OpTy || !Op || !ResTy)6735return error("Invalid record");6736I = new VAArgInst(Op, ResTy);6737InstructionList.push_back(I);6738break;6739}67406741case bitc::FUNC_CODE_OPERAND_BUNDLE: {6742// A call or an invoke can be optionally prefixed with some variable6743// number of operand bundle blocks. These blocks are read into6744// OperandBundles and consumed at the next call or invoke instruction.67456746if (Record.empty() || Record[0] >= BundleTags.size())6747return error("Invalid record");67486749std::vector<Value *> Inputs;67506751unsigned OpNum = 1;6752while (OpNum != Record.size()) {6753Value *Op;6754unsigned OpTypeID;6755if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))6756return error("Invalid record");6757Inputs.push_back(Op);6758}67596760OperandBundles.emplace_back(BundleTags[Record[0]], std::move(Inputs));6761continue;6762}67636764case bitc::FUNC_CODE_INST_FREEZE: { // FREEZE: [opty,opval]6765unsigned OpNum = 0;6766Value *Op = nullptr;6767unsigned OpTypeID;6768if (getValueTypePair(Record, OpNum, NextValueNo, Op, OpTypeID, CurBB))6769return error("Invalid record");6770if (OpNum != Record.size())6771return error("Invalid record");67726773I = new FreezeInst(Op);6774ResTypeID = OpTypeID;6775InstructionList.push_back(I);6776break;6777}6778}67796780// Add instruction to end of current BB. If there is no current BB, reject6781// this file.6782if (!CurBB) {6783I->deleteValue();6784return error("Invalid instruction with no BB");6785}6786if (!OperandBundles.empty()) {6787I->deleteValue();6788return error("Operand bundles found with no consumer");6789}6790I->insertInto(CurBB, CurBB->end());67916792// If this was a terminator instruction, move to the next block.6793if (I->isTerminator()) {6794++CurBBNo;6795CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;6796}67976798// Non-void values get registered in the value table for future use.6799if (!I->getType()->isVoidTy()) {6800assert(I->getType() == getTypeByID(ResTypeID) &&6801"Incorrect result type ID");6802if (Error Err = ValueList.assignValue(NextValueNo++, I, ResTypeID))6803return Err;6804}6805}68066807OutOfRecordLoop:68086809if (!OperandBundles.empty())6810return error("Operand bundles found with no consumer");68116812// Check the function list for unresolved values.6813if (Argument *A = dyn_cast<Argument>(ValueList.back())) {6814if (!A->getParent()) {6815// We found at least one unresolved value. Nuke them all to avoid leaks.6816for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){6817if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {6818A->replaceAllUsesWith(PoisonValue::get(A->getType()));6819delete A;6820}6821}6822return error("Never resolved value found in function");6823}6824}68256826// Unexpected unresolved metadata about to be dropped.6827if (MDLoader->hasFwdRefs())6828return error("Invalid function metadata: outgoing forward refs");68296830if (PhiConstExprBB)6831PhiConstExprBB->eraseFromParent();68326833for (const auto &Pair : ConstExprEdgeBBs) {6834BasicBlock *From = Pair.first.first;6835BasicBlock *To = Pair.first.second;6836BasicBlock *EdgeBB = Pair.second;6837BranchInst::Create(To, EdgeBB);6838From->getTerminator()->replaceSuccessorWith(To, EdgeBB);6839To->replacePhiUsesWith(From, EdgeBB);6840EdgeBB->moveBefore(To);6841}68426843// Trim the value list down to the size it was before we parsed this function.6844ValueList.shrinkTo(ModuleValueListSize);6845MDLoader->shrinkTo(ModuleMDLoaderSize);6846std::vector<BasicBlock*>().swap(FunctionBBs);6847return Error::success();6848}68496850/// Find the function body in the bitcode stream6851Error BitcodeReader::findFunctionInStream(6852Function *F,6853DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {6854while (DeferredFunctionInfoIterator->second == 0) {6855// This is the fallback handling for the old format bitcode that6856// didn't contain the function index in the VST, or when we have6857// an anonymous function which would not have a VST entry.6858// Assert that we have one of those two cases.6859assert(VSTOffset == 0 || !F->hasName());6860// Parse the next body in the stream and set its position in the6861// DeferredFunctionInfo map.6862if (Error Err = rememberAndSkipFunctionBodies())6863return Err;6864}6865return Error::success();6866}68676868SyncScope::ID BitcodeReader::getDecodedSyncScopeID(unsigned Val) {6869if (Val == SyncScope::SingleThread || Val == SyncScope::System)6870return SyncScope::ID(Val);6871if (Val >= SSIDs.size())6872return SyncScope::System; // Map unknown synchronization scopes to system.6873return SSIDs[Val];6874}68756876//===----------------------------------------------------------------------===//6877// GVMaterializer implementation6878//===----------------------------------------------------------------------===//68796880Error BitcodeReader::materialize(GlobalValue *GV) {6881Function *F = dyn_cast<Function>(GV);6882// If it's not a function or is already material, ignore the request.6883if (!F || !F->isMaterializable())6884return Error::success();68856886DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);6887assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");6888// If its position is recorded as 0, its body is somewhere in the stream6889// but we haven't seen it yet.6890if (DFII->second == 0)6891if (Error Err = findFunctionInStream(F, DFII))6892return Err;68936894// Materialize metadata before parsing any function bodies.6895if (Error Err = materializeMetadata())6896return Err;68976898// Move the bit stream to the saved position of the deferred function body.6899if (Error JumpFailed = Stream.JumpToBit(DFII->second))6900return JumpFailed;69016902// Regardless of the debug info format we want to end up in, we need6903// IsNewDbgInfoFormat=true to construct any debug records seen in the bitcode.6904F->IsNewDbgInfoFormat = true;69056906if (Error Err = parseFunctionBody(F))6907return Err;6908F->setIsMaterializable(false);69096910// All parsed Functions should load into the debug info format dictated by the6911// Module, unless we're attempting to preserve the input debug info format.6912if (SeenDebugIntrinsic && SeenDebugRecord)6913return error("Mixed debug intrinsics and debug records in bitcode module!");6914if (PreserveInputDbgFormat == cl::boolOrDefault::BOU_TRUE) {6915bool SeenAnyDebugInfo = SeenDebugIntrinsic || SeenDebugRecord;6916bool NewDbgInfoFormatDesired =6917SeenAnyDebugInfo ? SeenDebugRecord : F->getParent()->IsNewDbgInfoFormat;6918if (SeenAnyDebugInfo) {6919UseNewDbgInfoFormat = SeenDebugRecord;6920WriteNewDbgInfoFormatToBitcode = SeenDebugRecord;6921WriteNewDbgInfoFormat = SeenDebugRecord;6922}6923// If the module's debug info format doesn't match the observed input6924// format, then set its format now; we don't need to call the conversion6925// function because there must be no existing intrinsics to convert.6926// Otherwise, just set the format on this function now.6927if (NewDbgInfoFormatDesired != F->getParent()->IsNewDbgInfoFormat)6928F->getParent()->setNewDbgInfoFormatFlag(NewDbgInfoFormatDesired);6929else6930F->setNewDbgInfoFormatFlag(NewDbgInfoFormatDesired);6931} else {6932// If we aren't preserving formats, we use the Module flag to get our6933// desired format instead of reading flags, in case we are lazy-loading and6934// the format of the module has been changed since it was set by the flags.6935// We only need to convert debug info here if we have debug records but6936// desire the intrinsic format; everything else is a no-op or handled by the6937// autoupgrader.6938bool ModuleIsNewDbgInfoFormat = F->getParent()->IsNewDbgInfoFormat;6939if (ModuleIsNewDbgInfoFormat || !SeenDebugRecord)6940F->setNewDbgInfoFormatFlag(ModuleIsNewDbgInfoFormat);6941else6942F->setIsNewDbgInfoFormat(ModuleIsNewDbgInfoFormat);6943}69446945if (StripDebugInfo)6946stripDebugInfo(*F);69476948// Upgrade any old intrinsic calls in the function.6949for (auto &I : UpgradedIntrinsics) {6950for (User *U : llvm::make_early_inc_range(I.first->materialized_users()))6951if (CallInst *CI = dyn_cast<CallInst>(U))6952UpgradeIntrinsicCall(CI, I.second);6953}69546955// Finish fn->subprogram upgrade for materialized functions.6956if (DISubprogram *SP = MDLoader->lookupSubprogramForFunction(F))6957F->setSubprogram(SP);69586959// Check if the TBAA Metadata are valid, otherwise we will need to strip them.6960if (!MDLoader->isStrippingTBAA()) {6961for (auto &I : instructions(F)) {6962MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa);6963if (!TBAA || TBAAVerifyHelper.visitTBAAMetadata(I, TBAA))6964continue;6965MDLoader->setStripTBAA(true);6966stripTBAA(F->getParent());6967}6968}69696970for (auto &I : instructions(F)) {6971// "Upgrade" older incorrect branch weights by dropping them.6972if (auto *MD = I.getMetadata(LLVMContext::MD_prof)) {6973if (MD->getOperand(0) != nullptr && isa<MDString>(MD->getOperand(0))) {6974MDString *MDS = cast<MDString>(MD->getOperand(0));6975StringRef ProfName = MDS->getString();6976// Check consistency of !prof branch_weights metadata.6977if (ProfName != "branch_weights")6978continue;6979unsigned ExpectedNumOperands = 0;6980if (BranchInst *BI = dyn_cast<BranchInst>(&I))6981ExpectedNumOperands = BI->getNumSuccessors();6982else if (SwitchInst *SI = dyn_cast<SwitchInst>(&I))6983ExpectedNumOperands = SI->getNumSuccessors();6984else if (isa<CallInst>(&I))6985ExpectedNumOperands = 1;6986else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(&I))6987ExpectedNumOperands = IBI->getNumDestinations();6988else if (isa<SelectInst>(&I))6989ExpectedNumOperands = 2;6990else6991continue; // ignore and continue.69926993unsigned Offset = getBranchWeightOffset(MD);69946995// If branch weight doesn't match, just strip branch weight.6996if (MD->getNumOperands() != Offset + ExpectedNumOperands)6997I.setMetadata(LLVMContext::MD_prof, nullptr);6998}6999}70007001// Remove incompatible attributes on function calls.7002if (auto *CI = dyn_cast<CallBase>(&I)) {7003CI->removeRetAttrs(AttributeFuncs::typeIncompatible(7004CI->getFunctionType()->getReturnType()));70057006for (unsigned ArgNo = 0; ArgNo < CI->arg_size(); ++ArgNo)7007CI->removeParamAttrs(ArgNo, AttributeFuncs::typeIncompatible(7008CI->getArgOperand(ArgNo)->getType()));7009}7010}70117012// Look for functions that rely on old function attribute behavior.7013UpgradeFunctionAttributes(*F);70147015// Bring in any functions that this function forward-referenced via7016// blockaddresses.7017return materializeForwardReferencedFunctions();7018}70197020Error BitcodeReader::materializeModule() {7021if (Error Err = materializeMetadata())7022return Err;70237024// Promise to materialize all forward references.7025WillMaterializeAllForwardRefs = true;70267027// Iterate over the module, deserializing any functions that are still on7028// disk.7029for (Function &F : *TheModule) {7030if (Error Err = materialize(&F))7031return Err;7032}7033// At this point, if there are any function bodies, parse the rest of7034// the bits in the module past the last function block we have recorded7035// through either lazy scanning or the VST.7036if (LastFunctionBlockBit || NextUnreadBit)7037if (Error Err = parseModule(LastFunctionBlockBit > NextUnreadBit7038? LastFunctionBlockBit7039: NextUnreadBit))7040return Err;70417042// Check that all block address forward references got resolved (as we7043// promised above).7044if (!BasicBlockFwdRefs.empty())7045return error("Never resolved function from blockaddress");70467047// Upgrade any intrinsic calls that slipped through (should not happen!) and7048// delete the old functions to clean up. We can't do this unless the entire7049// module is materialized because there could always be another function body7050// with calls to the old function.7051for (auto &I : UpgradedIntrinsics) {7052for (auto *U : I.first->users()) {7053if (CallInst *CI = dyn_cast<CallInst>(U))7054UpgradeIntrinsicCall(CI, I.second);7055}7056if (!I.first->use_empty())7057I.first->replaceAllUsesWith(I.second);7058I.first->eraseFromParent();7059}7060UpgradedIntrinsics.clear();70617062UpgradeDebugInfo(*TheModule);70637064UpgradeModuleFlags(*TheModule);70657066UpgradeARCRuntime(*TheModule);70677068return Error::success();7069}70707071std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {7072return IdentifiedStructTypes;7073}70747075ModuleSummaryIndexBitcodeReader::ModuleSummaryIndexBitcodeReader(7076BitstreamCursor Cursor, StringRef Strtab, ModuleSummaryIndex &TheIndex,7077StringRef ModulePath, std::function<bool(GlobalValue::GUID)> IsPrevailing)7078: BitcodeReaderBase(std::move(Cursor), Strtab), TheIndex(TheIndex),7079ModulePath(ModulePath), IsPrevailing(IsPrevailing) {}70807081void ModuleSummaryIndexBitcodeReader::addThisModule() {7082TheIndex.addModule(ModulePath);7083}70847085ModuleSummaryIndex::ModuleInfo *7086ModuleSummaryIndexBitcodeReader::getThisModule() {7087return TheIndex.getModule(ModulePath);7088}70897090template <bool AllowNullValueInfo>7091std::tuple<ValueInfo, GlobalValue::GUID, GlobalValue::GUID>7092ModuleSummaryIndexBitcodeReader::getValueInfoFromValueId(unsigned ValueId) {7093auto VGI = ValueIdToValueInfoMap[ValueId];7094// We can have a null value info for memprof callsite info records in7095// distributed ThinLTO index files when the callee function summary is not7096// included in the index. The bitcode writer records 0 in that case,7097// and the caller of this helper will set AllowNullValueInfo to true.7098assert(AllowNullValueInfo || std::get<0>(VGI));7099return VGI;7100}71017102void ModuleSummaryIndexBitcodeReader::setValueGUID(7103uint64_t ValueID, StringRef ValueName, GlobalValue::LinkageTypes Linkage,7104StringRef SourceFileName) {7105std::string GlobalId =7106GlobalValue::getGlobalIdentifier(ValueName, Linkage, SourceFileName);7107auto ValueGUID = GlobalValue::getGUID(GlobalId);7108auto OriginalNameID = ValueGUID;7109if (GlobalValue::isLocalLinkage(Linkage))7110OriginalNameID = GlobalValue::getGUID(ValueName);7111if (PrintSummaryGUIDs)7112dbgs() << "GUID " << ValueGUID << "(" << OriginalNameID << ") is "7113<< ValueName << "\n";71147115// UseStrtab is false for legacy summary formats and value names are7116// created on stack. In that case we save the name in a string saver in7117// the index so that the value name can be recorded.7118ValueIdToValueInfoMap[ValueID] = std::make_tuple(7119TheIndex.getOrInsertValueInfo(7120ValueGUID, UseStrtab ? ValueName : TheIndex.saveString(ValueName)),7121OriginalNameID, ValueGUID);7122}71237124// Specialized value symbol table parser used when reading module index7125// blocks where we don't actually create global values. The parsed information7126// is saved in the bitcode reader for use when later parsing summaries.7127Error ModuleSummaryIndexBitcodeReader::parseValueSymbolTable(7128uint64_t Offset,7129DenseMap<unsigned, GlobalValue::LinkageTypes> &ValueIdToLinkageMap) {7130// With a strtab the VST is not required to parse the summary.7131if (UseStrtab)7132return Error::success();71337134assert(Offset > 0 && "Expected non-zero VST offset");7135Expected<uint64_t> MaybeCurrentBit = jumpToValueSymbolTable(Offset, Stream);7136if (!MaybeCurrentBit)7137return MaybeCurrentBit.takeError();7138uint64_t CurrentBit = MaybeCurrentBit.get();71397140if (Error Err = Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))7141return Err;71427143SmallVector<uint64_t, 64> Record;71447145// Read all the records for this value table.7146SmallString<128> ValueName;71477148while (true) {7149Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();7150if (!MaybeEntry)7151return MaybeEntry.takeError();7152BitstreamEntry Entry = MaybeEntry.get();71537154switch (Entry.Kind) {7155case BitstreamEntry::SubBlock: // Handled for us already.7156case BitstreamEntry::Error:7157return error("Malformed block");7158case BitstreamEntry::EndBlock:7159// Done parsing VST, jump back to wherever we came from.7160if (Error JumpFailed = Stream.JumpToBit(CurrentBit))7161return JumpFailed;7162return Error::success();7163case BitstreamEntry::Record:7164// The interesting case.7165break;7166}71677168// Read a record.7169Record.clear();7170Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);7171if (!MaybeRecord)7172return MaybeRecord.takeError();7173switch (MaybeRecord.get()) {7174default: // Default behavior: ignore (e.g. VST_CODE_BBENTRY records).7175break;7176case bitc::VST_CODE_ENTRY: { // VST_CODE_ENTRY: [valueid, namechar x N]7177if (convertToString(Record, 1, ValueName))7178return error("Invalid record");7179unsigned ValueID = Record[0];7180assert(!SourceFileName.empty());7181auto VLI = ValueIdToLinkageMap.find(ValueID);7182assert(VLI != ValueIdToLinkageMap.end() &&7183"No linkage found for VST entry?");7184auto Linkage = VLI->second;7185setValueGUID(ValueID, ValueName, Linkage, SourceFileName);7186ValueName.clear();7187break;7188}7189case bitc::VST_CODE_FNENTRY: {7190// VST_CODE_FNENTRY: [valueid, offset, namechar x N]7191if (convertToString(Record, 2, ValueName))7192return error("Invalid record");7193unsigned ValueID = Record[0];7194assert(!SourceFileName.empty());7195auto VLI = ValueIdToLinkageMap.find(ValueID);7196assert(VLI != ValueIdToLinkageMap.end() &&7197"No linkage found for VST entry?");7198auto Linkage = VLI->second;7199setValueGUID(ValueID, ValueName, Linkage, SourceFileName);7200ValueName.clear();7201break;7202}7203case bitc::VST_CODE_COMBINED_ENTRY: {7204// VST_CODE_COMBINED_ENTRY: [valueid, refguid]7205unsigned ValueID = Record[0];7206GlobalValue::GUID RefGUID = Record[1];7207// The "original name", which is the second value of the pair will be7208// overriden later by a FS_COMBINED_ORIGINAL_NAME in the combined index.7209ValueIdToValueInfoMap[ValueID] = std::make_tuple(7210TheIndex.getOrInsertValueInfo(RefGUID), RefGUID, RefGUID);7211break;7212}7213}7214}7215}72167217// Parse just the blocks needed for building the index out of the module.7218// At the end of this routine the module Index is populated with a map7219// from global value id to GlobalValueSummary objects.7220Error ModuleSummaryIndexBitcodeReader::parseModule() {7221if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))7222return Err;72237224SmallVector<uint64_t, 64> Record;7225DenseMap<unsigned, GlobalValue::LinkageTypes> ValueIdToLinkageMap;7226unsigned ValueId = 0;72277228// Read the index for this module.7229while (true) {7230Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();7231if (!MaybeEntry)7232return MaybeEntry.takeError();7233llvm::BitstreamEntry Entry = MaybeEntry.get();72347235switch (Entry.Kind) {7236case BitstreamEntry::Error:7237return error("Malformed block");7238case BitstreamEntry::EndBlock:7239return Error::success();72407241case BitstreamEntry::SubBlock:7242switch (Entry.ID) {7243default: // Skip unknown content.7244if (Error Err = Stream.SkipBlock())7245return Err;7246break;7247case bitc::BLOCKINFO_BLOCK_ID:7248// Need to parse these to get abbrev ids (e.g. for VST)7249if (Error Err = readBlockInfo())7250return Err;7251break;7252case bitc::VALUE_SYMTAB_BLOCK_ID:7253// Should have been parsed earlier via VSTOffset, unless there7254// is no summary section.7255assert(((SeenValueSymbolTable && VSTOffset > 0) ||7256!SeenGlobalValSummary) &&7257"Expected early VST parse via VSTOffset record");7258if (Error Err = Stream.SkipBlock())7259return Err;7260break;7261case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:7262case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:7263// Add the module if it is a per-module index (has a source file name).7264if (!SourceFileName.empty())7265addThisModule();7266assert(!SeenValueSymbolTable &&7267"Already read VST when parsing summary block?");7268// We might not have a VST if there were no values in the7269// summary. An empty summary block generated when we are7270// performing ThinLTO compiles so we don't later invoke7271// the regular LTO process on them.7272if (VSTOffset > 0) {7273if (Error Err = parseValueSymbolTable(VSTOffset, ValueIdToLinkageMap))7274return Err;7275SeenValueSymbolTable = true;7276}7277SeenGlobalValSummary = true;7278if (Error Err = parseEntireSummary(Entry.ID))7279return Err;7280break;7281case bitc::MODULE_STRTAB_BLOCK_ID:7282if (Error Err = parseModuleStringTable())7283return Err;7284break;7285}7286continue;72877288case BitstreamEntry::Record: {7289Record.clear();7290Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);7291if (!MaybeBitCode)7292return MaybeBitCode.takeError();7293switch (MaybeBitCode.get()) {7294default:7295break; // Default behavior, ignore unknown content.7296case bitc::MODULE_CODE_VERSION: {7297if (Error Err = parseVersionRecord(Record).takeError())7298return Err;7299break;7300}7301/// MODULE_CODE_SOURCE_FILENAME: [namechar x N]7302case bitc::MODULE_CODE_SOURCE_FILENAME: {7303SmallString<128> ValueName;7304if (convertToString(Record, 0, ValueName))7305return error("Invalid record");7306SourceFileName = ValueName.c_str();7307break;7308}7309/// MODULE_CODE_HASH: [5*i32]7310case bitc::MODULE_CODE_HASH: {7311if (Record.size() != 5)7312return error("Invalid hash length " + Twine(Record.size()).str());7313auto &Hash = getThisModule()->second;7314int Pos = 0;7315for (auto &Val : Record) {7316assert(!(Val >> 32) && "Unexpected high bits set");7317Hash[Pos++] = Val;7318}7319break;7320}7321/// MODULE_CODE_VSTOFFSET: [offset]7322case bitc::MODULE_CODE_VSTOFFSET:7323if (Record.empty())7324return error("Invalid record");7325// Note that we subtract 1 here because the offset is relative to one7326// word before the start of the identification or module block, which7327// was historically always the start of the regular bitcode header.7328VSTOffset = Record[0] - 1;7329break;7330// v1 GLOBALVAR: [pointer type, isconst, initid, linkage, ...]7331// v1 FUNCTION: [type, callingconv, isproto, linkage, ...]7332// v1 ALIAS: [alias type, addrspace, aliasee val#, linkage, ...]7333// v2: [strtab offset, strtab size, v1]7334case bitc::MODULE_CODE_GLOBALVAR:7335case bitc::MODULE_CODE_FUNCTION:7336case bitc::MODULE_CODE_ALIAS: {7337StringRef Name;7338ArrayRef<uint64_t> GVRecord;7339std::tie(Name, GVRecord) = readNameFromStrtab(Record);7340if (GVRecord.size() <= 3)7341return error("Invalid record");7342uint64_t RawLinkage = GVRecord[3];7343GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);7344if (!UseStrtab) {7345ValueIdToLinkageMap[ValueId++] = Linkage;7346break;7347}73487349setValueGUID(ValueId++, Name, Linkage, SourceFileName);7350break;7351}7352}7353}7354continue;7355}7356}7357}73587359std::vector<ValueInfo>7360ModuleSummaryIndexBitcodeReader::makeRefList(ArrayRef<uint64_t> Record) {7361std::vector<ValueInfo> Ret;7362Ret.reserve(Record.size());7363for (uint64_t RefValueId : Record)7364Ret.push_back(std::get<0>(getValueInfoFromValueId(RefValueId)));7365return Ret;7366}73677368std::vector<FunctionSummary::EdgeTy>7369ModuleSummaryIndexBitcodeReader::makeCallList(ArrayRef<uint64_t> Record,7370bool IsOldProfileFormat,7371bool HasProfile, bool HasRelBF) {7372std::vector<FunctionSummary::EdgeTy> Ret;7373// In the case of new profile formats, there are two Record entries per7374// Edge. Otherwise, conservatively reserve up to Record.size.7375if (!IsOldProfileFormat && (HasProfile || HasRelBF))7376Ret.reserve(Record.size() / 2);7377else7378Ret.reserve(Record.size());73797380for (unsigned I = 0, E = Record.size(); I != E; ++I) {7381CalleeInfo::HotnessType Hotness = CalleeInfo::HotnessType::Unknown;7382bool HasTailCall = false;7383uint64_t RelBF = 0;7384ValueInfo Callee = std::get<0>(getValueInfoFromValueId(Record[I]));7385if (IsOldProfileFormat) {7386I += 1; // Skip old callsitecount field7387if (HasProfile)7388I += 1; // Skip old profilecount field7389} else if (HasProfile)7390std::tie(Hotness, HasTailCall) =7391getDecodedHotnessCallEdgeInfo(Record[++I]);7392else if (HasRelBF)7393getDecodedRelBFCallEdgeInfo(Record[++I], RelBF, HasTailCall);7394Ret.push_back(FunctionSummary::EdgeTy{7395Callee, CalleeInfo(Hotness, HasTailCall, RelBF)});7396}7397return Ret;7398}73997400static void7401parseWholeProgramDevirtResolutionByArg(ArrayRef<uint64_t> Record, size_t &Slot,7402WholeProgramDevirtResolution &Wpd) {7403uint64_t ArgNum = Record[Slot++];7404WholeProgramDevirtResolution::ByArg &B =7405Wpd.ResByArg[{Record.begin() + Slot, Record.begin() + Slot + ArgNum}];7406Slot += ArgNum;74077408B.TheKind =7409static_cast<WholeProgramDevirtResolution::ByArg::Kind>(Record[Slot++]);7410B.Info = Record[Slot++];7411B.Byte = Record[Slot++];7412B.Bit = Record[Slot++];7413}74147415static void parseWholeProgramDevirtResolution(ArrayRef<uint64_t> Record,7416StringRef Strtab, size_t &Slot,7417TypeIdSummary &TypeId) {7418uint64_t Id = Record[Slot++];7419WholeProgramDevirtResolution &Wpd = TypeId.WPDRes[Id];74207421Wpd.TheKind = static_cast<WholeProgramDevirtResolution::Kind>(Record[Slot++]);7422Wpd.SingleImplName = {Strtab.data() + Record[Slot],7423static_cast<size_t>(Record[Slot + 1])};7424Slot += 2;74257426uint64_t ResByArgNum = Record[Slot++];7427for (uint64_t I = 0; I != ResByArgNum; ++I)7428parseWholeProgramDevirtResolutionByArg(Record, Slot, Wpd);7429}74307431static void parseTypeIdSummaryRecord(ArrayRef<uint64_t> Record,7432StringRef Strtab,7433ModuleSummaryIndex &TheIndex) {7434size_t Slot = 0;7435TypeIdSummary &TypeId = TheIndex.getOrInsertTypeIdSummary(7436{Strtab.data() + Record[Slot], static_cast<size_t>(Record[Slot + 1])});7437Slot += 2;74387439TypeId.TTRes.TheKind = static_cast<TypeTestResolution::Kind>(Record[Slot++]);7440TypeId.TTRes.SizeM1BitWidth = Record[Slot++];7441TypeId.TTRes.AlignLog2 = Record[Slot++];7442TypeId.TTRes.SizeM1 = Record[Slot++];7443TypeId.TTRes.BitMask = Record[Slot++];7444TypeId.TTRes.InlineBits = Record[Slot++];74457446while (Slot < Record.size())7447parseWholeProgramDevirtResolution(Record, Strtab, Slot, TypeId);7448}74497450std::vector<FunctionSummary::ParamAccess>7451ModuleSummaryIndexBitcodeReader::parseParamAccesses(ArrayRef<uint64_t> Record) {7452auto ReadRange = [&]() {7453APInt Lower(FunctionSummary::ParamAccess::RangeWidth,7454BitcodeReader::decodeSignRotatedValue(Record.front()));7455Record = Record.drop_front();7456APInt Upper(FunctionSummary::ParamAccess::RangeWidth,7457BitcodeReader::decodeSignRotatedValue(Record.front()));7458Record = Record.drop_front();7459ConstantRange Range{Lower, Upper};7460assert(!Range.isFullSet());7461assert(!Range.isUpperSignWrapped());7462return Range;7463};74647465std::vector<FunctionSummary::ParamAccess> PendingParamAccesses;7466while (!Record.empty()) {7467PendingParamAccesses.emplace_back();7468FunctionSummary::ParamAccess &ParamAccess = PendingParamAccesses.back();7469ParamAccess.ParamNo = Record.front();7470Record = Record.drop_front();7471ParamAccess.Use = ReadRange();7472ParamAccess.Calls.resize(Record.front());7473Record = Record.drop_front();7474for (auto &Call : ParamAccess.Calls) {7475Call.ParamNo = Record.front();7476Record = Record.drop_front();7477Call.Callee = std::get<0>(getValueInfoFromValueId(Record.front()));7478Record = Record.drop_front();7479Call.Offsets = ReadRange();7480}7481}7482return PendingParamAccesses;7483}74847485void ModuleSummaryIndexBitcodeReader::parseTypeIdCompatibleVtableInfo(7486ArrayRef<uint64_t> Record, size_t &Slot,7487TypeIdCompatibleVtableInfo &TypeId) {7488uint64_t Offset = Record[Slot++];7489ValueInfo Callee = std::get<0>(getValueInfoFromValueId(Record[Slot++]));7490TypeId.push_back({Offset, Callee});7491}74927493void ModuleSummaryIndexBitcodeReader::parseTypeIdCompatibleVtableSummaryRecord(7494ArrayRef<uint64_t> Record) {7495size_t Slot = 0;7496TypeIdCompatibleVtableInfo &TypeId =7497TheIndex.getOrInsertTypeIdCompatibleVtableSummary(7498{Strtab.data() + Record[Slot],7499static_cast<size_t>(Record[Slot + 1])});7500Slot += 2;75017502while (Slot < Record.size())7503parseTypeIdCompatibleVtableInfo(Record, Slot, TypeId);7504}75057506static void setSpecialRefs(std::vector<ValueInfo> &Refs, unsigned ROCnt,7507unsigned WOCnt) {7508// Readonly and writeonly refs are in the end of the refs list.7509assert(ROCnt + WOCnt <= Refs.size());7510unsigned FirstWORef = Refs.size() - WOCnt;7511unsigned RefNo = FirstWORef - ROCnt;7512for (; RefNo < FirstWORef; ++RefNo)7513Refs[RefNo].setReadOnly();7514for (; RefNo < Refs.size(); ++RefNo)7515Refs[RefNo].setWriteOnly();7516}75177518// Eagerly parse the entire summary block. This populates the GlobalValueSummary7519// objects in the index.7520Error ModuleSummaryIndexBitcodeReader::parseEntireSummary(unsigned ID) {7521if (Error Err = Stream.EnterSubBlock(ID))7522return Err;7523SmallVector<uint64_t, 64> Record;75247525// Parse version7526{7527Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();7528if (!MaybeEntry)7529return MaybeEntry.takeError();7530BitstreamEntry Entry = MaybeEntry.get();75317532if (Entry.Kind != BitstreamEntry::Record)7533return error("Invalid Summary Block: record for version expected");7534Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);7535if (!MaybeRecord)7536return MaybeRecord.takeError();7537if (MaybeRecord.get() != bitc::FS_VERSION)7538return error("Invalid Summary Block: version expected");7539}7540const uint64_t Version = Record[0];7541const bool IsOldProfileFormat = Version == 1;7542if (Version < 1 || Version > ModuleSummaryIndex::BitcodeSummaryVersion)7543return error("Invalid summary version " + Twine(Version) +7544". Version should be in the range [1-" +7545Twine(ModuleSummaryIndex::BitcodeSummaryVersion) +7546"].");7547Record.clear();75487549// Keep around the last seen summary to be used when we see an optional7550// "OriginalName" attachement.7551GlobalValueSummary *LastSeenSummary = nullptr;7552GlobalValue::GUID LastSeenGUID = 0;75537554// We can expect to see any number of type ID information records before7555// each function summary records; these variables store the information7556// collected so far so that it can be used to create the summary object.7557std::vector<GlobalValue::GUID> PendingTypeTests;7558std::vector<FunctionSummary::VFuncId> PendingTypeTestAssumeVCalls,7559PendingTypeCheckedLoadVCalls;7560std::vector<FunctionSummary::ConstVCall> PendingTypeTestAssumeConstVCalls,7561PendingTypeCheckedLoadConstVCalls;7562std::vector<FunctionSummary::ParamAccess> PendingParamAccesses;75637564std::vector<CallsiteInfo> PendingCallsites;7565std::vector<AllocInfo> PendingAllocs;75667567while (true) {7568Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();7569if (!MaybeEntry)7570return MaybeEntry.takeError();7571BitstreamEntry Entry = MaybeEntry.get();75727573switch (Entry.Kind) {7574case BitstreamEntry::SubBlock: // Handled for us already.7575case BitstreamEntry::Error:7576return error("Malformed block");7577case BitstreamEntry::EndBlock:7578return Error::success();7579case BitstreamEntry::Record:7580// The interesting case.7581break;7582}75837584// Read a record. The record format depends on whether this7585// is a per-module index or a combined index file. In the per-module7586// case the records contain the associated value's ID for correlation7587// with VST entries. In the combined index the correlation is done7588// via the bitcode offset of the summary records (which were saved7589// in the combined index VST entries). The records also contain7590// information used for ThinLTO renaming and importing.7591Record.clear();7592Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);7593if (!MaybeBitCode)7594return MaybeBitCode.takeError();7595switch (unsigned BitCode = MaybeBitCode.get()) {7596default: // Default behavior: ignore.7597break;7598case bitc::FS_FLAGS: { // [flags]7599TheIndex.setFlags(Record[0]);7600break;7601}7602case bitc::FS_VALUE_GUID: { // [valueid, refguid]7603uint64_t ValueID = Record[0];7604GlobalValue::GUID RefGUID = Record[1];7605ValueIdToValueInfoMap[ValueID] = std::make_tuple(7606TheIndex.getOrInsertValueInfo(RefGUID), RefGUID, RefGUID);7607break;7608}7609// FS_PERMODULE is legacy and does not have support for the tail call flag.7610// FS_PERMODULE: [valueid, flags, instcount, fflags, numrefs,7611// numrefs x valueid, n x (valueid)]7612// FS_PERMODULE_PROFILE: [valueid, flags, instcount, fflags, numrefs,7613// numrefs x valueid,7614// n x (valueid, hotness+tailcall flags)]7615// FS_PERMODULE_RELBF: [valueid, flags, instcount, fflags, numrefs,7616// numrefs x valueid,7617// n x (valueid, relblockfreq+tailcall)]7618case bitc::FS_PERMODULE:7619case bitc::FS_PERMODULE_RELBF:7620case bitc::FS_PERMODULE_PROFILE: {7621unsigned ValueID = Record[0];7622uint64_t RawFlags = Record[1];7623unsigned InstCount = Record[2];7624uint64_t RawFunFlags = 0;7625unsigned NumRefs = Record[3];7626unsigned NumRORefs = 0, NumWORefs = 0;7627int RefListStartIndex = 4;7628if (Version >= 4) {7629RawFunFlags = Record[3];7630NumRefs = Record[4];7631RefListStartIndex = 5;7632if (Version >= 5) {7633NumRORefs = Record[5];7634RefListStartIndex = 6;7635if (Version >= 7) {7636NumWORefs = Record[6];7637RefListStartIndex = 7;7638}7639}7640}76417642auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7643// The module path string ref set in the summary must be owned by the7644// index's module string table. Since we don't have a module path7645// string table section in the per-module index, we create a single7646// module path string table entry with an empty (0) ID to take7647// ownership.7648int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;7649assert(Record.size() >= RefListStartIndex + NumRefs &&7650"Record size inconsistent with number of references");7651std::vector<ValueInfo> Refs = makeRefList(7652ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));7653bool HasProfile = (BitCode == bitc::FS_PERMODULE_PROFILE);7654bool HasRelBF = (BitCode == bitc::FS_PERMODULE_RELBF);7655std::vector<FunctionSummary::EdgeTy> Calls = makeCallList(7656ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),7657IsOldProfileFormat, HasProfile, HasRelBF);7658setSpecialRefs(Refs, NumRORefs, NumWORefs);7659auto VIAndOriginalGUID = getValueInfoFromValueId(ValueID);7660// In order to save memory, only record the memprof summaries if this is7661// the prevailing copy of a symbol. The linker doesn't resolve local7662// linkage values so don't check whether those are prevailing.7663auto LT = (GlobalValue::LinkageTypes)Flags.Linkage;7664if (IsPrevailing &&7665!GlobalValue::isLocalLinkage(LT) &&7666!IsPrevailing(std::get<2>(VIAndOriginalGUID))) {7667PendingCallsites.clear();7668PendingAllocs.clear();7669}7670auto FS = std::make_unique<FunctionSummary>(7671Flags, InstCount, getDecodedFFlags(RawFunFlags), /*EntryCount=*/0,7672std::move(Refs), std::move(Calls), std::move(PendingTypeTests),7673std::move(PendingTypeTestAssumeVCalls),7674std::move(PendingTypeCheckedLoadVCalls),7675std::move(PendingTypeTestAssumeConstVCalls),7676std::move(PendingTypeCheckedLoadConstVCalls),7677std::move(PendingParamAccesses), std::move(PendingCallsites),7678std::move(PendingAllocs));7679FS->setModulePath(getThisModule()->first());7680FS->setOriginalName(std::get<1>(VIAndOriginalGUID));7681TheIndex.addGlobalValueSummary(std::get<0>(VIAndOriginalGUID),7682std::move(FS));7683break;7684}7685// FS_ALIAS: [valueid, flags, valueid]7686// Aliases must be emitted (and parsed) after all FS_PERMODULE entries, as7687// they expect all aliasee summaries to be available.7688case bitc::FS_ALIAS: {7689unsigned ValueID = Record[0];7690uint64_t RawFlags = Record[1];7691unsigned AliaseeID = Record[2];7692auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7693auto AS = std::make_unique<AliasSummary>(Flags);7694// The module path string ref set in the summary must be owned by the7695// index's module string table. Since we don't have a module path7696// string table section in the per-module index, we create a single7697// module path string table entry with an empty (0) ID to take7698// ownership.7699AS->setModulePath(getThisModule()->first());77007701auto AliaseeVI = std::get<0>(getValueInfoFromValueId(AliaseeID));7702auto AliaseeInModule = TheIndex.findSummaryInModule(AliaseeVI, ModulePath);7703if (!AliaseeInModule)7704return error("Alias expects aliasee summary to be parsed");7705AS->setAliasee(AliaseeVI, AliaseeInModule);77067707auto GUID = getValueInfoFromValueId(ValueID);7708AS->setOriginalName(std::get<1>(GUID));7709TheIndex.addGlobalValueSummary(std::get<0>(GUID), std::move(AS));7710break;7711}7712// FS_PERMODULE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags, n x valueid]7713case bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS: {7714unsigned ValueID = Record[0];7715uint64_t RawFlags = Record[1];7716unsigned RefArrayStart = 2;7717GlobalVarSummary::GVarFlags GVF(/* ReadOnly */ false,7718/* WriteOnly */ false,7719/* Constant */ false,7720GlobalObject::VCallVisibilityPublic);7721auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7722if (Version >= 5) {7723GVF = getDecodedGVarFlags(Record[2]);7724RefArrayStart = 3;7725}7726std::vector<ValueInfo> Refs =7727makeRefList(ArrayRef<uint64_t>(Record).slice(RefArrayStart));7728auto FS =7729std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));7730FS->setModulePath(getThisModule()->first());7731auto GUID = getValueInfoFromValueId(ValueID);7732FS->setOriginalName(std::get<1>(GUID));7733TheIndex.addGlobalValueSummary(std::get<0>(GUID), std::move(FS));7734break;7735}7736// FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags,7737// numrefs, numrefs x valueid,7738// n x (valueid, offset)]7739case bitc::FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: {7740unsigned ValueID = Record[0];7741uint64_t RawFlags = Record[1];7742GlobalVarSummary::GVarFlags GVF = getDecodedGVarFlags(Record[2]);7743unsigned NumRefs = Record[3];7744unsigned RefListStartIndex = 4;7745unsigned VTableListStartIndex = RefListStartIndex + NumRefs;7746auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7747std::vector<ValueInfo> Refs = makeRefList(7748ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));7749VTableFuncList VTableFuncs;7750for (unsigned I = VTableListStartIndex, E = Record.size(); I != E; ++I) {7751ValueInfo Callee = std::get<0>(getValueInfoFromValueId(Record[I]));7752uint64_t Offset = Record[++I];7753VTableFuncs.push_back({Callee, Offset});7754}7755auto VS =7756std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));7757VS->setModulePath(getThisModule()->first());7758VS->setVTableFuncs(VTableFuncs);7759auto GUID = getValueInfoFromValueId(ValueID);7760VS->setOriginalName(std::get<1>(GUID));7761TheIndex.addGlobalValueSummary(std::get<0>(GUID), std::move(VS));7762break;7763}7764// FS_COMBINED is legacy and does not have support for the tail call flag.7765// FS_COMBINED: [valueid, modid, flags, instcount, fflags, numrefs,7766// numrefs x valueid, n x (valueid)]7767// FS_COMBINED_PROFILE: [valueid, modid, flags, instcount, fflags, numrefs,7768// numrefs x valueid,7769// n x (valueid, hotness+tailcall flags)]7770case bitc::FS_COMBINED:7771case bitc::FS_COMBINED_PROFILE: {7772unsigned ValueID = Record[0];7773uint64_t ModuleId = Record[1];7774uint64_t RawFlags = Record[2];7775unsigned InstCount = Record[3];7776uint64_t RawFunFlags = 0;7777uint64_t EntryCount = 0;7778unsigned NumRefs = Record[4];7779unsigned NumRORefs = 0, NumWORefs = 0;7780int RefListStartIndex = 5;77817782if (Version >= 4) {7783RawFunFlags = Record[4];7784RefListStartIndex = 6;7785size_t NumRefsIndex = 5;7786if (Version >= 5) {7787unsigned NumRORefsOffset = 1;7788RefListStartIndex = 7;7789if (Version >= 6) {7790NumRefsIndex = 6;7791EntryCount = Record[5];7792RefListStartIndex = 8;7793if (Version >= 7) {7794RefListStartIndex = 9;7795NumWORefs = Record[8];7796NumRORefsOffset = 2;7797}7798}7799NumRORefs = Record[RefListStartIndex - NumRORefsOffset];7800}7801NumRefs = Record[NumRefsIndex];7802}78037804auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7805int CallGraphEdgeStartIndex = RefListStartIndex + NumRefs;7806assert(Record.size() >= RefListStartIndex + NumRefs &&7807"Record size inconsistent with number of references");7808std::vector<ValueInfo> Refs = makeRefList(7809ArrayRef<uint64_t>(Record).slice(RefListStartIndex, NumRefs));7810bool HasProfile = (BitCode == bitc::FS_COMBINED_PROFILE);7811std::vector<FunctionSummary::EdgeTy> Edges = makeCallList(7812ArrayRef<uint64_t>(Record).slice(CallGraphEdgeStartIndex),7813IsOldProfileFormat, HasProfile, false);7814ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));7815setSpecialRefs(Refs, NumRORefs, NumWORefs);7816auto FS = std::make_unique<FunctionSummary>(7817Flags, InstCount, getDecodedFFlags(RawFunFlags), EntryCount,7818std::move(Refs), std::move(Edges), std::move(PendingTypeTests),7819std::move(PendingTypeTestAssumeVCalls),7820std::move(PendingTypeCheckedLoadVCalls),7821std::move(PendingTypeTestAssumeConstVCalls),7822std::move(PendingTypeCheckedLoadConstVCalls),7823std::move(PendingParamAccesses), std::move(PendingCallsites),7824std::move(PendingAllocs));7825LastSeenSummary = FS.get();7826LastSeenGUID = VI.getGUID();7827FS->setModulePath(ModuleIdMap[ModuleId]);7828TheIndex.addGlobalValueSummary(VI, std::move(FS));7829break;7830}7831// FS_COMBINED_ALIAS: [valueid, modid, flags, valueid]7832// Aliases must be emitted (and parsed) after all FS_COMBINED entries, as7833// they expect all aliasee summaries to be available.7834case bitc::FS_COMBINED_ALIAS: {7835unsigned ValueID = Record[0];7836uint64_t ModuleId = Record[1];7837uint64_t RawFlags = Record[2];7838unsigned AliaseeValueId = Record[3];7839auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7840auto AS = std::make_unique<AliasSummary>(Flags);7841LastSeenSummary = AS.get();7842AS->setModulePath(ModuleIdMap[ModuleId]);78437844auto AliaseeVI = std::get<0>(getValueInfoFromValueId(AliaseeValueId));7845auto AliaseeInModule = TheIndex.findSummaryInModule(AliaseeVI, AS->modulePath());7846AS->setAliasee(AliaseeVI, AliaseeInModule);78477848ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));7849LastSeenGUID = VI.getGUID();7850TheIndex.addGlobalValueSummary(VI, std::move(AS));7851break;7852}7853// FS_COMBINED_GLOBALVAR_INIT_REFS: [valueid, modid, flags, n x valueid]7854case bitc::FS_COMBINED_GLOBALVAR_INIT_REFS: {7855unsigned ValueID = Record[0];7856uint64_t ModuleId = Record[1];7857uint64_t RawFlags = Record[2];7858unsigned RefArrayStart = 3;7859GlobalVarSummary::GVarFlags GVF(/* ReadOnly */ false,7860/* WriteOnly */ false,7861/* Constant */ false,7862GlobalObject::VCallVisibilityPublic);7863auto Flags = getDecodedGVSummaryFlags(RawFlags, Version);7864if (Version >= 5) {7865GVF = getDecodedGVarFlags(Record[3]);7866RefArrayStart = 4;7867}7868std::vector<ValueInfo> Refs =7869makeRefList(ArrayRef<uint64_t>(Record).slice(RefArrayStart));7870auto FS =7871std::make_unique<GlobalVarSummary>(Flags, GVF, std::move(Refs));7872LastSeenSummary = FS.get();7873FS->setModulePath(ModuleIdMap[ModuleId]);7874ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));7875LastSeenGUID = VI.getGUID();7876TheIndex.addGlobalValueSummary(VI, std::move(FS));7877break;7878}7879// FS_COMBINED_ORIGINAL_NAME: [original_name]7880case bitc::FS_COMBINED_ORIGINAL_NAME: {7881uint64_t OriginalName = Record[0];7882if (!LastSeenSummary)7883return error("Name attachment that does not follow a combined record");7884LastSeenSummary->setOriginalName(OriginalName);7885TheIndex.addOriginalName(LastSeenGUID, OriginalName);7886// Reset the LastSeenSummary7887LastSeenSummary = nullptr;7888LastSeenGUID = 0;7889break;7890}7891case bitc::FS_TYPE_TESTS:7892assert(PendingTypeTests.empty());7893llvm::append_range(PendingTypeTests, Record);7894break;78957896case bitc::FS_TYPE_TEST_ASSUME_VCALLS:7897assert(PendingTypeTestAssumeVCalls.empty());7898for (unsigned I = 0; I != Record.size(); I += 2)7899PendingTypeTestAssumeVCalls.push_back({Record[I], Record[I+1]});7900break;79017902case bitc::FS_TYPE_CHECKED_LOAD_VCALLS:7903assert(PendingTypeCheckedLoadVCalls.empty());7904for (unsigned I = 0; I != Record.size(); I += 2)7905PendingTypeCheckedLoadVCalls.push_back({Record[I], Record[I+1]});7906break;79077908case bitc::FS_TYPE_TEST_ASSUME_CONST_VCALL:7909PendingTypeTestAssumeConstVCalls.push_back(7910{{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});7911break;79127913case bitc::FS_TYPE_CHECKED_LOAD_CONST_VCALL:7914PendingTypeCheckedLoadConstVCalls.push_back(7915{{Record[0], Record[1]}, {Record.begin() + 2, Record.end()}});7916break;79177918case bitc::FS_CFI_FUNCTION_DEFS: {7919std::set<std::string> &CfiFunctionDefs = TheIndex.cfiFunctionDefs();7920for (unsigned I = 0; I != Record.size(); I += 2)7921CfiFunctionDefs.insert(7922{Strtab.data() + Record[I], static_cast<size_t>(Record[I + 1])});7923break;7924}79257926case bitc::FS_CFI_FUNCTION_DECLS: {7927std::set<std::string> &CfiFunctionDecls = TheIndex.cfiFunctionDecls();7928for (unsigned I = 0; I != Record.size(); I += 2)7929CfiFunctionDecls.insert(7930{Strtab.data() + Record[I], static_cast<size_t>(Record[I + 1])});7931break;7932}79337934case bitc::FS_TYPE_ID:7935parseTypeIdSummaryRecord(Record, Strtab, TheIndex);7936break;79377938case bitc::FS_TYPE_ID_METADATA:7939parseTypeIdCompatibleVtableSummaryRecord(Record);7940break;79417942case bitc::FS_BLOCK_COUNT:7943TheIndex.addBlockCount(Record[0]);7944break;79457946case bitc::FS_PARAM_ACCESS: {7947PendingParamAccesses = parseParamAccesses(Record);7948break;7949}79507951case bitc::FS_STACK_IDS: { // [n x stackid]7952// Save stack ids in the reader to consult when adding stack ids from the7953// lists in the stack node and alloc node entries.7954StackIds = ArrayRef<uint64_t>(Record);7955break;7956}79577958case bitc::FS_PERMODULE_CALLSITE_INFO: {7959unsigned ValueID = Record[0];7960SmallVector<unsigned> StackIdList;7961for (auto R = Record.begin() + 1; R != Record.end(); R++) {7962assert(*R < StackIds.size());7963StackIdList.push_back(TheIndex.addOrGetStackIdIndex(StackIds[*R]));7964}7965ValueInfo VI = std::get<0>(getValueInfoFromValueId(ValueID));7966PendingCallsites.push_back(CallsiteInfo({VI, std::move(StackIdList)}));7967break;7968}79697970case bitc::FS_COMBINED_CALLSITE_INFO: {7971auto RecordIter = Record.begin();7972unsigned ValueID = *RecordIter++;7973unsigned NumStackIds = *RecordIter++;7974unsigned NumVersions = *RecordIter++;7975assert(Record.size() == 3 + NumStackIds + NumVersions);7976SmallVector<unsigned> StackIdList;7977for (unsigned J = 0; J < NumStackIds; J++) {7978assert(*RecordIter < StackIds.size());7979StackIdList.push_back(7980TheIndex.addOrGetStackIdIndex(StackIds[*RecordIter++]));7981}7982SmallVector<unsigned> Versions;7983for (unsigned J = 0; J < NumVersions; J++)7984Versions.push_back(*RecordIter++);7985ValueInfo VI = std::get<0>(7986getValueInfoFromValueId</*AllowNullValueInfo*/ true>(ValueID));7987PendingCallsites.push_back(7988CallsiteInfo({VI, std::move(Versions), std::move(StackIdList)}));7989break;7990}79917992case bitc::FS_PERMODULE_ALLOC_INFO: {7993unsigned I = 0;7994std::vector<MIBInfo> MIBs;7995unsigned NumMIBs = 0;7996if (Version >= 10)7997NumMIBs = Record[I++];7998unsigned MIBsRead = 0;7999while ((Version >= 10 && MIBsRead++ < NumMIBs) ||8000(Version < 10 && I < Record.size())) {8001assert(Record.size() - I >= 2);8002AllocationType AllocType = (AllocationType)Record[I++];8003unsigned NumStackEntries = Record[I++];8004assert(Record.size() - I >= NumStackEntries);8005SmallVector<unsigned> StackIdList;8006for (unsigned J = 0; J < NumStackEntries; J++) {8007assert(Record[I] < StackIds.size());8008StackIdList.push_back(8009TheIndex.addOrGetStackIdIndex(StackIds[Record[I++]]));8010}8011MIBs.push_back(MIBInfo(AllocType, std::move(StackIdList)));8012}8013std::vector<uint64_t> TotalSizes;8014// We either have no sizes or NumMIBs of them.8015assert(I == Record.size() || Record.size() - I == NumMIBs);8016if (I < Record.size()) {8017MIBsRead = 0;8018while (MIBsRead++ < NumMIBs)8019TotalSizes.push_back(Record[I++]);8020}8021PendingAllocs.push_back(AllocInfo(std::move(MIBs)));8022if (!TotalSizes.empty()) {8023assert(PendingAllocs.back().MIBs.size() == TotalSizes.size());8024PendingAllocs.back().TotalSizes = std::move(TotalSizes);8025}8026break;8027}80288029case bitc::FS_COMBINED_ALLOC_INFO: {8030unsigned I = 0;8031std::vector<MIBInfo> MIBs;8032unsigned NumMIBs = Record[I++];8033unsigned NumVersions = Record[I++];8034unsigned MIBsRead = 0;8035while (MIBsRead++ < NumMIBs) {8036assert(Record.size() - I >= 2);8037AllocationType AllocType = (AllocationType)Record[I++];8038unsigned NumStackEntries = Record[I++];8039assert(Record.size() - I >= NumStackEntries);8040SmallVector<unsigned> StackIdList;8041for (unsigned J = 0; J < NumStackEntries; J++) {8042assert(Record[I] < StackIds.size());8043StackIdList.push_back(8044TheIndex.addOrGetStackIdIndex(StackIds[Record[I++]]));8045}8046MIBs.push_back(MIBInfo(AllocType, std::move(StackIdList)));8047}8048assert(Record.size() - I >= NumVersions);8049SmallVector<uint8_t> Versions;8050for (unsigned J = 0; J < NumVersions; J++)8051Versions.push_back(Record[I++]);8052std::vector<uint64_t> TotalSizes;8053// We either have no sizes or NumMIBs of them.8054assert(I == Record.size() || Record.size() - I == NumMIBs);8055if (I < Record.size()) {8056MIBsRead = 0;8057while (MIBsRead++ < NumMIBs) {8058TotalSizes.push_back(Record[I++]);8059}8060}8061PendingAllocs.push_back(8062AllocInfo(std::move(Versions), std::move(MIBs)));8063if (!TotalSizes.empty()) {8064assert(PendingAllocs.back().MIBs.size() == TotalSizes.size());8065PendingAllocs.back().TotalSizes = std::move(TotalSizes);8066}8067break;8068}8069}8070}8071llvm_unreachable("Exit infinite loop");8072}80738074// Parse the module string table block into the Index.8075// This populates the ModulePathStringTable map in the index.8076Error ModuleSummaryIndexBitcodeReader::parseModuleStringTable() {8077if (Error Err = Stream.EnterSubBlock(bitc::MODULE_STRTAB_BLOCK_ID))8078return Err;80798080SmallVector<uint64_t, 64> Record;80818082SmallString<128> ModulePath;8083ModuleSummaryIndex::ModuleInfo *LastSeenModule = nullptr;80848085while (true) {8086Expected<BitstreamEntry> MaybeEntry = Stream.advanceSkippingSubblocks();8087if (!MaybeEntry)8088return MaybeEntry.takeError();8089BitstreamEntry Entry = MaybeEntry.get();80908091switch (Entry.Kind) {8092case BitstreamEntry::SubBlock: // Handled for us already.8093case BitstreamEntry::Error:8094return error("Malformed block");8095case BitstreamEntry::EndBlock:8096return Error::success();8097case BitstreamEntry::Record:8098// The interesting case.8099break;8100}81018102Record.clear();8103Expected<unsigned> MaybeRecord = Stream.readRecord(Entry.ID, Record);8104if (!MaybeRecord)8105return MaybeRecord.takeError();8106switch (MaybeRecord.get()) {8107default: // Default behavior: ignore.8108break;8109case bitc::MST_CODE_ENTRY: {8110// MST_ENTRY: [modid, namechar x N]8111uint64_t ModuleId = Record[0];81128113if (convertToString(Record, 1, ModulePath))8114return error("Invalid record");81158116LastSeenModule = TheIndex.addModule(ModulePath);8117ModuleIdMap[ModuleId] = LastSeenModule->first();81188119ModulePath.clear();8120break;8121}8122/// MST_CODE_HASH: [5*i32]8123case bitc::MST_CODE_HASH: {8124if (Record.size() != 5)8125return error("Invalid hash length " + Twine(Record.size()).str());8126if (!LastSeenModule)8127return error("Invalid hash that does not follow a module path");8128int Pos = 0;8129for (auto &Val : Record) {8130assert(!(Val >> 32) && "Unexpected high bits set");8131LastSeenModule->second[Pos++] = Val;8132}8133// Reset LastSeenModule to avoid overriding the hash unexpectedly.8134LastSeenModule = nullptr;8135break;8136}8137}8138}8139llvm_unreachable("Exit infinite loop");8140}81418142namespace {81438144// FIXME: This class is only here to support the transition to llvm::Error. It8145// will be removed once this transition is complete. Clients should prefer to8146// deal with the Error value directly, rather than converting to error_code.8147class BitcodeErrorCategoryType : public std::error_category {8148const char *name() const noexcept override {8149return "llvm.bitcode";8150}81518152std::string message(int IE) const override {8153BitcodeError E = static_cast<BitcodeError>(IE);8154switch (E) {8155case BitcodeError::CorruptedBitcode:8156return "Corrupted bitcode";8157}8158llvm_unreachable("Unknown error type!");8159}8160};81618162} // end anonymous namespace81638164const std::error_category &llvm::BitcodeErrorCategory() {8165static BitcodeErrorCategoryType ErrorCategory;8166return ErrorCategory;8167}81688169static Expected<StringRef> readBlobInRecord(BitstreamCursor &Stream,8170unsigned Block, unsigned RecordID) {8171if (Error Err = Stream.EnterSubBlock(Block))8172return std::move(Err);81738174StringRef Strtab;8175while (true) {8176Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();8177if (!MaybeEntry)8178return MaybeEntry.takeError();8179llvm::BitstreamEntry Entry = MaybeEntry.get();81808181switch (Entry.Kind) {8182case BitstreamEntry::EndBlock:8183return Strtab;81848185case BitstreamEntry::Error:8186return error("Malformed block");81878188case BitstreamEntry::SubBlock:8189if (Error Err = Stream.SkipBlock())8190return std::move(Err);8191break;81928193case BitstreamEntry::Record:8194StringRef Blob;8195SmallVector<uint64_t, 1> Record;8196Expected<unsigned> MaybeRecord =8197Stream.readRecord(Entry.ID, Record, &Blob);8198if (!MaybeRecord)8199return MaybeRecord.takeError();8200if (MaybeRecord.get() == RecordID)8201Strtab = Blob;8202break;8203}8204}8205}82068207//===----------------------------------------------------------------------===//8208// External interface8209//===----------------------------------------------------------------------===//82108211Expected<std::vector<BitcodeModule>>8212llvm::getBitcodeModuleList(MemoryBufferRef Buffer) {8213auto FOrErr = getBitcodeFileContents(Buffer);8214if (!FOrErr)8215return FOrErr.takeError();8216return std::move(FOrErr->Mods);8217}82188219Expected<BitcodeFileContents>8220llvm::getBitcodeFileContents(MemoryBufferRef Buffer) {8221Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);8222if (!StreamOrErr)8223return StreamOrErr.takeError();8224BitstreamCursor &Stream = *StreamOrErr;82258226BitcodeFileContents F;8227while (true) {8228uint64_t BCBegin = Stream.getCurrentByteNo();82298230// We may be consuming bitcode from a client that leaves garbage at the end8231// of the bitcode stream (e.g. Apple's ar tool). If we are close enough to8232// the end that there cannot possibly be another module, stop looking.8233if (BCBegin + 8 >= Stream.getBitcodeBytes().size())8234return F;82358236Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();8237if (!MaybeEntry)8238return MaybeEntry.takeError();8239llvm::BitstreamEntry Entry = MaybeEntry.get();82408241switch (Entry.Kind) {8242case BitstreamEntry::EndBlock:8243case BitstreamEntry::Error:8244return error("Malformed block");82458246case BitstreamEntry::SubBlock: {8247uint64_t IdentificationBit = -1ull;8248if (Entry.ID == bitc::IDENTIFICATION_BLOCK_ID) {8249IdentificationBit = Stream.GetCurrentBitNo() - BCBegin * 8;8250if (Error Err = Stream.SkipBlock())8251return std::move(Err);82528253{8254Expected<llvm::BitstreamEntry> MaybeEntry = Stream.advance();8255if (!MaybeEntry)8256return MaybeEntry.takeError();8257Entry = MaybeEntry.get();8258}82598260if (Entry.Kind != BitstreamEntry::SubBlock ||8261Entry.ID != bitc::MODULE_BLOCK_ID)8262return error("Malformed block");8263}82648265if (Entry.ID == bitc::MODULE_BLOCK_ID) {8266uint64_t ModuleBit = Stream.GetCurrentBitNo() - BCBegin * 8;8267if (Error Err = Stream.SkipBlock())8268return std::move(Err);82698270F.Mods.push_back({Stream.getBitcodeBytes().slice(8271BCBegin, Stream.getCurrentByteNo() - BCBegin),8272Buffer.getBufferIdentifier(), IdentificationBit,8273ModuleBit});8274continue;8275}82768277if (Entry.ID == bitc::STRTAB_BLOCK_ID) {8278Expected<StringRef> Strtab =8279readBlobInRecord(Stream, bitc::STRTAB_BLOCK_ID, bitc::STRTAB_BLOB);8280if (!Strtab)8281return Strtab.takeError();8282// This string table is used by every preceding bitcode module that does8283// not have its own string table. A bitcode file may have multiple8284// string tables if it was created by binary concatenation, for example8285// with "llvm-cat -b".8286for (BitcodeModule &I : llvm::reverse(F.Mods)) {8287if (!I.Strtab.empty())8288break;8289I.Strtab = *Strtab;8290}8291// Similarly, the string table is used by every preceding symbol table;8292// normally there will be just one unless the bitcode file was created8293// by binary concatenation.8294if (!F.Symtab.empty() && F.StrtabForSymtab.empty())8295F.StrtabForSymtab = *Strtab;8296continue;8297}82988299if (Entry.ID == bitc::SYMTAB_BLOCK_ID) {8300Expected<StringRef> SymtabOrErr =8301readBlobInRecord(Stream, bitc::SYMTAB_BLOCK_ID, bitc::SYMTAB_BLOB);8302if (!SymtabOrErr)8303return SymtabOrErr.takeError();83048305// We can expect the bitcode file to have multiple symbol tables if it8306// was created by binary concatenation. In that case we silently8307// ignore any subsequent symbol tables, which is fine because this is a8308// low level function. The client is expected to notice that the number8309// of modules in the symbol table does not match the number of modules8310// in the input file and regenerate the symbol table.8311if (F.Symtab.empty())8312F.Symtab = *SymtabOrErr;8313continue;8314}83158316if (Error Err = Stream.SkipBlock())8317return std::move(Err);8318continue;8319}8320case BitstreamEntry::Record:8321if (Error E = Stream.skipRecord(Entry.ID).takeError())8322return std::move(E);8323continue;8324}8325}8326}83278328/// Get a lazy one-at-time loading module from bitcode.8329///8330/// This isn't always used in a lazy context. In particular, it's also used by8331/// \a parseModule(). If this is truly lazy, then we need to eagerly pull8332/// in forward-referenced functions from block address references.8333///8334/// \param[in] MaterializeAll Set to \c true if we should materialize8335/// everything.8336Expected<std::unique_ptr<Module>>8337BitcodeModule::getModuleImpl(LLVMContext &Context, bool MaterializeAll,8338bool ShouldLazyLoadMetadata, bool IsImporting,8339ParserCallbacks Callbacks) {8340BitstreamCursor Stream(Buffer);83418342std::string ProducerIdentification;8343if (IdentificationBit != -1ull) {8344if (Error JumpFailed = Stream.JumpToBit(IdentificationBit))8345return std::move(JumpFailed);8346if (Error E =8347readIdentificationBlock(Stream).moveInto(ProducerIdentification))8348return std::move(E);8349}83508351if (Error JumpFailed = Stream.JumpToBit(ModuleBit))8352return std::move(JumpFailed);8353auto *R = new BitcodeReader(std::move(Stream), Strtab, ProducerIdentification,8354Context);83558356std::unique_ptr<Module> M =8357std::make_unique<Module>(ModuleIdentifier, Context);8358M->setMaterializer(R);83598360// Delay parsing Metadata if ShouldLazyLoadMetadata is true.8361if (Error Err = R->parseBitcodeInto(M.get(), ShouldLazyLoadMetadata,8362IsImporting, Callbacks))8363return std::move(Err);83648365if (MaterializeAll) {8366// Read in the entire module, and destroy the BitcodeReader.8367if (Error Err = M->materializeAll())8368return std::move(Err);8369} else {8370// Resolve forward references from blockaddresses.8371if (Error Err = R->materializeForwardReferencedFunctions())8372return std::move(Err);8373}83748375return std::move(M);8376}83778378Expected<std::unique_ptr<Module>>8379BitcodeModule::getLazyModule(LLVMContext &Context, bool ShouldLazyLoadMetadata,8380bool IsImporting, ParserCallbacks Callbacks) {8381return getModuleImpl(Context, false, ShouldLazyLoadMetadata, IsImporting,8382Callbacks);8383}83848385// Parse the specified bitcode buffer and merge the index into CombinedIndex.8386// We don't use ModuleIdentifier here because the client may need to control the8387// module path used in the combined summary (e.g. when reading summaries for8388// regular LTO modules).8389Error BitcodeModule::readSummary(8390ModuleSummaryIndex &CombinedIndex, StringRef ModulePath,8391std::function<bool(GlobalValue::GUID)> IsPrevailing) {8392BitstreamCursor Stream(Buffer);8393if (Error JumpFailed = Stream.JumpToBit(ModuleBit))8394return JumpFailed;83958396ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, CombinedIndex,8397ModulePath, IsPrevailing);8398return R.parseModule();8399}84008401// Parse the specified bitcode buffer, returning the function info index.8402Expected<std::unique_ptr<ModuleSummaryIndex>> BitcodeModule::getSummary() {8403BitstreamCursor Stream(Buffer);8404if (Error JumpFailed = Stream.JumpToBit(ModuleBit))8405return std::move(JumpFailed);84068407auto Index = std::make_unique<ModuleSummaryIndex>(/*HaveGVs=*/false);8408ModuleSummaryIndexBitcodeReader R(std::move(Stream), Strtab, *Index,8409ModuleIdentifier, 0);84108411if (Error Err = R.parseModule())8412return std::move(Err);84138414return std::move(Index);8415}84168417static Expected<std::pair<bool, bool>>8418getEnableSplitLTOUnitAndUnifiedFlag(BitstreamCursor &Stream,8419unsigned ID,8420BitcodeLTOInfo <OInfo) {8421if (Error Err = Stream.EnterSubBlock(ID))8422return std::move(Err);8423SmallVector<uint64_t, 64> Record;84248425while (true) {8426BitstreamEntry Entry;8427std::pair<bool, bool> Result = {false,false};8428if (Error E = Stream.advanceSkippingSubblocks().moveInto(Entry))8429return std::move(E);84308431switch (Entry.Kind) {8432case BitstreamEntry::SubBlock: // Handled for us already.8433case BitstreamEntry::Error:8434return error("Malformed block");8435case BitstreamEntry::EndBlock: {8436// If no flags record found, set both flags to false.8437return Result;8438}8439case BitstreamEntry::Record:8440// The interesting case.8441break;8442}84438444// Look for the FS_FLAGS record.8445Record.clear();8446Expected<unsigned> MaybeBitCode = Stream.readRecord(Entry.ID, Record);8447if (!MaybeBitCode)8448return MaybeBitCode.takeError();8449switch (MaybeBitCode.get()) {8450default: // Default behavior: ignore.8451break;8452case bitc::FS_FLAGS: { // [flags]8453uint64_t Flags = Record[0];8454// Scan flags.8455assert(Flags <= 0x2ff && "Unexpected bits in flag");84568457bool EnableSplitLTOUnit = Flags & 0x8;8458bool UnifiedLTO = Flags & 0x200;8459Result = {EnableSplitLTOUnit, UnifiedLTO};84608461return Result;8462}8463}8464}8465llvm_unreachable("Exit infinite loop");8466}84678468// Check if the given bitcode buffer contains a global value summary block.8469Expected<BitcodeLTOInfo> BitcodeModule::getLTOInfo() {8470BitstreamCursor Stream(Buffer);8471if (Error JumpFailed = Stream.JumpToBit(ModuleBit))8472return std::move(JumpFailed);84738474if (Error Err = Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))8475return std::move(Err);84768477while (true) {8478llvm::BitstreamEntry Entry;8479if (Error E = Stream.advance().moveInto(Entry))8480return std::move(E);84818482switch (Entry.Kind) {8483case BitstreamEntry::Error:8484return error("Malformed block");8485case BitstreamEntry::EndBlock:8486return BitcodeLTOInfo{/*IsThinLTO=*/false, /*HasSummary=*/false,8487/*EnableSplitLTOUnit=*/false, /*UnifiedLTO=*/false};84888489case BitstreamEntry::SubBlock:8490if (Entry.ID == bitc::GLOBALVAL_SUMMARY_BLOCK_ID) {8491BitcodeLTOInfo LTOInfo;8492Expected<std::pair<bool, bool>> Flags =8493getEnableSplitLTOUnitAndUnifiedFlag(Stream, Entry.ID, LTOInfo);8494if (!Flags)8495return Flags.takeError();8496std::tie(LTOInfo.EnableSplitLTOUnit, LTOInfo.UnifiedLTO) = Flags.get();8497LTOInfo.IsThinLTO = true;8498LTOInfo.HasSummary = true;8499return LTOInfo;8500}85018502if (Entry.ID == bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID) {8503BitcodeLTOInfo LTOInfo;8504Expected<std::pair<bool, bool>> Flags =8505getEnableSplitLTOUnitAndUnifiedFlag(Stream, Entry.ID, LTOInfo);8506if (!Flags)8507return Flags.takeError();8508std::tie(LTOInfo.EnableSplitLTOUnit, LTOInfo.UnifiedLTO) = Flags.get();8509LTOInfo.IsThinLTO = false;8510LTOInfo.HasSummary = true;8511return LTOInfo;8512}85138514// Ignore other sub-blocks.8515if (Error Err = Stream.SkipBlock())8516return std::move(Err);8517continue;85188519case BitstreamEntry::Record:8520if (Expected<unsigned> StreamFailed = Stream.skipRecord(Entry.ID))8521continue;8522else8523return StreamFailed.takeError();8524}8525}8526}85278528static Expected<BitcodeModule> getSingleModule(MemoryBufferRef Buffer) {8529Expected<std::vector<BitcodeModule>> MsOrErr = getBitcodeModuleList(Buffer);8530if (!MsOrErr)8531return MsOrErr.takeError();85328533if (MsOrErr->size() != 1)8534return error("Expected a single module");85358536return (*MsOrErr)[0];8537}85388539Expected<std::unique_ptr<Module>>8540llvm::getLazyBitcodeModule(MemoryBufferRef Buffer, LLVMContext &Context,8541bool ShouldLazyLoadMetadata, bool IsImporting,8542ParserCallbacks Callbacks) {8543Expected<BitcodeModule> BM = getSingleModule(Buffer);8544if (!BM)8545return BM.takeError();85468547return BM->getLazyModule(Context, ShouldLazyLoadMetadata, IsImporting,8548Callbacks);8549}85508551Expected<std::unique_ptr<Module>> llvm::getOwningLazyBitcodeModule(8552std::unique_ptr<MemoryBuffer> &&Buffer, LLVMContext &Context,8553bool ShouldLazyLoadMetadata, bool IsImporting, ParserCallbacks Callbacks) {8554auto MOrErr = getLazyBitcodeModule(*Buffer, Context, ShouldLazyLoadMetadata,8555IsImporting, Callbacks);8556if (MOrErr)8557(*MOrErr)->setOwnedMemoryBuffer(std::move(Buffer));8558return MOrErr;8559}85608561Expected<std::unique_ptr<Module>>8562BitcodeModule::parseModule(LLVMContext &Context, ParserCallbacks Callbacks) {8563return getModuleImpl(Context, true, false, false, Callbacks);8564// TODO: Restore the use-lists to the in-memory state when the bitcode was8565// written. We must defer until the Module has been fully materialized.8566}85678568Expected<std::unique_ptr<Module>>8569llvm::parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context,8570ParserCallbacks Callbacks) {8571Expected<BitcodeModule> BM = getSingleModule(Buffer);8572if (!BM)8573return BM.takeError();85748575return BM->parseModule(Context, Callbacks);8576}85778578Expected<std::string> llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer) {8579Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);8580if (!StreamOrErr)8581return StreamOrErr.takeError();85828583return readTriple(*StreamOrErr);8584}85858586Expected<bool> llvm::isBitcodeContainingObjCCategory(MemoryBufferRef Buffer) {8587Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);8588if (!StreamOrErr)8589return StreamOrErr.takeError();85908591return hasObjCCategory(*StreamOrErr);8592}85938594Expected<std::string> llvm::getBitcodeProducerString(MemoryBufferRef Buffer) {8595Expected<BitstreamCursor> StreamOrErr = initStream(Buffer);8596if (!StreamOrErr)8597return StreamOrErr.takeError();85988599return readIdentificationCode(*StreamOrErr);8600}86018602Error llvm::readModuleSummaryIndex(MemoryBufferRef Buffer,8603ModuleSummaryIndex &CombinedIndex) {8604Expected<BitcodeModule> BM = getSingleModule(Buffer);8605if (!BM)8606return BM.takeError();86078608return BM->readSummary(CombinedIndex, BM->getModuleIdentifier());8609}86108611Expected<std::unique_ptr<ModuleSummaryIndex>>8612llvm::getModuleSummaryIndex(MemoryBufferRef Buffer) {8613Expected<BitcodeModule> BM = getSingleModule(Buffer);8614if (!BM)8615return BM.takeError();86168617return BM->getSummary();8618}86198620Expected<BitcodeLTOInfo> llvm::getBitcodeLTOInfo(MemoryBufferRef Buffer) {8621Expected<BitcodeModule> BM = getSingleModule(Buffer);8622if (!BM)8623return BM.takeError();86248625return BM->getLTOInfo();8626}86278628Expected<std::unique_ptr<ModuleSummaryIndex>>8629llvm::getModuleSummaryIndexForFile(StringRef Path,8630bool IgnoreEmptyThinLTOIndexFile) {8631ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =8632MemoryBuffer::getFileOrSTDIN(Path);8633if (!FileOrErr)8634return errorCodeToError(FileOrErr.getError());8635if (IgnoreEmptyThinLTOIndexFile && !(*FileOrErr)->getBufferSize())8636return nullptr;8637return getModuleSummaryIndex(**FileOrErr);8638}863986408641