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) {} 389 390 LTO::ThinLTOState::ThinLTOState(ThinBackend Backend) : Backend(Backend) { 391 if (!Backend) 392 this->Backend = 393 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency()); 394 } 395 396 LTO::LTO(Config Conf, ThinBackend Backend, 397 unsigned ParallelCodeGenParallelismLevel) 398 : Conf(std::move(Conf)), 399 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf), 400 ThinLTO(std::move(Backend)) {} 401 402 // Requires a destructor for MapVector<BitcodeModule>. 403 LTO::~LTO() = default; 404 405 // Add the symbols in the given module to the GlobalResolutions map, and resolve 406 // their partitions. 407 void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms, 408 ArrayRef<SymbolResolution> Res, 409 unsigned Partition, bool InSummary) { 410 auto *ResI = Res.begin(); 411 auto *ResE = Res.end(); 412 (void)ResE; 413 for (const InputFile::Symbol &Sym : Syms) { 414 assert(ResI != ResE); 415 SymbolResolution Res = *ResI++; 416 417 auto &GlobalRes = GlobalResolutions[Sym.getName()]; 418 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr(); 419 if (Res.Prevailing) 420 GlobalRes.IRName = Sym.getIRName(); 421 422 // Set the partition to external if we know it is re-defined by the linker 423 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a 424 // regular object, is referenced from llvm.compiler_used, or was already 425 // recorded as being referenced from a different partition. 426 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() || 427 (GlobalRes.Partition != GlobalResolution::Unknown && 428 GlobalRes.Partition != Partition)) { 429 GlobalRes.Partition = GlobalResolution::External; 430 } else 431 // First recorded reference, save the current partition. 432 GlobalRes.Partition = Partition; 433 434 // Flag as visible outside of summary if visible from a regular object or 435 // from a module that does not have a summary. 436 GlobalRes.VisibleOutsideSummary |= 437 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary); 438 } 439 } 440 441 static void writeToResolutionFile(raw_ostream &OS, InputFile *Input, 442 ArrayRef<SymbolResolution> Res) { 443 StringRef Path = Input->getName(); 444 OS << Path << '\n'; 445 auto ResI = Res.begin(); 446 for (const InputFile::Symbol &Sym : Input->symbols()) { 447 assert(ResI != Res.end()); 448 SymbolResolution Res = *ResI++; 449 450 OS << "-r=" << Path << ',' << Sym.getName() << ','; 451 if (Res.Prevailing) 452 OS << 'p'; 453 if (Res.FinalDefinitionInLinkageUnit) 454 OS << 'l'; 455 if (Res.VisibleToRegularObj) 456 OS << 'x'; 457 if (Res.LinkerRedefined) 458 OS << 'r'; 459 OS << '\n'; 460 } 461 OS.flush(); 462 assert(ResI == Res.end()); 463 } 464 465 Error LTO::add(std::unique_ptr<InputFile> Input, 466 ArrayRef<SymbolResolution> Res) { 467 assert(!CalledGetMaxTasks); 468 469 if (Conf.ResolutionFile) 470 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res); 471 472 const SymbolResolution *ResI = Res.begin(); 473 for (unsigned I = 0; I != Input->Mods.size(); ++I) 474 if (Error Err = addModule(*Input, I, ResI, Res.end())) 475 return Err; 476 477 assert(ResI == Res.end()); 478 return Error::success(); 479 } 480 481 Error LTO::addModule(InputFile &Input, unsigned ModI, 482 const SymbolResolution *&ResI, 483 const SymbolResolution *ResE) { 484 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo(); 485 if (!LTOInfo) 486 return LTOInfo.takeError(); 487 488 BitcodeModule BM = Input.Mods[ModI]; 489 auto ModSyms = Input.module_symbols(ModI); 490 addModuleToGlobalRes(ModSyms, {ResI, ResE}, 491 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0, 492 LTOInfo->HasSummary); 493 494 if (LTOInfo->IsThinLTO) 495 return addThinLTO(BM, ModSyms, ResI, ResE); 496 497 Expected<RegularLTOState::AddedModule> ModOrErr = 498 addRegularLTO(BM, ModSyms, ResI, ResE); 499 if (!ModOrErr) 500 return ModOrErr.takeError(); 501 502 if (!LTOInfo->HasSummary) 503 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false); 504 505 // Regular LTO module summaries are added to a dummy module that represents 506 // the combined regular LTO module. 507 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull)) 508 return Err; 509 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr)); 510 return Error::success(); 511 } 512 513 // Checks whether the given global value is in a non-prevailing comdat 514 // (comdat containing values the linker indicated were not prevailing, 515 // which we then dropped to available_externally), and if so, removes 516 // it from the comdat. This is called for all global values to ensure the 517 // comdat is empty rather than leaving an incomplete comdat. It is needed for 518 // regular LTO modules, in case we are in a mixed-LTO mode (both regular 519 // and thin LTO modules) compilation. Since the regular LTO module will be 520 // linked first in the final native link, we want to make sure the linker 521 // doesn't select any of these incomplete comdats that would be left 522 // in the regular LTO module without this cleanup. 523 static void 524 handleNonPrevailingComdat(GlobalValue &GV, 525 std::set<const Comdat *> &NonPrevailingComdats) { 526 Comdat *C = GV.getComdat(); 527 if (!C) 528 return; 529 530 if (!NonPrevailingComdats.count(C)) 531 return; 532 533 // Additionally need to drop externally visible global values from the comdat 534 // to available_externally, so that there aren't multiply defined linker 535 // errors. 536 if (!GV.hasLocalLinkage()) 537 GV.setLinkage(GlobalValue::AvailableExternallyLinkage); 538 539 if (auto GO = dyn_cast<GlobalObject>(&GV)) 540 GO->setComdat(nullptr); 541 } 542 543 // Add a regular LTO object to the link. 544 // The resulting module needs to be linked into the combined LTO module with 545 // linkRegularLTO. 546 Expected<LTO::RegularLTOState::AddedModule> 547 LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms, 548 const SymbolResolution *&ResI, 549 const SymbolResolution *ResE) { 550 RegularLTOState::AddedModule Mod; 551 Expected<std::unique_ptr<Module>> MOrErr = 552 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true, 553 /*IsImporting*/ false); 554 if (!MOrErr) 555 return MOrErr.takeError(); 556 Module &M = **MOrErr; 557 Mod.M = std::move(*MOrErr); 558 559 if (Error Err = M.materializeMetadata()) 560 return std::move(Err); 561 UpgradeDebugInfo(M); 562 563 ModuleSymbolTable SymTab; 564 SymTab.addModule(&M); 565 566 for (GlobalVariable &GV : M.globals()) 567 if (GV.hasAppendingLinkage()) 568 Mod.Keep.push_back(&GV); 569 570 DenseSet<GlobalObject *> AliasedGlobals; 571 for (auto &GA : M.aliases()) 572 if (GlobalObject *GO = GA.getBaseObject()) 573 AliasedGlobals.insert(GO); 574 575 // In this function we need IR GlobalValues matching the symbols in Syms 576 // (which is not backed by a module), so we need to enumerate them in the same 577 // order. The symbol enumeration order of a ModuleSymbolTable intentionally 578 // matches the order of an irsymtab, but when we read the irsymtab in 579 // InputFile::create we omit some symbols that are irrelevant to LTO. The 580 // Skip() function skips the same symbols from the module as InputFile does 581 // from the symbol table. 582 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end(); 583 auto Skip = [&]() { 584 while (MsymI != MsymE) { 585 auto Flags = SymTab.getSymbolFlags(*MsymI); 586 if ((Flags & object::BasicSymbolRef::SF_Global) && 587 !(Flags & object::BasicSymbolRef::SF_FormatSpecific)) 588 return; 589 ++MsymI; 590 } 591 }; 592 Skip(); 593 594 std::set<const Comdat *> NonPrevailingComdats; 595 for (const InputFile::Symbol &Sym : Syms) { 596 assert(ResI != ResE); 597 SymbolResolution Res = *ResI++; 598 599 assert(MsymI != MsymE); 600 ModuleSymbolTable::Symbol Msym = *MsymI++; 601 Skip(); 602 603 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) { 604 if (Res.Prevailing) { 605 if (Sym.isUndefined()) 606 continue; 607 Mod.Keep.push_back(GV); 608 // For symbols re-defined with linker -wrap and -defsym options, 609 // set the linkage to weak to inhibit IPO. The linkage will be 610 // restored by the linker. 611 if (Res.LinkerRedefined) 612 GV->setLinkage(GlobalValue::WeakAnyLinkage); 613 614 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage(); 615 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage)) 616 GV->setLinkage(GlobalValue::getWeakLinkage( 617 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage))); 618 } else if (isa<GlobalObject>(GV) && 619 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() || 620 GV->hasAvailableExternallyLinkage()) && 621 !AliasedGlobals.count(cast<GlobalObject>(GV))) { 622 // Any of the above three types of linkage indicates that the 623 // chosen prevailing symbol will have the same semantics as this copy of 624 // the symbol, so we may be able to link it with available_externally 625 // linkage. We will decide later whether to do that when we link this 626 // module (in linkRegularLTO), based on whether it is undefined. 627 Mod.Keep.push_back(GV); 628 GV->setLinkage(GlobalValue::AvailableExternallyLinkage); 629 if (GV->hasComdat()) 630 NonPrevailingComdats.insert(GV->getComdat()); 631 cast<GlobalObject>(GV)->setComdat(nullptr); 632 } 633 634 // Set the 'local' flag based on the linker resolution for this symbol. 635 GV->setDSOLocal(Res.FinalDefinitionInLinkageUnit); 636 } 637 // Common resolution: collect the maximum size/alignment over all commons. 638 // We also record if we see an instance of a common as prevailing, so that 639 // if none is prevailing we can ignore it later. 640 if (Sym.isCommon()) { 641 // FIXME: We should figure out what to do about commons defined by asm. 642 // For now they aren't reported correctly by ModuleSymbolTable. 643 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()]; 644 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize()); 645 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment()); 646 CommonRes.Prevailing |= Res.Prevailing; 647 } 648 649 } 650 if (!M.getComdatSymbolTable().empty()) 651 for (GlobalValue &GV : M.global_values()) 652 handleNonPrevailingComdat(GV, NonPrevailingComdats); 653 assert(MsymI == MsymE); 654 return std::move(Mod); 655 } 656 657 Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod, 658 bool LivenessFromIndex) { 659 if (!RegularLTO.CombinedModule) { 660 RegularLTO.CombinedModule = 661 llvm::make_unique<Module>("ld-temp.o", RegularLTO.Ctx); 662 RegularLTO.Mover = llvm::make_unique<IRMover>(*RegularLTO.CombinedModule); 663 } 664 665 std::vector<GlobalValue *> Keep; 666 for (GlobalValue *GV : Mod.Keep) { 667 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID())) 668 continue; 669 670 if (!GV->hasAvailableExternallyLinkage()) { 671 Keep.push_back(GV); 672 continue; 673 } 674 675 // Only link available_externally definitions if we don't already have a 676 // definition. 677 GlobalValue *CombinedGV = 678 RegularLTO.CombinedModule->getNamedValue(GV->getName()); 679 if (CombinedGV && !CombinedGV->isDeclaration()) 680 continue; 681 682 Keep.push_back(GV); 683 } 684 685 return RegularLTO.Mover->move(std::move(Mod.M), Keep, 686 [](GlobalValue &, IRMover::ValueAdder) {}, 687 /* IsPerformingImport */ false); 688 } 689 690 // Add a ThinLTO module to the link. 691 Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms, 692 const SymbolResolution *&ResI, 693 const SymbolResolution *ResE) { 694 if (Error Err = 695 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(), 696 ThinLTO.ModuleMap.size())) 697 return Err; 698 699 for (const InputFile::Symbol &Sym : Syms) { 700 assert(ResI != ResE); 701 SymbolResolution Res = *ResI++; 702 703 if (!Sym.getIRName().empty()) { 704 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier( 705 Sym.getIRName(), GlobalValue::ExternalLinkage, "")); 706 if (Res.Prevailing) { 707 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier(); 708 709 // For linker redefined symbols (via --wrap or --defsym) we want to 710 // switch the linkage to `weak` to prevent IPOs from happening. 711 // Find the summary in the module for this very GV and record the new 712 // linkage so that we can switch it when we import the GV. 713 if (Res.LinkerRedefined) 714 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule( 715 GUID, BM.getModuleIdentifier())) 716 S->setLinkage(GlobalValue::WeakAnyLinkage); 717 } 718 719 // If the linker resolved the symbol to a local definition then mark it 720 // as local in the summary for the module we are adding. 721 if (Res.FinalDefinitionInLinkageUnit) { 722 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule( 723 GUID, BM.getModuleIdentifier())) { 724 S->setDSOLocal(true); 725 } 726 } 727 } 728 } 729 730 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second) 731 return make_error<StringError>( 732 "Expected at most one ThinLTO module per bitcode file", 733 inconvertibleErrorCode()); 734 735 return Error::success(); 736 } 737 738 unsigned LTO::getMaxTasks() const { 739 CalledGetMaxTasks = true; 740 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size(); 741 } 742 743 Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) { 744 // Compute "dead" symbols, we don't want to import/export these! 745 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols; 746 for (auto &Res : GlobalResolutions) { 747 if (Res.second.VisibleOutsideSummary && 748 // IRName will be defined if we have seen the prevailing copy of 749 // this value. If not, no need to preserve any ThinLTO copies. 750 !Res.second.IRName.empty()) 751 GUIDPreservedSymbols.insert(GlobalValue::getGUID( 752 GlobalValue::dropLLVMManglingEscape(Res.second.IRName))); 753 } 754 755 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols); 756 757 // Save the status of having a regularLTO combined module, as 758 // this is needed for generating the ThinLTO Task ID, and 759 // the CombinedModule will be moved at the end of runRegularLTO. 760 bool HasRegularLTO = RegularLTO.CombinedModule != nullptr || 761 !RegularLTO.ModsWithSummaries.empty(); 762 // Invoke regular LTO if there was a regular LTO module to start with. 763 if (HasRegularLTO) 764 if (auto E = runRegularLTO(AddStream)) 765 return E; 766 return runThinLTO(AddStream, Cache, HasRegularLTO); 767 } 768 769 Error LTO::runRegularLTO(AddStreamFn AddStream) { 770 for (auto &M : RegularLTO.ModsWithSummaries) 771 if (Error Err = linkRegularLTO(std::move(M), 772 /*LivenessFromIndex=*/true)) 773 return Err; 774 775 // Make sure commons have the right size/alignment: we kept the largest from 776 // all the prevailing when adding the inputs, and we apply it here. 777 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout(); 778 for (auto &I : RegularLTO.Commons) { 779 if (!I.second.Prevailing) 780 // Don't do anything if no instance of this common was prevailing. 781 continue; 782 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first); 783 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) { 784 // Don't create a new global if the type is already correct, just make 785 // sure the alignment is correct. 786 OldGV->setAlignment(I.second.Align); 787 continue; 788 } 789 ArrayType *Ty = 790 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size); 791 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false, 792 GlobalValue::CommonLinkage, 793 ConstantAggregateZero::get(Ty), ""); 794 GV->setAlignment(I.second.Align); 795 if (OldGV) { 796 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType())); 797 GV->takeName(OldGV); 798 OldGV->eraseFromParent(); 799 } else { 800 GV->setName(I.first); 801 } 802 } 803 804 if (Conf.PreOptModuleHook && 805 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule)) 806 return Error::success(); 807 808 if (!Conf.CodeGenOnly) { 809 for (const auto &R : GlobalResolutions) { 810 if (R.second.IRName.empty()) 811 continue; 812 if (R.second.Partition != 0 && 813 R.second.Partition != GlobalResolution::External) 814 continue; 815 816 GlobalValue *GV = 817 RegularLTO.CombinedModule->getNamedValue(R.second.IRName); 818 // Ignore symbols defined in other partitions. 819 if (!GV || GV->hasLocalLinkage()) 820 continue; 821 GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global 822 : GlobalValue::UnnamedAddr::None); 823 if (R.second.Partition == 0) 824 GV->setLinkage(GlobalValue::InternalLinkage); 825 } 826 827 if (Conf.PostInternalizeModuleHook && 828 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule)) 829 return Error::success(); 830 } 831 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel, 832 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex); 833 } 834 835 /// This class defines the interface to the ThinLTO backend. 836 class lto::ThinBackendProc { 837 protected: 838 Config &Conf; 839 ModuleSummaryIndex &CombinedIndex; 840 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries; 841 842 public: 843 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex, 844 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries) 845 : Conf(Conf), CombinedIndex(CombinedIndex), 846 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {} 847 848 virtual ~ThinBackendProc() {} 849 virtual Error start( 850 unsigned Task, BitcodeModule BM, 851 const FunctionImporter::ImportMapTy &ImportList, 852 const FunctionImporter::ExportSetTy &ExportList, 853 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 854 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0; 855 virtual Error wait() = 0; 856 }; 857 858 namespace { 859 class InProcessThinBackend : public ThinBackendProc { 860 ThreadPool BackendThreadPool; 861 AddStreamFn AddStream; 862 NativeObjectCache Cache; 863 TypeIdSummariesByGuidTy TypeIdSummariesByGuid; 864 std::set<GlobalValue::GUID> CfiFunctionDefs; 865 std::set<GlobalValue::GUID> CfiFunctionDecls; 866 867 Optional<Error> Err; 868 std::mutex ErrMu; 869 870 public: 871 InProcessThinBackend( 872 Config &Conf, ModuleSummaryIndex &CombinedIndex, 873 unsigned ThinLTOParallelismLevel, 874 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 875 AddStreamFn AddStream, NativeObjectCache Cache) 876 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries), 877 BackendThreadPool(ThinLTOParallelismLevel), 878 AddStream(std::move(AddStream)), Cache(std::move(Cache)) { 879 // Create a mapping from type identifier GUIDs to type identifier summaries. 880 // This allows backends to use the type identifier GUIDs stored in the 881 // function summaries to determine which type identifier summaries affect 882 // each function without needing to compute GUIDs in each backend. 883 for (auto &TId : CombinedIndex.typeIds()) 884 TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId); 885 for (auto &Name : CombinedIndex.cfiFunctionDefs()) 886 CfiFunctionDefs.insert( 887 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name))); 888 for (auto &Name : CombinedIndex.cfiFunctionDecls()) 889 CfiFunctionDecls.insert( 890 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name))); 891 } 892 893 Error runThinLTOBackendThread( 894 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task, 895 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex, 896 const FunctionImporter::ImportMapTy &ImportList, 897 const FunctionImporter::ExportSetTy &ExportList, 898 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 899 const GVSummaryMapTy &DefinedGlobals, 900 MapVector<StringRef, BitcodeModule> &ModuleMap, 901 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) { 902 auto RunThinBackend = [&](AddStreamFn AddStream) { 903 LTOLLVMContext BackendContext(Conf); 904 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext); 905 if (!MOrErr) 906 return MOrErr.takeError(); 907 908 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex, 909 ImportList, DefinedGlobals, ModuleMap); 910 }; 911 912 auto ModuleID = BM.getModuleIdentifier(); 913 914 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) || 915 all_of(CombinedIndex.getModuleHash(ModuleID), 916 [](uint32_t V) { return V == 0; })) 917 // Cache disabled or no entry for this module in the combined index or 918 // no module hash. 919 return RunThinBackend(AddStream); 920 921 SmallString<40> Key; 922 // The module may be cached, this helps handling it. 923 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList, 924 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid, 925 CfiFunctionDefs, CfiFunctionDecls); 926 if (AddStreamFn CacheAddStream = Cache(Task, Key)) 927 return RunThinBackend(CacheAddStream); 928 929 return Error::success(); 930 } 931 932 Error start( 933 unsigned Task, BitcodeModule BM, 934 const FunctionImporter::ImportMapTy &ImportList, 935 const FunctionImporter::ExportSetTy &ExportList, 936 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 937 MapVector<StringRef, BitcodeModule> &ModuleMap) override { 938 StringRef ModulePath = BM.getModuleIdentifier(); 939 assert(ModuleToDefinedGVSummaries.count(ModulePath)); 940 const GVSummaryMapTy &DefinedGlobals = 941 ModuleToDefinedGVSummaries.find(ModulePath)->second; 942 BackendThreadPool.async( 943 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex, 944 const FunctionImporter::ImportMapTy &ImportList, 945 const FunctionImporter::ExportSetTy &ExportList, 946 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> 947 &ResolvedODR, 948 const GVSummaryMapTy &DefinedGlobals, 949 MapVector<StringRef, BitcodeModule> &ModuleMap, 950 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) { 951 Error E = runThinLTOBackendThread( 952 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList, 953 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid); 954 if (E) { 955 std::unique_lock<std::mutex> L(ErrMu); 956 if (Err) 957 Err = joinErrors(std::move(*Err), std::move(E)); 958 else 959 Err = std::move(E); 960 } 961 }, 962 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList), 963 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap), 964 std::ref(TypeIdSummariesByGuid)); 965 return Error::success(); 966 } 967 968 Error wait() override { 969 BackendThreadPool.wait(); 970 if (Err) 971 return std::move(*Err); 972 else 973 return Error::success(); 974 } 975 }; 976 } // end anonymous namespace 977 978 ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) { 979 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex, 980 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 981 AddStreamFn AddStream, NativeObjectCache Cache) { 982 return llvm::make_unique<InProcessThinBackend>( 983 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries, 984 AddStream, Cache); 985 }; 986 } 987 988 // Given the original \p Path to an output file, replace any path 989 // prefix matching \p OldPrefix with \p NewPrefix. Also, create the 990 // resulting directory if it does not yet exist. 991 std::string lto::getThinLTOOutputFile(const std::string &Path, 992 const std::string &OldPrefix, 993 const std::string &NewPrefix) { 994 if (OldPrefix.empty() && NewPrefix.empty()) 995 return Path; 996 SmallString<128> NewPath(Path); 997 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix); 998 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str()); 999 if (!ParentPath.empty()) { 1000 // Make sure the new directory exists, creating it if necessary. 1001 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath)) 1002 llvm::errs() << "warning: could not create directory '" << ParentPath 1003 << "': " << EC.message() << '\n'; 1004 } 1005 return NewPath.str(); 1006 } 1007 1008 namespace { 1009 class WriteIndexesThinBackend : public ThinBackendProc { 1010 std::string OldPrefix, NewPrefix; 1011 bool ShouldEmitImportsFiles; 1012 1013 std::string LinkedObjectsFileName; 1014 std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile; 1015 1016 public: 1017 WriteIndexesThinBackend( 1018 Config &Conf, ModuleSummaryIndex &CombinedIndex, 1019 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 1020 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles, 1021 std::string LinkedObjectsFileName) 1022 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries), 1023 OldPrefix(OldPrefix), NewPrefix(NewPrefix), 1024 ShouldEmitImportsFiles(ShouldEmitImportsFiles), 1025 LinkedObjectsFileName(LinkedObjectsFileName) {} 1026 1027 Error start( 1028 unsigned Task, BitcodeModule BM, 1029 const FunctionImporter::ImportMapTy &ImportList, 1030 const FunctionImporter::ExportSetTy &ExportList, 1031 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR, 1032 MapVector<StringRef, BitcodeModule> &ModuleMap) override { 1033 StringRef ModulePath = BM.getModuleIdentifier(); 1034 std::string NewModulePath = 1035 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix); 1036 1037 std::error_code EC; 1038 if (!LinkedObjectsFileName.empty()) { 1039 if (!LinkedObjectsFile) { 1040 LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>( 1041 LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None); 1042 if (EC) 1043 return errorCodeToError(EC); 1044 } 1045 *LinkedObjectsFile << NewModulePath << '\n'; 1046 } 1047 1048 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex; 1049 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries, 1050 ImportList, ModuleToSummariesForIndex); 1051 1052 raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC, 1053 sys::fs::OpenFlags::F_None); 1054 if (EC) 1055 return errorCodeToError(EC); 1056 WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex); 1057 1058 if (ShouldEmitImportsFiles) 1059 return errorCodeToError( 1060 EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList)); 1061 return Error::success(); 1062 } 1063 1064 Error wait() override { return Error::success(); } 1065 }; 1066 } // end anonymous namespace 1067 1068 ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix, 1069 std::string NewPrefix, 1070 bool ShouldEmitImportsFiles, 1071 std::string LinkedObjectsFile) { 1072 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex, 1073 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries, 1074 AddStreamFn AddStream, NativeObjectCache Cache) { 1075 return llvm::make_unique<WriteIndexesThinBackend>( 1076 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix, 1077 ShouldEmitImportsFiles, LinkedObjectsFile); 1078 }; 1079 } 1080 1081 Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache, 1082 bool HasRegularLTO) { 1083 if (ThinLTO.ModuleMap.empty()) 1084 return Error::success(); 1085 1086 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex)) 1087 return Error::success(); 1088 1089 // Collect for each module the list of function it defines (GUID -> 1090 // Summary). 1091 StringMap<GVSummaryMapTy> 1092 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size()); 1093 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule( 1094 ModuleToDefinedGVSummaries); 1095 // Create entries for any modules that didn't have any GV summaries 1096 // (either they didn't have any GVs to start with, or we suppressed 1097 // generation of the summaries because they e.g. had inline assembly 1098 // uses that couldn't be promoted/renamed on export). This is so 1099 // InProcessThinBackend::start can still launch a backend thread, which 1100 // is passed the map of summaries for the module, without any special 1101 // handling for this case. 1102 for (auto &Mod : ThinLTO.ModuleMap) 1103 if (!ModuleToDefinedGVSummaries.count(Mod.first)) 1104 ModuleToDefinedGVSummaries.try_emplace(Mod.first); 1105 1106 StringMap<FunctionImporter::ImportMapTy> ImportLists( 1107 ThinLTO.ModuleMap.size()); 1108 StringMap<FunctionImporter::ExportSetTy> ExportLists( 1109 ThinLTO.ModuleMap.size()); 1110 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR; 1111 1112 if (Conf.OptLevel > 0) 1113 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries, 1114 ImportLists, ExportLists); 1115 1116 // Figure out which symbols need to be internalized. This also needs to happen 1117 // at -O0 because summary-based DCE is implemented using internalization, and 1118 // we must apply DCE consistently with the full LTO module in order to avoid 1119 // undefined references during the final link. 1120 std::set<GlobalValue::GUID> ExportedGUIDs; 1121 for (auto &Res : GlobalResolutions) { 1122 // First check if the symbol was flagged as having external references. 1123 if (Res.second.Partition != GlobalResolution::External) 1124 continue; 1125 // IRName will be defined if we have seen the prevailing copy of 1126 // this value. If not, no need to mark as exported from a ThinLTO 1127 // partition (and we can't get the GUID). 1128 if (Res.second.IRName.empty()) 1129 continue; 1130 auto GUID = GlobalValue::getGUID( 1131 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)); 1132 // Mark exported unless index-based analysis determined it to be dead. 1133 if (ThinLTO.CombinedIndex.isGUIDLive(GUID)) 1134 ExportedGUIDs.insert(GUID); 1135 } 1136 1137 // Any functions referenced by the jump table in the regular LTO object must 1138 // be exported. 1139 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs()) 1140 ExportedGUIDs.insert( 1141 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def))); 1142 1143 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) { 1144 const auto &ExportList = ExportLists.find(ModuleIdentifier); 1145 return (ExportList != ExportLists.end() && 1146 ExportList->second.count(GUID)) || 1147 ExportedGUIDs.count(GUID); 1148 }; 1149 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported); 1150 1151 auto isPrevailing = [&](GlobalValue::GUID GUID, 1152 const GlobalValueSummary *S) { 1153 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath(); 1154 }; 1155 auto recordNewLinkage = [&](StringRef ModuleIdentifier, 1156 GlobalValue::GUID GUID, 1157 GlobalValue::LinkageTypes NewLinkage) { 1158 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage; 1159 }; 1160 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing, 1161 recordNewLinkage); 1162 1163 std::unique_ptr<ThinBackendProc> BackendProc = 1164 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries, 1165 AddStream, Cache); 1166 1167 // Task numbers start at ParallelCodeGenParallelismLevel if an LTO 1168 // module is present, as tasks 0 through ParallelCodeGenParallelismLevel-1 1169 // are reserved for parallel code generation partitions. 1170 unsigned Task = 1171 HasRegularLTO ? RegularLTO.ParallelCodeGenParallelismLevel : 0; 1172 for (auto &Mod : ThinLTO.ModuleMap) { 1173 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first], 1174 ExportLists[Mod.first], 1175 ResolvedODR[Mod.first], ThinLTO.ModuleMap)) 1176 return E; 1177 ++Task; 1178 } 1179 1180 return BackendProc->wait(); 1181 } 1182 1183 Expected<std::unique_ptr<ToolOutputFile>> 1184 lto::setupOptimizationRemarks(LLVMContext &Context, 1185 StringRef LTORemarksFilename, 1186 bool LTOPassRemarksWithHotness, int Count) { 1187 if (LTORemarksFilename.empty()) 1188 return nullptr; 1189 1190 std::string Filename = LTORemarksFilename; 1191 if (Count != -1) 1192 Filename += ".thin." + llvm::utostr(Count) + ".yaml"; 1193 1194 std::error_code EC; 1195 auto DiagnosticFile = 1196 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None); 1197 if (EC) 1198 return errorCodeToError(EC); 1199 Context.setDiagnosticsOutputFile( 1200 llvm::make_unique<yaml::Output>(DiagnosticFile->os())); 1201 if (LTOPassRemarksWithHotness) 1202 Context.setDiagnosticsHotnessRequested(true); 1203 DiagnosticFile->keep(); 1204 return std::move(DiagnosticFile); 1205 } 1206