1 //===- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // Bitcode writer implementation. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "llvm/Bitcode/BitcodeWriter.h" 14 #include "ValueEnumerator.h" 15 #include "llvm/ADT/APFloat.h" 16 #include "llvm/ADT/APInt.h" 17 #include "llvm/ADT/ArrayRef.h" 18 #include "llvm/ADT/DenseMap.h" 19 #include "llvm/ADT/None.h" 20 #include "llvm/ADT/Optional.h" 21 #include "llvm/ADT/STLExtras.h" 22 #include "llvm/ADT/SmallString.h" 23 #include "llvm/ADT/SmallVector.h" 24 #include "llvm/ADT/StringMap.h" 25 #include "llvm/ADT/StringRef.h" 26 #include "llvm/ADT/Triple.h" 27 #include "llvm/Bitcode/BitcodeCommon.h" 28 #include "llvm/Bitcode/BitcodeReader.h" 29 #include "llvm/Bitcode/LLVMBitCodes.h" 30 #include "llvm/Bitstream/BitCodes.h" 31 #include "llvm/Bitstream/BitstreamWriter.h" 32 #include "llvm/Config/llvm-config.h" 33 #include "llvm/IR/Attributes.h" 34 #include "llvm/IR/BasicBlock.h" 35 #include "llvm/IR/Comdat.h" 36 #include "llvm/IR/Constant.h" 37 #include "llvm/IR/Constants.h" 38 #include "llvm/IR/DebugInfoMetadata.h" 39 #include "llvm/IR/DebugLoc.h" 40 #include "llvm/IR/DerivedTypes.h" 41 #include "llvm/IR/Function.h" 42 #include "llvm/IR/GlobalAlias.h" 43 #include "llvm/IR/GlobalIFunc.h" 44 #include "llvm/IR/GlobalObject.h" 45 #include "llvm/IR/GlobalValue.h" 46 #include "llvm/IR/GlobalVariable.h" 47 #include "llvm/IR/InlineAsm.h" 48 #include "llvm/IR/InstrTypes.h" 49 #include "llvm/IR/Instruction.h" 50 #include "llvm/IR/Instructions.h" 51 #include "llvm/IR/LLVMContext.h" 52 #include "llvm/IR/Metadata.h" 53 #include "llvm/IR/Module.h" 54 #include "llvm/IR/ModuleSummaryIndex.h" 55 #include "llvm/IR/Operator.h" 56 #include "llvm/IR/Type.h" 57 #include "llvm/IR/UseListOrder.h" 58 #include "llvm/IR/Value.h" 59 #include "llvm/IR/ValueSymbolTable.h" 60 #include "llvm/MC/StringTableBuilder.h" 61 #include "llvm/MC/TargetRegistry.h" 62 #include "llvm/Object/IRSymtab.h" 63 #include "llvm/Support/AtomicOrdering.h" 64 #include "llvm/Support/Casting.h" 65 #include "llvm/Support/CommandLine.h" 66 #include "llvm/Support/Endian.h" 67 #include "llvm/Support/Error.h" 68 #include "llvm/Support/ErrorHandling.h" 69 #include "llvm/Support/MathExtras.h" 70 #include "llvm/Support/SHA1.h" 71 #include "llvm/Support/raw_ostream.h" 72 #include <algorithm> 73 #include <cassert> 74 #include <cstddef> 75 #include <cstdint> 76 #include <iterator> 77 #include <map> 78 #include <memory> 79 #include <string> 80 #include <utility> 81 #include <vector> 82 83 using namespace llvm; 84 85 static cl::opt<unsigned> 86 IndexThreshold("bitcode-mdindex-threshold", cl::Hidden, cl::init(25), 87 cl::desc("Number of metadatas above which we emit an index " 88 "to enable lazy-loading")); 89 static cl::opt<uint32_t> FlushThreshold( 90 "bitcode-flush-threshold", cl::Hidden, cl::init(512), 91 cl::desc("The threshold (unit M) for flushing LLVM bitcode.")); 92 93 static cl::opt<bool> WriteRelBFToSummary( 94 "write-relbf-to-summary", cl::Hidden, cl::init(false), 95 cl::desc("Write relative block frequency to function summary ")); 96 97 extern FunctionSummary::ForceSummaryHotnessType ForceSummaryEdgesCold; 98 99 namespace { 100 101 /// These are manifest constants used by the bitcode writer. They do not need to 102 /// be kept in sync with the reader, but need to be consistent within this file. 103 enum { 104 // VALUE_SYMTAB_BLOCK abbrev id's. 105 VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV, 106 VST_ENTRY_7_ABBREV, 107 VST_ENTRY_6_ABBREV, 108 VST_BBENTRY_6_ABBREV, 109 110 // CONSTANTS_BLOCK abbrev id's. 111 CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV, 112 CONSTANTS_INTEGER_ABBREV, 113 CONSTANTS_CE_CAST_Abbrev, 114 CONSTANTS_NULL_Abbrev, 115 116 // FUNCTION_BLOCK abbrev id's. 117 FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV, 118 FUNCTION_INST_UNOP_ABBREV, 119 FUNCTION_INST_UNOP_FLAGS_ABBREV, 120 FUNCTION_INST_BINOP_ABBREV, 121 FUNCTION_INST_BINOP_FLAGS_ABBREV, 122 FUNCTION_INST_CAST_ABBREV, 123 FUNCTION_INST_RET_VOID_ABBREV, 124 FUNCTION_INST_RET_VAL_ABBREV, 125 FUNCTION_INST_UNREACHABLE_ABBREV, 126 FUNCTION_INST_GEP_ABBREV, 127 }; 128 129 /// Abstract class to manage the bitcode writing, subclassed for each bitcode 130 /// file type. 131 class BitcodeWriterBase { 132 protected: 133 /// The stream created and owned by the client. 134 BitstreamWriter &Stream; 135 136 StringTableBuilder &StrtabBuilder; 137 138 public: 139 /// Constructs a BitcodeWriterBase object that writes to the provided 140 /// \p Stream. 141 BitcodeWriterBase(BitstreamWriter &Stream, StringTableBuilder &StrtabBuilder) 142 : Stream(Stream), StrtabBuilder(StrtabBuilder) {} 143 144 protected: 145 void writeModuleVersion(); 146 }; 147 148 void BitcodeWriterBase::writeModuleVersion() { 149 // VERSION: [version#] 150 Stream.EmitRecord(bitc::MODULE_CODE_VERSION, ArrayRef<uint64_t>{2}); 151 } 152 153 /// Base class to manage the module bitcode writing, currently subclassed for 154 /// ModuleBitcodeWriter and ThinLinkBitcodeWriter. 155 class ModuleBitcodeWriterBase : public BitcodeWriterBase { 156 protected: 157 /// The Module to write to bitcode. 158 const Module &M; 159 160 /// Enumerates ids for all values in the module. 161 ValueEnumerator VE; 162 163 /// Optional per-module index to write for ThinLTO. 164 const ModuleSummaryIndex *Index; 165 166 /// Map that holds the correspondence between GUIDs in the summary index, 167 /// that came from indirect call profiles, and a value id generated by this 168 /// class to use in the VST and summary block records. 169 std::map<GlobalValue::GUID, unsigned> GUIDToValueIdMap; 170 171 /// Tracks the last value id recorded in the GUIDToValueMap. 172 unsigned GlobalValueId; 173 174 /// Saves the offset of the VSTOffset record that must eventually be 175 /// backpatched with the offset of the actual VST. 176 uint64_t VSTOffsetPlaceholder = 0; 177 178 public: 179 /// Constructs a ModuleBitcodeWriterBase object for the given Module, 180 /// writing to the provided \p Buffer. 181 ModuleBitcodeWriterBase(const Module &M, StringTableBuilder &StrtabBuilder, 182 BitstreamWriter &Stream, 183 bool ShouldPreserveUseListOrder, 184 const ModuleSummaryIndex *Index) 185 : BitcodeWriterBase(Stream, StrtabBuilder), M(M), 186 VE(M, ShouldPreserveUseListOrder), Index(Index) { 187 // Assign ValueIds to any callee values in the index that came from 188 // indirect call profiles and were recorded as a GUID not a Value* 189 // (which would have been assigned an ID by the ValueEnumerator). 190 // The starting ValueId is just after the number of values in the 191 // ValueEnumerator, so that they can be emitted in the VST. 192 GlobalValueId = VE.getValues().size(); 193 if (!Index) 194 return; 195 for (const auto &GUIDSummaryLists : *Index) 196 // Examine all summaries for this GUID. 197 for (auto &Summary : GUIDSummaryLists.second.SummaryList) 198 if (auto FS = dyn_cast<FunctionSummary>(Summary.get())) 199 // For each call in the function summary, see if the call 200 // is to a GUID (which means it is for an indirect call, 201 // otherwise we would have a Value for it). If so, synthesize 202 // a value id. 203 for (auto &CallEdge : FS->calls()) 204 if (!CallEdge.first.haveGVs() || !CallEdge.first.getValue()) 205 assignValueId(CallEdge.first.getGUID()); 206 } 207 208 protected: 209 void writePerModuleGlobalValueSummary(); 210 211 private: 212 void writePerModuleFunctionSummaryRecord(SmallVector<uint64_t, 64> &NameVals, 213 GlobalValueSummary *Summary, 214 unsigned ValueID, 215 unsigned FSCallsAbbrev, 216 unsigned FSCallsProfileAbbrev, 217 const Function &F); 218 void writeModuleLevelReferences(const GlobalVariable &V, 219 SmallVector<uint64_t, 64> &NameVals, 220 unsigned FSModRefsAbbrev, 221 unsigned FSModVTableRefsAbbrev); 222 223 void assignValueId(GlobalValue::GUID ValGUID) { 224 GUIDToValueIdMap[ValGUID] = ++GlobalValueId; 225 } 226 227 unsigned getValueId(GlobalValue::GUID ValGUID) { 228 const auto &VMI = GUIDToValueIdMap.find(ValGUID); 229 // Expect that any GUID value had a value Id assigned by an 230 // earlier call to assignValueId. 231 assert(VMI != GUIDToValueIdMap.end() && 232 "GUID does not have assigned value Id"); 233 return VMI->second; 234 } 235 236 // Helper to get the valueId for the type of value recorded in VI. 237 unsigned getValueId(ValueInfo VI) { 238 if (!VI.haveGVs() || !VI.getValue()) 239 return getValueId(VI.getGUID()); 240 return VE.getValueID(VI.getValue()); 241 } 242 243 std::map<GlobalValue::GUID, unsigned> &valueIds() { return GUIDToValueIdMap; } 244 }; 245 246 /// Class to manage the bitcode writing for a module. 247 class ModuleBitcodeWriter : public ModuleBitcodeWriterBase { 248 /// Pointer to the buffer allocated by caller for bitcode writing. 249 const SmallVectorImpl<char> &Buffer; 250 251 /// True if a module hash record should be written. 252 bool GenerateHash; 253 254 /// If non-null, when GenerateHash is true, the resulting hash is written 255 /// into ModHash. 256 ModuleHash *ModHash; 257 258 SHA1 Hasher; 259 260 /// The start bit of the identification block. 261 uint64_t BitcodeStartBit; 262 263 public: 264 /// Constructs a ModuleBitcodeWriter object for the given Module, 265 /// writing to the provided \p Buffer. 266 ModuleBitcodeWriter(const Module &M, SmallVectorImpl<char> &Buffer, 267 StringTableBuilder &StrtabBuilder, 268 BitstreamWriter &Stream, bool ShouldPreserveUseListOrder, 269 const ModuleSummaryIndex *Index, bool GenerateHash, 270 ModuleHash *ModHash = nullptr) 271 : ModuleBitcodeWriterBase(M, StrtabBuilder, Stream, 272 ShouldPreserveUseListOrder, Index), 273 Buffer(Buffer), GenerateHash(GenerateHash), ModHash(ModHash), 274 BitcodeStartBit(Stream.GetCurrentBitNo()) {} 275 276 /// Emit the current module to the bitstream. 277 void write(); 278 279 private: 280 uint64_t bitcodeStartBit() { return BitcodeStartBit; } 281 282 size_t addToStrtab(StringRef Str); 283 284 void writeAttributeGroupTable(); 285 void writeAttributeTable(); 286 void writeTypeTable(); 287 void writeComdats(); 288 void writeValueSymbolTableForwardDecl(); 289 void writeModuleInfo(); 290 void writeValueAsMetadata(const ValueAsMetadata *MD, 291 SmallVectorImpl<uint64_t> &Record); 292 void writeMDTuple(const MDTuple *N, SmallVectorImpl<uint64_t> &Record, 293 unsigned Abbrev); 294 unsigned createDILocationAbbrev(); 295 void writeDILocation(const DILocation *N, SmallVectorImpl<uint64_t> &Record, 296 unsigned &Abbrev); 297 unsigned createGenericDINodeAbbrev(); 298 void writeGenericDINode(const GenericDINode *N, 299 SmallVectorImpl<uint64_t> &Record, unsigned &Abbrev); 300 void writeDISubrange(const DISubrange *N, SmallVectorImpl<uint64_t> &Record, 301 unsigned Abbrev); 302 void writeDIGenericSubrange(const DIGenericSubrange *N, 303 SmallVectorImpl<uint64_t> &Record, 304 unsigned Abbrev); 305 void writeDIEnumerator(const DIEnumerator *N, 306 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 307 void writeDIBasicType(const DIBasicType *N, SmallVectorImpl<uint64_t> &Record, 308 unsigned Abbrev); 309 void writeDIStringType(const DIStringType *N, 310 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 311 void writeDIDerivedType(const DIDerivedType *N, 312 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 313 void writeDICompositeType(const DICompositeType *N, 314 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 315 void writeDISubroutineType(const DISubroutineType *N, 316 SmallVectorImpl<uint64_t> &Record, 317 unsigned Abbrev); 318 void writeDIFile(const DIFile *N, SmallVectorImpl<uint64_t> &Record, 319 unsigned Abbrev); 320 void writeDICompileUnit(const DICompileUnit *N, 321 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 322 void writeDISubprogram(const DISubprogram *N, 323 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 324 void writeDILexicalBlock(const DILexicalBlock *N, 325 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 326 void writeDILexicalBlockFile(const DILexicalBlockFile *N, 327 SmallVectorImpl<uint64_t> &Record, 328 unsigned Abbrev); 329 void writeDICommonBlock(const DICommonBlock *N, 330 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 331 void writeDINamespace(const DINamespace *N, SmallVectorImpl<uint64_t> &Record, 332 unsigned Abbrev); 333 void writeDIMacro(const DIMacro *N, SmallVectorImpl<uint64_t> &Record, 334 unsigned Abbrev); 335 void writeDIMacroFile(const DIMacroFile *N, SmallVectorImpl<uint64_t> &Record, 336 unsigned Abbrev); 337 void writeDIArgList(const DIArgList *N, SmallVectorImpl<uint64_t> &Record, 338 unsigned Abbrev); 339 void writeDIModule(const DIModule *N, SmallVectorImpl<uint64_t> &Record, 340 unsigned Abbrev); 341 void writeDITemplateTypeParameter(const DITemplateTypeParameter *N, 342 SmallVectorImpl<uint64_t> &Record, 343 unsigned Abbrev); 344 void writeDITemplateValueParameter(const DITemplateValueParameter *N, 345 SmallVectorImpl<uint64_t> &Record, 346 unsigned Abbrev); 347 void writeDIGlobalVariable(const DIGlobalVariable *N, 348 SmallVectorImpl<uint64_t> &Record, 349 unsigned Abbrev); 350 void writeDILocalVariable(const DILocalVariable *N, 351 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 352 void writeDILabel(const DILabel *N, 353 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 354 void writeDIExpression(const DIExpression *N, 355 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 356 void writeDIGlobalVariableExpression(const DIGlobalVariableExpression *N, 357 SmallVectorImpl<uint64_t> &Record, 358 unsigned Abbrev); 359 void writeDIObjCProperty(const DIObjCProperty *N, 360 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev); 361 void writeDIImportedEntity(const DIImportedEntity *N, 362 SmallVectorImpl<uint64_t> &Record, 363 unsigned Abbrev); 364 unsigned createNamedMetadataAbbrev(); 365 void writeNamedMetadata(SmallVectorImpl<uint64_t> &Record); 366 unsigned createMetadataStringsAbbrev(); 367 void writeMetadataStrings(ArrayRef<const Metadata *> Strings, 368 SmallVectorImpl<uint64_t> &Record); 369 void writeMetadataRecords(ArrayRef<const Metadata *> MDs, 370 SmallVectorImpl<uint64_t> &Record, 371 std::vector<unsigned> *MDAbbrevs = nullptr, 372 std::vector<uint64_t> *IndexPos = nullptr); 373 void writeModuleMetadata(); 374 void writeFunctionMetadata(const Function &F); 375 void writeFunctionMetadataAttachment(const Function &F); 376 void pushGlobalMetadataAttachment(SmallVectorImpl<uint64_t> &Record, 377 const GlobalObject &GO); 378 void writeModuleMetadataKinds(); 379 void writeOperandBundleTags(); 380 void writeSyncScopeNames(); 381 void writeConstants(unsigned FirstVal, unsigned LastVal, bool isGlobal); 382 void writeModuleConstants(); 383 bool pushValueAndType(const Value *V, unsigned InstID, 384 SmallVectorImpl<unsigned> &Vals); 385 void writeOperandBundles(const CallBase &CB, unsigned InstID); 386 void pushValue(const Value *V, unsigned InstID, 387 SmallVectorImpl<unsigned> &Vals); 388 void pushValueSigned(const Value *V, unsigned InstID, 389 SmallVectorImpl<uint64_t> &Vals); 390 void writeInstruction(const Instruction &I, unsigned InstID, 391 SmallVectorImpl<unsigned> &Vals); 392 void writeFunctionLevelValueSymbolTable(const ValueSymbolTable &VST); 393 void writeGlobalValueSymbolTable( 394 DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex); 395 void writeUseList(UseListOrder &&Order); 396 void writeUseListBlock(const Function *F); 397 void 398 writeFunction(const Function &F, 399 DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex); 400 void writeBlockInfo(); 401 void writeModuleHash(size_t BlockStartPos); 402 403 unsigned getEncodedSyncScopeID(SyncScope::ID SSID) { 404 return unsigned(SSID); 405 } 406 407 unsigned getEncodedAlign(MaybeAlign Alignment) { return encode(Alignment); } 408 }; 409 410 /// Class to manage the bitcode writing for a combined index. 411 class IndexBitcodeWriter : public BitcodeWriterBase { 412 /// The combined index to write to bitcode. 413 const ModuleSummaryIndex &Index; 414 415 /// When writing a subset of the index for distributed backends, client 416 /// provides a map of modules to the corresponding GUIDs/summaries to write. 417 const std::map<std::string, GVSummaryMapTy> *ModuleToSummariesForIndex; 418 419 /// Map that holds the correspondence between the GUID used in the combined 420 /// index and a value id generated by this class to use in references. 421 std::map<GlobalValue::GUID, unsigned> GUIDToValueIdMap; 422 423 /// Tracks the last value id recorded in the GUIDToValueMap. 424 unsigned GlobalValueId = 0; 425 426 public: 427 /// Constructs a IndexBitcodeWriter object for the given combined index, 428 /// writing to the provided \p Buffer. When writing a subset of the index 429 /// for a distributed backend, provide a \p ModuleToSummariesForIndex map. 430 IndexBitcodeWriter(BitstreamWriter &Stream, StringTableBuilder &StrtabBuilder, 431 const ModuleSummaryIndex &Index, 432 const std::map<std::string, GVSummaryMapTy> 433 *ModuleToSummariesForIndex = nullptr) 434 : BitcodeWriterBase(Stream, StrtabBuilder), Index(Index), 435 ModuleToSummariesForIndex(ModuleToSummariesForIndex) { 436 // Assign unique value ids to all summaries to be written, for use 437 // in writing out the call graph edges. Save the mapping from GUID 438 // to the new global value id to use when writing those edges, which 439 // are currently saved in the index in terms of GUID. 440 forEachSummary([&](GVInfo I, bool) { 441 GUIDToValueIdMap[I.first] = ++GlobalValueId; 442 }); 443 } 444 445 /// The below iterator returns the GUID and associated summary. 446 using GVInfo = std::pair<GlobalValue::GUID, GlobalValueSummary *>; 447 448 /// Calls the callback for each value GUID and summary to be written to 449 /// bitcode. This hides the details of whether they are being pulled from the 450 /// entire index or just those in a provided ModuleToSummariesForIndex map. 451 template<typename Functor> 452 void forEachSummary(Functor Callback) { 453 if (ModuleToSummariesForIndex) { 454 for (auto &M : *ModuleToSummariesForIndex) 455 for (auto &Summary : M.second) { 456 Callback(Summary, false); 457 // Ensure aliasee is handled, e.g. for assigning a valueId, 458 // even if we are not importing the aliasee directly (the 459 // imported alias will contain a copy of aliasee). 460 if (auto *AS = dyn_cast<AliasSummary>(Summary.getSecond())) 461 Callback({AS->getAliaseeGUID(), &AS->getAliasee()}, true); 462 } 463 } else { 464 for (auto &Summaries : Index) 465 for (auto &Summary : Summaries.second.SummaryList) 466 Callback({Summaries.first, Summary.get()}, false); 467 } 468 } 469 470 /// Calls the callback for each entry in the modulePaths StringMap that 471 /// should be written to the module path string table. This hides the details 472 /// of whether they are being pulled from the entire index or just those in a 473 /// provided ModuleToSummariesForIndex map. 474 template <typename Functor> void forEachModule(Functor Callback) { 475 if (ModuleToSummariesForIndex) { 476 for (const auto &M : *ModuleToSummariesForIndex) { 477 const auto &MPI = Index.modulePaths().find(M.first); 478 if (MPI == Index.modulePaths().end()) { 479 // This should only happen if the bitcode file was empty, in which 480 // case we shouldn't be importing (the ModuleToSummariesForIndex 481 // would only include the module we are writing and index for). 482 assert(ModuleToSummariesForIndex->size() == 1); 483 continue; 484 } 485 Callback(*MPI); 486 } 487 } else { 488 for (const auto &MPSE : Index.modulePaths()) 489 Callback(MPSE); 490 } 491 } 492 493 /// Main entry point for writing a combined index to bitcode. 494 void write(); 495 496 private: 497 void writeModStrings(); 498 void writeCombinedGlobalValueSummary(); 499 500 Optional<unsigned> getValueId(GlobalValue::GUID ValGUID) { 501 auto VMI = GUIDToValueIdMap.find(ValGUID); 502 if (VMI == GUIDToValueIdMap.end()) 503 return None; 504 return VMI->second; 505 } 506 507 std::map<GlobalValue::GUID, unsigned> &valueIds() { return GUIDToValueIdMap; } 508 }; 509 510 } // end anonymous namespace 511 512 static unsigned getEncodedCastOpcode(unsigned Opcode) { 513 switch (Opcode) { 514 default: llvm_unreachable("Unknown cast instruction!"); 515 case Instruction::Trunc : return bitc::CAST_TRUNC; 516 case Instruction::ZExt : return bitc::CAST_ZEXT; 517 case Instruction::SExt : return bitc::CAST_SEXT; 518 case Instruction::FPToUI : return bitc::CAST_FPTOUI; 519 case Instruction::FPToSI : return bitc::CAST_FPTOSI; 520 case Instruction::UIToFP : return bitc::CAST_UITOFP; 521 case Instruction::SIToFP : return bitc::CAST_SITOFP; 522 case Instruction::FPTrunc : return bitc::CAST_FPTRUNC; 523 case Instruction::FPExt : return bitc::CAST_FPEXT; 524 case Instruction::PtrToInt: return bitc::CAST_PTRTOINT; 525 case Instruction::IntToPtr: return bitc::CAST_INTTOPTR; 526 case Instruction::BitCast : return bitc::CAST_BITCAST; 527 case Instruction::AddrSpaceCast: return bitc::CAST_ADDRSPACECAST; 528 } 529 } 530 531 static unsigned getEncodedUnaryOpcode(unsigned Opcode) { 532 switch (Opcode) { 533 default: llvm_unreachable("Unknown binary instruction!"); 534 case Instruction::FNeg: return bitc::UNOP_FNEG; 535 } 536 } 537 538 static unsigned getEncodedBinaryOpcode(unsigned Opcode) { 539 switch (Opcode) { 540 default: llvm_unreachable("Unknown binary instruction!"); 541 case Instruction::Add: 542 case Instruction::FAdd: return bitc::BINOP_ADD; 543 case Instruction::Sub: 544 case Instruction::FSub: return bitc::BINOP_SUB; 545 case Instruction::Mul: 546 case Instruction::FMul: return bitc::BINOP_MUL; 547 case Instruction::UDiv: return bitc::BINOP_UDIV; 548 case Instruction::FDiv: 549 case Instruction::SDiv: return bitc::BINOP_SDIV; 550 case Instruction::URem: return bitc::BINOP_UREM; 551 case Instruction::FRem: 552 case Instruction::SRem: return bitc::BINOP_SREM; 553 case Instruction::Shl: return bitc::BINOP_SHL; 554 case Instruction::LShr: return bitc::BINOP_LSHR; 555 case Instruction::AShr: return bitc::BINOP_ASHR; 556 case Instruction::And: return bitc::BINOP_AND; 557 case Instruction::Or: return bitc::BINOP_OR; 558 case Instruction::Xor: return bitc::BINOP_XOR; 559 } 560 } 561 562 static unsigned getEncodedRMWOperation(AtomicRMWInst::BinOp Op) { 563 switch (Op) { 564 default: llvm_unreachable("Unknown RMW operation!"); 565 case AtomicRMWInst::Xchg: return bitc::RMW_XCHG; 566 case AtomicRMWInst::Add: return bitc::RMW_ADD; 567 case AtomicRMWInst::Sub: return bitc::RMW_SUB; 568 case AtomicRMWInst::And: return bitc::RMW_AND; 569 case AtomicRMWInst::Nand: return bitc::RMW_NAND; 570 case AtomicRMWInst::Or: return bitc::RMW_OR; 571 case AtomicRMWInst::Xor: return bitc::RMW_XOR; 572 case AtomicRMWInst::Max: return bitc::RMW_MAX; 573 case AtomicRMWInst::Min: return bitc::RMW_MIN; 574 case AtomicRMWInst::UMax: return bitc::RMW_UMAX; 575 case AtomicRMWInst::UMin: return bitc::RMW_UMIN; 576 case AtomicRMWInst::FAdd: return bitc::RMW_FADD; 577 case AtomicRMWInst::FSub: return bitc::RMW_FSUB; 578 } 579 } 580 581 static unsigned getEncodedOrdering(AtomicOrdering Ordering) { 582 switch (Ordering) { 583 case AtomicOrdering::NotAtomic: return bitc::ORDERING_NOTATOMIC; 584 case AtomicOrdering::Unordered: return bitc::ORDERING_UNORDERED; 585 case AtomicOrdering::Monotonic: return bitc::ORDERING_MONOTONIC; 586 case AtomicOrdering::Acquire: return bitc::ORDERING_ACQUIRE; 587 case AtomicOrdering::Release: return bitc::ORDERING_RELEASE; 588 case AtomicOrdering::AcquireRelease: return bitc::ORDERING_ACQREL; 589 case AtomicOrdering::SequentiallyConsistent: return bitc::ORDERING_SEQCST; 590 } 591 llvm_unreachable("Invalid ordering"); 592 } 593 594 static void writeStringRecord(BitstreamWriter &Stream, unsigned Code, 595 StringRef Str, unsigned AbbrevToUse) { 596 SmallVector<unsigned, 64> Vals; 597 598 // Code: [strchar x N] 599 for (unsigned i = 0, e = Str.size(); i != e; ++i) { 600 if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(Str[i])) 601 AbbrevToUse = 0; 602 Vals.push_back(Str[i]); 603 } 604 605 // Emit the finished record. 606 Stream.EmitRecord(Code, Vals, AbbrevToUse); 607 } 608 609 static uint64_t getAttrKindEncoding(Attribute::AttrKind Kind) { 610 switch (Kind) { 611 case Attribute::Alignment: 612 return bitc::ATTR_KIND_ALIGNMENT; 613 case Attribute::AllocSize: 614 return bitc::ATTR_KIND_ALLOC_SIZE; 615 case Attribute::AlwaysInline: 616 return bitc::ATTR_KIND_ALWAYS_INLINE; 617 case Attribute::ArgMemOnly: 618 return bitc::ATTR_KIND_ARGMEMONLY; 619 case Attribute::Builtin: 620 return bitc::ATTR_KIND_BUILTIN; 621 case Attribute::ByVal: 622 return bitc::ATTR_KIND_BY_VAL; 623 case Attribute::Convergent: 624 return bitc::ATTR_KIND_CONVERGENT; 625 case Attribute::InAlloca: 626 return bitc::ATTR_KIND_IN_ALLOCA; 627 case Attribute::Cold: 628 return bitc::ATTR_KIND_COLD; 629 case Attribute::DisableSanitizerInstrumentation: 630 return bitc::ATTR_KIND_DISABLE_SANITIZER_INSTRUMENTATION; 631 case Attribute::Hot: 632 return bitc::ATTR_KIND_HOT; 633 case Attribute::ElementType: 634 return bitc::ATTR_KIND_ELEMENTTYPE; 635 case Attribute::InaccessibleMemOnly: 636 return bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY; 637 case Attribute::InaccessibleMemOrArgMemOnly: 638 return bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY; 639 case Attribute::InlineHint: 640 return bitc::ATTR_KIND_INLINE_HINT; 641 case Attribute::InReg: 642 return bitc::ATTR_KIND_IN_REG; 643 case Attribute::JumpTable: 644 return bitc::ATTR_KIND_JUMP_TABLE; 645 case Attribute::MinSize: 646 return bitc::ATTR_KIND_MIN_SIZE; 647 case Attribute::Naked: 648 return bitc::ATTR_KIND_NAKED; 649 case Attribute::Nest: 650 return bitc::ATTR_KIND_NEST; 651 case Attribute::NoAlias: 652 return bitc::ATTR_KIND_NO_ALIAS; 653 case Attribute::NoBuiltin: 654 return bitc::ATTR_KIND_NO_BUILTIN; 655 case Attribute::NoCallback: 656 return bitc::ATTR_KIND_NO_CALLBACK; 657 case Attribute::NoCapture: 658 return bitc::ATTR_KIND_NO_CAPTURE; 659 case Attribute::NoDuplicate: 660 return bitc::ATTR_KIND_NO_DUPLICATE; 661 case Attribute::NoFree: 662 return bitc::ATTR_KIND_NOFREE; 663 case Attribute::NoImplicitFloat: 664 return bitc::ATTR_KIND_NO_IMPLICIT_FLOAT; 665 case Attribute::NoInline: 666 return bitc::ATTR_KIND_NO_INLINE; 667 case Attribute::NoRecurse: 668 return bitc::ATTR_KIND_NO_RECURSE; 669 case Attribute::NoMerge: 670 return bitc::ATTR_KIND_NO_MERGE; 671 case Attribute::NonLazyBind: 672 return bitc::ATTR_KIND_NON_LAZY_BIND; 673 case Attribute::NonNull: 674 return bitc::ATTR_KIND_NON_NULL; 675 case Attribute::Dereferenceable: 676 return bitc::ATTR_KIND_DEREFERENCEABLE; 677 case Attribute::DereferenceableOrNull: 678 return bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL; 679 case Attribute::NoRedZone: 680 return bitc::ATTR_KIND_NO_RED_ZONE; 681 case Attribute::NoReturn: 682 return bitc::ATTR_KIND_NO_RETURN; 683 case Attribute::NoSync: 684 return bitc::ATTR_KIND_NOSYNC; 685 case Attribute::NoCfCheck: 686 return bitc::ATTR_KIND_NOCF_CHECK; 687 case Attribute::NoProfile: 688 return bitc::ATTR_KIND_NO_PROFILE; 689 case Attribute::NoUnwind: 690 return bitc::ATTR_KIND_NO_UNWIND; 691 case Attribute::NoSanitizeCoverage: 692 return bitc::ATTR_KIND_NO_SANITIZE_COVERAGE; 693 case Attribute::NullPointerIsValid: 694 return bitc::ATTR_KIND_NULL_POINTER_IS_VALID; 695 case Attribute::OptForFuzzing: 696 return bitc::ATTR_KIND_OPT_FOR_FUZZING; 697 case Attribute::OptimizeForSize: 698 return bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE; 699 case Attribute::OptimizeNone: 700 return bitc::ATTR_KIND_OPTIMIZE_NONE; 701 case Attribute::ReadNone: 702 return bitc::ATTR_KIND_READ_NONE; 703 case Attribute::ReadOnly: 704 return bitc::ATTR_KIND_READ_ONLY; 705 case Attribute::Returned: 706 return bitc::ATTR_KIND_RETURNED; 707 case Attribute::ReturnsTwice: 708 return bitc::ATTR_KIND_RETURNS_TWICE; 709 case Attribute::SExt: 710 return bitc::ATTR_KIND_S_EXT; 711 case Attribute::Speculatable: 712 return bitc::ATTR_KIND_SPECULATABLE; 713 case Attribute::StackAlignment: 714 return bitc::ATTR_KIND_STACK_ALIGNMENT; 715 case Attribute::StackProtect: 716 return bitc::ATTR_KIND_STACK_PROTECT; 717 case Attribute::StackProtectReq: 718 return bitc::ATTR_KIND_STACK_PROTECT_REQ; 719 case Attribute::StackProtectStrong: 720 return bitc::ATTR_KIND_STACK_PROTECT_STRONG; 721 case Attribute::SafeStack: 722 return bitc::ATTR_KIND_SAFESTACK; 723 case Attribute::ShadowCallStack: 724 return bitc::ATTR_KIND_SHADOWCALLSTACK; 725 case Attribute::StrictFP: 726 return bitc::ATTR_KIND_STRICT_FP; 727 case Attribute::StructRet: 728 return bitc::ATTR_KIND_STRUCT_RET; 729 case Attribute::SanitizeAddress: 730 return bitc::ATTR_KIND_SANITIZE_ADDRESS; 731 case Attribute::SanitizeHWAddress: 732 return bitc::ATTR_KIND_SANITIZE_HWADDRESS; 733 case Attribute::SanitizeThread: 734 return bitc::ATTR_KIND_SANITIZE_THREAD; 735 case Attribute::SanitizeMemory: 736 return bitc::ATTR_KIND_SANITIZE_MEMORY; 737 case Attribute::SpeculativeLoadHardening: 738 return bitc::ATTR_KIND_SPECULATIVE_LOAD_HARDENING; 739 case Attribute::SwiftError: 740 return bitc::ATTR_KIND_SWIFT_ERROR; 741 case Attribute::SwiftSelf: 742 return bitc::ATTR_KIND_SWIFT_SELF; 743 case Attribute::SwiftAsync: 744 return bitc::ATTR_KIND_SWIFT_ASYNC; 745 case Attribute::UWTable: 746 return bitc::ATTR_KIND_UW_TABLE; 747 case Attribute::VScaleRange: 748 return bitc::ATTR_KIND_VSCALE_RANGE; 749 case Attribute::WillReturn: 750 return bitc::ATTR_KIND_WILLRETURN; 751 case Attribute::WriteOnly: 752 return bitc::ATTR_KIND_WRITEONLY; 753 case Attribute::ZExt: 754 return bitc::ATTR_KIND_Z_EXT; 755 case Attribute::ImmArg: 756 return bitc::ATTR_KIND_IMMARG; 757 case Attribute::SanitizeMemTag: 758 return bitc::ATTR_KIND_SANITIZE_MEMTAG; 759 case Attribute::Preallocated: 760 return bitc::ATTR_KIND_PREALLOCATED; 761 case Attribute::NoUndef: 762 return bitc::ATTR_KIND_NOUNDEF; 763 case Attribute::ByRef: 764 return bitc::ATTR_KIND_BYREF; 765 case Attribute::MustProgress: 766 return bitc::ATTR_KIND_MUSTPROGRESS; 767 case Attribute::EndAttrKinds: 768 llvm_unreachable("Can not encode end-attribute kinds marker."); 769 case Attribute::None: 770 llvm_unreachable("Can not encode none-attribute."); 771 case Attribute::EmptyKey: 772 case Attribute::TombstoneKey: 773 llvm_unreachable("Trying to encode EmptyKey/TombstoneKey"); 774 } 775 776 llvm_unreachable("Trying to encode unknown attribute"); 777 } 778 779 void ModuleBitcodeWriter::writeAttributeGroupTable() { 780 const std::vector<ValueEnumerator::IndexAndAttrSet> &AttrGrps = 781 VE.getAttributeGroups(); 782 if (AttrGrps.empty()) return; 783 784 Stream.EnterSubblock(bitc::PARAMATTR_GROUP_BLOCK_ID, 3); 785 786 SmallVector<uint64_t, 64> Record; 787 for (ValueEnumerator::IndexAndAttrSet Pair : AttrGrps) { 788 unsigned AttrListIndex = Pair.first; 789 AttributeSet AS = Pair.second; 790 Record.push_back(VE.getAttributeGroupID(Pair)); 791 Record.push_back(AttrListIndex); 792 793 for (Attribute Attr : AS) { 794 if (Attr.isEnumAttribute()) { 795 Record.push_back(0); 796 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum())); 797 } else if (Attr.isIntAttribute()) { 798 Record.push_back(1); 799 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum())); 800 Record.push_back(Attr.getValueAsInt()); 801 } else if (Attr.isStringAttribute()) { 802 StringRef Kind = Attr.getKindAsString(); 803 StringRef Val = Attr.getValueAsString(); 804 805 Record.push_back(Val.empty() ? 3 : 4); 806 Record.append(Kind.begin(), Kind.end()); 807 Record.push_back(0); 808 if (!Val.empty()) { 809 Record.append(Val.begin(), Val.end()); 810 Record.push_back(0); 811 } 812 } else { 813 assert(Attr.isTypeAttribute()); 814 Type *Ty = Attr.getValueAsType(); 815 Record.push_back(Ty ? 6 : 5); 816 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum())); 817 if (Ty) 818 Record.push_back(VE.getTypeID(Attr.getValueAsType())); 819 } 820 } 821 822 Stream.EmitRecord(bitc::PARAMATTR_GRP_CODE_ENTRY, Record); 823 Record.clear(); 824 } 825 826 Stream.ExitBlock(); 827 } 828 829 void ModuleBitcodeWriter::writeAttributeTable() { 830 const std::vector<AttributeList> &Attrs = VE.getAttributeLists(); 831 if (Attrs.empty()) return; 832 833 Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3); 834 835 SmallVector<uint64_t, 64> Record; 836 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) { 837 AttributeList AL = Attrs[i]; 838 for (unsigned i : AL.indexes()) { 839 AttributeSet AS = AL.getAttributes(i); 840 if (AS.hasAttributes()) 841 Record.push_back(VE.getAttributeGroupID({i, AS})); 842 } 843 844 Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record); 845 Record.clear(); 846 } 847 848 Stream.ExitBlock(); 849 } 850 851 /// WriteTypeTable - Write out the type table for a module. 852 void ModuleBitcodeWriter::writeTypeTable() { 853 const ValueEnumerator::TypeList &TypeList = VE.getTypes(); 854 855 Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */); 856 SmallVector<uint64_t, 64> TypeVals; 857 858 uint64_t NumBits = VE.computeBitsRequiredForTypeIndicies(); 859 860 // Abbrev for TYPE_CODE_POINTER. 861 auto Abbv = std::make_shared<BitCodeAbbrev>(); 862 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER)); 863 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits)); 864 Abbv->Add(BitCodeAbbrevOp(0)); // Addrspace = 0 865 unsigned PtrAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 866 867 // Abbrev for TYPE_CODE_OPAQUE_POINTER. 868 Abbv = std::make_shared<BitCodeAbbrev>(); 869 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_OPAQUE_POINTER)); 870 Abbv->Add(BitCodeAbbrevOp(0)); // Addrspace = 0 871 unsigned OpaquePtrAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 872 873 // Abbrev for TYPE_CODE_FUNCTION. 874 Abbv = std::make_shared<BitCodeAbbrev>(); 875 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION)); 876 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isvararg 877 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 878 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits)); 879 unsigned FunctionAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 880 881 // Abbrev for TYPE_CODE_STRUCT_ANON. 882 Abbv = std::make_shared<BitCodeAbbrev>(); 883 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON)); 884 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked 885 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 886 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits)); 887 unsigned StructAnonAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 888 889 // Abbrev for TYPE_CODE_STRUCT_NAME. 890 Abbv = std::make_shared<BitCodeAbbrev>(); 891 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME)); 892 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 893 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6)); 894 unsigned StructNameAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 895 896 // Abbrev for TYPE_CODE_STRUCT_NAMED. 897 Abbv = std::make_shared<BitCodeAbbrev>(); 898 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED)); 899 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked 900 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 901 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits)); 902 unsigned StructNamedAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 903 904 // Abbrev for TYPE_CODE_ARRAY. 905 Abbv = std::make_shared<BitCodeAbbrev>(); 906 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY)); 907 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // size 908 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits)); 909 unsigned ArrayAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 910 911 // Emit an entry count so the reader can reserve space. 912 TypeVals.push_back(TypeList.size()); 913 Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals); 914 TypeVals.clear(); 915 916 // Loop over all of the types, emitting each in turn. 917 for (unsigned i = 0, e = TypeList.size(); i != e; ++i) { 918 Type *T = TypeList[i]; 919 int AbbrevToUse = 0; 920 unsigned Code = 0; 921 922 switch (T->getTypeID()) { 923 case Type::VoidTyID: Code = bitc::TYPE_CODE_VOID; break; 924 case Type::HalfTyID: Code = bitc::TYPE_CODE_HALF; break; 925 case Type::BFloatTyID: Code = bitc::TYPE_CODE_BFLOAT; break; 926 case Type::FloatTyID: Code = bitc::TYPE_CODE_FLOAT; break; 927 case Type::DoubleTyID: Code = bitc::TYPE_CODE_DOUBLE; break; 928 case Type::X86_FP80TyID: Code = bitc::TYPE_CODE_X86_FP80; break; 929 case Type::FP128TyID: Code = bitc::TYPE_CODE_FP128; break; 930 case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break; 931 case Type::LabelTyID: Code = bitc::TYPE_CODE_LABEL; break; 932 case Type::MetadataTyID: Code = bitc::TYPE_CODE_METADATA; break; 933 case Type::X86_MMXTyID: Code = bitc::TYPE_CODE_X86_MMX; break; 934 case Type::X86_AMXTyID: Code = bitc::TYPE_CODE_X86_AMX; break; 935 case Type::TokenTyID: Code = bitc::TYPE_CODE_TOKEN; break; 936 case Type::IntegerTyID: 937 // INTEGER: [width] 938 Code = bitc::TYPE_CODE_INTEGER; 939 TypeVals.push_back(cast<IntegerType>(T)->getBitWidth()); 940 break; 941 case Type::PointerTyID: { 942 PointerType *PTy = cast<PointerType>(T); 943 unsigned AddressSpace = PTy->getAddressSpace(); 944 if (PTy->isOpaque()) { 945 // OPAQUE_POINTER: [address space] 946 Code = bitc::TYPE_CODE_OPAQUE_POINTER; 947 TypeVals.push_back(AddressSpace); 948 if (AddressSpace == 0) 949 AbbrevToUse = OpaquePtrAbbrev; 950 } else { 951 // POINTER: [pointee type, address space] 952 Code = bitc::TYPE_CODE_POINTER; 953 TypeVals.push_back(VE.getTypeID(PTy->getElementType())); 954 TypeVals.push_back(AddressSpace); 955 if (AddressSpace == 0) 956 AbbrevToUse = PtrAbbrev; 957 } 958 break; 959 } 960 case Type::FunctionTyID: { 961 FunctionType *FT = cast<FunctionType>(T); 962 // FUNCTION: [isvararg, retty, paramty x N] 963 Code = bitc::TYPE_CODE_FUNCTION; 964 TypeVals.push_back(FT->isVarArg()); 965 TypeVals.push_back(VE.getTypeID(FT->getReturnType())); 966 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) 967 TypeVals.push_back(VE.getTypeID(FT->getParamType(i))); 968 AbbrevToUse = FunctionAbbrev; 969 break; 970 } 971 case Type::StructTyID: { 972 StructType *ST = cast<StructType>(T); 973 // STRUCT: [ispacked, eltty x N] 974 TypeVals.push_back(ST->isPacked()); 975 // Output all of the element types. 976 for (StructType::element_iterator I = ST->element_begin(), 977 E = ST->element_end(); I != E; ++I) 978 TypeVals.push_back(VE.getTypeID(*I)); 979 980 if (ST->isLiteral()) { 981 Code = bitc::TYPE_CODE_STRUCT_ANON; 982 AbbrevToUse = StructAnonAbbrev; 983 } else { 984 if (ST->isOpaque()) { 985 Code = bitc::TYPE_CODE_OPAQUE; 986 } else { 987 Code = bitc::TYPE_CODE_STRUCT_NAMED; 988 AbbrevToUse = StructNamedAbbrev; 989 } 990 991 // Emit the name if it is present. 992 if (!ST->getName().empty()) 993 writeStringRecord(Stream, bitc::TYPE_CODE_STRUCT_NAME, ST->getName(), 994 StructNameAbbrev); 995 } 996 break; 997 } 998 case Type::ArrayTyID: { 999 ArrayType *AT = cast<ArrayType>(T); 1000 // ARRAY: [numelts, eltty] 1001 Code = bitc::TYPE_CODE_ARRAY; 1002 TypeVals.push_back(AT->getNumElements()); 1003 TypeVals.push_back(VE.getTypeID(AT->getElementType())); 1004 AbbrevToUse = ArrayAbbrev; 1005 break; 1006 } 1007 case Type::FixedVectorTyID: 1008 case Type::ScalableVectorTyID: { 1009 VectorType *VT = cast<VectorType>(T); 1010 // VECTOR [numelts, eltty] or 1011 // [numelts, eltty, scalable] 1012 Code = bitc::TYPE_CODE_VECTOR; 1013 TypeVals.push_back(VT->getElementCount().getKnownMinValue()); 1014 TypeVals.push_back(VE.getTypeID(VT->getElementType())); 1015 if (isa<ScalableVectorType>(VT)) 1016 TypeVals.push_back(true); 1017 break; 1018 } 1019 } 1020 1021 // Emit the finished record. 1022 Stream.EmitRecord(Code, TypeVals, AbbrevToUse); 1023 TypeVals.clear(); 1024 } 1025 1026 Stream.ExitBlock(); 1027 } 1028 1029 static unsigned getEncodedLinkage(const GlobalValue::LinkageTypes Linkage) { 1030 switch (Linkage) { 1031 case GlobalValue::ExternalLinkage: 1032 return 0; 1033 case GlobalValue::WeakAnyLinkage: 1034 return 16; 1035 case GlobalValue::AppendingLinkage: 1036 return 2; 1037 case GlobalValue::InternalLinkage: 1038 return 3; 1039 case GlobalValue::LinkOnceAnyLinkage: 1040 return 18; 1041 case GlobalValue::ExternalWeakLinkage: 1042 return 7; 1043 case GlobalValue::CommonLinkage: 1044 return 8; 1045 case GlobalValue::PrivateLinkage: 1046 return 9; 1047 case GlobalValue::WeakODRLinkage: 1048 return 17; 1049 case GlobalValue::LinkOnceODRLinkage: 1050 return 19; 1051 case GlobalValue::AvailableExternallyLinkage: 1052 return 12; 1053 } 1054 llvm_unreachable("Invalid linkage"); 1055 } 1056 1057 static unsigned getEncodedLinkage(const GlobalValue &GV) { 1058 return getEncodedLinkage(GV.getLinkage()); 1059 } 1060 1061 static uint64_t getEncodedFFlags(FunctionSummary::FFlags Flags) { 1062 uint64_t RawFlags = 0; 1063 RawFlags |= Flags.ReadNone; 1064 RawFlags |= (Flags.ReadOnly << 1); 1065 RawFlags |= (Flags.NoRecurse << 2); 1066 RawFlags |= (Flags.ReturnDoesNotAlias << 3); 1067 RawFlags |= (Flags.NoInline << 4); 1068 RawFlags |= (Flags.AlwaysInline << 5); 1069 RawFlags |= (Flags.NoUnwind << 6); 1070 RawFlags |= (Flags.MayThrow << 7); 1071 RawFlags |= (Flags.HasUnknownCall << 8); 1072 return RawFlags; 1073 } 1074 1075 // Decode the flags for GlobalValue in the summary. See getDecodedGVSummaryFlags 1076 // in BitcodeReader.cpp. 1077 static uint64_t getEncodedGVSummaryFlags(GlobalValueSummary::GVFlags Flags) { 1078 uint64_t RawFlags = 0; 1079 1080 RawFlags |= Flags.NotEligibleToImport; // bool 1081 RawFlags |= (Flags.Live << 1); 1082 RawFlags |= (Flags.DSOLocal << 2); 1083 RawFlags |= (Flags.CanAutoHide << 3); 1084 1085 // Linkage don't need to be remapped at that time for the summary. Any future 1086 // change to the getEncodedLinkage() function will need to be taken into 1087 // account here as well. 1088 RawFlags = (RawFlags << 4) | Flags.Linkage; // 4 bits 1089 1090 RawFlags |= (Flags.Visibility << 8); // 2 bits 1091 1092 return RawFlags; 1093 } 1094 1095 static uint64_t getEncodedGVarFlags(GlobalVarSummary::GVarFlags Flags) { 1096 uint64_t RawFlags = Flags.MaybeReadOnly | (Flags.MaybeWriteOnly << 1) | 1097 (Flags.Constant << 2) | Flags.VCallVisibility << 3; 1098 return RawFlags; 1099 } 1100 1101 static unsigned getEncodedVisibility(const GlobalValue &GV) { 1102 switch (GV.getVisibility()) { 1103 case GlobalValue::DefaultVisibility: return 0; 1104 case GlobalValue::HiddenVisibility: return 1; 1105 case GlobalValue::ProtectedVisibility: return 2; 1106 } 1107 llvm_unreachable("Invalid visibility"); 1108 } 1109 1110 static unsigned getEncodedDLLStorageClass(const GlobalValue &GV) { 1111 switch (GV.getDLLStorageClass()) { 1112 case GlobalValue::DefaultStorageClass: return 0; 1113 case GlobalValue::DLLImportStorageClass: return 1; 1114 case GlobalValue::DLLExportStorageClass: return 2; 1115 } 1116 llvm_unreachable("Invalid DLL storage class"); 1117 } 1118 1119 static unsigned getEncodedThreadLocalMode(const GlobalValue &GV) { 1120 switch (GV.getThreadLocalMode()) { 1121 case GlobalVariable::NotThreadLocal: return 0; 1122 case GlobalVariable::GeneralDynamicTLSModel: return 1; 1123 case GlobalVariable::LocalDynamicTLSModel: return 2; 1124 case GlobalVariable::InitialExecTLSModel: return 3; 1125 case GlobalVariable::LocalExecTLSModel: return 4; 1126 } 1127 llvm_unreachable("Invalid TLS model"); 1128 } 1129 1130 static unsigned getEncodedComdatSelectionKind(const Comdat &C) { 1131 switch (C.getSelectionKind()) { 1132 case Comdat::Any: 1133 return bitc::COMDAT_SELECTION_KIND_ANY; 1134 case Comdat::ExactMatch: 1135 return bitc::COMDAT_SELECTION_KIND_EXACT_MATCH; 1136 case Comdat::Largest: 1137 return bitc::COMDAT_SELECTION_KIND_LARGEST; 1138 case Comdat::NoDeduplicate: 1139 return bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES; 1140 case Comdat::SameSize: 1141 return bitc::COMDAT_SELECTION_KIND_SAME_SIZE; 1142 } 1143 llvm_unreachable("Invalid selection kind"); 1144 } 1145 1146 static unsigned getEncodedUnnamedAddr(const GlobalValue &GV) { 1147 switch (GV.getUnnamedAddr()) { 1148 case GlobalValue::UnnamedAddr::None: return 0; 1149 case GlobalValue::UnnamedAddr::Local: return 2; 1150 case GlobalValue::UnnamedAddr::Global: return 1; 1151 } 1152 llvm_unreachable("Invalid unnamed_addr"); 1153 } 1154 1155 size_t ModuleBitcodeWriter::addToStrtab(StringRef Str) { 1156 if (GenerateHash) 1157 Hasher.update(Str); 1158 return StrtabBuilder.add(Str); 1159 } 1160 1161 void ModuleBitcodeWriter::writeComdats() { 1162 SmallVector<unsigned, 64> Vals; 1163 for (const Comdat *C : VE.getComdats()) { 1164 // COMDAT: [strtab offset, strtab size, selection_kind] 1165 Vals.push_back(addToStrtab(C->getName())); 1166 Vals.push_back(C->getName().size()); 1167 Vals.push_back(getEncodedComdatSelectionKind(*C)); 1168 Stream.EmitRecord(bitc::MODULE_CODE_COMDAT, Vals, /*AbbrevToUse=*/0); 1169 Vals.clear(); 1170 } 1171 } 1172 1173 /// Write a record that will eventually hold the word offset of the 1174 /// module-level VST. For now the offset is 0, which will be backpatched 1175 /// after the real VST is written. Saves the bit offset to backpatch. 1176 void ModuleBitcodeWriter::writeValueSymbolTableForwardDecl() { 1177 // Write a placeholder value in for the offset of the real VST, 1178 // which is written after the function blocks so that it can include 1179 // the offset of each function. The placeholder offset will be 1180 // updated when the real VST is written. 1181 auto Abbv = std::make_shared<BitCodeAbbrev>(); 1182 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_VSTOFFSET)); 1183 // Blocks are 32-bit aligned, so we can use a 32-bit word offset to 1184 // hold the real VST offset. Must use fixed instead of VBR as we don't 1185 // know how many VBR chunks to reserve ahead of time. 1186 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 1187 unsigned VSTOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 1188 1189 // Emit the placeholder 1190 uint64_t Vals[] = {bitc::MODULE_CODE_VSTOFFSET, 0}; 1191 Stream.EmitRecordWithAbbrev(VSTOffsetAbbrev, Vals); 1192 1193 // Compute and save the bit offset to the placeholder, which will be 1194 // patched when the real VST is written. We can simply subtract the 32-bit 1195 // fixed size from the current bit number to get the location to backpatch. 1196 VSTOffsetPlaceholder = Stream.GetCurrentBitNo() - 32; 1197 } 1198 1199 enum StringEncoding { SE_Char6, SE_Fixed7, SE_Fixed8 }; 1200 1201 /// Determine the encoding to use for the given string name and length. 1202 static StringEncoding getStringEncoding(StringRef Str) { 1203 bool isChar6 = true; 1204 for (char C : Str) { 1205 if (isChar6) 1206 isChar6 = BitCodeAbbrevOp::isChar6(C); 1207 if ((unsigned char)C & 128) 1208 // don't bother scanning the rest. 1209 return SE_Fixed8; 1210 } 1211 if (isChar6) 1212 return SE_Char6; 1213 return SE_Fixed7; 1214 } 1215 1216 /// Emit top-level description of module, including target triple, inline asm, 1217 /// descriptors for global variables, and function prototype info. 1218 /// Returns the bit offset to backpatch with the location of the real VST. 1219 void ModuleBitcodeWriter::writeModuleInfo() { 1220 // Emit various pieces of data attached to a module. 1221 if (!M.getTargetTriple().empty()) 1222 writeStringRecord(Stream, bitc::MODULE_CODE_TRIPLE, M.getTargetTriple(), 1223 0 /*TODO*/); 1224 const std::string &DL = M.getDataLayoutStr(); 1225 if (!DL.empty()) 1226 writeStringRecord(Stream, bitc::MODULE_CODE_DATALAYOUT, DL, 0 /*TODO*/); 1227 if (!M.getModuleInlineAsm().empty()) 1228 writeStringRecord(Stream, bitc::MODULE_CODE_ASM, M.getModuleInlineAsm(), 1229 0 /*TODO*/); 1230 1231 // Emit information about sections and GC, computing how many there are. Also 1232 // compute the maximum alignment value. 1233 std::map<std::string, unsigned> SectionMap; 1234 std::map<std::string, unsigned> GCMap; 1235 MaybeAlign MaxAlignment; 1236 unsigned MaxGlobalType = 0; 1237 const auto UpdateMaxAlignment = [&MaxAlignment](const MaybeAlign A) { 1238 if (A) 1239 MaxAlignment = !MaxAlignment ? *A : std::max(*MaxAlignment, *A); 1240 }; 1241 for (const GlobalVariable &GV : M.globals()) { 1242 UpdateMaxAlignment(GV.getAlign()); 1243 MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV.getValueType())); 1244 if (GV.hasSection()) { 1245 // Give section names unique ID's. 1246 unsigned &Entry = SectionMap[std::string(GV.getSection())]; 1247 if (!Entry) { 1248 writeStringRecord(Stream, bitc::MODULE_CODE_SECTIONNAME, GV.getSection(), 1249 0 /*TODO*/); 1250 Entry = SectionMap.size(); 1251 } 1252 } 1253 } 1254 for (const Function &F : M) { 1255 UpdateMaxAlignment(F.getAlign()); 1256 if (F.hasSection()) { 1257 // Give section names unique ID's. 1258 unsigned &Entry = SectionMap[std::string(F.getSection())]; 1259 if (!Entry) { 1260 writeStringRecord(Stream, bitc::MODULE_CODE_SECTIONNAME, F.getSection(), 1261 0 /*TODO*/); 1262 Entry = SectionMap.size(); 1263 } 1264 } 1265 if (F.hasGC()) { 1266 // Same for GC names. 1267 unsigned &Entry = GCMap[F.getGC()]; 1268 if (!Entry) { 1269 writeStringRecord(Stream, bitc::MODULE_CODE_GCNAME, F.getGC(), 1270 0 /*TODO*/); 1271 Entry = GCMap.size(); 1272 } 1273 } 1274 } 1275 1276 // Emit abbrev for globals, now that we know # sections and max alignment. 1277 unsigned SimpleGVarAbbrev = 0; 1278 if (!M.global_empty()) { 1279 // Add an abbrev for common globals with no visibility or thread localness. 1280 auto Abbv = std::make_shared<BitCodeAbbrev>(); 1281 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR)); 1282 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 1283 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 1284 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1285 Log2_32_Ceil(MaxGlobalType+1))); 1286 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // AddrSpace << 2 1287 //| explicitType << 1 1288 //| constant 1289 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Initializer. 1290 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // Linkage. 1291 if (!MaxAlignment) // Alignment. 1292 Abbv->Add(BitCodeAbbrevOp(0)); 1293 else { 1294 unsigned MaxEncAlignment = getEncodedAlign(MaxAlignment); 1295 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1296 Log2_32_Ceil(MaxEncAlignment+1))); 1297 } 1298 if (SectionMap.empty()) // Section. 1299 Abbv->Add(BitCodeAbbrevOp(0)); 1300 else 1301 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1302 Log2_32_Ceil(SectionMap.size()+1))); 1303 // Don't bother emitting vis + thread local. 1304 SimpleGVarAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 1305 } 1306 1307 SmallVector<unsigned, 64> Vals; 1308 // Emit the module's source file name. 1309 { 1310 StringEncoding Bits = getStringEncoding(M.getSourceFileName()); 1311 BitCodeAbbrevOp AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8); 1312 if (Bits == SE_Char6) 1313 AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Char6); 1314 else if (Bits == SE_Fixed7) 1315 AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7); 1316 1317 // MODULE_CODE_SOURCE_FILENAME: [namechar x N] 1318 auto Abbv = std::make_shared<BitCodeAbbrev>(); 1319 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_SOURCE_FILENAME)); 1320 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 1321 Abbv->Add(AbbrevOpToUse); 1322 unsigned FilenameAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 1323 1324 for (const auto P : M.getSourceFileName()) 1325 Vals.push_back((unsigned char)P); 1326 1327 // Emit the finished record. 1328 Stream.EmitRecord(bitc::MODULE_CODE_SOURCE_FILENAME, Vals, FilenameAbbrev); 1329 Vals.clear(); 1330 } 1331 1332 // Emit the global variable information. 1333 for (const GlobalVariable &GV : M.globals()) { 1334 unsigned AbbrevToUse = 0; 1335 1336 // GLOBALVAR: [strtab offset, strtab size, type, isconst, initid, 1337 // linkage, alignment, section, visibility, threadlocal, 1338 // unnamed_addr, externally_initialized, dllstorageclass, 1339 // comdat, attributes, DSO_Local] 1340 Vals.push_back(addToStrtab(GV.getName())); 1341 Vals.push_back(GV.getName().size()); 1342 Vals.push_back(VE.getTypeID(GV.getValueType())); 1343 Vals.push_back(GV.getType()->getAddressSpace() << 2 | 2 | GV.isConstant()); 1344 Vals.push_back(GV.isDeclaration() ? 0 : 1345 (VE.getValueID(GV.getInitializer()) + 1)); 1346 Vals.push_back(getEncodedLinkage(GV)); 1347 Vals.push_back(getEncodedAlign(GV.getAlign())); 1348 Vals.push_back(GV.hasSection() ? SectionMap[std::string(GV.getSection())] 1349 : 0); 1350 if (GV.isThreadLocal() || 1351 GV.getVisibility() != GlobalValue::DefaultVisibility || 1352 GV.getUnnamedAddr() != GlobalValue::UnnamedAddr::None || 1353 GV.isExternallyInitialized() || 1354 GV.getDLLStorageClass() != GlobalValue::DefaultStorageClass || 1355 GV.hasComdat() || 1356 GV.hasAttributes() || 1357 GV.isDSOLocal() || 1358 GV.hasPartition()) { 1359 Vals.push_back(getEncodedVisibility(GV)); 1360 Vals.push_back(getEncodedThreadLocalMode(GV)); 1361 Vals.push_back(getEncodedUnnamedAddr(GV)); 1362 Vals.push_back(GV.isExternallyInitialized()); 1363 Vals.push_back(getEncodedDLLStorageClass(GV)); 1364 Vals.push_back(GV.hasComdat() ? VE.getComdatID(GV.getComdat()) : 0); 1365 1366 auto AL = GV.getAttributesAsList(AttributeList::FunctionIndex); 1367 Vals.push_back(VE.getAttributeListID(AL)); 1368 1369 Vals.push_back(GV.isDSOLocal()); 1370 Vals.push_back(addToStrtab(GV.getPartition())); 1371 Vals.push_back(GV.getPartition().size()); 1372 } else { 1373 AbbrevToUse = SimpleGVarAbbrev; 1374 } 1375 1376 Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse); 1377 Vals.clear(); 1378 } 1379 1380 // Emit the function proto information. 1381 for (const Function &F : M) { 1382 // FUNCTION: [strtab offset, strtab size, type, callingconv, isproto, 1383 // linkage, paramattrs, alignment, section, visibility, gc, 1384 // unnamed_addr, prologuedata, dllstorageclass, comdat, 1385 // prefixdata, personalityfn, DSO_Local, addrspace] 1386 Vals.push_back(addToStrtab(F.getName())); 1387 Vals.push_back(F.getName().size()); 1388 Vals.push_back(VE.getTypeID(F.getFunctionType())); 1389 Vals.push_back(F.getCallingConv()); 1390 Vals.push_back(F.isDeclaration()); 1391 Vals.push_back(getEncodedLinkage(F)); 1392 Vals.push_back(VE.getAttributeListID(F.getAttributes())); 1393 Vals.push_back(getEncodedAlign(F.getAlign())); 1394 Vals.push_back(F.hasSection() ? SectionMap[std::string(F.getSection())] 1395 : 0); 1396 Vals.push_back(getEncodedVisibility(F)); 1397 Vals.push_back(F.hasGC() ? GCMap[F.getGC()] : 0); 1398 Vals.push_back(getEncodedUnnamedAddr(F)); 1399 Vals.push_back(F.hasPrologueData() ? (VE.getValueID(F.getPrologueData()) + 1) 1400 : 0); 1401 Vals.push_back(getEncodedDLLStorageClass(F)); 1402 Vals.push_back(F.hasComdat() ? VE.getComdatID(F.getComdat()) : 0); 1403 Vals.push_back(F.hasPrefixData() ? (VE.getValueID(F.getPrefixData()) + 1) 1404 : 0); 1405 Vals.push_back( 1406 F.hasPersonalityFn() ? (VE.getValueID(F.getPersonalityFn()) + 1) : 0); 1407 1408 Vals.push_back(F.isDSOLocal()); 1409 Vals.push_back(F.getAddressSpace()); 1410 Vals.push_back(addToStrtab(F.getPartition())); 1411 Vals.push_back(F.getPartition().size()); 1412 1413 unsigned AbbrevToUse = 0; 1414 Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse); 1415 Vals.clear(); 1416 } 1417 1418 // Emit the alias information. 1419 for (const GlobalAlias &A : M.aliases()) { 1420 // ALIAS: [strtab offset, strtab size, alias type, aliasee val#, linkage, 1421 // visibility, dllstorageclass, threadlocal, unnamed_addr, 1422 // DSO_Local] 1423 Vals.push_back(addToStrtab(A.getName())); 1424 Vals.push_back(A.getName().size()); 1425 Vals.push_back(VE.getTypeID(A.getValueType())); 1426 Vals.push_back(A.getType()->getAddressSpace()); 1427 Vals.push_back(VE.getValueID(A.getAliasee())); 1428 Vals.push_back(getEncodedLinkage(A)); 1429 Vals.push_back(getEncodedVisibility(A)); 1430 Vals.push_back(getEncodedDLLStorageClass(A)); 1431 Vals.push_back(getEncodedThreadLocalMode(A)); 1432 Vals.push_back(getEncodedUnnamedAddr(A)); 1433 Vals.push_back(A.isDSOLocal()); 1434 Vals.push_back(addToStrtab(A.getPartition())); 1435 Vals.push_back(A.getPartition().size()); 1436 1437 unsigned AbbrevToUse = 0; 1438 Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse); 1439 Vals.clear(); 1440 } 1441 1442 // Emit the ifunc information. 1443 for (const GlobalIFunc &I : M.ifuncs()) { 1444 // IFUNC: [strtab offset, strtab size, ifunc type, address space, resolver 1445 // val#, linkage, visibility, DSO_Local] 1446 Vals.push_back(addToStrtab(I.getName())); 1447 Vals.push_back(I.getName().size()); 1448 Vals.push_back(VE.getTypeID(I.getValueType())); 1449 Vals.push_back(I.getType()->getAddressSpace()); 1450 Vals.push_back(VE.getValueID(I.getResolver())); 1451 Vals.push_back(getEncodedLinkage(I)); 1452 Vals.push_back(getEncodedVisibility(I)); 1453 Vals.push_back(I.isDSOLocal()); 1454 Vals.push_back(addToStrtab(I.getPartition())); 1455 Vals.push_back(I.getPartition().size()); 1456 Stream.EmitRecord(bitc::MODULE_CODE_IFUNC, Vals); 1457 Vals.clear(); 1458 } 1459 1460 writeValueSymbolTableForwardDecl(); 1461 } 1462 1463 static uint64_t getOptimizationFlags(const Value *V) { 1464 uint64_t Flags = 0; 1465 1466 if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(V)) { 1467 if (OBO->hasNoSignedWrap()) 1468 Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP; 1469 if (OBO->hasNoUnsignedWrap()) 1470 Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP; 1471 } else if (const auto *PEO = dyn_cast<PossiblyExactOperator>(V)) { 1472 if (PEO->isExact()) 1473 Flags |= 1 << bitc::PEO_EXACT; 1474 } else if (const auto *FPMO = dyn_cast<FPMathOperator>(V)) { 1475 if (FPMO->hasAllowReassoc()) 1476 Flags |= bitc::AllowReassoc; 1477 if (FPMO->hasNoNaNs()) 1478 Flags |= bitc::NoNaNs; 1479 if (FPMO->hasNoInfs()) 1480 Flags |= bitc::NoInfs; 1481 if (FPMO->hasNoSignedZeros()) 1482 Flags |= bitc::NoSignedZeros; 1483 if (FPMO->hasAllowReciprocal()) 1484 Flags |= bitc::AllowReciprocal; 1485 if (FPMO->hasAllowContract()) 1486 Flags |= bitc::AllowContract; 1487 if (FPMO->hasApproxFunc()) 1488 Flags |= bitc::ApproxFunc; 1489 } 1490 1491 return Flags; 1492 } 1493 1494 void ModuleBitcodeWriter::writeValueAsMetadata( 1495 const ValueAsMetadata *MD, SmallVectorImpl<uint64_t> &Record) { 1496 // Mimic an MDNode with a value as one operand. 1497 Value *V = MD->getValue(); 1498 Record.push_back(VE.getTypeID(V->getType())); 1499 Record.push_back(VE.getValueID(V)); 1500 Stream.EmitRecord(bitc::METADATA_VALUE, Record, 0); 1501 Record.clear(); 1502 } 1503 1504 void ModuleBitcodeWriter::writeMDTuple(const MDTuple *N, 1505 SmallVectorImpl<uint64_t> &Record, 1506 unsigned Abbrev) { 1507 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) { 1508 Metadata *MD = N->getOperand(i); 1509 assert(!(MD && isa<LocalAsMetadata>(MD)) && 1510 "Unexpected function-local metadata"); 1511 Record.push_back(VE.getMetadataOrNullID(MD)); 1512 } 1513 Stream.EmitRecord(N->isDistinct() ? bitc::METADATA_DISTINCT_NODE 1514 : bitc::METADATA_NODE, 1515 Record, Abbrev); 1516 Record.clear(); 1517 } 1518 1519 unsigned ModuleBitcodeWriter::createDILocationAbbrev() { 1520 // Assume the column is usually under 128, and always output the inlined-at 1521 // location (it's never more expensive than building an array size 1). 1522 auto Abbv = std::make_shared<BitCodeAbbrev>(); 1523 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_LOCATION)); 1524 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); 1525 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 1526 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 1527 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 1528 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 1529 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); 1530 return Stream.EmitAbbrev(std::move(Abbv)); 1531 } 1532 1533 void ModuleBitcodeWriter::writeDILocation(const DILocation *N, 1534 SmallVectorImpl<uint64_t> &Record, 1535 unsigned &Abbrev) { 1536 if (!Abbrev) 1537 Abbrev = createDILocationAbbrev(); 1538 1539 Record.push_back(N->isDistinct()); 1540 Record.push_back(N->getLine()); 1541 Record.push_back(N->getColumn()); 1542 Record.push_back(VE.getMetadataID(N->getScope())); 1543 Record.push_back(VE.getMetadataOrNullID(N->getInlinedAt())); 1544 Record.push_back(N->isImplicitCode()); 1545 1546 Stream.EmitRecord(bitc::METADATA_LOCATION, Record, Abbrev); 1547 Record.clear(); 1548 } 1549 1550 unsigned ModuleBitcodeWriter::createGenericDINodeAbbrev() { 1551 // Assume the column is usually under 128, and always output the inlined-at 1552 // location (it's never more expensive than building an array size 1). 1553 auto Abbv = std::make_shared<BitCodeAbbrev>(); 1554 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_GENERIC_DEBUG)); 1555 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); 1556 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 1557 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); 1558 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 1559 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 1560 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 1561 return Stream.EmitAbbrev(std::move(Abbv)); 1562 } 1563 1564 void ModuleBitcodeWriter::writeGenericDINode(const GenericDINode *N, 1565 SmallVectorImpl<uint64_t> &Record, 1566 unsigned &Abbrev) { 1567 if (!Abbrev) 1568 Abbrev = createGenericDINodeAbbrev(); 1569 1570 Record.push_back(N->isDistinct()); 1571 Record.push_back(N->getTag()); 1572 Record.push_back(0); // Per-tag version field; unused for now. 1573 1574 for (auto &I : N->operands()) 1575 Record.push_back(VE.getMetadataOrNullID(I)); 1576 1577 Stream.EmitRecord(bitc::METADATA_GENERIC_DEBUG, Record, Abbrev); 1578 Record.clear(); 1579 } 1580 1581 void ModuleBitcodeWriter::writeDISubrange(const DISubrange *N, 1582 SmallVectorImpl<uint64_t> &Record, 1583 unsigned Abbrev) { 1584 const uint64_t Version = 2 << 1; 1585 Record.push_back((uint64_t)N->isDistinct() | Version); 1586 Record.push_back(VE.getMetadataOrNullID(N->getRawCountNode())); 1587 Record.push_back(VE.getMetadataOrNullID(N->getRawLowerBound())); 1588 Record.push_back(VE.getMetadataOrNullID(N->getRawUpperBound())); 1589 Record.push_back(VE.getMetadataOrNullID(N->getRawStride())); 1590 1591 Stream.EmitRecord(bitc::METADATA_SUBRANGE, Record, Abbrev); 1592 Record.clear(); 1593 } 1594 1595 void ModuleBitcodeWriter::writeDIGenericSubrange( 1596 const DIGenericSubrange *N, SmallVectorImpl<uint64_t> &Record, 1597 unsigned Abbrev) { 1598 Record.push_back((uint64_t)N->isDistinct()); 1599 Record.push_back(VE.getMetadataOrNullID(N->getRawCountNode())); 1600 Record.push_back(VE.getMetadataOrNullID(N->getRawLowerBound())); 1601 Record.push_back(VE.getMetadataOrNullID(N->getRawUpperBound())); 1602 Record.push_back(VE.getMetadataOrNullID(N->getRawStride())); 1603 1604 Stream.EmitRecord(bitc::METADATA_GENERIC_SUBRANGE, Record, Abbrev); 1605 Record.clear(); 1606 } 1607 1608 static void emitSignedInt64(SmallVectorImpl<uint64_t> &Vals, uint64_t V) { 1609 if ((int64_t)V >= 0) 1610 Vals.push_back(V << 1); 1611 else 1612 Vals.push_back((-V << 1) | 1); 1613 } 1614 1615 static void emitWideAPInt(SmallVectorImpl<uint64_t> &Vals, const APInt &A) { 1616 // We have an arbitrary precision integer value to write whose 1617 // bit width is > 64. However, in canonical unsigned integer 1618 // format it is likely that the high bits are going to be zero. 1619 // So, we only write the number of active words. 1620 unsigned NumWords = A.getActiveWords(); 1621 const uint64_t *RawData = A.getRawData(); 1622 for (unsigned i = 0; i < NumWords; i++) 1623 emitSignedInt64(Vals, RawData[i]); 1624 } 1625 1626 void ModuleBitcodeWriter::writeDIEnumerator(const DIEnumerator *N, 1627 SmallVectorImpl<uint64_t> &Record, 1628 unsigned Abbrev) { 1629 const uint64_t IsBigInt = 1 << 2; 1630 Record.push_back(IsBigInt | (N->isUnsigned() << 1) | N->isDistinct()); 1631 Record.push_back(N->getValue().getBitWidth()); 1632 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1633 emitWideAPInt(Record, N->getValue()); 1634 1635 Stream.EmitRecord(bitc::METADATA_ENUMERATOR, Record, Abbrev); 1636 Record.clear(); 1637 } 1638 1639 void ModuleBitcodeWriter::writeDIBasicType(const DIBasicType *N, 1640 SmallVectorImpl<uint64_t> &Record, 1641 unsigned Abbrev) { 1642 Record.push_back(N->isDistinct()); 1643 Record.push_back(N->getTag()); 1644 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1645 Record.push_back(N->getSizeInBits()); 1646 Record.push_back(N->getAlignInBits()); 1647 Record.push_back(N->getEncoding()); 1648 Record.push_back(N->getFlags()); 1649 1650 Stream.EmitRecord(bitc::METADATA_BASIC_TYPE, Record, Abbrev); 1651 Record.clear(); 1652 } 1653 1654 void ModuleBitcodeWriter::writeDIStringType(const DIStringType *N, 1655 SmallVectorImpl<uint64_t> &Record, 1656 unsigned Abbrev) { 1657 Record.push_back(N->isDistinct()); 1658 Record.push_back(N->getTag()); 1659 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1660 Record.push_back(VE.getMetadataOrNullID(N->getStringLength())); 1661 Record.push_back(VE.getMetadataOrNullID(N->getStringLengthExp())); 1662 Record.push_back(N->getSizeInBits()); 1663 Record.push_back(N->getAlignInBits()); 1664 Record.push_back(N->getEncoding()); 1665 1666 Stream.EmitRecord(bitc::METADATA_STRING_TYPE, Record, Abbrev); 1667 Record.clear(); 1668 } 1669 1670 void ModuleBitcodeWriter::writeDIDerivedType(const DIDerivedType *N, 1671 SmallVectorImpl<uint64_t> &Record, 1672 unsigned Abbrev) { 1673 Record.push_back(N->isDistinct()); 1674 Record.push_back(N->getTag()); 1675 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1676 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1677 Record.push_back(N->getLine()); 1678 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1679 Record.push_back(VE.getMetadataOrNullID(N->getBaseType())); 1680 Record.push_back(N->getSizeInBits()); 1681 Record.push_back(N->getAlignInBits()); 1682 Record.push_back(N->getOffsetInBits()); 1683 Record.push_back(N->getFlags()); 1684 Record.push_back(VE.getMetadataOrNullID(N->getExtraData())); 1685 1686 // DWARF address space is encoded as N->getDWARFAddressSpace() + 1. 0 means 1687 // that there is no DWARF address space associated with DIDerivedType. 1688 if (const auto &DWARFAddressSpace = N->getDWARFAddressSpace()) 1689 Record.push_back(*DWARFAddressSpace + 1); 1690 else 1691 Record.push_back(0); 1692 1693 Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get())); 1694 1695 Stream.EmitRecord(bitc::METADATA_DERIVED_TYPE, Record, Abbrev); 1696 Record.clear(); 1697 } 1698 1699 void ModuleBitcodeWriter::writeDICompositeType( 1700 const DICompositeType *N, SmallVectorImpl<uint64_t> &Record, 1701 unsigned Abbrev) { 1702 const unsigned IsNotUsedInOldTypeRef = 0x2; 1703 Record.push_back(IsNotUsedInOldTypeRef | (unsigned)N->isDistinct()); 1704 Record.push_back(N->getTag()); 1705 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1706 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1707 Record.push_back(N->getLine()); 1708 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1709 Record.push_back(VE.getMetadataOrNullID(N->getBaseType())); 1710 Record.push_back(N->getSizeInBits()); 1711 Record.push_back(N->getAlignInBits()); 1712 Record.push_back(N->getOffsetInBits()); 1713 Record.push_back(N->getFlags()); 1714 Record.push_back(VE.getMetadataOrNullID(N->getElements().get())); 1715 Record.push_back(N->getRuntimeLang()); 1716 Record.push_back(VE.getMetadataOrNullID(N->getVTableHolder())); 1717 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get())); 1718 Record.push_back(VE.getMetadataOrNullID(N->getRawIdentifier())); 1719 Record.push_back(VE.getMetadataOrNullID(N->getDiscriminator())); 1720 Record.push_back(VE.getMetadataOrNullID(N->getRawDataLocation())); 1721 Record.push_back(VE.getMetadataOrNullID(N->getRawAssociated())); 1722 Record.push_back(VE.getMetadataOrNullID(N->getRawAllocated())); 1723 Record.push_back(VE.getMetadataOrNullID(N->getRawRank())); 1724 Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get())); 1725 1726 Stream.EmitRecord(bitc::METADATA_COMPOSITE_TYPE, Record, Abbrev); 1727 Record.clear(); 1728 } 1729 1730 void ModuleBitcodeWriter::writeDISubroutineType( 1731 const DISubroutineType *N, SmallVectorImpl<uint64_t> &Record, 1732 unsigned Abbrev) { 1733 const unsigned HasNoOldTypeRefs = 0x2; 1734 Record.push_back(HasNoOldTypeRefs | (unsigned)N->isDistinct()); 1735 Record.push_back(N->getFlags()); 1736 Record.push_back(VE.getMetadataOrNullID(N->getTypeArray().get())); 1737 Record.push_back(N->getCC()); 1738 1739 Stream.EmitRecord(bitc::METADATA_SUBROUTINE_TYPE, Record, Abbrev); 1740 Record.clear(); 1741 } 1742 1743 void ModuleBitcodeWriter::writeDIFile(const DIFile *N, 1744 SmallVectorImpl<uint64_t> &Record, 1745 unsigned Abbrev) { 1746 Record.push_back(N->isDistinct()); 1747 Record.push_back(VE.getMetadataOrNullID(N->getRawFilename())); 1748 Record.push_back(VE.getMetadataOrNullID(N->getRawDirectory())); 1749 if (N->getRawChecksum()) { 1750 Record.push_back(N->getRawChecksum()->Kind); 1751 Record.push_back(VE.getMetadataOrNullID(N->getRawChecksum()->Value)); 1752 } else { 1753 // Maintain backwards compatibility with the old internal representation of 1754 // CSK_None in ChecksumKind by writing nulls here when Checksum is None. 1755 Record.push_back(0); 1756 Record.push_back(VE.getMetadataOrNullID(nullptr)); 1757 } 1758 auto Source = N->getRawSource(); 1759 if (Source) 1760 Record.push_back(VE.getMetadataOrNullID(*Source)); 1761 1762 Stream.EmitRecord(bitc::METADATA_FILE, Record, Abbrev); 1763 Record.clear(); 1764 } 1765 1766 void ModuleBitcodeWriter::writeDICompileUnit(const DICompileUnit *N, 1767 SmallVectorImpl<uint64_t> &Record, 1768 unsigned Abbrev) { 1769 assert(N->isDistinct() && "Expected distinct compile units"); 1770 Record.push_back(/* IsDistinct */ true); 1771 Record.push_back(N->getSourceLanguage()); 1772 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1773 Record.push_back(VE.getMetadataOrNullID(N->getRawProducer())); 1774 Record.push_back(N->isOptimized()); 1775 Record.push_back(VE.getMetadataOrNullID(N->getRawFlags())); 1776 Record.push_back(N->getRuntimeVersion()); 1777 Record.push_back(VE.getMetadataOrNullID(N->getRawSplitDebugFilename())); 1778 Record.push_back(N->getEmissionKind()); 1779 Record.push_back(VE.getMetadataOrNullID(N->getEnumTypes().get())); 1780 Record.push_back(VE.getMetadataOrNullID(N->getRetainedTypes().get())); 1781 Record.push_back(/* subprograms */ 0); 1782 Record.push_back(VE.getMetadataOrNullID(N->getGlobalVariables().get())); 1783 Record.push_back(VE.getMetadataOrNullID(N->getImportedEntities().get())); 1784 Record.push_back(N->getDWOId()); 1785 Record.push_back(VE.getMetadataOrNullID(N->getMacros().get())); 1786 Record.push_back(N->getSplitDebugInlining()); 1787 Record.push_back(N->getDebugInfoForProfiling()); 1788 Record.push_back((unsigned)N->getNameTableKind()); 1789 Record.push_back(N->getRangesBaseAddress()); 1790 Record.push_back(VE.getMetadataOrNullID(N->getRawSysRoot())); 1791 Record.push_back(VE.getMetadataOrNullID(N->getRawSDK())); 1792 1793 Stream.EmitRecord(bitc::METADATA_COMPILE_UNIT, Record, Abbrev); 1794 Record.clear(); 1795 } 1796 1797 void ModuleBitcodeWriter::writeDISubprogram(const DISubprogram *N, 1798 SmallVectorImpl<uint64_t> &Record, 1799 unsigned Abbrev) { 1800 const uint64_t HasUnitFlag = 1 << 1; 1801 const uint64_t HasSPFlagsFlag = 1 << 2; 1802 Record.push_back(uint64_t(N->isDistinct()) | HasUnitFlag | HasSPFlagsFlag); 1803 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1804 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1805 Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName())); 1806 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1807 Record.push_back(N->getLine()); 1808 Record.push_back(VE.getMetadataOrNullID(N->getType())); 1809 Record.push_back(N->getScopeLine()); 1810 Record.push_back(VE.getMetadataOrNullID(N->getContainingType())); 1811 Record.push_back(N->getSPFlags()); 1812 Record.push_back(N->getVirtualIndex()); 1813 Record.push_back(N->getFlags()); 1814 Record.push_back(VE.getMetadataOrNullID(N->getRawUnit())); 1815 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get())); 1816 Record.push_back(VE.getMetadataOrNullID(N->getDeclaration())); 1817 Record.push_back(VE.getMetadataOrNullID(N->getRetainedNodes().get())); 1818 Record.push_back(N->getThisAdjustment()); 1819 Record.push_back(VE.getMetadataOrNullID(N->getThrownTypes().get())); 1820 Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get())); 1821 1822 Stream.EmitRecord(bitc::METADATA_SUBPROGRAM, Record, Abbrev); 1823 Record.clear(); 1824 } 1825 1826 void ModuleBitcodeWriter::writeDILexicalBlock(const DILexicalBlock *N, 1827 SmallVectorImpl<uint64_t> &Record, 1828 unsigned Abbrev) { 1829 Record.push_back(N->isDistinct()); 1830 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1831 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1832 Record.push_back(N->getLine()); 1833 Record.push_back(N->getColumn()); 1834 1835 Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK, Record, Abbrev); 1836 Record.clear(); 1837 } 1838 1839 void ModuleBitcodeWriter::writeDILexicalBlockFile( 1840 const DILexicalBlockFile *N, SmallVectorImpl<uint64_t> &Record, 1841 unsigned Abbrev) { 1842 Record.push_back(N->isDistinct()); 1843 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1844 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1845 Record.push_back(N->getDiscriminator()); 1846 1847 Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK_FILE, Record, Abbrev); 1848 Record.clear(); 1849 } 1850 1851 void ModuleBitcodeWriter::writeDICommonBlock(const DICommonBlock *N, 1852 SmallVectorImpl<uint64_t> &Record, 1853 unsigned Abbrev) { 1854 Record.push_back(N->isDistinct()); 1855 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1856 Record.push_back(VE.getMetadataOrNullID(N->getDecl())); 1857 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1858 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1859 Record.push_back(N->getLineNo()); 1860 1861 Stream.EmitRecord(bitc::METADATA_COMMON_BLOCK, Record, Abbrev); 1862 Record.clear(); 1863 } 1864 1865 void ModuleBitcodeWriter::writeDINamespace(const DINamespace *N, 1866 SmallVectorImpl<uint64_t> &Record, 1867 unsigned Abbrev) { 1868 Record.push_back(N->isDistinct() | N->getExportSymbols() << 1); 1869 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1870 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1871 1872 Stream.EmitRecord(bitc::METADATA_NAMESPACE, Record, Abbrev); 1873 Record.clear(); 1874 } 1875 1876 void ModuleBitcodeWriter::writeDIMacro(const DIMacro *N, 1877 SmallVectorImpl<uint64_t> &Record, 1878 unsigned Abbrev) { 1879 Record.push_back(N->isDistinct()); 1880 Record.push_back(N->getMacinfoType()); 1881 Record.push_back(N->getLine()); 1882 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1883 Record.push_back(VE.getMetadataOrNullID(N->getRawValue())); 1884 1885 Stream.EmitRecord(bitc::METADATA_MACRO, Record, Abbrev); 1886 Record.clear(); 1887 } 1888 1889 void ModuleBitcodeWriter::writeDIMacroFile(const DIMacroFile *N, 1890 SmallVectorImpl<uint64_t> &Record, 1891 unsigned Abbrev) { 1892 Record.push_back(N->isDistinct()); 1893 Record.push_back(N->getMacinfoType()); 1894 Record.push_back(N->getLine()); 1895 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1896 Record.push_back(VE.getMetadataOrNullID(N->getElements().get())); 1897 1898 Stream.EmitRecord(bitc::METADATA_MACRO_FILE, Record, Abbrev); 1899 Record.clear(); 1900 } 1901 1902 void ModuleBitcodeWriter::writeDIArgList(const DIArgList *N, 1903 SmallVectorImpl<uint64_t> &Record, 1904 unsigned Abbrev) { 1905 Record.reserve(N->getArgs().size()); 1906 for (ValueAsMetadata *MD : N->getArgs()) 1907 Record.push_back(VE.getMetadataID(MD)); 1908 1909 Stream.EmitRecord(bitc::METADATA_ARG_LIST, Record, Abbrev); 1910 Record.clear(); 1911 } 1912 1913 void ModuleBitcodeWriter::writeDIModule(const DIModule *N, 1914 SmallVectorImpl<uint64_t> &Record, 1915 unsigned Abbrev) { 1916 Record.push_back(N->isDistinct()); 1917 for (auto &I : N->operands()) 1918 Record.push_back(VE.getMetadataOrNullID(I)); 1919 Record.push_back(N->getLineNo()); 1920 Record.push_back(N->getIsDecl()); 1921 1922 Stream.EmitRecord(bitc::METADATA_MODULE, Record, Abbrev); 1923 Record.clear(); 1924 } 1925 1926 void ModuleBitcodeWriter::writeDITemplateTypeParameter( 1927 const DITemplateTypeParameter *N, SmallVectorImpl<uint64_t> &Record, 1928 unsigned Abbrev) { 1929 Record.push_back(N->isDistinct()); 1930 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1931 Record.push_back(VE.getMetadataOrNullID(N->getType())); 1932 Record.push_back(N->isDefault()); 1933 1934 Stream.EmitRecord(bitc::METADATA_TEMPLATE_TYPE, Record, Abbrev); 1935 Record.clear(); 1936 } 1937 1938 void ModuleBitcodeWriter::writeDITemplateValueParameter( 1939 const DITemplateValueParameter *N, SmallVectorImpl<uint64_t> &Record, 1940 unsigned Abbrev) { 1941 Record.push_back(N->isDistinct()); 1942 Record.push_back(N->getTag()); 1943 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1944 Record.push_back(VE.getMetadataOrNullID(N->getType())); 1945 Record.push_back(N->isDefault()); 1946 Record.push_back(VE.getMetadataOrNullID(N->getValue())); 1947 1948 Stream.EmitRecord(bitc::METADATA_TEMPLATE_VALUE, Record, Abbrev); 1949 Record.clear(); 1950 } 1951 1952 void ModuleBitcodeWriter::writeDIGlobalVariable( 1953 const DIGlobalVariable *N, SmallVectorImpl<uint64_t> &Record, 1954 unsigned Abbrev) { 1955 const uint64_t Version = 2 << 1; 1956 Record.push_back((uint64_t)N->isDistinct() | Version); 1957 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1958 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1959 Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName())); 1960 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1961 Record.push_back(N->getLine()); 1962 Record.push_back(VE.getMetadataOrNullID(N->getType())); 1963 Record.push_back(N->isLocalToUnit()); 1964 Record.push_back(N->isDefinition()); 1965 Record.push_back(VE.getMetadataOrNullID(N->getStaticDataMemberDeclaration())); 1966 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams())); 1967 Record.push_back(N->getAlignInBits()); 1968 Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get())); 1969 1970 Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR, Record, Abbrev); 1971 Record.clear(); 1972 } 1973 1974 void ModuleBitcodeWriter::writeDILocalVariable( 1975 const DILocalVariable *N, SmallVectorImpl<uint64_t> &Record, 1976 unsigned Abbrev) { 1977 // In order to support all possible bitcode formats in BitcodeReader we need 1978 // to distinguish the following cases: 1979 // 1) Record has no artificial tag (Record[1]), 1980 // has no obsolete inlinedAt field (Record[9]). 1981 // In this case Record size will be 8, HasAlignment flag is false. 1982 // 2) Record has artificial tag (Record[1]), 1983 // has no obsolete inlignedAt field (Record[9]). 1984 // In this case Record size will be 9, HasAlignment flag is false. 1985 // 3) Record has both artificial tag (Record[1]) and 1986 // obsolete inlignedAt field (Record[9]). 1987 // In this case Record size will be 10, HasAlignment flag is false. 1988 // 4) Record has neither artificial tag, nor inlignedAt field, but 1989 // HasAlignment flag is true and Record[8] contains alignment value. 1990 const uint64_t HasAlignmentFlag = 1 << 1; 1991 Record.push_back((uint64_t)N->isDistinct() | HasAlignmentFlag); 1992 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 1993 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 1994 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 1995 Record.push_back(N->getLine()); 1996 Record.push_back(VE.getMetadataOrNullID(N->getType())); 1997 Record.push_back(N->getArg()); 1998 Record.push_back(N->getFlags()); 1999 Record.push_back(N->getAlignInBits()); 2000 Record.push_back(VE.getMetadataOrNullID(N->getAnnotations().get())); 2001 2002 Stream.EmitRecord(bitc::METADATA_LOCAL_VAR, Record, Abbrev); 2003 Record.clear(); 2004 } 2005 2006 void ModuleBitcodeWriter::writeDILabel( 2007 const DILabel *N, SmallVectorImpl<uint64_t> &Record, 2008 unsigned Abbrev) { 2009 Record.push_back((uint64_t)N->isDistinct()); 2010 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 2011 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 2012 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 2013 Record.push_back(N->getLine()); 2014 2015 Stream.EmitRecord(bitc::METADATA_LABEL, Record, Abbrev); 2016 Record.clear(); 2017 } 2018 2019 void ModuleBitcodeWriter::writeDIExpression(const DIExpression *N, 2020 SmallVectorImpl<uint64_t> &Record, 2021 unsigned Abbrev) { 2022 Record.reserve(N->getElements().size() + 1); 2023 const uint64_t Version = 3 << 1; 2024 Record.push_back((uint64_t)N->isDistinct() | Version); 2025 Record.append(N->elements_begin(), N->elements_end()); 2026 2027 Stream.EmitRecord(bitc::METADATA_EXPRESSION, Record, Abbrev); 2028 Record.clear(); 2029 } 2030 2031 void ModuleBitcodeWriter::writeDIGlobalVariableExpression( 2032 const DIGlobalVariableExpression *N, SmallVectorImpl<uint64_t> &Record, 2033 unsigned Abbrev) { 2034 Record.push_back(N->isDistinct()); 2035 Record.push_back(VE.getMetadataOrNullID(N->getVariable())); 2036 Record.push_back(VE.getMetadataOrNullID(N->getExpression())); 2037 2038 Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR_EXPR, Record, Abbrev); 2039 Record.clear(); 2040 } 2041 2042 void ModuleBitcodeWriter::writeDIObjCProperty(const DIObjCProperty *N, 2043 SmallVectorImpl<uint64_t> &Record, 2044 unsigned Abbrev) { 2045 Record.push_back(N->isDistinct()); 2046 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 2047 Record.push_back(VE.getMetadataOrNullID(N->getFile())); 2048 Record.push_back(N->getLine()); 2049 Record.push_back(VE.getMetadataOrNullID(N->getRawSetterName())); 2050 Record.push_back(VE.getMetadataOrNullID(N->getRawGetterName())); 2051 Record.push_back(N->getAttributes()); 2052 Record.push_back(VE.getMetadataOrNullID(N->getType())); 2053 2054 Stream.EmitRecord(bitc::METADATA_OBJC_PROPERTY, Record, Abbrev); 2055 Record.clear(); 2056 } 2057 2058 void ModuleBitcodeWriter::writeDIImportedEntity( 2059 const DIImportedEntity *N, SmallVectorImpl<uint64_t> &Record, 2060 unsigned Abbrev) { 2061 Record.push_back(N->isDistinct()); 2062 Record.push_back(N->getTag()); 2063 Record.push_back(VE.getMetadataOrNullID(N->getScope())); 2064 Record.push_back(VE.getMetadataOrNullID(N->getEntity())); 2065 Record.push_back(N->getLine()); 2066 Record.push_back(VE.getMetadataOrNullID(N->getRawName())); 2067 Record.push_back(VE.getMetadataOrNullID(N->getRawFile())); 2068 Record.push_back(VE.getMetadataOrNullID(N->getElements().get())); 2069 2070 Stream.EmitRecord(bitc::METADATA_IMPORTED_ENTITY, Record, Abbrev); 2071 Record.clear(); 2072 } 2073 2074 unsigned ModuleBitcodeWriter::createNamedMetadataAbbrev() { 2075 auto Abbv = std::make_shared<BitCodeAbbrev>(); 2076 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_NAME)); 2077 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 2078 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); 2079 return Stream.EmitAbbrev(std::move(Abbv)); 2080 } 2081 2082 void ModuleBitcodeWriter::writeNamedMetadata( 2083 SmallVectorImpl<uint64_t> &Record) { 2084 if (M.named_metadata_empty()) 2085 return; 2086 2087 unsigned Abbrev = createNamedMetadataAbbrev(); 2088 for (const NamedMDNode &NMD : M.named_metadata()) { 2089 // Write name. 2090 StringRef Str = NMD.getName(); 2091 Record.append(Str.bytes_begin(), Str.bytes_end()); 2092 Stream.EmitRecord(bitc::METADATA_NAME, Record, Abbrev); 2093 Record.clear(); 2094 2095 // Write named metadata operands. 2096 for (const MDNode *N : NMD.operands()) 2097 Record.push_back(VE.getMetadataID(N)); 2098 Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0); 2099 Record.clear(); 2100 } 2101 } 2102 2103 unsigned ModuleBitcodeWriter::createMetadataStringsAbbrev() { 2104 auto Abbv = std::make_shared<BitCodeAbbrev>(); 2105 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRINGS)); 2106 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of strings 2107 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // offset to chars 2108 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2109 return Stream.EmitAbbrev(std::move(Abbv)); 2110 } 2111 2112 /// Write out a record for MDString. 2113 /// 2114 /// All the metadata strings in a metadata block are emitted in a single 2115 /// record. The sizes and strings themselves are shoved into a blob. 2116 void ModuleBitcodeWriter::writeMetadataStrings( 2117 ArrayRef<const Metadata *> Strings, SmallVectorImpl<uint64_t> &Record) { 2118 if (Strings.empty()) 2119 return; 2120 2121 // Start the record with the number of strings. 2122 Record.push_back(bitc::METADATA_STRINGS); 2123 Record.push_back(Strings.size()); 2124 2125 // Emit the sizes of the strings in the blob. 2126 SmallString<256> Blob; 2127 { 2128 BitstreamWriter W(Blob); 2129 for (const Metadata *MD : Strings) 2130 W.EmitVBR(cast<MDString>(MD)->getLength(), 6); 2131 W.FlushToWord(); 2132 } 2133 2134 // Add the offset to the strings to the record. 2135 Record.push_back(Blob.size()); 2136 2137 // Add the strings to the blob. 2138 for (const Metadata *MD : Strings) 2139 Blob.append(cast<MDString>(MD)->getString()); 2140 2141 // Emit the final record. 2142 Stream.EmitRecordWithBlob(createMetadataStringsAbbrev(), Record, Blob); 2143 Record.clear(); 2144 } 2145 2146 // Generates an enum to use as an index in the Abbrev array of Metadata record. 2147 enum MetadataAbbrev : unsigned { 2148 #define HANDLE_MDNODE_LEAF(CLASS) CLASS##AbbrevID, 2149 #include "llvm/IR/Metadata.def" 2150 LastPlusOne 2151 }; 2152 2153 void ModuleBitcodeWriter::writeMetadataRecords( 2154 ArrayRef<const Metadata *> MDs, SmallVectorImpl<uint64_t> &Record, 2155 std::vector<unsigned> *MDAbbrevs, std::vector<uint64_t> *IndexPos) { 2156 if (MDs.empty()) 2157 return; 2158 2159 // Initialize MDNode abbreviations. 2160 #define HANDLE_MDNODE_LEAF(CLASS) unsigned CLASS##Abbrev = 0; 2161 #include "llvm/IR/Metadata.def" 2162 2163 for (const Metadata *MD : MDs) { 2164 if (IndexPos) 2165 IndexPos->push_back(Stream.GetCurrentBitNo()); 2166 if (const MDNode *N = dyn_cast<MDNode>(MD)) { 2167 assert(N->isResolved() && "Expected forward references to be resolved"); 2168 2169 switch (N->getMetadataID()) { 2170 default: 2171 llvm_unreachable("Invalid MDNode subclass"); 2172 #define HANDLE_MDNODE_LEAF(CLASS) \ 2173 case Metadata::CLASS##Kind: \ 2174 if (MDAbbrevs) \ 2175 write##CLASS(cast<CLASS>(N), Record, \ 2176 (*MDAbbrevs)[MetadataAbbrev::CLASS##AbbrevID]); \ 2177 else \ 2178 write##CLASS(cast<CLASS>(N), Record, CLASS##Abbrev); \ 2179 continue; 2180 #include "llvm/IR/Metadata.def" 2181 } 2182 } 2183 writeValueAsMetadata(cast<ValueAsMetadata>(MD), Record); 2184 } 2185 } 2186 2187 void ModuleBitcodeWriter::writeModuleMetadata() { 2188 if (!VE.hasMDs() && M.named_metadata_empty()) 2189 return; 2190 2191 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 4); 2192 SmallVector<uint64_t, 64> Record; 2193 2194 // Emit all abbrevs upfront, so that the reader can jump in the middle of the 2195 // block and load any metadata. 2196 std::vector<unsigned> MDAbbrevs; 2197 2198 MDAbbrevs.resize(MetadataAbbrev::LastPlusOne); 2199 MDAbbrevs[MetadataAbbrev::DILocationAbbrevID] = createDILocationAbbrev(); 2200 MDAbbrevs[MetadataAbbrev::GenericDINodeAbbrevID] = 2201 createGenericDINodeAbbrev(); 2202 2203 auto Abbv = std::make_shared<BitCodeAbbrev>(); 2204 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_INDEX_OFFSET)); 2205 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2206 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2207 unsigned OffsetAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 2208 2209 Abbv = std::make_shared<BitCodeAbbrev>(); 2210 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_INDEX)); 2211 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 2212 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 2213 unsigned IndexAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 2214 2215 // Emit MDStrings together upfront. 2216 writeMetadataStrings(VE.getMDStrings(), Record); 2217 2218 // We only emit an index for the metadata record if we have more than a given 2219 // (naive) threshold of metadatas, otherwise it is not worth it. 2220 if (VE.getNonMDStrings().size() > IndexThreshold) { 2221 // Write a placeholder value in for the offset of the metadata index, 2222 // which is written after the records, so that it can include 2223 // the offset of each entry. The placeholder offset will be 2224 // updated after all records are emitted. 2225 uint64_t Vals[] = {0, 0}; 2226 Stream.EmitRecord(bitc::METADATA_INDEX_OFFSET, Vals, OffsetAbbrev); 2227 } 2228 2229 // Compute and save the bit offset to the current position, which will be 2230 // patched when we emit the index later. We can simply subtract the 64-bit 2231 // fixed size from the current bit number to get the location to backpatch. 2232 uint64_t IndexOffsetRecordBitPos = Stream.GetCurrentBitNo(); 2233 2234 // This index will contain the bitpos for each individual record. 2235 std::vector<uint64_t> IndexPos; 2236 IndexPos.reserve(VE.getNonMDStrings().size()); 2237 2238 // Write all the records 2239 writeMetadataRecords(VE.getNonMDStrings(), Record, &MDAbbrevs, &IndexPos); 2240 2241 if (VE.getNonMDStrings().size() > IndexThreshold) { 2242 // Now that we have emitted all the records we will emit the index. But 2243 // first 2244 // backpatch the forward reference so that the reader can skip the records 2245 // efficiently. 2246 Stream.BackpatchWord64(IndexOffsetRecordBitPos - 64, 2247 Stream.GetCurrentBitNo() - IndexOffsetRecordBitPos); 2248 2249 // Delta encode the index. 2250 uint64_t PreviousValue = IndexOffsetRecordBitPos; 2251 for (auto &Elt : IndexPos) { 2252 auto EltDelta = Elt - PreviousValue; 2253 PreviousValue = Elt; 2254 Elt = EltDelta; 2255 } 2256 // Emit the index record. 2257 Stream.EmitRecord(bitc::METADATA_INDEX, IndexPos, IndexAbbrev); 2258 IndexPos.clear(); 2259 } 2260 2261 // Write the named metadata now. 2262 writeNamedMetadata(Record); 2263 2264 auto AddDeclAttachedMetadata = [&](const GlobalObject &GO) { 2265 SmallVector<uint64_t, 4> Record; 2266 Record.push_back(VE.getValueID(&GO)); 2267 pushGlobalMetadataAttachment(Record, GO); 2268 Stream.EmitRecord(bitc::METADATA_GLOBAL_DECL_ATTACHMENT, Record); 2269 }; 2270 for (const Function &F : M) 2271 if (F.isDeclaration() && F.hasMetadata()) 2272 AddDeclAttachedMetadata(F); 2273 // FIXME: Only store metadata for declarations here, and move data for global 2274 // variable definitions to a separate block (PR28134). 2275 for (const GlobalVariable &GV : M.globals()) 2276 if (GV.hasMetadata()) 2277 AddDeclAttachedMetadata(GV); 2278 2279 Stream.ExitBlock(); 2280 } 2281 2282 void ModuleBitcodeWriter::writeFunctionMetadata(const Function &F) { 2283 if (!VE.hasMDs()) 2284 return; 2285 2286 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3); 2287 SmallVector<uint64_t, 64> Record; 2288 writeMetadataStrings(VE.getMDStrings(), Record); 2289 writeMetadataRecords(VE.getNonMDStrings(), Record); 2290 Stream.ExitBlock(); 2291 } 2292 2293 void ModuleBitcodeWriter::pushGlobalMetadataAttachment( 2294 SmallVectorImpl<uint64_t> &Record, const GlobalObject &GO) { 2295 // [n x [id, mdnode]] 2296 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 2297 GO.getAllMetadata(MDs); 2298 for (const auto &I : MDs) { 2299 Record.push_back(I.first); 2300 Record.push_back(VE.getMetadataID(I.second)); 2301 } 2302 } 2303 2304 void ModuleBitcodeWriter::writeFunctionMetadataAttachment(const Function &F) { 2305 Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3); 2306 2307 SmallVector<uint64_t, 64> Record; 2308 2309 if (F.hasMetadata()) { 2310 pushGlobalMetadataAttachment(Record, F); 2311 Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0); 2312 Record.clear(); 2313 } 2314 2315 // Write metadata attachments 2316 // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]] 2317 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 2318 for (const BasicBlock &BB : F) 2319 for (const Instruction &I : BB) { 2320 MDs.clear(); 2321 I.getAllMetadataOtherThanDebugLoc(MDs); 2322 2323 // If no metadata, ignore instruction. 2324 if (MDs.empty()) continue; 2325 2326 Record.push_back(VE.getInstructionID(&I)); 2327 2328 for (unsigned i = 0, e = MDs.size(); i != e; ++i) { 2329 Record.push_back(MDs[i].first); 2330 Record.push_back(VE.getMetadataID(MDs[i].second)); 2331 } 2332 Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0); 2333 Record.clear(); 2334 } 2335 2336 Stream.ExitBlock(); 2337 } 2338 2339 void ModuleBitcodeWriter::writeModuleMetadataKinds() { 2340 SmallVector<uint64_t, 64> Record; 2341 2342 // Write metadata kinds 2343 // METADATA_KIND - [n x [id, name]] 2344 SmallVector<StringRef, 8> Names; 2345 M.getMDKindNames(Names); 2346 2347 if (Names.empty()) return; 2348 2349 Stream.EnterSubblock(bitc::METADATA_KIND_BLOCK_ID, 3); 2350 2351 for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) { 2352 Record.push_back(MDKindID); 2353 StringRef KName = Names[MDKindID]; 2354 Record.append(KName.begin(), KName.end()); 2355 2356 Stream.EmitRecord(bitc::METADATA_KIND, Record, 0); 2357 Record.clear(); 2358 } 2359 2360 Stream.ExitBlock(); 2361 } 2362 2363 void ModuleBitcodeWriter::writeOperandBundleTags() { 2364 // Write metadata kinds 2365 // 2366 // OPERAND_BUNDLE_TAGS_BLOCK_ID : N x OPERAND_BUNDLE_TAG 2367 // 2368 // OPERAND_BUNDLE_TAG - [strchr x N] 2369 2370 SmallVector<StringRef, 8> Tags; 2371 M.getOperandBundleTags(Tags); 2372 2373 if (Tags.empty()) 2374 return; 2375 2376 Stream.EnterSubblock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID, 3); 2377 2378 SmallVector<uint64_t, 64> Record; 2379 2380 for (auto Tag : Tags) { 2381 Record.append(Tag.begin(), Tag.end()); 2382 2383 Stream.EmitRecord(bitc::OPERAND_BUNDLE_TAG, Record, 0); 2384 Record.clear(); 2385 } 2386 2387 Stream.ExitBlock(); 2388 } 2389 2390 void ModuleBitcodeWriter::writeSyncScopeNames() { 2391 SmallVector<StringRef, 8> SSNs; 2392 M.getContext().getSyncScopeNames(SSNs); 2393 if (SSNs.empty()) 2394 return; 2395 2396 Stream.EnterSubblock(bitc::SYNC_SCOPE_NAMES_BLOCK_ID, 2); 2397 2398 SmallVector<uint64_t, 64> Record; 2399 for (auto SSN : SSNs) { 2400 Record.append(SSN.begin(), SSN.end()); 2401 Stream.EmitRecord(bitc::SYNC_SCOPE_NAME, Record, 0); 2402 Record.clear(); 2403 } 2404 2405 Stream.ExitBlock(); 2406 } 2407 2408 void ModuleBitcodeWriter::writeConstants(unsigned FirstVal, unsigned LastVal, 2409 bool isGlobal) { 2410 if (FirstVal == LastVal) return; 2411 2412 Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4); 2413 2414 unsigned AggregateAbbrev = 0; 2415 unsigned String8Abbrev = 0; 2416 unsigned CString7Abbrev = 0; 2417 unsigned CString6Abbrev = 0; 2418 // If this is a constant pool for the module, emit module-specific abbrevs. 2419 if (isGlobal) { 2420 // Abbrev for CST_CODE_AGGREGATE. 2421 auto Abbv = std::make_shared<BitCodeAbbrev>(); 2422 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE)); 2423 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 2424 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1))); 2425 AggregateAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 2426 2427 // Abbrev for CST_CODE_STRING. 2428 Abbv = std::make_shared<BitCodeAbbrev>(); 2429 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING)); 2430 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 2431 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); 2432 String8Abbrev = Stream.EmitAbbrev(std::move(Abbv)); 2433 // Abbrev for CST_CODE_CSTRING. 2434 Abbv = std::make_shared<BitCodeAbbrev>(); 2435 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING)); 2436 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 2437 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); 2438 CString7Abbrev = Stream.EmitAbbrev(std::move(Abbv)); 2439 // Abbrev for CST_CODE_CSTRING. 2440 Abbv = std::make_shared<BitCodeAbbrev>(); 2441 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING)); 2442 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 2443 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6)); 2444 CString6Abbrev = Stream.EmitAbbrev(std::move(Abbv)); 2445 } 2446 2447 SmallVector<uint64_t, 64> Record; 2448 2449 const ValueEnumerator::ValueList &Vals = VE.getValues(); 2450 Type *LastTy = nullptr; 2451 for (unsigned i = FirstVal; i != LastVal; ++i) { 2452 const Value *V = Vals[i].first; 2453 // If we need to switch types, do so now. 2454 if (V->getType() != LastTy) { 2455 LastTy = V->getType(); 2456 Record.push_back(VE.getTypeID(LastTy)); 2457 Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record, 2458 CONSTANTS_SETTYPE_ABBREV); 2459 Record.clear(); 2460 } 2461 2462 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) { 2463 Record.push_back( 2464 unsigned(IA->hasSideEffects()) | unsigned(IA->isAlignStack()) << 1 | 2465 unsigned(IA->getDialect() & 1) << 2 | unsigned(IA->canThrow()) << 3); 2466 2467 // Add the asm string. 2468 const std::string &AsmStr = IA->getAsmString(); 2469 Record.push_back(AsmStr.size()); 2470 Record.append(AsmStr.begin(), AsmStr.end()); 2471 2472 // Add the constraint string. 2473 const std::string &ConstraintStr = IA->getConstraintString(); 2474 Record.push_back(ConstraintStr.size()); 2475 Record.append(ConstraintStr.begin(), ConstraintStr.end()); 2476 Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record); 2477 Record.clear(); 2478 continue; 2479 } 2480 const Constant *C = cast<Constant>(V); 2481 unsigned Code = -1U; 2482 unsigned AbbrevToUse = 0; 2483 if (C->isNullValue()) { 2484 Code = bitc::CST_CODE_NULL; 2485 } else if (isa<PoisonValue>(C)) { 2486 Code = bitc::CST_CODE_POISON; 2487 } else if (isa<UndefValue>(C)) { 2488 Code = bitc::CST_CODE_UNDEF; 2489 } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) { 2490 if (IV->getBitWidth() <= 64) { 2491 uint64_t V = IV->getSExtValue(); 2492 emitSignedInt64(Record, V); 2493 Code = bitc::CST_CODE_INTEGER; 2494 AbbrevToUse = CONSTANTS_INTEGER_ABBREV; 2495 } else { // Wide integers, > 64 bits in size. 2496 emitWideAPInt(Record, IV->getValue()); 2497 Code = bitc::CST_CODE_WIDE_INTEGER; 2498 } 2499 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) { 2500 Code = bitc::CST_CODE_FLOAT; 2501 Type *Ty = CFP->getType(); 2502 if (Ty->isHalfTy() || Ty->isBFloatTy() || Ty->isFloatTy() || 2503 Ty->isDoubleTy()) { 2504 Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue()); 2505 } else if (Ty->isX86_FP80Ty()) { 2506 // api needed to prevent premature destruction 2507 // bits are not in the same order as a normal i80 APInt, compensate. 2508 APInt api = CFP->getValueAPF().bitcastToAPInt(); 2509 const uint64_t *p = api.getRawData(); 2510 Record.push_back((p[1] << 48) | (p[0] >> 16)); 2511 Record.push_back(p[0] & 0xffffLL); 2512 } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) { 2513 APInt api = CFP->getValueAPF().bitcastToAPInt(); 2514 const uint64_t *p = api.getRawData(); 2515 Record.push_back(p[0]); 2516 Record.push_back(p[1]); 2517 } else { 2518 assert(0 && "Unknown FP type!"); 2519 } 2520 } else if (isa<ConstantDataSequential>(C) && 2521 cast<ConstantDataSequential>(C)->isString()) { 2522 const ConstantDataSequential *Str = cast<ConstantDataSequential>(C); 2523 // Emit constant strings specially. 2524 unsigned NumElts = Str->getNumElements(); 2525 // If this is a null-terminated string, use the denser CSTRING encoding. 2526 if (Str->isCString()) { 2527 Code = bitc::CST_CODE_CSTRING; 2528 --NumElts; // Don't encode the null, which isn't allowed by char6. 2529 } else { 2530 Code = bitc::CST_CODE_STRING; 2531 AbbrevToUse = String8Abbrev; 2532 } 2533 bool isCStr7 = Code == bitc::CST_CODE_CSTRING; 2534 bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING; 2535 for (unsigned i = 0; i != NumElts; ++i) { 2536 unsigned char V = Str->getElementAsInteger(i); 2537 Record.push_back(V); 2538 isCStr7 &= (V & 128) == 0; 2539 if (isCStrChar6) 2540 isCStrChar6 = BitCodeAbbrevOp::isChar6(V); 2541 } 2542 2543 if (isCStrChar6) 2544 AbbrevToUse = CString6Abbrev; 2545 else if (isCStr7) 2546 AbbrevToUse = CString7Abbrev; 2547 } else if (const ConstantDataSequential *CDS = 2548 dyn_cast<ConstantDataSequential>(C)) { 2549 Code = bitc::CST_CODE_DATA; 2550 Type *EltTy = CDS->getElementType(); 2551 if (isa<IntegerType>(EltTy)) { 2552 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) 2553 Record.push_back(CDS->getElementAsInteger(i)); 2554 } else { 2555 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) 2556 Record.push_back( 2557 CDS->getElementAsAPFloat(i).bitcastToAPInt().getLimitedValue()); 2558 } 2559 } else if (isa<ConstantAggregate>(C)) { 2560 Code = bitc::CST_CODE_AGGREGATE; 2561 for (const Value *Op : C->operands()) 2562 Record.push_back(VE.getValueID(Op)); 2563 AbbrevToUse = AggregateAbbrev; 2564 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) { 2565 switch (CE->getOpcode()) { 2566 default: 2567 if (Instruction::isCast(CE->getOpcode())) { 2568 Code = bitc::CST_CODE_CE_CAST; 2569 Record.push_back(getEncodedCastOpcode(CE->getOpcode())); 2570 Record.push_back(VE.getTypeID(C->getOperand(0)->getType())); 2571 Record.push_back(VE.getValueID(C->getOperand(0))); 2572 AbbrevToUse = CONSTANTS_CE_CAST_Abbrev; 2573 } else { 2574 assert(CE->getNumOperands() == 2 && "Unknown constant expr!"); 2575 Code = bitc::CST_CODE_CE_BINOP; 2576 Record.push_back(getEncodedBinaryOpcode(CE->getOpcode())); 2577 Record.push_back(VE.getValueID(C->getOperand(0))); 2578 Record.push_back(VE.getValueID(C->getOperand(1))); 2579 uint64_t Flags = getOptimizationFlags(CE); 2580 if (Flags != 0) 2581 Record.push_back(Flags); 2582 } 2583 break; 2584 case Instruction::FNeg: { 2585 assert(CE->getNumOperands() == 1 && "Unknown constant expr!"); 2586 Code = bitc::CST_CODE_CE_UNOP; 2587 Record.push_back(getEncodedUnaryOpcode(CE->getOpcode())); 2588 Record.push_back(VE.getValueID(C->getOperand(0))); 2589 uint64_t Flags = getOptimizationFlags(CE); 2590 if (Flags != 0) 2591 Record.push_back(Flags); 2592 break; 2593 } 2594 case Instruction::GetElementPtr: { 2595 Code = bitc::CST_CODE_CE_GEP; 2596 const auto *GO = cast<GEPOperator>(C); 2597 Record.push_back(VE.getTypeID(GO->getSourceElementType())); 2598 if (Optional<unsigned> Idx = GO->getInRangeIndex()) { 2599 Code = bitc::CST_CODE_CE_GEP_WITH_INRANGE_INDEX; 2600 Record.push_back((*Idx << 1) | GO->isInBounds()); 2601 } else if (GO->isInBounds()) 2602 Code = bitc::CST_CODE_CE_INBOUNDS_GEP; 2603 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) { 2604 Record.push_back(VE.getTypeID(C->getOperand(i)->getType())); 2605 Record.push_back(VE.getValueID(C->getOperand(i))); 2606 } 2607 break; 2608 } 2609 case Instruction::Select: 2610 Code = bitc::CST_CODE_CE_SELECT; 2611 Record.push_back(VE.getValueID(C->getOperand(0))); 2612 Record.push_back(VE.getValueID(C->getOperand(1))); 2613 Record.push_back(VE.getValueID(C->getOperand(2))); 2614 break; 2615 case Instruction::ExtractElement: 2616 Code = bitc::CST_CODE_CE_EXTRACTELT; 2617 Record.push_back(VE.getTypeID(C->getOperand(0)->getType())); 2618 Record.push_back(VE.getValueID(C->getOperand(0))); 2619 Record.push_back(VE.getTypeID(C->getOperand(1)->getType())); 2620 Record.push_back(VE.getValueID(C->getOperand(1))); 2621 break; 2622 case Instruction::InsertElement: 2623 Code = bitc::CST_CODE_CE_INSERTELT; 2624 Record.push_back(VE.getValueID(C->getOperand(0))); 2625 Record.push_back(VE.getValueID(C->getOperand(1))); 2626 Record.push_back(VE.getTypeID(C->getOperand(2)->getType())); 2627 Record.push_back(VE.getValueID(C->getOperand(2))); 2628 break; 2629 case Instruction::ShuffleVector: 2630 // If the return type and argument types are the same, this is a 2631 // standard shufflevector instruction. If the types are different, 2632 // then the shuffle is widening or truncating the input vectors, and 2633 // the argument type must also be encoded. 2634 if (C->getType() == C->getOperand(0)->getType()) { 2635 Code = bitc::CST_CODE_CE_SHUFFLEVEC; 2636 } else { 2637 Code = bitc::CST_CODE_CE_SHUFVEC_EX; 2638 Record.push_back(VE.getTypeID(C->getOperand(0)->getType())); 2639 } 2640 Record.push_back(VE.getValueID(C->getOperand(0))); 2641 Record.push_back(VE.getValueID(C->getOperand(1))); 2642 Record.push_back(VE.getValueID(CE->getShuffleMaskForBitcode())); 2643 break; 2644 case Instruction::ICmp: 2645 case Instruction::FCmp: 2646 Code = bitc::CST_CODE_CE_CMP; 2647 Record.push_back(VE.getTypeID(C->getOperand(0)->getType())); 2648 Record.push_back(VE.getValueID(C->getOperand(0))); 2649 Record.push_back(VE.getValueID(C->getOperand(1))); 2650 Record.push_back(CE->getPredicate()); 2651 break; 2652 } 2653 } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) { 2654 Code = bitc::CST_CODE_BLOCKADDRESS; 2655 Record.push_back(VE.getTypeID(BA->getFunction()->getType())); 2656 Record.push_back(VE.getValueID(BA->getFunction())); 2657 Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock())); 2658 } else if (const auto *Equiv = dyn_cast<DSOLocalEquivalent>(C)) { 2659 Code = bitc::CST_CODE_DSO_LOCAL_EQUIVALENT; 2660 Record.push_back(VE.getTypeID(Equiv->getGlobalValue()->getType())); 2661 Record.push_back(VE.getValueID(Equiv->getGlobalValue())); 2662 } else { 2663 #ifndef NDEBUG 2664 C->dump(); 2665 #endif 2666 llvm_unreachable("Unknown constant!"); 2667 } 2668 Stream.EmitRecord(Code, Record, AbbrevToUse); 2669 Record.clear(); 2670 } 2671 2672 Stream.ExitBlock(); 2673 } 2674 2675 void ModuleBitcodeWriter::writeModuleConstants() { 2676 const ValueEnumerator::ValueList &Vals = VE.getValues(); 2677 2678 // Find the first constant to emit, which is the first non-globalvalue value. 2679 // We know globalvalues have been emitted by WriteModuleInfo. 2680 for (unsigned i = 0, e = Vals.size(); i != e; ++i) { 2681 if (!isa<GlobalValue>(Vals[i].first)) { 2682 writeConstants(i, Vals.size(), true); 2683 return; 2684 } 2685 } 2686 } 2687 2688 /// pushValueAndType - The file has to encode both the value and type id for 2689 /// many values, because we need to know what type to create for forward 2690 /// references. However, most operands are not forward references, so this type 2691 /// field is not needed. 2692 /// 2693 /// This function adds V's value ID to Vals. If the value ID is higher than the 2694 /// instruction ID, then it is a forward reference, and it also includes the 2695 /// type ID. The value ID that is written is encoded relative to the InstID. 2696 bool ModuleBitcodeWriter::pushValueAndType(const Value *V, unsigned InstID, 2697 SmallVectorImpl<unsigned> &Vals) { 2698 unsigned ValID = VE.getValueID(V); 2699 // Make encoding relative to the InstID. 2700 Vals.push_back(InstID - ValID); 2701 if (ValID >= InstID) { 2702 Vals.push_back(VE.getTypeID(V->getType())); 2703 return true; 2704 } 2705 return false; 2706 } 2707 2708 void ModuleBitcodeWriter::writeOperandBundles(const CallBase &CS, 2709 unsigned InstID) { 2710 SmallVector<unsigned, 64> Record; 2711 LLVMContext &C = CS.getContext(); 2712 2713 for (unsigned i = 0, e = CS.getNumOperandBundles(); i != e; ++i) { 2714 const auto &Bundle = CS.getOperandBundleAt(i); 2715 Record.push_back(C.getOperandBundleTagID(Bundle.getTagName())); 2716 2717 for (auto &Input : Bundle.Inputs) 2718 pushValueAndType(Input, InstID, Record); 2719 2720 Stream.EmitRecord(bitc::FUNC_CODE_OPERAND_BUNDLE, Record); 2721 Record.clear(); 2722 } 2723 } 2724 2725 /// pushValue - Like pushValueAndType, but where the type of the value is 2726 /// omitted (perhaps it was already encoded in an earlier operand). 2727 void ModuleBitcodeWriter::pushValue(const Value *V, unsigned InstID, 2728 SmallVectorImpl<unsigned> &Vals) { 2729 unsigned ValID = VE.getValueID(V); 2730 Vals.push_back(InstID - ValID); 2731 } 2732 2733 void ModuleBitcodeWriter::pushValueSigned(const Value *V, unsigned InstID, 2734 SmallVectorImpl<uint64_t> &Vals) { 2735 unsigned ValID = VE.getValueID(V); 2736 int64_t diff = ((int32_t)InstID - (int32_t)ValID); 2737 emitSignedInt64(Vals, diff); 2738 } 2739 2740 /// WriteInstruction - Emit an instruction to the specified stream. 2741 void ModuleBitcodeWriter::writeInstruction(const Instruction &I, 2742 unsigned InstID, 2743 SmallVectorImpl<unsigned> &Vals) { 2744 unsigned Code = 0; 2745 unsigned AbbrevToUse = 0; 2746 VE.setInstructionID(&I); 2747 switch (I.getOpcode()) { 2748 default: 2749 if (Instruction::isCast(I.getOpcode())) { 2750 Code = bitc::FUNC_CODE_INST_CAST; 2751 if (!pushValueAndType(I.getOperand(0), InstID, Vals)) 2752 AbbrevToUse = FUNCTION_INST_CAST_ABBREV; 2753 Vals.push_back(VE.getTypeID(I.getType())); 2754 Vals.push_back(getEncodedCastOpcode(I.getOpcode())); 2755 } else { 2756 assert(isa<BinaryOperator>(I) && "Unknown instruction!"); 2757 Code = bitc::FUNC_CODE_INST_BINOP; 2758 if (!pushValueAndType(I.getOperand(0), InstID, Vals)) 2759 AbbrevToUse = FUNCTION_INST_BINOP_ABBREV; 2760 pushValue(I.getOperand(1), InstID, Vals); 2761 Vals.push_back(getEncodedBinaryOpcode(I.getOpcode())); 2762 uint64_t Flags = getOptimizationFlags(&I); 2763 if (Flags != 0) { 2764 if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV) 2765 AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV; 2766 Vals.push_back(Flags); 2767 } 2768 } 2769 break; 2770 case Instruction::FNeg: { 2771 Code = bitc::FUNC_CODE_INST_UNOP; 2772 if (!pushValueAndType(I.getOperand(0), InstID, Vals)) 2773 AbbrevToUse = FUNCTION_INST_UNOP_ABBREV; 2774 Vals.push_back(getEncodedUnaryOpcode(I.getOpcode())); 2775 uint64_t Flags = getOptimizationFlags(&I); 2776 if (Flags != 0) { 2777 if (AbbrevToUse == FUNCTION_INST_UNOP_ABBREV) 2778 AbbrevToUse = FUNCTION_INST_UNOP_FLAGS_ABBREV; 2779 Vals.push_back(Flags); 2780 } 2781 break; 2782 } 2783 case Instruction::GetElementPtr: { 2784 Code = bitc::FUNC_CODE_INST_GEP; 2785 AbbrevToUse = FUNCTION_INST_GEP_ABBREV; 2786 auto &GEPInst = cast<GetElementPtrInst>(I); 2787 Vals.push_back(GEPInst.isInBounds()); 2788 Vals.push_back(VE.getTypeID(GEPInst.getSourceElementType())); 2789 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) 2790 pushValueAndType(I.getOperand(i), InstID, Vals); 2791 break; 2792 } 2793 case Instruction::ExtractValue: { 2794 Code = bitc::FUNC_CODE_INST_EXTRACTVAL; 2795 pushValueAndType(I.getOperand(0), InstID, Vals); 2796 const ExtractValueInst *EVI = cast<ExtractValueInst>(&I); 2797 Vals.append(EVI->idx_begin(), EVI->idx_end()); 2798 break; 2799 } 2800 case Instruction::InsertValue: { 2801 Code = bitc::FUNC_CODE_INST_INSERTVAL; 2802 pushValueAndType(I.getOperand(0), InstID, Vals); 2803 pushValueAndType(I.getOperand(1), InstID, Vals); 2804 const InsertValueInst *IVI = cast<InsertValueInst>(&I); 2805 Vals.append(IVI->idx_begin(), IVI->idx_end()); 2806 break; 2807 } 2808 case Instruction::Select: { 2809 Code = bitc::FUNC_CODE_INST_VSELECT; 2810 pushValueAndType(I.getOperand(1), InstID, Vals); 2811 pushValue(I.getOperand(2), InstID, Vals); 2812 pushValueAndType(I.getOperand(0), InstID, Vals); 2813 uint64_t Flags = getOptimizationFlags(&I); 2814 if (Flags != 0) 2815 Vals.push_back(Flags); 2816 break; 2817 } 2818 case Instruction::ExtractElement: 2819 Code = bitc::FUNC_CODE_INST_EXTRACTELT; 2820 pushValueAndType(I.getOperand(0), InstID, Vals); 2821 pushValueAndType(I.getOperand(1), InstID, Vals); 2822 break; 2823 case Instruction::InsertElement: 2824 Code = bitc::FUNC_CODE_INST_INSERTELT; 2825 pushValueAndType(I.getOperand(0), InstID, Vals); 2826 pushValue(I.getOperand(1), InstID, Vals); 2827 pushValueAndType(I.getOperand(2), InstID, Vals); 2828 break; 2829 case Instruction::ShuffleVector: 2830 Code = bitc::FUNC_CODE_INST_SHUFFLEVEC; 2831 pushValueAndType(I.getOperand(0), InstID, Vals); 2832 pushValue(I.getOperand(1), InstID, Vals); 2833 pushValue(cast<ShuffleVectorInst>(I).getShuffleMaskForBitcode(), InstID, 2834 Vals); 2835 break; 2836 case Instruction::ICmp: 2837 case Instruction::FCmp: { 2838 // compare returning Int1Ty or vector of Int1Ty 2839 Code = bitc::FUNC_CODE_INST_CMP2; 2840 pushValueAndType(I.getOperand(0), InstID, Vals); 2841 pushValue(I.getOperand(1), InstID, Vals); 2842 Vals.push_back(cast<CmpInst>(I).getPredicate()); 2843 uint64_t Flags = getOptimizationFlags(&I); 2844 if (Flags != 0) 2845 Vals.push_back(Flags); 2846 break; 2847 } 2848 2849 case Instruction::Ret: 2850 { 2851 Code = bitc::FUNC_CODE_INST_RET; 2852 unsigned NumOperands = I.getNumOperands(); 2853 if (NumOperands == 0) 2854 AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV; 2855 else if (NumOperands == 1) { 2856 if (!pushValueAndType(I.getOperand(0), InstID, Vals)) 2857 AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV; 2858 } else { 2859 for (unsigned i = 0, e = NumOperands; i != e; ++i) 2860 pushValueAndType(I.getOperand(i), InstID, Vals); 2861 } 2862 } 2863 break; 2864 case Instruction::Br: 2865 { 2866 Code = bitc::FUNC_CODE_INST_BR; 2867 const BranchInst &II = cast<BranchInst>(I); 2868 Vals.push_back(VE.getValueID(II.getSuccessor(0))); 2869 if (II.isConditional()) { 2870 Vals.push_back(VE.getValueID(II.getSuccessor(1))); 2871 pushValue(II.getCondition(), InstID, Vals); 2872 } 2873 } 2874 break; 2875 case Instruction::Switch: 2876 { 2877 Code = bitc::FUNC_CODE_INST_SWITCH; 2878 const SwitchInst &SI = cast<SwitchInst>(I); 2879 Vals.push_back(VE.getTypeID(SI.getCondition()->getType())); 2880 pushValue(SI.getCondition(), InstID, Vals); 2881 Vals.push_back(VE.getValueID(SI.getDefaultDest())); 2882 for (auto Case : SI.cases()) { 2883 Vals.push_back(VE.getValueID(Case.getCaseValue())); 2884 Vals.push_back(VE.getValueID(Case.getCaseSuccessor())); 2885 } 2886 } 2887 break; 2888 case Instruction::IndirectBr: 2889 Code = bitc::FUNC_CODE_INST_INDIRECTBR; 2890 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); 2891 // Encode the address operand as relative, but not the basic blocks. 2892 pushValue(I.getOperand(0), InstID, Vals); 2893 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) 2894 Vals.push_back(VE.getValueID(I.getOperand(i))); 2895 break; 2896 2897 case Instruction::Invoke: { 2898 const InvokeInst *II = cast<InvokeInst>(&I); 2899 const Value *Callee = II->getCalledOperand(); 2900 FunctionType *FTy = II->getFunctionType(); 2901 2902 if (II->hasOperandBundles()) 2903 writeOperandBundles(*II, InstID); 2904 2905 Code = bitc::FUNC_CODE_INST_INVOKE; 2906 2907 Vals.push_back(VE.getAttributeListID(II->getAttributes())); 2908 Vals.push_back(II->getCallingConv() | 1 << 13); 2909 Vals.push_back(VE.getValueID(II->getNormalDest())); 2910 Vals.push_back(VE.getValueID(II->getUnwindDest())); 2911 Vals.push_back(VE.getTypeID(FTy)); 2912 pushValueAndType(Callee, InstID, Vals); 2913 2914 // Emit value #'s for the fixed parameters. 2915 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) 2916 pushValue(I.getOperand(i), InstID, Vals); // fixed param. 2917 2918 // Emit type/value pairs for varargs params. 2919 if (FTy->isVarArg()) { 2920 for (unsigned i = FTy->getNumParams(), e = II->arg_size(); i != e; ++i) 2921 pushValueAndType(I.getOperand(i), InstID, Vals); // vararg 2922 } 2923 break; 2924 } 2925 case Instruction::Resume: 2926 Code = bitc::FUNC_CODE_INST_RESUME; 2927 pushValueAndType(I.getOperand(0), InstID, Vals); 2928 break; 2929 case Instruction::CleanupRet: { 2930 Code = bitc::FUNC_CODE_INST_CLEANUPRET; 2931 const auto &CRI = cast<CleanupReturnInst>(I); 2932 pushValue(CRI.getCleanupPad(), InstID, Vals); 2933 if (CRI.hasUnwindDest()) 2934 Vals.push_back(VE.getValueID(CRI.getUnwindDest())); 2935 break; 2936 } 2937 case Instruction::CatchRet: { 2938 Code = bitc::FUNC_CODE_INST_CATCHRET; 2939 const auto &CRI = cast<CatchReturnInst>(I); 2940 pushValue(CRI.getCatchPad(), InstID, Vals); 2941 Vals.push_back(VE.getValueID(CRI.getSuccessor())); 2942 break; 2943 } 2944 case Instruction::CleanupPad: 2945 case Instruction::CatchPad: { 2946 const auto &FuncletPad = cast<FuncletPadInst>(I); 2947 Code = isa<CatchPadInst>(FuncletPad) ? bitc::FUNC_CODE_INST_CATCHPAD 2948 : bitc::FUNC_CODE_INST_CLEANUPPAD; 2949 pushValue(FuncletPad.getParentPad(), InstID, Vals); 2950 2951 unsigned NumArgOperands = FuncletPad.getNumArgOperands(); 2952 Vals.push_back(NumArgOperands); 2953 for (unsigned Op = 0; Op != NumArgOperands; ++Op) 2954 pushValueAndType(FuncletPad.getArgOperand(Op), InstID, Vals); 2955 break; 2956 } 2957 case Instruction::CatchSwitch: { 2958 Code = bitc::FUNC_CODE_INST_CATCHSWITCH; 2959 const auto &CatchSwitch = cast<CatchSwitchInst>(I); 2960 2961 pushValue(CatchSwitch.getParentPad(), InstID, Vals); 2962 2963 unsigned NumHandlers = CatchSwitch.getNumHandlers(); 2964 Vals.push_back(NumHandlers); 2965 for (const BasicBlock *CatchPadBB : CatchSwitch.handlers()) 2966 Vals.push_back(VE.getValueID(CatchPadBB)); 2967 2968 if (CatchSwitch.hasUnwindDest()) 2969 Vals.push_back(VE.getValueID(CatchSwitch.getUnwindDest())); 2970 break; 2971 } 2972 case Instruction::CallBr: { 2973 const CallBrInst *CBI = cast<CallBrInst>(&I); 2974 const Value *Callee = CBI->getCalledOperand(); 2975 FunctionType *FTy = CBI->getFunctionType(); 2976 2977 if (CBI->hasOperandBundles()) 2978 writeOperandBundles(*CBI, InstID); 2979 2980 Code = bitc::FUNC_CODE_INST_CALLBR; 2981 2982 Vals.push_back(VE.getAttributeListID(CBI->getAttributes())); 2983 2984 Vals.push_back(CBI->getCallingConv() << bitc::CALL_CCONV | 2985 1 << bitc::CALL_EXPLICIT_TYPE); 2986 2987 Vals.push_back(VE.getValueID(CBI->getDefaultDest())); 2988 Vals.push_back(CBI->getNumIndirectDests()); 2989 for (unsigned i = 0, e = CBI->getNumIndirectDests(); i != e; ++i) 2990 Vals.push_back(VE.getValueID(CBI->getIndirectDest(i))); 2991 2992 Vals.push_back(VE.getTypeID(FTy)); 2993 pushValueAndType(Callee, InstID, Vals); 2994 2995 // Emit value #'s for the fixed parameters. 2996 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) 2997 pushValue(I.getOperand(i), InstID, Vals); // fixed param. 2998 2999 // Emit type/value pairs for varargs params. 3000 if (FTy->isVarArg()) { 3001 for (unsigned i = FTy->getNumParams(), e = CBI->arg_size(); i != e; ++i) 3002 pushValueAndType(I.getOperand(i), InstID, Vals); // vararg 3003 } 3004 break; 3005 } 3006 case Instruction::Unreachable: 3007 Code = bitc::FUNC_CODE_INST_UNREACHABLE; 3008 AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV; 3009 break; 3010 3011 case Instruction::PHI: { 3012 const PHINode &PN = cast<PHINode>(I); 3013 Code = bitc::FUNC_CODE_INST_PHI; 3014 // With the newer instruction encoding, forward references could give 3015 // negative valued IDs. This is most common for PHIs, so we use 3016 // signed VBRs. 3017 SmallVector<uint64_t, 128> Vals64; 3018 Vals64.push_back(VE.getTypeID(PN.getType())); 3019 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) { 3020 pushValueSigned(PN.getIncomingValue(i), InstID, Vals64); 3021 Vals64.push_back(VE.getValueID(PN.getIncomingBlock(i))); 3022 } 3023 3024 uint64_t Flags = getOptimizationFlags(&I); 3025 if (Flags != 0) 3026 Vals64.push_back(Flags); 3027 3028 // Emit a Vals64 vector and exit. 3029 Stream.EmitRecord(Code, Vals64, AbbrevToUse); 3030 Vals64.clear(); 3031 return; 3032 } 3033 3034 case Instruction::LandingPad: { 3035 const LandingPadInst &LP = cast<LandingPadInst>(I); 3036 Code = bitc::FUNC_CODE_INST_LANDINGPAD; 3037 Vals.push_back(VE.getTypeID(LP.getType())); 3038 Vals.push_back(LP.isCleanup()); 3039 Vals.push_back(LP.getNumClauses()); 3040 for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) { 3041 if (LP.isCatch(I)) 3042 Vals.push_back(LandingPadInst::Catch); 3043 else 3044 Vals.push_back(LandingPadInst::Filter); 3045 pushValueAndType(LP.getClause(I), InstID, Vals); 3046 } 3047 break; 3048 } 3049 3050 case Instruction::Alloca: { 3051 Code = bitc::FUNC_CODE_INST_ALLOCA; 3052 const AllocaInst &AI = cast<AllocaInst>(I); 3053 Vals.push_back(VE.getTypeID(AI.getAllocatedType())); 3054 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); 3055 Vals.push_back(VE.getValueID(I.getOperand(0))); // size. 3056 using APV = AllocaPackedValues; 3057 unsigned Record = 0; 3058 unsigned EncodedAlign = getEncodedAlign(AI.getAlign()); 3059 Bitfield::set<APV::AlignLower>( 3060 Record, EncodedAlign & ((1 << APV::AlignLower::Bits) - 1)); 3061 Bitfield::set<APV::AlignUpper>(Record, 3062 EncodedAlign >> APV::AlignLower::Bits); 3063 Bitfield::set<APV::UsedWithInAlloca>(Record, AI.isUsedWithInAlloca()); 3064 Bitfield::set<APV::ExplicitType>(Record, true); 3065 Bitfield::set<APV::SwiftError>(Record, AI.isSwiftError()); 3066 Vals.push_back(Record); 3067 break; 3068 } 3069 3070 case Instruction::Load: 3071 if (cast<LoadInst>(I).isAtomic()) { 3072 Code = bitc::FUNC_CODE_INST_LOADATOMIC; 3073 pushValueAndType(I.getOperand(0), InstID, Vals); 3074 } else { 3075 Code = bitc::FUNC_CODE_INST_LOAD; 3076 if (!pushValueAndType(I.getOperand(0), InstID, Vals)) // ptr 3077 AbbrevToUse = FUNCTION_INST_LOAD_ABBREV; 3078 } 3079 Vals.push_back(VE.getTypeID(I.getType())); 3080 Vals.push_back(getEncodedAlign(cast<LoadInst>(I).getAlign())); 3081 Vals.push_back(cast<LoadInst>(I).isVolatile()); 3082 if (cast<LoadInst>(I).isAtomic()) { 3083 Vals.push_back(getEncodedOrdering(cast<LoadInst>(I).getOrdering())); 3084 Vals.push_back(getEncodedSyncScopeID(cast<LoadInst>(I).getSyncScopeID())); 3085 } 3086 break; 3087 case Instruction::Store: 3088 if (cast<StoreInst>(I).isAtomic()) 3089 Code = bitc::FUNC_CODE_INST_STOREATOMIC; 3090 else 3091 Code = bitc::FUNC_CODE_INST_STORE; 3092 pushValueAndType(I.getOperand(1), InstID, Vals); // ptrty + ptr 3093 pushValueAndType(I.getOperand(0), InstID, Vals); // valty + val 3094 Vals.push_back(getEncodedAlign(cast<StoreInst>(I).getAlign())); 3095 Vals.push_back(cast<StoreInst>(I).isVolatile()); 3096 if (cast<StoreInst>(I).isAtomic()) { 3097 Vals.push_back(getEncodedOrdering(cast<StoreInst>(I).getOrdering())); 3098 Vals.push_back( 3099 getEncodedSyncScopeID(cast<StoreInst>(I).getSyncScopeID())); 3100 } 3101 break; 3102 case Instruction::AtomicCmpXchg: 3103 Code = bitc::FUNC_CODE_INST_CMPXCHG; 3104 pushValueAndType(I.getOperand(0), InstID, Vals); // ptrty + ptr 3105 pushValueAndType(I.getOperand(1), InstID, Vals); // cmp. 3106 pushValue(I.getOperand(2), InstID, Vals); // newval. 3107 Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile()); 3108 Vals.push_back( 3109 getEncodedOrdering(cast<AtomicCmpXchgInst>(I).getSuccessOrdering())); 3110 Vals.push_back( 3111 getEncodedSyncScopeID(cast<AtomicCmpXchgInst>(I).getSyncScopeID())); 3112 Vals.push_back( 3113 getEncodedOrdering(cast<AtomicCmpXchgInst>(I).getFailureOrdering())); 3114 Vals.push_back(cast<AtomicCmpXchgInst>(I).isWeak()); 3115 Vals.push_back(getEncodedAlign(cast<AtomicCmpXchgInst>(I).getAlign())); 3116 break; 3117 case Instruction::AtomicRMW: 3118 Code = bitc::FUNC_CODE_INST_ATOMICRMW; 3119 pushValueAndType(I.getOperand(0), InstID, Vals); // ptrty + ptr 3120 pushValueAndType(I.getOperand(1), InstID, Vals); // valty + val 3121 Vals.push_back( 3122 getEncodedRMWOperation(cast<AtomicRMWInst>(I).getOperation())); 3123 Vals.push_back(cast<AtomicRMWInst>(I).isVolatile()); 3124 Vals.push_back(getEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering())); 3125 Vals.push_back( 3126 getEncodedSyncScopeID(cast<AtomicRMWInst>(I).getSyncScopeID())); 3127 Vals.push_back(getEncodedAlign(cast<AtomicRMWInst>(I).getAlign())); 3128 break; 3129 case Instruction::Fence: 3130 Code = bitc::FUNC_CODE_INST_FENCE; 3131 Vals.push_back(getEncodedOrdering(cast<FenceInst>(I).getOrdering())); 3132 Vals.push_back(getEncodedSyncScopeID(cast<FenceInst>(I).getSyncScopeID())); 3133 break; 3134 case Instruction::Call: { 3135 const CallInst &CI = cast<CallInst>(I); 3136 FunctionType *FTy = CI.getFunctionType(); 3137 3138 if (CI.hasOperandBundles()) 3139 writeOperandBundles(CI, InstID); 3140 3141 Code = bitc::FUNC_CODE_INST_CALL; 3142 3143 Vals.push_back(VE.getAttributeListID(CI.getAttributes())); 3144 3145 unsigned Flags = getOptimizationFlags(&I); 3146 Vals.push_back(CI.getCallingConv() << bitc::CALL_CCONV | 3147 unsigned(CI.isTailCall()) << bitc::CALL_TAIL | 3148 unsigned(CI.isMustTailCall()) << bitc::CALL_MUSTTAIL | 3149 1 << bitc::CALL_EXPLICIT_TYPE | 3150 unsigned(CI.isNoTailCall()) << bitc::CALL_NOTAIL | 3151 unsigned(Flags != 0) << bitc::CALL_FMF); 3152 if (Flags != 0) 3153 Vals.push_back(Flags); 3154 3155 Vals.push_back(VE.getTypeID(FTy)); 3156 pushValueAndType(CI.getCalledOperand(), InstID, Vals); // Callee 3157 3158 // Emit value #'s for the fixed parameters. 3159 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) { 3160 // Check for labels (can happen with asm labels). 3161 if (FTy->getParamType(i)->isLabelTy()) 3162 Vals.push_back(VE.getValueID(CI.getArgOperand(i))); 3163 else 3164 pushValue(CI.getArgOperand(i), InstID, Vals); // fixed param. 3165 } 3166 3167 // Emit type/value pairs for varargs params. 3168 if (FTy->isVarArg()) { 3169 for (unsigned i = FTy->getNumParams(), e = CI.arg_size(); i != e; ++i) 3170 pushValueAndType(CI.getArgOperand(i), InstID, Vals); // varargs 3171 } 3172 break; 3173 } 3174 case Instruction::VAArg: 3175 Code = bitc::FUNC_CODE_INST_VAARG; 3176 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); // valistty 3177 pushValue(I.getOperand(0), InstID, Vals); // valist. 3178 Vals.push_back(VE.getTypeID(I.getType())); // restype. 3179 break; 3180 case Instruction::Freeze: 3181 Code = bitc::FUNC_CODE_INST_FREEZE; 3182 pushValueAndType(I.getOperand(0), InstID, Vals); 3183 break; 3184 } 3185 3186 Stream.EmitRecord(Code, Vals, AbbrevToUse); 3187 Vals.clear(); 3188 } 3189 3190 /// Write a GlobalValue VST to the module. The purpose of this data structure is 3191 /// to allow clients to efficiently find the function body. 3192 void ModuleBitcodeWriter::writeGlobalValueSymbolTable( 3193 DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex) { 3194 // Get the offset of the VST we are writing, and backpatch it into 3195 // the VST forward declaration record. 3196 uint64_t VSTOffset = Stream.GetCurrentBitNo(); 3197 // The BitcodeStartBit was the stream offset of the identification block. 3198 VSTOffset -= bitcodeStartBit(); 3199 assert((VSTOffset & 31) == 0 && "VST block not 32-bit aligned"); 3200 // Note that we add 1 here because the offset is relative to one word 3201 // before the start of the identification block, which was historically 3202 // always the start of the regular bitcode header. 3203 Stream.BackpatchWord(VSTOffsetPlaceholder, VSTOffset / 32 + 1); 3204 3205 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4); 3206 3207 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3208 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_FNENTRY)); 3209 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id 3210 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // funcoffset 3211 unsigned FnEntryAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 3212 3213 for (const Function &F : M) { 3214 uint64_t Record[2]; 3215 3216 if (F.isDeclaration()) 3217 continue; 3218 3219 Record[0] = VE.getValueID(&F); 3220 3221 // Save the word offset of the function (from the start of the 3222 // actual bitcode written to the stream). 3223 uint64_t BitcodeIndex = FunctionToBitcodeIndex[&F] - bitcodeStartBit(); 3224 assert((BitcodeIndex & 31) == 0 && "function block not 32-bit aligned"); 3225 // Note that we add 1 here because the offset is relative to one word 3226 // before the start of the identification block, which was historically 3227 // always the start of the regular bitcode header. 3228 Record[1] = BitcodeIndex / 32 + 1; 3229 3230 Stream.EmitRecord(bitc::VST_CODE_FNENTRY, Record, FnEntryAbbrev); 3231 } 3232 3233 Stream.ExitBlock(); 3234 } 3235 3236 /// Emit names for arguments, instructions and basic blocks in a function. 3237 void ModuleBitcodeWriter::writeFunctionLevelValueSymbolTable( 3238 const ValueSymbolTable &VST) { 3239 if (VST.empty()) 3240 return; 3241 3242 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4); 3243 3244 // FIXME: Set up the abbrev, we know how many values there are! 3245 // FIXME: We know if the type names can use 7-bit ascii. 3246 SmallVector<uint64_t, 64> NameVals; 3247 3248 for (const ValueName &Name : VST) { 3249 // Figure out the encoding to use for the name. 3250 StringEncoding Bits = getStringEncoding(Name.getKey()); 3251 3252 unsigned AbbrevToUse = VST_ENTRY_8_ABBREV; 3253 NameVals.push_back(VE.getValueID(Name.getValue())); 3254 3255 // VST_CODE_ENTRY: [valueid, namechar x N] 3256 // VST_CODE_BBENTRY: [bbid, namechar x N] 3257 unsigned Code; 3258 if (isa<BasicBlock>(Name.getValue())) { 3259 Code = bitc::VST_CODE_BBENTRY; 3260 if (Bits == SE_Char6) 3261 AbbrevToUse = VST_BBENTRY_6_ABBREV; 3262 } else { 3263 Code = bitc::VST_CODE_ENTRY; 3264 if (Bits == SE_Char6) 3265 AbbrevToUse = VST_ENTRY_6_ABBREV; 3266 else if (Bits == SE_Fixed7) 3267 AbbrevToUse = VST_ENTRY_7_ABBREV; 3268 } 3269 3270 for (const auto P : Name.getKey()) 3271 NameVals.push_back((unsigned char)P); 3272 3273 // Emit the finished record. 3274 Stream.EmitRecord(Code, NameVals, AbbrevToUse); 3275 NameVals.clear(); 3276 } 3277 3278 Stream.ExitBlock(); 3279 } 3280 3281 void ModuleBitcodeWriter::writeUseList(UseListOrder &&Order) { 3282 assert(Order.Shuffle.size() >= 2 && "Shuffle too small"); 3283 unsigned Code; 3284 if (isa<BasicBlock>(Order.V)) 3285 Code = bitc::USELIST_CODE_BB; 3286 else 3287 Code = bitc::USELIST_CODE_DEFAULT; 3288 3289 SmallVector<uint64_t, 64> Record(Order.Shuffle.begin(), Order.Shuffle.end()); 3290 Record.push_back(VE.getValueID(Order.V)); 3291 Stream.EmitRecord(Code, Record); 3292 } 3293 3294 void ModuleBitcodeWriter::writeUseListBlock(const Function *F) { 3295 assert(VE.shouldPreserveUseListOrder() && 3296 "Expected to be preserving use-list order"); 3297 3298 auto hasMore = [&]() { 3299 return !VE.UseListOrders.empty() && VE.UseListOrders.back().F == F; 3300 }; 3301 if (!hasMore()) 3302 // Nothing to do. 3303 return; 3304 3305 Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3); 3306 while (hasMore()) { 3307 writeUseList(std::move(VE.UseListOrders.back())); 3308 VE.UseListOrders.pop_back(); 3309 } 3310 Stream.ExitBlock(); 3311 } 3312 3313 /// Emit a function body to the module stream. 3314 void ModuleBitcodeWriter::writeFunction( 3315 const Function &F, 3316 DenseMap<const Function *, uint64_t> &FunctionToBitcodeIndex) { 3317 // Save the bitcode index of the start of this function block for recording 3318 // in the VST. 3319 FunctionToBitcodeIndex[&F] = Stream.GetCurrentBitNo(); 3320 3321 Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4); 3322 VE.incorporateFunction(F); 3323 3324 SmallVector<unsigned, 64> Vals; 3325 3326 // Emit the number of basic blocks, so the reader can create them ahead of 3327 // time. 3328 Vals.push_back(VE.getBasicBlocks().size()); 3329 Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals); 3330 Vals.clear(); 3331 3332 // If there are function-local constants, emit them now. 3333 unsigned CstStart, CstEnd; 3334 VE.getFunctionConstantRange(CstStart, CstEnd); 3335 writeConstants(CstStart, CstEnd, false); 3336 3337 // If there is function-local metadata, emit it now. 3338 writeFunctionMetadata(F); 3339 3340 // Keep a running idea of what the instruction ID is. 3341 unsigned InstID = CstEnd; 3342 3343 bool NeedsMetadataAttachment = F.hasMetadata(); 3344 3345 DILocation *LastDL = nullptr; 3346 // Finally, emit all the instructions, in order. 3347 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) 3348 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); 3349 I != E; ++I) { 3350 writeInstruction(*I, InstID, Vals); 3351 3352 if (!I->getType()->isVoidTy()) 3353 ++InstID; 3354 3355 // If the instruction has metadata, write a metadata attachment later. 3356 NeedsMetadataAttachment |= I->hasMetadataOtherThanDebugLoc(); 3357 3358 // If the instruction has a debug location, emit it. 3359 DILocation *DL = I->getDebugLoc(); 3360 if (!DL) 3361 continue; 3362 3363 if (DL == LastDL) { 3364 // Just repeat the same debug loc as last time. 3365 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals); 3366 continue; 3367 } 3368 3369 Vals.push_back(DL->getLine()); 3370 Vals.push_back(DL->getColumn()); 3371 Vals.push_back(VE.getMetadataOrNullID(DL->getScope())); 3372 Vals.push_back(VE.getMetadataOrNullID(DL->getInlinedAt())); 3373 Vals.push_back(DL->isImplicitCode()); 3374 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals); 3375 Vals.clear(); 3376 3377 LastDL = DL; 3378 } 3379 3380 // Emit names for all the instructions etc. 3381 if (auto *Symtab = F.getValueSymbolTable()) 3382 writeFunctionLevelValueSymbolTable(*Symtab); 3383 3384 if (NeedsMetadataAttachment) 3385 writeFunctionMetadataAttachment(F); 3386 if (VE.shouldPreserveUseListOrder()) 3387 writeUseListBlock(&F); 3388 VE.purgeFunction(); 3389 Stream.ExitBlock(); 3390 } 3391 3392 // Emit blockinfo, which defines the standard abbreviations etc. 3393 void ModuleBitcodeWriter::writeBlockInfo() { 3394 // We only want to emit block info records for blocks that have multiple 3395 // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK. 3396 // Other blocks can define their abbrevs inline. 3397 Stream.EnterBlockInfoBlock(); 3398 3399 { // 8-bit fixed-width VST_CODE_ENTRY/VST_CODE_BBENTRY strings. 3400 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3401 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); 3402 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3403 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3404 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); 3405 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) != 3406 VST_ENTRY_8_ABBREV) 3407 llvm_unreachable("Unexpected abbrev ordering!"); 3408 } 3409 3410 { // 7-bit fixed width VST_CODE_ENTRY strings. 3411 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3412 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY)); 3413 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3414 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3415 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); 3416 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) != 3417 VST_ENTRY_7_ABBREV) 3418 llvm_unreachable("Unexpected abbrev ordering!"); 3419 } 3420 { // 6-bit char6 VST_CODE_ENTRY strings. 3421 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3422 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY)); 3423 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3424 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3425 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6)); 3426 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) != 3427 VST_ENTRY_6_ABBREV) 3428 llvm_unreachable("Unexpected abbrev ordering!"); 3429 } 3430 { // 6-bit char6 VST_CODE_BBENTRY strings. 3431 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3432 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY)); 3433 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3434 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3435 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6)); 3436 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID, Abbv) != 3437 VST_BBENTRY_6_ABBREV) 3438 llvm_unreachable("Unexpected abbrev ordering!"); 3439 } 3440 3441 { // SETTYPE abbrev for CONSTANTS_BLOCK. 3442 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3443 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE)); 3444 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3445 VE.computeBitsRequiredForTypeIndicies())); 3446 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) != 3447 CONSTANTS_SETTYPE_ABBREV) 3448 llvm_unreachable("Unexpected abbrev ordering!"); 3449 } 3450 3451 { // INTEGER abbrev for CONSTANTS_BLOCK. 3452 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3453 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER)); 3454 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3455 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) != 3456 CONSTANTS_INTEGER_ABBREV) 3457 llvm_unreachable("Unexpected abbrev ordering!"); 3458 } 3459 3460 { // CE_CAST abbrev for CONSTANTS_BLOCK. 3461 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3462 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST)); 3463 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // cast opc 3464 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // typeid 3465 VE.computeBitsRequiredForTypeIndicies())); 3466 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id 3467 3468 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) != 3469 CONSTANTS_CE_CAST_Abbrev) 3470 llvm_unreachable("Unexpected abbrev ordering!"); 3471 } 3472 { // NULL abbrev for CONSTANTS_BLOCK. 3473 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3474 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL)); 3475 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID, Abbv) != 3476 CONSTANTS_NULL_Abbrev) 3477 llvm_unreachable("Unexpected abbrev ordering!"); 3478 } 3479 3480 // FIXME: This should only use space for first class types! 3481 3482 { // INST_LOAD abbrev for FUNCTION_BLOCK. 3483 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3484 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD)); 3485 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr 3486 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty 3487 VE.computeBitsRequiredForTypeIndicies())); 3488 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align 3489 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile 3490 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3491 FUNCTION_INST_LOAD_ABBREV) 3492 llvm_unreachable("Unexpected abbrev ordering!"); 3493 } 3494 { // INST_UNOP abbrev for FUNCTION_BLOCK. 3495 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3496 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNOP)); 3497 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS 3498 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc 3499 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3500 FUNCTION_INST_UNOP_ABBREV) 3501 llvm_unreachable("Unexpected abbrev ordering!"); 3502 } 3503 { // INST_UNOP_FLAGS abbrev for FUNCTION_BLOCK. 3504 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3505 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNOP)); 3506 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS 3507 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc 3508 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); // flags 3509 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3510 FUNCTION_INST_UNOP_FLAGS_ABBREV) 3511 llvm_unreachable("Unexpected abbrev ordering!"); 3512 } 3513 { // INST_BINOP abbrev for FUNCTION_BLOCK. 3514 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3515 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP)); 3516 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS 3517 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS 3518 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc 3519 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3520 FUNCTION_INST_BINOP_ABBREV) 3521 llvm_unreachable("Unexpected abbrev ordering!"); 3522 } 3523 { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK. 3524 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3525 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP)); 3526 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS 3527 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS 3528 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc 3529 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); // flags 3530 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3531 FUNCTION_INST_BINOP_FLAGS_ABBREV) 3532 llvm_unreachable("Unexpected abbrev ordering!"); 3533 } 3534 { // INST_CAST abbrev for FUNCTION_BLOCK. 3535 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3536 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST)); 3537 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // OpVal 3538 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty 3539 VE.computeBitsRequiredForTypeIndicies())); 3540 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc 3541 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3542 FUNCTION_INST_CAST_ABBREV) 3543 llvm_unreachable("Unexpected abbrev ordering!"); 3544 } 3545 3546 { // INST_RET abbrev for FUNCTION_BLOCK. 3547 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3548 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET)); 3549 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3550 FUNCTION_INST_RET_VOID_ABBREV) 3551 llvm_unreachable("Unexpected abbrev ordering!"); 3552 } 3553 { // INST_RET abbrev for FUNCTION_BLOCK. 3554 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3555 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET)); 3556 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID 3557 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3558 FUNCTION_INST_RET_VAL_ABBREV) 3559 llvm_unreachable("Unexpected abbrev ordering!"); 3560 } 3561 { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK. 3562 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3563 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE)); 3564 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3565 FUNCTION_INST_UNREACHABLE_ABBREV) 3566 llvm_unreachable("Unexpected abbrev ordering!"); 3567 } 3568 { 3569 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3570 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_GEP)); 3571 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); 3572 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty 3573 Log2_32_Ceil(VE.getTypes().size() + 1))); 3574 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3575 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 3576 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) != 3577 FUNCTION_INST_GEP_ABBREV) 3578 llvm_unreachable("Unexpected abbrev ordering!"); 3579 } 3580 3581 Stream.ExitBlock(); 3582 } 3583 3584 /// Write the module path strings, currently only used when generating 3585 /// a combined index file. 3586 void IndexBitcodeWriter::writeModStrings() { 3587 Stream.EnterSubblock(bitc::MODULE_STRTAB_BLOCK_ID, 3); 3588 3589 // TODO: See which abbrev sizes we actually need to emit 3590 3591 // 8-bit fixed-width MST_ENTRY strings. 3592 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3593 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY)); 3594 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3595 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3596 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8)); 3597 unsigned Abbrev8Bit = Stream.EmitAbbrev(std::move(Abbv)); 3598 3599 // 7-bit fixed width MST_ENTRY strings. 3600 Abbv = std::make_shared<BitCodeAbbrev>(); 3601 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY)); 3602 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3603 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3604 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); 3605 unsigned Abbrev7Bit = Stream.EmitAbbrev(std::move(Abbv)); 3606 3607 // 6-bit char6 MST_ENTRY strings. 3608 Abbv = std::make_shared<BitCodeAbbrev>(); 3609 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY)); 3610 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3611 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3612 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6)); 3613 unsigned Abbrev6Bit = Stream.EmitAbbrev(std::move(Abbv)); 3614 3615 // Module Hash, 160 bits SHA1. Optionally, emitted after each MST_CODE_ENTRY. 3616 Abbv = std::make_shared<BitCodeAbbrev>(); 3617 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_HASH)); 3618 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3619 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3620 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3621 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3622 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3623 unsigned AbbrevHash = Stream.EmitAbbrev(std::move(Abbv)); 3624 3625 SmallVector<unsigned, 64> Vals; 3626 forEachModule( 3627 [&](const StringMapEntry<std::pair<uint64_t, ModuleHash>> &MPSE) { 3628 StringRef Key = MPSE.getKey(); 3629 const auto &Value = MPSE.getValue(); 3630 StringEncoding Bits = getStringEncoding(Key); 3631 unsigned AbbrevToUse = Abbrev8Bit; 3632 if (Bits == SE_Char6) 3633 AbbrevToUse = Abbrev6Bit; 3634 else if (Bits == SE_Fixed7) 3635 AbbrevToUse = Abbrev7Bit; 3636 3637 Vals.push_back(Value.first); 3638 Vals.append(Key.begin(), Key.end()); 3639 3640 // Emit the finished record. 3641 Stream.EmitRecord(bitc::MST_CODE_ENTRY, Vals, AbbrevToUse); 3642 3643 // Emit an optional hash for the module now 3644 const auto &Hash = Value.second; 3645 if (llvm::any_of(Hash, [](uint32_t H) { return H; })) { 3646 Vals.assign(Hash.begin(), Hash.end()); 3647 // Emit the hash record. 3648 Stream.EmitRecord(bitc::MST_CODE_HASH, Vals, AbbrevHash); 3649 } 3650 3651 Vals.clear(); 3652 }); 3653 Stream.ExitBlock(); 3654 } 3655 3656 /// Write the function type metadata related records that need to appear before 3657 /// a function summary entry (whether per-module or combined). 3658 template <typename Fn> 3659 static void writeFunctionTypeMetadataRecords(BitstreamWriter &Stream, 3660 FunctionSummary *FS, 3661 Fn GetValueID) { 3662 if (!FS->type_tests().empty()) 3663 Stream.EmitRecord(bitc::FS_TYPE_TESTS, FS->type_tests()); 3664 3665 SmallVector<uint64_t, 64> Record; 3666 3667 auto WriteVFuncIdVec = [&](uint64_t Ty, 3668 ArrayRef<FunctionSummary::VFuncId> VFs) { 3669 if (VFs.empty()) 3670 return; 3671 Record.clear(); 3672 for (auto &VF : VFs) { 3673 Record.push_back(VF.GUID); 3674 Record.push_back(VF.Offset); 3675 } 3676 Stream.EmitRecord(Ty, Record); 3677 }; 3678 3679 WriteVFuncIdVec(bitc::FS_TYPE_TEST_ASSUME_VCALLS, 3680 FS->type_test_assume_vcalls()); 3681 WriteVFuncIdVec(bitc::FS_TYPE_CHECKED_LOAD_VCALLS, 3682 FS->type_checked_load_vcalls()); 3683 3684 auto WriteConstVCallVec = [&](uint64_t Ty, 3685 ArrayRef<FunctionSummary::ConstVCall> VCs) { 3686 for (auto &VC : VCs) { 3687 Record.clear(); 3688 Record.push_back(VC.VFunc.GUID); 3689 Record.push_back(VC.VFunc.Offset); 3690 llvm::append_range(Record, VC.Args); 3691 Stream.EmitRecord(Ty, Record); 3692 } 3693 }; 3694 3695 WriteConstVCallVec(bitc::FS_TYPE_TEST_ASSUME_CONST_VCALL, 3696 FS->type_test_assume_const_vcalls()); 3697 WriteConstVCallVec(bitc::FS_TYPE_CHECKED_LOAD_CONST_VCALL, 3698 FS->type_checked_load_const_vcalls()); 3699 3700 auto WriteRange = [&](ConstantRange Range) { 3701 Range = Range.sextOrTrunc(FunctionSummary::ParamAccess::RangeWidth); 3702 assert(Range.getLower().getNumWords() == 1); 3703 assert(Range.getUpper().getNumWords() == 1); 3704 emitSignedInt64(Record, *Range.getLower().getRawData()); 3705 emitSignedInt64(Record, *Range.getUpper().getRawData()); 3706 }; 3707 3708 if (!FS->paramAccesses().empty()) { 3709 Record.clear(); 3710 for (auto &Arg : FS->paramAccesses()) { 3711 size_t UndoSize = Record.size(); 3712 Record.push_back(Arg.ParamNo); 3713 WriteRange(Arg.Use); 3714 Record.push_back(Arg.Calls.size()); 3715 for (auto &Call : Arg.Calls) { 3716 Record.push_back(Call.ParamNo); 3717 Optional<unsigned> ValueID = GetValueID(Call.Callee); 3718 if (!ValueID) { 3719 // If ValueID is unknown we can't drop just this call, we must drop 3720 // entire parameter. 3721 Record.resize(UndoSize); 3722 break; 3723 } 3724 Record.push_back(*ValueID); 3725 WriteRange(Call.Offsets); 3726 } 3727 } 3728 if (!Record.empty()) 3729 Stream.EmitRecord(bitc::FS_PARAM_ACCESS, Record); 3730 } 3731 } 3732 3733 /// Collect type IDs from type tests used by function. 3734 static void 3735 getReferencedTypeIds(FunctionSummary *FS, 3736 std::set<GlobalValue::GUID> &ReferencedTypeIds) { 3737 if (!FS->type_tests().empty()) 3738 for (auto &TT : FS->type_tests()) 3739 ReferencedTypeIds.insert(TT); 3740 3741 auto GetReferencedTypesFromVFuncIdVec = 3742 [&](ArrayRef<FunctionSummary::VFuncId> VFs) { 3743 for (auto &VF : VFs) 3744 ReferencedTypeIds.insert(VF.GUID); 3745 }; 3746 3747 GetReferencedTypesFromVFuncIdVec(FS->type_test_assume_vcalls()); 3748 GetReferencedTypesFromVFuncIdVec(FS->type_checked_load_vcalls()); 3749 3750 auto GetReferencedTypesFromConstVCallVec = 3751 [&](ArrayRef<FunctionSummary::ConstVCall> VCs) { 3752 for (auto &VC : VCs) 3753 ReferencedTypeIds.insert(VC.VFunc.GUID); 3754 }; 3755 3756 GetReferencedTypesFromConstVCallVec(FS->type_test_assume_const_vcalls()); 3757 GetReferencedTypesFromConstVCallVec(FS->type_checked_load_const_vcalls()); 3758 } 3759 3760 static void writeWholeProgramDevirtResolutionByArg( 3761 SmallVector<uint64_t, 64> &NameVals, const std::vector<uint64_t> &args, 3762 const WholeProgramDevirtResolution::ByArg &ByArg) { 3763 NameVals.push_back(args.size()); 3764 llvm::append_range(NameVals, args); 3765 3766 NameVals.push_back(ByArg.TheKind); 3767 NameVals.push_back(ByArg.Info); 3768 NameVals.push_back(ByArg.Byte); 3769 NameVals.push_back(ByArg.Bit); 3770 } 3771 3772 static void writeWholeProgramDevirtResolution( 3773 SmallVector<uint64_t, 64> &NameVals, StringTableBuilder &StrtabBuilder, 3774 uint64_t Id, const WholeProgramDevirtResolution &Wpd) { 3775 NameVals.push_back(Id); 3776 3777 NameVals.push_back(Wpd.TheKind); 3778 NameVals.push_back(StrtabBuilder.add(Wpd.SingleImplName)); 3779 NameVals.push_back(Wpd.SingleImplName.size()); 3780 3781 NameVals.push_back(Wpd.ResByArg.size()); 3782 for (auto &A : Wpd.ResByArg) 3783 writeWholeProgramDevirtResolutionByArg(NameVals, A.first, A.second); 3784 } 3785 3786 static void writeTypeIdSummaryRecord(SmallVector<uint64_t, 64> &NameVals, 3787 StringTableBuilder &StrtabBuilder, 3788 const std::string &Id, 3789 const TypeIdSummary &Summary) { 3790 NameVals.push_back(StrtabBuilder.add(Id)); 3791 NameVals.push_back(Id.size()); 3792 3793 NameVals.push_back(Summary.TTRes.TheKind); 3794 NameVals.push_back(Summary.TTRes.SizeM1BitWidth); 3795 NameVals.push_back(Summary.TTRes.AlignLog2); 3796 NameVals.push_back(Summary.TTRes.SizeM1); 3797 NameVals.push_back(Summary.TTRes.BitMask); 3798 NameVals.push_back(Summary.TTRes.InlineBits); 3799 3800 for (auto &W : Summary.WPDRes) 3801 writeWholeProgramDevirtResolution(NameVals, StrtabBuilder, W.first, 3802 W.second); 3803 } 3804 3805 static void writeTypeIdCompatibleVtableSummaryRecord( 3806 SmallVector<uint64_t, 64> &NameVals, StringTableBuilder &StrtabBuilder, 3807 const std::string &Id, const TypeIdCompatibleVtableInfo &Summary, 3808 ValueEnumerator &VE) { 3809 NameVals.push_back(StrtabBuilder.add(Id)); 3810 NameVals.push_back(Id.size()); 3811 3812 for (auto &P : Summary) { 3813 NameVals.push_back(P.AddressPointOffset); 3814 NameVals.push_back(VE.getValueID(P.VTableVI.getValue())); 3815 } 3816 } 3817 3818 // Helper to emit a single function summary record. 3819 void ModuleBitcodeWriterBase::writePerModuleFunctionSummaryRecord( 3820 SmallVector<uint64_t, 64> &NameVals, GlobalValueSummary *Summary, 3821 unsigned ValueID, unsigned FSCallsAbbrev, unsigned FSCallsProfileAbbrev, 3822 const Function &F) { 3823 NameVals.push_back(ValueID); 3824 3825 FunctionSummary *FS = cast<FunctionSummary>(Summary); 3826 3827 writeFunctionTypeMetadataRecords( 3828 Stream, FS, [&](const ValueInfo &VI) -> Optional<unsigned> { 3829 return {VE.getValueID(VI.getValue())}; 3830 }); 3831 3832 auto SpecialRefCnts = FS->specialRefCounts(); 3833 NameVals.push_back(getEncodedGVSummaryFlags(FS->flags())); 3834 NameVals.push_back(FS->instCount()); 3835 NameVals.push_back(getEncodedFFlags(FS->fflags())); 3836 NameVals.push_back(FS->refs().size()); 3837 NameVals.push_back(SpecialRefCnts.first); // rorefcnt 3838 NameVals.push_back(SpecialRefCnts.second); // worefcnt 3839 3840 for (auto &RI : FS->refs()) 3841 NameVals.push_back(VE.getValueID(RI.getValue())); 3842 3843 bool HasProfileData = 3844 F.hasProfileData() || ForceSummaryEdgesCold != FunctionSummary::FSHT_None; 3845 for (auto &ECI : FS->calls()) { 3846 NameVals.push_back(getValueId(ECI.first)); 3847 if (HasProfileData) 3848 NameVals.push_back(static_cast<uint8_t>(ECI.second.Hotness)); 3849 else if (WriteRelBFToSummary) 3850 NameVals.push_back(ECI.second.RelBlockFreq); 3851 } 3852 3853 unsigned FSAbbrev = (HasProfileData ? FSCallsProfileAbbrev : FSCallsAbbrev); 3854 unsigned Code = 3855 (HasProfileData ? bitc::FS_PERMODULE_PROFILE 3856 : (WriteRelBFToSummary ? bitc::FS_PERMODULE_RELBF 3857 : bitc::FS_PERMODULE)); 3858 3859 // Emit the finished record. 3860 Stream.EmitRecord(Code, NameVals, FSAbbrev); 3861 NameVals.clear(); 3862 } 3863 3864 // Collect the global value references in the given variable's initializer, 3865 // and emit them in a summary record. 3866 void ModuleBitcodeWriterBase::writeModuleLevelReferences( 3867 const GlobalVariable &V, SmallVector<uint64_t, 64> &NameVals, 3868 unsigned FSModRefsAbbrev, unsigned FSModVTableRefsAbbrev) { 3869 auto VI = Index->getValueInfo(V.getGUID()); 3870 if (!VI || VI.getSummaryList().empty()) { 3871 // Only declarations should not have a summary (a declaration might however 3872 // have a summary if the def was in module level asm). 3873 assert(V.isDeclaration()); 3874 return; 3875 } 3876 auto *Summary = VI.getSummaryList()[0].get(); 3877 NameVals.push_back(VE.getValueID(&V)); 3878 GlobalVarSummary *VS = cast<GlobalVarSummary>(Summary); 3879 NameVals.push_back(getEncodedGVSummaryFlags(VS->flags())); 3880 NameVals.push_back(getEncodedGVarFlags(VS->varflags())); 3881 3882 auto VTableFuncs = VS->vTableFuncs(); 3883 if (!VTableFuncs.empty()) 3884 NameVals.push_back(VS->refs().size()); 3885 3886 unsigned SizeBeforeRefs = NameVals.size(); 3887 for (auto &RI : VS->refs()) 3888 NameVals.push_back(VE.getValueID(RI.getValue())); 3889 // Sort the refs for determinism output, the vector returned by FS->refs() has 3890 // been initialized from a DenseSet. 3891 llvm::sort(drop_begin(NameVals, SizeBeforeRefs)); 3892 3893 if (VTableFuncs.empty()) 3894 Stream.EmitRecord(bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS, NameVals, 3895 FSModRefsAbbrev); 3896 else { 3897 // VTableFuncs pairs should already be sorted by offset. 3898 for (auto &P : VTableFuncs) { 3899 NameVals.push_back(VE.getValueID(P.FuncVI.getValue())); 3900 NameVals.push_back(P.VTableOffset); 3901 } 3902 3903 Stream.EmitRecord(bitc::FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS, NameVals, 3904 FSModVTableRefsAbbrev); 3905 } 3906 NameVals.clear(); 3907 } 3908 3909 /// Emit the per-module summary section alongside the rest of 3910 /// the module's bitcode. 3911 void ModuleBitcodeWriterBase::writePerModuleGlobalValueSummary() { 3912 // By default we compile with ThinLTO if the module has a summary, but the 3913 // client can request full LTO with a module flag. 3914 bool IsThinLTO = true; 3915 if (auto *MD = 3916 mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("ThinLTO"))) 3917 IsThinLTO = MD->getZExtValue(); 3918 Stream.EnterSubblock(IsThinLTO ? bitc::GLOBALVAL_SUMMARY_BLOCK_ID 3919 : bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID, 3920 4); 3921 3922 Stream.EmitRecord( 3923 bitc::FS_VERSION, 3924 ArrayRef<uint64_t>{ModuleSummaryIndex::BitcodeSummaryVersion}); 3925 3926 // Write the index flags. 3927 uint64_t Flags = 0; 3928 // Bits 1-3 are set only in the combined index, skip them. 3929 if (Index->enableSplitLTOUnit()) 3930 Flags |= 0x8; 3931 Stream.EmitRecord(bitc::FS_FLAGS, ArrayRef<uint64_t>{Flags}); 3932 3933 if (Index->begin() == Index->end()) { 3934 Stream.ExitBlock(); 3935 return; 3936 } 3937 3938 for (const auto &GVI : valueIds()) { 3939 Stream.EmitRecord(bitc::FS_VALUE_GUID, 3940 ArrayRef<uint64_t>{GVI.second, GVI.first}); 3941 } 3942 3943 // Abbrev for FS_PERMODULE_PROFILE. 3944 auto Abbv = std::make_shared<BitCodeAbbrev>(); 3945 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_PROFILE)); 3946 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 3947 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 3948 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount 3949 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // fflags 3950 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs 3951 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // rorefcnt 3952 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // worefcnt 3953 // numrefs x valueid, n x (valueid, hotness) 3954 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3955 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3956 unsigned FSCallsProfileAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 3957 3958 // Abbrev for FS_PERMODULE or FS_PERMODULE_RELBF. 3959 Abbv = std::make_shared<BitCodeAbbrev>(); 3960 if (WriteRelBFToSummary) 3961 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_RELBF)); 3962 else 3963 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE)); 3964 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 3965 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 3966 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount 3967 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // fflags 3968 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs 3969 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // rorefcnt 3970 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // worefcnt 3971 // numrefs x valueid, n x (valueid [, rel_block_freq]) 3972 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3973 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3974 unsigned FSCallsAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 3975 3976 // Abbrev for FS_PERMODULE_GLOBALVAR_INIT_REFS. 3977 Abbv = std::make_shared<BitCodeAbbrev>(); 3978 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS)); 3979 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 3980 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 3981 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); // valueids 3982 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3983 unsigned FSModRefsAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 3984 3985 // Abbrev for FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS. 3986 Abbv = std::make_shared<BitCodeAbbrev>(); 3987 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS)); 3988 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 3989 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 3990 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs 3991 // numrefs x valueid, n x (valueid , offset) 3992 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 3993 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 3994 unsigned FSModVTableRefsAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 3995 3996 // Abbrev for FS_ALIAS. 3997 Abbv = std::make_shared<BitCodeAbbrev>(); 3998 Abbv->Add(BitCodeAbbrevOp(bitc::FS_ALIAS)); 3999 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4000 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 4001 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4002 unsigned FSAliasAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4003 4004 // Abbrev for FS_TYPE_ID_METADATA 4005 Abbv = std::make_shared<BitCodeAbbrev>(); 4006 Abbv->Add(BitCodeAbbrevOp(bitc::FS_TYPE_ID_METADATA)); 4007 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // typeid strtab index 4008 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // typeid length 4009 // n x (valueid , offset) 4010 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 4011 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 4012 unsigned TypeIdCompatibleVtableAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4013 4014 SmallVector<uint64_t, 64> NameVals; 4015 // Iterate over the list of functions instead of the Index to 4016 // ensure the ordering is stable. 4017 for (const Function &F : M) { 4018 // Summary emission does not support anonymous functions, they have to 4019 // renamed using the anonymous function renaming pass. 4020 if (!F.hasName()) 4021 report_fatal_error("Unexpected anonymous function when writing summary"); 4022 4023 ValueInfo VI = Index->getValueInfo(F.getGUID()); 4024 if (!VI || VI.getSummaryList().empty()) { 4025 // Only declarations should not have a summary (a declaration might 4026 // however have a summary if the def was in module level asm). 4027 assert(F.isDeclaration()); 4028 continue; 4029 } 4030 auto *Summary = VI.getSummaryList()[0].get(); 4031 writePerModuleFunctionSummaryRecord(NameVals, Summary, VE.getValueID(&F), 4032 FSCallsAbbrev, FSCallsProfileAbbrev, F); 4033 } 4034 4035 // Capture references from GlobalVariable initializers, which are outside 4036 // of a function scope. 4037 for (const GlobalVariable &G : M.globals()) 4038 writeModuleLevelReferences(G, NameVals, FSModRefsAbbrev, 4039 FSModVTableRefsAbbrev); 4040 4041 for (const GlobalAlias &A : M.aliases()) { 4042 auto *Aliasee = A.getAliaseeObject(); 4043 if (!Aliasee->hasName()) 4044 // Nameless function don't have an entry in the summary, skip it. 4045 continue; 4046 auto AliasId = VE.getValueID(&A); 4047 auto AliaseeId = VE.getValueID(Aliasee); 4048 NameVals.push_back(AliasId); 4049 auto *Summary = Index->getGlobalValueSummary(A); 4050 AliasSummary *AS = cast<AliasSummary>(Summary); 4051 NameVals.push_back(getEncodedGVSummaryFlags(AS->flags())); 4052 NameVals.push_back(AliaseeId); 4053 Stream.EmitRecord(bitc::FS_ALIAS, NameVals, FSAliasAbbrev); 4054 NameVals.clear(); 4055 } 4056 4057 for (auto &S : Index->typeIdCompatibleVtableMap()) { 4058 writeTypeIdCompatibleVtableSummaryRecord(NameVals, StrtabBuilder, S.first, 4059 S.second, VE); 4060 Stream.EmitRecord(bitc::FS_TYPE_ID_METADATA, NameVals, 4061 TypeIdCompatibleVtableAbbrev); 4062 NameVals.clear(); 4063 } 4064 4065 Stream.EmitRecord(bitc::FS_BLOCK_COUNT, 4066 ArrayRef<uint64_t>{Index->getBlockCount()}); 4067 4068 Stream.ExitBlock(); 4069 } 4070 4071 /// Emit the combined summary section into the combined index file. 4072 void IndexBitcodeWriter::writeCombinedGlobalValueSummary() { 4073 Stream.EnterSubblock(bitc::GLOBALVAL_SUMMARY_BLOCK_ID, 3); 4074 Stream.EmitRecord( 4075 bitc::FS_VERSION, 4076 ArrayRef<uint64_t>{ModuleSummaryIndex::BitcodeSummaryVersion}); 4077 4078 // Write the index flags. 4079 Stream.EmitRecord(bitc::FS_FLAGS, ArrayRef<uint64_t>{Index.getFlags()}); 4080 4081 for (const auto &GVI : valueIds()) { 4082 Stream.EmitRecord(bitc::FS_VALUE_GUID, 4083 ArrayRef<uint64_t>{GVI.second, GVI.first}); 4084 } 4085 4086 // Abbrev for FS_COMBINED. 4087 auto Abbv = std::make_shared<BitCodeAbbrev>(); 4088 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED)); 4089 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4090 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid 4091 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 4092 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount 4093 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // fflags 4094 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // entrycount 4095 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs 4096 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // rorefcnt 4097 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // worefcnt 4098 // numrefs x valueid, n x (valueid) 4099 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 4100 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 4101 unsigned FSCallsAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4102 4103 // Abbrev for FS_COMBINED_PROFILE. 4104 Abbv = std::make_shared<BitCodeAbbrev>(); 4105 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_PROFILE)); 4106 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4107 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid 4108 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 4109 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount 4110 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // fflags 4111 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // entrycount 4112 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs 4113 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // rorefcnt 4114 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // worefcnt 4115 // numrefs x valueid, n x (valueid, hotness) 4116 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 4117 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 4118 unsigned FSCallsProfileAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4119 4120 // Abbrev for FS_COMBINED_GLOBALVAR_INIT_REFS. 4121 Abbv = std::make_shared<BitCodeAbbrev>(); 4122 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_GLOBALVAR_INIT_REFS)); 4123 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4124 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid 4125 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 4126 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); // valueids 4127 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); 4128 unsigned FSModRefsAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4129 4130 // Abbrev for FS_COMBINED_ALIAS. 4131 Abbv = std::make_shared<BitCodeAbbrev>(); 4132 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_ALIAS)); 4133 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4134 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid 4135 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // flags 4136 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid 4137 unsigned FSAliasAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4138 4139 // The aliases are emitted as a post-pass, and will point to the value 4140 // id of the aliasee. Save them in a vector for post-processing. 4141 SmallVector<AliasSummary *, 64> Aliases; 4142 4143 // Save the value id for each summary for alias emission. 4144 DenseMap<const GlobalValueSummary *, unsigned> SummaryToValueIdMap; 4145 4146 SmallVector<uint64_t, 64> NameVals; 4147 4148 // Set that will be populated during call to writeFunctionTypeMetadataRecords 4149 // with the type ids referenced by this index file. 4150 std::set<GlobalValue::GUID> ReferencedTypeIds; 4151 4152 // For local linkage, we also emit the original name separately 4153 // immediately after the record. 4154 auto MaybeEmitOriginalName = [&](GlobalValueSummary &S) { 4155 // We don't need to emit the original name if we are writing the index for 4156 // distributed backends (in which case ModuleToSummariesForIndex is 4157 // non-null). The original name is only needed during the thin link, since 4158 // for SamplePGO the indirect call targets for local functions have 4159 // have the original name annotated in profile. 4160 // Continue to emit it when writing out the entire combined index, which is 4161 // used in testing the thin link via llvm-lto. 4162 if (ModuleToSummariesForIndex || !GlobalValue::isLocalLinkage(S.linkage())) 4163 return; 4164 NameVals.push_back(S.getOriginalName()); 4165 Stream.EmitRecord(bitc::FS_COMBINED_ORIGINAL_NAME, NameVals); 4166 NameVals.clear(); 4167 }; 4168 4169 std::set<GlobalValue::GUID> DefOrUseGUIDs; 4170 forEachSummary([&](GVInfo I, bool IsAliasee) { 4171 GlobalValueSummary *S = I.second; 4172 assert(S); 4173 DefOrUseGUIDs.insert(I.first); 4174 for (const ValueInfo &VI : S->refs()) 4175 DefOrUseGUIDs.insert(VI.getGUID()); 4176 4177 auto ValueId = getValueId(I.first); 4178 assert(ValueId); 4179 SummaryToValueIdMap[S] = *ValueId; 4180 4181 // If this is invoked for an aliasee, we want to record the above 4182 // mapping, but then not emit a summary entry (if the aliasee is 4183 // to be imported, we will invoke this separately with IsAliasee=false). 4184 if (IsAliasee) 4185 return; 4186 4187 if (auto *AS = dyn_cast<AliasSummary>(S)) { 4188 // Will process aliases as a post-pass because the reader wants all 4189 // global to be loaded first. 4190 Aliases.push_back(AS); 4191 return; 4192 } 4193 4194 if (auto *VS = dyn_cast<GlobalVarSummary>(S)) { 4195 NameVals.push_back(*ValueId); 4196 NameVals.push_back(Index.getModuleId(VS->modulePath())); 4197 NameVals.push_back(getEncodedGVSummaryFlags(VS->flags())); 4198 NameVals.push_back(getEncodedGVarFlags(VS->varflags())); 4199 for (auto &RI : VS->refs()) { 4200 auto RefValueId = getValueId(RI.getGUID()); 4201 if (!RefValueId) 4202 continue; 4203 NameVals.push_back(*RefValueId); 4204 } 4205 4206 // Emit the finished record. 4207 Stream.EmitRecord(bitc::FS_COMBINED_GLOBALVAR_INIT_REFS, NameVals, 4208 FSModRefsAbbrev); 4209 NameVals.clear(); 4210 MaybeEmitOriginalName(*S); 4211 return; 4212 } 4213 4214 auto GetValueId = [&](const ValueInfo &VI) -> Optional<unsigned> { 4215 return getValueId(VI.getGUID()); 4216 }; 4217 4218 auto *FS = cast<FunctionSummary>(S); 4219 writeFunctionTypeMetadataRecords(Stream, FS, GetValueId); 4220 getReferencedTypeIds(FS, ReferencedTypeIds); 4221 4222 NameVals.push_back(*ValueId); 4223 NameVals.push_back(Index.getModuleId(FS->modulePath())); 4224 NameVals.push_back(getEncodedGVSummaryFlags(FS->flags())); 4225 NameVals.push_back(FS->instCount()); 4226 NameVals.push_back(getEncodedFFlags(FS->fflags())); 4227 NameVals.push_back(FS->entryCount()); 4228 4229 // Fill in below 4230 NameVals.push_back(0); // numrefs 4231 NameVals.push_back(0); // rorefcnt 4232 NameVals.push_back(0); // worefcnt 4233 4234 unsigned Count = 0, RORefCnt = 0, WORefCnt = 0; 4235 for (auto &RI : FS->refs()) { 4236 auto RefValueId = getValueId(RI.getGUID()); 4237 if (!RefValueId) 4238 continue; 4239 NameVals.push_back(*RefValueId); 4240 if (RI.isReadOnly()) 4241 RORefCnt++; 4242 else if (RI.isWriteOnly()) 4243 WORefCnt++; 4244 Count++; 4245 } 4246 NameVals[6] = Count; 4247 NameVals[7] = RORefCnt; 4248 NameVals[8] = WORefCnt; 4249 4250 bool HasProfileData = false; 4251 for (auto &EI : FS->calls()) { 4252 HasProfileData |= 4253 EI.second.getHotness() != CalleeInfo::HotnessType::Unknown; 4254 if (HasProfileData) 4255 break; 4256 } 4257 4258 for (auto &EI : FS->calls()) { 4259 // If this GUID doesn't have a value id, it doesn't have a function 4260 // summary and we don't need to record any calls to it. 4261 Optional<unsigned> CallValueId = GetValueId(EI.first); 4262 if (!CallValueId) 4263 continue; 4264 NameVals.push_back(*CallValueId); 4265 if (HasProfileData) 4266 NameVals.push_back(static_cast<uint8_t>(EI.second.Hotness)); 4267 } 4268 4269 unsigned FSAbbrev = (HasProfileData ? FSCallsProfileAbbrev : FSCallsAbbrev); 4270 unsigned Code = 4271 (HasProfileData ? bitc::FS_COMBINED_PROFILE : bitc::FS_COMBINED); 4272 4273 // Emit the finished record. 4274 Stream.EmitRecord(Code, NameVals, FSAbbrev); 4275 NameVals.clear(); 4276 MaybeEmitOriginalName(*S); 4277 }); 4278 4279 for (auto *AS : Aliases) { 4280 auto AliasValueId = SummaryToValueIdMap[AS]; 4281 assert(AliasValueId); 4282 NameVals.push_back(AliasValueId); 4283 NameVals.push_back(Index.getModuleId(AS->modulePath())); 4284 NameVals.push_back(getEncodedGVSummaryFlags(AS->flags())); 4285 auto AliaseeValueId = SummaryToValueIdMap[&AS->getAliasee()]; 4286 assert(AliaseeValueId); 4287 NameVals.push_back(AliaseeValueId); 4288 4289 // Emit the finished record. 4290 Stream.EmitRecord(bitc::FS_COMBINED_ALIAS, NameVals, FSAliasAbbrev); 4291 NameVals.clear(); 4292 MaybeEmitOriginalName(*AS); 4293 4294 if (auto *FS = dyn_cast<FunctionSummary>(&AS->getAliasee())) 4295 getReferencedTypeIds(FS, ReferencedTypeIds); 4296 } 4297 4298 if (!Index.cfiFunctionDefs().empty()) { 4299 for (auto &S : Index.cfiFunctionDefs()) { 4300 if (DefOrUseGUIDs.count( 4301 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(S)))) { 4302 NameVals.push_back(StrtabBuilder.add(S)); 4303 NameVals.push_back(S.size()); 4304 } 4305 } 4306 if (!NameVals.empty()) { 4307 Stream.EmitRecord(bitc::FS_CFI_FUNCTION_DEFS, NameVals); 4308 NameVals.clear(); 4309 } 4310 } 4311 4312 if (!Index.cfiFunctionDecls().empty()) { 4313 for (auto &S : Index.cfiFunctionDecls()) { 4314 if (DefOrUseGUIDs.count( 4315 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(S)))) { 4316 NameVals.push_back(StrtabBuilder.add(S)); 4317 NameVals.push_back(S.size()); 4318 } 4319 } 4320 if (!NameVals.empty()) { 4321 Stream.EmitRecord(bitc::FS_CFI_FUNCTION_DECLS, NameVals); 4322 NameVals.clear(); 4323 } 4324 } 4325 4326 // Walk the GUIDs that were referenced, and write the 4327 // corresponding type id records. 4328 for (auto &T : ReferencedTypeIds) { 4329 auto TidIter = Index.typeIds().equal_range(T); 4330 for (auto It = TidIter.first; It != TidIter.second; ++It) { 4331 writeTypeIdSummaryRecord(NameVals, StrtabBuilder, It->second.first, 4332 It->second.second); 4333 Stream.EmitRecord(bitc::FS_TYPE_ID, NameVals); 4334 NameVals.clear(); 4335 } 4336 } 4337 4338 Stream.EmitRecord(bitc::FS_BLOCK_COUNT, 4339 ArrayRef<uint64_t>{Index.getBlockCount()}); 4340 4341 Stream.ExitBlock(); 4342 } 4343 4344 /// Create the "IDENTIFICATION_BLOCK_ID" containing a single string with the 4345 /// current llvm version, and a record for the epoch number. 4346 static void writeIdentificationBlock(BitstreamWriter &Stream) { 4347 Stream.EnterSubblock(bitc::IDENTIFICATION_BLOCK_ID, 5); 4348 4349 // Write the "user readable" string identifying the bitcode producer 4350 auto Abbv = std::make_shared<BitCodeAbbrev>(); 4351 Abbv->Add(BitCodeAbbrevOp(bitc::IDENTIFICATION_CODE_STRING)); 4352 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 4353 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6)); 4354 auto StringAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4355 writeStringRecord(Stream, bitc::IDENTIFICATION_CODE_STRING, 4356 "LLVM" LLVM_VERSION_STRING, StringAbbrev); 4357 4358 // Write the epoch version 4359 Abbv = std::make_shared<BitCodeAbbrev>(); 4360 Abbv->Add(BitCodeAbbrevOp(bitc::IDENTIFICATION_CODE_EPOCH)); 4361 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); 4362 auto EpochAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4363 constexpr std::array<unsigned, 1> Vals = {{bitc::BITCODE_CURRENT_EPOCH}}; 4364 Stream.EmitRecord(bitc::IDENTIFICATION_CODE_EPOCH, Vals, EpochAbbrev); 4365 Stream.ExitBlock(); 4366 } 4367 4368 void ModuleBitcodeWriter::writeModuleHash(size_t BlockStartPos) { 4369 // Emit the module's hash. 4370 // MODULE_CODE_HASH: [5*i32] 4371 if (GenerateHash) { 4372 uint32_t Vals[5]; 4373 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&(Buffer)[BlockStartPos], 4374 Buffer.size() - BlockStartPos)); 4375 StringRef Hash = Hasher.result(); 4376 for (int Pos = 0; Pos < 20; Pos += 4) { 4377 Vals[Pos / 4] = support::endian::read32be(Hash.data() + Pos); 4378 } 4379 4380 // Emit the finished record. 4381 Stream.EmitRecord(bitc::MODULE_CODE_HASH, Vals); 4382 4383 if (ModHash) 4384 // Save the written hash value. 4385 llvm::copy(Vals, std::begin(*ModHash)); 4386 } 4387 } 4388 4389 void ModuleBitcodeWriter::write() { 4390 writeIdentificationBlock(Stream); 4391 4392 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3); 4393 size_t BlockStartPos = Buffer.size(); 4394 4395 writeModuleVersion(); 4396 4397 // Emit blockinfo, which defines the standard abbreviations etc. 4398 writeBlockInfo(); 4399 4400 // Emit information describing all of the types in the module. 4401 writeTypeTable(); 4402 4403 // Emit information about attribute groups. 4404 writeAttributeGroupTable(); 4405 4406 // Emit information about parameter attributes. 4407 writeAttributeTable(); 4408 4409 writeComdats(); 4410 4411 // Emit top-level description of module, including target triple, inline asm, 4412 // descriptors for global variables, and function prototype info. 4413 writeModuleInfo(); 4414 4415 // Emit constants. 4416 writeModuleConstants(); 4417 4418 // Emit metadata kind names. 4419 writeModuleMetadataKinds(); 4420 4421 // Emit metadata. 4422 writeModuleMetadata(); 4423 4424 // Emit module-level use-lists. 4425 if (VE.shouldPreserveUseListOrder()) 4426 writeUseListBlock(nullptr); 4427 4428 writeOperandBundleTags(); 4429 writeSyncScopeNames(); 4430 4431 // Emit function bodies. 4432 DenseMap<const Function *, uint64_t> FunctionToBitcodeIndex; 4433 for (Module::const_iterator F = M.begin(), E = M.end(); F != E; ++F) 4434 if (!F->isDeclaration()) 4435 writeFunction(*F, FunctionToBitcodeIndex); 4436 4437 // Need to write after the above call to WriteFunction which populates 4438 // the summary information in the index. 4439 if (Index) 4440 writePerModuleGlobalValueSummary(); 4441 4442 writeGlobalValueSymbolTable(FunctionToBitcodeIndex); 4443 4444 writeModuleHash(BlockStartPos); 4445 4446 Stream.ExitBlock(); 4447 } 4448 4449 static void writeInt32ToBuffer(uint32_t Value, SmallVectorImpl<char> &Buffer, 4450 uint32_t &Position) { 4451 support::endian::write32le(&Buffer[Position], Value); 4452 Position += 4; 4453 } 4454 4455 /// If generating a bc file on darwin, we have to emit a 4456 /// header and trailer to make it compatible with the system archiver. To do 4457 /// this we emit the following header, and then emit a trailer that pads the 4458 /// file out to be a multiple of 16 bytes. 4459 /// 4460 /// struct bc_header { 4461 /// uint32_t Magic; // 0x0B17C0DE 4462 /// uint32_t Version; // Version, currently always 0. 4463 /// uint32_t BitcodeOffset; // Offset to traditional bitcode file. 4464 /// uint32_t BitcodeSize; // Size of traditional bitcode file. 4465 /// uint32_t CPUType; // CPU specifier. 4466 /// ... potentially more later ... 4467 /// }; 4468 static void emitDarwinBCHeaderAndTrailer(SmallVectorImpl<char> &Buffer, 4469 const Triple &TT) { 4470 unsigned CPUType = ~0U; 4471 4472 // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*, 4473 // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic 4474 // number from /usr/include/mach/machine.h. It is ok to reproduce the 4475 // specific constants here because they are implicitly part of the Darwin ABI. 4476 enum { 4477 DARWIN_CPU_ARCH_ABI64 = 0x01000000, 4478 DARWIN_CPU_TYPE_X86 = 7, 4479 DARWIN_CPU_TYPE_ARM = 12, 4480 DARWIN_CPU_TYPE_POWERPC = 18 4481 }; 4482 4483 Triple::ArchType Arch = TT.getArch(); 4484 if (Arch == Triple::x86_64) 4485 CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64; 4486 else if (Arch == Triple::x86) 4487 CPUType = DARWIN_CPU_TYPE_X86; 4488 else if (Arch == Triple::ppc) 4489 CPUType = DARWIN_CPU_TYPE_POWERPC; 4490 else if (Arch == Triple::ppc64) 4491 CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64; 4492 else if (Arch == Triple::arm || Arch == Triple::thumb) 4493 CPUType = DARWIN_CPU_TYPE_ARM; 4494 4495 // Traditional Bitcode starts after header. 4496 assert(Buffer.size() >= BWH_HeaderSize && 4497 "Expected header size to be reserved"); 4498 unsigned BCOffset = BWH_HeaderSize; 4499 unsigned BCSize = Buffer.size() - BWH_HeaderSize; 4500 4501 // Write the magic and version. 4502 unsigned Position = 0; 4503 writeInt32ToBuffer(0x0B17C0DE, Buffer, Position); 4504 writeInt32ToBuffer(0, Buffer, Position); // Version. 4505 writeInt32ToBuffer(BCOffset, Buffer, Position); 4506 writeInt32ToBuffer(BCSize, Buffer, Position); 4507 writeInt32ToBuffer(CPUType, Buffer, Position); 4508 4509 // If the file is not a multiple of 16 bytes, insert dummy padding. 4510 while (Buffer.size() & 15) 4511 Buffer.push_back(0); 4512 } 4513 4514 /// Helper to write the header common to all bitcode files. 4515 static void writeBitcodeHeader(BitstreamWriter &Stream) { 4516 // Emit the file header. 4517 Stream.Emit((unsigned)'B', 8); 4518 Stream.Emit((unsigned)'C', 8); 4519 Stream.Emit(0x0, 4); 4520 Stream.Emit(0xC, 4); 4521 Stream.Emit(0xE, 4); 4522 Stream.Emit(0xD, 4); 4523 } 4524 4525 BitcodeWriter::BitcodeWriter(SmallVectorImpl<char> &Buffer, raw_fd_stream *FS) 4526 : Buffer(Buffer), Stream(new BitstreamWriter(Buffer, FS, FlushThreshold)) { 4527 writeBitcodeHeader(*Stream); 4528 } 4529 4530 BitcodeWriter::~BitcodeWriter() { assert(WroteStrtab); } 4531 4532 void BitcodeWriter::writeBlob(unsigned Block, unsigned Record, StringRef Blob) { 4533 Stream->EnterSubblock(Block, 3); 4534 4535 auto Abbv = std::make_shared<BitCodeAbbrev>(); 4536 Abbv->Add(BitCodeAbbrevOp(Record)); 4537 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 4538 auto AbbrevNo = Stream->EmitAbbrev(std::move(Abbv)); 4539 4540 Stream->EmitRecordWithBlob(AbbrevNo, ArrayRef<uint64_t>{Record}, Blob); 4541 4542 Stream->ExitBlock(); 4543 } 4544 4545 void BitcodeWriter::writeSymtab() { 4546 assert(!WroteStrtab && !WroteSymtab); 4547 4548 // If any module has module-level inline asm, we will require a registered asm 4549 // parser for the target so that we can create an accurate symbol table for 4550 // the module. 4551 for (Module *M : Mods) { 4552 if (M->getModuleInlineAsm().empty()) 4553 continue; 4554 4555 std::string Err; 4556 const Triple TT(M->getTargetTriple()); 4557 const Target *T = TargetRegistry::lookupTarget(TT.str(), Err); 4558 if (!T || !T->hasMCAsmParser()) 4559 return; 4560 } 4561 4562 WroteSymtab = true; 4563 SmallVector<char, 0> Symtab; 4564 // The irsymtab::build function may be unable to create a symbol table if the 4565 // module is malformed (e.g. it contains an invalid alias). Writing a symbol 4566 // table is not required for correctness, but we still want to be able to 4567 // write malformed modules to bitcode files, so swallow the error. 4568 if (Error E = irsymtab::build(Mods, Symtab, StrtabBuilder, Alloc)) { 4569 consumeError(std::move(E)); 4570 return; 4571 } 4572 4573 writeBlob(bitc::SYMTAB_BLOCK_ID, bitc::SYMTAB_BLOB, 4574 {Symtab.data(), Symtab.size()}); 4575 } 4576 4577 void BitcodeWriter::writeStrtab() { 4578 assert(!WroteStrtab); 4579 4580 std::vector<char> Strtab; 4581 StrtabBuilder.finalizeInOrder(); 4582 Strtab.resize(StrtabBuilder.getSize()); 4583 StrtabBuilder.write((uint8_t *)Strtab.data()); 4584 4585 writeBlob(bitc::STRTAB_BLOCK_ID, bitc::STRTAB_BLOB, 4586 {Strtab.data(), Strtab.size()}); 4587 4588 WroteStrtab = true; 4589 } 4590 4591 void BitcodeWriter::copyStrtab(StringRef Strtab) { 4592 writeBlob(bitc::STRTAB_BLOCK_ID, bitc::STRTAB_BLOB, Strtab); 4593 WroteStrtab = true; 4594 } 4595 4596 void BitcodeWriter::writeModule(const Module &M, 4597 bool ShouldPreserveUseListOrder, 4598 const ModuleSummaryIndex *Index, 4599 bool GenerateHash, ModuleHash *ModHash) { 4600 assert(!WroteStrtab); 4601 4602 // The Mods vector is used by irsymtab::build, which requires non-const 4603 // Modules in case it needs to materialize metadata. But the bitcode writer 4604 // requires that the module is materialized, so we can cast to non-const here, 4605 // after checking that it is in fact materialized. 4606 assert(M.isMaterialized()); 4607 Mods.push_back(const_cast<Module *>(&M)); 4608 4609 ModuleBitcodeWriter ModuleWriter(M, Buffer, StrtabBuilder, *Stream, 4610 ShouldPreserveUseListOrder, Index, 4611 GenerateHash, ModHash); 4612 ModuleWriter.write(); 4613 } 4614 4615 void BitcodeWriter::writeIndex( 4616 const ModuleSummaryIndex *Index, 4617 const std::map<std::string, GVSummaryMapTy> *ModuleToSummariesForIndex) { 4618 IndexBitcodeWriter IndexWriter(*Stream, StrtabBuilder, *Index, 4619 ModuleToSummariesForIndex); 4620 IndexWriter.write(); 4621 } 4622 4623 /// Write the specified module to the specified output stream. 4624 void llvm::WriteBitcodeToFile(const Module &M, raw_ostream &Out, 4625 bool ShouldPreserveUseListOrder, 4626 const ModuleSummaryIndex *Index, 4627 bool GenerateHash, ModuleHash *ModHash) { 4628 SmallVector<char, 0> Buffer; 4629 Buffer.reserve(256*1024); 4630 4631 // If this is darwin or another generic macho target, reserve space for the 4632 // header. 4633 Triple TT(M.getTargetTriple()); 4634 if (TT.isOSDarwin() || TT.isOSBinFormatMachO()) 4635 Buffer.insert(Buffer.begin(), BWH_HeaderSize, 0); 4636 4637 BitcodeWriter Writer(Buffer, dyn_cast<raw_fd_stream>(&Out)); 4638 Writer.writeModule(M, ShouldPreserveUseListOrder, Index, GenerateHash, 4639 ModHash); 4640 Writer.writeSymtab(); 4641 Writer.writeStrtab(); 4642 4643 if (TT.isOSDarwin() || TT.isOSBinFormatMachO()) 4644 emitDarwinBCHeaderAndTrailer(Buffer, TT); 4645 4646 // Write the generated bitstream to "Out". 4647 if (!Buffer.empty()) 4648 Out.write((char *)&Buffer.front(), Buffer.size()); 4649 } 4650 4651 void IndexBitcodeWriter::write() { 4652 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3); 4653 4654 writeModuleVersion(); 4655 4656 // Write the module paths in the combined index. 4657 writeModStrings(); 4658 4659 // Write the summary combined index records. 4660 writeCombinedGlobalValueSummary(); 4661 4662 Stream.ExitBlock(); 4663 } 4664 4665 // Write the specified module summary index to the given raw output stream, 4666 // where it will be written in a new bitcode block. This is used when 4667 // writing the combined index file for ThinLTO. When writing a subset of the 4668 // index for a distributed backend, provide a \p ModuleToSummariesForIndex map. 4669 void llvm::WriteIndexToFile( 4670 const ModuleSummaryIndex &Index, raw_ostream &Out, 4671 const std::map<std::string, GVSummaryMapTy> *ModuleToSummariesForIndex) { 4672 SmallVector<char, 0> Buffer; 4673 Buffer.reserve(256 * 1024); 4674 4675 BitcodeWriter Writer(Buffer); 4676 Writer.writeIndex(&Index, ModuleToSummariesForIndex); 4677 Writer.writeStrtab(); 4678 4679 Out.write((char *)&Buffer.front(), Buffer.size()); 4680 } 4681 4682 namespace { 4683 4684 /// Class to manage the bitcode writing for a thin link bitcode file. 4685 class ThinLinkBitcodeWriter : public ModuleBitcodeWriterBase { 4686 /// ModHash is for use in ThinLTO incremental build, generated while writing 4687 /// the module bitcode file. 4688 const ModuleHash *ModHash; 4689 4690 public: 4691 ThinLinkBitcodeWriter(const Module &M, StringTableBuilder &StrtabBuilder, 4692 BitstreamWriter &Stream, 4693 const ModuleSummaryIndex &Index, 4694 const ModuleHash &ModHash) 4695 : ModuleBitcodeWriterBase(M, StrtabBuilder, Stream, 4696 /*ShouldPreserveUseListOrder=*/false, &Index), 4697 ModHash(&ModHash) {} 4698 4699 void write(); 4700 4701 private: 4702 void writeSimplifiedModuleInfo(); 4703 }; 4704 4705 } // end anonymous namespace 4706 4707 // This function writes a simpilified module info for thin link bitcode file. 4708 // It only contains the source file name along with the name(the offset and 4709 // size in strtab) and linkage for global values. For the global value info 4710 // entry, in order to keep linkage at offset 5, there are three zeros used 4711 // as padding. 4712 void ThinLinkBitcodeWriter::writeSimplifiedModuleInfo() { 4713 SmallVector<unsigned, 64> Vals; 4714 // Emit the module's source file name. 4715 { 4716 StringEncoding Bits = getStringEncoding(M.getSourceFileName()); 4717 BitCodeAbbrevOp AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8); 4718 if (Bits == SE_Char6) 4719 AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Char6); 4720 else if (Bits == SE_Fixed7) 4721 AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7); 4722 4723 // MODULE_CODE_SOURCE_FILENAME: [namechar x N] 4724 auto Abbv = std::make_shared<BitCodeAbbrev>(); 4725 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_SOURCE_FILENAME)); 4726 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 4727 Abbv->Add(AbbrevOpToUse); 4728 unsigned FilenameAbbrev = Stream.EmitAbbrev(std::move(Abbv)); 4729 4730 for (const auto P : M.getSourceFileName()) 4731 Vals.push_back((unsigned char)P); 4732 4733 Stream.EmitRecord(bitc::MODULE_CODE_SOURCE_FILENAME, Vals, FilenameAbbrev); 4734 Vals.clear(); 4735 } 4736 4737 // Emit the global variable information. 4738 for (const GlobalVariable &GV : M.globals()) { 4739 // GLOBALVAR: [strtab offset, strtab size, 0, 0, 0, linkage] 4740 Vals.push_back(StrtabBuilder.add(GV.getName())); 4741 Vals.push_back(GV.getName().size()); 4742 Vals.push_back(0); 4743 Vals.push_back(0); 4744 Vals.push_back(0); 4745 Vals.push_back(getEncodedLinkage(GV)); 4746 4747 Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals); 4748 Vals.clear(); 4749 } 4750 4751 // Emit the function proto information. 4752 for (const Function &F : M) { 4753 // FUNCTION: [strtab offset, strtab size, 0, 0, 0, linkage] 4754 Vals.push_back(StrtabBuilder.add(F.getName())); 4755 Vals.push_back(F.getName().size()); 4756 Vals.push_back(0); 4757 Vals.push_back(0); 4758 Vals.push_back(0); 4759 Vals.push_back(getEncodedLinkage(F)); 4760 4761 Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals); 4762 Vals.clear(); 4763 } 4764 4765 // Emit the alias information. 4766 for (const GlobalAlias &A : M.aliases()) { 4767 // ALIAS: [strtab offset, strtab size, 0, 0, 0, linkage] 4768 Vals.push_back(StrtabBuilder.add(A.getName())); 4769 Vals.push_back(A.getName().size()); 4770 Vals.push_back(0); 4771 Vals.push_back(0); 4772 Vals.push_back(0); 4773 Vals.push_back(getEncodedLinkage(A)); 4774 4775 Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals); 4776 Vals.clear(); 4777 } 4778 4779 // Emit the ifunc information. 4780 for (const GlobalIFunc &I : M.ifuncs()) { 4781 // IFUNC: [strtab offset, strtab size, 0, 0, 0, linkage] 4782 Vals.push_back(StrtabBuilder.add(I.getName())); 4783 Vals.push_back(I.getName().size()); 4784 Vals.push_back(0); 4785 Vals.push_back(0); 4786 Vals.push_back(0); 4787 Vals.push_back(getEncodedLinkage(I)); 4788 4789 Stream.EmitRecord(bitc::MODULE_CODE_IFUNC, Vals); 4790 Vals.clear(); 4791 } 4792 } 4793 4794 void ThinLinkBitcodeWriter::write() { 4795 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3); 4796 4797 writeModuleVersion(); 4798 4799 writeSimplifiedModuleInfo(); 4800 4801 writePerModuleGlobalValueSummary(); 4802 4803 // Write module hash. 4804 Stream.EmitRecord(bitc::MODULE_CODE_HASH, ArrayRef<uint32_t>(*ModHash)); 4805 4806 Stream.ExitBlock(); 4807 } 4808 4809 void BitcodeWriter::writeThinLinkBitcode(const Module &M, 4810 const ModuleSummaryIndex &Index, 4811 const ModuleHash &ModHash) { 4812 assert(!WroteStrtab); 4813 4814 // The Mods vector is used by irsymtab::build, which requires non-const 4815 // Modules in case it needs to materialize metadata. But the bitcode writer 4816 // requires that the module is materialized, so we can cast to non-const here, 4817 // after checking that it is in fact materialized. 4818 assert(M.isMaterialized()); 4819 Mods.push_back(const_cast<Module *>(&M)); 4820 4821 ThinLinkBitcodeWriter ThinLinkWriter(M, StrtabBuilder, *Stream, Index, 4822 ModHash); 4823 ThinLinkWriter.write(); 4824 } 4825 4826 // Write the specified thin link bitcode file to the given raw output stream, 4827 // where it will be written in a new bitcode block. This is used when 4828 // writing the per-module index file for ThinLTO. 4829 void llvm::WriteThinLinkBitcodeToFile(const Module &M, raw_ostream &Out, 4830 const ModuleSummaryIndex &Index, 4831 const ModuleHash &ModHash) { 4832 SmallVector<char, 0> Buffer; 4833 Buffer.reserve(256 * 1024); 4834 4835 BitcodeWriter Writer(Buffer); 4836 Writer.writeThinLinkBitcode(M, Index, ModHash); 4837 Writer.writeSymtab(); 4838 Writer.writeStrtab(); 4839 4840 Out.write((char *)&Buffer.front(), Buffer.size()); 4841 } 4842 4843 static const char *getSectionNameForBitcode(const Triple &T) { 4844 switch (T.getObjectFormat()) { 4845 case Triple::MachO: 4846 return "__LLVM,__bitcode"; 4847 case Triple::COFF: 4848 case Triple::ELF: 4849 case Triple::Wasm: 4850 case Triple::UnknownObjectFormat: 4851 return ".llvmbc"; 4852 case Triple::GOFF: 4853 llvm_unreachable("GOFF is not yet implemented"); 4854 break; 4855 case Triple::XCOFF: 4856 llvm_unreachable("XCOFF is not yet implemented"); 4857 break; 4858 } 4859 llvm_unreachable("Unimplemented ObjectFormatType"); 4860 } 4861 4862 static const char *getSectionNameForCommandline(const Triple &T) { 4863 switch (T.getObjectFormat()) { 4864 case Triple::MachO: 4865 return "__LLVM,__cmdline"; 4866 case Triple::COFF: 4867 case Triple::ELF: 4868 case Triple::Wasm: 4869 case Triple::UnknownObjectFormat: 4870 return ".llvmcmd"; 4871 case Triple::GOFF: 4872 llvm_unreachable("GOFF is not yet implemented"); 4873 break; 4874 case Triple::XCOFF: 4875 llvm_unreachable("XCOFF is not yet implemented"); 4876 break; 4877 } 4878 llvm_unreachable("Unimplemented ObjectFormatType"); 4879 } 4880 4881 void llvm::EmbedBitcodeInModule(llvm::Module &M, llvm::MemoryBufferRef Buf, 4882 bool EmbedBitcode, bool EmbedCmdline, 4883 const std::vector<uint8_t> &CmdArgs) { 4884 // Save llvm.compiler.used and remove it. 4885 SmallVector<Constant *, 2> UsedArray; 4886 SmallVector<GlobalValue *, 4> UsedGlobals; 4887 Type *UsedElementType = Type::getInt8Ty(M.getContext())->getPointerTo(0); 4888 GlobalVariable *Used = collectUsedGlobalVariables(M, UsedGlobals, true); 4889 for (auto *GV : UsedGlobals) { 4890 if (GV->getName() != "llvm.embedded.module" && 4891 GV->getName() != "llvm.cmdline") 4892 UsedArray.push_back( 4893 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType)); 4894 } 4895 if (Used) 4896 Used->eraseFromParent(); 4897 4898 // Embed the bitcode for the llvm module. 4899 std::string Data; 4900 ArrayRef<uint8_t> ModuleData; 4901 Triple T(M.getTargetTriple()); 4902 4903 if (EmbedBitcode) { 4904 if (Buf.getBufferSize() == 0 || 4905 !isBitcode((const unsigned char *)Buf.getBufferStart(), 4906 (const unsigned char *)Buf.getBufferEnd())) { 4907 // If the input is LLVM Assembly, bitcode is produced by serializing 4908 // the module. Use-lists order need to be preserved in this case. 4909 llvm::raw_string_ostream OS(Data); 4910 llvm::WriteBitcodeToFile(M, OS, /* ShouldPreserveUseListOrder */ true); 4911 ModuleData = 4912 ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size()); 4913 } else 4914 // If the input is LLVM bitcode, write the input byte stream directly. 4915 ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(), 4916 Buf.getBufferSize()); 4917 } 4918 llvm::Constant *ModuleConstant = 4919 llvm::ConstantDataArray::get(M.getContext(), ModuleData); 4920 llvm::GlobalVariable *GV = new llvm::GlobalVariable( 4921 M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage, 4922 ModuleConstant); 4923 GV->setSection(getSectionNameForBitcode(T)); 4924 // Set alignment to 1 to prevent padding between two contributions from input 4925 // sections after linking. 4926 GV->setAlignment(Align(1)); 4927 UsedArray.push_back( 4928 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType)); 4929 if (llvm::GlobalVariable *Old = 4930 M.getGlobalVariable("llvm.embedded.module", true)) { 4931 assert(Old->hasOneUse() && 4932 "llvm.embedded.module can only be used once in llvm.compiler.used"); 4933 GV->takeName(Old); 4934 Old->eraseFromParent(); 4935 } else { 4936 GV->setName("llvm.embedded.module"); 4937 } 4938 4939 // Skip if only bitcode needs to be embedded. 4940 if (EmbedCmdline) { 4941 // Embed command-line options. 4942 ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CmdArgs.data()), 4943 CmdArgs.size()); 4944 llvm::Constant *CmdConstant = 4945 llvm::ConstantDataArray::get(M.getContext(), CmdData); 4946 GV = new llvm::GlobalVariable(M, CmdConstant->getType(), true, 4947 llvm::GlobalValue::PrivateLinkage, 4948 CmdConstant); 4949 GV->setSection(getSectionNameForCommandline(T)); 4950 GV->setAlignment(Align(1)); 4951 UsedArray.push_back( 4952 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType)); 4953 if (llvm::GlobalVariable *Old = M.getGlobalVariable("llvm.cmdline", true)) { 4954 assert(Old->hasOneUse() && 4955 "llvm.cmdline can only be used once in llvm.compiler.used"); 4956 GV->takeName(Old); 4957 Old->eraseFromParent(); 4958 } else { 4959 GV->setName("llvm.cmdline"); 4960 } 4961 } 4962 4963 if (UsedArray.empty()) 4964 return; 4965 4966 // Recreate llvm.compiler.used. 4967 ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size()); 4968 auto *NewUsed = new GlobalVariable( 4969 M, ATy, false, llvm::GlobalValue::AppendingLinkage, 4970 llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used"); 4971 NewUsed->setSection("llvm.metadata"); 4972 } 4973