xref: /llvm-project-15.0.7/llvm/lib/LTO/LTO.cpp (revision 1524e67f)
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     // Common resolution: collect the maximum size/alignment over all commons.
635     // We also record if we see an instance of a common as prevailing, so that
636     // if none is prevailing we can ignore it later.
637     if (Sym.isCommon()) {
638       // FIXME: We should figure out what to do about commons defined by asm.
639       // For now they aren't reported correctly by ModuleSymbolTable.
640       auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
641       CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
642       CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
643       CommonRes.Prevailing |= Res.Prevailing;
644     }
645 
646     // FIXME: use proposed local attribute for FinalDefinitionInLinkageUnit.
647   }
648   if (!M.getComdatSymbolTable().empty())
649     for (GlobalValue &GV : M.global_values())
650       handleNonPrevailingComdat(GV, NonPrevailingComdats);
651   assert(MsymI == MsymE);
652   return std::move(Mod);
653 }
654 
655 Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
656                           bool LivenessFromIndex) {
657   if (!RegularLTO.CombinedModule) {
658     RegularLTO.CombinedModule =
659         llvm::make_unique<Module>("ld-temp.o", RegularLTO.Ctx);
660     RegularLTO.Mover = llvm::make_unique<IRMover>(*RegularLTO.CombinedModule);
661   }
662 
663   std::vector<GlobalValue *> Keep;
664   for (GlobalValue *GV : Mod.Keep) {
665     if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
666       continue;
667 
668     if (!GV->hasAvailableExternallyLinkage()) {
669       Keep.push_back(GV);
670       continue;
671     }
672 
673     // Only link available_externally definitions if we don't already have a
674     // definition.
675     GlobalValue *CombinedGV =
676         RegularLTO.CombinedModule->getNamedValue(GV->getName());
677     if (CombinedGV && !CombinedGV->isDeclaration())
678       continue;
679 
680     Keep.push_back(GV);
681   }
682 
683   return RegularLTO.Mover->move(std::move(Mod.M), Keep,
684                                 [](GlobalValue &, IRMover::ValueAdder) {},
685                                 /* IsPerformingImport */ false);
686 }
687 
688 // Add a ThinLTO module to the link.
689 Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
690                       const SymbolResolution *&ResI,
691                       const SymbolResolution *ResE) {
692   if (Error Err =
693           BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
694                          ThinLTO.ModuleMap.size()))
695     return Err;
696 
697   for (const InputFile::Symbol &Sym : Syms) {
698     assert(ResI != ResE);
699     SymbolResolution Res = *ResI++;
700 
701     if (Res.Prevailing) {
702       if (!Sym.getIRName().empty()) {
703         auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
704             Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
705         ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
706 
707         // For linker redefined symbols (via --wrap or --defsym) we want to
708         // switch the linkage to `weak` to prevent IPOs from happening.
709         // Find the summary in the module for this very GV and record the new
710         // linkage so that we can switch it when we import the GV.
711         if (Res.LinkerRedefined)
712           if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
713                   GUID, BM.getModuleIdentifier()))
714             S->setLinkage(GlobalValue::WeakAnyLinkage);
715       }
716     }
717   }
718 
719   if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second)
720     return make_error<StringError>(
721         "Expected at most one ThinLTO module per bitcode file",
722         inconvertibleErrorCode());
723 
724   return Error::success();
725 }
726 
727 unsigned LTO::getMaxTasks() const {
728   CalledGetMaxTasks = true;
729   return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
730 }
731 
732 Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
733   // Compute "dead" symbols, we don't want to import/export these!
734   DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
735   for (auto &Res : GlobalResolutions) {
736     if (Res.second.VisibleOutsideSummary &&
737         // IRName will be defined if we have seen the prevailing copy of
738         // this value. If not, no need to preserve any ThinLTO copies.
739         !Res.second.IRName.empty())
740       GUIDPreservedSymbols.insert(GlobalValue::getGUID(
741           GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
742   }
743 
744   computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols);
745 
746   // Save the status of having a regularLTO combined module, as
747   // this is needed for generating the ThinLTO Task ID, and
748   // the CombinedModule will be moved at the end of runRegularLTO.
749   bool HasRegularLTO = RegularLTO.CombinedModule != nullptr ||
750                        !RegularLTO.ModsWithSummaries.empty();
751   // Invoke regular LTO if there was a regular LTO module to start with.
752   if (HasRegularLTO)
753     if (auto E = runRegularLTO(AddStream))
754       return E;
755   return runThinLTO(AddStream, Cache, HasRegularLTO);
756 }
757 
758 Error LTO::runRegularLTO(AddStreamFn AddStream) {
759   for (auto &M : RegularLTO.ModsWithSummaries)
760     if (Error Err = linkRegularLTO(std::move(M),
761                                    /*LivenessFromIndex=*/true))
762       return Err;
763 
764   // Make sure commons have the right size/alignment: we kept the largest from
765   // all the prevailing when adding the inputs, and we apply it here.
766   const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
767   for (auto &I : RegularLTO.Commons) {
768     if (!I.second.Prevailing)
769       // Don't do anything if no instance of this common was prevailing.
770       continue;
771     GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
772     if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
773       // Don't create a new global if the type is already correct, just make
774       // sure the alignment is correct.
775       OldGV->setAlignment(I.second.Align);
776       continue;
777     }
778     ArrayType *Ty =
779         ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
780     auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false,
781                                   GlobalValue::CommonLinkage,
782                                   ConstantAggregateZero::get(Ty), "");
783     GV->setAlignment(I.second.Align);
784     if (OldGV) {
785       OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType()));
786       GV->takeName(OldGV);
787       OldGV->eraseFromParent();
788     } else {
789       GV->setName(I.first);
790     }
791   }
792 
793   if (Conf.PreOptModuleHook &&
794       !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
795     return Error::success();
796 
797   if (!Conf.CodeGenOnly) {
798     for (const auto &R : GlobalResolutions) {
799       if (R.second.IRName.empty())
800         continue;
801       if (R.second.Partition != 0 &&
802           R.second.Partition != GlobalResolution::External)
803         continue;
804 
805       GlobalValue *GV =
806           RegularLTO.CombinedModule->getNamedValue(R.second.IRName);
807       // Ignore symbols defined in other partitions.
808       if (!GV || GV->hasLocalLinkage())
809         continue;
810       GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global
811                                               : GlobalValue::UnnamedAddr::None);
812       if (R.second.Partition == 0)
813         GV->setLinkage(GlobalValue::InternalLinkage);
814     }
815 
816     if (Conf.PostInternalizeModuleHook &&
817         !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule))
818       return Error::success();
819   }
820   return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel,
821                  std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex);
822 }
823 
824 /// This class defines the interface to the ThinLTO backend.
825 class lto::ThinBackendProc {
826 protected:
827   Config &Conf;
828   ModuleSummaryIndex &CombinedIndex;
829   const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries;
830 
831 public:
832   ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex,
833                   const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries)
834       : Conf(Conf), CombinedIndex(CombinedIndex),
835         ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {}
836 
837   virtual ~ThinBackendProc() {}
838   virtual Error start(
839       unsigned Task, BitcodeModule BM,
840       const FunctionImporter::ImportMapTy &ImportList,
841       const FunctionImporter::ExportSetTy &ExportList,
842       const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
843       MapVector<StringRef, BitcodeModule> &ModuleMap) = 0;
844   virtual Error wait() = 0;
845 };
846 
847 namespace {
848 class InProcessThinBackend : public ThinBackendProc {
849   ThreadPool BackendThreadPool;
850   AddStreamFn AddStream;
851   NativeObjectCache Cache;
852   TypeIdSummariesByGuidTy TypeIdSummariesByGuid;
853   std::set<GlobalValue::GUID> CfiFunctionDefs;
854   std::set<GlobalValue::GUID> CfiFunctionDecls;
855 
856   Optional<Error> Err;
857   std::mutex ErrMu;
858 
859 public:
860   InProcessThinBackend(
861       Config &Conf, ModuleSummaryIndex &CombinedIndex,
862       unsigned ThinLTOParallelismLevel,
863       const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
864       AddStreamFn AddStream, NativeObjectCache Cache)
865       : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
866         BackendThreadPool(ThinLTOParallelismLevel),
867         AddStream(std::move(AddStream)), Cache(std::move(Cache)) {
868     // Create a mapping from type identifier GUIDs to type identifier summaries.
869     // This allows backends to use the type identifier GUIDs stored in the
870     // function summaries to determine which type identifier summaries affect
871     // each function without needing to compute GUIDs in each backend.
872     for (auto &TId : CombinedIndex.typeIds())
873       TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId);
874     for (auto &Name : CombinedIndex.cfiFunctionDefs())
875       CfiFunctionDefs.insert(
876           GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
877     for (auto &Name : CombinedIndex.cfiFunctionDecls())
878       CfiFunctionDecls.insert(
879           GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
880   }
881 
882   Error runThinLTOBackendThread(
883       AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
884       BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
885       const FunctionImporter::ImportMapTy &ImportList,
886       const FunctionImporter::ExportSetTy &ExportList,
887       const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
888       const GVSummaryMapTy &DefinedGlobals,
889       MapVector<StringRef, BitcodeModule> &ModuleMap,
890       const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
891     auto RunThinBackend = [&](AddStreamFn AddStream) {
892       LTOLLVMContext BackendContext(Conf);
893       Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
894       if (!MOrErr)
895         return MOrErr.takeError();
896 
897       return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
898                          ImportList, DefinedGlobals, ModuleMap);
899     };
900 
901     auto ModuleID = BM.getModuleIdentifier();
902 
903     if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) ||
904         all_of(CombinedIndex.getModuleHash(ModuleID),
905                [](uint32_t V) { return V == 0; }))
906       // Cache disabled or no entry for this module in the combined index or
907       // no module hash.
908       return RunThinBackend(AddStream);
909 
910     SmallString<40> Key;
911     // The module may be cached, this helps handling it.
912     computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
913                     ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid,
914                     CfiFunctionDefs, CfiFunctionDecls);
915     if (AddStreamFn CacheAddStream = Cache(Task, Key))
916       return RunThinBackend(CacheAddStream);
917 
918     return Error::success();
919   }
920 
921   Error start(
922       unsigned Task, BitcodeModule BM,
923       const FunctionImporter::ImportMapTy &ImportList,
924       const FunctionImporter::ExportSetTy &ExportList,
925       const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
926       MapVector<StringRef, BitcodeModule> &ModuleMap) override {
927     StringRef ModulePath = BM.getModuleIdentifier();
928     assert(ModuleToDefinedGVSummaries.count(ModulePath));
929     const GVSummaryMapTy &DefinedGlobals =
930         ModuleToDefinedGVSummaries.find(ModulePath)->second;
931     BackendThreadPool.async(
932         [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
933             const FunctionImporter::ImportMapTy &ImportList,
934             const FunctionImporter::ExportSetTy &ExportList,
935             const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
936                 &ResolvedODR,
937             const GVSummaryMapTy &DefinedGlobals,
938             MapVector<StringRef, BitcodeModule> &ModuleMap,
939             const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
940           Error E = runThinLTOBackendThread(
941               AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
942               ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid);
943           if (E) {
944             std::unique_lock<std::mutex> L(ErrMu);
945             if (Err)
946               Err = joinErrors(std::move(*Err), std::move(E));
947             else
948               Err = std::move(E);
949           }
950         },
951         BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
952         std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap),
953         std::ref(TypeIdSummariesByGuid));
954     return Error::success();
955   }
956 
957   Error wait() override {
958     BackendThreadPool.wait();
959     if (Err)
960       return std::move(*Err);
961     else
962       return Error::success();
963   }
964 };
965 } // end anonymous namespace
966 
967 ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
968   return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
969              const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
970              AddStreamFn AddStream, NativeObjectCache Cache) {
971     return llvm::make_unique<InProcessThinBackend>(
972         Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
973         AddStream, Cache);
974   };
975 }
976 
977 // Given the original \p Path to an output file, replace any path
978 // prefix matching \p OldPrefix with \p NewPrefix. Also, create the
979 // resulting directory if it does not yet exist.
980 std::string lto::getThinLTOOutputFile(const std::string &Path,
981                                       const std::string &OldPrefix,
982                                       const std::string &NewPrefix) {
983   if (OldPrefix.empty() && NewPrefix.empty())
984     return Path;
985   SmallString<128> NewPath(Path);
986   llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix);
987   StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str());
988   if (!ParentPath.empty()) {
989     // Make sure the new directory exists, creating it if necessary.
990     if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath))
991       llvm::errs() << "warning: could not create directory '" << ParentPath
992                    << "': " << EC.message() << '\n';
993   }
994   return NewPath.str();
995 }
996 
997 namespace {
998 class WriteIndexesThinBackend : public ThinBackendProc {
999   std::string OldPrefix, NewPrefix;
1000   bool ShouldEmitImportsFiles;
1001 
1002   std::string LinkedObjectsFileName;
1003   std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile;
1004 
1005 public:
1006   WriteIndexesThinBackend(
1007       Config &Conf, ModuleSummaryIndex &CombinedIndex,
1008       const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1009       std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
1010       std::string LinkedObjectsFileName)
1011       : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
1012         OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1013         ShouldEmitImportsFiles(ShouldEmitImportsFiles),
1014         LinkedObjectsFileName(LinkedObjectsFileName) {}
1015 
1016   Error start(
1017       unsigned Task, BitcodeModule BM,
1018       const FunctionImporter::ImportMapTy &ImportList,
1019       const FunctionImporter::ExportSetTy &ExportList,
1020       const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
1021       MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1022     StringRef ModulePath = BM.getModuleIdentifier();
1023     std::string NewModulePath =
1024         getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1025 
1026     std::error_code EC;
1027     if (!LinkedObjectsFileName.empty()) {
1028       if (!LinkedObjectsFile) {
1029         LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>(
1030             LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None);
1031         if (EC)
1032           return errorCodeToError(EC);
1033       }
1034       *LinkedObjectsFile << NewModulePath << '\n';
1035     }
1036 
1037     std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1038     gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
1039                                      ImportList, ModuleToSummariesForIndex);
1040 
1041     raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC,
1042                       sys::fs::OpenFlags::F_None);
1043     if (EC)
1044       return errorCodeToError(EC);
1045     WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex);
1046 
1047     if (ShouldEmitImportsFiles)
1048       return errorCodeToError(
1049           EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList));
1050     return Error::success();
1051   }
1052 
1053   Error wait() override { return Error::success(); }
1054 };
1055 } // end anonymous namespace
1056 
1057 ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix,
1058                                                std::string NewPrefix,
1059                                                bool ShouldEmitImportsFiles,
1060                                                std::string LinkedObjectsFile) {
1061   return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
1062              const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1063              AddStreamFn AddStream, NativeObjectCache Cache) {
1064     return llvm::make_unique<WriteIndexesThinBackend>(
1065         Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
1066         ShouldEmitImportsFiles, LinkedObjectsFile);
1067   };
1068 }
1069 
1070 Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache,
1071                       bool HasRegularLTO) {
1072   if (ThinLTO.ModuleMap.empty())
1073     return Error::success();
1074 
1075   if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
1076     return Error::success();
1077 
1078   // Collect for each module the list of function it defines (GUID ->
1079   // Summary).
1080   StringMap<GVSummaryMapTy>
1081       ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1082   ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1083       ModuleToDefinedGVSummaries);
1084   // Create entries for any modules that didn't have any GV summaries
1085   // (either they didn't have any GVs to start with, or we suppressed
1086   // generation of the summaries because they e.g. had inline assembly
1087   // uses that couldn't be promoted/renamed on export). This is so
1088   // InProcessThinBackend::start can still launch a backend thread, which
1089   // is passed the map of summaries for the module, without any special
1090   // handling for this case.
1091   for (auto &Mod : ThinLTO.ModuleMap)
1092     if (!ModuleToDefinedGVSummaries.count(Mod.first))
1093       ModuleToDefinedGVSummaries.try_emplace(Mod.first);
1094 
1095   StringMap<FunctionImporter::ImportMapTy> ImportLists(
1096       ThinLTO.ModuleMap.size());
1097   StringMap<FunctionImporter::ExportSetTy> ExportLists(
1098       ThinLTO.ModuleMap.size());
1099   StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
1100 
1101   if (Conf.OptLevel > 0)
1102     ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1103                              ImportLists, ExportLists);
1104 
1105   // Figure out which symbols need to be internalized. This also needs to happen
1106   // at -O0 because summary-based DCE is implemented using internalization, and
1107   // we must apply DCE consistently with the full LTO module in order to avoid
1108   // undefined references during the final link.
1109   std::set<GlobalValue::GUID> ExportedGUIDs;
1110   for (auto &Res : GlobalResolutions) {
1111     // First check if the symbol was flagged as having external references.
1112     if (Res.second.Partition != GlobalResolution::External)
1113       continue;
1114     // IRName will be defined if we have seen the prevailing copy of
1115     // this value. If not, no need to mark as exported from a ThinLTO
1116     // partition (and we can't get the GUID).
1117     if (Res.second.IRName.empty())
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   // Task numbers start at ParallelCodeGenParallelismLevel if an LTO
1157   // module is present, as tasks 0 through ParallelCodeGenParallelismLevel-1
1158   // are reserved for parallel code generation partitions.
1159   unsigned Task =
1160       HasRegularLTO ? RegularLTO.ParallelCodeGenParallelismLevel : 0;
1161   for (auto &Mod : ThinLTO.ModuleMap) {
1162     if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
1163                                      ExportLists[Mod.first],
1164                                      ResolvedODR[Mod.first], ThinLTO.ModuleMap))
1165       return E;
1166     ++Task;
1167   }
1168 
1169   return BackendProc->wait();
1170 }
1171 
1172 Expected<std::unique_ptr<ToolOutputFile>>
1173 lto::setupOptimizationRemarks(LLVMContext &Context,
1174                               StringRef LTORemarksFilename,
1175                               bool LTOPassRemarksWithHotness, int Count) {
1176   if (LTORemarksFilename.empty())
1177     return nullptr;
1178 
1179   std::string Filename = LTORemarksFilename;
1180   if (Count != -1)
1181     Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1182 
1183   std::error_code EC;
1184   auto DiagnosticFile =
1185       llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
1186   if (EC)
1187     return errorCodeToError(EC);
1188   Context.setDiagnosticsOutputFile(
1189       llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
1190   if (LTOPassRemarksWithHotness)
1191     Context.setDiagnosticsHotnessRequested(true);
1192   DiagnosticFile->keep();
1193   return std::move(DiagnosticFile);
1194 }
1195