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