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