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