1 //===-LTO.cpp - LLVM Link Time Optimizer ----------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file implements functions and classes used to support LTO. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/LTO/LTO.h" 15 #include "llvm/Analysis/TargetLibraryInfo.h" 16 #include "llvm/Analysis/TargetTransformInfo.h" 17 #include "llvm/Bitcode/BitcodeReader.h" 18 #include "llvm/Bitcode/BitcodeWriter.h" 19 #include "llvm/CodeGen/Analysis.h" 20 #include "llvm/IR/AutoUpgrade.h" 21 #include "llvm/IR/DiagnosticPrinter.h" 22 #include "llvm/IR/LegacyPassManager.h" 23 #include "llvm/IR/Mangler.h" 24 #include "llvm/IR/Metadata.h" 25 #include "llvm/LTO/LTOBackend.h" 26 #include "llvm/Linker/IRMover.h" 27 #include "llvm/Object/IRObjectFile.h" 28 #include "llvm/Support/Error.h" 29 #include "llvm/Support/ManagedStatic.h" 30 #include "llvm/Support/MemoryBuffer.h" 31 #include "llvm/Support/Path.h" 32 #include "llvm/Support/SHA1.h" 33 #include "llvm/Support/SourceMgr.h" 34 #include "llvm/Support/TargetRegistry.h" 35 #include "llvm/Support/ThreadPool.h" 36 #include "llvm/Support/Threading.h" 37 #include "llvm/Support/VCSRevision.h" 38 #include "llvm/Support/raw_ostream.h" 39 #include "llvm/Target/TargetMachine.h" 40 #include "llvm/Target/TargetOptions.h" 41 #include "llvm/Transforms/IPO.h" 42 #include "llvm/Transforms/IPO/PassManagerBuilder.h" 43 #include "llvm/Transforms/Utils/SplitModule.h" 44 45 #include <set> 46 47 using namespace llvm; 48 using namespace lto; 49 using namespace object; 50 51 #define DEBUG_TYPE "lto" 52 53 // The values are (type identifier, summary) pairs. 54 typedef DenseMap< 55 GlobalValue::GUID, 56 TinyPtrVector<const std::pair<const std::string, TypeIdSummary> *>> 57 TypeIdSummariesByGuidTy; 58 59 // Returns a unique hash for the Module considering the current list of 60 // export/import and other global analysis results. 61 // The hash is produced in \p Key. 62 static void computeCacheKey( 63 SmallString<40> &Key, const Config &Conf, const ModuleSummaryIndex &Index, 64 StringRef ModuleID, const FunctionImporter::ImportMapTy &ImportList, 65 const FunctionImporter::ExportSetTy &ExportList, 66 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 67 const GVSummaryMapTy &DefinedGlobals, 68 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid, 69 const std::set<GlobalValue::GUID> &CfiFunctionDefs, 70 const std::set<GlobalValue::GUID> &CfiFunctionDecls) { 71 // Compute the unique hash for this entry. 72 // This is based on the current compiler version, the module itself, the 73 // export list, the hash for every single module in the import list, the 74 // list of ResolvedODR for the module, and the list of preserved symbols. 75 SHA1 Hasher; 76 77 // Start with the compiler revision 78 Hasher.update(LLVM_VERSION_STRING); 79 #ifdef LLVM_REVISION 80 Hasher.update(LLVM_REVISION); 81 #endif 82 83 // Include the parts of the LTO configuration that affect code generation. 84 auto AddString = [&](StringRef Str) { 85 Hasher.update(Str); 86 Hasher.update(ArrayRef<uint8_t>{0}); 87 }; 88 auto AddUnsigned = [&](unsigned I) { 89 uint8_t Data[4]; 90 Data[0] = I; 91 Data[1] = I >> 8; 92 Data[2] = I >> 16; 93 Data[3] = I >> 24; 94 Hasher.update(ArrayRef<uint8_t>{Data, 4}); 95 }; 96 auto AddUint64 = [&](uint64_t I) { 97 uint8_t Data[8]; 98 Data[0] = I; 99 Data[1] = I >> 8; 100 Data[2] = I >> 16; 101 Data[3] = I >> 24; 102 Data[4] = I >> 32; 103 Data[5] = I >> 40; 104 Data[6] = I >> 48; 105 Data[7] = I >> 56; 106 Hasher.update(ArrayRef<uint8_t>{Data, 8}); 107 }; 108 AddString(Conf.CPU); 109 // FIXME: Hash more of Options. For now all clients initialize Options from 110 // command-line flags (which is unsupported in production), but may set 111 // RelaxELFRelocations. The clang driver can also pass FunctionSections, 112 // DataSections and DebuggerTuning via command line flags. 113 AddUnsigned(Conf.Options.RelaxELFRelocations); 114 AddUnsigned(Conf.Options.FunctionSections); 115 AddUnsigned(Conf.Options.DataSections); 116 AddUnsigned((unsigned)Conf.Options.DebuggerTuning); 117 for (auto &A : Conf.MAttrs) 118 AddString(A); 119 if (Conf.RelocModel) 120 AddUnsigned(*Conf.RelocModel); 121 else 122 AddUnsigned(-1); 123 if (Conf.CodeModel) 124 AddUnsigned(*Conf.CodeModel); 125 else 126 AddUnsigned(-1); 127 AddUnsigned(Conf.CGOptLevel); 128 AddUnsigned(Conf.CGFileType); 129 AddUnsigned(Conf.OptLevel); 130 AddUnsigned(Conf.UseNewPM); 131 AddString(Conf.OptPipeline); 132 AddString(Conf.AAPipeline); 133 AddString(Conf.OverrideTriple); 134 AddString(Conf.DefaultTriple); 135 136 // Include the hash for the current module 137 auto ModHash = Index.getModuleHash(ModuleID); 138 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash))); 139 for (auto F : ExportList) 140 // The export list can impact the internalization, be conservative here 141 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&F, sizeof(F))); 142 143 // Include the hash for every module we import functions from. The set of 144 // imported symbols for each module may affect code generation and is 145 // sensitive to link order, so include that as well. 146 for (auto &Entry : ImportList) { 147 auto ModHash = Index.getModuleHash(Entry.first()); 148 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash))); 149 150 AddUint64(Entry.second.size()); 151 for (auto &Fn : Entry.second) 152 AddUint64(Fn.first); 153 } 154 155 // Include the hash for the resolved ODR. 156 for (auto &Entry : ResolvedODR) { 157 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.first, 158 sizeof(GlobalValue::GUID))); 159 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.second, 160 sizeof(GlobalValue::LinkageTypes))); 161 } 162 163 // Members of CfiFunctionDefs and CfiFunctionDecls that are referenced or 164 // defined in this module. 165 std::set<GlobalValue::GUID> UsedCfiDefs; 166 std::set<GlobalValue::GUID> UsedCfiDecls; 167 168 // Typeids used in this module. 169 std::set<GlobalValue::GUID> UsedTypeIds; 170 171 auto AddUsedCfiGlobal = [&](GlobalValue::GUID ValueGUID) { 172 if (CfiFunctionDefs.count(ValueGUID)) 173 UsedCfiDefs.insert(ValueGUID); 174 if (CfiFunctionDecls.count(ValueGUID)) 175 UsedCfiDecls.insert(ValueGUID); 176 }; 177 178 auto AddUsedThings = [&](GlobalValueSummary *GS) { 179 if (!GS) return; 180 for (const ValueInfo &VI : GS->refs()) 181 AddUsedCfiGlobal(VI.getGUID()); 182 if (auto *FS = dyn_cast<FunctionSummary>(GS)) { 183 for (auto &TT : FS->type_tests()) 184 UsedTypeIds.insert(TT); 185 for (auto &TT : FS->type_test_assume_vcalls()) 186 UsedTypeIds.insert(TT.GUID); 187 for (auto &TT : FS->type_checked_load_vcalls()) 188 UsedTypeIds.insert(TT.GUID); 189 for (auto &TT : FS->type_test_assume_const_vcalls()) 190 UsedTypeIds.insert(TT.VFunc.GUID); 191 for (auto &TT : FS->type_checked_load_const_vcalls()) 192 UsedTypeIds.insert(TT.VFunc.GUID); 193 for (auto &ET : FS->calls()) 194 AddUsedCfiGlobal(ET.first.getGUID()); 195 } 196 }; 197 198 // Include the hash for the linkage type to reflect internalization and weak 199 // resolution, and collect any used type identifier resolutions. 200 for (auto &GS : DefinedGlobals) { 201 GlobalValue::LinkageTypes Linkage = GS.second->linkage(); 202 Hasher.update( 203 ArrayRef<uint8_t>((const uint8_t *)&Linkage, sizeof(Linkage))); 204 AddUsedCfiGlobal(GS.first); 205 AddUsedThings(GS.second); 206 } 207 208 // Imported functions may introduce new uses of type identifier resolutions, 209 // so we need to collect their used resolutions as well. 210 for (auto &ImpM : ImportList) 211 for (auto &ImpF : ImpM.second) 212 AddUsedThings(Index.findSummaryInModule(ImpF.first, ImpM.first())); 213 214 auto AddTypeIdSummary = [&](StringRef TId, const TypeIdSummary &S) { 215 AddString(TId); 216 217 AddUnsigned(S.TTRes.TheKind); 218 AddUnsigned(S.TTRes.SizeM1BitWidth); 219 220 AddUint64(S.TTRes.AlignLog2); 221 AddUint64(S.TTRes.SizeM1); 222 AddUint64(S.TTRes.BitMask); 223 AddUint64(S.TTRes.InlineBits); 224 225 AddUint64(S.WPDRes.size()); 226 for (auto &WPD : S.WPDRes) { 227 AddUnsigned(WPD.first); 228 AddUnsigned(WPD.second.TheKind); 229 AddString(WPD.second.SingleImplName); 230 231 AddUint64(WPD.second.ResByArg.size()); 232 for (auto &ByArg : WPD.second.ResByArg) { 233 AddUint64(ByArg.first.size()); 234 for (uint64_t Arg : ByArg.first) 235 AddUint64(Arg); 236 AddUnsigned(ByArg.second.TheKind); 237 AddUint64(ByArg.second.Info); 238 AddUnsigned(ByArg.second.Byte); 239 AddUnsigned(ByArg.second.Bit); 240 } 241 } 242 }; 243 244 // Include the hash for all type identifiers used by this module. 245 for (GlobalValue::GUID TId : UsedTypeIds) { 246 auto SummariesI = TypeIdSummariesByGuid.find(TId); 247 if (SummariesI != TypeIdSummariesByGuid.end()) 248 for (auto *Summary : SummariesI->second) 249 AddTypeIdSummary(Summary->first, Summary->second); 250 } 251 252 AddUnsigned(UsedCfiDefs.size()); 253 for (auto &V : UsedCfiDefs) 254 AddUint64(V); 255 256 AddUnsigned(UsedCfiDecls.size()); 257 for (auto &V : UsedCfiDecls) 258 AddUint64(V); 259 260 if (!Conf.SampleProfile.empty()) { 261 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile); 262 if (FileOrErr) 263 Hasher.update(FileOrErr.get()->getBuffer()); 264 } 265 266 Key = toHex(Hasher.result()); 267 } 268 269 static void thinLTOResolveWeakForLinkerGUID( 270 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID, 271 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias, 272 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)> 273 isPrevailing, 274 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)> 275 recordNewLinkage) { 276 for (auto &S : GVSummaryList) { 277 GlobalValue::LinkageTypes OriginalLinkage = S->linkage(); 278 if (!GlobalValue::isWeakForLinker(OriginalLinkage)) 279 continue; 280 // We need to emit only one of these. The prevailing module will keep it, 281 // but turned into a weak, while the others will drop it when possible. 282 // This is both a compile-time optimization and a correctness 283 // transformation. This is necessary for correctness when we have exported 284 // a reference - we need to convert the linkonce to weak to 285 // ensure a copy is kept to satisfy the exported reference. 286 // FIXME: We may want to split the compile time and correctness 287 // aspects into separate routines. 288 if (isPrevailing(GUID, S.get())) { 289 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage)) 290 S->setLinkage(GlobalValue::getWeakLinkage( 291 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage))); 292 } 293 // Alias and aliasee can't be turned into available_externally. 294 else if (!isa<AliasSummary>(S.get()) && 295 !GlobalInvolvedWithAlias.count(S.get())) 296 S->setLinkage(GlobalValue::AvailableExternallyLinkage); 297 if (S->linkage() != OriginalLinkage) 298 recordNewLinkage(S->modulePath(), GUID, S->linkage()); 299 } 300 } 301 302 // Resolve Weak and LinkOnce values in the \p Index. 303 // 304 // We'd like to drop these functions if they are no longer referenced in the 305 // current module. However there is a chance that another module is still 306 // referencing them because of the import. We make sure we always emit at least 307 // one copy. 308 void llvm::thinLTOResolveWeakForLinkerInIndex( 309 ModuleSummaryIndex &Index, 310 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)> 311 isPrevailing, 312 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)> 313 recordNewLinkage) { 314 // We won't optimize the globals that are referenced by an alias for now 315 // Ideally we should turn the alias into a global and duplicate the definition 316 // when needed. 317 DenseSet<GlobalValueSummary *> GlobalInvolvedWithAlias; 318 for (auto &I : Index) 319 for (auto &S : I.second.SummaryList) 320 if (auto AS = dyn_cast<AliasSummary>(S.get())) 321 GlobalInvolvedWithAlias.insert(&AS->getAliasee()); 322 323 for (auto &I : Index) 324 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first, 325 GlobalInvolvedWithAlias, isPrevailing, 326 recordNewLinkage); 327 } 328 329 static void thinLTOInternalizeAndPromoteGUID( 330 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID, 331 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) { 332 for (auto &S : GVSummaryList) { 333 if (isExported(S->modulePath(), GUID)) { 334 if (GlobalValue::isLocalLinkage(S->linkage())) 335 S->setLinkage(GlobalValue::ExternalLinkage); 336 } else if (!GlobalValue::isLocalLinkage(S->linkage())) 337 S->setLinkage(GlobalValue::InternalLinkage); 338 } 339 } 340 341 // Update the linkages in the given \p Index to mark exported values 342 // as external and non-exported values as internal. 343 void llvm::thinLTOInternalizeAndPromoteInIndex( 344 ModuleSummaryIndex &Index, 345 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) { 346 for (auto &I : Index) 347 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported); 348 } 349 350 // Requires a destructor for std::vector<InputModule>. 351 InputFile::~InputFile() = default; 352 353 Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) { 354 std::unique_ptr<InputFile> File(new InputFile); 355 356 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object); 357 if (!FOrErr) 358 return FOrErr.takeError(); 359 360 File->TargetTriple = FOrErr->TheReader.getTargetTriple(); 361 File->SourceFileName = FOrErr->TheReader.getSourceFileName(); 362 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts(); 363 File->ComdatTable = FOrErr->TheReader.getComdatTable(); 364 365 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) { 366 size_t Begin = File->Symbols.size(); 367 for (const irsymtab::Reader::SymbolRef &Sym : 368 FOrErr->TheReader.module_symbols(I)) 369 // Skip symbols that are irrelevant to LTO. Note that this condition needs 370 // to match the one in Skip() in LTO::addRegularLTO(). 371 if (Sym.isGlobal() && !Sym.isFormatSpecific()) 372 File->Symbols.push_back(Sym); 373 File->ModuleSymIndices.push_back({Begin, File->Symbols.size()}); 374 } 375 376 File->Mods = FOrErr->Mods; 377 File->Strtab = std::move(FOrErr->Strtab); 378 return std::move(File); 379 } 380 381 StringRef InputFile::getName() const { 382 return Mods[0].getModuleIdentifier(); 383 } 384 385 LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel, 386 Config &Conf) 387 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel), 388 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)), 389 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {} 390 391 LTO::ThinLTOState::ThinLTOState(ThinBackend Backend) 392 : Backend(Backend), CombinedIndex(/*IsPeformingAnalysis*/ false) { 393 if (!Backend) 394 this->Backend = 395 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency()); 396 } 397 398 LTO::LTO(Config Conf, ThinBackend Backend, 399 unsigned ParallelCodeGenParallelismLevel) 400 : Conf(std::move(Conf)), 401 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf), 402 ThinLTO(std::move(Backend)) {} 403 404 // Requires a destructor for MapVector<BitcodeModule>. 405 LTO::~LTO() = default; 406 407 // Add the symbols in the given module to the GlobalResolutions map, and resolve 408 // their partitions. 409 void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms, 410 ArrayRef<SymbolResolution> Res, 411 unsigned Partition, bool InSummary) { 412 auto *ResI = Res.begin(); 413 auto *ResE = Res.end(); 414 (void)ResE; 415 for (const InputFile::Symbol &Sym : Syms) { 416 assert(ResI != ResE); 417 SymbolResolution Res = *ResI++; 418 419 auto &GlobalRes = GlobalResolutions[Sym.getName()]; 420 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr(); 421 if (Res.Prevailing) { 422 assert(!GlobalRes.Prevailing && 423 "Multiple prevailing defs are not allowed"); 424 GlobalRes.Prevailing = true; 425 GlobalRes.IRName = Sym.getIRName(); 426 } 427 428 // Set the partition to external if we know it is re-defined by the linker 429 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a 430 // regular object, is referenced from llvm.compiler_used, or was already 431 // recorded as being referenced from a different partition. 432 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() || 433 (GlobalRes.Partition != GlobalResolution::Unknown && 434 GlobalRes.Partition != Partition)) { 435 GlobalRes.Partition = GlobalResolution::External; 436 } else 437 // First recorded reference, save the current partition. 438 GlobalRes.Partition = Partition; 439 440 // Flag as visible outside of summary if visible from a regular object or 441 // from a module that does not have a summary. 442 GlobalRes.VisibleOutsideSummary |= 443 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary); 444 } 445 } 446 447 static void writeToResolutionFile(raw_ostream &OS, InputFile *Input, 448 ArrayRef<SymbolResolution> Res) { 449 StringRef Path = Input->getName(); 450 OS << Path << '\n'; 451 auto ResI = Res.begin(); 452 for (const InputFile::Symbol &Sym : Input->symbols()) { 453 assert(ResI != Res.end()); 454 SymbolResolution Res = *ResI++; 455 456 OS << "-r=" << Path << ',' << Sym.getName() << ','; 457 if (Res.Prevailing) 458 OS << 'p'; 459 if (Res.FinalDefinitionInLinkageUnit) 460 OS << 'l'; 461 if (Res.VisibleToRegularObj) 462 OS << 'x'; 463 if (Res.LinkerRedefined) 464 OS << 'r'; 465 OS << '\n'; 466 } 467 OS.flush(); 468 assert(ResI == Res.end()); 469 } 470 471 Error LTO::add(std::unique_ptr<InputFile> Input, 472 ArrayRef<SymbolResolution> Res) { 473 assert(!CalledGetMaxTasks); 474 475 if (Conf.ResolutionFile) 476 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res); 477 478 if (RegularLTO.CombinedModule->getTargetTriple().empty()) 479 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple()); 480 481 const SymbolResolution *ResI = Res.begin(); 482 for (unsigned I = 0; I != Input->Mods.size(); ++I) 483 if (Error Err = addModule(*Input, I, ResI, Res.end())) 484 return Err; 485 486 assert(ResI == Res.end()); 487 return Error::success(); 488 } 489 490 Error LTO::addModule(InputFile &Input, unsigned ModI, 491 const SymbolResolution *&ResI, 492 const SymbolResolution *ResE) { 493 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo(); 494 if (!LTOInfo) 495 return LTOInfo.takeError(); 496 497 BitcodeModule BM = Input.Mods[ModI]; 498 auto ModSyms = Input.module_symbols(ModI); 499 addModuleToGlobalRes(ModSyms, {ResI, ResE}, 500 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0, 501 LTOInfo->HasSummary); 502 503 if (LTOInfo->IsThinLTO) 504 return addThinLTO(BM, ModSyms, ResI, ResE); 505 506 Expected<RegularLTOState::AddedModule> ModOrErr = 507 addRegularLTO(BM, ModSyms, ResI, ResE); 508 if (!ModOrErr) 509 return ModOrErr.takeError(); 510 511 if (!LTOInfo->HasSummary) 512 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false); 513 514 // Regular LTO module summaries are added to a dummy module that represents 515 // the combined regular LTO module. 516 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull)) 517 return Err; 518 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr)); 519 return Error::success(); 520 } 521 522 // Checks whether the given global value is in a non-prevailing comdat 523 // (comdat containing values the linker indicated were not prevailing, 524 // which we then dropped to available_externally), and if so, removes 525 // it from the comdat. This is called for all global values to ensure the 526 // comdat is empty rather than leaving an incomplete comdat. It is needed for 527 // regular LTO modules, in case we are in a mixed-LTO mode (both regular 528 // and thin LTO modules) compilation. Since the regular LTO module will be 529 // linked first in the final native link, we want to make sure the linker 530 // doesn't select any of these incomplete comdats that would be left 531 // in the regular LTO module without this cleanup. 532 static void 533 handleNonPrevailingComdat(GlobalValue &GV, 534 std::set<const Comdat *> &NonPrevailingComdats) { 535 Comdat *C = GV.getComdat(); 536 if (!C) 537 return; 538 539 if (!NonPrevailingComdats.count(C)) 540 return; 541 542 // Additionally need to drop externally visible global values from the comdat 543 // to available_externally, so that there aren't multiply defined linker 544 // errors. 545 if (!GV.hasLocalLinkage()) 546 GV.setLinkage(GlobalValue::AvailableExternallyLinkage); 547 548 if (auto GO = dyn_cast<GlobalObject>(&GV)) 549 GO->setComdat(nullptr); 550 } 551 552 // Add a regular LTO object to the link. 553 // The resulting module needs to be linked into the combined LTO module with 554 // linkRegularLTO. 555 Expected<LTO::RegularLTOState::AddedModule> 556 LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms, 557 const SymbolResolution *&ResI, 558 const SymbolResolution *ResE) { 559 RegularLTOState::AddedModule Mod; 560 Expected<std::unique_ptr<Module>> MOrErr = 561 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true, 562 /*IsImporting*/ false); 563 if (!MOrErr) 564 return MOrErr.takeError(); 565 Module &M = **MOrErr; 566 Mod.M = std::move(*MOrErr); 567 568 if (Error Err = M.materializeMetadata()) 569 return std::move(Err); 570 UpgradeDebugInfo(M); 571 572 ModuleSymbolTable SymTab; 573 SymTab.addModule(&M); 574 575 for (GlobalVariable &GV : M.globals()) 576 if (GV.hasAppendingLinkage()) 577 Mod.Keep.push_back(&GV); 578 579 DenseSet<GlobalObject *> AliasedGlobals; 580 for (auto &GA : M.aliases()) 581 if (GlobalObject *GO = GA.getBaseObject()) 582 AliasedGlobals.insert(GO); 583 584 // In this function we need IR GlobalValues matching the symbols in Syms 585 // (which is not backed by a module), so we need to enumerate them in the same 586 // order. The symbol enumeration order of a ModuleSymbolTable intentionally 587 // matches the order of an irsymtab, but when we read the irsymtab in 588 // InputFile::create we omit some symbols that are irrelevant to LTO. The 589 // Skip() function skips the same symbols from the module as InputFile does 590 // from the symbol table. 591 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end(); 592 auto Skip = [&]() { 593 while (MsymI != MsymE) { 594 auto Flags = SymTab.getSymbolFlags(*MsymI); 595 if ((Flags & object::BasicSymbolRef::SF_Global) && 596 !(Flags & object::BasicSymbolRef::SF_FormatSpecific)) 597 return; 598 ++MsymI; 599 } 600 }; 601 Skip(); 602 603 std::set<const Comdat *> NonPrevailingComdats; 604 for (const InputFile::Symbol &Sym : Syms) { 605 assert(ResI != ResE); 606 SymbolResolution Res = *ResI++; 607 608 assert(MsymI != MsymE); 609 ModuleSymbolTable::Symbol Msym = *MsymI++; 610 Skip(); 611 612 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) { 613 if (Res.Prevailing) { 614 if (Sym.isUndefined()) 615 continue; 616 Mod.Keep.push_back(GV); 617 // For symbols re-defined with linker -wrap and -defsym options, 618 // set the linkage to weak to inhibit IPO. The linkage will be 619 // restored by the linker. 620 if (Res.LinkerRedefined) 621 GV->setLinkage(GlobalValue::WeakAnyLinkage); 622 623 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage(); 624 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage)) 625 GV->setLinkage(GlobalValue::getWeakLinkage( 626 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage))); 627 } else if (isa<GlobalObject>(GV) && 628 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() || 629 GV->hasAvailableExternallyLinkage()) && 630 !AliasedGlobals.count(cast<GlobalObject>(GV))) { 631 // Any of the above three types of linkage indicates that the 632 // chosen prevailing symbol will have the same semantics as this copy of 633 // the symbol, so we may be able to link it with available_externally 634 // linkage. We will decide later whether to do that when we link this 635 // module (in linkRegularLTO), based on whether it is undefined. 636 Mod.Keep.push_back(GV); 637 GV->setLinkage(GlobalValue::AvailableExternallyLinkage); 638 if (GV->hasComdat()) 639 NonPrevailingComdats.insert(GV->getComdat()); 640 cast<GlobalObject>(GV)->setComdat(nullptr); 641 } 642 643 // Set the 'local' flag based on the linker resolution for this symbol. 644 if (Res.FinalDefinitionInLinkageUnit) 645 GV->setDSOLocal(true); 646 } 647 // Common resolution: collect the maximum size/alignment over all commons. 648 // We also record if we see an instance of a common as prevailing, so that 649 // if none is prevailing we can ignore it later. 650 if (Sym.isCommon()) { 651 // FIXME: We should figure out what to do about commons defined by asm. 652 // For now they aren't reported correctly by ModuleSymbolTable. 653 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()]; 654 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize()); 655 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment()); 656 CommonRes.Prevailing |= Res.Prevailing; 657 } 658 659 } 660 if (!M.getComdatSymbolTable().empty()) 661 for (GlobalValue &GV : M.global_values()) 662 handleNonPrevailingComdat(GV, NonPrevailingComdats); 663 assert(MsymI == MsymE); 664 return std::move(Mod); 665 } 666 667 Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod, 668 bool LivenessFromIndex) { 669 std::vector<GlobalValue *> Keep; 670 for (GlobalValue *GV : Mod.Keep) { 671 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID())) 672 continue; 673 674 if (!GV->hasAvailableExternallyLinkage()) { 675 Keep.push_back(GV); 676 continue; 677 } 678 679 // Only link available_externally definitions if we don't already have a 680 // definition. 681 GlobalValue *CombinedGV = 682 RegularLTO.CombinedModule->getNamedValue(GV->getName()); 683 if (CombinedGV && !CombinedGV->isDeclaration()) 684 continue; 685 686 Keep.push_back(GV); 687 } 688 689 return RegularLTO.Mover->move(std::move(Mod.M), Keep, 690 [](GlobalValue &, IRMover::ValueAdder) {}, 691 /* IsPerformingImport */ false); 692 } 693 694 // Add a ThinLTO module to the link. 695 Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms, 696 const SymbolResolution *&ResI, 697 const SymbolResolution *ResE) { 698 if (Error Err = 699 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(), 700 ThinLTO.ModuleMap.size())) 701 return Err; 702 703 for (const InputFile::Symbol &Sym : Syms) { 704 assert(ResI != ResE); 705 SymbolResolution Res = *ResI++; 706 707 if (!Sym.getIRName().empty()) { 708 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier( 709 Sym.getIRName(), GlobalValue::ExternalLinkage, "")); 710 if (Res.Prevailing) { 711 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier(); 712 713 // For linker redefined symbols (via --wrap or --defsym) we want to 714 // switch the linkage to `weak` to prevent IPOs from happening. 715 // Find the summary in the module for this very GV and record the new 716 // linkage so that we can switch it when we import the GV. 717 if (Res.LinkerRedefined) 718 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule( 719 GUID, BM.getModuleIdentifier())) 720 S->setLinkage(GlobalValue::WeakAnyLinkage); 721 } 722 723 // If the linker resolved the symbol to a local definition then mark it 724 // as local in the summary for the module we are adding. 725 if (Res.FinalDefinitionInLinkageUnit) { 726 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule( 727 GUID, BM.getModuleIdentifier())) { 728 S->setDSOLocal(true); 729 } 730 } 731 } 732 } 733 734 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second) 735 return make_error<StringError>( 736 "Expected at most one ThinLTO module per bitcode file", 737 inconvertibleErrorCode()); 738 739 return Error::success(); 740 } 741 742 unsigned LTO::getMaxTasks() const { 743 CalledGetMaxTasks = true; 744 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size(); 745 } 746 747 Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) { 748 // Compute "dead" symbols, we don't want to import/export these! 749 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols; 750 for (auto &Res : GlobalResolutions) 751 if (Res.second.VisibleOutsideSummary && Res.second.Prevailing) 752 GUIDPreservedSymbols.insert(GlobalValue::getGUID( 753 GlobalValue::dropLLVMManglingEscape(Res.second.IRName))); 754 755 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols); 756 757 if (auto E = runRegularLTO(AddStream)) 758 return E; 759 return runThinLTO(AddStream, Cache); 760 } 761 762 Error LTO::runRegularLTO(AddStreamFn AddStream) { 763 for (auto &M : RegularLTO.ModsWithSummaries) 764 if (Error Err = linkRegularLTO(std::move(M), 765 /*LivenessFromIndex=*/true)) 766 return Err; 767 768 // Make sure commons have the right size/alignment: we kept the largest from 769 // all the prevailing when adding the inputs, and we apply it here. 770 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout(); 771 for (auto &I : RegularLTO.Commons) { 772 if (!I.second.Prevailing) 773 // Don't do anything if no instance of this common was prevailing. 774 continue; 775 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first); 776 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) { 777 // Don't create a new global if the type is already correct, just make 778 // sure the alignment is correct. 779 OldGV->setAlignment(I.second.Align); 780 continue; 781 } 782 ArrayType *Ty = 783 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size); 784 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false, 785 GlobalValue::CommonLinkage, 786 ConstantAggregateZero::get(Ty), ""); 787 GV->setAlignment(I.second.Align); 788 if (OldGV) { 789 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType())); 790 GV->takeName(OldGV); 791 OldGV->eraseFromParent(); 792 } else { 793 GV->setName(I.first); 794 } 795 } 796 797 if (Conf.PreOptModuleHook && 798 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule)) 799 return Error::success(); 800 801 if (!Conf.CodeGenOnly) { 802 for (const auto &R : GlobalResolutions) { 803 if (!R.second.Prevailing) 804 continue; 805 if (R.second.Partition != 0 && 806 R.second.Partition != GlobalResolution::External) 807 continue; 808 809 GlobalValue *GV = 810 RegularLTO.CombinedModule->getNamedValue(R.second.IRName); 811 // Ignore symbols defined in other partitions. 812 if (!GV || GV->hasLocalLinkage()) 813 continue; 814 GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global 815 : GlobalValue::UnnamedAddr::None); 816 if (R.second.Partition == 0) 817 GV->setLinkage(GlobalValue::InternalLinkage); 818 } 819 820 if (Conf.PostInternalizeModuleHook && 821 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule)) 822 return Error::success(); 823 } 824 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel, 825 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex); 826 } 827 828 /// This class defines the interface to the ThinLTO backend. 829 class lto::ThinBackendProc { 830 protected: 831 Config &Conf; 832 ModuleSummaryIndex &CombinedIndex; 833 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries; 834 835 public: 836 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex, 837 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries) 838 : Conf(Conf), CombinedIndex(CombinedIndex), 839 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {} 840 841 virtual ~ThinBackendProc() {} 842 virtual Error start( 843 unsigned Task, BitcodeModule BM, 844 const FunctionImporter::ImportMapTy &ImportList, 845 const FunctionImporter::ExportSetTy &ExportList, 846 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 847 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0; 848 virtual Error wait() = 0; 849 }; 850 851 namespace { 852 class InProcessThinBackend : public ThinBackendProc { 853 ThreadPool BackendThreadPool; 854 AddStreamFn AddStream; 855 NativeObjectCache Cache; 856 TypeIdSummariesByGuidTy TypeIdSummariesByGuid; 857 std::set<GlobalValue::GUID> CfiFunctionDefs; 858 std::set<GlobalValue::GUID> CfiFunctionDecls; 859 860 Optional<Error> Err; 861 std::mutex ErrMu; 862 863 public: 864 InProcessThinBackend( 865 Config &Conf, ModuleSummaryIndex &CombinedIndex, 866 unsigned ThinLTOParallelismLevel, 867 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 868 AddStreamFn AddStream, NativeObjectCache Cache) 869 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries), 870 BackendThreadPool(ThinLTOParallelismLevel), 871 AddStream(std::move(AddStream)), Cache(std::move(Cache)) { 872 // Create a mapping from type identifier GUIDs to type identifier summaries. 873 // This allows backends to use the type identifier GUIDs stored in the 874 // function summaries to determine which type identifier summaries affect 875 // each function without needing to compute GUIDs in each backend. 876 for (auto &TId : CombinedIndex.typeIds()) 877 TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId); 878 for (auto &Name : CombinedIndex.cfiFunctionDefs()) 879 CfiFunctionDefs.insert( 880 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name))); 881 for (auto &Name : CombinedIndex.cfiFunctionDecls()) 882 CfiFunctionDecls.insert( 883 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name))); 884 } 885 886 Error runThinLTOBackendThread( 887 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task, 888 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex, 889 const FunctionImporter::ImportMapTy &ImportList, 890 const FunctionImporter::ExportSetTy &ExportList, 891 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 892 const GVSummaryMapTy &DefinedGlobals, 893 MapVector<StringRef, BitcodeModule> &ModuleMap, 894 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) { 895 auto RunThinBackend = [&](AddStreamFn AddStream) { 896 LTOLLVMContext BackendContext(Conf); 897 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext); 898 if (!MOrErr) 899 return MOrErr.takeError(); 900 901 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex, 902 ImportList, DefinedGlobals, ModuleMap); 903 }; 904 905 auto ModuleID = BM.getModuleIdentifier(); 906 907 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) || 908 all_of(CombinedIndex.getModuleHash(ModuleID), 909 [](uint32_t V) { return V == 0; })) 910 // Cache disabled or no entry for this module in the combined index or 911 // no module hash. 912 return RunThinBackend(AddStream); 913 914 SmallString<40> Key; 915 // The module may be cached, this helps handling it. 916 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList, 917 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid, 918 CfiFunctionDefs, CfiFunctionDecls); 919 if (AddStreamFn CacheAddStream = Cache(Task, Key)) 920 return RunThinBackend(CacheAddStream); 921 922 return Error::success(); 923 } 924 925 Error start( 926 unsigned Task, BitcodeModule BM, 927 const FunctionImporter::ImportMapTy &ImportList, 928 const FunctionImporter::ExportSetTy &ExportList, 929 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 930 MapVector<StringRef, BitcodeModule> &ModuleMap) override { 931 StringRef ModulePath = BM.getModuleIdentifier(); 932 assert(ModuleToDefinedGVSummaries.count(ModulePath)); 933 const GVSummaryMapTy &DefinedGlobals = 934 ModuleToDefinedGVSummaries.find(ModulePath)->second; 935 BackendThreadPool.async( 936 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex, 937 const FunctionImporter::ImportMapTy &ImportList, 938 const FunctionImporter::ExportSetTy &ExportList, 939 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> 940 &ResolvedODR, 941 const GVSummaryMapTy &DefinedGlobals, 942 MapVector<StringRef, BitcodeModule> &ModuleMap, 943 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) { 944 Error E = runThinLTOBackendThread( 945 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList, 946 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid); 947 if (E) { 948 std::unique_lock<std::mutex> L(ErrMu); 949 if (Err) 950 Err = joinErrors(std::move(*Err), std::move(E)); 951 else 952 Err = std::move(E); 953 } 954 }, 955 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList), 956 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap), 957 std::ref(TypeIdSummariesByGuid)); 958 return Error::success(); 959 } 960 961 Error wait() override { 962 BackendThreadPool.wait(); 963 if (Err) 964 return std::move(*Err); 965 else 966 return Error::success(); 967 } 968 }; 969 } // end anonymous namespace 970 971 ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) { 972 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex, 973 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 974 AddStreamFn AddStream, NativeObjectCache Cache) { 975 return llvm::make_unique<InProcessThinBackend>( 976 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries, 977 AddStream, Cache); 978 }; 979 } 980 981 // Given the original \p Path to an output file, replace any path 982 // prefix matching \p OldPrefix with \p NewPrefix. Also, create the 983 // resulting directory if it does not yet exist. 984 std::string lto::getThinLTOOutputFile(const std::string &Path, 985 const std::string &OldPrefix, 986 const std::string &NewPrefix) { 987 if (OldPrefix.empty() && NewPrefix.empty()) 988 return Path; 989 SmallString<128> NewPath(Path); 990 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix); 991 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str()); 992 if (!ParentPath.empty()) { 993 // Make sure the new directory exists, creating it if necessary. 994 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath)) 995 llvm::errs() << "warning: could not create directory '" << ParentPath 996 << "': " << EC.message() << '\n'; 997 } 998 return NewPath.str(); 999 } 1000 1001 namespace { 1002 class WriteIndexesThinBackend : public ThinBackendProc { 1003 std::string OldPrefix, NewPrefix; 1004 bool ShouldEmitImportsFiles; 1005 1006 std::string LinkedObjectsFileName; 1007 std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile; 1008 1009 public: 1010 WriteIndexesThinBackend( 1011 Config &Conf, ModuleSummaryIndex &CombinedIndex, 1012 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 1013 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles, 1014 std::string LinkedObjectsFileName) 1015 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries), 1016 OldPrefix(OldPrefix), NewPrefix(NewPrefix), 1017 ShouldEmitImportsFiles(ShouldEmitImportsFiles), 1018 LinkedObjectsFileName(LinkedObjectsFileName) {} 1019 1020 Error start( 1021 unsigned Task, BitcodeModule BM, 1022 const FunctionImporter::ImportMapTy &ImportList, 1023 const FunctionImporter::ExportSetTy &ExportList, 1024 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 1025 MapVector<StringRef, BitcodeModule> &ModuleMap) override { 1026 StringRef ModulePath = BM.getModuleIdentifier(); 1027 std::string NewModulePath = 1028 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix); 1029 1030 std::error_code EC; 1031 if (!LinkedObjectsFileName.empty()) { 1032 if (!LinkedObjectsFile) { 1033 LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>( 1034 LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None); 1035 if (EC) 1036 return errorCodeToError(EC); 1037 } 1038 *LinkedObjectsFile << NewModulePath << '\n'; 1039 } 1040 1041 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex; 1042 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries, 1043 ImportList, ModuleToSummariesForIndex); 1044 1045 raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC, 1046 sys::fs::OpenFlags::F_None); 1047 if (EC) 1048 return errorCodeToError(EC); 1049 WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex); 1050 1051 if (ShouldEmitImportsFiles) 1052 return errorCodeToError( 1053 EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList)); 1054 return Error::success(); 1055 } 1056 1057 Error wait() override { return Error::success(); } 1058 }; 1059 } // end anonymous namespace 1060 1061 ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix, 1062 std::string NewPrefix, 1063 bool ShouldEmitImportsFiles, 1064 std::string LinkedObjectsFile) { 1065 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex, 1066 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 1067 AddStreamFn AddStream, NativeObjectCache Cache) { 1068 return llvm::make_unique<WriteIndexesThinBackend>( 1069 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix, 1070 ShouldEmitImportsFiles, LinkedObjectsFile); 1071 }; 1072 } 1073 1074 Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) { 1075 if (ThinLTO.ModuleMap.empty()) 1076 return Error::success(); 1077 1078 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex)) 1079 return Error::success(); 1080 1081 // Collect for each module the list of function it defines (GUID -> 1082 // Summary). 1083 StringMap<GVSummaryMapTy> 1084 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size()); 1085 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule( 1086 ModuleToDefinedGVSummaries); 1087 // Create entries for any modules that didn't have any GV summaries 1088 // (either they didn't have any GVs to start with, or we suppressed 1089 // generation of the summaries because they e.g. had inline assembly 1090 // uses that couldn't be promoted/renamed on export). This is so 1091 // InProcessThinBackend::start can still launch a backend thread, which 1092 // is passed the map of summaries for the module, without any special 1093 // handling for this case. 1094 for (auto &Mod : ThinLTO.ModuleMap) 1095 if (!ModuleToDefinedGVSummaries.count(Mod.first)) 1096 ModuleToDefinedGVSummaries.try_emplace(Mod.first); 1097 1098 StringMap<FunctionImporter::ImportMapTy> ImportLists( 1099 ThinLTO.ModuleMap.size()); 1100 StringMap<FunctionImporter::ExportSetTy> ExportLists( 1101 ThinLTO.ModuleMap.size()); 1102 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR; 1103 1104 if (Conf.OptLevel > 0) 1105 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries, 1106 ImportLists, ExportLists); 1107 1108 // Figure out which symbols need to be internalized. This also needs to happen 1109 // at -O0 because summary-based DCE is implemented using internalization, and 1110 // we must apply DCE consistently with the full LTO module in order to avoid 1111 // undefined references during the final link. 1112 std::set<GlobalValue::GUID> ExportedGUIDs; 1113 for (auto &Res : GlobalResolutions) { 1114 // If the symbol does not have external references or it is not prevailing, 1115 // then not need to mark it as exported from a ThinLTO partition. 1116 if (Res.second.Partition != GlobalResolution::External || 1117 !Res.second.Prevailing) 1118 continue; 1119 auto GUID = GlobalValue::getGUID( 1120 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)); 1121 // Mark exported unless index-based analysis determined it to be dead. 1122 if (ThinLTO.CombinedIndex.isGUIDLive(GUID)) 1123 ExportedGUIDs.insert(GUID); 1124 } 1125 1126 // Any functions referenced by the jump table in the regular LTO object must 1127 // be exported. 1128 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs()) 1129 ExportedGUIDs.insert( 1130 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def))); 1131 1132 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) { 1133 const auto &ExportList = ExportLists.find(ModuleIdentifier); 1134 return (ExportList != ExportLists.end() && 1135 ExportList->second.count(GUID)) || 1136 ExportedGUIDs.count(GUID); 1137 }; 1138 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported); 1139 1140 auto isPrevailing = [&](GlobalValue::GUID GUID, 1141 const GlobalValueSummary *S) { 1142 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath(); 1143 }; 1144 auto recordNewLinkage = [&](StringRef ModuleIdentifier, 1145 GlobalValue::GUID GUID, 1146 GlobalValue::LinkageTypes NewLinkage) { 1147 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage; 1148 }; 1149 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing, 1150 recordNewLinkage); 1151 1152 std::unique_ptr<ThinBackendProc> BackendProc = 1153 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries, 1154 AddStream, Cache); 1155 1156 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined 1157 // module and parallel code generation partitions. 1158 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel; 1159 for (auto &Mod : ThinLTO.ModuleMap) { 1160 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first], 1161 ExportLists[Mod.first], 1162 ResolvedODR[Mod.first], ThinLTO.ModuleMap)) 1163 return E; 1164 ++Task; 1165 } 1166 1167 return BackendProc->wait(); 1168 } 1169 1170 Expected<std::unique_ptr<ToolOutputFile>> 1171 lto::setupOptimizationRemarks(LLVMContext &Context, 1172 StringRef LTORemarksFilename, 1173 bool LTOPassRemarksWithHotness, int Count) { 1174 if (LTORemarksFilename.empty()) 1175 return nullptr; 1176 1177 std::string Filename = LTORemarksFilename; 1178 if (Count != -1) 1179 Filename += ".thin." + llvm::utostr(Count) + ".yaml"; 1180 1181 std::error_code EC; 1182 auto DiagnosticFile = 1183 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None); 1184 if (EC) 1185 return errorCodeToError(EC); 1186 Context.setDiagnosticsOutputFile( 1187 llvm::make_unique<yaml::Output>(DiagnosticFile->os())); 1188 if (LTOPassRemarksWithHotness) 1189 Context.setDiagnosticsHotnessRequested(true); 1190 DiagnosticFile->keep(); 1191 return std::move(DiagnosticFile); 1192 } 1193