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