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