10b57cec5SDimitry Andric //===- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // Bitcode writer implementation.
100b57cec5SDimitry Andric //
110b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
120b57cec5SDimitry Andric 
130b57cec5SDimitry Andric #include "llvm/Bitcode/BitcodeWriter.h"
140b57cec5SDimitry Andric #include "ValueEnumerator.h"
150b57cec5SDimitry Andric #include "llvm/ADT/APFloat.h"
160b57cec5SDimitry Andric #include "llvm/ADT/APInt.h"
170b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h"
180b57cec5SDimitry Andric #include "llvm/ADT/DenseMap.h"
190b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h"
2081ad6265SDimitry Andric #include "llvm/ADT/SetVector.h"
2181ad6265SDimitry Andric #include "llvm/ADT/SmallPtrSet.h"
220b57cec5SDimitry Andric #include "llvm/ADT/SmallString.h"
230b57cec5SDimitry Andric #include "llvm/ADT/SmallVector.h"
240b57cec5SDimitry Andric #include "llvm/ADT/StringMap.h"
250b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
26e8d8bef9SDimitry Andric #include "llvm/Bitcode/BitcodeCommon.h"
27480093f4SDimitry Andric #include "llvm/Bitcode/BitcodeReader.h"
28480093f4SDimitry Andric #include "llvm/Bitcode/LLVMBitCodes.h"
290b57cec5SDimitry Andric #include "llvm/Bitstream/BitCodes.h"
300b57cec5SDimitry Andric #include "llvm/Bitstream/BitstreamWriter.h"
310b57cec5SDimitry Andric #include "llvm/Config/llvm-config.h"
320b57cec5SDimitry Andric #include "llvm/IR/Attributes.h"
330b57cec5SDimitry Andric #include "llvm/IR/BasicBlock.h"
340b57cec5SDimitry Andric #include "llvm/IR/Comdat.h"
350b57cec5SDimitry Andric #include "llvm/IR/Constant.h"
360b57cec5SDimitry Andric #include "llvm/IR/Constants.h"
370b57cec5SDimitry Andric #include "llvm/IR/DebugInfoMetadata.h"
380b57cec5SDimitry Andric #include "llvm/IR/DebugLoc.h"
390b57cec5SDimitry Andric #include "llvm/IR/DerivedTypes.h"
400b57cec5SDimitry Andric #include "llvm/IR/Function.h"
410b57cec5SDimitry Andric #include "llvm/IR/GlobalAlias.h"
420b57cec5SDimitry Andric #include "llvm/IR/GlobalIFunc.h"
430b57cec5SDimitry Andric #include "llvm/IR/GlobalObject.h"
440b57cec5SDimitry Andric #include "llvm/IR/GlobalValue.h"
450b57cec5SDimitry Andric #include "llvm/IR/GlobalVariable.h"
460b57cec5SDimitry Andric #include "llvm/IR/InlineAsm.h"
470b57cec5SDimitry Andric #include "llvm/IR/InstrTypes.h"
480b57cec5SDimitry Andric #include "llvm/IR/Instruction.h"
490b57cec5SDimitry Andric #include "llvm/IR/Instructions.h"
500b57cec5SDimitry Andric #include "llvm/IR/LLVMContext.h"
510b57cec5SDimitry Andric #include "llvm/IR/Metadata.h"
520b57cec5SDimitry Andric #include "llvm/IR/Module.h"
530b57cec5SDimitry Andric #include "llvm/IR/ModuleSummaryIndex.h"
540b57cec5SDimitry Andric #include "llvm/IR/Operator.h"
550b57cec5SDimitry Andric #include "llvm/IR/Type.h"
560b57cec5SDimitry Andric #include "llvm/IR/UseListOrder.h"
570b57cec5SDimitry Andric #include "llvm/IR/Value.h"
580b57cec5SDimitry Andric #include "llvm/IR/ValueSymbolTable.h"
590b57cec5SDimitry Andric #include "llvm/MC/StringTableBuilder.h"
60349cc55cSDimitry Andric #include "llvm/MC/TargetRegistry.h"
610b57cec5SDimitry Andric #include "llvm/Object/IRSymtab.h"
620b57cec5SDimitry Andric #include "llvm/Support/AtomicOrdering.h"
630b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
640b57cec5SDimitry Andric #include "llvm/Support/CommandLine.h"
650b57cec5SDimitry Andric #include "llvm/Support/Endian.h"
660b57cec5SDimitry Andric #include "llvm/Support/Error.h"
670b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h"
680b57cec5SDimitry Andric #include "llvm/Support/MathExtras.h"
690b57cec5SDimitry Andric #include "llvm/Support/SHA1.h"
700b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h"
71*fe013be4SDimitry Andric #include "llvm/TargetParser/Triple.h"
720b57cec5SDimitry Andric #include <algorithm>
730b57cec5SDimitry Andric #include <cassert>
740b57cec5SDimitry Andric #include <cstddef>
750b57cec5SDimitry Andric #include <cstdint>
760b57cec5SDimitry Andric #include <iterator>
770b57cec5SDimitry Andric #include <map>
780b57cec5SDimitry Andric #include <memory>
79bdd1243dSDimitry Andric #include <optional>
800b57cec5SDimitry Andric #include <string>
810b57cec5SDimitry Andric #include <utility>
820b57cec5SDimitry Andric #include <vector>
830b57cec5SDimitry Andric 
840b57cec5SDimitry Andric using namespace llvm;
850b57cec5SDimitry Andric 
860b57cec5SDimitry Andric static cl::opt<unsigned>
870b57cec5SDimitry Andric     IndexThreshold("bitcode-mdindex-threshold", cl::Hidden, cl::init(25),
880b57cec5SDimitry Andric                    cl::desc("Number of metadatas above which we emit an index "
890b57cec5SDimitry Andric                             "to enable lazy-loading"));
90e8d8bef9SDimitry Andric static cl::opt<uint32_t> FlushThreshold(
91e8d8bef9SDimitry Andric     "bitcode-flush-threshold", cl::Hidden, cl::init(512),
92e8d8bef9SDimitry Andric     cl::desc("The threshold (unit M) for flushing LLVM bitcode."));
930b57cec5SDimitry Andric 
948bcb0991SDimitry Andric static cl::opt<bool> WriteRelBFToSummary(
950b57cec5SDimitry Andric     "write-relbf-to-summary", cl::Hidden, cl::init(false),
960b57cec5SDimitry Andric     cl::desc("Write relative block frequency to function summary "));
970b57cec5SDimitry Andric 
98bdd1243dSDimitry Andric namespace llvm {
990b57cec5SDimitry Andric extern FunctionSummary::ForceSummaryHotnessType ForceSummaryEdgesCold;
100bdd1243dSDimitry Andric }
1010b57cec5SDimitry Andric 
1020b57cec5SDimitry Andric namespace {
1030b57cec5SDimitry Andric 
1040b57cec5SDimitry Andric /// These are manifest constants used by the bitcode writer. They do not need to
1050b57cec5SDimitry Andric /// be kept in sync with the reader, but need to be consistent within this file.
1060b57cec5SDimitry Andric enum {
1070b57cec5SDimitry Andric   // VALUE_SYMTAB_BLOCK abbrev id's.
1080b57cec5SDimitry Andric   VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
1090b57cec5SDimitry Andric   VST_ENTRY_7_ABBREV,
1100b57cec5SDimitry Andric   VST_ENTRY_6_ABBREV,
1110b57cec5SDimitry Andric   VST_BBENTRY_6_ABBREV,
1120b57cec5SDimitry Andric 
1130b57cec5SDimitry Andric   // CONSTANTS_BLOCK abbrev id's.
1140b57cec5SDimitry Andric   CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
1150b57cec5SDimitry Andric   CONSTANTS_INTEGER_ABBREV,
1160b57cec5SDimitry Andric   CONSTANTS_CE_CAST_Abbrev,
1170b57cec5SDimitry Andric   CONSTANTS_NULL_Abbrev,
1180b57cec5SDimitry Andric 
1190b57cec5SDimitry Andric   // FUNCTION_BLOCK abbrev id's.
1200b57cec5SDimitry Andric   FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
1210b57cec5SDimitry Andric   FUNCTION_INST_UNOP_ABBREV,
1220b57cec5SDimitry Andric   FUNCTION_INST_UNOP_FLAGS_ABBREV,
1230b57cec5SDimitry Andric   FUNCTION_INST_BINOP_ABBREV,
1240b57cec5SDimitry Andric   FUNCTION_INST_BINOP_FLAGS_ABBREV,
1250b57cec5SDimitry Andric   FUNCTION_INST_CAST_ABBREV,
1260b57cec5SDimitry Andric   FUNCTION_INST_RET_VOID_ABBREV,
1270b57cec5SDimitry Andric   FUNCTION_INST_RET_VAL_ABBREV,
1280b57cec5SDimitry Andric   FUNCTION_INST_UNREACHABLE_ABBREV,
1290b57cec5SDimitry Andric   FUNCTION_INST_GEP_ABBREV,
1300b57cec5SDimitry Andric };
1310b57cec5SDimitry Andric 
1320b57cec5SDimitry Andric /// Abstract class to manage the bitcode writing, subclassed for each bitcode
1330b57cec5SDimitry Andric /// file type.
1340b57cec5SDimitry Andric class BitcodeWriterBase {
1350b57cec5SDimitry Andric protected:
1360b57cec5SDimitry Andric   /// The stream created and owned by the client.
1370b57cec5SDimitry Andric   BitstreamWriter &Stream;
1380b57cec5SDimitry Andric 
1390b57cec5SDimitry Andric   StringTableBuilder &StrtabBuilder;
1400b57cec5SDimitry Andric 
1410b57cec5SDimitry Andric public:
1420b57cec5SDimitry Andric   /// Constructs a BitcodeWriterBase object that writes to the provided
1430b57cec5SDimitry Andric   /// \p Stream.
1440b57cec5SDimitry Andric   BitcodeWriterBase(BitstreamWriter &Stream, StringTableBuilder &StrtabBuilder)
1450b57cec5SDimitry Andric       : Stream(Stream), StrtabBuilder(StrtabBuilder) {}
1460b57cec5SDimitry Andric 
1470b57cec5SDimitry Andric protected:
1480b57cec5SDimitry Andric   void writeModuleVersion();
1490b57cec5SDimitry Andric };
1500b57cec5SDimitry Andric 
1510b57cec5SDimitry Andric void BitcodeWriterBase::writeModuleVersion() {
1520b57cec5SDimitry Andric   // VERSION: [version#]
1530b57cec5SDimitry Andric   Stream.EmitRecord(bitc::MODULE_CODE_VERSION, ArrayRef<uint64_t>{2});
1540b57cec5SDimitry Andric }
1550b57cec5SDimitry Andric 
1560b57cec5SDimitry Andric /// Base class to manage the module bitcode writing, currently subclassed for
1570b57cec5SDimitry Andric /// ModuleBitcodeWriter and ThinLinkBitcodeWriter.
1580b57cec5SDimitry Andric class ModuleBitcodeWriterBase : public BitcodeWriterBase {
1590b57cec5SDimitry Andric protected:
1600b57cec5SDimitry Andric   /// The Module to write to bitcode.
1610b57cec5SDimitry Andric   const Module &M;
1620b57cec5SDimitry Andric 
1630b57cec5SDimitry Andric   /// Enumerates ids for all values in the module.
1640b57cec5SDimitry Andric   ValueEnumerator VE;
1650b57cec5SDimitry Andric 
1660b57cec5SDimitry Andric   /// Optional per-module index to write for ThinLTO.
1670b57cec5SDimitry Andric   const ModuleSummaryIndex *Index;
1680b57cec5SDimitry Andric 
1690b57cec5SDimitry Andric   /// Map that holds the correspondence between GUIDs in the summary index,
1700b57cec5SDimitry Andric   /// that came from indirect call profiles, and a value id generated by this
1710b57cec5SDimitry Andric   /// class to use in the VST and summary block records.
1720b57cec5SDimitry Andric   std::map<GlobalValue::GUID, unsigned> GUIDToValueIdMap;
1730b57cec5SDimitry Andric 
1740b57cec5SDimitry Andric   /// Tracks the last value id recorded in the GUIDToValueMap.
1750b57cec5SDimitry Andric   unsigned GlobalValueId;
1760b57cec5SDimitry Andric 
1770b57cec5SDimitry Andric   /// Saves the offset of the VSTOffset record that must eventually be
1780b57cec5SDimitry Andric   /// backpatched with the offset of the actual VST.
1790b57cec5SDimitry Andric   uint64_t VSTOffsetPlaceholder = 0;
1800b57cec5SDimitry Andric 
1810b57cec5SDimitry Andric public:
1820b57cec5SDimitry Andric   /// Constructs a ModuleBitcodeWriterBase object for the given Module,
1830b57cec5SDimitry Andric   /// writing to the provided \p Buffer.
1840b57cec5SDimitry Andric   ModuleBitcodeWriterBase(const Module &M, StringTableBuilder &StrtabBuilder,
1850b57cec5SDimitry Andric                           BitstreamWriter &Stream,
1860b57cec5SDimitry Andric                           bool ShouldPreserveUseListOrder,
1870b57cec5SDimitry Andric                           const ModuleSummaryIndex *Index)
1880b57cec5SDimitry Andric       : BitcodeWriterBase(Stream, StrtabBuilder), M(M),
1890b57cec5SDimitry Andric         VE(M, ShouldPreserveUseListOrder), Index(Index) {
1900b57cec5SDimitry Andric     // Assign ValueIds to any callee values in the index that came from
1910b57cec5SDimitry Andric     // indirect call profiles and were recorded as a GUID not a Value*
1920b57cec5SDimitry Andric     // (which would have been assigned an ID by the ValueEnumerator).
1930b57cec5SDimitry Andric     // The starting ValueId is just after the number of values in the
1940b57cec5SDimitry Andric     // ValueEnumerator, so that they can be emitted in the VST.
1950b57cec5SDimitry Andric     GlobalValueId = VE.getValues().size();
1960b57cec5SDimitry Andric     if (!Index)
1970b57cec5SDimitry Andric       return;
1980b57cec5SDimitry Andric     for (const auto &GUIDSummaryLists : *Index)
1990b57cec5SDimitry Andric       // Examine all summaries for this GUID.
2000b57cec5SDimitry Andric       for (auto &Summary : GUIDSummaryLists.second.SummaryList)
2010b57cec5SDimitry Andric         if (auto FS = dyn_cast<FunctionSummary>(Summary.get()))
2020b57cec5SDimitry Andric           // For each call in the function summary, see if the call
2030b57cec5SDimitry Andric           // is to a GUID (which means it is for an indirect call,
2040b57cec5SDimitry Andric           // otherwise we would have a Value for it). If so, synthesize
2050b57cec5SDimitry Andric           // a value id.
2060b57cec5SDimitry Andric           for (auto &CallEdge : FS->calls())
2070b57cec5SDimitry Andric             if (!CallEdge.first.haveGVs() || !CallEdge.first.getValue())
2080b57cec5SDimitry Andric               assignValueId(CallEdge.first.getGUID());
2090b57cec5SDimitry Andric   }
2100b57cec5SDimitry Andric 
2110b57cec5SDimitry Andric protected:
2120b57cec5SDimitry Andric   void writePerModuleGlobalValueSummary();
2130b57cec5SDimitry Andric 
2140b57cec5SDimitry Andric private:
215bdd1243dSDimitry Andric   void writePerModuleFunctionSummaryRecord(
216bdd1243dSDimitry Andric       SmallVector<uint64_t, 64> &NameVals, GlobalValueSummary *Summary,
217bdd1243dSDimitry Andric       unsigned ValueID, unsigned FSCallsAbbrev, unsigned FSCallsProfileAbbrev,
218bdd1243dSDimitry Andric       unsigned CallsiteAbbrev, unsigned AllocAbbrev, const Function &F);
2190b57cec5SDimitry Andric   void writeModuleLevelReferences(const GlobalVariable &V,
2200b57cec5SDimitry Andric                                   SmallVector<uint64_t, 64> &NameVals,
2210b57cec5SDimitry Andric                                   unsigned FSModRefsAbbrev,
2220b57cec5SDimitry Andric                                   unsigned FSModVTableRefsAbbrev);
2230b57cec5SDimitry Andric 
2240b57cec5SDimitry Andric   void assignValueId(GlobalValue::GUID ValGUID) {
2250b57cec5SDimitry Andric     GUIDToValueIdMap[ValGUID] = ++GlobalValueId;
2260b57cec5SDimitry Andric   }
2270b57cec5SDimitry Andric 
2280b57cec5SDimitry Andric   unsigned getValueId(GlobalValue::GUID ValGUID) {
2290b57cec5SDimitry Andric     const auto &VMI = GUIDToValueIdMap.find(ValGUID);
2300b57cec5SDimitry Andric     // Expect that any GUID value had a value Id assigned by an
2310b57cec5SDimitry Andric     // earlier call to assignValueId.
2320b57cec5SDimitry Andric     assert(VMI != GUIDToValueIdMap.end() &&
2330b57cec5SDimitry Andric            "GUID does not have assigned value Id");
2340b57cec5SDimitry Andric     return VMI->second;
2350b57cec5SDimitry Andric   }
2360b57cec5SDimitry Andric 
2370b57cec5SDimitry Andric   // Helper to get the valueId for the type of value recorded in VI.
2380b57cec5SDimitry Andric   unsigned getValueId(ValueInfo VI) {
2390b57cec5SDimitry Andric     if (!VI.haveGVs() || !VI.getValue())
2400b57cec5SDimitry Andric       return getValueId(VI.getGUID());
2410b57cec5SDimitry Andric     return VE.getValueID(VI.getValue());
2420b57cec5SDimitry Andric   }
2430b57cec5SDimitry Andric 
2440b57cec5SDimitry Andric   std::map<GlobalValue::GUID, unsigned> &valueIds() { return GUIDToValueIdMap; }
2450b57cec5SDimitry Andric };
2460b57cec5SDimitry Andric 
2470b57cec5SDimitry Andric /// Class to manage the bitcode writing for a module.
2480b57cec5SDimitry Andric class ModuleBitcodeWriter : public ModuleBitcodeWriterBase {
2490b57cec5SDimitry Andric   /// Pointer to the buffer allocated by caller for bitcode writing.
2500b57cec5SDimitry Andric   const SmallVectorImpl<char> &Buffer;
2510b57cec5SDimitry Andric 
2520b57cec5SDimitry Andric   /// True if a module hash record should be written.
2530b57cec5SDimitry Andric   bool GenerateHash;
2540b57cec5SDimitry Andric 
2550b57cec5SDimitry Andric   /// If non-null, when GenerateHash is true, the resulting hash is written
2560b57cec5SDimitry Andric   /// into ModHash.
2570b57cec5SDimitry Andric   ModuleHash *ModHash;
2580b57cec5SDimitry Andric 
2590b57cec5SDimitry Andric   SHA1 Hasher;
2600b57cec5SDimitry Andric 
2610b57cec5SDimitry Andric   /// The start bit of the identification block.
2620b57cec5SDimitry Andric   uint64_t BitcodeStartBit;
2630b57cec5SDimitry Andric 
2640b57cec5SDimitry Andric public:
2650b57cec5SDimitry Andric   /// Constructs a ModuleBitcodeWriter object for the given Module,
2660b57cec5SDimitry Andric   /// writing to the provided \p Buffer.
2670b57cec5SDimitry Andric   ModuleBitcodeWriter(const Module &M, SmallVectorImpl<char> &Buffer,
2680b57cec5SDimitry Andric                       StringTableBuilder &StrtabBuilder,
2690b57cec5SDimitry Andric                       BitstreamWriter &Stream, bool ShouldPreserveUseListOrder,
2700b57cec5SDimitry Andric                       const ModuleSummaryIndex *Index, bool GenerateHash,
2710b57cec5SDimitry Andric                       ModuleHash *ModHash = nullptr)
2720b57cec5SDimitry Andric       : ModuleBitcodeWriterBase(M, StrtabBuilder, Stream,
2730b57cec5SDimitry Andric                                 ShouldPreserveUseListOrder, Index),
2740b57cec5SDimitry Andric         Buffer(Buffer), GenerateHash(GenerateHash), ModHash(ModHash),
2750b57cec5SDimitry Andric         BitcodeStartBit(Stream.GetCurrentBitNo()) {}
2760b57cec5SDimitry Andric 
2770b57cec5SDimitry Andric   /// Emit the current module to the bitstream.
2780b57cec5SDimitry Andric   void write();
2790b57cec5SDimitry Andric 
2800b57cec5SDimitry Andric private:
2810b57cec5SDimitry Andric   uint64_t bitcodeStartBit() { return BitcodeStartBit; }
2820b57cec5SDimitry Andric 
2830b57cec5SDimitry Andric   size_t addToStrtab(StringRef Str);
2840b57cec5SDimitry Andric 
2850b57cec5SDimitry Andric   void writeAttributeGroupTable();
2860b57cec5SDimitry Andric   void writeAttributeTable();
2870b57cec5SDimitry Andric   void writeTypeTable();
2880b57cec5SDimitry Andric   void writeComdats();
2890b57cec5SDimitry Andric   void writeValueSymbolTableForwardDecl();
2900b57cec5SDimitry Andric   void writeModuleInfo();
2910b57cec5SDimitry Andric   void writeValueAsMetadata(const ValueAsMetadata *MD,
2920b57cec5SDimitry Andric                             SmallVectorImpl<uint64_t> &Record);
2930b57cec5SDimitry Andric   void writeMDTuple(const MDTuple *N, SmallVectorImpl<uint64_t> &Record,
2940b57cec5SDimitry Andric                     unsigned Abbrev);
2950b57cec5SDimitry Andric   unsigned createDILocationAbbrev();
2960b57cec5SDimitry Andric   void writeDILocation(const DILocation *N, SmallVectorImpl<uint64_t> &Record,
2970b57cec5SDimitry Andric                        unsigned &Abbrev);
2980b57cec5SDimitry Andric   unsigned createGenericDINodeAbbrev();
2990b57cec5SDimitry Andric   void writeGenericDINode(const GenericDINode *N,
3000b57cec5SDimitry Andric                           SmallVectorImpl<uint64_t> &Record, unsigned &Abbrev);
3010b57cec5SDimitry Andric   void writeDISubrange(const DISubrange *N, SmallVectorImpl<uint64_t> &Record,
3020b57cec5SDimitry Andric                        unsigned Abbrev);
303e8d8bef9SDimitry Andric   void writeDIGenericSubrange(const DIGenericSubrange *N,
304e8d8bef9SDimitry Andric                               SmallVectorImpl<uint64_t> &Record,
305e8d8bef9SDimitry Andric                               unsigned Abbrev);
3060b57cec5SDimitry Andric   void writeDIEnumerator(const DIEnumerator *N,
3070b57cec5SDimitry Andric                          SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3080b57cec5SDimitry Andric   void writeDIBasicType(const DIBasicType *N, SmallVectorImpl<uint64_t> &Record,
3090b57cec5SDimitry Andric                         unsigned Abbrev);
310e8d8bef9SDimitry Andric   void writeDIStringType(const DIStringType *N,
311e8d8bef9SDimitry Andric                          SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3120b57cec5SDimitry Andric   void writeDIDerivedType(const DIDerivedType *N,
3130b57cec5SDimitry Andric                           SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3140b57cec5SDimitry Andric   void writeDICompositeType(const DICompositeType *N,
3150b57cec5SDimitry Andric                             SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3160b57cec5SDimitry Andric   void writeDISubroutineType(const DISubroutineType *N,
3170b57cec5SDimitry Andric                              SmallVectorImpl<uint64_t> &Record,
3180b57cec5SDimitry Andric                              unsigned Abbrev);
3190b57cec5SDimitry Andric   void writeDIFile(const DIFile *N, SmallVectorImpl<uint64_t> &Record,
3200b57cec5SDimitry Andric                    unsigned Abbrev);
3210b57cec5SDimitry Andric   void writeDICompileUnit(const DICompileUnit *N,
3220b57cec5SDimitry Andric                           SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3230b57cec5SDimitry Andric   void writeDISubprogram(const DISubprogram *N,
3240b57cec5SDimitry Andric                          SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3250b57cec5SDimitry Andric   void writeDILexicalBlock(const DILexicalBlock *N,
3260b57cec5SDimitry Andric                            SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3270b57cec5SDimitry Andric   void writeDILexicalBlockFile(const DILexicalBlockFile *N,
3280b57cec5SDimitry Andric                                SmallVectorImpl<uint64_t> &Record,
3290b57cec5SDimitry Andric                                unsigned Abbrev);
3300b57cec5SDimitry Andric   void writeDICommonBlock(const DICommonBlock *N,
3310b57cec5SDimitry Andric                           SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3320b57cec5SDimitry Andric   void writeDINamespace(const DINamespace *N, SmallVectorImpl<uint64_t> &Record,
3330b57cec5SDimitry Andric                         unsigned Abbrev);
3340b57cec5SDimitry Andric   void writeDIMacro(const DIMacro *N, SmallVectorImpl<uint64_t> &Record,
3350b57cec5SDimitry Andric                     unsigned Abbrev);
3360b57cec5SDimitry Andric   void writeDIMacroFile(const DIMacroFile *N, SmallVectorImpl<uint64_t> &Record,
3370b57cec5SDimitry Andric                         unsigned Abbrev);
338fe6060f1SDimitry Andric   void writeDIArgList(const DIArgList *N, SmallVectorImpl<uint64_t> &Record,
339fe6060f1SDimitry Andric                       unsigned Abbrev);
3400b57cec5SDimitry Andric   void writeDIModule(const DIModule *N, SmallVectorImpl<uint64_t> &Record,
3410b57cec5SDimitry Andric                      unsigned Abbrev);
342bdd1243dSDimitry Andric   void writeDIAssignID(const DIAssignID *N, SmallVectorImpl<uint64_t> &Record,
343bdd1243dSDimitry Andric                        unsigned Abbrev);
3440b57cec5SDimitry Andric   void writeDITemplateTypeParameter(const DITemplateTypeParameter *N,
3450b57cec5SDimitry Andric                                     SmallVectorImpl<uint64_t> &Record,
3460b57cec5SDimitry Andric                                     unsigned Abbrev);
3470b57cec5SDimitry Andric   void writeDITemplateValueParameter(const DITemplateValueParameter *N,
3480b57cec5SDimitry Andric                                      SmallVectorImpl<uint64_t> &Record,
3490b57cec5SDimitry Andric                                      unsigned Abbrev);
3500b57cec5SDimitry Andric   void writeDIGlobalVariable(const DIGlobalVariable *N,
3510b57cec5SDimitry Andric                              SmallVectorImpl<uint64_t> &Record,
3520b57cec5SDimitry Andric                              unsigned Abbrev);
3530b57cec5SDimitry Andric   void writeDILocalVariable(const DILocalVariable *N,
3540b57cec5SDimitry Andric                             SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3550b57cec5SDimitry Andric   void writeDILabel(const DILabel *N,
3560b57cec5SDimitry Andric                     SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3570b57cec5SDimitry Andric   void writeDIExpression(const DIExpression *N,
3580b57cec5SDimitry Andric                          SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3590b57cec5SDimitry Andric   void writeDIGlobalVariableExpression(const DIGlobalVariableExpression *N,
3600b57cec5SDimitry Andric                                        SmallVectorImpl<uint64_t> &Record,
3610b57cec5SDimitry Andric                                        unsigned Abbrev);
3620b57cec5SDimitry Andric   void writeDIObjCProperty(const DIObjCProperty *N,
3630b57cec5SDimitry Andric                            SmallVectorImpl<uint64_t> &Record, unsigned Abbrev);
3640b57cec5SDimitry Andric   void writeDIImportedEntity(const DIImportedEntity *N,
3650b57cec5SDimitry Andric                              SmallVectorImpl<uint64_t> &Record,
3660b57cec5SDimitry Andric                              unsigned Abbrev);
3670b57cec5SDimitry Andric   unsigned createNamedMetadataAbbrev();
3680b57cec5SDimitry Andric   void writeNamedMetadata(SmallVectorImpl<uint64_t> &Record);
3690b57cec5SDimitry Andric   unsigned createMetadataStringsAbbrev();
3700b57cec5SDimitry Andric   void writeMetadataStrings(ArrayRef<const Metadata *> Strings,
3710b57cec5SDimitry Andric                             SmallVectorImpl<uint64_t> &Record);
3720b57cec5SDimitry Andric   void writeMetadataRecords(ArrayRef<const Metadata *> MDs,
3730b57cec5SDimitry Andric                             SmallVectorImpl<uint64_t> &Record,
3740b57cec5SDimitry Andric                             std::vector<unsigned> *MDAbbrevs = nullptr,
3750b57cec5SDimitry Andric                             std::vector<uint64_t> *IndexPos = nullptr);
3760b57cec5SDimitry Andric   void writeModuleMetadata();
3770b57cec5SDimitry Andric   void writeFunctionMetadata(const Function &F);
3780b57cec5SDimitry Andric   void writeFunctionMetadataAttachment(const Function &F);
3790b57cec5SDimitry Andric   void pushGlobalMetadataAttachment(SmallVectorImpl<uint64_t> &Record,
3800b57cec5SDimitry Andric                                     const GlobalObject &GO);
3810b57cec5SDimitry Andric   void writeModuleMetadataKinds();
3820b57cec5SDimitry Andric   void writeOperandBundleTags();
3830b57cec5SDimitry Andric   void writeSyncScopeNames();
3840b57cec5SDimitry Andric   void writeConstants(unsigned FirstVal, unsigned LastVal, bool isGlobal);
3850b57cec5SDimitry Andric   void writeModuleConstants();
3860b57cec5SDimitry Andric   bool pushValueAndType(const Value *V, unsigned InstID,
3870b57cec5SDimitry Andric                         SmallVectorImpl<unsigned> &Vals);
3885ffd83dbSDimitry Andric   void writeOperandBundles(const CallBase &CB, unsigned InstID);
3890b57cec5SDimitry Andric   void pushValue(const Value *V, unsigned InstID,
3900b57cec5SDimitry Andric                  SmallVectorImpl<unsigned> &Vals);
3910b57cec5SDimitry Andric   void pushValueSigned(const Value *V, unsigned InstID,
3920b57cec5SDimitry Andric                        SmallVectorImpl<uint64_t> &Vals);
3930b57cec5SDimitry Andric   void writeInstruction(const Instruction &I, unsigned InstID,
3940b57cec5SDimitry Andric                         SmallVectorImpl<unsigned> &Vals);
3950b57cec5SDimitry Andric   void writeFunctionLevelValueSymbolTable(const ValueSymbolTable &VST);
3960b57cec5SDimitry Andric   void writeGlobalValueSymbolTable(
3970b57cec5SDimitry Andric       DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex);
3980b57cec5SDimitry Andric   void writeUseList(UseListOrder &&Order);
3990b57cec5SDimitry Andric   void writeUseListBlock(const Function *F);
4000b57cec5SDimitry Andric   void
4010b57cec5SDimitry Andric   writeFunction(const Function &F,
4020b57cec5SDimitry Andric                 DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex);
4030b57cec5SDimitry Andric   void writeBlockInfo();
4040b57cec5SDimitry Andric   void writeModuleHash(size_t BlockStartPos);
4050b57cec5SDimitry Andric 
4060b57cec5SDimitry Andric   unsigned getEncodedSyncScopeID(SyncScope::ID SSID) {
4070b57cec5SDimitry Andric     return unsigned(SSID);
4080b57cec5SDimitry Andric   }
409e8d8bef9SDimitry Andric 
410e8d8bef9SDimitry Andric   unsigned getEncodedAlign(MaybeAlign Alignment) { return encode(Alignment); }
4110b57cec5SDimitry Andric };
4120b57cec5SDimitry Andric 
4130b57cec5SDimitry Andric /// Class to manage the bitcode writing for a combined index.
4140b57cec5SDimitry Andric class IndexBitcodeWriter : public BitcodeWriterBase {
4150b57cec5SDimitry Andric   /// The combined index to write to bitcode.
4160b57cec5SDimitry Andric   const ModuleSummaryIndex &Index;
4170b57cec5SDimitry Andric 
4180b57cec5SDimitry Andric   /// When writing a subset of the index for distributed backends, client
4190b57cec5SDimitry Andric   /// provides a map of modules to the corresponding GUIDs/summaries to write.
4200b57cec5SDimitry Andric   const std::map<std::string, GVSummaryMapTy> *ModuleToSummariesForIndex;
4210b57cec5SDimitry Andric 
4220b57cec5SDimitry Andric   /// Map that holds the correspondence between the GUID used in the combined
4230b57cec5SDimitry Andric   /// index and a value id generated by this class to use in references.
4240b57cec5SDimitry Andric   std::map<GlobalValue::GUID, unsigned> GUIDToValueIdMap;
4250b57cec5SDimitry Andric 
426bdd1243dSDimitry Andric   // The sorted stack id indices actually used in the summary entries being
427bdd1243dSDimitry Andric   // written, which will be a subset of those in the full index in the case of
428bdd1243dSDimitry Andric   // distributed indexes.
429bdd1243dSDimitry Andric   std::vector<unsigned> StackIdIndices;
430bdd1243dSDimitry Andric 
4310b57cec5SDimitry Andric   /// Tracks the last value id recorded in the GUIDToValueMap.
4320b57cec5SDimitry Andric   unsigned GlobalValueId = 0;
4330b57cec5SDimitry Andric 
4340b57cec5SDimitry Andric public:
4350b57cec5SDimitry Andric   /// Constructs a IndexBitcodeWriter object for the given combined index,
4360b57cec5SDimitry Andric   /// writing to the provided \p Buffer. When writing a subset of the index
4370b57cec5SDimitry Andric   /// for a distributed backend, provide a \p ModuleToSummariesForIndex map.
4380b57cec5SDimitry Andric   IndexBitcodeWriter(BitstreamWriter &Stream, StringTableBuilder &StrtabBuilder,
4390b57cec5SDimitry Andric                      const ModuleSummaryIndex &Index,
4400b57cec5SDimitry Andric                      const std::map<std::string, GVSummaryMapTy>
4410b57cec5SDimitry Andric                          *ModuleToSummariesForIndex = nullptr)
4420b57cec5SDimitry Andric       : BitcodeWriterBase(Stream, StrtabBuilder), Index(Index),
4430b57cec5SDimitry Andric         ModuleToSummariesForIndex(ModuleToSummariesForIndex) {
4440b57cec5SDimitry Andric     // Assign unique value ids to all summaries to be written, for use
4450b57cec5SDimitry Andric     // in writing out the call graph edges. Save the mapping from GUID
4460b57cec5SDimitry Andric     // to the new global value id to use when writing those edges, which
4470b57cec5SDimitry Andric     // are currently saved in the index in terms of GUID.
448bdd1243dSDimitry Andric     forEachSummary([&](GVInfo I, bool IsAliasee) {
4490b57cec5SDimitry Andric       GUIDToValueIdMap[I.first] = ++GlobalValueId;
450bdd1243dSDimitry Andric       if (IsAliasee)
451bdd1243dSDimitry Andric         return;
452bdd1243dSDimitry Andric       auto *FS = dyn_cast<FunctionSummary>(I.second);
453bdd1243dSDimitry Andric       if (!FS)
454bdd1243dSDimitry Andric         return;
455bdd1243dSDimitry Andric       // Record all stack id indices actually used in the summary entries being
456bdd1243dSDimitry Andric       // written, so that we can compact them in the case of distributed ThinLTO
457bdd1243dSDimitry Andric       // indexes.
458bdd1243dSDimitry Andric       for (auto &CI : FS->callsites())
459bdd1243dSDimitry Andric         for (auto Idx : CI.StackIdIndices)
460bdd1243dSDimitry Andric           StackIdIndices.push_back(Idx);
461bdd1243dSDimitry Andric       for (auto &AI : FS->allocs())
462bdd1243dSDimitry Andric         for (auto &MIB : AI.MIBs)
463bdd1243dSDimitry Andric           for (auto Idx : MIB.StackIdIndices)
464bdd1243dSDimitry Andric             StackIdIndices.push_back(Idx);
4650b57cec5SDimitry Andric     });
466bdd1243dSDimitry Andric     llvm::sort(StackIdIndices);
467bdd1243dSDimitry Andric     StackIdIndices.erase(
468bdd1243dSDimitry Andric         std::unique(StackIdIndices.begin(), StackIdIndices.end()),
469bdd1243dSDimitry Andric         StackIdIndices.end());
4700b57cec5SDimitry Andric   }
4710b57cec5SDimitry Andric 
4720b57cec5SDimitry Andric   /// The below iterator returns the GUID and associated summary.
4730b57cec5SDimitry Andric   using GVInfo = std::pair<GlobalValue::GUID, GlobalValueSummary *>;
4740b57cec5SDimitry Andric 
4750b57cec5SDimitry Andric   /// Calls the callback for each value GUID and summary to be written to
4760b57cec5SDimitry Andric   /// bitcode. This hides the details of whether they are being pulled from the
4770b57cec5SDimitry Andric   /// entire index or just those in a provided ModuleToSummariesForIndex map.
4780b57cec5SDimitry Andric   template<typename Functor>
4790b57cec5SDimitry Andric   void forEachSummary(Functor Callback) {
4800b57cec5SDimitry Andric     if (ModuleToSummariesForIndex) {
4810b57cec5SDimitry Andric       for (auto &M : *ModuleToSummariesForIndex)
4820b57cec5SDimitry Andric         for (auto &Summary : M.second) {
4830b57cec5SDimitry Andric           Callback(Summary, false);
4840b57cec5SDimitry Andric           // Ensure aliasee is handled, e.g. for assigning a valueId,
4850b57cec5SDimitry Andric           // even if we are not importing the aliasee directly (the
4860b57cec5SDimitry Andric           // imported alias will contain a copy of aliasee).
4870b57cec5SDimitry Andric           if (auto *AS = dyn_cast<AliasSummary>(Summary.getSecond()))
4880b57cec5SDimitry Andric             Callback({AS->getAliaseeGUID(), &AS->getAliasee()}, true);
4890b57cec5SDimitry Andric         }
4900b57cec5SDimitry Andric     } else {
4910b57cec5SDimitry Andric       for (auto &Summaries : Index)
4920b57cec5SDimitry Andric         for (auto &Summary : Summaries.second.SummaryList)
4930b57cec5SDimitry Andric           Callback({Summaries.first, Summary.get()}, false);
4940b57cec5SDimitry Andric     }
4950b57cec5SDimitry Andric   }
4960b57cec5SDimitry Andric 
4970b57cec5SDimitry Andric   /// Calls the callback for each entry in the modulePaths StringMap that
4980b57cec5SDimitry Andric   /// should be written to the module path string table. This hides the details
4990b57cec5SDimitry Andric   /// of whether they are being pulled from the entire index or just those in a
5000b57cec5SDimitry Andric   /// provided ModuleToSummariesForIndex map.
5010b57cec5SDimitry Andric   template <typename Functor> void forEachModule(Functor Callback) {
5020b57cec5SDimitry Andric     if (ModuleToSummariesForIndex) {
5030b57cec5SDimitry Andric       for (const auto &M : *ModuleToSummariesForIndex) {
5040b57cec5SDimitry Andric         const auto &MPI = Index.modulePaths().find(M.first);
5050b57cec5SDimitry Andric         if (MPI == Index.modulePaths().end()) {
5060b57cec5SDimitry Andric           // This should only happen if the bitcode file was empty, in which
5070b57cec5SDimitry Andric           // case we shouldn't be importing (the ModuleToSummariesForIndex
5080b57cec5SDimitry Andric           // would only include the module we are writing and index for).
5090b57cec5SDimitry Andric           assert(ModuleToSummariesForIndex->size() == 1);
5100b57cec5SDimitry Andric           continue;
5110b57cec5SDimitry Andric         }
5120b57cec5SDimitry Andric         Callback(*MPI);
5130b57cec5SDimitry Andric       }
5140b57cec5SDimitry Andric     } else {
5150b57cec5SDimitry Andric       for (const auto &MPSE : Index.modulePaths())
5160b57cec5SDimitry Andric         Callback(MPSE);
5170b57cec5SDimitry Andric     }
5180b57cec5SDimitry Andric   }
5190b57cec5SDimitry Andric 
5200b57cec5SDimitry Andric   /// Main entry point for writing a combined index to bitcode.
5210b57cec5SDimitry Andric   void write();
5220b57cec5SDimitry Andric 
5230b57cec5SDimitry Andric private:
5240b57cec5SDimitry Andric   void writeModStrings();
5250b57cec5SDimitry Andric   void writeCombinedGlobalValueSummary();
5260b57cec5SDimitry Andric 
527bdd1243dSDimitry Andric   std::optional<unsigned> getValueId(GlobalValue::GUID ValGUID) {
5280b57cec5SDimitry Andric     auto VMI = GUIDToValueIdMap.find(ValGUID);
5290b57cec5SDimitry Andric     if (VMI == GUIDToValueIdMap.end())
530bdd1243dSDimitry Andric       return std::nullopt;
5310b57cec5SDimitry Andric     return VMI->second;
5320b57cec5SDimitry Andric   }
5330b57cec5SDimitry Andric 
5340b57cec5SDimitry Andric   std::map<GlobalValue::GUID, unsigned> &valueIds() { return GUIDToValueIdMap; }
5350b57cec5SDimitry Andric };
5360b57cec5SDimitry Andric 
5370b57cec5SDimitry Andric } // end anonymous namespace
5380b57cec5SDimitry Andric 
5390b57cec5SDimitry Andric static unsigned getEncodedCastOpcode(unsigned Opcode) {
5400b57cec5SDimitry Andric   switch (Opcode) {
5410b57cec5SDimitry Andric   default: llvm_unreachable("Unknown cast instruction!");
5420b57cec5SDimitry Andric   case Instruction::Trunc   : return bitc::CAST_TRUNC;
5430b57cec5SDimitry Andric   case Instruction::ZExt    : return bitc::CAST_ZEXT;
5440b57cec5SDimitry Andric   case Instruction::SExt    : return bitc::CAST_SEXT;
5450b57cec5SDimitry Andric   case Instruction::FPToUI  : return bitc::CAST_FPTOUI;
5460b57cec5SDimitry Andric   case Instruction::FPToSI  : return bitc::CAST_FPTOSI;
5470b57cec5SDimitry Andric   case Instruction::UIToFP  : return bitc::CAST_UITOFP;
5480b57cec5SDimitry Andric   case Instruction::SIToFP  : return bitc::CAST_SITOFP;
5490b57cec5SDimitry Andric   case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
5500b57cec5SDimitry Andric   case Instruction::FPExt   : return bitc::CAST_FPEXT;
5510b57cec5SDimitry Andric   case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
5520b57cec5SDimitry Andric   case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
5530b57cec5SDimitry Andric   case Instruction::BitCast : return bitc::CAST_BITCAST;
5540b57cec5SDimitry Andric   case Instruction::AddrSpaceCast: return bitc::CAST_ADDRSPACECAST;
5550b57cec5SDimitry Andric   }
5560b57cec5SDimitry Andric }
5570b57cec5SDimitry Andric 
5580b57cec5SDimitry Andric static unsigned getEncodedUnaryOpcode(unsigned Opcode) {
5590b57cec5SDimitry Andric   switch (Opcode) {
5600b57cec5SDimitry Andric   default: llvm_unreachable("Unknown binary instruction!");
5618bcb0991SDimitry Andric   case Instruction::FNeg: return bitc::UNOP_FNEG;
5620b57cec5SDimitry Andric   }
5630b57cec5SDimitry Andric }
5640b57cec5SDimitry Andric 
5650b57cec5SDimitry Andric static unsigned getEncodedBinaryOpcode(unsigned Opcode) {
5660b57cec5SDimitry Andric   switch (Opcode) {
5670b57cec5SDimitry Andric   default: llvm_unreachable("Unknown binary instruction!");
5680b57cec5SDimitry Andric   case Instruction::Add:
5690b57cec5SDimitry Andric   case Instruction::FAdd: return bitc::BINOP_ADD;
5700b57cec5SDimitry Andric   case Instruction::Sub:
5710b57cec5SDimitry Andric   case Instruction::FSub: return bitc::BINOP_SUB;
5720b57cec5SDimitry Andric   case Instruction::Mul:
5730b57cec5SDimitry Andric   case Instruction::FMul: return bitc::BINOP_MUL;
5740b57cec5SDimitry Andric   case Instruction::UDiv: return bitc::BINOP_UDIV;
5750b57cec5SDimitry Andric   case Instruction::FDiv:
5760b57cec5SDimitry Andric   case Instruction::SDiv: return bitc::BINOP_SDIV;
5770b57cec5SDimitry Andric   case Instruction::URem: return bitc::BINOP_UREM;
5780b57cec5SDimitry Andric   case Instruction::FRem:
5790b57cec5SDimitry Andric   case Instruction::SRem: return bitc::BINOP_SREM;
5800b57cec5SDimitry Andric   case Instruction::Shl:  return bitc::BINOP_SHL;
5810b57cec5SDimitry Andric   case Instruction::LShr: return bitc::BINOP_LSHR;
5820b57cec5SDimitry Andric   case Instruction::AShr: return bitc::BINOP_ASHR;
5830b57cec5SDimitry Andric   case Instruction::And:  return bitc::BINOP_AND;
5840b57cec5SDimitry Andric   case Instruction::Or:   return bitc::BINOP_OR;
5850b57cec5SDimitry Andric   case Instruction::Xor:  return bitc::BINOP_XOR;
5860b57cec5SDimitry Andric   }
5870b57cec5SDimitry Andric }
5880b57cec5SDimitry Andric 
5890b57cec5SDimitry Andric static unsigned getEncodedRMWOperation(AtomicRMWInst::BinOp Op) {
5900b57cec5SDimitry Andric   switch (Op) {
5910b57cec5SDimitry Andric   default: llvm_unreachable("Unknown RMW operation!");
5920b57cec5SDimitry Andric   case AtomicRMWInst::Xchg: return bitc::RMW_XCHG;
5930b57cec5SDimitry Andric   case AtomicRMWInst::Add: return bitc::RMW_ADD;
5940b57cec5SDimitry Andric   case AtomicRMWInst::Sub: return bitc::RMW_SUB;
5950b57cec5SDimitry Andric   case AtomicRMWInst::And: return bitc::RMW_AND;
5960b57cec5SDimitry Andric   case AtomicRMWInst::Nand: return bitc::RMW_NAND;
5970b57cec5SDimitry Andric   case AtomicRMWInst::Or: return bitc::RMW_OR;
5980b57cec5SDimitry Andric   case AtomicRMWInst::Xor: return bitc::RMW_XOR;
5990b57cec5SDimitry Andric   case AtomicRMWInst::Max: return bitc::RMW_MAX;
6000b57cec5SDimitry Andric   case AtomicRMWInst::Min: return bitc::RMW_MIN;
6010b57cec5SDimitry Andric   case AtomicRMWInst::UMax: return bitc::RMW_UMAX;
6020b57cec5SDimitry Andric   case AtomicRMWInst::UMin: return bitc::RMW_UMIN;
6030b57cec5SDimitry Andric   case AtomicRMWInst::FAdd: return bitc::RMW_FADD;
6040b57cec5SDimitry Andric   case AtomicRMWInst::FSub: return bitc::RMW_FSUB;
605753f127fSDimitry Andric   case AtomicRMWInst::FMax: return bitc::RMW_FMAX;
606753f127fSDimitry Andric   case AtomicRMWInst::FMin: return bitc::RMW_FMIN;
607bdd1243dSDimitry Andric   case AtomicRMWInst::UIncWrap:
608bdd1243dSDimitry Andric     return bitc::RMW_UINC_WRAP;
609bdd1243dSDimitry Andric   case AtomicRMWInst::UDecWrap:
610bdd1243dSDimitry Andric     return bitc::RMW_UDEC_WRAP;
6110b57cec5SDimitry Andric   }
6120b57cec5SDimitry Andric }
6130b57cec5SDimitry Andric 
6140b57cec5SDimitry Andric static unsigned getEncodedOrdering(AtomicOrdering Ordering) {
6150b57cec5SDimitry Andric   switch (Ordering) {
6160b57cec5SDimitry Andric   case AtomicOrdering::NotAtomic: return bitc::ORDERING_NOTATOMIC;
6170b57cec5SDimitry Andric   case AtomicOrdering::Unordered: return bitc::ORDERING_UNORDERED;
6180b57cec5SDimitry Andric   case AtomicOrdering::Monotonic: return bitc::ORDERING_MONOTONIC;
6190b57cec5SDimitry Andric   case AtomicOrdering::Acquire: return bitc::ORDERING_ACQUIRE;
6200b57cec5SDimitry Andric   case AtomicOrdering::Release: return bitc::ORDERING_RELEASE;
6210b57cec5SDimitry Andric   case AtomicOrdering::AcquireRelease: return bitc::ORDERING_ACQREL;
6220b57cec5SDimitry Andric   case AtomicOrdering::SequentiallyConsistent: return bitc::ORDERING_SEQCST;
6230b57cec5SDimitry Andric   }
6240b57cec5SDimitry Andric   llvm_unreachable("Invalid ordering");
6250b57cec5SDimitry Andric }
6260b57cec5SDimitry Andric 
6270b57cec5SDimitry Andric static void writeStringRecord(BitstreamWriter &Stream, unsigned Code,
6280b57cec5SDimitry Andric                               StringRef Str, unsigned AbbrevToUse) {
6290b57cec5SDimitry Andric   SmallVector<unsigned, 64> Vals;
6300b57cec5SDimitry Andric 
6310b57cec5SDimitry Andric   // Code: [strchar x N]
6324824e7fdSDimitry Andric   for (char C : Str) {
6334824e7fdSDimitry Andric     if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(C))
6340b57cec5SDimitry Andric       AbbrevToUse = 0;
6354824e7fdSDimitry Andric     Vals.push_back(C);
6360b57cec5SDimitry Andric   }
6370b57cec5SDimitry Andric 
6380b57cec5SDimitry Andric   // Emit the finished record.
6390b57cec5SDimitry Andric   Stream.EmitRecord(Code, Vals, AbbrevToUse);
6400b57cec5SDimitry Andric }
6410b57cec5SDimitry Andric 
6420b57cec5SDimitry Andric static uint64_t getAttrKindEncoding(Attribute::AttrKind Kind) {
6430b57cec5SDimitry Andric   switch (Kind) {
6440b57cec5SDimitry Andric   case Attribute::Alignment:
6450b57cec5SDimitry Andric     return bitc::ATTR_KIND_ALIGNMENT;
64681ad6265SDimitry Andric   case Attribute::AllocAlign:
64781ad6265SDimitry Andric     return bitc::ATTR_KIND_ALLOC_ALIGN;
6480b57cec5SDimitry Andric   case Attribute::AllocSize:
6490b57cec5SDimitry Andric     return bitc::ATTR_KIND_ALLOC_SIZE;
6500b57cec5SDimitry Andric   case Attribute::AlwaysInline:
6510b57cec5SDimitry Andric     return bitc::ATTR_KIND_ALWAYS_INLINE;
6520b57cec5SDimitry Andric   case Attribute::Builtin:
6530b57cec5SDimitry Andric     return bitc::ATTR_KIND_BUILTIN;
6540b57cec5SDimitry Andric   case Attribute::ByVal:
6550b57cec5SDimitry Andric     return bitc::ATTR_KIND_BY_VAL;
6560b57cec5SDimitry Andric   case Attribute::Convergent:
6570b57cec5SDimitry Andric     return bitc::ATTR_KIND_CONVERGENT;
6580b57cec5SDimitry Andric   case Attribute::InAlloca:
6590b57cec5SDimitry Andric     return bitc::ATTR_KIND_IN_ALLOCA;
6600b57cec5SDimitry Andric   case Attribute::Cold:
6610b57cec5SDimitry Andric     return bitc::ATTR_KIND_COLD;
662349cc55cSDimitry Andric   case Attribute::DisableSanitizerInstrumentation:
663349cc55cSDimitry Andric     return bitc::ATTR_KIND_DISABLE_SANITIZER_INSTRUMENTATION;
664753f127fSDimitry Andric   case Attribute::FnRetThunkExtern:
665753f127fSDimitry Andric     return bitc::ATTR_KIND_FNRETTHUNK_EXTERN;
666e8d8bef9SDimitry Andric   case Attribute::Hot:
667e8d8bef9SDimitry Andric     return bitc::ATTR_KIND_HOT;
668fe6060f1SDimitry Andric   case Attribute::ElementType:
669fe6060f1SDimitry Andric     return bitc::ATTR_KIND_ELEMENTTYPE;
6700b57cec5SDimitry Andric   case Attribute::InlineHint:
6710b57cec5SDimitry Andric     return bitc::ATTR_KIND_INLINE_HINT;
6720b57cec5SDimitry Andric   case Attribute::InReg:
6730b57cec5SDimitry Andric     return bitc::ATTR_KIND_IN_REG;
6740b57cec5SDimitry Andric   case Attribute::JumpTable:
6750b57cec5SDimitry Andric     return bitc::ATTR_KIND_JUMP_TABLE;
6760b57cec5SDimitry Andric   case Attribute::MinSize:
6770b57cec5SDimitry Andric     return bitc::ATTR_KIND_MIN_SIZE;
67881ad6265SDimitry Andric   case Attribute::AllocatedPointer:
67981ad6265SDimitry Andric     return bitc::ATTR_KIND_ALLOCATED_POINTER;
68081ad6265SDimitry Andric   case Attribute::AllocKind:
68181ad6265SDimitry Andric     return bitc::ATTR_KIND_ALLOC_KIND;
682bdd1243dSDimitry Andric   case Attribute::Memory:
683bdd1243dSDimitry Andric     return bitc::ATTR_KIND_MEMORY;
684*fe013be4SDimitry Andric   case Attribute::NoFPClass:
685*fe013be4SDimitry Andric     return bitc::ATTR_KIND_NOFPCLASS;
6860b57cec5SDimitry Andric   case Attribute::Naked:
6870b57cec5SDimitry Andric     return bitc::ATTR_KIND_NAKED;
6880b57cec5SDimitry Andric   case Attribute::Nest:
6890b57cec5SDimitry Andric     return bitc::ATTR_KIND_NEST;
6900b57cec5SDimitry Andric   case Attribute::NoAlias:
6910b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_ALIAS;
6920b57cec5SDimitry Andric   case Attribute::NoBuiltin:
6930b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_BUILTIN;
694e8d8bef9SDimitry Andric   case Attribute::NoCallback:
695e8d8bef9SDimitry Andric     return bitc::ATTR_KIND_NO_CALLBACK;
6960b57cec5SDimitry Andric   case Attribute::NoCapture:
6970b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_CAPTURE;
6980b57cec5SDimitry Andric   case Attribute::NoDuplicate:
6990b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_DUPLICATE;
7000b57cec5SDimitry Andric   case Attribute::NoFree:
7010b57cec5SDimitry Andric     return bitc::ATTR_KIND_NOFREE;
7020b57cec5SDimitry Andric   case Attribute::NoImplicitFloat:
7030b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_IMPLICIT_FLOAT;
7040b57cec5SDimitry Andric   case Attribute::NoInline:
7050b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_INLINE;
7060b57cec5SDimitry Andric   case Attribute::NoRecurse:
7070b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_RECURSE;
7085ffd83dbSDimitry Andric   case Attribute::NoMerge:
7095ffd83dbSDimitry Andric     return bitc::ATTR_KIND_NO_MERGE;
7100b57cec5SDimitry Andric   case Attribute::NonLazyBind:
7110b57cec5SDimitry Andric     return bitc::ATTR_KIND_NON_LAZY_BIND;
7120b57cec5SDimitry Andric   case Attribute::NonNull:
7130b57cec5SDimitry Andric     return bitc::ATTR_KIND_NON_NULL;
7140b57cec5SDimitry Andric   case Attribute::Dereferenceable:
7150b57cec5SDimitry Andric     return bitc::ATTR_KIND_DEREFERENCEABLE;
7160b57cec5SDimitry Andric   case Attribute::DereferenceableOrNull:
7170b57cec5SDimitry Andric     return bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL;
7180b57cec5SDimitry Andric   case Attribute::NoRedZone:
7190b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_RED_ZONE;
7200b57cec5SDimitry Andric   case Attribute::NoReturn:
7210b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_RETURN;
7220b57cec5SDimitry Andric   case Attribute::NoSync:
7230b57cec5SDimitry Andric     return bitc::ATTR_KIND_NOSYNC;
7240b57cec5SDimitry Andric   case Attribute::NoCfCheck:
7250b57cec5SDimitry Andric     return bitc::ATTR_KIND_NOCF_CHECK;
726e8d8bef9SDimitry Andric   case Attribute::NoProfile:
727e8d8bef9SDimitry Andric     return bitc::ATTR_KIND_NO_PROFILE;
728bdd1243dSDimitry Andric   case Attribute::SkipProfile:
729bdd1243dSDimitry Andric     return bitc::ATTR_KIND_SKIP_PROFILE;
7300b57cec5SDimitry Andric   case Attribute::NoUnwind:
7310b57cec5SDimitry Andric     return bitc::ATTR_KIND_NO_UNWIND;
73281ad6265SDimitry Andric   case Attribute::NoSanitizeBounds:
73381ad6265SDimitry Andric     return bitc::ATTR_KIND_NO_SANITIZE_BOUNDS;
734fe6060f1SDimitry Andric   case Attribute::NoSanitizeCoverage:
735fe6060f1SDimitry Andric     return bitc::ATTR_KIND_NO_SANITIZE_COVERAGE;
7365ffd83dbSDimitry Andric   case Attribute::NullPointerIsValid:
7375ffd83dbSDimitry Andric     return bitc::ATTR_KIND_NULL_POINTER_IS_VALID;
7380b57cec5SDimitry Andric   case Attribute::OptForFuzzing:
7390b57cec5SDimitry Andric     return bitc::ATTR_KIND_OPT_FOR_FUZZING;
7400b57cec5SDimitry Andric   case Attribute::OptimizeForSize:
7410b57cec5SDimitry Andric     return bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE;
7420b57cec5SDimitry Andric   case Attribute::OptimizeNone:
7430b57cec5SDimitry Andric     return bitc::ATTR_KIND_OPTIMIZE_NONE;
7440b57cec5SDimitry Andric   case Attribute::ReadNone:
7450b57cec5SDimitry Andric     return bitc::ATTR_KIND_READ_NONE;
7460b57cec5SDimitry Andric   case Attribute::ReadOnly:
7470b57cec5SDimitry Andric     return bitc::ATTR_KIND_READ_ONLY;
7480b57cec5SDimitry Andric   case Attribute::Returned:
7490b57cec5SDimitry Andric     return bitc::ATTR_KIND_RETURNED;
7500b57cec5SDimitry Andric   case Attribute::ReturnsTwice:
7510b57cec5SDimitry Andric     return bitc::ATTR_KIND_RETURNS_TWICE;
7520b57cec5SDimitry Andric   case Attribute::SExt:
7530b57cec5SDimitry Andric     return bitc::ATTR_KIND_S_EXT;
7540b57cec5SDimitry Andric   case Attribute::Speculatable:
7550b57cec5SDimitry Andric     return bitc::ATTR_KIND_SPECULATABLE;
7560b57cec5SDimitry Andric   case Attribute::StackAlignment:
7570b57cec5SDimitry Andric     return bitc::ATTR_KIND_STACK_ALIGNMENT;
7580b57cec5SDimitry Andric   case Attribute::StackProtect:
7590b57cec5SDimitry Andric     return bitc::ATTR_KIND_STACK_PROTECT;
7600b57cec5SDimitry Andric   case Attribute::StackProtectReq:
7610b57cec5SDimitry Andric     return bitc::ATTR_KIND_STACK_PROTECT_REQ;
7620b57cec5SDimitry Andric   case Attribute::StackProtectStrong:
7630b57cec5SDimitry Andric     return bitc::ATTR_KIND_STACK_PROTECT_STRONG;
7640b57cec5SDimitry Andric   case Attribute::SafeStack:
7650b57cec5SDimitry Andric     return bitc::ATTR_KIND_SAFESTACK;
7660b57cec5SDimitry Andric   case Attribute::ShadowCallStack:
7670b57cec5SDimitry Andric     return bitc::ATTR_KIND_SHADOWCALLSTACK;
7680b57cec5SDimitry Andric   case Attribute::StrictFP:
7690b57cec5SDimitry Andric     return bitc::ATTR_KIND_STRICT_FP;
7700b57cec5SDimitry Andric   case Attribute::StructRet:
7710b57cec5SDimitry Andric     return bitc::ATTR_KIND_STRUCT_RET;
7720b57cec5SDimitry Andric   case Attribute::SanitizeAddress:
7730b57cec5SDimitry Andric     return bitc::ATTR_KIND_SANITIZE_ADDRESS;
7740b57cec5SDimitry Andric   case Attribute::SanitizeHWAddress:
7750b57cec5SDimitry Andric     return bitc::ATTR_KIND_SANITIZE_HWADDRESS;
7760b57cec5SDimitry Andric   case Attribute::SanitizeThread:
7770b57cec5SDimitry Andric     return bitc::ATTR_KIND_SANITIZE_THREAD;
7780b57cec5SDimitry Andric   case Attribute::SanitizeMemory:
7790b57cec5SDimitry Andric     return bitc::ATTR_KIND_SANITIZE_MEMORY;
7800b57cec5SDimitry Andric   case Attribute::SpeculativeLoadHardening:
7810b57cec5SDimitry Andric     return bitc::ATTR_KIND_SPECULATIVE_LOAD_HARDENING;
7820b57cec5SDimitry Andric   case Attribute::SwiftError:
7830b57cec5SDimitry Andric     return bitc::ATTR_KIND_SWIFT_ERROR;
7840b57cec5SDimitry Andric   case Attribute::SwiftSelf:
7850b57cec5SDimitry Andric     return bitc::ATTR_KIND_SWIFT_SELF;
786fe6060f1SDimitry Andric   case Attribute::SwiftAsync:
787fe6060f1SDimitry Andric     return bitc::ATTR_KIND_SWIFT_ASYNC;
7880b57cec5SDimitry Andric   case Attribute::UWTable:
7890b57cec5SDimitry Andric     return bitc::ATTR_KIND_UW_TABLE;
790fe6060f1SDimitry Andric   case Attribute::VScaleRange:
791fe6060f1SDimitry Andric     return bitc::ATTR_KIND_VSCALE_RANGE;
7920b57cec5SDimitry Andric   case Attribute::WillReturn:
7930b57cec5SDimitry Andric     return bitc::ATTR_KIND_WILLRETURN;
7940b57cec5SDimitry Andric   case Attribute::WriteOnly:
7950b57cec5SDimitry Andric     return bitc::ATTR_KIND_WRITEONLY;
7960b57cec5SDimitry Andric   case Attribute::ZExt:
7970b57cec5SDimitry Andric     return bitc::ATTR_KIND_Z_EXT;
7980b57cec5SDimitry Andric   case Attribute::ImmArg:
7990b57cec5SDimitry Andric     return bitc::ATTR_KIND_IMMARG;
8000b57cec5SDimitry Andric   case Attribute::SanitizeMemTag:
8010b57cec5SDimitry Andric     return bitc::ATTR_KIND_SANITIZE_MEMTAG;
8025ffd83dbSDimitry Andric   case Attribute::Preallocated:
8035ffd83dbSDimitry Andric     return bitc::ATTR_KIND_PREALLOCATED;
8045ffd83dbSDimitry Andric   case Attribute::NoUndef:
8055ffd83dbSDimitry Andric     return bitc::ATTR_KIND_NOUNDEF;
806e8d8bef9SDimitry Andric   case Attribute::ByRef:
807e8d8bef9SDimitry Andric     return bitc::ATTR_KIND_BYREF;
808e8d8bef9SDimitry Andric   case Attribute::MustProgress:
809e8d8bef9SDimitry Andric     return bitc::ATTR_KIND_MUSTPROGRESS;
81081ad6265SDimitry Andric   case Attribute::PresplitCoroutine:
81181ad6265SDimitry Andric     return bitc::ATTR_KIND_PRESPLIT_COROUTINE;
8120b57cec5SDimitry Andric   case Attribute::EndAttrKinds:
8130b57cec5SDimitry Andric     llvm_unreachable("Can not encode end-attribute kinds marker.");
8140b57cec5SDimitry Andric   case Attribute::None:
8150b57cec5SDimitry Andric     llvm_unreachable("Can not encode none-attribute.");
8165ffd83dbSDimitry Andric   case Attribute::EmptyKey:
8175ffd83dbSDimitry Andric   case Attribute::TombstoneKey:
8185ffd83dbSDimitry Andric     llvm_unreachable("Trying to encode EmptyKey/TombstoneKey");
8190b57cec5SDimitry Andric   }
8200b57cec5SDimitry Andric 
8210b57cec5SDimitry Andric   llvm_unreachable("Trying to encode unknown attribute");
8220b57cec5SDimitry Andric }
8230b57cec5SDimitry Andric 
8240b57cec5SDimitry Andric void ModuleBitcodeWriter::writeAttributeGroupTable() {
8250b57cec5SDimitry Andric   const std::vector<ValueEnumerator::IndexAndAttrSet> &AttrGrps =
8260b57cec5SDimitry Andric       VE.getAttributeGroups();
8270b57cec5SDimitry Andric   if (AttrGrps.empty()) return;
8280b57cec5SDimitry Andric 
8290b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::PARAMATTR_GROUP_BLOCK_ID, 3);
8300b57cec5SDimitry Andric 
8310b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
8320b57cec5SDimitry Andric   for (ValueEnumerator::IndexAndAttrSet Pair : AttrGrps) {
8330b57cec5SDimitry Andric     unsigned AttrListIndex = Pair.first;
8340b57cec5SDimitry Andric     AttributeSet AS = Pair.second;
8350b57cec5SDimitry Andric     Record.push_back(VE.getAttributeGroupID(Pair));
8360b57cec5SDimitry Andric     Record.push_back(AttrListIndex);
8370b57cec5SDimitry Andric 
8380b57cec5SDimitry Andric     for (Attribute Attr : AS) {
8390b57cec5SDimitry Andric       if (Attr.isEnumAttribute()) {
8400b57cec5SDimitry Andric         Record.push_back(0);
8410b57cec5SDimitry Andric         Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
8420b57cec5SDimitry Andric       } else if (Attr.isIntAttribute()) {
8430b57cec5SDimitry Andric         Record.push_back(1);
8440b57cec5SDimitry Andric         Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
8450b57cec5SDimitry Andric         Record.push_back(Attr.getValueAsInt());
8460b57cec5SDimitry Andric       } else if (Attr.isStringAttribute()) {
8470b57cec5SDimitry Andric         StringRef Kind = Attr.getKindAsString();
8480b57cec5SDimitry Andric         StringRef Val = Attr.getValueAsString();
8490b57cec5SDimitry Andric 
8500b57cec5SDimitry Andric         Record.push_back(Val.empty() ? 3 : 4);
8510b57cec5SDimitry Andric         Record.append(Kind.begin(), Kind.end());
8520b57cec5SDimitry Andric         Record.push_back(0);
8530b57cec5SDimitry Andric         if (!Val.empty()) {
8540b57cec5SDimitry Andric           Record.append(Val.begin(), Val.end());
8550b57cec5SDimitry Andric           Record.push_back(0);
8560b57cec5SDimitry Andric         }
8570b57cec5SDimitry Andric       } else {
8580b57cec5SDimitry Andric         assert(Attr.isTypeAttribute());
8590b57cec5SDimitry Andric         Type *Ty = Attr.getValueAsType();
8600b57cec5SDimitry Andric         Record.push_back(Ty ? 6 : 5);
8610b57cec5SDimitry Andric         Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
8620b57cec5SDimitry Andric         if (Ty)
8630b57cec5SDimitry Andric           Record.push_back(VE.getTypeID(Attr.getValueAsType()));
8640b57cec5SDimitry Andric       }
8650b57cec5SDimitry Andric     }
8660b57cec5SDimitry Andric 
8670b57cec5SDimitry Andric     Stream.EmitRecord(bitc::PARAMATTR_GRP_CODE_ENTRY, Record);
8680b57cec5SDimitry Andric     Record.clear();
8690b57cec5SDimitry Andric   }
8700b57cec5SDimitry Andric 
8710b57cec5SDimitry Andric   Stream.ExitBlock();
8720b57cec5SDimitry Andric }
8730b57cec5SDimitry Andric 
8740b57cec5SDimitry Andric void ModuleBitcodeWriter::writeAttributeTable() {
8750b57cec5SDimitry Andric   const std::vector<AttributeList> &Attrs = VE.getAttributeLists();
8760b57cec5SDimitry Andric   if (Attrs.empty()) return;
8770b57cec5SDimitry Andric 
8780b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
8790b57cec5SDimitry Andric 
8800b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
8810eae32dcSDimitry Andric   for (const AttributeList &AL : Attrs) {
882349cc55cSDimitry Andric     for (unsigned i : AL.indexes()) {
8830b57cec5SDimitry Andric       AttributeSet AS = AL.getAttributes(i);
8840b57cec5SDimitry Andric       if (AS.hasAttributes())
8850b57cec5SDimitry Andric         Record.push_back(VE.getAttributeGroupID({i, AS}));
8860b57cec5SDimitry Andric     }
8870b57cec5SDimitry Andric 
8880b57cec5SDimitry Andric     Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
8890b57cec5SDimitry Andric     Record.clear();
8900b57cec5SDimitry Andric   }
8910b57cec5SDimitry Andric 
8920b57cec5SDimitry Andric   Stream.ExitBlock();
8930b57cec5SDimitry Andric }
8940b57cec5SDimitry Andric 
8950b57cec5SDimitry Andric /// WriteTypeTable - Write out the type table for a module.
8960b57cec5SDimitry Andric void ModuleBitcodeWriter::writeTypeTable() {
8970b57cec5SDimitry Andric   const ValueEnumerator::TypeList &TypeList = VE.getTypes();
8980b57cec5SDimitry Andric 
8990b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */);
9000b57cec5SDimitry Andric   SmallVector<uint64_t, 64> TypeVals;
9010b57cec5SDimitry Andric 
9020b57cec5SDimitry Andric   uint64_t NumBits = VE.computeBitsRequiredForTypeIndicies();
9030b57cec5SDimitry Andric 
904fe6060f1SDimitry Andric   // Abbrev for TYPE_CODE_OPAQUE_POINTER.
905*fe013be4SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
906fe6060f1SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_OPAQUE_POINTER));
907fe6060f1SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(0)); // Addrspace = 0
908fe6060f1SDimitry Andric   unsigned OpaquePtrAbbrev = Stream.EmitAbbrev(std::move(Abbv));
909fe6060f1SDimitry Andric 
9100b57cec5SDimitry Andric   // Abbrev for TYPE_CODE_FUNCTION.
9110b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
9120b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
9130b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // isvararg
9140b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
9150b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
9160b57cec5SDimitry Andric   unsigned FunctionAbbrev = Stream.EmitAbbrev(std::move(Abbv));
9170b57cec5SDimitry Andric 
9180b57cec5SDimitry Andric   // Abbrev for TYPE_CODE_STRUCT_ANON.
9190b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
9200b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON));
9210b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // ispacked
9220b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
9230b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
9240b57cec5SDimitry Andric   unsigned StructAnonAbbrev = Stream.EmitAbbrev(std::move(Abbv));
9250b57cec5SDimitry Andric 
9260b57cec5SDimitry Andric   // Abbrev for TYPE_CODE_STRUCT_NAME.
9270b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
9280b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME));
9290b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
9300b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
9310b57cec5SDimitry Andric   unsigned StructNameAbbrev = Stream.EmitAbbrev(std::move(Abbv));
9320b57cec5SDimitry Andric 
9330b57cec5SDimitry Andric   // Abbrev for TYPE_CODE_STRUCT_NAMED.
9340b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
9350b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED));
9360b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // ispacked
9370b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
9380b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
9390b57cec5SDimitry Andric   unsigned StructNamedAbbrev = Stream.EmitAbbrev(std::move(Abbv));
9400b57cec5SDimitry Andric 
9410b57cec5SDimitry Andric   // Abbrev for TYPE_CODE_ARRAY.
9420b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
9430b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
9440b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // size
9450b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
9460b57cec5SDimitry Andric   unsigned ArrayAbbrev = Stream.EmitAbbrev(std::move(Abbv));
9470b57cec5SDimitry Andric 
9480b57cec5SDimitry Andric   // Emit an entry count so the reader can reserve space.
9490b57cec5SDimitry Andric   TypeVals.push_back(TypeList.size());
9500b57cec5SDimitry Andric   Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
9510b57cec5SDimitry Andric   TypeVals.clear();
9520b57cec5SDimitry Andric 
9530b57cec5SDimitry Andric   // Loop over all of the types, emitting each in turn.
9544824e7fdSDimitry Andric   for (Type *T : TypeList) {
9550b57cec5SDimitry Andric     int AbbrevToUse = 0;
9560b57cec5SDimitry Andric     unsigned Code = 0;
9570b57cec5SDimitry Andric 
9580b57cec5SDimitry Andric     switch (T->getTypeID()) {
9590b57cec5SDimitry Andric     case Type::VoidTyID:      Code = bitc::TYPE_CODE_VOID;      break;
9600b57cec5SDimitry Andric     case Type::HalfTyID:      Code = bitc::TYPE_CODE_HALF;      break;
9615ffd83dbSDimitry Andric     case Type::BFloatTyID:    Code = bitc::TYPE_CODE_BFLOAT;    break;
9620b57cec5SDimitry Andric     case Type::FloatTyID:     Code = bitc::TYPE_CODE_FLOAT;     break;
9630b57cec5SDimitry Andric     case Type::DoubleTyID:    Code = bitc::TYPE_CODE_DOUBLE;    break;
9640b57cec5SDimitry Andric     case Type::X86_FP80TyID:  Code = bitc::TYPE_CODE_X86_FP80;  break;
9650b57cec5SDimitry Andric     case Type::FP128TyID:     Code = bitc::TYPE_CODE_FP128;     break;
9660b57cec5SDimitry Andric     case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break;
9670b57cec5SDimitry Andric     case Type::LabelTyID:     Code = bitc::TYPE_CODE_LABEL;     break;
9680b57cec5SDimitry Andric     case Type::MetadataTyID:  Code = bitc::TYPE_CODE_METADATA;  break;
9690b57cec5SDimitry Andric     case Type::X86_MMXTyID:   Code = bitc::TYPE_CODE_X86_MMX;   break;
970e8d8bef9SDimitry Andric     case Type::X86_AMXTyID:   Code = bitc::TYPE_CODE_X86_AMX;   break;
9710b57cec5SDimitry Andric     case Type::TokenTyID:     Code = bitc::TYPE_CODE_TOKEN;     break;
9720b57cec5SDimitry Andric     case Type::IntegerTyID:
9730b57cec5SDimitry Andric       // INTEGER: [width]
9740b57cec5SDimitry Andric       Code = bitc::TYPE_CODE_INTEGER;
9750b57cec5SDimitry Andric       TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
9760b57cec5SDimitry Andric       break;
9770b57cec5SDimitry Andric     case Type::PointerTyID: {
9780b57cec5SDimitry Andric       PointerType *PTy = cast<PointerType>(T);
979fe6060f1SDimitry Andric       unsigned AddressSpace = PTy->getAddressSpace();
980fe6060f1SDimitry Andric       // OPAQUE_POINTER: [address space]
981fe6060f1SDimitry Andric       Code = bitc::TYPE_CODE_OPAQUE_POINTER;
982fe6060f1SDimitry Andric       TypeVals.push_back(AddressSpace);
983fe6060f1SDimitry Andric       if (AddressSpace == 0)
984fe6060f1SDimitry Andric         AbbrevToUse = OpaquePtrAbbrev;
9850b57cec5SDimitry Andric       break;
9860b57cec5SDimitry Andric     }
9870b57cec5SDimitry Andric     case Type::FunctionTyID: {
9880b57cec5SDimitry Andric       FunctionType *FT = cast<FunctionType>(T);
9890b57cec5SDimitry Andric       // FUNCTION: [isvararg, retty, paramty x N]
9900b57cec5SDimitry Andric       Code = bitc::TYPE_CODE_FUNCTION;
9910b57cec5SDimitry Andric       TypeVals.push_back(FT->isVarArg());
9920b57cec5SDimitry Andric       TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
9930b57cec5SDimitry Andric       for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
9940b57cec5SDimitry Andric         TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
9950b57cec5SDimitry Andric       AbbrevToUse = FunctionAbbrev;
9960b57cec5SDimitry Andric       break;
9970b57cec5SDimitry Andric     }
9980b57cec5SDimitry Andric     case Type::StructTyID: {
9990b57cec5SDimitry Andric       StructType *ST = cast<StructType>(T);
10000b57cec5SDimitry Andric       // STRUCT: [ispacked, eltty x N]
10010b57cec5SDimitry Andric       TypeVals.push_back(ST->isPacked());
10020b57cec5SDimitry Andric       // Output all of the element types.
1003349cc55cSDimitry Andric       for (Type *ET : ST->elements())
1004349cc55cSDimitry Andric         TypeVals.push_back(VE.getTypeID(ET));
10050b57cec5SDimitry Andric 
10060b57cec5SDimitry Andric       if (ST->isLiteral()) {
10070b57cec5SDimitry Andric         Code = bitc::TYPE_CODE_STRUCT_ANON;
10080b57cec5SDimitry Andric         AbbrevToUse = StructAnonAbbrev;
10090b57cec5SDimitry Andric       } else {
10100b57cec5SDimitry Andric         if (ST->isOpaque()) {
10110b57cec5SDimitry Andric           Code = bitc::TYPE_CODE_OPAQUE;
10120b57cec5SDimitry Andric         } else {
10130b57cec5SDimitry Andric           Code = bitc::TYPE_CODE_STRUCT_NAMED;
10140b57cec5SDimitry Andric           AbbrevToUse = StructNamedAbbrev;
10150b57cec5SDimitry Andric         }
10160b57cec5SDimitry Andric 
10170b57cec5SDimitry Andric         // Emit the name if it is present.
10180b57cec5SDimitry Andric         if (!ST->getName().empty())
10190b57cec5SDimitry Andric           writeStringRecord(Stream, bitc::TYPE_CODE_STRUCT_NAME, ST->getName(),
10200b57cec5SDimitry Andric                             StructNameAbbrev);
10210b57cec5SDimitry Andric       }
10220b57cec5SDimitry Andric       break;
10230b57cec5SDimitry Andric     }
10240b57cec5SDimitry Andric     case Type::ArrayTyID: {
10250b57cec5SDimitry Andric       ArrayType *AT = cast<ArrayType>(T);
10260b57cec5SDimitry Andric       // ARRAY: [numelts, eltty]
10270b57cec5SDimitry Andric       Code = bitc::TYPE_CODE_ARRAY;
10280b57cec5SDimitry Andric       TypeVals.push_back(AT->getNumElements());
10290b57cec5SDimitry Andric       TypeVals.push_back(VE.getTypeID(AT->getElementType()));
10300b57cec5SDimitry Andric       AbbrevToUse = ArrayAbbrev;
10310b57cec5SDimitry Andric       break;
10320b57cec5SDimitry Andric     }
10335ffd83dbSDimitry Andric     case Type::FixedVectorTyID:
10345ffd83dbSDimitry Andric     case Type::ScalableVectorTyID: {
10350b57cec5SDimitry Andric       VectorType *VT = cast<VectorType>(T);
10360b57cec5SDimitry Andric       // VECTOR [numelts, eltty] or
10370b57cec5SDimitry Andric       //        [numelts, eltty, scalable]
10380b57cec5SDimitry Andric       Code = bitc::TYPE_CODE_VECTOR;
1039e8d8bef9SDimitry Andric       TypeVals.push_back(VT->getElementCount().getKnownMinValue());
10400b57cec5SDimitry Andric       TypeVals.push_back(VE.getTypeID(VT->getElementType()));
10415ffd83dbSDimitry Andric       if (isa<ScalableVectorType>(VT))
10425ffd83dbSDimitry Andric         TypeVals.push_back(true);
10430b57cec5SDimitry Andric       break;
10440b57cec5SDimitry Andric     }
1045bdd1243dSDimitry Andric     case Type::TargetExtTyID: {
1046bdd1243dSDimitry Andric       TargetExtType *TET = cast<TargetExtType>(T);
1047bdd1243dSDimitry Andric       Code = bitc::TYPE_CODE_TARGET_TYPE;
1048bdd1243dSDimitry Andric       writeStringRecord(Stream, bitc::TYPE_CODE_STRUCT_NAME, TET->getName(),
1049bdd1243dSDimitry Andric                         StructNameAbbrev);
1050bdd1243dSDimitry Andric       TypeVals.push_back(TET->getNumTypeParameters());
1051bdd1243dSDimitry Andric       for (Type *InnerTy : TET->type_params())
1052bdd1243dSDimitry Andric         TypeVals.push_back(VE.getTypeID(InnerTy));
1053bdd1243dSDimitry Andric       for (unsigned IntParam : TET->int_params())
1054bdd1243dSDimitry Andric         TypeVals.push_back(IntParam);
1055bdd1243dSDimitry Andric       break;
1056bdd1243dSDimitry Andric     }
1057bdd1243dSDimitry Andric     case Type::TypedPointerTyID:
1058bdd1243dSDimitry Andric       llvm_unreachable("Typed pointers cannot be added to IR modules");
10590b57cec5SDimitry Andric     }
10600b57cec5SDimitry Andric 
10610b57cec5SDimitry Andric     // Emit the finished record.
10620b57cec5SDimitry Andric     Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
10630b57cec5SDimitry Andric     TypeVals.clear();
10640b57cec5SDimitry Andric   }
10650b57cec5SDimitry Andric 
10660b57cec5SDimitry Andric   Stream.ExitBlock();
10670b57cec5SDimitry Andric }
10680b57cec5SDimitry Andric 
10690b57cec5SDimitry Andric static unsigned getEncodedLinkage(const GlobalValue::LinkageTypes Linkage) {
10700b57cec5SDimitry Andric   switch (Linkage) {
10710b57cec5SDimitry Andric   case GlobalValue::ExternalLinkage:
10720b57cec5SDimitry Andric     return 0;
10730b57cec5SDimitry Andric   case GlobalValue::WeakAnyLinkage:
10740b57cec5SDimitry Andric     return 16;
10750b57cec5SDimitry Andric   case GlobalValue::AppendingLinkage:
10760b57cec5SDimitry Andric     return 2;
10770b57cec5SDimitry Andric   case GlobalValue::InternalLinkage:
10780b57cec5SDimitry Andric     return 3;
10790b57cec5SDimitry Andric   case GlobalValue::LinkOnceAnyLinkage:
10800b57cec5SDimitry Andric     return 18;
10810b57cec5SDimitry Andric   case GlobalValue::ExternalWeakLinkage:
10820b57cec5SDimitry Andric     return 7;
10830b57cec5SDimitry Andric   case GlobalValue::CommonLinkage:
10840b57cec5SDimitry Andric     return 8;
10850b57cec5SDimitry Andric   case GlobalValue::PrivateLinkage:
10860b57cec5SDimitry Andric     return 9;
10870b57cec5SDimitry Andric   case GlobalValue::WeakODRLinkage:
10880b57cec5SDimitry Andric     return 17;
10890b57cec5SDimitry Andric   case GlobalValue::LinkOnceODRLinkage:
10900b57cec5SDimitry Andric     return 19;
10910b57cec5SDimitry Andric   case GlobalValue::AvailableExternallyLinkage:
10920b57cec5SDimitry Andric     return 12;
10930b57cec5SDimitry Andric   }
10940b57cec5SDimitry Andric   llvm_unreachable("Invalid linkage");
10950b57cec5SDimitry Andric }
10960b57cec5SDimitry Andric 
10970b57cec5SDimitry Andric static unsigned getEncodedLinkage(const GlobalValue &GV) {
10980b57cec5SDimitry Andric   return getEncodedLinkage(GV.getLinkage());
10990b57cec5SDimitry Andric }
11000b57cec5SDimitry Andric 
11010b57cec5SDimitry Andric static uint64_t getEncodedFFlags(FunctionSummary::FFlags Flags) {
11020b57cec5SDimitry Andric   uint64_t RawFlags = 0;
11030b57cec5SDimitry Andric   RawFlags |= Flags.ReadNone;
11040b57cec5SDimitry Andric   RawFlags |= (Flags.ReadOnly << 1);
11050b57cec5SDimitry Andric   RawFlags |= (Flags.NoRecurse << 2);
11060b57cec5SDimitry Andric   RawFlags |= (Flags.ReturnDoesNotAlias << 3);
11070b57cec5SDimitry Andric   RawFlags |= (Flags.NoInline << 4);
1108480093f4SDimitry Andric   RawFlags |= (Flags.AlwaysInline << 5);
1109349cc55cSDimitry Andric   RawFlags |= (Flags.NoUnwind << 6);
1110349cc55cSDimitry Andric   RawFlags |= (Flags.MayThrow << 7);
1111349cc55cSDimitry Andric   RawFlags |= (Flags.HasUnknownCall << 8);
11120eae32dcSDimitry Andric   RawFlags |= (Flags.MustBeUnreachable << 9);
11130b57cec5SDimitry Andric   return RawFlags;
11140b57cec5SDimitry Andric }
11150b57cec5SDimitry Andric 
1116fe6060f1SDimitry Andric // Decode the flags for GlobalValue in the summary. See getDecodedGVSummaryFlags
1117fe6060f1SDimitry Andric // in BitcodeReader.cpp.
11180b57cec5SDimitry Andric static uint64_t getEncodedGVSummaryFlags(GlobalValueSummary::GVFlags Flags) {
11190b57cec5SDimitry Andric   uint64_t RawFlags = 0;
11200b57cec5SDimitry Andric 
11210b57cec5SDimitry Andric   RawFlags |= Flags.NotEligibleToImport; // bool
11220b57cec5SDimitry Andric   RawFlags |= (Flags.Live << 1);
11230b57cec5SDimitry Andric   RawFlags |= (Flags.DSOLocal << 2);
11240b57cec5SDimitry Andric   RawFlags |= (Flags.CanAutoHide << 3);
11250b57cec5SDimitry Andric 
11260b57cec5SDimitry Andric   // Linkage don't need to be remapped at that time for the summary. Any future
11270b57cec5SDimitry Andric   // change to the getEncodedLinkage() function will need to be taken into
11280b57cec5SDimitry Andric   // account here as well.
11290b57cec5SDimitry Andric   RawFlags = (RawFlags << 4) | Flags.Linkage; // 4 bits
11300b57cec5SDimitry Andric 
1131fe6060f1SDimitry Andric   RawFlags |= (Flags.Visibility << 8); // 2 bits
1132fe6060f1SDimitry Andric 
11330b57cec5SDimitry Andric   return RawFlags;
11340b57cec5SDimitry Andric }
11350b57cec5SDimitry Andric 
11360b57cec5SDimitry Andric static uint64_t getEncodedGVarFlags(GlobalVarSummary::GVarFlags Flags) {
11375ffd83dbSDimitry Andric   uint64_t RawFlags = Flags.MaybeReadOnly | (Flags.MaybeWriteOnly << 1) |
11385ffd83dbSDimitry Andric                       (Flags.Constant << 2) | Flags.VCallVisibility << 3;
11390b57cec5SDimitry Andric   return RawFlags;
11400b57cec5SDimitry Andric }
11410b57cec5SDimitry Andric 
11420b57cec5SDimitry Andric static unsigned getEncodedVisibility(const GlobalValue &GV) {
11430b57cec5SDimitry Andric   switch (GV.getVisibility()) {
11440b57cec5SDimitry Andric   case GlobalValue::DefaultVisibility:   return 0;
11450b57cec5SDimitry Andric   case GlobalValue::HiddenVisibility:    return 1;
11460b57cec5SDimitry Andric   case GlobalValue::ProtectedVisibility: return 2;
11470b57cec5SDimitry Andric   }
11480b57cec5SDimitry Andric   llvm_unreachable("Invalid visibility");
11490b57cec5SDimitry Andric }
11500b57cec5SDimitry Andric 
11510b57cec5SDimitry Andric static unsigned getEncodedDLLStorageClass(const GlobalValue &GV) {
11520b57cec5SDimitry Andric   switch (GV.getDLLStorageClass()) {
11530b57cec5SDimitry Andric   case GlobalValue::DefaultStorageClass:   return 0;
11540b57cec5SDimitry Andric   case GlobalValue::DLLImportStorageClass: return 1;
11550b57cec5SDimitry Andric   case GlobalValue::DLLExportStorageClass: return 2;
11560b57cec5SDimitry Andric   }
11570b57cec5SDimitry Andric   llvm_unreachable("Invalid DLL storage class");
11580b57cec5SDimitry Andric }
11590b57cec5SDimitry Andric 
11600b57cec5SDimitry Andric static unsigned getEncodedThreadLocalMode(const GlobalValue &GV) {
11610b57cec5SDimitry Andric   switch (GV.getThreadLocalMode()) {
11620b57cec5SDimitry Andric     case GlobalVariable::NotThreadLocal:         return 0;
11630b57cec5SDimitry Andric     case GlobalVariable::GeneralDynamicTLSModel: return 1;
11640b57cec5SDimitry Andric     case GlobalVariable::LocalDynamicTLSModel:   return 2;
11650b57cec5SDimitry Andric     case GlobalVariable::InitialExecTLSModel:    return 3;
11660b57cec5SDimitry Andric     case GlobalVariable::LocalExecTLSModel:      return 4;
11670b57cec5SDimitry Andric   }
11680b57cec5SDimitry Andric   llvm_unreachable("Invalid TLS model");
11690b57cec5SDimitry Andric }
11700b57cec5SDimitry Andric 
11710b57cec5SDimitry Andric static unsigned getEncodedComdatSelectionKind(const Comdat &C) {
11720b57cec5SDimitry Andric   switch (C.getSelectionKind()) {
11730b57cec5SDimitry Andric   case Comdat::Any:
11740b57cec5SDimitry Andric     return bitc::COMDAT_SELECTION_KIND_ANY;
11750b57cec5SDimitry Andric   case Comdat::ExactMatch:
11760b57cec5SDimitry Andric     return bitc::COMDAT_SELECTION_KIND_EXACT_MATCH;
11770b57cec5SDimitry Andric   case Comdat::Largest:
11780b57cec5SDimitry Andric     return bitc::COMDAT_SELECTION_KIND_LARGEST;
1179fe6060f1SDimitry Andric   case Comdat::NoDeduplicate:
11800b57cec5SDimitry Andric     return bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES;
11810b57cec5SDimitry Andric   case Comdat::SameSize:
11820b57cec5SDimitry Andric     return bitc::COMDAT_SELECTION_KIND_SAME_SIZE;
11830b57cec5SDimitry Andric   }
11840b57cec5SDimitry Andric   llvm_unreachable("Invalid selection kind");
11850b57cec5SDimitry Andric }
11860b57cec5SDimitry Andric 
11870b57cec5SDimitry Andric static unsigned getEncodedUnnamedAddr(const GlobalValue &GV) {
11880b57cec5SDimitry Andric   switch (GV.getUnnamedAddr()) {
11890b57cec5SDimitry Andric   case GlobalValue::UnnamedAddr::None:   return 0;
11900b57cec5SDimitry Andric   case GlobalValue::UnnamedAddr::Local:  return 2;
11910b57cec5SDimitry Andric   case GlobalValue::UnnamedAddr::Global: return 1;
11920b57cec5SDimitry Andric   }
11930b57cec5SDimitry Andric   llvm_unreachable("Invalid unnamed_addr");
11940b57cec5SDimitry Andric }
11950b57cec5SDimitry Andric 
11960b57cec5SDimitry Andric size_t ModuleBitcodeWriter::addToStrtab(StringRef Str) {
11970b57cec5SDimitry Andric   if (GenerateHash)
11980b57cec5SDimitry Andric     Hasher.update(Str);
11990b57cec5SDimitry Andric   return StrtabBuilder.add(Str);
12000b57cec5SDimitry Andric }
12010b57cec5SDimitry Andric 
12020b57cec5SDimitry Andric void ModuleBitcodeWriter::writeComdats() {
12030b57cec5SDimitry Andric   SmallVector<unsigned, 64> Vals;
12040b57cec5SDimitry Andric   for (const Comdat *C : VE.getComdats()) {
12050b57cec5SDimitry Andric     // COMDAT: [strtab offset, strtab size, selection_kind]
12060b57cec5SDimitry Andric     Vals.push_back(addToStrtab(C->getName()));
12070b57cec5SDimitry Andric     Vals.push_back(C->getName().size());
12080b57cec5SDimitry Andric     Vals.push_back(getEncodedComdatSelectionKind(*C));
12090b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_COMDAT, Vals, /*AbbrevToUse=*/0);
12100b57cec5SDimitry Andric     Vals.clear();
12110b57cec5SDimitry Andric   }
12120b57cec5SDimitry Andric }
12130b57cec5SDimitry Andric 
12140b57cec5SDimitry Andric /// Write a record that will eventually hold the word offset of the
12150b57cec5SDimitry Andric /// module-level VST. For now the offset is 0, which will be backpatched
12160b57cec5SDimitry Andric /// after the real VST is written. Saves the bit offset to backpatch.
12170b57cec5SDimitry Andric void ModuleBitcodeWriter::writeValueSymbolTableForwardDecl() {
12180b57cec5SDimitry Andric   // Write a placeholder value in for the offset of the real VST,
12190b57cec5SDimitry Andric   // which is written after the function blocks so that it can include
12200b57cec5SDimitry Andric   // the offset of each function. The placeholder offset will be
12210b57cec5SDimitry Andric   // updated when the real VST is written.
12220b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
12230b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_VSTOFFSET));
12240b57cec5SDimitry Andric   // Blocks are 32-bit aligned, so we can use a 32-bit word offset to
12250b57cec5SDimitry Andric   // hold the real VST offset. Must use fixed instead of VBR as we don't
12260b57cec5SDimitry Andric   // know how many VBR chunks to reserve ahead of time.
12270b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
12280b57cec5SDimitry Andric   unsigned VSTOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbv));
12290b57cec5SDimitry Andric 
12300b57cec5SDimitry Andric   // Emit the placeholder
12310b57cec5SDimitry Andric   uint64_t Vals[] = {bitc::MODULE_CODE_VSTOFFSET, 0};
12320b57cec5SDimitry Andric   Stream.EmitRecordWithAbbrev(VSTOffsetAbbrev, Vals);
12330b57cec5SDimitry Andric 
12340b57cec5SDimitry Andric   // Compute and save the bit offset to the placeholder, which will be
12350b57cec5SDimitry Andric   // patched when the real VST is written. We can simply subtract the 32-bit
12360b57cec5SDimitry Andric   // fixed size from the current bit number to get the location to backpatch.
12370b57cec5SDimitry Andric   VSTOffsetPlaceholder = Stream.GetCurrentBitNo() - 32;
12380b57cec5SDimitry Andric }
12390b57cec5SDimitry Andric 
12400b57cec5SDimitry Andric enum StringEncoding { SE_Char6, SE_Fixed7, SE_Fixed8 };
12410b57cec5SDimitry Andric 
12420b57cec5SDimitry Andric /// Determine the encoding to use for the given string name and length.
12430b57cec5SDimitry Andric static StringEncoding getStringEncoding(StringRef Str) {
12440b57cec5SDimitry Andric   bool isChar6 = true;
12450b57cec5SDimitry Andric   for (char C : Str) {
12460b57cec5SDimitry Andric     if (isChar6)
12470b57cec5SDimitry Andric       isChar6 = BitCodeAbbrevOp::isChar6(C);
12480b57cec5SDimitry Andric     if ((unsigned char)C & 128)
12490b57cec5SDimitry Andric       // don't bother scanning the rest.
12500b57cec5SDimitry Andric       return SE_Fixed8;
12510b57cec5SDimitry Andric   }
12520b57cec5SDimitry Andric   if (isChar6)
12530b57cec5SDimitry Andric     return SE_Char6;
12540b57cec5SDimitry Andric   return SE_Fixed7;
12550b57cec5SDimitry Andric }
12560b57cec5SDimitry Andric 
125781ad6265SDimitry Andric static_assert(sizeof(GlobalValue::SanitizerMetadata) <= sizeof(unsigned),
125881ad6265SDimitry Andric               "Sanitizer Metadata is too large for naive serialization.");
125981ad6265SDimitry Andric static unsigned
126081ad6265SDimitry Andric serializeSanitizerMetadata(const GlobalValue::SanitizerMetadata &Meta) {
126181ad6265SDimitry Andric   return Meta.NoAddress | (Meta.NoHWAddress << 1) |
1262753f127fSDimitry Andric          (Meta.Memtag << 2) | (Meta.IsDynInit << 3);
126381ad6265SDimitry Andric }
126481ad6265SDimitry Andric 
12650b57cec5SDimitry Andric /// Emit top-level description of module, including target triple, inline asm,
12660b57cec5SDimitry Andric /// descriptors for global variables, and function prototype info.
12670b57cec5SDimitry Andric /// Returns the bit offset to backpatch with the location of the real VST.
12680b57cec5SDimitry Andric void ModuleBitcodeWriter::writeModuleInfo() {
12690b57cec5SDimitry Andric   // Emit various pieces of data attached to a module.
12700b57cec5SDimitry Andric   if (!M.getTargetTriple().empty())
12710b57cec5SDimitry Andric     writeStringRecord(Stream, bitc::MODULE_CODE_TRIPLE, M.getTargetTriple(),
12720b57cec5SDimitry Andric                       0 /*TODO*/);
12730b57cec5SDimitry Andric   const std::string &DL = M.getDataLayoutStr();
12740b57cec5SDimitry Andric   if (!DL.empty())
12750b57cec5SDimitry Andric     writeStringRecord(Stream, bitc::MODULE_CODE_DATALAYOUT, DL, 0 /*TODO*/);
12760b57cec5SDimitry Andric   if (!M.getModuleInlineAsm().empty())
12770b57cec5SDimitry Andric     writeStringRecord(Stream, bitc::MODULE_CODE_ASM, M.getModuleInlineAsm(),
12780b57cec5SDimitry Andric                       0 /*TODO*/);
12790b57cec5SDimitry Andric 
12800b57cec5SDimitry Andric   // Emit information about sections and GC, computing how many there are. Also
12810b57cec5SDimitry Andric   // compute the maximum alignment value.
12820b57cec5SDimitry Andric   std::map<std::string, unsigned> SectionMap;
12830b57cec5SDimitry Andric   std::map<std::string, unsigned> GCMap;
1284e8d8bef9SDimitry Andric   MaybeAlign MaxAlignment;
12850b57cec5SDimitry Andric   unsigned MaxGlobalType = 0;
1286e8d8bef9SDimitry Andric   const auto UpdateMaxAlignment = [&MaxAlignment](const MaybeAlign A) {
1287e8d8bef9SDimitry Andric     if (A)
1288e8d8bef9SDimitry Andric       MaxAlignment = !MaxAlignment ? *A : std::max(*MaxAlignment, *A);
1289e8d8bef9SDimitry Andric   };
12905ffd83dbSDimitry Andric   for (const GlobalVariable &GV : M.globals()) {
1291e8d8bef9SDimitry Andric     UpdateMaxAlignment(GV.getAlign());
12920b57cec5SDimitry Andric     MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV.getValueType()));
12930b57cec5SDimitry Andric     if (GV.hasSection()) {
12940b57cec5SDimitry Andric       // Give section names unique ID's.
12955ffd83dbSDimitry Andric       unsigned &Entry = SectionMap[std::string(GV.getSection())];
12960b57cec5SDimitry Andric       if (!Entry) {
12970b57cec5SDimitry Andric         writeStringRecord(Stream, bitc::MODULE_CODE_SECTIONNAME, GV.getSection(),
12980b57cec5SDimitry Andric                           0 /*TODO*/);
12990b57cec5SDimitry Andric         Entry = SectionMap.size();
13000b57cec5SDimitry Andric       }
13010b57cec5SDimitry Andric     }
13020b57cec5SDimitry Andric   }
13030b57cec5SDimitry Andric   for (const Function &F : M) {
1304e8d8bef9SDimitry Andric     UpdateMaxAlignment(F.getAlign());
13050b57cec5SDimitry Andric     if (F.hasSection()) {
13060b57cec5SDimitry Andric       // Give section names unique ID's.
13075ffd83dbSDimitry Andric       unsigned &Entry = SectionMap[std::string(F.getSection())];
13080b57cec5SDimitry Andric       if (!Entry) {
13090b57cec5SDimitry Andric         writeStringRecord(Stream, bitc::MODULE_CODE_SECTIONNAME, F.getSection(),
13100b57cec5SDimitry Andric                           0 /*TODO*/);
13110b57cec5SDimitry Andric         Entry = SectionMap.size();
13120b57cec5SDimitry Andric       }
13130b57cec5SDimitry Andric     }
13140b57cec5SDimitry Andric     if (F.hasGC()) {
13150b57cec5SDimitry Andric       // Same for GC names.
13160b57cec5SDimitry Andric       unsigned &Entry = GCMap[F.getGC()];
13170b57cec5SDimitry Andric       if (!Entry) {
13180b57cec5SDimitry Andric         writeStringRecord(Stream, bitc::MODULE_CODE_GCNAME, F.getGC(),
13190b57cec5SDimitry Andric                           0 /*TODO*/);
13200b57cec5SDimitry Andric         Entry = GCMap.size();
13210b57cec5SDimitry Andric       }
13220b57cec5SDimitry Andric     }
13230b57cec5SDimitry Andric   }
13240b57cec5SDimitry Andric 
13250b57cec5SDimitry Andric   // Emit abbrev for globals, now that we know # sections and max alignment.
13260b57cec5SDimitry Andric   unsigned SimpleGVarAbbrev = 0;
13270b57cec5SDimitry Andric   if (!M.global_empty()) {
13280b57cec5SDimitry Andric     // Add an abbrev for common globals with no visibility or thread localness.
13290b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
13300b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
13310b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
13320b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
13330b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
13340b57cec5SDimitry Andric                               Log2_32_Ceil(MaxGlobalType+1)));
13350b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // AddrSpace << 2
13360b57cec5SDimitry Andric                                                            //| explicitType << 1
13370b57cec5SDimitry Andric                                                            //| constant
13380b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // Initializer.
13390b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // Linkage.
1340e8d8bef9SDimitry Andric     if (!MaxAlignment)                                     // Alignment.
13410b57cec5SDimitry Andric       Abbv->Add(BitCodeAbbrevOp(0));
13420b57cec5SDimitry Andric     else {
1343e8d8bef9SDimitry Andric       unsigned MaxEncAlignment = getEncodedAlign(MaxAlignment);
13440b57cec5SDimitry Andric       Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
13450b57cec5SDimitry Andric                                Log2_32_Ceil(MaxEncAlignment+1)));
13460b57cec5SDimitry Andric     }
13470b57cec5SDimitry Andric     if (SectionMap.empty())                                    // Section.
13480b57cec5SDimitry Andric       Abbv->Add(BitCodeAbbrevOp(0));
13490b57cec5SDimitry Andric     else
13500b57cec5SDimitry Andric       Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
13510b57cec5SDimitry Andric                                Log2_32_Ceil(SectionMap.size()+1)));
13520b57cec5SDimitry Andric     // Don't bother emitting vis + thread local.
13530b57cec5SDimitry Andric     SimpleGVarAbbrev = Stream.EmitAbbrev(std::move(Abbv));
13540b57cec5SDimitry Andric   }
13550b57cec5SDimitry Andric 
13560b57cec5SDimitry Andric   SmallVector<unsigned, 64> Vals;
13570b57cec5SDimitry Andric   // Emit the module's source file name.
13580b57cec5SDimitry Andric   {
13590b57cec5SDimitry Andric     StringEncoding Bits = getStringEncoding(M.getSourceFileName());
13600b57cec5SDimitry Andric     BitCodeAbbrevOp AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8);
13610b57cec5SDimitry Andric     if (Bits == SE_Char6)
13620b57cec5SDimitry Andric       AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Char6);
13630b57cec5SDimitry Andric     else if (Bits == SE_Fixed7)
13640b57cec5SDimitry Andric       AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7);
13650b57cec5SDimitry Andric 
13660b57cec5SDimitry Andric     // MODULE_CODE_SOURCE_FILENAME: [namechar x N]
13670b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
13680b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_SOURCE_FILENAME));
13690b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
13700b57cec5SDimitry Andric     Abbv->Add(AbbrevOpToUse);
13710b57cec5SDimitry Andric     unsigned FilenameAbbrev = Stream.EmitAbbrev(std::move(Abbv));
13720b57cec5SDimitry Andric 
13730b57cec5SDimitry Andric     for (const auto P : M.getSourceFileName())
13740b57cec5SDimitry Andric       Vals.push_back((unsigned char)P);
13750b57cec5SDimitry Andric 
13760b57cec5SDimitry Andric     // Emit the finished record.
13770b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_SOURCE_FILENAME, Vals, FilenameAbbrev);
13780b57cec5SDimitry Andric     Vals.clear();
13790b57cec5SDimitry Andric   }
13800b57cec5SDimitry Andric 
13810b57cec5SDimitry Andric   // Emit the global variable information.
13820b57cec5SDimitry Andric   for (const GlobalVariable &GV : M.globals()) {
13830b57cec5SDimitry Andric     unsigned AbbrevToUse = 0;
13840b57cec5SDimitry Andric 
13850b57cec5SDimitry Andric     // GLOBALVAR: [strtab offset, strtab size, type, isconst, initid,
13860b57cec5SDimitry Andric     //             linkage, alignment, section, visibility, threadlocal,
13870b57cec5SDimitry Andric     //             unnamed_addr, externally_initialized, dllstorageclass,
138881ad6265SDimitry Andric     //             comdat, attributes, DSO_Local, GlobalSanitizer]
13890b57cec5SDimitry Andric     Vals.push_back(addToStrtab(GV.getName()));
13900b57cec5SDimitry Andric     Vals.push_back(GV.getName().size());
13910b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(GV.getValueType()));
13920b57cec5SDimitry Andric     Vals.push_back(GV.getType()->getAddressSpace() << 2 | 2 | GV.isConstant());
13930b57cec5SDimitry Andric     Vals.push_back(GV.isDeclaration() ? 0 :
13940b57cec5SDimitry Andric                    (VE.getValueID(GV.getInitializer()) + 1));
13950b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(GV));
1396e8d8bef9SDimitry Andric     Vals.push_back(getEncodedAlign(GV.getAlign()));
13975ffd83dbSDimitry Andric     Vals.push_back(GV.hasSection() ? SectionMap[std::string(GV.getSection())]
13985ffd83dbSDimitry Andric                                    : 0);
13990b57cec5SDimitry Andric     if (GV.isThreadLocal() ||
14000b57cec5SDimitry Andric         GV.getVisibility() != GlobalValue::DefaultVisibility ||
14010b57cec5SDimitry Andric         GV.getUnnamedAddr() != GlobalValue::UnnamedAddr::None ||
14020b57cec5SDimitry Andric         GV.isExternallyInitialized() ||
14030b57cec5SDimitry Andric         GV.getDLLStorageClass() != GlobalValue::DefaultStorageClass ||
140481ad6265SDimitry Andric         GV.hasComdat() || GV.hasAttributes() || GV.isDSOLocal() ||
140581ad6265SDimitry Andric         GV.hasPartition() || GV.hasSanitizerMetadata()) {
14060b57cec5SDimitry Andric       Vals.push_back(getEncodedVisibility(GV));
14070b57cec5SDimitry Andric       Vals.push_back(getEncodedThreadLocalMode(GV));
14080b57cec5SDimitry Andric       Vals.push_back(getEncodedUnnamedAddr(GV));
14090b57cec5SDimitry Andric       Vals.push_back(GV.isExternallyInitialized());
14100b57cec5SDimitry Andric       Vals.push_back(getEncodedDLLStorageClass(GV));
14110b57cec5SDimitry Andric       Vals.push_back(GV.hasComdat() ? VE.getComdatID(GV.getComdat()) : 0);
14120b57cec5SDimitry Andric 
14130b57cec5SDimitry Andric       auto AL = GV.getAttributesAsList(AttributeList::FunctionIndex);
14140b57cec5SDimitry Andric       Vals.push_back(VE.getAttributeListID(AL));
14150b57cec5SDimitry Andric 
14160b57cec5SDimitry Andric       Vals.push_back(GV.isDSOLocal());
14170b57cec5SDimitry Andric       Vals.push_back(addToStrtab(GV.getPartition()));
14180b57cec5SDimitry Andric       Vals.push_back(GV.getPartition().size());
141981ad6265SDimitry Andric 
142081ad6265SDimitry Andric       Vals.push_back((GV.hasSanitizerMetadata() ? serializeSanitizerMetadata(
142181ad6265SDimitry Andric                                                       GV.getSanitizerMetadata())
142281ad6265SDimitry Andric                                                 : 0));
14230b57cec5SDimitry Andric     } else {
14240b57cec5SDimitry Andric       AbbrevToUse = SimpleGVarAbbrev;
14250b57cec5SDimitry Andric     }
14260b57cec5SDimitry Andric 
14270b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
14280b57cec5SDimitry Andric     Vals.clear();
14290b57cec5SDimitry Andric   }
14300b57cec5SDimitry Andric 
14310b57cec5SDimitry Andric   // Emit the function proto information.
14320b57cec5SDimitry Andric   for (const Function &F : M) {
14330b57cec5SDimitry Andric     // FUNCTION:  [strtab offset, strtab size, type, callingconv, isproto,
14340b57cec5SDimitry Andric     //             linkage, paramattrs, alignment, section, visibility, gc,
14350b57cec5SDimitry Andric     //             unnamed_addr, prologuedata, dllstorageclass, comdat,
14360b57cec5SDimitry Andric     //             prefixdata, personalityfn, DSO_Local, addrspace]
14370b57cec5SDimitry Andric     Vals.push_back(addToStrtab(F.getName()));
14380b57cec5SDimitry Andric     Vals.push_back(F.getName().size());
14390b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(F.getFunctionType()));
14400b57cec5SDimitry Andric     Vals.push_back(F.getCallingConv());
14410b57cec5SDimitry Andric     Vals.push_back(F.isDeclaration());
14420b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(F));
14430b57cec5SDimitry Andric     Vals.push_back(VE.getAttributeListID(F.getAttributes()));
1444e8d8bef9SDimitry Andric     Vals.push_back(getEncodedAlign(F.getAlign()));
14455ffd83dbSDimitry Andric     Vals.push_back(F.hasSection() ? SectionMap[std::string(F.getSection())]
14465ffd83dbSDimitry Andric                                   : 0);
14470b57cec5SDimitry Andric     Vals.push_back(getEncodedVisibility(F));
14480b57cec5SDimitry Andric     Vals.push_back(F.hasGC() ? GCMap[F.getGC()] : 0);
14490b57cec5SDimitry Andric     Vals.push_back(getEncodedUnnamedAddr(F));
14500b57cec5SDimitry Andric     Vals.push_back(F.hasPrologueData() ? (VE.getValueID(F.getPrologueData()) + 1)
14510b57cec5SDimitry Andric                                        : 0);
14520b57cec5SDimitry Andric     Vals.push_back(getEncodedDLLStorageClass(F));
14530b57cec5SDimitry Andric     Vals.push_back(F.hasComdat() ? VE.getComdatID(F.getComdat()) : 0);
14540b57cec5SDimitry Andric     Vals.push_back(F.hasPrefixData() ? (VE.getValueID(F.getPrefixData()) + 1)
14550b57cec5SDimitry Andric                                      : 0);
14560b57cec5SDimitry Andric     Vals.push_back(
14570b57cec5SDimitry Andric         F.hasPersonalityFn() ? (VE.getValueID(F.getPersonalityFn()) + 1) : 0);
14580b57cec5SDimitry Andric 
14590b57cec5SDimitry Andric     Vals.push_back(F.isDSOLocal());
14600b57cec5SDimitry Andric     Vals.push_back(F.getAddressSpace());
14610b57cec5SDimitry Andric     Vals.push_back(addToStrtab(F.getPartition()));
14620b57cec5SDimitry Andric     Vals.push_back(F.getPartition().size());
14630b57cec5SDimitry Andric 
14640b57cec5SDimitry Andric     unsigned AbbrevToUse = 0;
14650b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
14660b57cec5SDimitry Andric     Vals.clear();
14670b57cec5SDimitry Andric   }
14680b57cec5SDimitry Andric 
14690b57cec5SDimitry Andric   // Emit the alias information.
14700b57cec5SDimitry Andric   for (const GlobalAlias &A : M.aliases()) {
14710b57cec5SDimitry Andric     // ALIAS: [strtab offset, strtab size, alias type, aliasee val#, linkage,
14720b57cec5SDimitry Andric     //         visibility, dllstorageclass, threadlocal, unnamed_addr,
14730b57cec5SDimitry Andric     //         DSO_Local]
14740b57cec5SDimitry Andric     Vals.push_back(addToStrtab(A.getName()));
14750b57cec5SDimitry Andric     Vals.push_back(A.getName().size());
14760b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(A.getValueType()));
14770b57cec5SDimitry Andric     Vals.push_back(A.getType()->getAddressSpace());
14780b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(A.getAliasee()));
14790b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(A));
14800b57cec5SDimitry Andric     Vals.push_back(getEncodedVisibility(A));
14810b57cec5SDimitry Andric     Vals.push_back(getEncodedDLLStorageClass(A));
14820b57cec5SDimitry Andric     Vals.push_back(getEncodedThreadLocalMode(A));
14830b57cec5SDimitry Andric     Vals.push_back(getEncodedUnnamedAddr(A));
14840b57cec5SDimitry Andric     Vals.push_back(A.isDSOLocal());
14850b57cec5SDimitry Andric     Vals.push_back(addToStrtab(A.getPartition()));
14860b57cec5SDimitry Andric     Vals.push_back(A.getPartition().size());
14870b57cec5SDimitry Andric 
14880b57cec5SDimitry Andric     unsigned AbbrevToUse = 0;
14890b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
14900b57cec5SDimitry Andric     Vals.clear();
14910b57cec5SDimitry Andric   }
14920b57cec5SDimitry Andric 
14930b57cec5SDimitry Andric   // Emit the ifunc information.
14940b57cec5SDimitry Andric   for (const GlobalIFunc &I : M.ifuncs()) {
14950b57cec5SDimitry Andric     // IFUNC: [strtab offset, strtab size, ifunc type, address space, resolver
14960b57cec5SDimitry Andric     //         val#, linkage, visibility, DSO_Local]
14970b57cec5SDimitry Andric     Vals.push_back(addToStrtab(I.getName()));
14980b57cec5SDimitry Andric     Vals.push_back(I.getName().size());
14990b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(I.getValueType()));
15000b57cec5SDimitry Andric     Vals.push_back(I.getType()->getAddressSpace());
15010b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(I.getResolver()));
15020b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(I));
15030b57cec5SDimitry Andric     Vals.push_back(getEncodedVisibility(I));
15040b57cec5SDimitry Andric     Vals.push_back(I.isDSOLocal());
15050b57cec5SDimitry Andric     Vals.push_back(addToStrtab(I.getPartition()));
15060b57cec5SDimitry Andric     Vals.push_back(I.getPartition().size());
15070b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_IFUNC, Vals);
15080b57cec5SDimitry Andric     Vals.clear();
15090b57cec5SDimitry Andric   }
15100b57cec5SDimitry Andric 
15110b57cec5SDimitry Andric   writeValueSymbolTableForwardDecl();
15120b57cec5SDimitry Andric }
15130b57cec5SDimitry Andric 
15140b57cec5SDimitry Andric static uint64_t getOptimizationFlags(const Value *V) {
15150b57cec5SDimitry Andric   uint64_t Flags = 0;
15160b57cec5SDimitry Andric 
15170b57cec5SDimitry Andric   if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(V)) {
15180b57cec5SDimitry Andric     if (OBO->hasNoSignedWrap())
15190b57cec5SDimitry Andric       Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP;
15200b57cec5SDimitry Andric     if (OBO->hasNoUnsignedWrap())
15210b57cec5SDimitry Andric       Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP;
15220b57cec5SDimitry Andric   } else if (const auto *PEO = dyn_cast<PossiblyExactOperator>(V)) {
15230b57cec5SDimitry Andric     if (PEO->isExact())
15240b57cec5SDimitry Andric       Flags |= 1 << bitc::PEO_EXACT;
15250b57cec5SDimitry Andric   } else if (const auto *FPMO = dyn_cast<FPMathOperator>(V)) {
15260b57cec5SDimitry Andric     if (FPMO->hasAllowReassoc())
15270b57cec5SDimitry Andric       Flags |= bitc::AllowReassoc;
15280b57cec5SDimitry Andric     if (FPMO->hasNoNaNs())
15290b57cec5SDimitry Andric       Flags |= bitc::NoNaNs;
15300b57cec5SDimitry Andric     if (FPMO->hasNoInfs())
15310b57cec5SDimitry Andric       Flags |= bitc::NoInfs;
15320b57cec5SDimitry Andric     if (FPMO->hasNoSignedZeros())
15330b57cec5SDimitry Andric       Flags |= bitc::NoSignedZeros;
15340b57cec5SDimitry Andric     if (FPMO->hasAllowReciprocal())
15350b57cec5SDimitry Andric       Flags |= bitc::AllowReciprocal;
15360b57cec5SDimitry Andric     if (FPMO->hasAllowContract())
15370b57cec5SDimitry Andric       Flags |= bitc::AllowContract;
15380b57cec5SDimitry Andric     if (FPMO->hasApproxFunc())
15390b57cec5SDimitry Andric       Flags |= bitc::ApproxFunc;
15400b57cec5SDimitry Andric   }
15410b57cec5SDimitry Andric 
15420b57cec5SDimitry Andric   return Flags;
15430b57cec5SDimitry Andric }
15440b57cec5SDimitry Andric 
15450b57cec5SDimitry Andric void ModuleBitcodeWriter::writeValueAsMetadata(
15460b57cec5SDimitry Andric     const ValueAsMetadata *MD, SmallVectorImpl<uint64_t> &Record) {
15470b57cec5SDimitry Andric   // Mimic an MDNode with a value as one operand.
15480b57cec5SDimitry Andric   Value *V = MD->getValue();
15490b57cec5SDimitry Andric   Record.push_back(VE.getTypeID(V->getType()));
15500b57cec5SDimitry Andric   Record.push_back(VE.getValueID(V));
15510b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_VALUE, Record, 0);
15520b57cec5SDimitry Andric   Record.clear();
15530b57cec5SDimitry Andric }
15540b57cec5SDimitry Andric 
15550b57cec5SDimitry Andric void ModuleBitcodeWriter::writeMDTuple(const MDTuple *N,
15560b57cec5SDimitry Andric                                        SmallVectorImpl<uint64_t> &Record,
15570b57cec5SDimitry Andric                                        unsigned Abbrev) {
15580b57cec5SDimitry Andric   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
15590b57cec5SDimitry Andric     Metadata *MD = N->getOperand(i);
15600b57cec5SDimitry Andric     assert(!(MD && isa<LocalAsMetadata>(MD)) &&
15610b57cec5SDimitry Andric            "Unexpected function-local metadata");
15620b57cec5SDimitry Andric     Record.push_back(VE.getMetadataOrNullID(MD));
15630b57cec5SDimitry Andric   }
15640b57cec5SDimitry Andric   Stream.EmitRecord(N->isDistinct() ? bitc::METADATA_DISTINCT_NODE
15650b57cec5SDimitry Andric                                     : bitc::METADATA_NODE,
15660b57cec5SDimitry Andric                     Record, Abbrev);
15670b57cec5SDimitry Andric   Record.clear();
15680b57cec5SDimitry Andric }
15690b57cec5SDimitry Andric 
15700b57cec5SDimitry Andric unsigned ModuleBitcodeWriter::createDILocationAbbrev() {
15710b57cec5SDimitry Andric   // Assume the column is usually under 128, and always output the inlined-at
15720b57cec5SDimitry Andric   // location (it's never more expensive than building an array size 1).
15730b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
15740b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_LOCATION));
15750b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
15760b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
15770b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
15780b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
15790b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
15800b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
15810b57cec5SDimitry Andric   return Stream.EmitAbbrev(std::move(Abbv));
15820b57cec5SDimitry Andric }
15830b57cec5SDimitry Andric 
15840b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDILocation(const DILocation *N,
15850b57cec5SDimitry Andric                                           SmallVectorImpl<uint64_t> &Record,
15860b57cec5SDimitry Andric                                           unsigned &Abbrev) {
15870b57cec5SDimitry Andric   if (!Abbrev)
15880b57cec5SDimitry Andric     Abbrev = createDILocationAbbrev();
15890b57cec5SDimitry Andric 
15900b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
15910b57cec5SDimitry Andric   Record.push_back(N->getLine());
15920b57cec5SDimitry Andric   Record.push_back(N->getColumn());
15930b57cec5SDimitry Andric   Record.push_back(VE.getMetadataID(N->getScope()));
15940b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getInlinedAt()));
15950b57cec5SDimitry Andric   Record.push_back(N->isImplicitCode());
15960b57cec5SDimitry Andric 
15970b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_LOCATION, Record, Abbrev);
15980b57cec5SDimitry Andric   Record.clear();
15990b57cec5SDimitry Andric }
16000b57cec5SDimitry Andric 
16010b57cec5SDimitry Andric unsigned ModuleBitcodeWriter::createGenericDINodeAbbrev() {
16020b57cec5SDimitry Andric   // Assume the column is usually under 128, and always output the inlined-at
16030b57cec5SDimitry Andric   // location (it's never more expensive than building an array size 1).
16040b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
16050b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_GENERIC_DEBUG));
16060b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
16070b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
16080b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
16090b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
16100b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
16110b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
16120b57cec5SDimitry Andric   return Stream.EmitAbbrev(std::move(Abbv));
16130b57cec5SDimitry Andric }
16140b57cec5SDimitry Andric 
16150b57cec5SDimitry Andric void ModuleBitcodeWriter::writeGenericDINode(const GenericDINode *N,
16160b57cec5SDimitry Andric                                              SmallVectorImpl<uint64_t> &Record,
16170b57cec5SDimitry Andric                                              unsigned &Abbrev) {
16180b57cec5SDimitry Andric   if (!Abbrev)
16190b57cec5SDimitry Andric     Abbrev = createGenericDINodeAbbrev();
16200b57cec5SDimitry Andric 
16210b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
16220b57cec5SDimitry Andric   Record.push_back(N->getTag());
16230b57cec5SDimitry Andric   Record.push_back(0); // Per-tag version field; unused for now.
16240b57cec5SDimitry Andric 
16250b57cec5SDimitry Andric   for (auto &I : N->operands())
16260b57cec5SDimitry Andric     Record.push_back(VE.getMetadataOrNullID(I));
16270b57cec5SDimitry Andric 
16280b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_GENERIC_DEBUG, Record, Abbrev);
16290b57cec5SDimitry Andric   Record.clear();
16300b57cec5SDimitry Andric }
16310b57cec5SDimitry Andric 
16320b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDISubrange(const DISubrange *N,
16330b57cec5SDimitry Andric                                           SmallVectorImpl<uint64_t> &Record,
16340b57cec5SDimitry Andric                                           unsigned Abbrev) {
16355ffd83dbSDimitry Andric   const uint64_t Version = 2 << 1;
16360b57cec5SDimitry Andric   Record.push_back((uint64_t)N->isDistinct() | Version);
16370b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawCountNode()));
16385ffd83dbSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawLowerBound()));
16395ffd83dbSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawUpperBound()));
16405ffd83dbSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawStride()));
16410b57cec5SDimitry Andric 
16420b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_SUBRANGE, Record, Abbrev);
16430b57cec5SDimitry Andric   Record.clear();
16440b57cec5SDimitry Andric }
16450b57cec5SDimitry Andric 
1646e8d8bef9SDimitry Andric void ModuleBitcodeWriter::writeDIGenericSubrange(
1647e8d8bef9SDimitry Andric     const DIGenericSubrange *N, SmallVectorImpl<uint64_t> &Record,
1648e8d8bef9SDimitry Andric     unsigned Abbrev) {
1649e8d8bef9SDimitry Andric   Record.push_back((uint64_t)N->isDistinct());
1650e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawCountNode()));
1651e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawLowerBound()));
1652e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawUpperBound()));
1653e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawStride()));
1654e8d8bef9SDimitry Andric 
1655e8d8bef9SDimitry Andric   Stream.EmitRecord(bitc::METADATA_GENERIC_SUBRANGE, Record, Abbrev);
1656e8d8bef9SDimitry Andric   Record.clear();
1657e8d8bef9SDimitry Andric }
1658e8d8bef9SDimitry Andric 
16595ffd83dbSDimitry Andric static void emitSignedInt64(SmallVectorImpl<uint64_t> &Vals, uint64_t V) {
16605ffd83dbSDimitry Andric   if ((int64_t)V >= 0)
16615ffd83dbSDimitry Andric     Vals.push_back(V << 1);
16625ffd83dbSDimitry Andric   else
16635ffd83dbSDimitry Andric     Vals.push_back((-V << 1) | 1);
16645ffd83dbSDimitry Andric }
16655ffd83dbSDimitry Andric 
16665ffd83dbSDimitry Andric static void emitWideAPInt(SmallVectorImpl<uint64_t> &Vals, const APInt &A) {
16675ffd83dbSDimitry Andric   // We have an arbitrary precision integer value to write whose
16685ffd83dbSDimitry Andric   // bit width is > 64. However, in canonical unsigned integer
16695ffd83dbSDimitry Andric   // format it is likely that the high bits are going to be zero.
16705ffd83dbSDimitry Andric   // So, we only write the number of active words.
16715ffd83dbSDimitry Andric   unsigned NumWords = A.getActiveWords();
16725ffd83dbSDimitry Andric   const uint64_t *RawData = A.getRawData();
16735ffd83dbSDimitry Andric   for (unsigned i = 0; i < NumWords; i++)
16745ffd83dbSDimitry Andric     emitSignedInt64(Vals, RawData[i]);
16755ffd83dbSDimitry Andric }
16765ffd83dbSDimitry Andric 
16770b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIEnumerator(const DIEnumerator *N,
16780b57cec5SDimitry Andric                                             SmallVectorImpl<uint64_t> &Record,
16790b57cec5SDimitry Andric                                             unsigned Abbrev) {
16805ffd83dbSDimitry Andric   const uint64_t IsBigInt = 1 << 2;
16815ffd83dbSDimitry Andric   Record.push_back(IsBigInt | (N->isUnsigned() << 1) | N->isDistinct());
16825ffd83dbSDimitry Andric   Record.push_back(N->getValue().getBitWidth());
16830b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
16845ffd83dbSDimitry Andric   emitWideAPInt(Record, N->getValue());
16850b57cec5SDimitry Andric 
16860b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_ENUMERATOR, Record, Abbrev);
16870b57cec5SDimitry Andric   Record.clear();
16880b57cec5SDimitry Andric }
16890b57cec5SDimitry Andric 
16900b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIBasicType(const DIBasicType *N,
16910b57cec5SDimitry Andric                                            SmallVectorImpl<uint64_t> &Record,
16920b57cec5SDimitry Andric                                            unsigned Abbrev) {
16930b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
16940b57cec5SDimitry Andric   Record.push_back(N->getTag());
16950b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
16960b57cec5SDimitry Andric   Record.push_back(N->getSizeInBits());
16970b57cec5SDimitry Andric   Record.push_back(N->getAlignInBits());
16980b57cec5SDimitry Andric   Record.push_back(N->getEncoding());
16990b57cec5SDimitry Andric   Record.push_back(N->getFlags());
17000b57cec5SDimitry Andric 
17010b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_BASIC_TYPE, Record, Abbrev);
17020b57cec5SDimitry Andric   Record.clear();
17030b57cec5SDimitry Andric }
17040b57cec5SDimitry Andric 
1705e8d8bef9SDimitry Andric void ModuleBitcodeWriter::writeDIStringType(const DIStringType *N,
1706e8d8bef9SDimitry Andric                                             SmallVectorImpl<uint64_t> &Record,
1707e8d8bef9SDimitry Andric                                             unsigned Abbrev) {
1708e8d8bef9SDimitry Andric   Record.push_back(N->isDistinct());
1709e8d8bef9SDimitry Andric   Record.push_back(N->getTag());
1710e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1711e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getStringLength()));
1712e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getStringLengthExp()));
171304eeddc0SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getStringLocationExp()));
1714e8d8bef9SDimitry Andric   Record.push_back(N->getSizeInBits());
1715e8d8bef9SDimitry Andric   Record.push_back(N->getAlignInBits());
1716e8d8bef9SDimitry Andric   Record.push_back(N->getEncoding());
1717e8d8bef9SDimitry Andric 
1718e8d8bef9SDimitry Andric   Stream.EmitRecord(bitc::METADATA_STRING_TYPE, Record, Abbrev);
1719e8d8bef9SDimitry Andric   Record.clear();
1720e8d8bef9SDimitry Andric }
1721e8d8bef9SDimitry Andric 
17220b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIDerivedType(const DIDerivedType *N,
17230b57cec5SDimitry Andric                                              SmallVectorImpl<uint64_t> &Record,
17240b57cec5SDimitry Andric                                              unsigned Abbrev) {
17250b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
17260b57cec5SDimitry Andric   Record.push_back(N->getTag());
17270b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
17280b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
17290b57cec5SDimitry Andric   Record.push_back(N->getLine());
17300b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
17310b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
17320b57cec5SDimitry Andric   Record.push_back(N->getSizeInBits());
17330b57cec5SDimitry Andric   Record.push_back(N->getAlignInBits());
17340b57cec5SDimitry Andric   Record.push_back(N->getOffsetInBits());
17350b57cec5SDimitry Andric   Record.push_back(N->getFlags());
17360b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getExtraData()));
17370b57cec5SDimitry Andric 
17380b57cec5SDimitry Andric   // DWARF address space is encoded as N->getDWARFAddressSpace() + 1. 0 means
17390b57cec5SDimitry Andric   // that there is no DWARF address space associated with DIDerivedType.
17400b57cec5SDimitry Andric   if (const auto &DWARFAddressSpace = N->getDWARFAddressSpace())
17410b57cec5SDimitry Andric     Record.push_back(*DWARFAddressSpace + 1);
17420b57cec5SDimitry Andric   else
17430b57cec5SDimitry Andric     Record.push_back(0);
17440b57cec5SDimitry Andric 
1745349cc55cSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get()));
1746349cc55cSDimitry Andric 
17470b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_DERIVED_TYPE, Record, Abbrev);
17480b57cec5SDimitry Andric   Record.clear();
17490b57cec5SDimitry Andric }
17500b57cec5SDimitry Andric 
17510b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDICompositeType(
17520b57cec5SDimitry Andric     const DICompositeType *N, SmallVectorImpl<uint64_t> &Record,
17530b57cec5SDimitry Andric     unsigned Abbrev) {
17540b57cec5SDimitry Andric   const unsigned IsNotUsedInOldTypeRef = 0x2;
17550b57cec5SDimitry Andric   Record.push_back(IsNotUsedInOldTypeRef | (unsigned)N->isDistinct());
17560b57cec5SDimitry Andric   Record.push_back(N->getTag());
17570b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
17580b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
17590b57cec5SDimitry Andric   Record.push_back(N->getLine());
17600b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
17610b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
17620b57cec5SDimitry Andric   Record.push_back(N->getSizeInBits());
17630b57cec5SDimitry Andric   Record.push_back(N->getAlignInBits());
17640b57cec5SDimitry Andric   Record.push_back(N->getOffsetInBits());
17650b57cec5SDimitry Andric   Record.push_back(N->getFlags());
17660b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getElements().get()));
17670b57cec5SDimitry Andric   Record.push_back(N->getRuntimeLang());
17680b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getVTableHolder()));
17690b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get()));
17700b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawIdentifier()));
17710b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getDiscriminator()));
17725ffd83dbSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawDataLocation()));
1773e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawAssociated()));
1774e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawAllocated()));
1775e8d8bef9SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawRank()));
1776349cc55cSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get()));
17770b57cec5SDimitry Andric 
17780b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_COMPOSITE_TYPE, Record, Abbrev);
17790b57cec5SDimitry Andric   Record.clear();
17800b57cec5SDimitry Andric }
17810b57cec5SDimitry Andric 
17820b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDISubroutineType(
17830b57cec5SDimitry Andric     const DISubroutineType *N, SmallVectorImpl<uint64_t> &Record,
17840b57cec5SDimitry Andric     unsigned Abbrev) {
17850b57cec5SDimitry Andric   const unsigned HasNoOldTypeRefs = 0x2;
17860b57cec5SDimitry Andric   Record.push_back(HasNoOldTypeRefs | (unsigned)N->isDistinct());
17870b57cec5SDimitry Andric   Record.push_back(N->getFlags());
17880b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getTypeArray().get()));
17890b57cec5SDimitry Andric   Record.push_back(N->getCC());
17900b57cec5SDimitry Andric 
17910b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_SUBROUTINE_TYPE, Record, Abbrev);
17920b57cec5SDimitry Andric   Record.clear();
17930b57cec5SDimitry Andric }
17940b57cec5SDimitry Andric 
17950b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIFile(const DIFile *N,
17960b57cec5SDimitry Andric                                       SmallVectorImpl<uint64_t> &Record,
17970b57cec5SDimitry Andric                                       unsigned Abbrev) {
17980b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
17990b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawFilename()));
18000b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawDirectory()));
18010b57cec5SDimitry Andric   if (N->getRawChecksum()) {
18020b57cec5SDimitry Andric     Record.push_back(N->getRawChecksum()->Kind);
18030b57cec5SDimitry Andric     Record.push_back(VE.getMetadataOrNullID(N->getRawChecksum()->Value));
18040b57cec5SDimitry Andric   } else {
18050b57cec5SDimitry Andric     // Maintain backwards compatibility with the old internal representation of
18060b57cec5SDimitry Andric     // CSK_None in ChecksumKind by writing nulls here when Checksum is None.
18070b57cec5SDimitry Andric     Record.push_back(0);
18080b57cec5SDimitry Andric     Record.push_back(VE.getMetadataOrNullID(nullptr));
18090b57cec5SDimitry Andric   }
18100b57cec5SDimitry Andric   auto Source = N->getRawSource();
18110b57cec5SDimitry Andric   if (Source)
1812bdd1243dSDimitry Andric     Record.push_back(VE.getMetadataOrNullID(Source));
18130b57cec5SDimitry Andric 
18140b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_FILE, Record, Abbrev);
18150b57cec5SDimitry Andric   Record.clear();
18160b57cec5SDimitry Andric }
18170b57cec5SDimitry Andric 
18180b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDICompileUnit(const DICompileUnit *N,
18190b57cec5SDimitry Andric                                              SmallVectorImpl<uint64_t> &Record,
18200b57cec5SDimitry Andric                                              unsigned Abbrev) {
18210b57cec5SDimitry Andric   assert(N->isDistinct() && "Expected distinct compile units");
18220b57cec5SDimitry Andric   Record.push_back(/* IsDistinct */ true);
18230b57cec5SDimitry Andric   Record.push_back(N->getSourceLanguage());
18240b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
18250b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawProducer()));
18260b57cec5SDimitry Andric   Record.push_back(N->isOptimized());
18270b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawFlags()));
18280b57cec5SDimitry Andric   Record.push_back(N->getRuntimeVersion());
18290b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawSplitDebugFilename()));
18300b57cec5SDimitry Andric   Record.push_back(N->getEmissionKind());
18310b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getEnumTypes().get()));
18320b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRetainedTypes().get()));
18330b57cec5SDimitry Andric   Record.push_back(/* subprograms */ 0);
18340b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getGlobalVariables().get()));
18350b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getImportedEntities().get()));
18360b57cec5SDimitry Andric   Record.push_back(N->getDWOId());
18370b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getMacros().get()));
18380b57cec5SDimitry Andric   Record.push_back(N->getSplitDebugInlining());
18390b57cec5SDimitry Andric   Record.push_back(N->getDebugInfoForProfiling());
18400b57cec5SDimitry Andric   Record.push_back((unsigned)N->getNameTableKind());
18415ffd83dbSDimitry Andric   Record.push_back(N->getRangesBaseAddress());
18425ffd83dbSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawSysRoot()));
18435ffd83dbSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawSDK()));
18440b57cec5SDimitry Andric 
18450b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_COMPILE_UNIT, Record, Abbrev);
18460b57cec5SDimitry Andric   Record.clear();
18470b57cec5SDimitry Andric }
18480b57cec5SDimitry Andric 
18490b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDISubprogram(const DISubprogram *N,
18500b57cec5SDimitry Andric                                             SmallVectorImpl<uint64_t> &Record,
18510b57cec5SDimitry Andric                                             unsigned Abbrev) {
18520b57cec5SDimitry Andric   const uint64_t HasUnitFlag = 1 << 1;
18530b57cec5SDimitry Andric   const uint64_t HasSPFlagsFlag = 1 << 2;
18540b57cec5SDimitry Andric   Record.push_back(uint64_t(N->isDistinct()) | HasUnitFlag | HasSPFlagsFlag);
18550b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
18560b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
18570b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
18580b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
18590b57cec5SDimitry Andric   Record.push_back(N->getLine());
18600b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getType()));
18610b57cec5SDimitry Andric   Record.push_back(N->getScopeLine());
18620b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getContainingType()));
18630b57cec5SDimitry Andric   Record.push_back(N->getSPFlags());
18640b57cec5SDimitry Andric   Record.push_back(N->getVirtualIndex());
18650b57cec5SDimitry Andric   Record.push_back(N->getFlags());
18660b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawUnit()));
18670b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get()));
18680b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getDeclaration()));
18690b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRetainedNodes().get()));
18700b57cec5SDimitry Andric   Record.push_back(N->getThisAdjustment());
18710b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getThrownTypes().get()));
1872349cc55cSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get()));
187381ad6265SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawTargetFuncName()));
18740b57cec5SDimitry Andric 
18750b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_SUBPROGRAM, Record, Abbrev);
18760b57cec5SDimitry Andric   Record.clear();
18770b57cec5SDimitry Andric }
18780b57cec5SDimitry Andric 
18790b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDILexicalBlock(const DILexicalBlock *N,
18800b57cec5SDimitry Andric                                               SmallVectorImpl<uint64_t> &Record,
18810b57cec5SDimitry Andric                                               unsigned Abbrev) {
18820b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
18830b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
18840b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
18850b57cec5SDimitry Andric   Record.push_back(N->getLine());
18860b57cec5SDimitry Andric   Record.push_back(N->getColumn());
18870b57cec5SDimitry Andric 
18880b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK, Record, Abbrev);
18890b57cec5SDimitry Andric   Record.clear();
18900b57cec5SDimitry Andric }
18910b57cec5SDimitry Andric 
18920b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDILexicalBlockFile(
18930b57cec5SDimitry Andric     const DILexicalBlockFile *N, SmallVectorImpl<uint64_t> &Record,
18940b57cec5SDimitry Andric     unsigned Abbrev) {
18950b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
18960b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
18970b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
18980b57cec5SDimitry Andric   Record.push_back(N->getDiscriminator());
18990b57cec5SDimitry Andric 
19000b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK_FILE, Record, Abbrev);
19010b57cec5SDimitry Andric   Record.clear();
19020b57cec5SDimitry Andric }
19030b57cec5SDimitry Andric 
19040b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDICommonBlock(const DICommonBlock *N,
19050b57cec5SDimitry Andric                                              SmallVectorImpl<uint64_t> &Record,
19060b57cec5SDimitry Andric                                              unsigned Abbrev) {
19070b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
19080b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
19090b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getDecl()));
19100b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
19110b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
19120b57cec5SDimitry Andric   Record.push_back(N->getLineNo());
19130b57cec5SDimitry Andric 
19140b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_COMMON_BLOCK, Record, Abbrev);
19150b57cec5SDimitry Andric   Record.clear();
19160b57cec5SDimitry Andric }
19170b57cec5SDimitry Andric 
19180b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDINamespace(const DINamespace *N,
19190b57cec5SDimitry Andric                                            SmallVectorImpl<uint64_t> &Record,
19200b57cec5SDimitry Andric                                            unsigned Abbrev) {
19210b57cec5SDimitry Andric   Record.push_back(N->isDistinct() | N->getExportSymbols() << 1);
19220b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
19230b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
19240b57cec5SDimitry Andric 
19250b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_NAMESPACE, Record, Abbrev);
19260b57cec5SDimitry Andric   Record.clear();
19270b57cec5SDimitry Andric }
19280b57cec5SDimitry Andric 
19290b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIMacro(const DIMacro *N,
19300b57cec5SDimitry Andric                                        SmallVectorImpl<uint64_t> &Record,
19310b57cec5SDimitry Andric                                        unsigned Abbrev) {
19320b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
19330b57cec5SDimitry Andric   Record.push_back(N->getMacinfoType());
19340b57cec5SDimitry Andric   Record.push_back(N->getLine());
19350b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
19360b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawValue()));
19370b57cec5SDimitry Andric 
19380b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_MACRO, Record, Abbrev);
19390b57cec5SDimitry Andric   Record.clear();
19400b57cec5SDimitry Andric }
19410b57cec5SDimitry Andric 
19420b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIMacroFile(const DIMacroFile *N,
19430b57cec5SDimitry Andric                                            SmallVectorImpl<uint64_t> &Record,
19440b57cec5SDimitry Andric                                            unsigned Abbrev) {
19450b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
19460b57cec5SDimitry Andric   Record.push_back(N->getMacinfoType());
19470b57cec5SDimitry Andric   Record.push_back(N->getLine());
19480b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
19490b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getElements().get()));
19500b57cec5SDimitry Andric 
19510b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_MACRO_FILE, Record, Abbrev);
19520b57cec5SDimitry Andric   Record.clear();
19530b57cec5SDimitry Andric }
19540b57cec5SDimitry Andric 
1955fe6060f1SDimitry Andric void ModuleBitcodeWriter::writeDIArgList(const DIArgList *N,
1956fe6060f1SDimitry Andric                                          SmallVectorImpl<uint64_t> &Record,
1957fe6060f1SDimitry Andric                                          unsigned Abbrev) {
1958fe6060f1SDimitry Andric   Record.reserve(N->getArgs().size());
1959fe6060f1SDimitry Andric   for (ValueAsMetadata *MD : N->getArgs())
1960fe6060f1SDimitry Andric     Record.push_back(VE.getMetadataID(MD));
1961fe6060f1SDimitry Andric 
1962fe6060f1SDimitry Andric   Stream.EmitRecord(bitc::METADATA_ARG_LIST, Record, Abbrev);
1963fe6060f1SDimitry Andric   Record.clear();
1964fe6060f1SDimitry Andric }
1965fe6060f1SDimitry Andric 
19660b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIModule(const DIModule *N,
19670b57cec5SDimitry Andric                                         SmallVectorImpl<uint64_t> &Record,
19680b57cec5SDimitry Andric                                         unsigned Abbrev) {
19690b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
19700b57cec5SDimitry Andric   for (auto &I : N->operands())
19710b57cec5SDimitry Andric     Record.push_back(VE.getMetadataOrNullID(I));
19725ffd83dbSDimitry Andric   Record.push_back(N->getLineNo());
1973e8d8bef9SDimitry Andric   Record.push_back(N->getIsDecl());
19740b57cec5SDimitry Andric 
19750b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_MODULE, Record, Abbrev);
19760b57cec5SDimitry Andric   Record.clear();
19770b57cec5SDimitry Andric }
19780b57cec5SDimitry Andric 
1979bdd1243dSDimitry Andric void ModuleBitcodeWriter::writeDIAssignID(const DIAssignID *N,
1980bdd1243dSDimitry Andric                                           SmallVectorImpl<uint64_t> &Record,
1981bdd1243dSDimitry Andric                                           unsigned Abbrev) {
1982bdd1243dSDimitry Andric   // There are no arguments for this metadata type.
1983bdd1243dSDimitry Andric   Record.push_back(N->isDistinct());
1984bdd1243dSDimitry Andric   Stream.EmitRecord(bitc::METADATA_ASSIGN_ID, Record, Abbrev);
1985bdd1243dSDimitry Andric   Record.clear();
1986bdd1243dSDimitry Andric }
1987bdd1243dSDimitry Andric 
19880b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDITemplateTypeParameter(
19890b57cec5SDimitry Andric     const DITemplateTypeParameter *N, SmallVectorImpl<uint64_t> &Record,
19900b57cec5SDimitry Andric     unsigned Abbrev) {
19910b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
19920b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
19930b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getType()));
19945ffd83dbSDimitry Andric   Record.push_back(N->isDefault());
19950b57cec5SDimitry Andric 
19960b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_TEMPLATE_TYPE, Record, Abbrev);
19970b57cec5SDimitry Andric   Record.clear();
19980b57cec5SDimitry Andric }
19990b57cec5SDimitry Andric 
20000b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDITemplateValueParameter(
20010b57cec5SDimitry Andric     const DITemplateValueParameter *N, SmallVectorImpl<uint64_t> &Record,
20020b57cec5SDimitry Andric     unsigned Abbrev) {
20030b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
20040b57cec5SDimitry Andric   Record.push_back(N->getTag());
20050b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
20060b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getType()));
20075ffd83dbSDimitry Andric   Record.push_back(N->isDefault());
20080b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getValue()));
20090b57cec5SDimitry Andric 
20100b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_TEMPLATE_VALUE, Record, Abbrev);
20110b57cec5SDimitry Andric   Record.clear();
20120b57cec5SDimitry Andric }
20130b57cec5SDimitry Andric 
20140b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIGlobalVariable(
20150b57cec5SDimitry Andric     const DIGlobalVariable *N, SmallVectorImpl<uint64_t> &Record,
20160b57cec5SDimitry Andric     unsigned Abbrev) {
20170b57cec5SDimitry Andric   const uint64_t Version = 2 << 1;
20180b57cec5SDimitry Andric   Record.push_back((uint64_t)N->isDistinct() | Version);
20190b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
20200b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
20210b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
20220b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
20230b57cec5SDimitry Andric   Record.push_back(N->getLine());
20240b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getType()));
20250b57cec5SDimitry Andric   Record.push_back(N->isLocalToUnit());
20260b57cec5SDimitry Andric   Record.push_back(N->isDefinition());
20270b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getStaticDataMemberDeclaration()));
20280b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams()));
20290b57cec5SDimitry Andric   Record.push_back(N->getAlignInBits());
2030349cc55cSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get()));
20310b57cec5SDimitry Andric 
20320b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR, Record, Abbrev);
20330b57cec5SDimitry Andric   Record.clear();
20340b57cec5SDimitry Andric }
20350b57cec5SDimitry Andric 
20360b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDILocalVariable(
20370b57cec5SDimitry Andric     const DILocalVariable *N, SmallVectorImpl<uint64_t> &Record,
20380b57cec5SDimitry Andric     unsigned Abbrev) {
20390b57cec5SDimitry Andric   // In order to support all possible bitcode formats in BitcodeReader we need
20400b57cec5SDimitry Andric   // to distinguish the following cases:
20410b57cec5SDimitry Andric   // 1) Record has no artificial tag (Record[1]),
20420b57cec5SDimitry Andric   //   has no obsolete inlinedAt field (Record[9]).
20430b57cec5SDimitry Andric   //   In this case Record size will be 8, HasAlignment flag is false.
20440b57cec5SDimitry Andric   // 2) Record has artificial tag (Record[1]),
20450b57cec5SDimitry Andric   //   has no obsolete inlignedAt field (Record[9]).
20460b57cec5SDimitry Andric   //   In this case Record size will be 9, HasAlignment flag is false.
20470b57cec5SDimitry Andric   // 3) Record has both artificial tag (Record[1]) and
20480b57cec5SDimitry Andric   //   obsolete inlignedAt field (Record[9]).
20490b57cec5SDimitry Andric   //   In this case Record size will be 10, HasAlignment flag is false.
20500b57cec5SDimitry Andric   // 4) Record has neither artificial tag, nor inlignedAt field, but
20510b57cec5SDimitry Andric   //   HasAlignment flag is true and Record[8] contains alignment value.
20520b57cec5SDimitry Andric   const uint64_t HasAlignmentFlag = 1 << 1;
20530b57cec5SDimitry Andric   Record.push_back((uint64_t)N->isDistinct() | HasAlignmentFlag);
20540b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
20550b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
20560b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
20570b57cec5SDimitry Andric   Record.push_back(N->getLine());
20580b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getType()));
20590b57cec5SDimitry Andric   Record.push_back(N->getArg());
20600b57cec5SDimitry Andric   Record.push_back(N->getFlags());
20610b57cec5SDimitry Andric   Record.push_back(N->getAlignInBits());
2062349cc55cSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get()));
20630b57cec5SDimitry Andric 
20640b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_LOCAL_VAR, Record, Abbrev);
20650b57cec5SDimitry Andric   Record.clear();
20660b57cec5SDimitry Andric }
20670b57cec5SDimitry Andric 
20680b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDILabel(
20690b57cec5SDimitry Andric     const DILabel *N, SmallVectorImpl<uint64_t> &Record,
20700b57cec5SDimitry Andric     unsigned Abbrev) {
20710b57cec5SDimitry Andric   Record.push_back((uint64_t)N->isDistinct());
20720b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
20730b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
20740b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
20750b57cec5SDimitry Andric   Record.push_back(N->getLine());
20760b57cec5SDimitry Andric 
20770b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_LABEL, Record, Abbrev);
20780b57cec5SDimitry Andric   Record.clear();
20790b57cec5SDimitry Andric }
20800b57cec5SDimitry Andric 
20810b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIExpression(const DIExpression *N,
20820b57cec5SDimitry Andric                                             SmallVectorImpl<uint64_t> &Record,
20830b57cec5SDimitry Andric                                             unsigned Abbrev) {
20840b57cec5SDimitry Andric   Record.reserve(N->getElements().size() + 1);
20850b57cec5SDimitry Andric   const uint64_t Version = 3 << 1;
20860b57cec5SDimitry Andric   Record.push_back((uint64_t)N->isDistinct() | Version);
20870b57cec5SDimitry Andric   Record.append(N->elements_begin(), N->elements_end());
20880b57cec5SDimitry Andric 
20890b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_EXPRESSION, Record, Abbrev);
20900b57cec5SDimitry Andric   Record.clear();
20910b57cec5SDimitry Andric }
20920b57cec5SDimitry Andric 
20930b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIGlobalVariableExpression(
20940b57cec5SDimitry Andric     const DIGlobalVariableExpression *N, SmallVectorImpl<uint64_t> &Record,
20950b57cec5SDimitry Andric     unsigned Abbrev) {
20960b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
20970b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getVariable()));
20980b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getExpression()));
20990b57cec5SDimitry Andric 
21000b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR_EXPR, Record, Abbrev);
21010b57cec5SDimitry Andric   Record.clear();
21020b57cec5SDimitry Andric }
21030b57cec5SDimitry Andric 
21040b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIObjCProperty(const DIObjCProperty *N,
21050b57cec5SDimitry Andric                                               SmallVectorImpl<uint64_t> &Record,
21060b57cec5SDimitry Andric                                               unsigned Abbrev) {
21070b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
21080b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
21090b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
21100b57cec5SDimitry Andric   Record.push_back(N->getLine());
21110b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawSetterName()));
21120b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawGetterName()));
21130b57cec5SDimitry Andric   Record.push_back(N->getAttributes());
21140b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getType()));
21150b57cec5SDimitry Andric 
21160b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_OBJC_PROPERTY, Record, Abbrev);
21170b57cec5SDimitry Andric   Record.clear();
21180b57cec5SDimitry Andric }
21190b57cec5SDimitry Andric 
21200b57cec5SDimitry Andric void ModuleBitcodeWriter::writeDIImportedEntity(
21210b57cec5SDimitry Andric     const DIImportedEntity *N, SmallVectorImpl<uint64_t> &Record,
21220b57cec5SDimitry Andric     unsigned Abbrev) {
21230b57cec5SDimitry Andric   Record.push_back(N->isDistinct());
21240b57cec5SDimitry Andric   Record.push_back(N->getTag());
21250b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
21260b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getEntity()));
21270b57cec5SDimitry Andric   Record.push_back(N->getLine());
21280b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
21290b57cec5SDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getRawFile()));
2130349cc55cSDimitry Andric   Record.push_back(VE.getMetadataOrNullID(N->getElements().get()));
21310b57cec5SDimitry Andric 
21320b57cec5SDimitry Andric   Stream.EmitRecord(bitc::METADATA_IMPORTED_ENTITY, Record, Abbrev);
21330b57cec5SDimitry Andric   Record.clear();
21340b57cec5SDimitry Andric }
21350b57cec5SDimitry Andric 
21360b57cec5SDimitry Andric unsigned ModuleBitcodeWriter::createNamedMetadataAbbrev() {
21370b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
21380b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_NAME));
21390b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
21400b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
21410b57cec5SDimitry Andric   return Stream.EmitAbbrev(std::move(Abbv));
21420b57cec5SDimitry Andric }
21430b57cec5SDimitry Andric 
21440b57cec5SDimitry Andric void ModuleBitcodeWriter::writeNamedMetadata(
21450b57cec5SDimitry Andric     SmallVectorImpl<uint64_t> &Record) {
21460b57cec5SDimitry Andric   if (M.named_metadata_empty())
21470b57cec5SDimitry Andric     return;
21480b57cec5SDimitry Andric 
21490b57cec5SDimitry Andric   unsigned Abbrev = createNamedMetadataAbbrev();
21500b57cec5SDimitry Andric   for (const NamedMDNode &NMD : M.named_metadata()) {
21510b57cec5SDimitry Andric     // Write name.
21520b57cec5SDimitry Andric     StringRef Str = NMD.getName();
21530b57cec5SDimitry Andric     Record.append(Str.bytes_begin(), Str.bytes_end());
21540b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_NAME, Record, Abbrev);
21550b57cec5SDimitry Andric     Record.clear();
21560b57cec5SDimitry Andric 
21570b57cec5SDimitry Andric     // Write named metadata operands.
21580b57cec5SDimitry Andric     for (const MDNode *N : NMD.operands())
21590b57cec5SDimitry Andric       Record.push_back(VE.getMetadataID(N));
21600b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
21610b57cec5SDimitry Andric     Record.clear();
21620b57cec5SDimitry Andric   }
21630b57cec5SDimitry Andric }
21640b57cec5SDimitry Andric 
21650b57cec5SDimitry Andric unsigned ModuleBitcodeWriter::createMetadataStringsAbbrev() {
21660b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
21670b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRINGS));
21680b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of strings
21690b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // offset to chars
21700b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
21710b57cec5SDimitry Andric   return Stream.EmitAbbrev(std::move(Abbv));
21720b57cec5SDimitry Andric }
21730b57cec5SDimitry Andric 
21740b57cec5SDimitry Andric /// Write out a record for MDString.
21750b57cec5SDimitry Andric ///
21760b57cec5SDimitry Andric /// All the metadata strings in a metadata block are emitted in a single
21770b57cec5SDimitry Andric /// record.  The sizes and strings themselves are shoved into a blob.
21780b57cec5SDimitry Andric void ModuleBitcodeWriter::writeMetadataStrings(
21790b57cec5SDimitry Andric     ArrayRef<const Metadata *> Strings, SmallVectorImpl<uint64_t> &Record) {
21800b57cec5SDimitry Andric   if (Strings.empty())
21810b57cec5SDimitry Andric     return;
21820b57cec5SDimitry Andric 
21830b57cec5SDimitry Andric   // Start the record with the number of strings.
21840b57cec5SDimitry Andric   Record.push_back(bitc::METADATA_STRINGS);
21850b57cec5SDimitry Andric   Record.push_back(Strings.size());
21860b57cec5SDimitry Andric 
21870b57cec5SDimitry Andric   // Emit the sizes of the strings in the blob.
21880b57cec5SDimitry Andric   SmallString<256> Blob;
21890b57cec5SDimitry Andric   {
21900b57cec5SDimitry Andric     BitstreamWriter W(Blob);
21910b57cec5SDimitry Andric     for (const Metadata *MD : Strings)
21920b57cec5SDimitry Andric       W.EmitVBR(cast<MDString>(MD)->getLength(), 6);
21930b57cec5SDimitry Andric     W.FlushToWord();
21940b57cec5SDimitry Andric   }
21950b57cec5SDimitry Andric 
21960b57cec5SDimitry Andric   // Add the offset to the strings to the record.
21970b57cec5SDimitry Andric   Record.push_back(Blob.size());
21980b57cec5SDimitry Andric 
21990b57cec5SDimitry Andric   // Add the strings to the blob.
22000b57cec5SDimitry Andric   for (const Metadata *MD : Strings)
22010b57cec5SDimitry Andric     Blob.append(cast<MDString>(MD)->getString());
22020b57cec5SDimitry Andric 
22030b57cec5SDimitry Andric   // Emit the final record.
22040b57cec5SDimitry Andric   Stream.EmitRecordWithBlob(createMetadataStringsAbbrev(), Record, Blob);
22050b57cec5SDimitry Andric   Record.clear();
22060b57cec5SDimitry Andric }
22070b57cec5SDimitry Andric 
22080b57cec5SDimitry Andric // Generates an enum to use as an index in the Abbrev array of Metadata record.
22090b57cec5SDimitry Andric enum MetadataAbbrev : unsigned {
22100b57cec5SDimitry Andric #define HANDLE_MDNODE_LEAF(CLASS) CLASS##AbbrevID,
22110b57cec5SDimitry Andric #include "llvm/IR/Metadata.def"
22120b57cec5SDimitry Andric   LastPlusOne
22130b57cec5SDimitry Andric };
22140b57cec5SDimitry Andric 
22150b57cec5SDimitry Andric void ModuleBitcodeWriter::writeMetadataRecords(
22160b57cec5SDimitry Andric     ArrayRef<const Metadata *> MDs, SmallVectorImpl<uint64_t> &Record,
22170b57cec5SDimitry Andric     std::vector<unsigned> *MDAbbrevs, std::vector<uint64_t> *IndexPos) {
22180b57cec5SDimitry Andric   if (MDs.empty())
22190b57cec5SDimitry Andric     return;
22200b57cec5SDimitry Andric 
22210b57cec5SDimitry Andric   // Initialize MDNode abbreviations.
22220b57cec5SDimitry Andric #define HANDLE_MDNODE_LEAF(CLASS) unsigned CLASS##Abbrev = 0;
22230b57cec5SDimitry Andric #include "llvm/IR/Metadata.def"
22240b57cec5SDimitry Andric 
22250b57cec5SDimitry Andric   for (const Metadata *MD : MDs) {
22260b57cec5SDimitry Andric     if (IndexPos)
22270b57cec5SDimitry Andric       IndexPos->push_back(Stream.GetCurrentBitNo());
22280b57cec5SDimitry Andric     if (const MDNode *N = dyn_cast<MDNode>(MD)) {
22290b57cec5SDimitry Andric       assert(N->isResolved() && "Expected forward references to be resolved");
22300b57cec5SDimitry Andric 
22310b57cec5SDimitry Andric       switch (N->getMetadataID()) {
22320b57cec5SDimitry Andric       default:
22330b57cec5SDimitry Andric         llvm_unreachable("Invalid MDNode subclass");
22340b57cec5SDimitry Andric #define HANDLE_MDNODE_LEAF(CLASS)                                              \
22350b57cec5SDimitry Andric   case Metadata::CLASS##Kind:                                                  \
22360b57cec5SDimitry Andric     if (MDAbbrevs)                                                             \
22370b57cec5SDimitry Andric       write##CLASS(cast<CLASS>(N), Record,                                     \
22380b57cec5SDimitry Andric                    (*MDAbbrevs)[MetadataAbbrev::CLASS##AbbrevID]);             \
22390b57cec5SDimitry Andric     else                                                                       \
22400b57cec5SDimitry Andric       write##CLASS(cast<CLASS>(N), Record, CLASS##Abbrev);                     \
22410b57cec5SDimitry Andric     continue;
22420b57cec5SDimitry Andric #include "llvm/IR/Metadata.def"
22430b57cec5SDimitry Andric       }
22440b57cec5SDimitry Andric     }
22450b57cec5SDimitry Andric     writeValueAsMetadata(cast<ValueAsMetadata>(MD), Record);
22460b57cec5SDimitry Andric   }
22470b57cec5SDimitry Andric }
22480b57cec5SDimitry Andric 
22490b57cec5SDimitry Andric void ModuleBitcodeWriter::writeModuleMetadata() {
22500b57cec5SDimitry Andric   if (!VE.hasMDs() && M.named_metadata_empty())
22510b57cec5SDimitry Andric     return;
22520b57cec5SDimitry Andric 
22530b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 4);
22540b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
22550b57cec5SDimitry Andric 
22560b57cec5SDimitry Andric   // Emit all abbrevs upfront, so that the reader can jump in the middle of the
22570b57cec5SDimitry Andric   // block and load any metadata.
22580b57cec5SDimitry Andric   std::vector<unsigned> MDAbbrevs;
22590b57cec5SDimitry Andric 
22600b57cec5SDimitry Andric   MDAbbrevs.resize(MetadataAbbrev::LastPlusOne);
22610b57cec5SDimitry Andric   MDAbbrevs[MetadataAbbrev::DILocationAbbrevID] = createDILocationAbbrev();
22620b57cec5SDimitry Andric   MDAbbrevs[MetadataAbbrev::GenericDINodeAbbrevID] =
22630b57cec5SDimitry Andric       createGenericDINodeAbbrev();
22640b57cec5SDimitry Andric 
22650b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
22660b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_INDEX_OFFSET));
22670b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
22680b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
22690b57cec5SDimitry Andric   unsigned OffsetAbbrev = Stream.EmitAbbrev(std::move(Abbv));
22700b57cec5SDimitry Andric 
22710b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
22720b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_INDEX));
22730b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
22740b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
22750b57cec5SDimitry Andric   unsigned IndexAbbrev = Stream.EmitAbbrev(std::move(Abbv));
22760b57cec5SDimitry Andric 
22770b57cec5SDimitry Andric   // Emit MDStrings together upfront.
22780b57cec5SDimitry Andric   writeMetadataStrings(VE.getMDStrings(), Record);
22790b57cec5SDimitry Andric 
22800b57cec5SDimitry Andric   // We only emit an index for the metadata record if we have more than a given
22810b57cec5SDimitry Andric   // (naive) threshold of metadatas, otherwise it is not worth it.
22820b57cec5SDimitry Andric   if (VE.getNonMDStrings().size() > IndexThreshold) {
22830b57cec5SDimitry Andric     // Write a placeholder value in for the offset of the metadata index,
22840b57cec5SDimitry Andric     // which is written after the records, so that it can include
22850b57cec5SDimitry Andric     // the offset of each entry. The placeholder offset will be
22860b57cec5SDimitry Andric     // updated after all records are emitted.
22870b57cec5SDimitry Andric     uint64_t Vals[] = {0, 0};
22880b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_INDEX_OFFSET, Vals, OffsetAbbrev);
22890b57cec5SDimitry Andric   }
22900b57cec5SDimitry Andric 
22910b57cec5SDimitry Andric   // Compute and save the bit offset to the current position, which will be
22920b57cec5SDimitry Andric   // patched when we emit the index later. We can simply subtract the 64-bit
22930b57cec5SDimitry Andric   // fixed size from the current bit number to get the location to backpatch.
22940b57cec5SDimitry Andric   uint64_t IndexOffsetRecordBitPos = Stream.GetCurrentBitNo();
22950b57cec5SDimitry Andric 
22960b57cec5SDimitry Andric   // This index will contain the bitpos for each individual record.
22970b57cec5SDimitry Andric   std::vector<uint64_t> IndexPos;
22980b57cec5SDimitry Andric   IndexPos.reserve(VE.getNonMDStrings().size());
22990b57cec5SDimitry Andric 
23000b57cec5SDimitry Andric   // Write all the records
23010b57cec5SDimitry Andric   writeMetadataRecords(VE.getNonMDStrings(), Record, &MDAbbrevs, &IndexPos);
23020b57cec5SDimitry Andric 
23030b57cec5SDimitry Andric   if (VE.getNonMDStrings().size() > IndexThreshold) {
23040b57cec5SDimitry Andric     // Now that we have emitted all the records we will emit the index. But
23050b57cec5SDimitry Andric     // first
23060b57cec5SDimitry Andric     // backpatch the forward reference so that the reader can skip the records
23070b57cec5SDimitry Andric     // efficiently.
23080b57cec5SDimitry Andric     Stream.BackpatchWord64(IndexOffsetRecordBitPos - 64,
23090b57cec5SDimitry Andric                            Stream.GetCurrentBitNo() - IndexOffsetRecordBitPos);
23100b57cec5SDimitry Andric 
23110b57cec5SDimitry Andric     // Delta encode the index.
23120b57cec5SDimitry Andric     uint64_t PreviousValue = IndexOffsetRecordBitPos;
23130b57cec5SDimitry Andric     for (auto &Elt : IndexPos) {
23140b57cec5SDimitry Andric       auto EltDelta = Elt - PreviousValue;
23150b57cec5SDimitry Andric       PreviousValue = Elt;
23160b57cec5SDimitry Andric       Elt = EltDelta;
23170b57cec5SDimitry Andric     }
23180b57cec5SDimitry Andric     // Emit the index record.
23190b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_INDEX, IndexPos, IndexAbbrev);
23200b57cec5SDimitry Andric     IndexPos.clear();
23210b57cec5SDimitry Andric   }
23220b57cec5SDimitry Andric 
23230b57cec5SDimitry Andric   // Write the named metadata now.
23240b57cec5SDimitry Andric   writeNamedMetadata(Record);
23250b57cec5SDimitry Andric 
23260b57cec5SDimitry Andric   auto AddDeclAttachedMetadata = [&](const GlobalObject &GO) {
23270b57cec5SDimitry Andric     SmallVector<uint64_t, 4> Record;
23280b57cec5SDimitry Andric     Record.push_back(VE.getValueID(&GO));
23290b57cec5SDimitry Andric     pushGlobalMetadataAttachment(Record, GO);
23300b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_GLOBAL_DECL_ATTACHMENT, Record);
23310b57cec5SDimitry Andric   };
23320b57cec5SDimitry Andric   for (const Function &F : M)
23330b57cec5SDimitry Andric     if (F.isDeclaration() && F.hasMetadata())
23340b57cec5SDimitry Andric       AddDeclAttachedMetadata(F);
23350b57cec5SDimitry Andric   // FIXME: Only store metadata for declarations here, and move data for global
23360b57cec5SDimitry Andric   // variable definitions to a separate block (PR28134).
23370b57cec5SDimitry Andric   for (const GlobalVariable &GV : M.globals())
23380b57cec5SDimitry Andric     if (GV.hasMetadata())
23390b57cec5SDimitry Andric       AddDeclAttachedMetadata(GV);
23400b57cec5SDimitry Andric 
23410b57cec5SDimitry Andric   Stream.ExitBlock();
23420b57cec5SDimitry Andric }
23430b57cec5SDimitry Andric 
23440b57cec5SDimitry Andric void ModuleBitcodeWriter::writeFunctionMetadata(const Function &F) {
23450b57cec5SDimitry Andric   if (!VE.hasMDs())
23460b57cec5SDimitry Andric     return;
23470b57cec5SDimitry Andric 
23480b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
23490b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
23500b57cec5SDimitry Andric   writeMetadataStrings(VE.getMDStrings(), Record);
23510b57cec5SDimitry Andric   writeMetadataRecords(VE.getNonMDStrings(), Record);
23520b57cec5SDimitry Andric   Stream.ExitBlock();
23530b57cec5SDimitry Andric }
23540b57cec5SDimitry Andric 
23550b57cec5SDimitry Andric void ModuleBitcodeWriter::pushGlobalMetadataAttachment(
23560b57cec5SDimitry Andric     SmallVectorImpl<uint64_t> &Record, const GlobalObject &GO) {
23570b57cec5SDimitry Andric   // [n x [id, mdnode]]
23580b57cec5SDimitry Andric   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
23590b57cec5SDimitry Andric   GO.getAllMetadata(MDs);
23600b57cec5SDimitry Andric   for (const auto &I : MDs) {
23610b57cec5SDimitry Andric     Record.push_back(I.first);
23620b57cec5SDimitry Andric     Record.push_back(VE.getMetadataID(I.second));
23630b57cec5SDimitry Andric   }
23640b57cec5SDimitry Andric }
23650b57cec5SDimitry Andric 
23660b57cec5SDimitry Andric void ModuleBitcodeWriter::writeFunctionMetadataAttachment(const Function &F) {
23670b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3);
23680b57cec5SDimitry Andric 
23690b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
23700b57cec5SDimitry Andric 
23710b57cec5SDimitry Andric   if (F.hasMetadata()) {
23720b57cec5SDimitry Andric     pushGlobalMetadataAttachment(Record, F);
23730b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
23740b57cec5SDimitry Andric     Record.clear();
23750b57cec5SDimitry Andric   }
23760b57cec5SDimitry Andric 
23770b57cec5SDimitry Andric   // Write metadata attachments
23780b57cec5SDimitry Andric   // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]]
23790b57cec5SDimitry Andric   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
23800b57cec5SDimitry Andric   for (const BasicBlock &BB : F)
23810b57cec5SDimitry Andric     for (const Instruction &I : BB) {
23820b57cec5SDimitry Andric       MDs.clear();
23830b57cec5SDimitry Andric       I.getAllMetadataOtherThanDebugLoc(MDs);
23840b57cec5SDimitry Andric 
23850b57cec5SDimitry Andric       // If no metadata, ignore instruction.
23860b57cec5SDimitry Andric       if (MDs.empty()) continue;
23870b57cec5SDimitry Andric 
23880b57cec5SDimitry Andric       Record.push_back(VE.getInstructionID(&I));
23890b57cec5SDimitry Andric 
23900b57cec5SDimitry Andric       for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
23910b57cec5SDimitry Andric         Record.push_back(MDs[i].first);
23920b57cec5SDimitry Andric         Record.push_back(VE.getMetadataID(MDs[i].second));
23930b57cec5SDimitry Andric       }
23940b57cec5SDimitry Andric       Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
23950b57cec5SDimitry Andric       Record.clear();
23960b57cec5SDimitry Andric     }
23970b57cec5SDimitry Andric 
23980b57cec5SDimitry Andric   Stream.ExitBlock();
23990b57cec5SDimitry Andric }
24000b57cec5SDimitry Andric 
24010b57cec5SDimitry Andric void ModuleBitcodeWriter::writeModuleMetadataKinds() {
24020b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
24030b57cec5SDimitry Andric 
24040b57cec5SDimitry Andric   // Write metadata kinds
24050b57cec5SDimitry Andric   // METADATA_KIND - [n x [id, name]]
24060b57cec5SDimitry Andric   SmallVector<StringRef, 8> Names;
24070b57cec5SDimitry Andric   M.getMDKindNames(Names);
24080b57cec5SDimitry Andric 
24090b57cec5SDimitry Andric   if (Names.empty()) return;
24100b57cec5SDimitry Andric 
24110b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::METADATA_KIND_BLOCK_ID, 3);
24120b57cec5SDimitry Andric 
24130b57cec5SDimitry Andric   for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) {
24140b57cec5SDimitry Andric     Record.push_back(MDKindID);
24150b57cec5SDimitry Andric     StringRef KName = Names[MDKindID];
24160b57cec5SDimitry Andric     Record.append(KName.begin(), KName.end());
24170b57cec5SDimitry Andric 
24180b57cec5SDimitry Andric     Stream.EmitRecord(bitc::METADATA_KIND, Record, 0);
24190b57cec5SDimitry Andric     Record.clear();
24200b57cec5SDimitry Andric   }
24210b57cec5SDimitry Andric 
24220b57cec5SDimitry Andric   Stream.ExitBlock();
24230b57cec5SDimitry Andric }
24240b57cec5SDimitry Andric 
24250b57cec5SDimitry Andric void ModuleBitcodeWriter::writeOperandBundleTags() {
24260b57cec5SDimitry Andric   // Write metadata kinds
24270b57cec5SDimitry Andric   //
24280b57cec5SDimitry Andric   // OPERAND_BUNDLE_TAGS_BLOCK_ID : N x OPERAND_BUNDLE_TAG
24290b57cec5SDimitry Andric   //
24300b57cec5SDimitry Andric   // OPERAND_BUNDLE_TAG - [strchr x N]
24310b57cec5SDimitry Andric 
24320b57cec5SDimitry Andric   SmallVector<StringRef, 8> Tags;
24330b57cec5SDimitry Andric   M.getOperandBundleTags(Tags);
24340b57cec5SDimitry Andric 
24350b57cec5SDimitry Andric   if (Tags.empty())
24360b57cec5SDimitry Andric     return;
24370b57cec5SDimitry Andric 
24380b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID, 3);
24390b57cec5SDimitry Andric 
24400b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
24410b57cec5SDimitry Andric 
24420b57cec5SDimitry Andric   for (auto Tag : Tags) {
24430b57cec5SDimitry Andric     Record.append(Tag.begin(), Tag.end());
24440b57cec5SDimitry Andric 
24450b57cec5SDimitry Andric     Stream.EmitRecord(bitc::OPERAND_BUNDLE_TAG, Record, 0);
24460b57cec5SDimitry Andric     Record.clear();
24470b57cec5SDimitry Andric   }
24480b57cec5SDimitry Andric 
24490b57cec5SDimitry Andric   Stream.ExitBlock();
24500b57cec5SDimitry Andric }
24510b57cec5SDimitry Andric 
24520b57cec5SDimitry Andric void ModuleBitcodeWriter::writeSyncScopeNames() {
24530b57cec5SDimitry Andric   SmallVector<StringRef, 8> SSNs;
24540b57cec5SDimitry Andric   M.getContext().getSyncScopeNames(SSNs);
24550b57cec5SDimitry Andric   if (SSNs.empty())
24560b57cec5SDimitry Andric     return;
24570b57cec5SDimitry Andric 
24580b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::SYNC_SCOPE_NAMES_BLOCK_ID, 2);
24590b57cec5SDimitry Andric 
24600b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
24610b57cec5SDimitry Andric   for (auto SSN : SSNs) {
24620b57cec5SDimitry Andric     Record.append(SSN.begin(), SSN.end());
24630b57cec5SDimitry Andric     Stream.EmitRecord(bitc::SYNC_SCOPE_NAME, Record, 0);
24640b57cec5SDimitry Andric     Record.clear();
24650b57cec5SDimitry Andric   }
24660b57cec5SDimitry Andric 
24670b57cec5SDimitry Andric   Stream.ExitBlock();
24680b57cec5SDimitry Andric }
24690b57cec5SDimitry Andric 
24700b57cec5SDimitry Andric void ModuleBitcodeWriter::writeConstants(unsigned FirstVal, unsigned LastVal,
24710b57cec5SDimitry Andric                                          bool isGlobal) {
24720b57cec5SDimitry Andric   if (FirstVal == LastVal) return;
24730b57cec5SDimitry Andric 
24740b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
24750b57cec5SDimitry Andric 
24760b57cec5SDimitry Andric   unsigned AggregateAbbrev = 0;
24770b57cec5SDimitry Andric   unsigned String8Abbrev = 0;
24780b57cec5SDimitry Andric   unsigned CString7Abbrev = 0;
24790b57cec5SDimitry Andric   unsigned CString6Abbrev = 0;
24800b57cec5SDimitry Andric   // If this is a constant pool for the module, emit module-specific abbrevs.
24810b57cec5SDimitry Andric   if (isGlobal) {
24820b57cec5SDimitry Andric     // Abbrev for CST_CODE_AGGREGATE.
24830b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
24840b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
24850b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
24860b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
24870b57cec5SDimitry Andric     AggregateAbbrev = Stream.EmitAbbrev(std::move(Abbv));
24880b57cec5SDimitry Andric 
24890b57cec5SDimitry Andric     // Abbrev for CST_CODE_STRING.
24900b57cec5SDimitry Andric     Abbv = std::make_shared<BitCodeAbbrev>();
24910b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING));
24920b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
24930b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
24940b57cec5SDimitry Andric     String8Abbrev = Stream.EmitAbbrev(std::move(Abbv));
24950b57cec5SDimitry Andric     // Abbrev for CST_CODE_CSTRING.
24960b57cec5SDimitry Andric     Abbv = std::make_shared<BitCodeAbbrev>();
24970b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
24980b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
24990b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
25000b57cec5SDimitry Andric     CString7Abbrev = Stream.EmitAbbrev(std::move(Abbv));
25010b57cec5SDimitry Andric     // Abbrev for CST_CODE_CSTRING.
25020b57cec5SDimitry Andric     Abbv = std::make_shared<BitCodeAbbrev>();
25030b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
25040b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
25050b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
25060b57cec5SDimitry Andric     CString6Abbrev = Stream.EmitAbbrev(std::move(Abbv));
25070b57cec5SDimitry Andric   }
25080b57cec5SDimitry Andric 
25090b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
25100b57cec5SDimitry Andric 
25110b57cec5SDimitry Andric   const ValueEnumerator::ValueList &Vals = VE.getValues();
25120b57cec5SDimitry Andric   Type *LastTy = nullptr;
25130b57cec5SDimitry Andric   for (unsigned i = FirstVal; i != LastVal; ++i) {
25140b57cec5SDimitry Andric     const Value *V = Vals[i].first;
25150b57cec5SDimitry Andric     // If we need to switch types, do so now.
25160b57cec5SDimitry Andric     if (V->getType() != LastTy) {
25170b57cec5SDimitry Andric       LastTy = V->getType();
25180b57cec5SDimitry Andric       Record.push_back(VE.getTypeID(LastTy));
25190b57cec5SDimitry Andric       Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
25200b57cec5SDimitry Andric                         CONSTANTS_SETTYPE_ABBREV);
25210b57cec5SDimitry Andric       Record.clear();
25220b57cec5SDimitry Andric     }
25230b57cec5SDimitry Andric 
25240b57cec5SDimitry Andric     if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
252504eeddc0SDimitry Andric       Record.push_back(VE.getTypeID(IA->getFunctionType()));
2526fe6060f1SDimitry Andric       Record.push_back(
2527fe6060f1SDimitry Andric           unsigned(IA->hasSideEffects()) | unsigned(IA->isAlignStack()) << 1 |
2528fe6060f1SDimitry Andric           unsigned(IA->getDialect() & 1) << 2 | unsigned(IA->canThrow()) << 3);
25290b57cec5SDimitry Andric 
25300b57cec5SDimitry Andric       // Add the asm string.
25310b57cec5SDimitry Andric       const std::string &AsmStr = IA->getAsmString();
25320b57cec5SDimitry Andric       Record.push_back(AsmStr.size());
25330b57cec5SDimitry Andric       Record.append(AsmStr.begin(), AsmStr.end());
25340b57cec5SDimitry Andric 
25350b57cec5SDimitry Andric       // Add the constraint string.
25360b57cec5SDimitry Andric       const std::string &ConstraintStr = IA->getConstraintString();
25370b57cec5SDimitry Andric       Record.push_back(ConstraintStr.size());
25380b57cec5SDimitry Andric       Record.append(ConstraintStr.begin(), ConstraintStr.end());
25390b57cec5SDimitry Andric       Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record);
25400b57cec5SDimitry Andric       Record.clear();
25410b57cec5SDimitry Andric       continue;
25420b57cec5SDimitry Andric     }
25430b57cec5SDimitry Andric     const Constant *C = cast<Constant>(V);
25440b57cec5SDimitry Andric     unsigned Code = -1U;
25450b57cec5SDimitry Andric     unsigned AbbrevToUse = 0;
25460b57cec5SDimitry Andric     if (C->isNullValue()) {
25470b57cec5SDimitry Andric       Code = bitc::CST_CODE_NULL;
2548e8d8bef9SDimitry Andric     } else if (isa<PoisonValue>(C)) {
2549e8d8bef9SDimitry Andric       Code = bitc::CST_CODE_POISON;
25500b57cec5SDimitry Andric     } else if (isa<UndefValue>(C)) {
25510b57cec5SDimitry Andric       Code = bitc::CST_CODE_UNDEF;
25520b57cec5SDimitry Andric     } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
25530b57cec5SDimitry Andric       if (IV->getBitWidth() <= 64) {
25540b57cec5SDimitry Andric         uint64_t V = IV->getSExtValue();
25550b57cec5SDimitry Andric         emitSignedInt64(Record, V);
25560b57cec5SDimitry Andric         Code = bitc::CST_CODE_INTEGER;
25570b57cec5SDimitry Andric         AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
25580b57cec5SDimitry Andric       } else {                             // Wide integers, > 64 bits in size.
25595ffd83dbSDimitry Andric         emitWideAPInt(Record, IV->getValue());
25600b57cec5SDimitry Andric         Code = bitc::CST_CODE_WIDE_INTEGER;
25610b57cec5SDimitry Andric       }
25620b57cec5SDimitry Andric     } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
25630b57cec5SDimitry Andric       Code = bitc::CST_CODE_FLOAT;
25640b57cec5SDimitry Andric       Type *Ty = CFP->getType();
25655ffd83dbSDimitry Andric       if (Ty->isHalfTy() || Ty->isBFloatTy() || Ty->isFloatTy() ||
25665ffd83dbSDimitry Andric           Ty->isDoubleTy()) {
25670b57cec5SDimitry Andric         Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue());
25680b57cec5SDimitry Andric       } else if (Ty->isX86_FP80Ty()) {
25690b57cec5SDimitry Andric         // api needed to prevent premature destruction
25700b57cec5SDimitry Andric         // bits are not in the same order as a normal i80 APInt, compensate.
25710b57cec5SDimitry Andric         APInt api = CFP->getValueAPF().bitcastToAPInt();
25720b57cec5SDimitry Andric         const uint64_t *p = api.getRawData();
25730b57cec5SDimitry Andric         Record.push_back((p[1] << 48) | (p[0] >> 16));
25740b57cec5SDimitry Andric         Record.push_back(p[0] & 0xffffLL);
25750b57cec5SDimitry Andric       } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) {
25760b57cec5SDimitry Andric         APInt api = CFP->getValueAPF().bitcastToAPInt();
25770b57cec5SDimitry Andric         const uint64_t *p = api.getRawData();
25780b57cec5SDimitry Andric         Record.push_back(p[0]);
25790b57cec5SDimitry Andric         Record.push_back(p[1]);
25800b57cec5SDimitry Andric       } else {
25810b57cec5SDimitry Andric         assert(0 && "Unknown FP type!");
25820b57cec5SDimitry Andric       }
25830b57cec5SDimitry Andric     } else if (isa<ConstantDataSequential>(C) &&
25840b57cec5SDimitry Andric                cast<ConstantDataSequential>(C)->isString()) {
25850b57cec5SDimitry Andric       const ConstantDataSequential *Str = cast<ConstantDataSequential>(C);
25860b57cec5SDimitry Andric       // Emit constant strings specially.
25870b57cec5SDimitry Andric       unsigned NumElts = Str->getNumElements();
25880b57cec5SDimitry Andric       // If this is a null-terminated string, use the denser CSTRING encoding.
25890b57cec5SDimitry Andric       if (Str->isCString()) {
25900b57cec5SDimitry Andric         Code = bitc::CST_CODE_CSTRING;
25910b57cec5SDimitry Andric         --NumElts;  // Don't encode the null, which isn't allowed by char6.
25920b57cec5SDimitry Andric       } else {
25930b57cec5SDimitry Andric         Code = bitc::CST_CODE_STRING;
25940b57cec5SDimitry Andric         AbbrevToUse = String8Abbrev;
25950b57cec5SDimitry Andric       }
25960b57cec5SDimitry Andric       bool isCStr7 = Code == bitc::CST_CODE_CSTRING;
25970b57cec5SDimitry Andric       bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING;
25980b57cec5SDimitry Andric       for (unsigned i = 0; i != NumElts; ++i) {
25990b57cec5SDimitry Andric         unsigned char V = Str->getElementAsInteger(i);
26000b57cec5SDimitry Andric         Record.push_back(V);
26010b57cec5SDimitry Andric         isCStr7 &= (V & 128) == 0;
26020b57cec5SDimitry Andric         if (isCStrChar6)
26030b57cec5SDimitry Andric           isCStrChar6 = BitCodeAbbrevOp::isChar6(V);
26040b57cec5SDimitry Andric       }
26050b57cec5SDimitry Andric 
26060b57cec5SDimitry Andric       if (isCStrChar6)
26070b57cec5SDimitry Andric         AbbrevToUse = CString6Abbrev;
26080b57cec5SDimitry Andric       else if (isCStr7)
26090b57cec5SDimitry Andric         AbbrevToUse = CString7Abbrev;
26100b57cec5SDimitry Andric     } else if (const ConstantDataSequential *CDS =
26110b57cec5SDimitry Andric                   dyn_cast<ConstantDataSequential>(C)) {
26120b57cec5SDimitry Andric       Code = bitc::CST_CODE_DATA;
26135ffd83dbSDimitry Andric       Type *EltTy = CDS->getElementType();
26140b57cec5SDimitry Andric       if (isa<IntegerType>(EltTy)) {
26150b57cec5SDimitry Andric         for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
26160b57cec5SDimitry Andric           Record.push_back(CDS->getElementAsInteger(i));
26170b57cec5SDimitry Andric       } else {
26180b57cec5SDimitry Andric         for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
26190b57cec5SDimitry Andric           Record.push_back(
26200b57cec5SDimitry Andric               CDS->getElementAsAPFloat(i).bitcastToAPInt().getLimitedValue());
26210b57cec5SDimitry Andric       }
26220b57cec5SDimitry Andric     } else if (isa<ConstantAggregate>(C)) {
26230b57cec5SDimitry Andric       Code = bitc::CST_CODE_AGGREGATE;
26240b57cec5SDimitry Andric       for (const Value *Op : C->operands())
26250b57cec5SDimitry Andric         Record.push_back(VE.getValueID(Op));
26260b57cec5SDimitry Andric       AbbrevToUse = AggregateAbbrev;
26270b57cec5SDimitry Andric     } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
26280b57cec5SDimitry Andric       switch (CE->getOpcode()) {
26290b57cec5SDimitry Andric       default:
26300b57cec5SDimitry Andric         if (Instruction::isCast(CE->getOpcode())) {
26310b57cec5SDimitry Andric           Code = bitc::CST_CODE_CE_CAST;
26320b57cec5SDimitry Andric           Record.push_back(getEncodedCastOpcode(CE->getOpcode()));
26330b57cec5SDimitry Andric           Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
26340b57cec5SDimitry Andric           Record.push_back(VE.getValueID(C->getOperand(0)));
26350b57cec5SDimitry Andric           AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
26360b57cec5SDimitry Andric         } else {
26370b57cec5SDimitry Andric           assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
26380b57cec5SDimitry Andric           Code = bitc::CST_CODE_CE_BINOP;
26390b57cec5SDimitry Andric           Record.push_back(getEncodedBinaryOpcode(CE->getOpcode()));
26400b57cec5SDimitry Andric           Record.push_back(VE.getValueID(C->getOperand(0)));
26410b57cec5SDimitry Andric           Record.push_back(VE.getValueID(C->getOperand(1)));
26420b57cec5SDimitry Andric           uint64_t Flags = getOptimizationFlags(CE);
26430b57cec5SDimitry Andric           if (Flags != 0)
26440b57cec5SDimitry Andric             Record.push_back(Flags);
26450b57cec5SDimitry Andric         }
26460b57cec5SDimitry Andric         break;
26470b57cec5SDimitry Andric       case Instruction::FNeg: {
26480b57cec5SDimitry Andric         assert(CE->getNumOperands() == 1 && "Unknown constant expr!");
26490b57cec5SDimitry Andric         Code = bitc::CST_CODE_CE_UNOP;
26500b57cec5SDimitry Andric         Record.push_back(getEncodedUnaryOpcode(CE->getOpcode()));
26510b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(0)));
26520b57cec5SDimitry Andric         uint64_t Flags = getOptimizationFlags(CE);
26530b57cec5SDimitry Andric         if (Flags != 0)
26540b57cec5SDimitry Andric           Record.push_back(Flags);
26550b57cec5SDimitry Andric         break;
26560b57cec5SDimitry Andric       }
26570b57cec5SDimitry Andric       case Instruction::GetElementPtr: {
26580b57cec5SDimitry Andric         Code = bitc::CST_CODE_CE_GEP;
26590b57cec5SDimitry Andric         const auto *GO = cast<GEPOperator>(C);
26600b57cec5SDimitry Andric         Record.push_back(VE.getTypeID(GO->getSourceElementType()));
2661bdd1243dSDimitry Andric         if (std::optional<unsigned> Idx = GO->getInRangeIndex()) {
26620b57cec5SDimitry Andric           Code = bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX;
26630b57cec5SDimitry Andric           Record.push_back((*Idx << 1) | GO->isInBounds());
26640b57cec5SDimitry Andric         } else if (GO->isInBounds())
26650b57cec5SDimitry Andric           Code = bitc::CST_CODE_CE_INBOUNDS_GEP;
26660b57cec5SDimitry Andric         for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
26670b57cec5SDimitry Andric           Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
26680b57cec5SDimitry Andric           Record.push_back(VE.getValueID(C->getOperand(i)));
26690b57cec5SDimitry Andric         }
26700b57cec5SDimitry Andric         break;
26710b57cec5SDimitry Andric       }
26720b57cec5SDimitry Andric       case Instruction::ExtractElement:
26730b57cec5SDimitry Andric         Code = bitc::CST_CODE_CE_EXTRACTELT;
26740b57cec5SDimitry Andric         Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
26750b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(0)));
26760b57cec5SDimitry Andric         Record.push_back(VE.getTypeID(C->getOperand(1)->getType()));
26770b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(1)));
26780b57cec5SDimitry Andric         break;
26790b57cec5SDimitry Andric       case Instruction::InsertElement:
26800b57cec5SDimitry Andric         Code = bitc::CST_CODE_CE_INSERTELT;
26810b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(0)));
26820b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(1)));
26830b57cec5SDimitry Andric         Record.push_back(VE.getTypeID(C->getOperand(2)->getType()));
26840b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(2)));
26850b57cec5SDimitry Andric         break;
26860b57cec5SDimitry Andric       case Instruction::ShuffleVector:
26870b57cec5SDimitry Andric         // If the return type and argument types are the same, this is a
26880b57cec5SDimitry Andric         // standard shufflevector instruction.  If the types are different,
26890b57cec5SDimitry Andric         // then the shuffle is widening or truncating the input vectors, and
26900b57cec5SDimitry Andric         // the argument type must also be encoded.
26910b57cec5SDimitry Andric         if (C->getType() == C->getOperand(0)->getType()) {
26920b57cec5SDimitry Andric           Code = bitc::CST_CODE_CE_SHUFFLEVEC;
26930b57cec5SDimitry Andric         } else {
26940b57cec5SDimitry Andric           Code = bitc::CST_CODE_CE_SHUFVEC_EX;
26950b57cec5SDimitry Andric           Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
26960b57cec5SDimitry Andric         }
26970b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(0)));
26980b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(1)));
26995ffd83dbSDimitry Andric         Record.push_back(VE.getValueID(CE->getShuffleMaskForBitcode()));
27000b57cec5SDimitry Andric         break;
27010b57cec5SDimitry Andric       case Instruction::ICmp:
27020b57cec5SDimitry Andric       case Instruction::FCmp:
27030b57cec5SDimitry Andric         Code = bitc::CST_CODE_CE_CMP;
27040b57cec5SDimitry Andric         Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
27050b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(0)));
27060b57cec5SDimitry Andric         Record.push_back(VE.getValueID(C->getOperand(1)));
27070b57cec5SDimitry Andric         Record.push_back(CE->getPredicate());
27080b57cec5SDimitry Andric         break;
27090b57cec5SDimitry Andric       }
27100b57cec5SDimitry Andric     } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
27110b57cec5SDimitry Andric       Code = bitc::CST_CODE_BLOCKADDRESS;
27120b57cec5SDimitry Andric       Record.push_back(VE.getTypeID(BA->getFunction()->getType()));
27130b57cec5SDimitry Andric       Record.push_back(VE.getValueID(BA->getFunction()));
27140b57cec5SDimitry Andric       Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock()));
2715fe6060f1SDimitry Andric     } else if (const auto *Equiv = dyn_cast<DSOLocalEquivalent>(C)) {
2716fe6060f1SDimitry Andric       Code = bitc::CST_CODE_DSO_LOCAL_EQUIVALENT;
2717fe6060f1SDimitry Andric       Record.push_back(VE.getTypeID(Equiv->getGlobalValue()->getType()));
2718fe6060f1SDimitry Andric       Record.push_back(VE.getValueID(Equiv->getGlobalValue()));
27190eae32dcSDimitry Andric     } else if (const auto *NC = dyn_cast<NoCFIValue>(C)) {
27200eae32dcSDimitry Andric       Code = bitc::CST_CODE_NO_CFI_VALUE;
27210eae32dcSDimitry Andric       Record.push_back(VE.getTypeID(NC->getGlobalValue()->getType()));
27220eae32dcSDimitry Andric       Record.push_back(VE.getValueID(NC->getGlobalValue()));
27230b57cec5SDimitry Andric     } else {
27240b57cec5SDimitry Andric #ifndef NDEBUG
27250b57cec5SDimitry Andric       C->dump();
27260b57cec5SDimitry Andric #endif
27270b57cec5SDimitry Andric       llvm_unreachable("Unknown constant!");
27280b57cec5SDimitry Andric     }
27290b57cec5SDimitry Andric     Stream.EmitRecord(Code, Record, AbbrevToUse);
27300b57cec5SDimitry Andric     Record.clear();
27310b57cec5SDimitry Andric   }
27320b57cec5SDimitry Andric 
27330b57cec5SDimitry Andric   Stream.ExitBlock();
27340b57cec5SDimitry Andric }
27350b57cec5SDimitry Andric 
27360b57cec5SDimitry Andric void ModuleBitcodeWriter::writeModuleConstants() {
27370b57cec5SDimitry Andric   const ValueEnumerator::ValueList &Vals = VE.getValues();
27380b57cec5SDimitry Andric 
27390b57cec5SDimitry Andric   // Find the first constant to emit, which is the first non-globalvalue value.
27400b57cec5SDimitry Andric   // We know globalvalues have been emitted by WriteModuleInfo.
27410b57cec5SDimitry Andric   for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
27420b57cec5SDimitry Andric     if (!isa<GlobalValue>(Vals[i].first)) {
27430b57cec5SDimitry Andric       writeConstants(i, Vals.size(), true);
27440b57cec5SDimitry Andric       return;
27450b57cec5SDimitry Andric     }
27460b57cec5SDimitry Andric   }
27470b57cec5SDimitry Andric }
27480b57cec5SDimitry Andric 
27490b57cec5SDimitry Andric /// pushValueAndType - The file has to encode both the value and type id for
27500b57cec5SDimitry Andric /// many values, because we need to know what type to create for forward
27510b57cec5SDimitry Andric /// references.  However, most operands are not forward references, so this type
27520b57cec5SDimitry Andric /// field is not needed.
27530b57cec5SDimitry Andric ///
27540b57cec5SDimitry Andric /// This function adds V's value ID to Vals.  If the value ID is higher than the
27550b57cec5SDimitry Andric /// instruction ID, then it is a forward reference, and it also includes the
27560b57cec5SDimitry Andric /// type ID.  The value ID that is written is encoded relative to the InstID.
27570b57cec5SDimitry Andric bool ModuleBitcodeWriter::pushValueAndType(const Value *V, unsigned InstID,
27580b57cec5SDimitry Andric                                            SmallVectorImpl<unsigned> &Vals) {
27590b57cec5SDimitry Andric   unsigned ValID = VE.getValueID(V);
27600b57cec5SDimitry Andric   // Make encoding relative to the InstID.
27610b57cec5SDimitry Andric   Vals.push_back(InstID - ValID);
27620b57cec5SDimitry Andric   if (ValID >= InstID) {
27630b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(V->getType()));
27640b57cec5SDimitry Andric     return true;
27650b57cec5SDimitry Andric   }
27660b57cec5SDimitry Andric   return false;
27670b57cec5SDimitry Andric }
27680b57cec5SDimitry Andric 
27695ffd83dbSDimitry Andric void ModuleBitcodeWriter::writeOperandBundles(const CallBase &CS,
27700b57cec5SDimitry Andric                                               unsigned InstID) {
27710b57cec5SDimitry Andric   SmallVector<unsigned, 64> Record;
27725ffd83dbSDimitry Andric   LLVMContext &C = CS.getContext();
27730b57cec5SDimitry Andric 
27740b57cec5SDimitry Andric   for (unsigned i = 0, e = CS.getNumOperandBundles(); i != e; ++i) {
27750b57cec5SDimitry Andric     const auto &Bundle = CS.getOperandBundleAt(i);
27760b57cec5SDimitry Andric     Record.push_back(C.getOperandBundleTagID(Bundle.getTagName()));
27770b57cec5SDimitry Andric 
27780b57cec5SDimitry Andric     for (auto &Input : Bundle.Inputs)
27790b57cec5SDimitry Andric       pushValueAndType(Input, InstID, Record);
27800b57cec5SDimitry Andric 
27810b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FUNC_CODE_OPERAND_BUNDLE, Record);
27820b57cec5SDimitry Andric     Record.clear();
27830b57cec5SDimitry Andric   }
27840b57cec5SDimitry Andric }
27850b57cec5SDimitry Andric 
27860b57cec5SDimitry Andric /// pushValue - Like pushValueAndType, but where the type of the value is
27870b57cec5SDimitry Andric /// omitted (perhaps it was already encoded in an earlier operand).
27880b57cec5SDimitry Andric void ModuleBitcodeWriter::pushValue(const Value *V, unsigned InstID,
27890b57cec5SDimitry Andric                                     SmallVectorImpl<unsigned> &Vals) {
27900b57cec5SDimitry Andric   unsigned ValID = VE.getValueID(V);
27910b57cec5SDimitry Andric   Vals.push_back(InstID - ValID);
27920b57cec5SDimitry Andric }
27930b57cec5SDimitry Andric 
27940b57cec5SDimitry Andric void ModuleBitcodeWriter::pushValueSigned(const Value *V, unsigned InstID,
27950b57cec5SDimitry Andric                                           SmallVectorImpl<uint64_t> &Vals) {
27960b57cec5SDimitry Andric   unsigned ValID = VE.getValueID(V);
27970b57cec5SDimitry Andric   int64_t diff = ((int32_t)InstID - (int32_t)ValID);
27980b57cec5SDimitry Andric   emitSignedInt64(Vals, diff);
27990b57cec5SDimitry Andric }
28000b57cec5SDimitry Andric 
28010b57cec5SDimitry Andric /// WriteInstruction - Emit an instruction to the specified stream.
28020b57cec5SDimitry Andric void ModuleBitcodeWriter::writeInstruction(const Instruction &I,
28030b57cec5SDimitry Andric                                            unsigned InstID,
28040b57cec5SDimitry Andric                                            SmallVectorImpl<unsigned> &Vals) {
28050b57cec5SDimitry Andric   unsigned Code = 0;
28060b57cec5SDimitry Andric   unsigned AbbrevToUse = 0;
28070b57cec5SDimitry Andric   VE.setInstructionID(&I);
28080b57cec5SDimitry Andric   switch (I.getOpcode()) {
28090b57cec5SDimitry Andric   default:
28100b57cec5SDimitry Andric     if (Instruction::isCast(I.getOpcode())) {
28110b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_CAST;
28120b57cec5SDimitry Andric       if (!pushValueAndType(I.getOperand(0), InstID, Vals))
28130b57cec5SDimitry Andric         AbbrevToUse = FUNCTION_INST_CAST_ABBREV;
28140b57cec5SDimitry Andric       Vals.push_back(VE.getTypeID(I.getType()));
28150b57cec5SDimitry Andric       Vals.push_back(getEncodedCastOpcode(I.getOpcode()));
28160b57cec5SDimitry Andric     } else {
28170b57cec5SDimitry Andric       assert(isa<BinaryOperator>(I) && "Unknown instruction!");
28180b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_BINOP;
28190b57cec5SDimitry Andric       if (!pushValueAndType(I.getOperand(0), InstID, Vals))
28200b57cec5SDimitry Andric         AbbrevToUse = FUNCTION_INST_BINOP_ABBREV;
28210b57cec5SDimitry Andric       pushValue(I.getOperand(1), InstID, Vals);
28220b57cec5SDimitry Andric       Vals.push_back(getEncodedBinaryOpcode(I.getOpcode()));
28230b57cec5SDimitry Andric       uint64_t Flags = getOptimizationFlags(&I);
28240b57cec5SDimitry Andric       if (Flags != 0) {
28250b57cec5SDimitry Andric         if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV)
28260b57cec5SDimitry Andric           AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV;
28270b57cec5SDimitry Andric         Vals.push_back(Flags);
28280b57cec5SDimitry Andric       }
28290b57cec5SDimitry Andric     }
28300b57cec5SDimitry Andric     break;
28310b57cec5SDimitry Andric   case Instruction::FNeg: {
28320b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_UNOP;
28330b57cec5SDimitry Andric     if (!pushValueAndType(I.getOperand(0), InstID, Vals))
28340b57cec5SDimitry Andric       AbbrevToUse = FUNCTION_INST_UNOP_ABBREV;
28350b57cec5SDimitry Andric     Vals.push_back(getEncodedUnaryOpcode(I.getOpcode()));
28360b57cec5SDimitry Andric     uint64_t Flags = getOptimizationFlags(&I);
28370b57cec5SDimitry Andric     if (Flags != 0) {
28380b57cec5SDimitry Andric       if (AbbrevToUse == FUNCTION_INST_UNOP_ABBREV)
28390b57cec5SDimitry Andric         AbbrevToUse = FUNCTION_INST_UNOP_FLAGS_ABBREV;
28400b57cec5SDimitry Andric       Vals.push_back(Flags);
28410b57cec5SDimitry Andric     }
28420b57cec5SDimitry Andric     break;
28430b57cec5SDimitry Andric   }
28440b57cec5SDimitry Andric   case Instruction::GetElementPtr: {
28450b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_GEP;
28460b57cec5SDimitry Andric     AbbrevToUse = FUNCTION_INST_GEP_ABBREV;
28470b57cec5SDimitry Andric     auto &GEPInst = cast<GetElementPtrInst>(I);
28480b57cec5SDimitry Andric     Vals.push_back(GEPInst.isInBounds());
28490b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(GEPInst.getSourceElementType()));
28500b57cec5SDimitry Andric     for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
28510b57cec5SDimitry Andric       pushValueAndType(I.getOperand(i), InstID, Vals);
28520b57cec5SDimitry Andric     break;
28530b57cec5SDimitry Andric   }
28540b57cec5SDimitry Andric   case Instruction::ExtractValue: {
28550b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_EXTRACTVAL;
28560b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
28570b57cec5SDimitry Andric     const ExtractValueInst *EVI = cast<ExtractValueInst>(&I);
28580b57cec5SDimitry Andric     Vals.append(EVI->idx_begin(), EVI->idx_end());
28590b57cec5SDimitry Andric     break;
28600b57cec5SDimitry Andric   }
28610b57cec5SDimitry Andric   case Instruction::InsertValue: {
28620b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_INSERTVAL;
28630b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
28640b57cec5SDimitry Andric     pushValueAndType(I.getOperand(1), InstID, Vals);
28650b57cec5SDimitry Andric     const InsertValueInst *IVI = cast<InsertValueInst>(&I);
28660b57cec5SDimitry Andric     Vals.append(IVI->idx_begin(), IVI->idx_end());
28670b57cec5SDimitry Andric     break;
28680b57cec5SDimitry Andric   }
28690b57cec5SDimitry Andric   case Instruction::Select: {
28700b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_VSELECT;
28710b57cec5SDimitry Andric     pushValueAndType(I.getOperand(1), InstID, Vals);
28720b57cec5SDimitry Andric     pushValue(I.getOperand(2), InstID, Vals);
28730b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
28740b57cec5SDimitry Andric     uint64_t Flags = getOptimizationFlags(&I);
28750b57cec5SDimitry Andric     if (Flags != 0)
28760b57cec5SDimitry Andric       Vals.push_back(Flags);
28770b57cec5SDimitry Andric     break;
28780b57cec5SDimitry Andric   }
28790b57cec5SDimitry Andric   case Instruction::ExtractElement:
28800b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_EXTRACTELT;
28810b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
28820b57cec5SDimitry Andric     pushValueAndType(I.getOperand(1), InstID, Vals);
28830b57cec5SDimitry Andric     break;
28840b57cec5SDimitry Andric   case Instruction::InsertElement:
28850b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_INSERTELT;
28860b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
28870b57cec5SDimitry Andric     pushValue(I.getOperand(1), InstID, Vals);
28880b57cec5SDimitry Andric     pushValueAndType(I.getOperand(2), InstID, Vals);
28890b57cec5SDimitry Andric     break;
28900b57cec5SDimitry Andric   case Instruction::ShuffleVector:
28910b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
28920b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
28930b57cec5SDimitry Andric     pushValue(I.getOperand(1), InstID, Vals);
28945ffd83dbSDimitry Andric     pushValue(cast<ShuffleVectorInst>(I).getShuffleMaskForBitcode(), InstID,
28955ffd83dbSDimitry Andric               Vals);
28960b57cec5SDimitry Andric     break;
28970b57cec5SDimitry Andric   case Instruction::ICmp:
28980b57cec5SDimitry Andric   case Instruction::FCmp: {
28990b57cec5SDimitry Andric     // compare returning Int1Ty or vector of Int1Ty
29000b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CMP2;
29010b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
29020b57cec5SDimitry Andric     pushValue(I.getOperand(1), InstID, Vals);
29030b57cec5SDimitry Andric     Vals.push_back(cast<CmpInst>(I).getPredicate());
29040b57cec5SDimitry Andric     uint64_t Flags = getOptimizationFlags(&I);
29050b57cec5SDimitry Andric     if (Flags != 0)
29060b57cec5SDimitry Andric       Vals.push_back(Flags);
29070b57cec5SDimitry Andric     break;
29080b57cec5SDimitry Andric   }
29090b57cec5SDimitry Andric 
29100b57cec5SDimitry Andric   case Instruction::Ret:
29110b57cec5SDimitry Andric     {
29120b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_RET;
29130b57cec5SDimitry Andric       unsigned NumOperands = I.getNumOperands();
29140b57cec5SDimitry Andric       if (NumOperands == 0)
29150b57cec5SDimitry Andric         AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV;
29160b57cec5SDimitry Andric       else if (NumOperands == 1) {
29170b57cec5SDimitry Andric         if (!pushValueAndType(I.getOperand(0), InstID, Vals))
29180b57cec5SDimitry Andric           AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV;
29190b57cec5SDimitry Andric       } else {
29200b57cec5SDimitry Andric         for (unsigned i = 0, e = NumOperands; i != e; ++i)
29210b57cec5SDimitry Andric           pushValueAndType(I.getOperand(i), InstID, Vals);
29220b57cec5SDimitry Andric       }
29230b57cec5SDimitry Andric     }
29240b57cec5SDimitry Andric     break;
29250b57cec5SDimitry Andric   case Instruction::Br:
29260b57cec5SDimitry Andric     {
29270b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_BR;
29280b57cec5SDimitry Andric       const BranchInst &II = cast<BranchInst>(I);
29290b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(II.getSuccessor(0)));
29300b57cec5SDimitry Andric       if (II.isConditional()) {
29310b57cec5SDimitry Andric         Vals.push_back(VE.getValueID(II.getSuccessor(1)));
29320b57cec5SDimitry Andric         pushValue(II.getCondition(), InstID, Vals);
29330b57cec5SDimitry Andric       }
29340b57cec5SDimitry Andric     }
29350b57cec5SDimitry Andric     break;
29360b57cec5SDimitry Andric   case Instruction::Switch:
29370b57cec5SDimitry Andric     {
29380b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_SWITCH;
29390b57cec5SDimitry Andric       const SwitchInst &SI = cast<SwitchInst>(I);
29400b57cec5SDimitry Andric       Vals.push_back(VE.getTypeID(SI.getCondition()->getType()));
29410b57cec5SDimitry Andric       pushValue(SI.getCondition(), InstID, Vals);
29420b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(SI.getDefaultDest()));
29430b57cec5SDimitry Andric       for (auto Case : SI.cases()) {
29440b57cec5SDimitry Andric         Vals.push_back(VE.getValueID(Case.getCaseValue()));
29450b57cec5SDimitry Andric         Vals.push_back(VE.getValueID(Case.getCaseSuccessor()));
29460b57cec5SDimitry Andric       }
29470b57cec5SDimitry Andric     }
29480b57cec5SDimitry Andric     break;
29490b57cec5SDimitry Andric   case Instruction::IndirectBr:
29500b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_INDIRECTBR;
29510b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
29520b57cec5SDimitry Andric     // Encode the address operand as relative, but not the basic blocks.
29530b57cec5SDimitry Andric     pushValue(I.getOperand(0), InstID, Vals);
29540b57cec5SDimitry Andric     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
29550b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(I.getOperand(i)));
29560b57cec5SDimitry Andric     break;
29570b57cec5SDimitry Andric 
29580b57cec5SDimitry Andric   case Instruction::Invoke: {
29590b57cec5SDimitry Andric     const InvokeInst *II = cast<InvokeInst>(&I);
29605ffd83dbSDimitry Andric     const Value *Callee = II->getCalledOperand();
29610b57cec5SDimitry Andric     FunctionType *FTy = II->getFunctionType();
29620b57cec5SDimitry Andric 
29630b57cec5SDimitry Andric     if (II->hasOperandBundles())
29645ffd83dbSDimitry Andric       writeOperandBundles(*II, InstID);
29650b57cec5SDimitry Andric 
29660b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_INVOKE;
29670b57cec5SDimitry Andric 
29680b57cec5SDimitry Andric     Vals.push_back(VE.getAttributeListID(II->getAttributes()));
29690b57cec5SDimitry Andric     Vals.push_back(II->getCallingConv() | 1 << 13);
29700b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(II->getNormalDest()));
29710b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(II->getUnwindDest()));
29720b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(FTy));
29730b57cec5SDimitry Andric     pushValueAndType(Callee, InstID, Vals);
29740b57cec5SDimitry Andric 
29750b57cec5SDimitry Andric     // Emit value #'s for the fixed parameters.
29760b57cec5SDimitry Andric     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
29770b57cec5SDimitry Andric       pushValue(I.getOperand(i), InstID, Vals); // fixed param.
29780b57cec5SDimitry Andric 
29790b57cec5SDimitry Andric     // Emit type/value pairs for varargs params.
29800b57cec5SDimitry Andric     if (FTy->isVarArg()) {
2981349cc55cSDimitry Andric       for (unsigned i = FTy->getNumParams(), e = II->arg_size(); i != e; ++i)
29820b57cec5SDimitry Andric         pushValueAndType(I.getOperand(i), InstID, Vals); // vararg
29830b57cec5SDimitry Andric     }
29840b57cec5SDimitry Andric     break;
29850b57cec5SDimitry Andric   }
29860b57cec5SDimitry Andric   case Instruction::Resume:
29870b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_RESUME;
29880b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
29890b57cec5SDimitry Andric     break;
29900b57cec5SDimitry Andric   case Instruction::CleanupRet: {
29910b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CLEANUPRET;
29920b57cec5SDimitry Andric     const auto &CRI = cast<CleanupReturnInst>(I);
29930b57cec5SDimitry Andric     pushValue(CRI.getCleanupPad(), InstID, Vals);
29940b57cec5SDimitry Andric     if (CRI.hasUnwindDest())
29950b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(CRI.getUnwindDest()));
29960b57cec5SDimitry Andric     break;
29970b57cec5SDimitry Andric   }
29980b57cec5SDimitry Andric   case Instruction::CatchRet: {
29990b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CATCHRET;
30000b57cec5SDimitry Andric     const auto &CRI = cast<CatchReturnInst>(I);
30010b57cec5SDimitry Andric     pushValue(CRI.getCatchPad(), InstID, Vals);
30020b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(CRI.getSuccessor()));
30030b57cec5SDimitry Andric     break;
30040b57cec5SDimitry Andric   }
30050b57cec5SDimitry Andric   case Instruction::CleanupPad:
30060b57cec5SDimitry Andric   case Instruction::CatchPad: {
30070b57cec5SDimitry Andric     const auto &FuncletPad = cast<FuncletPadInst>(I);
30080b57cec5SDimitry Andric     Code = isa<CatchPadInst>(FuncletPad) ? bitc::FUNC_CODE_INST_CATCHPAD
30090b57cec5SDimitry Andric                                          : bitc::FUNC_CODE_INST_CLEANUPPAD;
30100b57cec5SDimitry Andric     pushValue(FuncletPad.getParentPad(), InstID, Vals);
30110b57cec5SDimitry Andric 
3012bdd1243dSDimitry Andric     unsigned NumArgOperands = FuncletPad.arg_size();
30130b57cec5SDimitry Andric     Vals.push_back(NumArgOperands);
30140b57cec5SDimitry Andric     for (unsigned Op = 0; Op != NumArgOperands; ++Op)
30150b57cec5SDimitry Andric       pushValueAndType(FuncletPad.getArgOperand(Op), InstID, Vals);
30160b57cec5SDimitry Andric     break;
30170b57cec5SDimitry Andric   }
30180b57cec5SDimitry Andric   case Instruction::CatchSwitch: {
30190b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CATCHSWITCH;
30200b57cec5SDimitry Andric     const auto &CatchSwitch = cast<CatchSwitchInst>(I);
30210b57cec5SDimitry Andric 
30220b57cec5SDimitry Andric     pushValue(CatchSwitch.getParentPad(), InstID, Vals);
30230b57cec5SDimitry Andric 
30240b57cec5SDimitry Andric     unsigned NumHandlers = CatchSwitch.getNumHandlers();
30250b57cec5SDimitry Andric     Vals.push_back(NumHandlers);
30260b57cec5SDimitry Andric     for (const BasicBlock *CatchPadBB : CatchSwitch.handlers())
30270b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(CatchPadBB));
30280b57cec5SDimitry Andric 
30290b57cec5SDimitry Andric     if (CatchSwitch.hasUnwindDest())
30300b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(CatchSwitch.getUnwindDest()));
30310b57cec5SDimitry Andric     break;
30320b57cec5SDimitry Andric   }
30330b57cec5SDimitry Andric   case Instruction::CallBr: {
30340b57cec5SDimitry Andric     const CallBrInst *CBI = cast<CallBrInst>(&I);
30355ffd83dbSDimitry Andric     const Value *Callee = CBI->getCalledOperand();
30360b57cec5SDimitry Andric     FunctionType *FTy = CBI->getFunctionType();
30370b57cec5SDimitry Andric 
30380b57cec5SDimitry Andric     if (CBI->hasOperandBundles())
30395ffd83dbSDimitry Andric       writeOperandBundles(*CBI, InstID);
30400b57cec5SDimitry Andric 
30410b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CALLBR;
30420b57cec5SDimitry Andric 
30430b57cec5SDimitry Andric     Vals.push_back(VE.getAttributeListID(CBI->getAttributes()));
30440b57cec5SDimitry Andric 
30450b57cec5SDimitry Andric     Vals.push_back(CBI->getCallingConv() << bitc::CALL_CCONV |
30460b57cec5SDimitry Andric                    1 << bitc::CALL_EXPLICIT_TYPE);
30470b57cec5SDimitry Andric 
30480b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(CBI->getDefaultDest()));
30490b57cec5SDimitry Andric     Vals.push_back(CBI->getNumIndirectDests());
30500b57cec5SDimitry Andric     for (unsigned i = 0, e = CBI->getNumIndirectDests(); i != e; ++i)
30510b57cec5SDimitry Andric       Vals.push_back(VE.getValueID(CBI->getIndirectDest(i)));
30520b57cec5SDimitry Andric 
30530b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(FTy));
30540b57cec5SDimitry Andric     pushValueAndType(Callee, InstID, Vals);
30550b57cec5SDimitry Andric 
30560b57cec5SDimitry Andric     // Emit value #'s for the fixed parameters.
30570b57cec5SDimitry Andric     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
30580b57cec5SDimitry Andric       pushValue(I.getOperand(i), InstID, Vals); // fixed param.
30590b57cec5SDimitry Andric 
30600b57cec5SDimitry Andric     // Emit type/value pairs for varargs params.
30610b57cec5SDimitry Andric     if (FTy->isVarArg()) {
3062349cc55cSDimitry Andric       for (unsigned i = FTy->getNumParams(), e = CBI->arg_size(); i != e; ++i)
30630b57cec5SDimitry Andric         pushValueAndType(I.getOperand(i), InstID, Vals); // vararg
30640b57cec5SDimitry Andric     }
30650b57cec5SDimitry Andric     break;
30660b57cec5SDimitry Andric   }
30670b57cec5SDimitry Andric   case Instruction::Unreachable:
30680b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_UNREACHABLE;
30690b57cec5SDimitry Andric     AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV;
30700b57cec5SDimitry Andric     break;
30710b57cec5SDimitry Andric 
30720b57cec5SDimitry Andric   case Instruction::PHI: {
30730b57cec5SDimitry Andric     const PHINode &PN = cast<PHINode>(I);
30740b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_PHI;
30750b57cec5SDimitry Andric     // With the newer instruction encoding, forward references could give
30760b57cec5SDimitry Andric     // negative valued IDs.  This is most common for PHIs, so we use
30770b57cec5SDimitry Andric     // signed VBRs.
30780b57cec5SDimitry Andric     SmallVector<uint64_t, 128> Vals64;
30790b57cec5SDimitry Andric     Vals64.push_back(VE.getTypeID(PN.getType()));
30800b57cec5SDimitry Andric     for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
30810b57cec5SDimitry Andric       pushValueSigned(PN.getIncomingValue(i), InstID, Vals64);
30820b57cec5SDimitry Andric       Vals64.push_back(VE.getValueID(PN.getIncomingBlock(i)));
30830b57cec5SDimitry Andric     }
30848bcb0991SDimitry Andric 
30858bcb0991SDimitry Andric     uint64_t Flags = getOptimizationFlags(&I);
30868bcb0991SDimitry Andric     if (Flags != 0)
30878bcb0991SDimitry Andric       Vals64.push_back(Flags);
30888bcb0991SDimitry Andric 
30890b57cec5SDimitry Andric     // Emit a Vals64 vector and exit.
30900b57cec5SDimitry Andric     Stream.EmitRecord(Code, Vals64, AbbrevToUse);
30910b57cec5SDimitry Andric     Vals64.clear();
30920b57cec5SDimitry Andric     return;
30930b57cec5SDimitry Andric   }
30940b57cec5SDimitry Andric 
30950b57cec5SDimitry Andric   case Instruction::LandingPad: {
30960b57cec5SDimitry Andric     const LandingPadInst &LP = cast<LandingPadInst>(I);
30970b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_LANDINGPAD;
30980b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(LP.getType()));
30990b57cec5SDimitry Andric     Vals.push_back(LP.isCleanup());
31000b57cec5SDimitry Andric     Vals.push_back(LP.getNumClauses());
31010b57cec5SDimitry Andric     for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) {
31020b57cec5SDimitry Andric       if (LP.isCatch(I))
31030b57cec5SDimitry Andric         Vals.push_back(LandingPadInst::Catch);
31040b57cec5SDimitry Andric       else
31050b57cec5SDimitry Andric         Vals.push_back(LandingPadInst::Filter);
31060b57cec5SDimitry Andric       pushValueAndType(LP.getClause(I), InstID, Vals);
31070b57cec5SDimitry Andric     }
31080b57cec5SDimitry Andric     break;
31090b57cec5SDimitry Andric   }
31100b57cec5SDimitry Andric 
31110b57cec5SDimitry Andric   case Instruction::Alloca: {
31120b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_ALLOCA;
31130b57cec5SDimitry Andric     const AllocaInst &AI = cast<AllocaInst>(I);
31140b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(AI.getAllocatedType()));
31150b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
31160b57cec5SDimitry Andric     Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
3117e8d8bef9SDimitry Andric     using APV = AllocaPackedValues;
3118e8d8bef9SDimitry Andric     unsigned Record = 0;
3119349cc55cSDimitry Andric     unsigned EncodedAlign = getEncodedAlign(AI.getAlign());
3120349cc55cSDimitry Andric     Bitfield::set<APV::AlignLower>(
3121349cc55cSDimitry Andric         Record, EncodedAlign & ((1 << APV::AlignLower::Bits) - 1));
3122349cc55cSDimitry Andric     Bitfield::set<APV::AlignUpper>(Record,
3123349cc55cSDimitry Andric                                    EncodedAlign >> APV::AlignLower::Bits);
3124e8d8bef9SDimitry Andric     Bitfield::set<APV::UsedWithInAlloca>(Record, AI.isUsedWithInAlloca());
3125e8d8bef9SDimitry Andric     Bitfield::set<APV::ExplicitType>(Record, true);
3126e8d8bef9SDimitry Andric     Bitfield::set<APV::SwiftError>(Record, AI.isSwiftError());
3127e8d8bef9SDimitry Andric     Vals.push_back(Record);
312881ad6265SDimitry Andric 
312981ad6265SDimitry Andric     unsigned AS = AI.getAddressSpace();
313081ad6265SDimitry Andric     if (AS != M.getDataLayout().getAllocaAddrSpace())
313181ad6265SDimitry Andric       Vals.push_back(AS);
31320b57cec5SDimitry Andric     break;
31330b57cec5SDimitry Andric   }
31340b57cec5SDimitry Andric 
31350b57cec5SDimitry Andric   case Instruction::Load:
31360b57cec5SDimitry Andric     if (cast<LoadInst>(I).isAtomic()) {
31370b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_LOADATOMIC;
31380b57cec5SDimitry Andric       pushValueAndType(I.getOperand(0), InstID, Vals);
31390b57cec5SDimitry Andric     } else {
31400b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_LOAD;
31410b57cec5SDimitry Andric       if (!pushValueAndType(I.getOperand(0), InstID, Vals)) // ptr
31420b57cec5SDimitry Andric         AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
31430b57cec5SDimitry Andric     }
31440b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(I.getType()));
3145e8d8bef9SDimitry Andric     Vals.push_back(getEncodedAlign(cast<LoadInst>(I).getAlign()));
31460b57cec5SDimitry Andric     Vals.push_back(cast<LoadInst>(I).isVolatile());
31470b57cec5SDimitry Andric     if (cast<LoadInst>(I).isAtomic()) {
31480b57cec5SDimitry Andric       Vals.push_back(getEncodedOrdering(cast<LoadInst>(I).getOrdering()));
31490b57cec5SDimitry Andric       Vals.push_back(getEncodedSyncScopeID(cast<LoadInst>(I).getSyncScopeID()));
31500b57cec5SDimitry Andric     }
31510b57cec5SDimitry Andric     break;
31520b57cec5SDimitry Andric   case Instruction::Store:
31530b57cec5SDimitry Andric     if (cast<StoreInst>(I).isAtomic())
31540b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_STOREATOMIC;
31550b57cec5SDimitry Andric     else
31560b57cec5SDimitry Andric       Code = bitc::FUNC_CODE_INST_STORE;
31570b57cec5SDimitry Andric     pushValueAndType(I.getOperand(1), InstID, Vals); // ptrty + ptr
31580b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals); // valty + val
3159e8d8bef9SDimitry Andric     Vals.push_back(getEncodedAlign(cast<StoreInst>(I).getAlign()));
31600b57cec5SDimitry Andric     Vals.push_back(cast<StoreInst>(I).isVolatile());
31610b57cec5SDimitry Andric     if (cast<StoreInst>(I).isAtomic()) {
31620b57cec5SDimitry Andric       Vals.push_back(getEncodedOrdering(cast<StoreInst>(I).getOrdering()));
31630b57cec5SDimitry Andric       Vals.push_back(
31640b57cec5SDimitry Andric           getEncodedSyncScopeID(cast<StoreInst>(I).getSyncScopeID()));
31650b57cec5SDimitry Andric     }
31660b57cec5SDimitry Andric     break;
31670b57cec5SDimitry Andric   case Instruction::AtomicCmpXchg:
31680b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CMPXCHG;
31690b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals); // ptrty + ptr
31700b57cec5SDimitry Andric     pushValueAndType(I.getOperand(1), InstID, Vals); // cmp.
31710b57cec5SDimitry Andric     pushValue(I.getOperand(2), InstID, Vals);        // newval.
31720b57cec5SDimitry Andric     Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile());
31730b57cec5SDimitry Andric     Vals.push_back(
31740b57cec5SDimitry Andric         getEncodedOrdering(cast<AtomicCmpXchgInst>(I).getSuccessOrdering()));
31750b57cec5SDimitry Andric     Vals.push_back(
31760b57cec5SDimitry Andric         getEncodedSyncScopeID(cast<AtomicCmpXchgInst>(I).getSyncScopeID()));
31770b57cec5SDimitry Andric     Vals.push_back(
31780b57cec5SDimitry Andric         getEncodedOrdering(cast<AtomicCmpXchgInst>(I).getFailureOrdering()));
31790b57cec5SDimitry Andric     Vals.push_back(cast<AtomicCmpXchgInst>(I).isWeak());
3180fe6060f1SDimitry Andric     Vals.push_back(getEncodedAlign(cast<AtomicCmpXchgInst>(I).getAlign()));
31810b57cec5SDimitry Andric     break;
31820b57cec5SDimitry Andric   case Instruction::AtomicRMW:
31830b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_ATOMICRMW;
31840b57cec5SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals); // ptrty + ptr
3185fe6060f1SDimitry Andric     pushValueAndType(I.getOperand(1), InstID, Vals); // valty + val
31860b57cec5SDimitry Andric     Vals.push_back(
31870b57cec5SDimitry Andric         getEncodedRMWOperation(cast<AtomicRMWInst>(I).getOperation()));
31880b57cec5SDimitry Andric     Vals.push_back(cast<AtomicRMWInst>(I).isVolatile());
31890b57cec5SDimitry Andric     Vals.push_back(getEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering()));
31900b57cec5SDimitry Andric     Vals.push_back(
31910b57cec5SDimitry Andric         getEncodedSyncScopeID(cast<AtomicRMWInst>(I).getSyncScopeID()));
3192fe6060f1SDimitry Andric     Vals.push_back(getEncodedAlign(cast<AtomicRMWInst>(I).getAlign()));
31930b57cec5SDimitry Andric     break;
31940b57cec5SDimitry Andric   case Instruction::Fence:
31950b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_FENCE;
31960b57cec5SDimitry Andric     Vals.push_back(getEncodedOrdering(cast<FenceInst>(I).getOrdering()));
31970b57cec5SDimitry Andric     Vals.push_back(getEncodedSyncScopeID(cast<FenceInst>(I).getSyncScopeID()));
31980b57cec5SDimitry Andric     break;
31990b57cec5SDimitry Andric   case Instruction::Call: {
32000b57cec5SDimitry Andric     const CallInst &CI = cast<CallInst>(I);
32010b57cec5SDimitry Andric     FunctionType *FTy = CI.getFunctionType();
32020b57cec5SDimitry Andric 
32030b57cec5SDimitry Andric     if (CI.hasOperandBundles())
32045ffd83dbSDimitry Andric       writeOperandBundles(CI, InstID);
32050b57cec5SDimitry Andric 
32060b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_CALL;
32070b57cec5SDimitry Andric 
32080b57cec5SDimitry Andric     Vals.push_back(VE.getAttributeListID(CI.getAttributes()));
32090b57cec5SDimitry Andric 
32100b57cec5SDimitry Andric     unsigned Flags = getOptimizationFlags(&I);
32110b57cec5SDimitry Andric     Vals.push_back(CI.getCallingConv() << bitc::CALL_CCONV |
32120b57cec5SDimitry Andric                    unsigned(CI.isTailCall()) << bitc::CALL_TAIL |
32130b57cec5SDimitry Andric                    unsigned(CI.isMustTailCall()) << bitc::CALL_MUSTTAIL |
32140b57cec5SDimitry Andric                    1 << bitc::CALL_EXPLICIT_TYPE |
32150b57cec5SDimitry Andric                    unsigned(CI.isNoTailCall()) << bitc::CALL_NOTAIL |
32160b57cec5SDimitry Andric                    unsigned(Flags != 0) << bitc::CALL_FMF);
32170b57cec5SDimitry Andric     if (Flags != 0)
32180b57cec5SDimitry Andric       Vals.push_back(Flags);
32190b57cec5SDimitry Andric 
32200b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(FTy));
32215ffd83dbSDimitry Andric     pushValueAndType(CI.getCalledOperand(), InstID, Vals); // Callee
32220b57cec5SDimitry Andric 
32230b57cec5SDimitry Andric     // Emit value #'s for the fixed parameters.
32240b57cec5SDimitry Andric     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
32250b57cec5SDimitry Andric       // Check for labels (can happen with asm labels).
32260b57cec5SDimitry Andric       if (FTy->getParamType(i)->isLabelTy())
32270b57cec5SDimitry Andric         Vals.push_back(VE.getValueID(CI.getArgOperand(i)));
32280b57cec5SDimitry Andric       else
32290b57cec5SDimitry Andric         pushValue(CI.getArgOperand(i), InstID, Vals); // fixed param.
32300b57cec5SDimitry Andric     }
32310b57cec5SDimitry Andric 
32320b57cec5SDimitry Andric     // Emit type/value pairs for varargs params.
32330b57cec5SDimitry Andric     if (FTy->isVarArg()) {
3234349cc55cSDimitry Andric       for (unsigned i = FTy->getNumParams(), e = CI.arg_size(); i != e; ++i)
32350b57cec5SDimitry Andric         pushValueAndType(CI.getArgOperand(i), InstID, Vals); // varargs
32360b57cec5SDimitry Andric     }
32370b57cec5SDimitry Andric     break;
32380b57cec5SDimitry Andric   }
32390b57cec5SDimitry Andric   case Instruction::VAArg:
32400b57cec5SDimitry Andric     Code = bitc::FUNC_CODE_INST_VAARG;
32410b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));   // valistty
32420b57cec5SDimitry Andric     pushValue(I.getOperand(0), InstID, Vals);                   // valist.
32430b57cec5SDimitry Andric     Vals.push_back(VE.getTypeID(I.getType())); // restype.
32440b57cec5SDimitry Andric     break;
3245480093f4SDimitry Andric   case Instruction::Freeze:
3246480093f4SDimitry Andric     Code = bitc::FUNC_CODE_INST_FREEZE;
3247480093f4SDimitry Andric     pushValueAndType(I.getOperand(0), InstID, Vals);
3248480093f4SDimitry Andric     break;
32490b57cec5SDimitry Andric   }
32500b57cec5SDimitry Andric 
32510b57cec5SDimitry Andric   Stream.EmitRecord(Code, Vals, AbbrevToUse);
32520b57cec5SDimitry Andric   Vals.clear();
32530b57cec5SDimitry Andric }
32540b57cec5SDimitry Andric 
32550b57cec5SDimitry Andric /// Write a GlobalValue VST to the module. The purpose of this data structure is
32560b57cec5SDimitry Andric /// to allow clients to efficiently find the function body.
32570b57cec5SDimitry Andric void ModuleBitcodeWriter::writeGlobalValueSymbolTable(
32580b57cec5SDimitry Andric   DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex) {
32590b57cec5SDimitry Andric   // Get the offset of the VST we are writing, and backpatch it into
32600b57cec5SDimitry Andric   // the VST forward declaration record.
32610b57cec5SDimitry Andric   uint64_t VSTOffset = Stream.GetCurrentBitNo();
32620b57cec5SDimitry Andric   // The BitcodeStartBit was the stream offset of the identification block.
32630b57cec5SDimitry Andric   VSTOffset -= bitcodeStartBit();
32640b57cec5SDimitry Andric   assert((VSTOffset & 31) == 0 && "VST block not 32-bit aligned");
32650b57cec5SDimitry Andric   // Note that we add 1 here because the offset is relative to one word
32660b57cec5SDimitry Andric   // before the start of the identification block, which was historically
32670b57cec5SDimitry Andric   // always the start of the regular bitcode header.
32680b57cec5SDimitry Andric   Stream.BackpatchWord(VSTOffsetPlaceholder, VSTOffset / 32 + 1);
32690b57cec5SDimitry Andric 
32700b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
32710b57cec5SDimitry Andric 
32720b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
32730b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_FNENTRY));
32740b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
32750b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // funcoffset
32760b57cec5SDimitry Andric   unsigned FnEntryAbbrev = Stream.EmitAbbrev(std::move(Abbv));
32770b57cec5SDimitry Andric 
32780b57cec5SDimitry Andric   for (const Function &F : M) {
32790b57cec5SDimitry Andric     uint64_t Record[2];
32800b57cec5SDimitry Andric 
32810b57cec5SDimitry Andric     if (F.isDeclaration())
32820b57cec5SDimitry Andric       continue;
32830b57cec5SDimitry Andric 
32840b57cec5SDimitry Andric     Record[0] = VE.getValueID(&F);
32850b57cec5SDimitry Andric 
32860b57cec5SDimitry Andric     // Save the word offset of the function (from the start of the
32870b57cec5SDimitry Andric     // actual bitcode written to the stream).
32880b57cec5SDimitry Andric     uint64_t BitcodeIndex = FunctionToBitcodeIndex[&F] - bitcodeStartBit();
32890b57cec5SDimitry Andric     assert((BitcodeIndex & 31) == 0 && "function block not 32-bit aligned");
32900b57cec5SDimitry Andric     // Note that we add 1 here because the offset is relative to one word
32910b57cec5SDimitry Andric     // before the start of the identification block, which was historically
32920b57cec5SDimitry Andric     // always the start of the regular bitcode header.
32930b57cec5SDimitry Andric     Record[1] = BitcodeIndex / 32 + 1;
32940b57cec5SDimitry Andric 
32950b57cec5SDimitry Andric     Stream.EmitRecord(bitc::VST_CODE_FNENTRY, Record, FnEntryAbbrev);
32960b57cec5SDimitry Andric   }
32970b57cec5SDimitry Andric 
32980b57cec5SDimitry Andric   Stream.ExitBlock();
32990b57cec5SDimitry Andric }
33000b57cec5SDimitry Andric 
33010b57cec5SDimitry Andric /// Emit names for arguments, instructions and basic blocks in a function.
33020b57cec5SDimitry Andric void ModuleBitcodeWriter::writeFunctionLevelValueSymbolTable(
33030b57cec5SDimitry Andric     const ValueSymbolTable &VST) {
33040b57cec5SDimitry Andric   if (VST.empty())
33050b57cec5SDimitry Andric     return;
33060b57cec5SDimitry Andric 
33070b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
33080b57cec5SDimitry Andric 
33090b57cec5SDimitry Andric   // FIXME: Set up the abbrev, we know how many values there are!
33100b57cec5SDimitry Andric   // FIXME: We know if the type names can use 7-bit ascii.
33110b57cec5SDimitry Andric   SmallVector<uint64_t, 64> NameVals;
33120b57cec5SDimitry Andric 
33130b57cec5SDimitry Andric   for (const ValueName &Name : VST) {
33140b57cec5SDimitry Andric     // Figure out the encoding to use for the name.
33150b57cec5SDimitry Andric     StringEncoding Bits = getStringEncoding(Name.getKey());
33160b57cec5SDimitry Andric 
33170b57cec5SDimitry Andric     unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
33180b57cec5SDimitry Andric     NameVals.push_back(VE.getValueID(Name.getValue()));
33190b57cec5SDimitry Andric 
33200b57cec5SDimitry Andric     // VST_CODE_ENTRY:   [valueid, namechar x N]
33210b57cec5SDimitry Andric     // VST_CODE_BBENTRY: [bbid, namechar x N]
33220b57cec5SDimitry Andric     unsigned Code;
33230b57cec5SDimitry Andric     if (isa<BasicBlock>(Name.getValue())) {
33240b57cec5SDimitry Andric       Code = bitc::VST_CODE_BBENTRY;
33250b57cec5SDimitry Andric       if (Bits == SE_Char6)
33260b57cec5SDimitry Andric         AbbrevToUse = VST_BBENTRY_6_ABBREV;
33270b57cec5SDimitry Andric     } else {
33280b57cec5SDimitry Andric       Code = bitc::VST_CODE_ENTRY;
33290b57cec5SDimitry Andric       if (Bits == SE_Char6)
33300b57cec5SDimitry Andric         AbbrevToUse = VST_ENTRY_6_ABBREV;
33310b57cec5SDimitry Andric       else if (Bits == SE_Fixed7)
33320b57cec5SDimitry Andric         AbbrevToUse = VST_ENTRY_7_ABBREV;
33330b57cec5SDimitry Andric     }
33340b57cec5SDimitry Andric 
33350b57cec5SDimitry Andric     for (const auto P : Name.getKey())
33360b57cec5SDimitry Andric       NameVals.push_back((unsigned char)P);
33370b57cec5SDimitry Andric 
33380b57cec5SDimitry Andric     // Emit the finished record.
33390b57cec5SDimitry Andric     Stream.EmitRecord(Code, NameVals, AbbrevToUse);
33400b57cec5SDimitry Andric     NameVals.clear();
33410b57cec5SDimitry Andric   }
33420b57cec5SDimitry Andric 
33430b57cec5SDimitry Andric   Stream.ExitBlock();
33440b57cec5SDimitry Andric }
33450b57cec5SDimitry Andric 
33460b57cec5SDimitry Andric void ModuleBitcodeWriter::writeUseList(UseListOrder &&Order) {
33470b57cec5SDimitry Andric   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
33480b57cec5SDimitry Andric   unsigned Code;
33490b57cec5SDimitry Andric   if (isa<BasicBlock>(Order.V))
33500b57cec5SDimitry Andric     Code = bitc::USELIST_CODE_BB;
33510b57cec5SDimitry Andric   else
33520b57cec5SDimitry Andric     Code = bitc::USELIST_CODE_DEFAULT;
33530b57cec5SDimitry Andric 
33540b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record(Order.Shuffle.begin(), Order.Shuffle.end());
33550b57cec5SDimitry Andric   Record.push_back(VE.getValueID(Order.V));
33560b57cec5SDimitry Andric   Stream.EmitRecord(Code, Record);
33570b57cec5SDimitry Andric }
33580b57cec5SDimitry Andric 
33590b57cec5SDimitry Andric void ModuleBitcodeWriter::writeUseListBlock(const Function *F) {
33600b57cec5SDimitry Andric   assert(VE.shouldPreserveUseListOrder() &&
33610b57cec5SDimitry Andric          "Expected to be preserving use-list order");
33620b57cec5SDimitry Andric 
33630b57cec5SDimitry Andric   auto hasMore = [&]() {
33640b57cec5SDimitry Andric     return !VE.UseListOrders.empty() && VE.UseListOrders.back().F == F;
33650b57cec5SDimitry Andric   };
33660b57cec5SDimitry Andric   if (!hasMore())
33670b57cec5SDimitry Andric     // Nothing to do.
33680b57cec5SDimitry Andric     return;
33690b57cec5SDimitry Andric 
33700b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3);
33710b57cec5SDimitry Andric   while (hasMore()) {
33720b57cec5SDimitry Andric     writeUseList(std::move(VE.UseListOrders.back()));
33730b57cec5SDimitry Andric     VE.UseListOrders.pop_back();
33740b57cec5SDimitry Andric   }
33750b57cec5SDimitry Andric   Stream.ExitBlock();
33760b57cec5SDimitry Andric }
33770b57cec5SDimitry Andric 
33780b57cec5SDimitry Andric /// Emit a function body to the module stream.
33790b57cec5SDimitry Andric void ModuleBitcodeWriter::writeFunction(
33800b57cec5SDimitry Andric     const Function &F,
33810b57cec5SDimitry Andric     DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex) {
33820b57cec5SDimitry Andric   // Save the bitcode index of the start of this function block for recording
33830b57cec5SDimitry Andric   // in the VST.
33840b57cec5SDimitry Andric   FunctionToBitcodeIndex[&F] = Stream.GetCurrentBitNo();
33850b57cec5SDimitry Andric 
33860b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4);
33870b57cec5SDimitry Andric   VE.incorporateFunction(F);
33880b57cec5SDimitry Andric 
33890b57cec5SDimitry Andric   SmallVector<unsigned, 64> Vals;
33900b57cec5SDimitry Andric 
33910b57cec5SDimitry Andric   // Emit the number of basic blocks, so the reader can create them ahead of
33920b57cec5SDimitry Andric   // time.
33930b57cec5SDimitry Andric   Vals.push_back(VE.getBasicBlocks().size());
33940b57cec5SDimitry Andric   Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
33950b57cec5SDimitry Andric   Vals.clear();
33960b57cec5SDimitry Andric 
33970b57cec5SDimitry Andric   // If there are function-local constants, emit them now.
33980b57cec5SDimitry Andric   unsigned CstStart, CstEnd;
33990b57cec5SDimitry Andric   VE.getFunctionConstantRange(CstStart, CstEnd);
34000b57cec5SDimitry Andric   writeConstants(CstStart, CstEnd, false);
34010b57cec5SDimitry Andric 
34020b57cec5SDimitry Andric   // If there is function-local metadata, emit it now.
34030b57cec5SDimitry Andric   writeFunctionMetadata(F);
34040b57cec5SDimitry Andric 
34050b57cec5SDimitry Andric   // Keep a running idea of what the instruction ID is.
34060b57cec5SDimitry Andric   unsigned InstID = CstEnd;
34070b57cec5SDimitry Andric 
34080b57cec5SDimitry Andric   bool NeedsMetadataAttachment = F.hasMetadata();
34090b57cec5SDimitry Andric 
34100b57cec5SDimitry Andric   DILocation *LastDL = nullptr;
341181ad6265SDimitry Andric   SmallSetVector<Function *, 4> BlockAddressUsers;
341281ad6265SDimitry Andric 
34130b57cec5SDimitry Andric   // Finally, emit all the instructions, in order.
341481ad6265SDimitry Andric   for (const BasicBlock &BB : F) {
34154824e7fdSDimitry Andric     for (const Instruction &I : BB) {
34164824e7fdSDimitry Andric       writeInstruction(I, InstID, Vals);
34170b57cec5SDimitry Andric 
34184824e7fdSDimitry Andric       if (!I.getType()->isVoidTy())
34190b57cec5SDimitry Andric         ++InstID;
34200b57cec5SDimitry Andric 
34210b57cec5SDimitry Andric       // If the instruction has metadata, write a metadata attachment later.
34224824e7fdSDimitry Andric       NeedsMetadataAttachment |= I.hasMetadataOtherThanDebugLoc();
34230b57cec5SDimitry Andric 
34240b57cec5SDimitry Andric       // If the instruction has a debug location, emit it.
34254824e7fdSDimitry Andric       DILocation *DL = I.getDebugLoc();
34260b57cec5SDimitry Andric       if (!DL)
34270b57cec5SDimitry Andric         continue;
34280b57cec5SDimitry Andric 
34290b57cec5SDimitry Andric       if (DL == LastDL) {
34300b57cec5SDimitry Andric         // Just repeat the same debug loc as last time.
34310b57cec5SDimitry Andric         Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals);
34320b57cec5SDimitry Andric         continue;
34330b57cec5SDimitry Andric       }
34340b57cec5SDimitry Andric 
34350b57cec5SDimitry Andric       Vals.push_back(DL->getLine());
34360b57cec5SDimitry Andric       Vals.push_back(DL->getColumn());
34370b57cec5SDimitry Andric       Vals.push_back(VE.getMetadataOrNullID(DL->getScope()));
34380b57cec5SDimitry Andric       Vals.push_back(VE.getMetadataOrNullID(DL->getInlinedAt()));
34390b57cec5SDimitry Andric       Vals.push_back(DL->isImplicitCode());
34400b57cec5SDimitry Andric       Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals);
34410b57cec5SDimitry Andric       Vals.clear();
34420b57cec5SDimitry Andric 
34430b57cec5SDimitry Andric       LastDL = DL;
34440b57cec5SDimitry Andric     }
34450b57cec5SDimitry Andric 
344681ad6265SDimitry Andric     if (BlockAddress *BA = BlockAddress::lookup(&BB)) {
344781ad6265SDimitry Andric       SmallVector<Value *> Worklist{BA};
344881ad6265SDimitry Andric       SmallPtrSet<Value *, 8> Visited{BA};
344981ad6265SDimitry Andric       while (!Worklist.empty()) {
345081ad6265SDimitry Andric         Value *V = Worklist.pop_back_val();
345181ad6265SDimitry Andric         for (User *U : V->users()) {
345281ad6265SDimitry Andric           if (auto *I = dyn_cast<Instruction>(U)) {
345381ad6265SDimitry Andric             Function *P = I->getFunction();
345481ad6265SDimitry Andric             if (P != &F)
345581ad6265SDimitry Andric               BlockAddressUsers.insert(P);
345681ad6265SDimitry Andric           } else if (isa<Constant>(U) && !isa<GlobalValue>(U) &&
345781ad6265SDimitry Andric                      Visited.insert(U).second)
345881ad6265SDimitry Andric             Worklist.push_back(U);
345981ad6265SDimitry Andric         }
346081ad6265SDimitry Andric       }
346181ad6265SDimitry Andric     }
346281ad6265SDimitry Andric   }
346381ad6265SDimitry Andric 
346481ad6265SDimitry Andric   if (!BlockAddressUsers.empty()) {
346581ad6265SDimitry Andric     Vals.resize(BlockAddressUsers.size());
346681ad6265SDimitry Andric     for (auto I : llvm::enumerate(BlockAddressUsers))
346781ad6265SDimitry Andric       Vals[I.index()] = VE.getValueID(I.value());
346881ad6265SDimitry Andric     Stream.EmitRecord(bitc::FUNC_CODE_BLOCKADDR_USERS, Vals);
346981ad6265SDimitry Andric     Vals.clear();
347081ad6265SDimitry Andric   }
347181ad6265SDimitry Andric 
34720b57cec5SDimitry Andric   // Emit names for all the instructions etc.
34730b57cec5SDimitry Andric   if (auto *Symtab = F.getValueSymbolTable())
34740b57cec5SDimitry Andric     writeFunctionLevelValueSymbolTable(*Symtab);
34750b57cec5SDimitry Andric 
34760b57cec5SDimitry Andric   if (NeedsMetadataAttachment)
34770b57cec5SDimitry Andric     writeFunctionMetadataAttachment(F);
34780b57cec5SDimitry Andric   if (VE.shouldPreserveUseListOrder())
34790b57cec5SDimitry Andric     writeUseListBlock(&F);
34800b57cec5SDimitry Andric   VE.purgeFunction();
34810b57cec5SDimitry Andric   Stream.ExitBlock();
34820b57cec5SDimitry Andric }
34830b57cec5SDimitry Andric 
34840b57cec5SDimitry Andric // Emit blockinfo, which defines the standard abbreviations etc.
34850b57cec5SDimitry Andric void ModuleBitcodeWriter::writeBlockInfo() {
34860b57cec5SDimitry Andric   // We only want to emit block info records for blocks that have multiple
34870b57cec5SDimitry Andric   // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK.
34880b57cec5SDimitry Andric   // Other blocks can define their abbrevs inline.
34890b57cec5SDimitry Andric   Stream.EnterBlockInfoBlock();
34900b57cec5SDimitry Andric 
34910b57cec5SDimitry Andric   { // 8-bit fixed-width VST_CODE_ENTRY/VST_CODE_BBENTRY strings.
34920b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
34930b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
34940b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
34950b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
34960b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
34970b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) !=
34980b57cec5SDimitry Andric         VST_ENTRY_8_ABBREV)
34990b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35000b57cec5SDimitry Andric   }
35010b57cec5SDimitry Andric 
35020b57cec5SDimitry Andric   { // 7-bit fixed width VST_CODE_ENTRY strings.
35030b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35040b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
35050b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
35060b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
35070b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
35080b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) !=
35090b57cec5SDimitry Andric         VST_ENTRY_7_ABBREV)
35100b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35110b57cec5SDimitry Andric   }
35120b57cec5SDimitry Andric   { // 6-bit char6 VST_CODE_ENTRY strings.
35130b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35140b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
35150b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
35160b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
35170b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
35180b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) !=
35190b57cec5SDimitry Andric         VST_ENTRY_6_ABBREV)
35200b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35210b57cec5SDimitry Andric   }
35220b57cec5SDimitry Andric   { // 6-bit char6 VST_CODE_BBENTRY strings.
35230b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35240b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
35250b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
35260b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
35270b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
35280b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) !=
35290b57cec5SDimitry Andric         VST_BBENTRY_6_ABBREV)
35300b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35310b57cec5SDimitry Andric   }
35320b57cec5SDimitry Andric 
35330b57cec5SDimitry Andric   { // SETTYPE abbrev for CONSTANTS_BLOCK.
35340b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35350b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
35360b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
35370b57cec5SDimitry Andric                               VE.computeBitsRequiredForTypeIndicies()));
35380b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) !=
35390b57cec5SDimitry Andric         CONSTANTS_SETTYPE_ABBREV)
35400b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35410b57cec5SDimitry Andric   }
35420b57cec5SDimitry Andric 
35430b57cec5SDimitry Andric   { // INTEGER abbrev for CONSTANTS_BLOCK.
35440b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35450b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
35460b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
35470b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) !=
35480b57cec5SDimitry Andric         CONSTANTS_INTEGER_ABBREV)
35490b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35500b57cec5SDimitry Andric   }
35510b57cec5SDimitry Andric 
35520b57cec5SDimitry Andric   { // CE_CAST abbrev for CONSTANTS_BLOCK.
35530b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35540b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
35550b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));  // cast opc
35560b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,       // typeid
35570b57cec5SDimitry Andric                               VE.computeBitsRequiredForTypeIndicies()));
35580b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));    // value id
35590b57cec5SDimitry Andric 
35600b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) !=
35610b57cec5SDimitry Andric         CONSTANTS_CE_CAST_Abbrev)
35620b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35630b57cec5SDimitry Andric   }
35640b57cec5SDimitry Andric   { // NULL abbrev for CONSTANTS_BLOCK.
35650b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35660b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
35670b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) !=
35680b57cec5SDimitry Andric         CONSTANTS_NULL_Abbrev)
35690b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35700b57cec5SDimitry Andric   }
35710b57cec5SDimitry Andric 
35720b57cec5SDimitry Andric   // FIXME: This should only use space for first class types!
35730b57cec5SDimitry Andric 
35740b57cec5SDimitry Andric   { // INST_LOAD abbrev for FUNCTION_BLOCK.
35750b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35760b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
35770b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
35780b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,    // dest ty
35790b57cec5SDimitry Andric                               VE.computeBitsRequiredForTypeIndicies()));
35800b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
35810b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
35820b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
35830b57cec5SDimitry Andric         FUNCTION_INST_LOAD_ABBREV)
35840b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35850b57cec5SDimitry Andric   }
35860b57cec5SDimitry Andric   { // INST_UNOP abbrev for FUNCTION_BLOCK.
35870b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35880b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNOP));
35890b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
35900b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
35910b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
35920b57cec5SDimitry Andric         FUNCTION_INST_UNOP_ABBREV)
35930b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
35940b57cec5SDimitry Andric   }
35950b57cec5SDimitry Andric   { // INST_UNOP_FLAGS abbrev for FUNCTION_BLOCK.
35960b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
35970b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNOP));
35980b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
35990b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
36000b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); // flags
36010b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36020b57cec5SDimitry Andric         FUNCTION_INST_UNOP_FLAGS_ABBREV)
36030b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36040b57cec5SDimitry Andric   }
36050b57cec5SDimitry Andric   { // INST_BINOP abbrev for FUNCTION_BLOCK.
36060b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36070b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
36080b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
36090b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
36100b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
36110b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36120b57cec5SDimitry Andric         FUNCTION_INST_BINOP_ABBREV)
36130b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36140b57cec5SDimitry Andric   }
36150b57cec5SDimitry Andric   { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK.
36160b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36170b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
36180b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
36190b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
36200b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
36210b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); // flags
36220b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36230b57cec5SDimitry Andric         FUNCTION_INST_BINOP_FLAGS_ABBREV)
36240b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36250b57cec5SDimitry Andric   }
36260b57cec5SDimitry Andric   { // INST_CAST abbrev for FUNCTION_BLOCK.
36270b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36280b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST));
36290b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));    // OpVal
36300b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,       // dest ty
36310b57cec5SDimitry Andric                               VE.computeBitsRequiredForTypeIndicies()));
36320b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));  // opc
36330b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36340b57cec5SDimitry Andric         FUNCTION_INST_CAST_ABBREV)
36350b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36360b57cec5SDimitry Andric   }
36370b57cec5SDimitry Andric 
36380b57cec5SDimitry Andric   { // INST_RET abbrev for FUNCTION_BLOCK.
36390b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36400b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
36410b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36420b57cec5SDimitry Andric         FUNCTION_INST_RET_VOID_ABBREV)
36430b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36440b57cec5SDimitry Andric   }
36450b57cec5SDimitry Andric   { // INST_RET abbrev for FUNCTION_BLOCK.
36460b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36470b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
36480b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID
36490b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36500b57cec5SDimitry Andric         FUNCTION_INST_RET_VAL_ABBREV)
36510b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36520b57cec5SDimitry Andric   }
36530b57cec5SDimitry Andric   { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK.
36540b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36550b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE));
36560b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36570b57cec5SDimitry Andric         FUNCTION_INST_UNREACHABLE_ABBREV)
36580b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36590b57cec5SDimitry Andric   }
36600b57cec5SDimitry Andric   {
36610b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
36620b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_GEP));
36630b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
36640b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
36650b57cec5SDimitry Andric                               Log2_32_Ceil(VE.getTypes().size() + 1)));
36660b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
36670b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
36680b57cec5SDimitry Andric     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
36690b57cec5SDimitry Andric         FUNCTION_INST_GEP_ABBREV)
36700b57cec5SDimitry Andric       llvm_unreachable("Unexpected abbrev ordering!");
36710b57cec5SDimitry Andric   }
36720b57cec5SDimitry Andric 
36730b57cec5SDimitry Andric   Stream.ExitBlock();
36740b57cec5SDimitry Andric }
36750b57cec5SDimitry Andric 
36760b57cec5SDimitry Andric /// Write the module path strings, currently only used when generating
36770b57cec5SDimitry Andric /// a combined index file.
36780b57cec5SDimitry Andric void IndexBitcodeWriter::writeModStrings() {
36790b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::MODULE_STRTAB_BLOCK_ID, 3);
36800b57cec5SDimitry Andric 
36810b57cec5SDimitry Andric   // TODO: See which abbrev sizes we actually need to emit
36820b57cec5SDimitry Andric 
36830b57cec5SDimitry Andric   // 8-bit fixed-width MST_ENTRY strings.
36840b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
36850b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY));
36860b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
36870b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
36880b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
36890b57cec5SDimitry Andric   unsigned Abbrev8Bit = Stream.EmitAbbrev(std::move(Abbv));
36900b57cec5SDimitry Andric 
36910b57cec5SDimitry Andric   // 7-bit fixed width MST_ENTRY strings.
36920b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
36930b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY));
36940b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
36950b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
36960b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
36970b57cec5SDimitry Andric   unsigned Abbrev7Bit = Stream.EmitAbbrev(std::move(Abbv));
36980b57cec5SDimitry Andric 
36990b57cec5SDimitry Andric   // 6-bit char6 MST_ENTRY strings.
37000b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
37010b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY));
37020b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
37030b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
37040b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
37050b57cec5SDimitry Andric   unsigned Abbrev6Bit = Stream.EmitAbbrev(std::move(Abbv));
37060b57cec5SDimitry Andric 
37070b57cec5SDimitry Andric   // Module Hash, 160 bits SHA1. Optionally, emitted after each MST_CODE_ENTRY.
37080b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
37090b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_HASH));
37100b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
37110b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
37120b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
37130b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
37140b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
37150b57cec5SDimitry Andric   unsigned AbbrevHash = Stream.EmitAbbrev(std::move(Abbv));
37160b57cec5SDimitry Andric 
37170b57cec5SDimitry Andric   SmallVector<unsigned, 64> Vals;
37180b57cec5SDimitry Andric   forEachModule(
37190b57cec5SDimitry Andric       [&](const StringMapEntry<std::pair<uint64_t, ModuleHash>> &MPSE) {
37200b57cec5SDimitry Andric         StringRef Key = MPSE.getKey();
37210b57cec5SDimitry Andric         const auto &Value = MPSE.getValue();
37220b57cec5SDimitry Andric         StringEncoding Bits = getStringEncoding(Key);
37230b57cec5SDimitry Andric         unsigned AbbrevToUse = Abbrev8Bit;
37240b57cec5SDimitry Andric         if (Bits == SE_Char6)
37250b57cec5SDimitry Andric           AbbrevToUse = Abbrev6Bit;
37260b57cec5SDimitry Andric         else if (Bits == SE_Fixed7)
37270b57cec5SDimitry Andric           AbbrevToUse = Abbrev7Bit;
37280b57cec5SDimitry Andric 
37290b57cec5SDimitry Andric         Vals.push_back(Value.first);
37300b57cec5SDimitry Andric         Vals.append(Key.begin(), Key.end());
37310b57cec5SDimitry Andric 
37320b57cec5SDimitry Andric         // Emit the finished record.
37330b57cec5SDimitry Andric         Stream.EmitRecord(bitc::MST_CODE_ENTRY, Vals, AbbrevToUse);
37340b57cec5SDimitry Andric 
37350b57cec5SDimitry Andric         // Emit an optional hash for the module now
37360b57cec5SDimitry Andric         const auto &Hash = Value.second;
37370b57cec5SDimitry Andric         if (llvm::any_of(Hash, [](uint32_t H) { return H; })) {
37380b57cec5SDimitry Andric           Vals.assign(Hash.begin(), Hash.end());
37390b57cec5SDimitry Andric           // Emit the hash record.
37400b57cec5SDimitry Andric           Stream.EmitRecord(bitc::MST_CODE_HASH, Vals, AbbrevHash);
37410b57cec5SDimitry Andric         }
37420b57cec5SDimitry Andric 
37430b57cec5SDimitry Andric         Vals.clear();
37440b57cec5SDimitry Andric       });
37450b57cec5SDimitry Andric   Stream.ExitBlock();
37460b57cec5SDimitry Andric }
37470b57cec5SDimitry Andric 
37480b57cec5SDimitry Andric /// Write the function type metadata related records that need to appear before
37490b57cec5SDimitry Andric /// a function summary entry (whether per-module or combined).
3750e8d8bef9SDimitry Andric template <typename Fn>
37510b57cec5SDimitry Andric static void writeFunctionTypeMetadataRecords(BitstreamWriter &Stream,
3752e8d8bef9SDimitry Andric                                              FunctionSummary *FS,
3753e8d8bef9SDimitry Andric                                              Fn GetValueID) {
37540b57cec5SDimitry Andric   if (!FS->type_tests().empty())
37550b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_TYPE_TESTS, FS->type_tests());
37560b57cec5SDimitry Andric 
37570b57cec5SDimitry Andric   SmallVector<uint64_t, 64> Record;
37580b57cec5SDimitry Andric 
37590b57cec5SDimitry Andric   auto WriteVFuncIdVec = [&](uint64_t Ty,
37600b57cec5SDimitry Andric                              ArrayRef<FunctionSummary::VFuncId> VFs) {
37610b57cec5SDimitry Andric     if (VFs.empty())
37620b57cec5SDimitry Andric       return;
37630b57cec5SDimitry Andric     Record.clear();
37640b57cec5SDimitry Andric     for (auto &VF : VFs) {
37650b57cec5SDimitry Andric       Record.push_back(VF.GUID);
37660b57cec5SDimitry Andric       Record.push_back(VF.Offset);
37670b57cec5SDimitry Andric     }
37680b57cec5SDimitry Andric     Stream.EmitRecord(Ty, Record);
37690b57cec5SDimitry Andric   };
37700b57cec5SDimitry Andric 
37710b57cec5SDimitry Andric   WriteVFuncIdVec(bitc::FS_TYPE_TEST_ASSUME_VCALLS,
37720b57cec5SDimitry Andric                   FS->type_test_assume_vcalls());
37730b57cec5SDimitry Andric   WriteVFuncIdVec(bitc::FS_TYPE_CHECKED_LOAD_VCALLS,
37740b57cec5SDimitry Andric                   FS->type_checked_load_vcalls());
37750b57cec5SDimitry Andric 
37760b57cec5SDimitry Andric   auto WriteConstVCallVec = [&](uint64_t Ty,
37770b57cec5SDimitry Andric                                 ArrayRef<FunctionSummary::ConstVCall> VCs) {
37780b57cec5SDimitry Andric     for (auto &VC : VCs) {
37790b57cec5SDimitry Andric       Record.clear();
37800b57cec5SDimitry Andric       Record.push_back(VC.VFunc.GUID);
37810b57cec5SDimitry Andric       Record.push_back(VC.VFunc.Offset);
3782e8d8bef9SDimitry Andric       llvm::append_range(Record, VC.Args);
37830b57cec5SDimitry Andric       Stream.EmitRecord(Ty, Record);
37840b57cec5SDimitry Andric     }
37850b57cec5SDimitry Andric   };
37860b57cec5SDimitry Andric 
37870b57cec5SDimitry Andric   WriteConstVCallVec(bitc::FS_TYPE_TEST_ASSUME_CONST_VCALL,
37880b57cec5SDimitry Andric                      FS->type_test_assume_const_vcalls());
37890b57cec5SDimitry Andric   WriteConstVCallVec(bitc::FS_TYPE_CHECKED_LOAD_CONST_VCALL,
37900b57cec5SDimitry Andric                      FS->type_checked_load_const_vcalls());
37915ffd83dbSDimitry Andric 
37925ffd83dbSDimitry Andric   auto WriteRange = [&](ConstantRange Range) {
37935ffd83dbSDimitry Andric     Range = Range.sextOrTrunc(FunctionSummary::ParamAccess::RangeWidth);
37945ffd83dbSDimitry Andric     assert(Range.getLower().getNumWords() == 1);
37955ffd83dbSDimitry Andric     assert(Range.getUpper().getNumWords() == 1);
37965ffd83dbSDimitry Andric     emitSignedInt64(Record, *Range.getLower().getRawData());
37975ffd83dbSDimitry Andric     emitSignedInt64(Record, *Range.getUpper().getRawData());
37985ffd83dbSDimitry Andric   };
37995ffd83dbSDimitry Andric 
38005ffd83dbSDimitry Andric   if (!FS->paramAccesses().empty()) {
38015ffd83dbSDimitry Andric     Record.clear();
38025ffd83dbSDimitry Andric     for (auto &Arg : FS->paramAccesses()) {
3803e8d8bef9SDimitry Andric       size_t UndoSize = Record.size();
38045ffd83dbSDimitry Andric       Record.push_back(Arg.ParamNo);
38055ffd83dbSDimitry Andric       WriteRange(Arg.Use);
38065ffd83dbSDimitry Andric       Record.push_back(Arg.Calls.size());
38075ffd83dbSDimitry Andric       for (auto &Call : Arg.Calls) {
38085ffd83dbSDimitry Andric         Record.push_back(Call.ParamNo);
3809bdd1243dSDimitry Andric         std::optional<unsigned> ValueID = GetValueID(Call.Callee);
3810e8d8bef9SDimitry Andric         if (!ValueID) {
3811e8d8bef9SDimitry Andric           // If ValueID is unknown we can't drop just this call, we must drop
3812e8d8bef9SDimitry Andric           // entire parameter.
3813e8d8bef9SDimitry Andric           Record.resize(UndoSize);
3814e8d8bef9SDimitry Andric           break;
3815e8d8bef9SDimitry Andric         }
3816e8d8bef9SDimitry Andric         Record.push_back(*ValueID);
38175ffd83dbSDimitry Andric         WriteRange(Call.Offsets);
38185ffd83dbSDimitry Andric       }
38195ffd83dbSDimitry Andric     }
3820e8d8bef9SDimitry Andric     if (!Record.empty())
38215ffd83dbSDimitry Andric       Stream.EmitRecord(bitc::FS_PARAM_ACCESS, Record);
38225ffd83dbSDimitry Andric   }
38230b57cec5SDimitry Andric }
38240b57cec5SDimitry Andric 
38250b57cec5SDimitry Andric /// Collect type IDs from type tests used by function.
38260b57cec5SDimitry Andric static void
38270b57cec5SDimitry Andric getReferencedTypeIds(FunctionSummary *FS,
38280b57cec5SDimitry Andric                      std::set<GlobalValue::GUID> &ReferencedTypeIds) {
38290b57cec5SDimitry Andric   if (!FS->type_tests().empty())
38300b57cec5SDimitry Andric     for (auto &TT : FS->type_tests())
38310b57cec5SDimitry Andric       ReferencedTypeIds.insert(TT);
38320b57cec5SDimitry Andric 
38330b57cec5SDimitry Andric   auto GetReferencedTypesFromVFuncIdVec =
38340b57cec5SDimitry Andric       [&](ArrayRef<FunctionSummary::VFuncId> VFs) {
38350b57cec5SDimitry Andric         for (auto &VF : VFs)
38360b57cec5SDimitry Andric           ReferencedTypeIds.insert(VF.GUID);
38370b57cec5SDimitry Andric       };
38380b57cec5SDimitry Andric 
38390b57cec5SDimitry Andric   GetReferencedTypesFromVFuncIdVec(FS->type_test_assume_vcalls());
38400b57cec5SDimitry Andric   GetReferencedTypesFromVFuncIdVec(FS->type_checked_load_vcalls());
38410b57cec5SDimitry Andric 
38420b57cec5SDimitry Andric   auto GetReferencedTypesFromConstVCallVec =
38430b57cec5SDimitry Andric       [&](ArrayRef<FunctionSummary::ConstVCall> VCs) {
38440b57cec5SDimitry Andric         for (auto &VC : VCs)
38450b57cec5SDimitry Andric           ReferencedTypeIds.insert(VC.VFunc.GUID);
38460b57cec5SDimitry Andric       };
38470b57cec5SDimitry Andric 
38480b57cec5SDimitry Andric   GetReferencedTypesFromConstVCallVec(FS->type_test_assume_const_vcalls());
38490b57cec5SDimitry Andric   GetReferencedTypesFromConstVCallVec(FS->type_checked_load_const_vcalls());
38500b57cec5SDimitry Andric }
38510b57cec5SDimitry Andric 
38520b57cec5SDimitry Andric static void writeWholeProgramDevirtResolutionByArg(
38530b57cec5SDimitry Andric     SmallVector<uint64_t, 64> &NameVals, const std::vector<uint64_t> &args,
38540b57cec5SDimitry Andric     const WholeProgramDevirtResolution::ByArg &ByArg) {
38550b57cec5SDimitry Andric   NameVals.push_back(args.size());
3856e8d8bef9SDimitry Andric   llvm::append_range(NameVals, args);
38570b57cec5SDimitry Andric 
38580b57cec5SDimitry Andric   NameVals.push_back(ByArg.TheKind);
38590b57cec5SDimitry Andric   NameVals.push_back(ByArg.Info);
38600b57cec5SDimitry Andric   NameVals.push_back(ByArg.Byte);
38610b57cec5SDimitry Andric   NameVals.push_back(ByArg.Bit);
38620b57cec5SDimitry Andric }
38630b57cec5SDimitry Andric 
38640b57cec5SDimitry Andric static void writeWholeProgramDevirtResolution(
38650b57cec5SDimitry Andric     SmallVector<uint64_t, 64> &NameVals, StringTableBuilder &StrtabBuilder,
38660b57cec5SDimitry Andric     uint64_t Id, const WholeProgramDevirtResolution &Wpd) {
38670b57cec5SDimitry Andric   NameVals.push_back(Id);
38680b57cec5SDimitry Andric 
38690b57cec5SDimitry Andric   NameVals.push_back(Wpd.TheKind);
38700b57cec5SDimitry Andric   NameVals.push_back(StrtabBuilder.add(Wpd.SingleImplName));
38710b57cec5SDimitry Andric   NameVals.push_back(Wpd.SingleImplName.size());
38720b57cec5SDimitry Andric 
38730b57cec5SDimitry Andric   NameVals.push_back(Wpd.ResByArg.size());
38740b57cec5SDimitry Andric   for (auto &A : Wpd.ResByArg)
38750b57cec5SDimitry Andric     writeWholeProgramDevirtResolutionByArg(NameVals, A.first, A.second);
38760b57cec5SDimitry Andric }
38770b57cec5SDimitry Andric 
38780b57cec5SDimitry Andric static void writeTypeIdSummaryRecord(SmallVector<uint64_t, 64> &NameVals,
38790b57cec5SDimitry Andric                                      StringTableBuilder &StrtabBuilder,
38800b57cec5SDimitry Andric                                      const std::string &Id,
38810b57cec5SDimitry Andric                                      const TypeIdSummary &Summary) {
38820b57cec5SDimitry Andric   NameVals.push_back(StrtabBuilder.add(Id));
38830b57cec5SDimitry Andric   NameVals.push_back(Id.size());
38840b57cec5SDimitry Andric 
38850b57cec5SDimitry Andric   NameVals.push_back(Summary.TTRes.TheKind);
38860b57cec5SDimitry Andric   NameVals.push_back(Summary.TTRes.SizeM1BitWidth);
38870b57cec5SDimitry Andric   NameVals.push_back(Summary.TTRes.AlignLog2);
38880b57cec5SDimitry Andric   NameVals.push_back(Summary.TTRes.SizeM1);
38890b57cec5SDimitry Andric   NameVals.push_back(Summary.TTRes.BitMask);
38900b57cec5SDimitry Andric   NameVals.push_back(Summary.TTRes.InlineBits);
38910b57cec5SDimitry Andric 
38920b57cec5SDimitry Andric   for (auto &W : Summary.WPDRes)
38930b57cec5SDimitry Andric     writeWholeProgramDevirtResolution(NameVals, StrtabBuilder, W.first,
38940b57cec5SDimitry Andric                                       W.second);
38950b57cec5SDimitry Andric }
38960b57cec5SDimitry Andric 
38970b57cec5SDimitry Andric static void writeTypeIdCompatibleVtableSummaryRecord(
38980b57cec5SDimitry Andric     SmallVector<uint64_t, 64> &NameVals, StringTableBuilder &StrtabBuilder,
38990b57cec5SDimitry Andric     const std::string &Id, const TypeIdCompatibleVtableInfo &Summary,
39000b57cec5SDimitry Andric     ValueEnumerator &VE) {
39010b57cec5SDimitry Andric   NameVals.push_back(StrtabBuilder.add(Id));
39020b57cec5SDimitry Andric   NameVals.push_back(Id.size());
39030b57cec5SDimitry Andric 
39040b57cec5SDimitry Andric   for (auto &P : Summary) {
39050b57cec5SDimitry Andric     NameVals.push_back(P.AddressPointOffset);
39060b57cec5SDimitry Andric     NameVals.push_back(VE.getValueID(P.VTableVI.getValue()));
39070b57cec5SDimitry Andric   }
39080b57cec5SDimitry Andric }
39090b57cec5SDimitry Andric 
3910bdd1243dSDimitry Andric static void writeFunctionHeapProfileRecords(
3911bdd1243dSDimitry Andric     BitstreamWriter &Stream, FunctionSummary *FS, unsigned CallsiteAbbrev,
3912bdd1243dSDimitry Andric     unsigned AllocAbbrev, bool PerModule,
3913bdd1243dSDimitry Andric     std::function<unsigned(const ValueInfo &VI)> GetValueID,
3914bdd1243dSDimitry Andric     std::function<unsigned(unsigned)> GetStackIndex) {
3915bdd1243dSDimitry Andric   SmallVector<uint64_t> Record;
3916bdd1243dSDimitry Andric 
3917bdd1243dSDimitry Andric   for (auto &CI : FS->callsites()) {
3918bdd1243dSDimitry Andric     Record.clear();
3919bdd1243dSDimitry Andric     // Per module callsite clones should always have a single entry of
3920bdd1243dSDimitry Andric     // value 0.
3921bdd1243dSDimitry Andric     assert(!PerModule || (CI.Clones.size() == 1 && CI.Clones[0] == 0));
3922bdd1243dSDimitry Andric     Record.push_back(GetValueID(CI.Callee));
3923bdd1243dSDimitry Andric     if (!PerModule) {
3924bdd1243dSDimitry Andric       Record.push_back(CI.StackIdIndices.size());
3925bdd1243dSDimitry Andric       Record.push_back(CI.Clones.size());
3926bdd1243dSDimitry Andric     }
3927bdd1243dSDimitry Andric     for (auto Id : CI.StackIdIndices)
3928bdd1243dSDimitry Andric       Record.push_back(GetStackIndex(Id));
3929bdd1243dSDimitry Andric     if (!PerModule) {
3930bdd1243dSDimitry Andric       for (auto V : CI.Clones)
3931bdd1243dSDimitry Andric         Record.push_back(V);
3932bdd1243dSDimitry Andric     }
3933bdd1243dSDimitry Andric     Stream.EmitRecord(PerModule ? bitc::FS_PERMODULE_CALLSITE_INFO
3934bdd1243dSDimitry Andric                                 : bitc::FS_COMBINED_CALLSITE_INFO,
3935bdd1243dSDimitry Andric                       Record, CallsiteAbbrev);
3936bdd1243dSDimitry Andric   }
3937bdd1243dSDimitry Andric 
3938bdd1243dSDimitry Andric   for (auto &AI : FS->allocs()) {
3939bdd1243dSDimitry Andric     Record.clear();
3940bdd1243dSDimitry Andric     // Per module alloc versions should always have a single entry of
3941bdd1243dSDimitry Andric     // value 0.
3942bdd1243dSDimitry Andric     assert(!PerModule || (AI.Versions.size() == 1 && AI.Versions[0] == 0));
3943bdd1243dSDimitry Andric     if (!PerModule) {
3944bdd1243dSDimitry Andric       Record.push_back(AI.MIBs.size());
3945bdd1243dSDimitry Andric       Record.push_back(AI.Versions.size());
3946bdd1243dSDimitry Andric     }
3947bdd1243dSDimitry Andric     for (auto &MIB : AI.MIBs) {
3948bdd1243dSDimitry Andric       Record.push_back((uint8_t)MIB.AllocType);
3949bdd1243dSDimitry Andric       Record.push_back(MIB.StackIdIndices.size());
3950bdd1243dSDimitry Andric       for (auto Id : MIB.StackIdIndices)
3951bdd1243dSDimitry Andric         Record.push_back(GetStackIndex(Id));
3952bdd1243dSDimitry Andric     }
3953bdd1243dSDimitry Andric     if (!PerModule) {
3954bdd1243dSDimitry Andric       for (auto V : AI.Versions)
3955bdd1243dSDimitry Andric         Record.push_back(V);
3956bdd1243dSDimitry Andric     }
3957bdd1243dSDimitry Andric     Stream.EmitRecord(PerModule ? bitc::FS_PERMODULE_ALLOC_INFO
3958bdd1243dSDimitry Andric                                 : bitc::FS_COMBINED_ALLOC_INFO,
3959bdd1243dSDimitry Andric                       Record, AllocAbbrev);
3960bdd1243dSDimitry Andric   }
3961bdd1243dSDimitry Andric }
3962bdd1243dSDimitry Andric 
39630b57cec5SDimitry Andric // Helper to emit a single function summary record.
39640b57cec5SDimitry Andric void ModuleBitcodeWriterBase::writePerModuleFunctionSummaryRecord(
39650b57cec5SDimitry Andric     SmallVector<uint64_t, 64> &NameVals, GlobalValueSummary *Summary,
39660b57cec5SDimitry Andric     unsigned ValueID, unsigned FSCallsAbbrev, unsigned FSCallsProfileAbbrev,
3967bdd1243dSDimitry Andric     unsigned CallsiteAbbrev, unsigned AllocAbbrev, const Function &F) {
39680b57cec5SDimitry Andric   NameVals.push_back(ValueID);
39690b57cec5SDimitry Andric 
39700b57cec5SDimitry Andric   FunctionSummary *FS = cast<FunctionSummary>(Summary);
3971e8d8bef9SDimitry Andric 
3972e8d8bef9SDimitry Andric   writeFunctionTypeMetadataRecords(
3973bdd1243dSDimitry Andric       Stream, FS, [&](const ValueInfo &VI) -> std::optional<unsigned> {
3974e8d8bef9SDimitry Andric         return {VE.getValueID(VI.getValue())};
3975e8d8bef9SDimitry Andric       });
39760b57cec5SDimitry Andric 
3977bdd1243dSDimitry Andric   writeFunctionHeapProfileRecords(
3978bdd1243dSDimitry Andric       Stream, FS, CallsiteAbbrev, AllocAbbrev,
3979bdd1243dSDimitry Andric       /*PerModule*/ true,
3980bdd1243dSDimitry Andric       /*GetValueId*/ [&](const ValueInfo &VI) { return getValueId(VI); },
3981bdd1243dSDimitry Andric       /*GetStackIndex*/ [&](unsigned I) { return I; });
3982bdd1243dSDimitry Andric 
39830b57cec5SDimitry Andric   auto SpecialRefCnts = FS->specialRefCounts();
39840b57cec5SDimitry Andric   NameVals.push_back(getEncodedGVSummaryFlags(FS->flags()));
39850b57cec5SDimitry Andric   NameVals.push_back(FS->instCount());
39860b57cec5SDimitry Andric   NameVals.push_back(getEncodedFFlags(FS->fflags()));
39870b57cec5SDimitry Andric   NameVals.push_back(FS->refs().size());
39880b57cec5SDimitry Andric   NameVals.push_back(SpecialRefCnts.first);  // rorefcnt
39890b57cec5SDimitry Andric   NameVals.push_back(SpecialRefCnts.second); // worefcnt
39900b57cec5SDimitry Andric 
39910b57cec5SDimitry Andric   for (auto &RI : FS->refs())
39920b57cec5SDimitry Andric     NameVals.push_back(VE.getValueID(RI.getValue()));
39930b57cec5SDimitry Andric 
39940b57cec5SDimitry Andric   bool HasProfileData =
39950b57cec5SDimitry Andric       F.hasProfileData() || ForceSummaryEdgesCold != FunctionSummary::FSHT_None;
39960b57cec5SDimitry Andric   for (auto &ECI : FS->calls()) {
39970b57cec5SDimitry Andric     NameVals.push_back(getValueId(ECI.first));
39980b57cec5SDimitry Andric     if (HasProfileData)
39990b57cec5SDimitry Andric       NameVals.push_back(static_cast<uint8_t>(ECI.second.Hotness));
40000b57cec5SDimitry Andric     else if (WriteRelBFToSummary)
40010b57cec5SDimitry Andric       NameVals.push_back(ECI.second.RelBlockFreq);
40020b57cec5SDimitry Andric   }
40030b57cec5SDimitry Andric 
40040b57cec5SDimitry Andric   unsigned FSAbbrev = (HasProfileData ? FSCallsProfileAbbrev : FSCallsAbbrev);
40050b57cec5SDimitry Andric   unsigned Code =
40060b57cec5SDimitry Andric       (HasProfileData ? bitc::FS_PERMODULE_PROFILE
40070b57cec5SDimitry Andric                       : (WriteRelBFToSummary ? bitc::FS_PERMODULE_RELBF
40080b57cec5SDimitry Andric                                              : bitc::FS_PERMODULE));
40090b57cec5SDimitry Andric 
40100b57cec5SDimitry Andric   // Emit the finished record.
40110b57cec5SDimitry Andric   Stream.EmitRecord(Code, NameVals, FSAbbrev);
40120b57cec5SDimitry Andric   NameVals.clear();
40130b57cec5SDimitry Andric }
40140b57cec5SDimitry Andric 
40150b57cec5SDimitry Andric // Collect the global value references in the given variable's initializer,
40160b57cec5SDimitry Andric // and emit them in a summary record.
40170b57cec5SDimitry Andric void ModuleBitcodeWriterBase::writeModuleLevelReferences(
40180b57cec5SDimitry Andric     const GlobalVariable &V, SmallVector<uint64_t, 64> &NameVals,
40190b57cec5SDimitry Andric     unsigned FSModRefsAbbrev, unsigned FSModVTableRefsAbbrev) {
40200b57cec5SDimitry Andric   auto VI = Index->getValueInfo(V.getGUID());
40210b57cec5SDimitry Andric   if (!VI || VI.getSummaryList().empty()) {
40220b57cec5SDimitry Andric     // Only declarations should not have a summary (a declaration might however
40230b57cec5SDimitry Andric     // have a summary if the def was in module level asm).
40240b57cec5SDimitry Andric     assert(V.isDeclaration());
40250b57cec5SDimitry Andric     return;
40260b57cec5SDimitry Andric   }
40270b57cec5SDimitry Andric   auto *Summary = VI.getSummaryList()[0].get();
40280b57cec5SDimitry Andric   NameVals.push_back(VE.getValueID(&V));
40290b57cec5SDimitry Andric   GlobalVarSummary *VS = cast<GlobalVarSummary>(Summary);
40300b57cec5SDimitry Andric   NameVals.push_back(getEncodedGVSummaryFlags(VS->flags()));
40310b57cec5SDimitry Andric   NameVals.push_back(getEncodedGVarFlags(VS->varflags()));
40320b57cec5SDimitry Andric 
40330b57cec5SDimitry Andric   auto VTableFuncs = VS->vTableFuncs();
40340b57cec5SDimitry Andric   if (!VTableFuncs.empty())
40350b57cec5SDimitry Andric     NameVals.push_back(VS->refs().size());
40360b57cec5SDimitry Andric 
40370b57cec5SDimitry Andric   unsigned SizeBeforeRefs = NameVals.size();
40380b57cec5SDimitry Andric   for (auto &RI : VS->refs())
40390b57cec5SDimitry Andric     NameVals.push_back(VE.getValueID(RI.getValue()));
40400b57cec5SDimitry Andric   // Sort the refs for determinism output, the vector returned by FS->refs() has
40410b57cec5SDimitry Andric   // been initialized from a DenseSet.
4042e8d8bef9SDimitry Andric   llvm::sort(drop_begin(NameVals, SizeBeforeRefs));
40430b57cec5SDimitry Andric 
40440b57cec5SDimitry Andric   if (VTableFuncs.empty())
40450b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS, NameVals,
40460b57cec5SDimitry Andric                       FSModRefsAbbrev);
40470b57cec5SDimitry Andric   else {
40480b57cec5SDimitry Andric     // VTableFuncs pairs should already be sorted by offset.
40490b57cec5SDimitry Andric     for (auto &P : VTableFuncs) {
40500b57cec5SDimitry Andric       NameVals.push_back(VE.getValueID(P.FuncVI.getValue()));
40510b57cec5SDimitry Andric       NameVals.push_back(P.VTableOffset);
40520b57cec5SDimitry Andric     }
40530b57cec5SDimitry Andric 
40540b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS, NameVals,
40550b57cec5SDimitry Andric                       FSModVTableRefsAbbrev);
40560b57cec5SDimitry Andric   }
40570b57cec5SDimitry Andric   NameVals.clear();
40580b57cec5SDimitry Andric }
40590b57cec5SDimitry Andric 
40600b57cec5SDimitry Andric /// Emit the per-module summary section alongside the rest of
40610b57cec5SDimitry Andric /// the module's bitcode.
40620b57cec5SDimitry Andric void ModuleBitcodeWriterBase::writePerModuleGlobalValueSummary() {
40630b57cec5SDimitry Andric   // By default we compile with ThinLTO if the module has a summary, but the
40640b57cec5SDimitry Andric   // client can request full LTO with a module flag.
40650b57cec5SDimitry Andric   bool IsThinLTO = true;
40660b57cec5SDimitry Andric   if (auto *MD =
40670b57cec5SDimitry Andric           mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("ThinLTO")))
40680b57cec5SDimitry Andric     IsThinLTO = MD->getZExtValue();
40690b57cec5SDimitry Andric   Stream.EnterSubblock(IsThinLTO ? bitc::GLOBALVAL_SUMMARY_BLOCK_ID
40700b57cec5SDimitry Andric                                  : bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID,
40710b57cec5SDimitry Andric                        4);
40720b57cec5SDimitry Andric 
4073480093f4SDimitry Andric   Stream.EmitRecord(
4074480093f4SDimitry Andric       bitc::FS_VERSION,
4075480093f4SDimitry Andric       ArrayRef<uint64_t>{ModuleSummaryIndex::BitcodeSummaryVersion});
40760b57cec5SDimitry Andric 
40770b57cec5SDimitry Andric   // Write the index flags.
40780b57cec5SDimitry Andric   uint64_t Flags = 0;
40790b57cec5SDimitry Andric   // Bits 1-3 are set only in the combined index, skip them.
40800b57cec5SDimitry Andric   if (Index->enableSplitLTOUnit())
40810b57cec5SDimitry Andric     Flags |= 0x8;
4082*fe013be4SDimitry Andric   if (Index->hasUnifiedLTO())
4083*fe013be4SDimitry Andric     Flags |= 0x200;
4084*fe013be4SDimitry Andric 
40850b57cec5SDimitry Andric   Stream.EmitRecord(bitc::FS_FLAGS, ArrayRef<uint64_t>{Flags});
40860b57cec5SDimitry Andric 
40870b57cec5SDimitry Andric   if (Index->begin() == Index->end()) {
40880b57cec5SDimitry Andric     Stream.ExitBlock();
40890b57cec5SDimitry Andric     return;
40900b57cec5SDimitry Andric   }
40910b57cec5SDimitry Andric 
40920b57cec5SDimitry Andric   for (const auto &GVI : valueIds()) {
40930b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_VALUE_GUID,
40940b57cec5SDimitry Andric                       ArrayRef<uint64_t>{GVI.second, GVI.first});
40950b57cec5SDimitry Andric   }
40960b57cec5SDimitry Andric 
4097bdd1243dSDimitry Andric   if (!Index->stackIds().empty()) {
4098bdd1243dSDimitry Andric     auto StackIdAbbv = std::make_shared<BitCodeAbbrev>();
4099bdd1243dSDimitry Andric     StackIdAbbv->Add(BitCodeAbbrevOp(bitc::FS_STACK_IDS));
4100bdd1243dSDimitry Andric     // numids x stackid
4101bdd1243dSDimitry Andric     StackIdAbbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
4102bdd1243dSDimitry Andric     StackIdAbbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
4103bdd1243dSDimitry Andric     unsigned StackIdAbbvId = Stream.EmitAbbrev(std::move(StackIdAbbv));
4104bdd1243dSDimitry Andric     Stream.EmitRecord(bitc::FS_STACK_IDS, Index->stackIds(), StackIdAbbvId);
4105bdd1243dSDimitry Andric   }
4106bdd1243dSDimitry Andric 
41070b57cec5SDimitry Andric   // Abbrev for FS_PERMODULE_PROFILE.
41080b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
41090b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_PROFILE));
41100b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
4111*fe013be4SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // flags
41120b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // instcount
41130b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // fflags
41140b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // numrefs
41150b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // rorefcnt
41160b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // worefcnt
41170b57cec5SDimitry Andric   // numrefs x valueid, n x (valueid, hotness)
41180b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
41190b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
41200b57cec5SDimitry Andric   unsigned FSCallsProfileAbbrev = Stream.EmitAbbrev(std::move(Abbv));
41210b57cec5SDimitry Andric 
41220b57cec5SDimitry Andric   // Abbrev for FS_PERMODULE or FS_PERMODULE_RELBF.
41230b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
41240b57cec5SDimitry Andric   if (WriteRelBFToSummary)
41250b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_RELBF));
41260b57cec5SDimitry Andric   else
41270b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE));
41280b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
41290b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // flags
41300b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // instcount
41310b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // fflags
41320b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // numrefs
41330b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // rorefcnt
41340b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // worefcnt
41350b57cec5SDimitry Andric   // numrefs x valueid, n x (valueid [, rel_block_freq])
41360b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
41370b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
41380b57cec5SDimitry Andric   unsigned FSCallsAbbrev = Stream.EmitAbbrev(std::move(Abbv));
41390b57cec5SDimitry Andric 
41400b57cec5SDimitry Andric   // Abbrev for FS_PERMODULE_GLOBALVAR_INIT_REFS.
41410b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
41420b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS));
41430b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
41440b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags
41450b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));  // valueids
41460b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
41470b57cec5SDimitry Andric   unsigned FSModRefsAbbrev = Stream.EmitAbbrev(std::move(Abbv));
41480b57cec5SDimitry Andric 
41490b57cec5SDimitry Andric   // Abbrev for FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS.
41500b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
41510b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS));
41520b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
41530b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags
41540b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs
41550b57cec5SDimitry Andric   // numrefs x valueid, n x (valueid , offset)
41560b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
41570b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
41580b57cec5SDimitry Andric   unsigned FSModVTableRefsAbbrev = Stream.EmitAbbrev(std::move(Abbv));
41590b57cec5SDimitry Andric 
41600b57cec5SDimitry Andric   // Abbrev for FS_ALIAS.
41610b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
41620b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_ALIAS));
41630b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
41640b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // flags
41650b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
41660b57cec5SDimitry Andric   unsigned FSAliasAbbrev = Stream.EmitAbbrev(std::move(Abbv));
41670b57cec5SDimitry Andric 
41680b57cec5SDimitry Andric   // Abbrev for FS_TYPE_ID_METADATA
41690b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
41700b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_TYPE_ID_METADATA));
41710b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // typeid strtab index
41720b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // typeid length
41730b57cec5SDimitry Andric   // n x (valueid , offset)
41740b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
41750b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
41760b57cec5SDimitry Andric   unsigned TypeIdCompatibleVtableAbbrev = Stream.EmitAbbrev(std::move(Abbv));
41770b57cec5SDimitry Andric 
4178bdd1243dSDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
4179bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_CALLSITE_INFO));
4180bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
4181bdd1243dSDimitry Andric   // n x stackidindex
4182bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
4183bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
4184bdd1243dSDimitry Andric   unsigned CallsiteAbbrev = Stream.EmitAbbrev(std::move(Abbv));
4185bdd1243dSDimitry Andric 
4186bdd1243dSDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
4187bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_ALLOC_INFO));
4188bdd1243dSDimitry Andric   // n x (alloc type, numstackids, numstackids x stackidindex)
4189bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
4190bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
4191bdd1243dSDimitry Andric   unsigned AllocAbbrev = Stream.EmitAbbrev(std::move(Abbv));
4192bdd1243dSDimitry Andric 
41930b57cec5SDimitry Andric   SmallVector<uint64_t, 64> NameVals;
41940b57cec5SDimitry Andric   // Iterate over the list of functions instead of the Index to
41950b57cec5SDimitry Andric   // ensure the ordering is stable.
41960b57cec5SDimitry Andric   for (const Function &F : M) {
41970b57cec5SDimitry Andric     // Summary emission does not support anonymous functions, they have to
41980b57cec5SDimitry Andric     // renamed using the anonymous function renaming pass.
41990b57cec5SDimitry Andric     if (!F.hasName())
42000b57cec5SDimitry Andric       report_fatal_error("Unexpected anonymous function when writing summary");
42010b57cec5SDimitry Andric 
42020b57cec5SDimitry Andric     ValueInfo VI = Index->getValueInfo(F.getGUID());
42030b57cec5SDimitry Andric     if (!VI || VI.getSummaryList().empty()) {
42040b57cec5SDimitry Andric       // Only declarations should not have a summary (a declaration might
42050b57cec5SDimitry Andric       // however have a summary if the def was in module level asm).
42060b57cec5SDimitry Andric       assert(F.isDeclaration());
42070b57cec5SDimitry Andric       continue;
42080b57cec5SDimitry Andric     }
42090b57cec5SDimitry Andric     auto *Summary = VI.getSummaryList()[0].get();
42100b57cec5SDimitry Andric     writePerModuleFunctionSummaryRecord(NameVals, Summary, VE.getValueID(&F),
4211bdd1243dSDimitry Andric                                         FSCallsAbbrev, FSCallsProfileAbbrev,
4212bdd1243dSDimitry Andric                                         CallsiteAbbrev, AllocAbbrev, F);
42130b57cec5SDimitry Andric   }
42140b57cec5SDimitry Andric 
42150b57cec5SDimitry Andric   // Capture references from GlobalVariable initializers, which are outside
42160b57cec5SDimitry Andric   // of a function scope.
42170b57cec5SDimitry Andric   for (const GlobalVariable &G : M.globals())
42180b57cec5SDimitry Andric     writeModuleLevelReferences(G, NameVals, FSModRefsAbbrev,
42190b57cec5SDimitry Andric                                FSModVTableRefsAbbrev);
42200b57cec5SDimitry Andric 
42210b57cec5SDimitry Andric   for (const GlobalAlias &A : M.aliases()) {
4222349cc55cSDimitry Andric     auto *Aliasee = A.getAliaseeObject();
4223fcaf7f86SDimitry Andric     // Skip ifunc and nameless functions which don't have an entry in the
4224fcaf7f86SDimitry Andric     // summary.
4225fcaf7f86SDimitry Andric     if (!Aliasee->hasName() || isa<GlobalIFunc>(Aliasee))
42260b57cec5SDimitry Andric       continue;
42270b57cec5SDimitry Andric     auto AliasId = VE.getValueID(&A);
42280b57cec5SDimitry Andric     auto AliaseeId = VE.getValueID(Aliasee);
42290b57cec5SDimitry Andric     NameVals.push_back(AliasId);
42300b57cec5SDimitry Andric     auto *Summary = Index->getGlobalValueSummary(A);
42310b57cec5SDimitry Andric     AliasSummary *AS = cast<AliasSummary>(Summary);
42320b57cec5SDimitry Andric     NameVals.push_back(getEncodedGVSummaryFlags(AS->flags()));
42330b57cec5SDimitry Andric     NameVals.push_back(AliaseeId);
42340b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_ALIAS, NameVals, FSAliasAbbrev);
42350b57cec5SDimitry Andric     NameVals.clear();
42360b57cec5SDimitry Andric   }
42370b57cec5SDimitry Andric 
42380b57cec5SDimitry Andric   for (auto &S : Index->typeIdCompatibleVtableMap()) {
42390b57cec5SDimitry Andric     writeTypeIdCompatibleVtableSummaryRecord(NameVals, StrtabBuilder, S.first,
42400b57cec5SDimitry Andric                                              S.second, VE);
42410b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_TYPE_ID_METADATA, NameVals,
42420b57cec5SDimitry Andric                       TypeIdCompatibleVtableAbbrev);
42430b57cec5SDimitry Andric     NameVals.clear();
42440b57cec5SDimitry Andric   }
42450b57cec5SDimitry Andric 
4246*fe013be4SDimitry Andric   if (Index->getBlockCount())
42475ffd83dbSDimitry Andric     Stream.EmitRecord(bitc::FS_BLOCK_COUNT,
42485ffd83dbSDimitry Andric                       ArrayRef<uint64_t>{Index->getBlockCount()});
42495ffd83dbSDimitry Andric 
42500b57cec5SDimitry Andric   Stream.ExitBlock();
42510b57cec5SDimitry Andric }
42520b57cec5SDimitry Andric 
42530b57cec5SDimitry Andric /// Emit the combined summary section into the combined index file.
42540b57cec5SDimitry Andric void IndexBitcodeWriter::writeCombinedGlobalValueSummary() {
4255bdd1243dSDimitry Andric   Stream.EnterSubblock(bitc::GLOBALVAL_SUMMARY_BLOCK_ID, 4);
4256480093f4SDimitry Andric   Stream.EmitRecord(
4257480093f4SDimitry Andric       bitc::FS_VERSION,
4258480093f4SDimitry Andric       ArrayRef<uint64_t>{ModuleSummaryIndex::BitcodeSummaryVersion});
42590b57cec5SDimitry Andric 
42600b57cec5SDimitry Andric   // Write the index flags.
42615ffd83dbSDimitry Andric   Stream.EmitRecord(bitc::FS_FLAGS, ArrayRef<uint64_t>{Index.getFlags()});
42620b57cec5SDimitry Andric 
42630b57cec5SDimitry Andric   for (const auto &GVI : valueIds()) {
42640b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_VALUE_GUID,
42650b57cec5SDimitry Andric                       ArrayRef<uint64_t>{GVI.second, GVI.first});
42660b57cec5SDimitry Andric   }
42670b57cec5SDimitry Andric 
4268bdd1243dSDimitry Andric   if (!StackIdIndices.empty()) {
4269bdd1243dSDimitry Andric     auto StackIdAbbv = std::make_shared<BitCodeAbbrev>();
4270bdd1243dSDimitry Andric     StackIdAbbv->Add(BitCodeAbbrevOp(bitc::FS_STACK_IDS));
4271bdd1243dSDimitry Andric     // numids x stackid
4272bdd1243dSDimitry Andric     StackIdAbbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
4273bdd1243dSDimitry Andric     StackIdAbbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
4274bdd1243dSDimitry Andric     unsigned StackIdAbbvId = Stream.EmitAbbrev(std::move(StackIdAbbv));
4275bdd1243dSDimitry Andric     // Write the stack ids used by this index, which will be a subset of those in
4276bdd1243dSDimitry Andric     // the full index in the case of distributed indexes.
4277bdd1243dSDimitry Andric     std::vector<uint64_t> StackIds;
4278bdd1243dSDimitry Andric     for (auto &I : StackIdIndices)
4279bdd1243dSDimitry Andric       StackIds.push_back(Index.getStackIdAtIndex(I));
4280bdd1243dSDimitry Andric     Stream.EmitRecord(bitc::FS_STACK_IDS, StackIds, StackIdAbbvId);
4281bdd1243dSDimitry Andric   }
4282bdd1243dSDimitry Andric 
42830b57cec5SDimitry Andric   // Abbrev for FS_COMBINED.
42840b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
42850b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED));
42860b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
42870b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // modid
42880b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // flags
42890b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // instcount
42900b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // fflags
42910b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // entrycount
42920b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // numrefs
42930b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // rorefcnt
42940b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // worefcnt
42950b57cec5SDimitry Andric   // numrefs x valueid, n x (valueid)
42960b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
42970b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
42980b57cec5SDimitry Andric   unsigned FSCallsAbbrev = Stream.EmitAbbrev(std::move(Abbv));
42990b57cec5SDimitry Andric 
43000b57cec5SDimitry Andric   // Abbrev for FS_COMBINED_PROFILE.
43010b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
43020b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_PROFILE));
43030b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
43040b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // modid
43050b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // flags
43060b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // instcount
43070b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // fflags
43080b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // entrycount
43090b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // numrefs
43100b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // rorefcnt
43110b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4));   // worefcnt
43120b57cec5SDimitry Andric   // numrefs x valueid, n x (valueid, hotness)
43130b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
43140b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
43150b57cec5SDimitry Andric   unsigned FSCallsProfileAbbrev = Stream.EmitAbbrev(std::move(Abbv));
43160b57cec5SDimitry Andric 
43170b57cec5SDimitry Andric   // Abbrev for FS_COMBINED_GLOBALVAR_INIT_REFS.
43180b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
43190b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_GLOBALVAR_INIT_REFS));
43200b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
43210b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // modid
43220b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // flags
43230b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));    // valueids
43240b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
43250b57cec5SDimitry Andric   unsigned FSModRefsAbbrev = Stream.EmitAbbrev(std::move(Abbv));
43260b57cec5SDimitry Andric 
43270b57cec5SDimitry Andric   // Abbrev for FS_COMBINED_ALIAS.
43280b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
43290b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_ALIAS));
43300b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
43310b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // modid
43320b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // flags
43330b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // valueid
43340b57cec5SDimitry Andric   unsigned FSAliasAbbrev = Stream.EmitAbbrev(std::move(Abbv));
43350b57cec5SDimitry Andric 
4336bdd1243dSDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
4337bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_CALLSITE_INFO));
4338bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
4339bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numstackindices
4340bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numver
4341bdd1243dSDimitry Andric   // numstackindices x stackidindex, numver x version
4342bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
4343bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
4344bdd1243dSDimitry Andric   unsigned CallsiteAbbrev = Stream.EmitAbbrev(std::move(Abbv));
4345bdd1243dSDimitry Andric 
4346bdd1243dSDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
4347bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_ALLOC_INFO));
4348bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // nummib
4349bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numver
4350bdd1243dSDimitry Andric   // nummib x (alloc type, numstackids, numstackids x stackidindex),
4351bdd1243dSDimitry Andric   // numver x version
4352bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
4353bdd1243dSDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
4354bdd1243dSDimitry Andric   unsigned AllocAbbrev = Stream.EmitAbbrev(std::move(Abbv));
4355bdd1243dSDimitry Andric 
43560b57cec5SDimitry Andric   // The aliases are emitted as a post-pass, and will point to the value
43570b57cec5SDimitry Andric   // id of the aliasee. Save them in a vector for post-processing.
43580b57cec5SDimitry Andric   SmallVector<AliasSummary *, 64> Aliases;
43590b57cec5SDimitry Andric 
43600b57cec5SDimitry Andric   // Save the value id for each summary for alias emission.
43610b57cec5SDimitry Andric   DenseMap<const GlobalValueSummary *, unsigned> SummaryToValueIdMap;
43620b57cec5SDimitry Andric 
43630b57cec5SDimitry Andric   SmallVector<uint64_t, 64> NameVals;
43640b57cec5SDimitry Andric 
43650b57cec5SDimitry Andric   // Set that will be populated during call to writeFunctionTypeMetadataRecords
43660b57cec5SDimitry Andric   // with the type ids referenced by this index file.
43670b57cec5SDimitry Andric   std::set<GlobalValue::GUID> ReferencedTypeIds;
43680b57cec5SDimitry Andric 
43690b57cec5SDimitry Andric   // For local linkage, we also emit the original name separately
43700b57cec5SDimitry Andric   // immediately after the record.
43710b57cec5SDimitry Andric   auto MaybeEmitOriginalName = [&](GlobalValueSummary &S) {
4372349cc55cSDimitry Andric     // We don't need to emit the original name if we are writing the index for
4373349cc55cSDimitry Andric     // distributed backends (in which case ModuleToSummariesForIndex is
4374349cc55cSDimitry Andric     // non-null). The original name is only needed during the thin link, since
4375349cc55cSDimitry Andric     // for SamplePGO the indirect call targets for local functions have
4376349cc55cSDimitry Andric     // have the original name annotated in profile.
4377349cc55cSDimitry Andric     // Continue to emit it when writing out the entire combined index, which is
4378349cc55cSDimitry Andric     // used in testing the thin link via llvm-lto.
4379349cc55cSDimitry Andric     if (ModuleToSummariesForIndex || !GlobalValue::isLocalLinkage(S.linkage()))
43800b57cec5SDimitry Andric       return;
43810b57cec5SDimitry Andric     NameVals.push_back(S.getOriginalName());
43820b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_COMBINED_ORIGINAL_NAME, NameVals);
43830b57cec5SDimitry Andric     NameVals.clear();
43840b57cec5SDimitry Andric   };
43850b57cec5SDimitry Andric 
43860b57cec5SDimitry Andric   std::set<GlobalValue::GUID> DefOrUseGUIDs;
43870b57cec5SDimitry Andric   forEachSummary([&](GVInfo I, bool IsAliasee) {
43880b57cec5SDimitry Andric     GlobalValueSummary *S = I.second;
43890b57cec5SDimitry Andric     assert(S);
43900b57cec5SDimitry Andric     DefOrUseGUIDs.insert(I.first);
43910b57cec5SDimitry Andric     for (const ValueInfo &VI : S->refs())
43920b57cec5SDimitry Andric       DefOrUseGUIDs.insert(VI.getGUID());
43930b57cec5SDimitry Andric 
43940b57cec5SDimitry Andric     auto ValueId = getValueId(I.first);
43950b57cec5SDimitry Andric     assert(ValueId);
43960b57cec5SDimitry Andric     SummaryToValueIdMap[S] = *ValueId;
43970b57cec5SDimitry Andric 
43980b57cec5SDimitry Andric     // If this is invoked for an aliasee, we want to record the above
43990b57cec5SDimitry Andric     // mapping, but then not emit a summary entry (if the aliasee is
44000b57cec5SDimitry Andric     // to be imported, we will invoke this separately with IsAliasee=false).
44010b57cec5SDimitry Andric     if (IsAliasee)
44020b57cec5SDimitry Andric       return;
44030b57cec5SDimitry Andric 
44040b57cec5SDimitry Andric     if (auto *AS = dyn_cast<AliasSummary>(S)) {
44050b57cec5SDimitry Andric       // Will process aliases as a post-pass because the reader wants all
44060b57cec5SDimitry Andric       // global to be loaded first.
44070b57cec5SDimitry Andric       Aliases.push_back(AS);
44080b57cec5SDimitry Andric       return;
44090b57cec5SDimitry Andric     }
44100b57cec5SDimitry Andric 
44110b57cec5SDimitry Andric     if (auto *VS = dyn_cast<GlobalVarSummary>(S)) {
44120b57cec5SDimitry Andric       NameVals.push_back(*ValueId);
44130b57cec5SDimitry Andric       NameVals.push_back(Index.getModuleId(VS->modulePath()));
44140b57cec5SDimitry Andric       NameVals.push_back(getEncodedGVSummaryFlags(VS->flags()));
44150b57cec5SDimitry Andric       NameVals.push_back(getEncodedGVarFlags(VS->varflags()));
44160b57cec5SDimitry Andric       for (auto &RI : VS->refs()) {
44170b57cec5SDimitry Andric         auto RefValueId = getValueId(RI.getGUID());
44180b57cec5SDimitry Andric         if (!RefValueId)
44190b57cec5SDimitry Andric           continue;
44200b57cec5SDimitry Andric         NameVals.push_back(*RefValueId);
44210b57cec5SDimitry Andric       }
44220b57cec5SDimitry Andric 
44230b57cec5SDimitry Andric       // Emit the finished record.
44240b57cec5SDimitry Andric       Stream.EmitRecord(bitc::FS_COMBINED_GLOBALVAR_INIT_REFS, NameVals,
44250b57cec5SDimitry Andric                         FSModRefsAbbrev);
44260b57cec5SDimitry Andric       NameVals.clear();
44270b57cec5SDimitry Andric       MaybeEmitOriginalName(*S);
44280b57cec5SDimitry Andric       return;
44290b57cec5SDimitry Andric     }
44300b57cec5SDimitry Andric 
4431bdd1243dSDimitry Andric     auto GetValueId = [&](const ValueInfo &VI) -> std::optional<unsigned> {
4432bdd1243dSDimitry Andric       if (!VI)
4433bdd1243dSDimitry Andric         return std::nullopt;
4434349cc55cSDimitry Andric       return getValueId(VI.getGUID());
4435e8d8bef9SDimitry Andric     };
4436e8d8bef9SDimitry Andric 
44370b57cec5SDimitry Andric     auto *FS = cast<FunctionSummary>(S);
4438e8d8bef9SDimitry Andric     writeFunctionTypeMetadataRecords(Stream, FS, GetValueId);
44390b57cec5SDimitry Andric     getReferencedTypeIds(FS, ReferencedTypeIds);
44400b57cec5SDimitry Andric 
4441bdd1243dSDimitry Andric     writeFunctionHeapProfileRecords(
4442bdd1243dSDimitry Andric         Stream, FS, CallsiteAbbrev, AllocAbbrev,
4443bdd1243dSDimitry Andric         /*PerModule*/ false,
4444bdd1243dSDimitry Andric         /*GetValueId*/ [&](const ValueInfo &VI) -> unsigned {
4445bdd1243dSDimitry Andric           std::optional<unsigned> ValueID = GetValueId(VI);
4446bdd1243dSDimitry Andric           // This can happen in shared index files for distributed ThinLTO if
4447bdd1243dSDimitry Andric           // the callee function summary is not included. Record 0 which we
4448bdd1243dSDimitry Andric           // will have to deal with conservatively when doing any kind of
4449bdd1243dSDimitry Andric           // validation in the ThinLTO backends.
4450bdd1243dSDimitry Andric           if (!ValueID)
4451bdd1243dSDimitry Andric             return 0;
4452bdd1243dSDimitry Andric           return *ValueID;
4453bdd1243dSDimitry Andric         },
4454bdd1243dSDimitry Andric         /*GetStackIndex*/ [&](unsigned I) {
4455bdd1243dSDimitry Andric           // Get the corresponding index into the list of StackIdIndices
4456bdd1243dSDimitry Andric           // actually being written for this combined index (which may be a
4457bdd1243dSDimitry Andric           // subset in the case of distributed indexes).
4458bdd1243dSDimitry Andric           auto Lower = llvm::lower_bound(StackIdIndices, I);
4459bdd1243dSDimitry Andric           return std::distance(StackIdIndices.begin(), Lower);
4460bdd1243dSDimitry Andric         });
4461bdd1243dSDimitry Andric 
44620b57cec5SDimitry Andric     NameVals.push_back(*ValueId);
44630b57cec5SDimitry Andric     NameVals.push_back(Index.getModuleId(FS->modulePath()));
44640b57cec5SDimitry Andric     NameVals.push_back(getEncodedGVSummaryFlags(FS->flags()));
44650b57cec5SDimitry Andric     NameVals.push_back(FS->instCount());
44660b57cec5SDimitry Andric     NameVals.push_back(getEncodedFFlags(FS->fflags()));
44670b57cec5SDimitry Andric     NameVals.push_back(FS->entryCount());
44680b57cec5SDimitry Andric 
44690b57cec5SDimitry Andric     // Fill in below
44700b57cec5SDimitry Andric     NameVals.push_back(0); // numrefs
44710b57cec5SDimitry Andric     NameVals.push_back(0); // rorefcnt
44720b57cec5SDimitry Andric     NameVals.push_back(0); // worefcnt
44730b57cec5SDimitry Andric 
44740b57cec5SDimitry Andric     unsigned Count = 0, RORefCnt = 0, WORefCnt = 0;
44750b57cec5SDimitry Andric     for (auto &RI : FS->refs()) {
44760b57cec5SDimitry Andric       auto RefValueId = getValueId(RI.getGUID());
44770b57cec5SDimitry Andric       if (!RefValueId)
44780b57cec5SDimitry Andric         continue;
44790b57cec5SDimitry Andric       NameVals.push_back(*RefValueId);
44800b57cec5SDimitry Andric       if (RI.isReadOnly())
44810b57cec5SDimitry Andric         RORefCnt++;
44820b57cec5SDimitry Andric       else if (RI.isWriteOnly())
44830b57cec5SDimitry Andric         WORefCnt++;
44840b57cec5SDimitry Andric       Count++;
44850b57cec5SDimitry Andric     }
44860b57cec5SDimitry Andric     NameVals[6] = Count;
44870b57cec5SDimitry Andric     NameVals[7] = RORefCnt;
44880b57cec5SDimitry Andric     NameVals[8] = WORefCnt;
44890b57cec5SDimitry Andric 
44900b57cec5SDimitry Andric     bool HasProfileData = false;
44910b57cec5SDimitry Andric     for (auto &EI : FS->calls()) {
44920b57cec5SDimitry Andric       HasProfileData |=
44930b57cec5SDimitry Andric           EI.second.getHotness() != CalleeInfo::HotnessType::Unknown;
44940b57cec5SDimitry Andric       if (HasProfileData)
44950b57cec5SDimitry Andric         break;
44960b57cec5SDimitry Andric     }
44970b57cec5SDimitry Andric 
44980b57cec5SDimitry Andric     for (auto &EI : FS->calls()) {
44990b57cec5SDimitry Andric       // If this GUID doesn't have a value id, it doesn't have a function
45000b57cec5SDimitry Andric       // summary and we don't need to record any calls to it.
4501bdd1243dSDimitry Andric       std::optional<unsigned> CallValueId = GetValueId(EI.first);
45020b57cec5SDimitry Andric       if (!CallValueId)
45030b57cec5SDimitry Andric         continue;
45040b57cec5SDimitry Andric       NameVals.push_back(*CallValueId);
45050b57cec5SDimitry Andric       if (HasProfileData)
45060b57cec5SDimitry Andric         NameVals.push_back(static_cast<uint8_t>(EI.second.Hotness));
45070b57cec5SDimitry Andric     }
45080b57cec5SDimitry Andric 
45090b57cec5SDimitry Andric     unsigned FSAbbrev = (HasProfileData ? FSCallsProfileAbbrev : FSCallsAbbrev);
45100b57cec5SDimitry Andric     unsigned Code =
45110b57cec5SDimitry Andric         (HasProfileData ? bitc::FS_COMBINED_PROFILE : bitc::FS_COMBINED);
45120b57cec5SDimitry Andric 
45130b57cec5SDimitry Andric     // Emit the finished record.
45140b57cec5SDimitry Andric     Stream.EmitRecord(Code, NameVals, FSAbbrev);
45150b57cec5SDimitry Andric     NameVals.clear();
45160b57cec5SDimitry Andric     MaybeEmitOriginalName(*S);
45170b57cec5SDimitry Andric   });
45180b57cec5SDimitry Andric 
45190b57cec5SDimitry Andric   for (auto *AS : Aliases) {
45200b57cec5SDimitry Andric     auto AliasValueId = SummaryToValueIdMap[AS];
45210b57cec5SDimitry Andric     assert(AliasValueId);
45220b57cec5SDimitry Andric     NameVals.push_back(AliasValueId);
45230b57cec5SDimitry Andric     NameVals.push_back(Index.getModuleId(AS->modulePath()));
45240b57cec5SDimitry Andric     NameVals.push_back(getEncodedGVSummaryFlags(AS->flags()));
45250b57cec5SDimitry Andric     auto AliaseeValueId = SummaryToValueIdMap[&AS->getAliasee()];
45260b57cec5SDimitry Andric     assert(AliaseeValueId);
45270b57cec5SDimitry Andric     NameVals.push_back(AliaseeValueId);
45280b57cec5SDimitry Andric 
45290b57cec5SDimitry Andric     // Emit the finished record.
45300b57cec5SDimitry Andric     Stream.EmitRecord(bitc::FS_COMBINED_ALIAS, NameVals, FSAliasAbbrev);
45310b57cec5SDimitry Andric     NameVals.clear();
45320b57cec5SDimitry Andric     MaybeEmitOriginalName(*AS);
45330b57cec5SDimitry Andric 
45340b57cec5SDimitry Andric     if (auto *FS = dyn_cast<FunctionSummary>(&AS->getAliasee()))
45350b57cec5SDimitry Andric       getReferencedTypeIds(FS, ReferencedTypeIds);
45360b57cec5SDimitry Andric   }
45370b57cec5SDimitry Andric 
45380b57cec5SDimitry Andric   if (!Index.cfiFunctionDefs().empty()) {
45390b57cec5SDimitry Andric     for (auto &S : Index.cfiFunctionDefs()) {
45400b57cec5SDimitry Andric       if (DefOrUseGUIDs.count(
45410b57cec5SDimitry Andric               GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(S)))) {
45420b57cec5SDimitry Andric         NameVals.push_back(StrtabBuilder.add(S));
45430b57cec5SDimitry Andric         NameVals.push_back(S.size());
45440b57cec5SDimitry Andric       }
45450b57cec5SDimitry Andric     }
45460b57cec5SDimitry Andric     if (!NameVals.empty()) {
45470b57cec5SDimitry Andric       Stream.EmitRecord(bitc::FS_CFI_FUNCTION_DEFS, NameVals);
45480b57cec5SDimitry Andric       NameVals.clear();
45490b57cec5SDimitry Andric     }
45500b57cec5SDimitry Andric   }
45510b57cec5SDimitry Andric 
45520b57cec5SDimitry Andric   if (!Index.cfiFunctionDecls().empty()) {
45530b57cec5SDimitry Andric     for (auto &S : Index.cfiFunctionDecls()) {
45540b57cec5SDimitry Andric       if (DefOrUseGUIDs.count(
45550b57cec5SDimitry Andric               GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(S)))) {
45560b57cec5SDimitry Andric         NameVals.push_back(StrtabBuilder.add(S));
45570b57cec5SDimitry Andric         NameVals.push_back(S.size());
45580b57cec5SDimitry Andric       }
45590b57cec5SDimitry Andric     }
45600b57cec5SDimitry Andric     if (!NameVals.empty()) {
45610b57cec5SDimitry Andric       Stream.EmitRecord(bitc::FS_CFI_FUNCTION_DECLS, NameVals);
45620b57cec5SDimitry Andric       NameVals.clear();
45630b57cec5SDimitry Andric     }
45640b57cec5SDimitry Andric   }
45650b57cec5SDimitry Andric 
45660b57cec5SDimitry Andric   // Walk the GUIDs that were referenced, and write the
45670b57cec5SDimitry Andric   // corresponding type id records.
45680b57cec5SDimitry Andric   for (auto &T : ReferencedTypeIds) {
45690b57cec5SDimitry Andric     auto TidIter = Index.typeIds().equal_range(T);
45700b57cec5SDimitry Andric     for (auto It = TidIter.first; It != TidIter.second; ++It) {
45710b57cec5SDimitry Andric       writeTypeIdSummaryRecord(NameVals, StrtabBuilder, It->second.first,
45720b57cec5SDimitry Andric                                It->second.second);
45730b57cec5SDimitry Andric       Stream.EmitRecord(bitc::FS_TYPE_ID, NameVals);
45740b57cec5SDimitry Andric       NameVals.clear();
45750b57cec5SDimitry Andric     }
45760b57cec5SDimitry Andric   }
45770b57cec5SDimitry Andric 
4578*fe013be4SDimitry Andric   if (Index.getBlockCount())
45795ffd83dbSDimitry Andric     Stream.EmitRecord(bitc::FS_BLOCK_COUNT,
45805ffd83dbSDimitry Andric                       ArrayRef<uint64_t>{Index.getBlockCount()});
45815ffd83dbSDimitry Andric 
45820b57cec5SDimitry Andric   Stream.ExitBlock();
45830b57cec5SDimitry Andric }
45840b57cec5SDimitry Andric 
45850b57cec5SDimitry Andric /// Create the "IDENTIFICATION_BLOCK_ID" containing a single string with the
45860b57cec5SDimitry Andric /// current llvm version, and a record for the epoch number.
45870b57cec5SDimitry Andric static void writeIdentificationBlock(BitstreamWriter &Stream) {
45880b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::IDENTIFICATION_BLOCK_ID, 5);
45890b57cec5SDimitry Andric 
45900b57cec5SDimitry Andric   // Write the "user readable" string identifying the bitcode producer
45910b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
45920b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::IDENTIFICATION_CODE_STRING));
45930b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
45940b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
45950b57cec5SDimitry Andric   auto StringAbbrev = Stream.EmitAbbrev(std::move(Abbv));
45960b57cec5SDimitry Andric   writeStringRecord(Stream, bitc::IDENTIFICATION_CODE_STRING,
45970b57cec5SDimitry Andric                     "LLVM" LLVM_VERSION_STRING, StringAbbrev);
45980b57cec5SDimitry Andric 
45990b57cec5SDimitry Andric   // Write the epoch version
46000b57cec5SDimitry Andric   Abbv = std::make_shared<BitCodeAbbrev>();
46010b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(bitc::IDENTIFICATION_CODE_EPOCH));
46020b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
46030b57cec5SDimitry Andric   auto EpochAbbrev = Stream.EmitAbbrev(std::move(Abbv));
46045ffd83dbSDimitry Andric   constexpr std::array<unsigned, 1> Vals = {{bitc::BITCODE_CURRENT_EPOCH}};
46050b57cec5SDimitry Andric   Stream.EmitRecord(bitc::IDENTIFICATION_CODE_EPOCH, Vals, EpochAbbrev);
46060b57cec5SDimitry Andric   Stream.ExitBlock();
46070b57cec5SDimitry Andric }
46080b57cec5SDimitry Andric 
46090b57cec5SDimitry Andric void ModuleBitcodeWriter::writeModuleHash(size_t BlockStartPos) {
46100b57cec5SDimitry Andric   // Emit the module's hash.
46110b57cec5SDimitry Andric   // MODULE_CODE_HASH: [5*i32]
46120b57cec5SDimitry Andric   if (GenerateHash) {
46130b57cec5SDimitry Andric     uint32_t Vals[5];
46140b57cec5SDimitry Andric     Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&(Buffer)[BlockStartPos],
46150b57cec5SDimitry Andric                                     Buffer.size() - BlockStartPos));
461681ad6265SDimitry Andric     std::array<uint8_t, 20> Hash = Hasher.result();
46170b57cec5SDimitry Andric     for (int Pos = 0; Pos < 20; Pos += 4) {
46180b57cec5SDimitry Andric       Vals[Pos / 4] = support::endian::read32be(Hash.data() + Pos);
46190b57cec5SDimitry Andric     }
46200b57cec5SDimitry Andric 
46210b57cec5SDimitry Andric     // Emit the finished record.
46220b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_HASH, Vals);
46230b57cec5SDimitry Andric 
46240b57cec5SDimitry Andric     if (ModHash)
46250b57cec5SDimitry Andric       // Save the written hash value.
46260b57cec5SDimitry Andric       llvm::copy(Vals, std::begin(*ModHash));
46270b57cec5SDimitry Andric   }
46280b57cec5SDimitry Andric }
46290b57cec5SDimitry Andric 
46300b57cec5SDimitry Andric void ModuleBitcodeWriter::write() {
46310b57cec5SDimitry Andric   writeIdentificationBlock(Stream);
46320b57cec5SDimitry Andric 
46330b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
46340b57cec5SDimitry Andric   size_t BlockStartPos = Buffer.size();
46350b57cec5SDimitry Andric 
46360b57cec5SDimitry Andric   writeModuleVersion();
46370b57cec5SDimitry Andric 
46380b57cec5SDimitry Andric   // Emit blockinfo, which defines the standard abbreviations etc.
46390b57cec5SDimitry Andric   writeBlockInfo();
46400b57cec5SDimitry Andric 
46410b57cec5SDimitry Andric   // Emit information describing all of the types in the module.
46420b57cec5SDimitry Andric   writeTypeTable();
46430b57cec5SDimitry Andric 
46440b57cec5SDimitry Andric   // Emit information about attribute groups.
46450b57cec5SDimitry Andric   writeAttributeGroupTable();
46460b57cec5SDimitry Andric 
46470b57cec5SDimitry Andric   // Emit information about parameter attributes.
46480b57cec5SDimitry Andric   writeAttributeTable();
46490b57cec5SDimitry Andric 
46500b57cec5SDimitry Andric   writeComdats();
46510b57cec5SDimitry Andric 
46520b57cec5SDimitry Andric   // Emit top-level description of module, including target triple, inline asm,
46530b57cec5SDimitry Andric   // descriptors for global variables, and function prototype info.
46540b57cec5SDimitry Andric   writeModuleInfo();
46550b57cec5SDimitry Andric 
46560b57cec5SDimitry Andric   // Emit constants.
46570b57cec5SDimitry Andric   writeModuleConstants();
46580b57cec5SDimitry Andric 
46590b57cec5SDimitry Andric   // Emit metadata kind names.
46600b57cec5SDimitry Andric   writeModuleMetadataKinds();
46610b57cec5SDimitry Andric 
46620b57cec5SDimitry Andric   // Emit metadata.
46630b57cec5SDimitry Andric   writeModuleMetadata();
46640b57cec5SDimitry Andric 
46650b57cec5SDimitry Andric   // Emit module-level use-lists.
46660b57cec5SDimitry Andric   if (VE.shouldPreserveUseListOrder())
46670b57cec5SDimitry Andric     writeUseListBlock(nullptr);
46680b57cec5SDimitry Andric 
46690b57cec5SDimitry Andric   writeOperandBundleTags();
46700b57cec5SDimitry Andric   writeSyncScopeNames();
46710b57cec5SDimitry Andric 
46720b57cec5SDimitry Andric   // Emit function bodies.
46730b57cec5SDimitry Andric   DenseMap<const Function *, uint64_t> FunctionToBitcodeIndex;
46744824e7fdSDimitry Andric   for (const Function &F : M)
46754824e7fdSDimitry Andric     if (!F.isDeclaration())
46764824e7fdSDimitry Andric       writeFunction(F, FunctionToBitcodeIndex);
46770b57cec5SDimitry Andric 
46780b57cec5SDimitry Andric   // Need to write after the above call to WriteFunction which populates
46790b57cec5SDimitry Andric   // the summary information in the index.
46800b57cec5SDimitry Andric   if (Index)
46810b57cec5SDimitry Andric     writePerModuleGlobalValueSummary();
46820b57cec5SDimitry Andric 
46830b57cec5SDimitry Andric   writeGlobalValueSymbolTable(FunctionToBitcodeIndex);
46840b57cec5SDimitry Andric 
46850b57cec5SDimitry Andric   writeModuleHash(BlockStartPos);
46860b57cec5SDimitry Andric 
46870b57cec5SDimitry Andric   Stream.ExitBlock();
46880b57cec5SDimitry Andric }
46890b57cec5SDimitry Andric 
46900b57cec5SDimitry Andric static void writeInt32ToBuffer(uint32_t Value, SmallVectorImpl<char> &Buffer,
46910b57cec5SDimitry Andric                                uint32_t &Position) {
46920b57cec5SDimitry Andric   support::endian::write32le(&Buffer[Position], Value);
46930b57cec5SDimitry Andric   Position += 4;
46940b57cec5SDimitry Andric }
46950b57cec5SDimitry Andric 
46960b57cec5SDimitry Andric /// If generating a bc file on darwin, we have to emit a
46970b57cec5SDimitry Andric /// header and trailer to make it compatible with the system archiver.  To do
46980b57cec5SDimitry Andric /// this we emit the following header, and then emit a trailer that pads the
46990b57cec5SDimitry Andric /// file out to be a multiple of 16 bytes.
47000b57cec5SDimitry Andric ///
47010b57cec5SDimitry Andric /// struct bc_header {
47020b57cec5SDimitry Andric ///   uint32_t Magic;         // 0x0B17C0DE
47030b57cec5SDimitry Andric ///   uint32_t Version;       // Version, currently always 0.
47040b57cec5SDimitry Andric ///   uint32_t BitcodeOffset; // Offset to traditional bitcode file.
47050b57cec5SDimitry Andric ///   uint32_t BitcodeSize;   // Size of traditional bitcode file.
47060b57cec5SDimitry Andric ///   uint32_t CPUType;       // CPU specifier.
47070b57cec5SDimitry Andric ///   ... potentially more later ...
47080b57cec5SDimitry Andric /// };
47090b57cec5SDimitry Andric static void emitDarwinBCHeaderAndTrailer(SmallVectorImpl<char> &Buffer,
47100b57cec5SDimitry Andric                                          const Triple &TT) {
47110b57cec5SDimitry Andric   unsigned CPUType = ~0U;
47120b57cec5SDimitry Andric 
47130b57cec5SDimitry Andric   // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*,
47140b57cec5SDimitry Andric   // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic
47150b57cec5SDimitry Andric   // number from /usr/include/mach/machine.h.  It is ok to reproduce the
47160b57cec5SDimitry Andric   // specific constants here because they are implicitly part of the Darwin ABI.
47170b57cec5SDimitry Andric   enum {
47180b57cec5SDimitry Andric     DARWIN_CPU_ARCH_ABI64      = 0x01000000,
47190b57cec5SDimitry Andric     DARWIN_CPU_TYPE_X86        = 7,
47200b57cec5SDimitry Andric     DARWIN_CPU_TYPE_ARM        = 12,
47210b57cec5SDimitry Andric     DARWIN_CPU_TYPE_POWERPC    = 18
47220b57cec5SDimitry Andric   };
47230b57cec5SDimitry Andric 
47240b57cec5SDimitry Andric   Triple::ArchType Arch = TT.getArch();
47250b57cec5SDimitry Andric   if (Arch == Triple::x86_64)
47260b57cec5SDimitry Andric     CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64;
47270b57cec5SDimitry Andric   else if (Arch == Triple::x86)
47280b57cec5SDimitry Andric     CPUType = DARWIN_CPU_TYPE_X86;
47290b57cec5SDimitry Andric   else if (Arch == Triple::ppc)
47300b57cec5SDimitry Andric     CPUType = DARWIN_CPU_TYPE_POWERPC;
47310b57cec5SDimitry Andric   else if (Arch == Triple::ppc64)
47320b57cec5SDimitry Andric     CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64;
47330b57cec5SDimitry Andric   else if (Arch == Triple::arm || Arch == Triple::thumb)
47340b57cec5SDimitry Andric     CPUType = DARWIN_CPU_TYPE_ARM;
47350b57cec5SDimitry Andric 
47360b57cec5SDimitry Andric   // Traditional Bitcode starts after header.
47370b57cec5SDimitry Andric   assert(Buffer.size() >= BWH_HeaderSize &&
47380b57cec5SDimitry Andric          "Expected header size to be reserved");
47390b57cec5SDimitry Andric   unsigned BCOffset = BWH_HeaderSize;
47400b57cec5SDimitry Andric   unsigned BCSize = Buffer.size() - BWH_HeaderSize;
47410b57cec5SDimitry Andric 
47420b57cec5SDimitry Andric   // Write the magic and version.
47430b57cec5SDimitry Andric   unsigned Position = 0;
47440b57cec5SDimitry Andric   writeInt32ToBuffer(0x0B17C0DE, Buffer, Position);
47450b57cec5SDimitry Andric   writeInt32ToBuffer(0, Buffer, Position); // Version.
47460b57cec5SDimitry Andric   writeInt32ToBuffer(BCOffset, Buffer, Position);
47470b57cec5SDimitry Andric   writeInt32ToBuffer(BCSize, Buffer, Position);
47480b57cec5SDimitry Andric   writeInt32ToBuffer(CPUType, Buffer, Position);
47490b57cec5SDimitry Andric 
47500b57cec5SDimitry Andric   // If the file is not a multiple of 16 bytes, insert dummy padding.
47510b57cec5SDimitry Andric   while (Buffer.size() & 15)
47520b57cec5SDimitry Andric     Buffer.push_back(0);
47530b57cec5SDimitry Andric }
47540b57cec5SDimitry Andric 
47550b57cec5SDimitry Andric /// Helper to write the header common to all bitcode files.
47560b57cec5SDimitry Andric static void writeBitcodeHeader(BitstreamWriter &Stream) {
47570b57cec5SDimitry Andric   // Emit the file header.
47580b57cec5SDimitry Andric   Stream.Emit((unsigned)'B', 8);
47590b57cec5SDimitry Andric   Stream.Emit((unsigned)'C', 8);
47600b57cec5SDimitry Andric   Stream.Emit(0x0, 4);
47610b57cec5SDimitry Andric   Stream.Emit(0xC, 4);
47620b57cec5SDimitry Andric   Stream.Emit(0xE, 4);
47630b57cec5SDimitry Andric   Stream.Emit(0xD, 4);
47640b57cec5SDimitry Andric }
47650b57cec5SDimitry Andric 
4766e8d8bef9SDimitry Andric BitcodeWriter::BitcodeWriter(SmallVectorImpl<char> &Buffer, raw_fd_stream *FS)
4767e8d8bef9SDimitry Andric     : Buffer(Buffer), Stream(new BitstreamWriter(Buffer, FS, FlushThreshold)) {
47680b57cec5SDimitry Andric   writeBitcodeHeader(*Stream);
47690b57cec5SDimitry Andric }
47700b57cec5SDimitry Andric 
47710b57cec5SDimitry Andric BitcodeWriter::~BitcodeWriter() { assert(WroteStrtab); }
47720b57cec5SDimitry Andric 
47730b57cec5SDimitry Andric void BitcodeWriter::writeBlob(unsigned Block, unsigned Record, StringRef Blob) {
47740b57cec5SDimitry Andric   Stream->EnterSubblock(Block, 3);
47750b57cec5SDimitry Andric 
47760b57cec5SDimitry Andric   auto Abbv = std::make_shared<BitCodeAbbrev>();
47770b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(Record));
47780b57cec5SDimitry Andric   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
47790b57cec5SDimitry Andric   auto AbbrevNo = Stream->EmitAbbrev(std::move(Abbv));
47800b57cec5SDimitry Andric 
47810b57cec5SDimitry Andric   Stream->EmitRecordWithBlob(AbbrevNo, ArrayRef<uint64_t>{Record}, Blob);
47820b57cec5SDimitry Andric 
47830b57cec5SDimitry Andric   Stream->ExitBlock();
47840b57cec5SDimitry Andric }
47850b57cec5SDimitry Andric 
47860b57cec5SDimitry Andric void BitcodeWriter::writeSymtab() {
47870b57cec5SDimitry Andric   assert(!WroteStrtab && !WroteSymtab);
47880b57cec5SDimitry Andric 
47890b57cec5SDimitry Andric   // If any module has module-level inline asm, we will require a registered asm
47900b57cec5SDimitry Andric   // parser for the target so that we can create an accurate symbol table for
47910b57cec5SDimitry Andric   // the module.
47920b57cec5SDimitry Andric   for (Module *M : Mods) {
47930b57cec5SDimitry Andric     if (M->getModuleInlineAsm().empty())
47940b57cec5SDimitry Andric       continue;
47950b57cec5SDimitry Andric 
47960b57cec5SDimitry Andric     std::string Err;
47970b57cec5SDimitry Andric     const Triple TT(M->getTargetTriple());
47980b57cec5SDimitry Andric     const Target *T = TargetRegistry::lookupTarget(TT.str(), Err);
47990b57cec5SDimitry Andric     if (!T || !T->hasMCAsmParser())
48000b57cec5SDimitry Andric       return;
48010b57cec5SDimitry Andric   }
48020b57cec5SDimitry Andric 
48030b57cec5SDimitry Andric   WroteSymtab = true;
48040b57cec5SDimitry Andric   SmallVector<char, 0> Symtab;
48050b57cec5SDimitry Andric   // The irsymtab::build function may be unable to create a symbol table if the
48060b57cec5SDimitry Andric   // module is malformed (e.g. it contains an invalid alias). Writing a symbol
48070b57cec5SDimitry Andric   // table is not required for correctness, but we still want to be able to
48080b57cec5SDimitry Andric   // write malformed modules to bitcode files, so swallow the error.
48090b57cec5SDimitry Andric   if (Error E = irsymtab::build(Mods, Symtab, StrtabBuilder, Alloc)) {
48100b57cec5SDimitry Andric     consumeError(std::move(E));
48110b57cec5SDimitry Andric     return;
48120b57cec5SDimitry Andric   }
48130b57cec5SDimitry Andric 
48140b57cec5SDimitry Andric   writeBlob(bitc::SYMTAB_BLOCK_ID, bitc::SYMTAB_BLOB,
48150b57cec5SDimitry Andric             {Symtab.data(), Symtab.size()});
48160b57cec5SDimitry Andric }
48170b57cec5SDimitry Andric 
48180b57cec5SDimitry Andric void BitcodeWriter::writeStrtab() {
48190b57cec5SDimitry Andric   assert(!WroteStrtab);
48200b57cec5SDimitry Andric 
48210b57cec5SDimitry Andric   std::vector<char> Strtab;
48220b57cec5SDimitry Andric   StrtabBuilder.finalizeInOrder();
48230b57cec5SDimitry Andric   Strtab.resize(StrtabBuilder.getSize());
48240b57cec5SDimitry Andric   StrtabBuilder.write((uint8_t *)Strtab.data());
48250b57cec5SDimitry Andric 
48260b57cec5SDimitry Andric   writeBlob(bitc::STRTAB_BLOCK_ID, bitc::STRTAB_BLOB,
48270b57cec5SDimitry Andric             {Strtab.data(), Strtab.size()});
48280b57cec5SDimitry Andric 
48290b57cec5SDimitry Andric   WroteStrtab = true;
48300b57cec5SDimitry Andric }
48310b57cec5SDimitry Andric 
48320b57cec5SDimitry Andric void BitcodeWriter::copyStrtab(StringRef Strtab) {
48330b57cec5SDimitry Andric   writeBlob(bitc::STRTAB_BLOCK_ID, bitc::STRTAB_BLOB, Strtab);
48340b57cec5SDimitry Andric   WroteStrtab = true;
48350b57cec5SDimitry Andric }
48360b57cec5SDimitry Andric 
48370b57cec5SDimitry Andric void BitcodeWriter::writeModule(const Module &M,
48380b57cec5SDimitry Andric                                 bool ShouldPreserveUseListOrder,
48390b57cec5SDimitry Andric                                 const ModuleSummaryIndex *Index,
48400b57cec5SDimitry Andric                                 bool GenerateHash, ModuleHash *ModHash) {
48410b57cec5SDimitry Andric   assert(!WroteStrtab);
48420b57cec5SDimitry Andric 
48430b57cec5SDimitry Andric   // The Mods vector is used by irsymtab::build, which requires non-const
48440b57cec5SDimitry Andric   // Modules in case it needs to materialize metadata. But the bitcode writer
48450b57cec5SDimitry Andric   // requires that the module is materialized, so we can cast to non-const here,
48460b57cec5SDimitry Andric   // after checking that it is in fact materialized.
48470b57cec5SDimitry Andric   assert(M.isMaterialized());
48480b57cec5SDimitry Andric   Mods.push_back(const_cast<Module *>(&M));
48490b57cec5SDimitry Andric 
48500b57cec5SDimitry Andric   ModuleBitcodeWriter ModuleWriter(M, Buffer, StrtabBuilder, *Stream,
48510b57cec5SDimitry Andric                                    ShouldPreserveUseListOrder, Index,
48520b57cec5SDimitry Andric                                    GenerateHash, ModHash);
48530b57cec5SDimitry Andric   ModuleWriter.write();
48540b57cec5SDimitry Andric }
48550b57cec5SDimitry Andric 
48560b57cec5SDimitry Andric void BitcodeWriter::writeIndex(
48570b57cec5SDimitry Andric     const ModuleSummaryIndex *Index,
48580b57cec5SDimitry Andric     const std::map<std::string, GVSummaryMapTy> *ModuleToSummariesForIndex) {
48590b57cec5SDimitry Andric   IndexBitcodeWriter IndexWriter(*Stream, StrtabBuilder, *Index,
48600b57cec5SDimitry Andric                                  ModuleToSummariesForIndex);
48610b57cec5SDimitry Andric   IndexWriter.write();
48620b57cec5SDimitry Andric }
48630b57cec5SDimitry Andric 
48640b57cec5SDimitry Andric /// Write the specified module to the specified output stream.
48650b57cec5SDimitry Andric void llvm::WriteBitcodeToFile(const Module &M, raw_ostream &Out,
48660b57cec5SDimitry Andric                               bool ShouldPreserveUseListOrder,
48670b57cec5SDimitry Andric                               const ModuleSummaryIndex *Index,
48680b57cec5SDimitry Andric                               bool GenerateHash, ModuleHash *ModHash) {
48690b57cec5SDimitry Andric   SmallVector<char, 0> Buffer;
48700b57cec5SDimitry Andric   Buffer.reserve(256*1024);
48710b57cec5SDimitry Andric 
48720b57cec5SDimitry Andric   // If this is darwin or another generic macho target, reserve space for the
48730b57cec5SDimitry Andric   // header.
48740b57cec5SDimitry Andric   Triple TT(M.getTargetTriple());
48750b57cec5SDimitry Andric   if (TT.isOSDarwin() || TT.isOSBinFormatMachO())
48760b57cec5SDimitry Andric     Buffer.insert(Buffer.begin(), BWH_HeaderSize, 0);
48770b57cec5SDimitry Andric 
4878e8d8bef9SDimitry Andric   BitcodeWriter Writer(Buffer, dyn_cast<raw_fd_stream>(&Out));
48790b57cec5SDimitry Andric   Writer.writeModule(M, ShouldPreserveUseListOrder, Index, GenerateHash,
48800b57cec5SDimitry Andric                      ModHash);
48810b57cec5SDimitry Andric   Writer.writeSymtab();
48820b57cec5SDimitry Andric   Writer.writeStrtab();
48830b57cec5SDimitry Andric 
48840b57cec5SDimitry Andric   if (TT.isOSDarwin() || TT.isOSBinFormatMachO())
48850b57cec5SDimitry Andric     emitDarwinBCHeaderAndTrailer(Buffer, TT);
48860b57cec5SDimitry Andric 
48870b57cec5SDimitry Andric   // Write the generated bitstream to "Out".
4888e8d8bef9SDimitry Andric   if (!Buffer.empty())
48890b57cec5SDimitry Andric     Out.write((char *)&Buffer.front(), Buffer.size());
48900b57cec5SDimitry Andric }
48910b57cec5SDimitry Andric 
48920b57cec5SDimitry Andric void IndexBitcodeWriter::write() {
48930b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
48940b57cec5SDimitry Andric 
48950b57cec5SDimitry Andric   writeModuleVersion();
48960b57cec5SDimitry Andric 
48970b57cec5SDimitry Andric   // Write the module paths in the combined index.
48980b57cec5SDimitry Andric   writeModStrings();
48990b57cec5SDimitry Andric 
49000b57cec5SDimitry Andric   // Write the summary combined index records.
49010b57cec5SDimitry Andric   writeCombinedGlobalValueSummary();
49020b57cec5SDimitry Andric 
49030b57cec5SDimitry Andric   Stream.ExitBlock();
49040b57cec5SDimitry Andric }
49050b57cec5SDimitry Andric 
49060b57cec5SDimitry Andric // Write the specified module summary index to the given raw output stream,
49070b57cec5SDimitry Andric // where it will be written in a new bitcode block. This is used when
49080b57cec5SDimitry Andric // writing the combined index file for ThinLTO. When writing a subset of the
49090b57cec5SDimitry Andric // index for a distributed backend, provide a \p ModuleToSummariesForIndex map.
49101fd87a68SDimitry Andric void llvm::writeIndexToFile(
49110b57cec5SDimitry Andric     const ModuleSummaryIndex &Index, raw_ostream &Out,
49120b57cec5SDimitry Andric     const std::map<std::string, GVSummaryMapTy> *ModuleToSummariesForIndex) {
49130b57cec5SDimitry Andric   SmallVector<char, 0> Buffer;
49140b57cec5SDimitry Andric   Buffer.reserve(256 * 1024);
49150b57cec5SDimitry Andric 
49160b57cec5SDimitry Andric   BitcodeWriter Writer(Buffer);
49170b57cec5SDimitry Andric   Writer.writeIndex(&Index, ModuleToSummariesForIndex);
49180b57cec5SDimitry Andric   Writer.writeStrtab();
49190b57cec5SDimitry Andric 
49200b57cec5SDimitry Andric   Out.write((char *)&Buffer.front(), Buffer.size());
49210b57cec5SDimitry Andric }
49220b57cec5SDimitry Andric 
49230b57cec5SDimitry Andric namespace {
49240b57cec5SDimitry Andric 
49250b57cec5SDimitry Andric /// Class to manage the bitcode writing for a thin link bitcode file.
49260b57cec5SDimitry Andric class ThinLinkBitcodeWriter : public ModuleBitcodeWriterBase {
49270b57cec5SDimitry Andric   /// ModHash is for use in ThinLTO incremental build, generated while writing
49280b57cec5SDimitry Andric   /// the module bitcode file.
49290b57cec5SDimitry Andric   const ModuleHash *ModHash;
49300b57cec5SDimitry Andric 
49310b57cec5SDimitry Andric public:
49320b57cec5SDimitry Andric   ThinLinkBitcodeWriter(const Module &M, StringTableBuilder &StrtabBuilder,
49330b57cec5SDimitry Andric                         BitstreamWriter &Stream,
49340b57cec5SDimitry Andric                         const ModuleSummaryIndex &Index,
49350b57cec5SDimitry Andric                         const ModuleHash &ModHash)
49360b57cec5SDimitry Andric       : ModuleBitcodeWriterBase(M, StrtabBuilder, Stream,
49370b57cec5SDimitry Andric                                 /*ShouldPreserveUseListOrder=*/false, &Index),
49380b57cec5SDimitry Andric         ModHash(&ModHash) {}
49390b57cec5SDimitry Andric 
49400b57cec5SDimitry Andric   void write();
49410b57cec5SDimitry Andric 
49420b57cec5SDimitry Andric private:
49430b57cec5SDimitry Andric   void writeSimplifiedModuleInfo();
49440b57cec5SDimitry Andric };
49450b57cec5SDimitry Andric 
49460b57cec5SDimitry Andric } // end anonymous namespace
49470b57cec5SDimitry Andric 
49480b57cec5SDimitry Andric // This function writes a simpilified module info for thin link bitcode file.
49490b57cec5SDimitry Andric // It only contains the source file name along with the name(the offset and
49500b57cec5SDimitry Andric // size in strtab) and linkage for global values. For the global value info
49510b57cec5SDimitry Andric // entry, in order to keep linkage at offset 5, there are three zeros used
49520b57cec5SDimitry Andric // as padding.
49530b57cec5SDimitry Andric void ThinLinkBitcodeWriter::writeSimplifiedModuleInfo() {
49540b57cec5SDimitry Andric   SmallVector<unsigned, 64> Vals;
49550b57cec5SDimitry Andric   // Emit the module's source file name.
49560b57cec5SDimitry Andric   {
49570b57cec5SDimitry Andric     StringEncoding Bits = getStringEncoding(M.getSourceFileName());
49580b57cec5SDimitry Andric     BitCodeAbbrevOp AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8);
49590b57cec5SDimitry Andric     if (Bits == SE_Char6)
49600b57cec5SDimitry Andric       AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Char6);
49610b57cec5SDimitry Andric     else if (Bits == SE_Fixed7)
49620b57cec5SDimitry Andric       AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7);
49630b57cec5SDimitry Andric 
49640b57cec5SDimitry Andric     // MODULE_CODE_SOURCE_FILENAME: [namechar x N]
49650b57cec5SDimitry Andric     auto Abbv = std::make_shared<BitCodeAbbrev>();
49660b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_SOURCE_FILENAME));
49670b57cec5SDimitry Andric     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
49680b57cec5SDimitry Andric     Abbv->Add(AbbrevOpToUse);
49690b57cec5SDimitry Andric     unsigned FilenameAbbrev = Stream.EmitAbbrev(std::move(Abbv));
49700b57cec5SDimitry Andric 
49710b57cec5SDimitry Andric     for (const auto P : M.getSourceFileName())
49720b57cec5SDimitry Andric       Vals.push_back((unsigned char)P);
49730b57cec5SDimitry Andric 
49740b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_SOURCE_FILENAME, Vals, FilenameAbbrev);
49750b57cec5SDimitry Andric     Vals.clear();
49760b57cec5SDimitry Andric   }
49770b57cec5SDimitry Andric 
49780b57cec5SDimitry Andric   // Emit the global variable information.
49790b57cec5SDimitry Andric   for (const GlobalVariable &GV : M.globals()) {
49800b57cec5SDimitry Andric     // GLOBALVAR: [strtab offset, strtab size, 0, 0, 0, linkage]
49810b57cec5SDimitry Andric     Vals.push_back(StrtabBuilder.add(GV.getName()));
49820b57cec5SDimitry Andric     Vals.push_back(GV.getName().size());
49830b57cec5SDimitry Andric     Vals.push_back(0);
49840b57cec5SDimitry Andric     Vals.push_back(0);
49850b57cec5SDimitry Andric     Vals.push_back(0);
49860b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(GV));
49870b57cec5SDimitry Andric 
49880b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals);
49890b57cec5SDimitry Andric     Vals.clear();
49900b57cec5SDimitry Andric   }
49910b57cec5SDimitry Andric 
49920b57cec5SDimitry Andric   // Emit the function proto information.
49930b57cec5SDimitry Andric   for (const Function &F : M) {
49940b57cec5SDimitry Andric     // FUNCTION:  [strtab offset, strtab size, 0, 0, 0, linkage]
49950b57cec5SDimitry Andric     Vals.push_back(StrtabBuilder.add(F.getName()));
49960b57cec5SDimitry Andric     Vals.push_back(F.getName().size());
49970b57cec5SDimitry Andric     Vals.push_back(0);
49980b57cec5SDimitry Andric     Vals.push_back(0);
49990b57cec5SDimitry Andric     Vals.push_back(0);
50000b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(F));
50010b57cec5SDimitry Andric 
50020b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals);
50030b57cec5SDimitry Andric     Vals.clear();
50040b57cec5SDimitry Andric   }
50050b57cec5SDimitry Andric 
50060b57cec5SDimitry Andric   // Emit the alias information.
50070b57cec5SDimitry Andric   for (const GlobalAlias &A : M.aliases()) {
50080b57cec5SDimitry Andric     // ALIAS: [strtab offset, strtab size, 0, 0, 0, linkage]
50090b57cec5SDimitry Andric     Vals.push_back(StrtabBuilder.add(A.getName()));
50100b57cec5SDimitry Andric     Vals.push_back(A.getName().size());
50110b57cec5SDimitry Andric     Vals.push_back(0);
50120b57cec5SDimitry Andric     Vals.push_back(0);
50130b57cec5SDimitry Andric     Vals.push_back(0);
50140b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(A));
50150b57cec5SDimitry Andric 
50160b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals);
50170b57cec5SDimitry Andric     Vals.clear();
50180b57cec5SDimitry Andric   }
50190b57cec5SDimitry Andric 
50200b57cec5SDimitry Andric   // Emit the ifunc information.
50210b57cec5SDimitry Andric   for (const GlobalIFunc &I : M.ifuncs()) {
50220b57cec5SDimitry Andric     // IFUNC: [strtab offset, strtab size, 0, 0, 0, linkage]
50230b57cec5SDimitry Andric     Vals.push_back(StrtabBuilder.add(I.getName()));
50240b57cec5SDimitry Andric     Vals.push_back(I.getName().size());
50250b57cec5SDimitry Andric     Vals.push_back(0);
50260b57cec5SDimitry Andric     Vals.push_back(0);
50270b57cec5SDimitry Andric     Vals.push_back(0);
50280b57cec5SDimitry Andric     Vals.push_back(getEncodedLinkage(I));
50290b57cec5SDimitry Andric 
50300b57cec5SDimitry Andric     Stream.EmitRecord(bitc::MODULE_CODE_IFUNC, Vals);
50310b57cec5SDimitry Andric     Vals.clear();
50320b57cec5SDimitry Andric   }
50330b57cec5SDimitry Andric }
50340b57cec5SDimitry Andric 
50350b57cec5SDimitry Andric void ThinLinkBitcodeWriter::write() {
50360b57cec5SDimitry Andric   Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
50370b57cec5SDimitry Andric 
50380b57cec5SDimitry Andric   writeModuleVersion();
50390b57cec5SDimitry Andric 
50400b57cec5SDimitry Andric   writeSimplifiedModuleInfo();
50410b57cec5SDimitry Andric 
50420b57cec5SDimitry Andric   writePerModuleGlobalValueSummary();
50430b57cec5SDimitry Andric 
50440b57cec5SDimitry Andric   // Write module hash.
50450b57cec5SDimitry Andric   Stream.EmitRecord(bitc::MODULE_CODE_HASH, ArrayRef<uint32_t>(*ModHash));
50460b57cec5SDimitry Andric 
50470b57cec5SDimitry Andric   Stream.ExitBlock();
50480b57cec5SDimitry Andric }
50490b57cec5SDimitry Andric 
50500b57cec5SDimitry Andric void BitcodeWriter::writeThinLinkBitcode(const Module &M,
50510b57cec5SDimitry Andric                                          const ModuleSummaryIndex &Index,
50520b57cec5SDimitry Andric                                          const ModuleHash &ModHash) {
50530b57cec5SDimitry Andric   assert(!WroteStrtab);
50540b57cec5SDimitry Andric 
50550b57cec5SDimitry Andric   // The Mods vector is used by irsymtab::build, which requires non-const
50560b57cec5SDimitry Andric   // Modules in case it needs to materialize metadata. But the bitcode writer
50570b57cec5SDimitry Andric   // requires that the module is materialized, so we can cast to non-const here,
50580b57cec5SDimitry Andric   // after checking that it is in fact materialized.
50590b57cec5SDimitry Andric   assert(M.isMaterialized());
50600b57cec5SDimitry Andric   Mods.push_back(const_cast<Module *>(&M));
50610b57cec5SDimitry Andric 
50620b57cec5SDimitry Andric   ThinLinkBitcodeWriter ThinLinkWriter(M, StrtabBuilder, *Stream, Index,
50630b57cec5SDimitry Andric                                        ModHash);
50640b57cec5SDimitry Andric   ThinLinkWriter.write();
50650b57cec5SDimitry Andric }
50660b57cec5SDimitry Andric 
50670b57cec5SDimitry Andric // Write the specified thin link bitcode file to the given raw output stream,
50680b57cec5SDimitry Andric // where it will be written in a new bitcode block. This is used when
50690b57cec5SDimitry Andric // writing the per-module index file for ThinLTO.
50701fd87a68SDimitry Andric void llvm::writeThinLinkBitcodeToFile(const Module &M, raw_ostream &Out,
50710b57cec5SDimitry Andric                                       const ModuleSummaryIndex &Index,
50720b57cec5SDimitry Andric                                       const ModuleHash &ModHash) {
50730b57cec5SDimitry Andric   SmallVector<char, 0> Buffer;
50740b57cec5SDimitry Andric   Buffer.reserve(256 * 1024);
50750b57cec5SDimitry Andric 
50760b57cec5SDimitry Andric   BitcodeWriter Writer(Buffer);
50770b57cec5SDimitry Andric   Writer.writeThinLinkBitcode(M, Index, ModHash);
50780b57cec5SDimitry Andric   Writer.writeSymtab();
50790b57cec5SDimitry Andric   Writer.writeStrtab();
50800b57cec5SDimitry Andric 
50810b57cec5SDimitry Andric   Out.write((char *)&Buffer.front(), Buffer.size());
50820b57cec5SDimitry Andric }
5083480093f4SDimitry Andric 
5084480093f4SDimitry Andric static const char *getSectionNameForBitcode(const Triple &T) {
5085480093f4SDimitry Andric   switch (T.getObjectFormat()) {
5086480093f4SDimitry Andric   case Triple::MachO:
5087480093f4SDimitry Andric     return "__LLVM,__bitcode";
5088480093f4SDimitry Andric   case Triple::COFF:
5089480093f4SDimitry Andric   case Triple::ELF:
5090480093f4SDimitry Andric   case Triple::Wasm:
5091480093f4SDimitry Andric   case Triple::UnknownObjectFormat:
5092480093f4SDimitry Andric     return ".llvmbc";
5093e8d8bef9SDimitry Andric   case Triple::GOFF:
5094e8d8bef9SDimitry Andric     llvm_unreachable("GOFF is not yet implemented");
5095e8d8bef9SDimitry Andric     break;
509681ad6265SDimitry Andric   case Triple::SPIRV:
509781ad6265SDimitry Andric     llvm_unreachable("SPIRV is not yet implemented");
509881ad6265SDimitry Andric     break;
5099480093f4SDimitry Andric   case Triple::XCOFF:
5100480093f4SDimitry Andric     llvm_unreachable("XCOFF is not yet implemented");
5101480093f4SDimitry Andric     break;
510281ad6265SDimitry Andric   case Triple::DXContainer:
510381ad6265SDimitry Andric     llvm_unreachable("DXContainer is not yet implemented");
510481ad6265SDimitry Andric     break;
5105480093f4SDimitry Andric   }
5106480093f4SDimitry Andric   llvm_unreachable("Unimplemented ObjectFormatType");
5107480093f4SDimitry Andric }
5108480093f4SDimitry Andric 
5109480093f4SDimitry Andric static const char *getSectionNameForCommandline(const Triple &T) {
5110480093f4SDimitry Andric   switch (T.getObjectFormat()) {
5111480093f4SDimitry Andric   case Triple::MachO:
5112480093f4SDimitry Andric     return "__LLVM,__cmdline";
5113480093f4SDimitry Andric   case Triple::COFF:
5114480093f4SDimitry Andric   case Triple::ELF:
5115480093f4SDimitry Andric   case Triple::Wasm:
5116480093f4SDimitry Andric   case Triple::UnknownObjectFormat:
5117480093f4SDimitry Andric     return ".llvmcmd";
5118e8d8bef9SDimitry Andric   case Triple::GOFF:
5119e8d8bef9SDimitry Andric     llvm_unreachable("GOFF is not yet implemented");
5120e8d8bef9SDimitry Andric     break;
512181ad6265SDimitry Andric   case Triple::SPIRV:
512281ad6265SDimitry Andric     llvm_unreachable("SPIRV is not yet implemented");
512381ad6265SDimitry Andric     break;
5124480093f4SDimitry Andric   case Triple::XCOFF:
5125480093f4SDimitry Andric     llvm_unreachable("XCOFF is not yet implemented");
5126480093f4SDimitry Andric     break;
512781ad6265SDimitry Andric   case Triple::DXContainer:
512881ad6265SDimitry Andric     llvm_unreachable("DXC is not yet implemented");
512981ad6265SDimitry Andric     break;
5130480093f4SDimitry Andric   }
5131480093f4SDimitry Andric   llvm_unreachable("Unimplemented ObjectFormatType");
5132480093f4SDimitry Andric }
5133480093f4SDimitry Andric 
51341fd87a68SDimitry Andric void llvm::embedBitcodeInModule(llvm::Module &M, llvm::MemoryBufferRef Buf,
5135e8d8bef9SDimitry Andric                                 bool EmbedBitcode, bool EmbedCmdline,
5136e8d8bef9SDimitry Andric                                 const std::vector<uint8_t> &CmdArgs) {
5137480093f4SDimitry Andric   // Save llvm.compiler.used and remove it.
5138480093f4SDimitry Andric   SmallVector<Constant *, 2> UsedArray;
5139fe6060f1SDimitry Andric   SmallVector<GlobalValue *, 4> UsedGlobals;
5140480093f4SDimitry Andric   Type *UsedElementType = Type::getInt8Ty(M.getContext())->getPointerTo(0);
5141480093f4SDimitry Andric   GlobalVariable *Used = collectUsedGlobalVariables(M, UsedGlobals, true);
5142480093f4SDimitry Andric   for (auto *GV : UsedGlobals) {
5143480093f4SDimitry Andric     if (GV->getName() != "llvm.embedded.module" &&
5144480093f4SDimitry Andric         GV->getName() != "llvm.cmdline")
5145480093f4SDimitry Andric       UsedArray.push_back(
5146480093f4SDimitry Andric           ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
5147480093f4SDimitry Andric   }
5148480093f4SDimitry Andric   if (Used)
5149480093f4SDimitry Andric     Used->eraseFromParent();
5150480093f4SDimitry Andric 
5151480093f4SDimitry Andric   // Embed the bitcode for the llvm module.
5152480093f4SDimitry Andric   std::string Data;
5153480093f4SDimitry Andric   ArrayRef<uint8_t> ModuleData;
5154480093f4SDimitry Andric   Triple T(M.getTargetTriple());
5155e8d8bef9SDimitry Andric 
5156480093f4SDimitry Andric   if (EmbedBitcode) {
5157e8d8bef9SDimitry Andric     if (Buf.getBufferSize() == 0 ||
5158e8d8bef9SDimitry Andric         !isBitcode((const unsigned char *)Buf.getBufferStart(),
5159480093f4SDimitry Andric                    (const unsigned char *)Buf.getBufferEnd())) {
5160480093f4SDimitry Andric       // If the input is LLVM Assembly, bitcode is produced by serializing
5161480093f4SDimitry Andric       // the module. Use-lists order need to be preserved in this case.
5162480093f4SDimitry Andric       llvm::raw_string_ostream OS(Data);
5163480093f4SDimitry Andric       llvm::WriteBitcodeToFile(M, OS, /* ShouldPreserveUseListOrder */ true);
5164480093f4SDimitry Andric       ModuleData =
5165480093f4SDimitry Andric           ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size());
5166480093f4SDimitry Andric     } else
5167480093f4SDimitry Andric       // If the input is LLVM bitcode, write the input byte stream directly.
5168480093f4SDimitry Andric       ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(),
5169480093f4SDimitry Andric                                      Buf.getBufferSize());
5170480093f4SDimitry Andric   }
5171480093f4SDimitry Andric   llvm::Constant *ModuleConstant =
5172480093f4SDimitry Andric       llvm::ConstantDataArray::get(M.getContext(), ModuleData);
5173480093f4SDimitry Andric   llvm::GlobalVariable *GV = new llvm::GlobalVariable(
5174480093f4SDimitry Andric       M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage,
5175480093f4SDimitry Andric       ModuleConstant);
5176480093f4SDimitry Andric   GV->setSection(getSectionNameForBitcode(T));
5177e8d8bef9SDimitry Andric   // Set alignment to 1 to prevent padding between two contributions from input
5178e8d8bef9SDimitry Andric   // sections after linking.
5179e8d8bef9SDimitry Andric   GV->setAlignment(Align(1));
5180480093f4SDimitry Andric   UsedArray.push_back(
5181480093f4SDimitry Andric       ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
5182480093f4SDimitry Andric   if (llvm::GlobalVariable *Old =
5183480093f4SDimitry Andric           M.getGlobalVariable("llvm.embedded.module", true)) {
518481ad6265SDimitry Andric     assert(Old->hasZeroLiveUses() &&
5185480093f4SDimitry Andric            "llvm.embedded.module can only be used once in llvm.compiler.used");
5186480093f4SDimitry Andric     GV->takeName(Old);
5187480093f4SDimitry Andric     Old->eraseFromParent();
5188480093f4SDimitry Andric   } else {
5189480093f4SDimitry Andric     GV->setName("llvm.embedded.module");
5190480093f4SDimitry Andric   }
5191480093f4SDimitry Andric 
5192480093f4SDimitry Andric   // Skip if only bitcode needs to be embedded.
5193e8d8bef9SDimitry Andric   if (EmbedCmdline) {
5194480093f4SDimitry Andric     // Embed command-line options.
5195e8d8bef9SDimitry Andric     ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CmdArgs.data()),
5196e8d8bef9SDimitry Andric                               CmdArgs.size());
5197480093f4SDimitry Andric     llvm::Constant *CmdConstant =
5198480093f4SDimitry Andric         llvm::ConstantDataArray::get(M.getContext(), CmdData);
5199480093f4SDimitry Andric     GV = new llvm::GlobalVariable(M, CmdConstant->getType(), true,
5200480093f4SDimitry Andric                                   llvm::GlobalValue::PrivateLinkage,
5201480093f4SDimitry Andric                                   CmdConstant);
5202480093f4SDimitry Andric     GV->setSection(getSectionNameForCommandline(T));
5203e8d8bef9SDimitry Andric     GV->setAlignment(Align(1));
5204480093f4SDimitry Andric     UsedArray.push_back(
5205480093f4SDimitry Andric         ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
5206480093f4SDimitry Andric     if (llvm::GlobalVariable *Old = M.getGlobalVariable("llvm.cmdline", true)) {
520781ad6265SDimitry Andric       assert(Old->hasZeroLiveUses() &&
5208480093f4SDimitry Andric              "llvm.cmdline can only be used once in llvm.compiler.used");
5209480093f4SDimitry Andric       GV->takeName(Old);
5210480093f4SDimitry Andric       Old->eraseFromParent();
5211480093f4SDimitry Andric     } else {
5212480093f4SDimitry Andric       GV->setName("llvm.cmdline");
5213480093f4SDimitry Andric     }
5214480093f4SDimitry Andric   }
5215480093f4SDimitry Andric 
5216480093f4SDimitry Andric   if (UsedArray.empty())
5217480093f4SDimitry Andric     return;
5218480093f4SDimitry Andric 
5219480093f4SDimitry Andric   // Recreate llvm.compiler.used.
5220480093f4SDimitry Andric   ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size());
5221480093f4SDimitry Andric   auto *NewUsed = new GlobalVariable(
5222480093f4SDimitry Andric       M, ATy, false, llvm::GlobalValue::AppendingLinkage,
5223480093f4SDimitry Andric       llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used");
5224480093f4SDimitry Andric   NewUsed->setSection("llvm.metadata");
5225480093f4SDimitry Andric }
5226