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