blob: 69d46a594d3780a511ded060988d7fa0234047b6 [file] [log] [blame]
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001//===-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"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000015#include "llvm/Analysis/TargetLibraryInfo.h"
16#include "llvm/Analysis/TargetTransformInfo.h"
Teresa Johnsonad176792016-11-11 05:34:58 +000017#include "llvm/Bitcode/BitcodeReader.h"
18#include "llvm/Bitcode/BitcodeWriter.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000019#include "llvm/CodeGen/Analysis.h"
20#include "llvm/IR/AutoUpgrade.h"
21#include "llvm/IR/DiagnosticPrinter.h"
22#include "llvm/IR/LegacyPassManager.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000023#include "llvm/IR/Mangler.h"
24#include "llvm/IR/Metadata.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000025#include "llvm/LTO/LTOBackend.h"
26#include "llvm/Linker/IRMover.h"
Peter Collingbourne192d8522017-03-28 23:35:34 +000027#include "llvm/Object/IRObjectFile.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000028#include "llvm/Support/Error.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000029#include "llvm/Support/ManagedStatic.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000030#include "llvm/Support/MemoryBuffer.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000031#include "llvm/Support/Path.h"
Mehdi Aminiadc0e262016-08-23 21:30:12 +000032#include "llvm/Support/SHA1.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000033#include "llvm/Support/SourceMgr.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000034#include "llvm/Support/TargetRegistry.h"
35#include "llvm/Support/ThreadPool.h"
Teresa Johnsonec544c52016-10-19 17:35:01 +000036#include "llvm/Support/Threading.h"
Peter Collingbourne942fa562017-04-13 01:26:12 +000037#include "llvm/Support/VCSRevision.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000038#include "llvm/Support/raw_ostream.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000039#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"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000044
Teresa Johnson9ba95f92016-08-11 14:58:12 +000045#include <set>
46
47using namespace llvm;
48using namespace lto;
49using namespace object;
Teresa Johnsondf6edc52016-05-23 22:54:06 +000050
Mehdi Aminiadc0e262016-08-23 21:30:12 +000051#define DEBUG_TYPE "lto"
52
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000053// The values are (type identifier, summary) pairs.
54typedef DenseMap<
55 GlobalValue::GUID,
56 TinyPtrVector<const std::pair<const std::string, TypeIdSummary> *>>
57 TypeIdSummariesByGuidTy;
58
Mehdi Aminiadc0e262016-08-23 21:30:12 +000059// 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.
62static void computeCacheKey(
Peter Collingbournef4257522016-12-08 05:28:30 +000063 SmallString<40> &Key, const Config &Conf, const ModuleSummaryIndex &Index,
64 StringRef ModuleID, const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +000065 const FunctionImporter::ExportSetTy &ExportList,
66 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000067 const GVSummaryMapTy &DefinedGlobals,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +000068 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid,
69 const std::set<GlobalValue::GUID> &CfiFunctionDefs,
70 const std::set<GlobalValue::GUID> &CfiFunctionDecls) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +000071 // 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);
Peter Collingbourne942fa562017-04-13 01:26:12 +000079#ifdef LLVM_REVISION
Mehdi Aminiadc0e262016-08-23 21:30:12 +000080 Hasher.update(LLVM_REVISION);
81#endif
82
Peter Collingbournef4257522016-12-08 05:28:30 +000083 // 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 };
Peter Collingbourne54a52b72017-03-03 20:25:30 +000096 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 };
Peter Collingbournef4257522016-12-08 05:28:30 +0000108 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);
Evgeniy Stepanovb9f1b012017-05-22 21:11:35 +0000119 if (Conf.RelocModel)
120 AddUnsigned(*Conf.RelocModel);
121 else
122 AddUnsigned(-1);
Rafael Espindola79e238a2017-08-03 02:16:21 +0000123 if (Conf.CodeModel)
124 AddUnsigned(*Conf.CodeModel);
125 else
126 AddUnsigned(-1);
Peter Collingbournef4257522016-12-08 05:28:30 +0000127 AddUnsigned(Conf.CGOptLevel);
Tobias Edler von Kochf454b9e2017-02-15 20:36:36 +0000128 AddUnsigned(Conf.CGFileType);
Peter Collingbournef4257522016-12-08 05:28:30 +0000129 AddUnsigned(Conf.OptLevel);
Tim Shen4e912aa2017-06-01 23:13:44 +0000130 AddUnsigned(Conf.UseNewPM);
Peter Collingbournef4257522016-12-08 05:28:30 +0000131 AddString(Conf.OptPipeline);
132 AddString(Conf.AAPipeline);
133 AddString(Conf.OverrideTriple);
134 AddString(Conf.DefaultTriple);
135
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000136 // 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
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000143 // 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.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000146 for (auto &Entry : ImportList) {
147 auto ModHash = Index.getModuleHash(Entry.first());
148 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000149
150 AddUint64(Entry.second.size());
151 for (auto &Fn : Entry.second)
152 AddUint64(Fn.first);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000153 }
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
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000163 // 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.
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000169 std::set<GlobalValue::GUID> UsedTypeIds;
170
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000171 auto AddUsedCfiGlobal = [&](GlobalValue::GUID ValueGUID) {
172 if (CfiFunctionDefs.count(ValueGUID))
173 UsedCfiDefs.insert(ValueGUID);
174 if (CfiFunctionDecls.count(ValueGUID))
175 UsedCfiDecls.insert(ValueGUID);
176 };
177
178 auto AddUsedThings = [&](GlobalValueSummary *GS) {
179 if (!GS) return;
180 for (const ValueInfo &VI : GS->refs())
181 AddUsedCfiGlobal(VI.getGUID());
182 if (auto *FS = dyn_cast<FunctionSummary>(GS)) {
183 for (auto &TT : FS->type_tests())
184 UsedTypeIds.insert(TT);
185 for (auto &TT : FS->type_test_assume_vcalls())
186 UsedTypeIds.insert(TT.GUID);
187 for (auto &TT : FS->type_checked_load_vcalls())
188 UsedTypeIds.insert(TT.GUID);
189 for (auto &TT : FS->type_test_assume_const_vcalls())
190 UsedTypeIds.insert(TT.VFunc.GUID);
191 for (auto &TT : FS->type_checked_load_const_vcalls())
192 UsedTypeIds.insert(TT.VFunc.GUID);
193 for (auto &ET : FS->calls())
194 AddUsedCfiGlobal(ET.first.getGUID());
195 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000196 };
197
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000198 // Include the hash for the linkage type to reflect internalization and weak
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000199 // resolution, and collect any used type identifier resolutions.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000200 for (auto &GS : DefinedGlobals) {
201 GlobalValue::LinkageTypes Linkage = GS.second->linkage();
202 Hasher.update(
203 ArrayRef<uint8_t>((const uint8_t *)&Linkage, sizeof(Linkage)));
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000204 AddUsedCfiGlobal(GS.first);
205 AddUsedThings(GS.second);
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000206 }
207
208 // Imported functions may introduce new uses of type identifier resolutions,
209 // so we need to collect their used resolutions as well.
210 for (auto &ImpM : ImportList)
211 for (auto &ImpF : ImpM.second)
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000212 AddUsedThings(Index.findSummaryInModule(ImpF.first, ImpM.first()));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000213
214 auto AddTypeIdSummary = [&](StringRef TId, const TypeIdSummary &S) {
215 AddString(TId);
216
217 AddUnsigned(S.TTRes.TheKind);
218 AddUnsigned(S.TTRes.SizeM1BitWidth);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000219
Peter Collingbourneb9b60252017-09-11 22:49:10 +0000220 AddUint64(S.TTRes.AlignLog2);
221 AddUint64(S.TTRes.SizeM1);
222 AddUint64(S.TTRes.BitMask);
223 AddUint64(S.TTRes.InlineBits);
224
Peter Collingbourne711284b2017-03-10 21:37:10 +0000225 AddUint64(S.WPDRes.size());
226 for (auto &WPD : S.WPDRes) {
227 AddUnsigned(WPD.first);
228 AddUnsigned(WPD.second.TheKind);
229 AddString(WPD.second.SingleImplName);
230
231 AddUint64(WPD.second.ResByArg.size());
232 for (auto &ByArg : WPD.second.ResByArg) {
233 AddUint64(ByArg.first.size());
234 for (uint64_t Arg : ByArg.first)
235 AddUint64(Arg);
236 AddUnsigned(ByArg.second.TheKind);
237 AddUint64(ByArg.second.Info);
Peter Collingbourneb15a35e2017-09-11 22:34:42 +0000238 AddUnsigned(ByArg.second.Byte);
239 AddUnsigned(ByArg.second.Bit);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000240 }
241 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000242 };
243
244 // Include the hash for all type identifiers used by this module.
245 for (GlobalValue::GUID TId : UsedTypeIds) {
246 auto SummariesI = TypeIdSummariesByGuid.find(TId);
247 if (SummariesI != TypeIdSummariesByGuid.end())
248 for (auto *Summary : SummariesI->second)
249 AddTypeIdSummary(Summary->first, Summary->second);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000250 }
251
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000252 AddUnsigned(UsedCfiDefs.size());
253 for (auto &V : UsedCfiDefs)
254 AddUint64(V);
255
256 AddUnsigned(UsedCfiDecls.size());
257 for (auto &V : UsedCfiDecls)
258 AddUint64(V);
259
Dehao Chen27978002016-12-16 16:48:46 +0000260 if (!Conf.SampleProfile.empty()) {
261 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile);
262 if (FileOrErr)
263 Hasher.update(FileOrErr.get()->getBuffer());
264 }
265
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000266 Key = toHex(Hasher.result());
267}
268
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000269static void thinLTOResolveWeakForLinkerGUID(
270 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
271 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000272 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000273 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000274 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000275 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000276 for (auto &S : GVSummaryList) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000277 GlobalValue::LinkageTypes OriginalLinkage = S->linkage();
278 if (!GlobalValue::isWeakForLinker(OriginalLinkage))
279 continue;
Peter Collingbourne73589f32016-07-07 18:31:51 +0000280 // We need to emit only one of these. The prevailing module will keep it,
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000281 // but turned into a weak, while the others will drop it when possible.
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000282 // This is both a compile-time optimization and a correctness
283 // transformation. This is necessary for correctness when we have exported
284 // a reference - we need to convert the linkonce to weak to
285 // ensure a copy is kept to satisfy the exported reference.
286 // FIXME: We may want to split the compile time and correctness
287 // aspects into separate routines.
Peter Collingbourne73589f32016-07-07 18:31:51 +0000288 if (isPrevailing(GUID, S.get())) {
Teresa Johnson28c03b52016-05-26 14:16:52 +0000289 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
290 S->setLinkage(GlobalValue::getWeakLinkage(
291 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000292 }
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000293 // Alias and aliasee can't be turned into available_externally.
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000294 else if (!isa<AliasSummary>(S.get()) &&
Teresa Johnson4566c6d2017-01-20 21:54:58 +0000295 !GlobalInvolvedWithAlias.count(S.get()))
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000296 S->setLinkage(GlobalValue::AvailableExternallyLinkage);
297 if (S->linkage() != OriginalLinkage)
298 recordNewLinkage(S->modulePath(), GUID, S->linkage());
299 }
300}
301
302// Resolve Weak and LinkOnce values in the \p Index.
303//
304// We'd like to drop these functions if they are no longer referenced in the
305// current module. However there is a chance that another module is still
306// referencing them because of the import. We make sure we always emit at least
307// one copy.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000308void llvm::thinLTOResolveWeakForLinkerInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000309 ModuleSummaryIndex &Index,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000310 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000311 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000312 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000313 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000314 // We won't optimize the globals that are referenced by an alias for now
315 // Ideally we should turn the alias into a global and duplicate the definition
316 // when needed.
317 DenseSet<GlobalValueSummary *> GlobalInvolvedWithAlias;
318 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000319 for (auto &S : I.second.SummaryList)
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000320 if (auto AS = dyn_cast<AliasSummary>(S.get()))
321 GlobalInvolvedWithAlias.insert(&AS->getAliasee());
322
323 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000324 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first,
325 GlobalInvolvedWithAlias, isPrevailing,
326 recordNewLinkage);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000327}
328
329static void thinLTOInternalizeAndPromoteGUID(
330 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000331 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000332 for (auto &S : GVSummaryList) {
Mehdi Amini1380edf2017-02-03 07:41:43 +0000333 if (isExported(S->modulePath(), GUID)) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000334 if (GlobalValue::isLocalLinkage(S->linkage()))
335 S->setLinkage(GlobalValue::ExternalLinkage);
336 } else if (!GlobalValue::isLocalLinkage(S->linkage()))
337 S->setLinkage(GlobalValue::InternalLinkage);
338 }
339}
340
341// Update the linkages in the given \p Index to mark exported values
342// as external and non-exported values as internal.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000343void llvm::thinLTOInternalizeAndPromoteInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000344 ModuleSummaryIndex &Index,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000345 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000346 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000347 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000348}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000349
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000350// Requires a destructor for std::vector<InputModule>.
351InputFile::~InputFile() = default;
352
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000353Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) {
354 std::unique_ptr<InputFile> File(new InputFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000355
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000356 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object);
357 if (!FOrErr)
358 return FOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000359
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000360 File->TargetTriple = FOrErr->TheReader.getTargetTriple();
361 File->SourceFileName = FOrErr->TheReader.getSourceFileName();
362 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts();
363 File->ComdatTable = FOrErr->TheReader.getComdatTable();
Peter Collingbournead903692016-12-13 19:43:49 +0000364
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000365 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000366 size_t Begin = File->Symbols.size();
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000367 for (const irsymtab::Reader::SymbolRef &Sym :
368 FOrErr->TheReader.module_symbols(I))
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000369 // Skip symbols that are irrelevant to LTO. Note that this condition needs
370 // to match the one in Skip() in LTO::addRegularLTO().
371 if (Sym.isGlobal() && !Sym.isFormatSpecific())
372 File->Symbols.push_back(Sym);
373 File->ModuleSymIndices.push_back({Begin, File->Symbols.size()});
Rafael Espindola79121102016-10-25 12:02:03 +0000374 }
375
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000376 File->Mods = FOrErr->Mods;
377 File->Strtab = std::move(FOrErr->Strtab);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000378 return std::move(File);
379}
380
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000381StringRef InputFile::getName() const {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000382 return Mods[0].getModuleIdentifier();
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000383}
384
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000385LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel,
386 Config &Conf)
387 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel),
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000388 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)),
389 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000390
Eugene Leviant28d8a492018-01-22 13:35:40 +0000391LTO::ThinLTOState::ThinLTOState(ThinBackend Backend)
392 : Backend(Backend), CombinedIndex(/*IsPeformingAnalysis*/ false) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000393 if (!Backend)
Teresa Johnsonec544c52016-10-19 17:35:01 +0000394 this->Backend =
395 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency());
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000396}
397
398LTO::LTO(Config Conf, ThinBackend Backend,
399 unsigned ParallelCodeGenParallelismLevel)
400 : Conf(std::move(Conf)),
401 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf),
Mehdi Amini026ddbb2016-08-19 05:56:37 +0000402 ThinLTO(std::move(Backend)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000403
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000404// Requires a destructor for MapVector<BitcodeModule>.
405LTO::~LTO() = default;
406
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000407// Add the symbols in the given module to the GlobalResolutions map, and resolve
408// their partitions.
409void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms,
410 ArrayRef<SymbolResolution> Res,
411 unsigned Partition, bool InSummary) {
412 auto *ResI = Res.begin();
413 auto *ResE = Res.end();
Peter Collingbourne7e85b262017-06-15 17:41:32 +0000414 (void)ResE;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000415 for (const InputFile::Symbol &Sym : Syms) {
416 assert(ResI != ResE);
417 SymbolResolution Res = *ResI++;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000418
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000419 auto &GlobalRes = GlobalResolutions[Sym.getName()];
420 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr();
Eugene Leviant746f1522017-12-15 09:18:21 +0000421 if (Res.Prevailing) {
Eugene Leviantcb122492017-12-15 16:27:33 +0000422 assert(GlobalRes.IRName.empty() &&
423 "Multiple prevailing defs are not allowed");
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000424 GlobalRes.IRName = Sym.getIRName();
Eugene Leviant746f1522017-12-15 09:18:21 +0000425 }
Teresa Johnson6c475a72017-01-05 21:34:18 +0000426
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000427 // Set the partition to external if we know it is re-defined by the linker
428 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a
429 // regular object, is referenced from llvm.compiler_used, or was already
430 // recorded as being referenced from a different partition.
431 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() ||
432 (GlobalRes.Partition != GlobalResolution::Unknown &&
433 GlobalRes.Partition != Partition)) {
434 GlobalRes.Partition = GlobalResolution::External;
435 } else
436 // First recorded reference, save the current partition.
437 GlobalRes.Partition = Partition;
438
439 // Flag as visible outside of summary if visible from a regular object or
440 // from a module that does not have a summary.
441 GlobalRes.VisibleOutsideSummary |=
442 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary);
443 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000444}
445
Rafael Espindola7775c332016-08-26 20:19:35 +0000446static void writeToResolutionFile(raw_ostream &OS, InputFile *Input,
447 ArrayRef<SymbolResolution> Res) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000448 StringRef Path = Input->getName();
Rafael Espindola7775c332016-08-26 20:19:35 +0000449 OS << Path << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000450 auto ResI = Res.begin();
451 for (const InputFile::Symbol &Sym : Input->symbols()) {
452 assert(ResI != Res.end());
453 SymbolResolution Res = *ResI++;
454
Rafael Espindola7775c332016-08-26 20:19:35 +0000455 OS << "-r=" << Path << ',' << Sym.getName() << ',';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000456 if (Res.Prevailing)
Rafael Espindola7775c332016-08-26 20:19:35 +0000457 OS << 'p';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000458 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola7775c332016-08-26 20:19:35 +0000459 OS << 'l';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000460 if (Res.VisibleToRegularObj)
Rafael Espindola7775c332016-08-26 20:19:35 +0000461 OS << 'x';
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000462 if (Res.LinkerRedefined)
463 OS << 'r';
Rafael Espindola7775c332016-08-26 20:19:35 +0000464 OS << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000465 }
Peter Collingbourne58ffcfb2017-01-19 23:10:14 +0000466 OS.flush();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000467 assert(ResI == Res.end());
468}
469
470Error LTO::add(std::unique_ptr<InputFile> Input,
471 ArrayRef<SymbolResolution> Res) {
472 assert(!CalledGetMaxTasks);
473
474 if (Conf.ResolutionFile)
Rafael Espindola7775c332016-08-26 20:19:35 +0000475 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000476
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000477 if (RegularLTO.CombinedModule->getTargetTriple().empty())
478 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple());
479
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000480 const SymbolResolution *ResI = Res.begin();
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000481 for (unsigned I = 0; I != Input->Mods.size(); ++I)
482 if (Error Err = addModule(*Input, I, ResI, Res.end()))
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000483 return Err;
484
485 assert(ResI == Res.end());
486 return Error::success();
487}
488
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000489Error LTO::addModule(InputFile &Input, unsigned ModI,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000490 const SymbolResolution *&ResI,
491 const SymbolResolution *ResE) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000492 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo();
493 if (!LTOInfo)
494 return LTOInfo.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000495
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000496 BitcodeModule BM = Input.Mods[ModI];
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000497 auto ModSyms = Input.module_symbols(ModI);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000498 addModuleToGlobalRes(ModSyms, {ResI, ResE},
499 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0,
500 LTOInfo->HasSummary);
501
502 if (LTOInfo->IsThinLTO)
503 return addThinLTO(BM, ModSyms, ResI, ResE);
504
505 Expected<RegularLTOState::AddedModule> ModOrErr =
506 addRegularLTO(BM, ModSyms, ResI, ResE);
507 if (!ModOrErr)
508 return ModOrErr.takeError();
509
510 if (!LTOInfo->HasSummary)
511 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false);
512
513 // Regular LTO module summaries are added to a dummy module that represents
514 // the combined regular LTO module.
515 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull))
516 return Err;
517 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr));
518 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000519}
520
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000521// Checks whether the given global value is in a non-prevailing comdat
522// (comdat containing values the linker indicated were not prevailing,
523// which we then dropped to available_externally), and if so, removes
524// it from the comdat. This is called for all global values to ensure the
525// comdat is empty rather than leaving an incomplete comdat. It is needed for
526// regular LTO modules, in case we are in a mixed-LTO mode (both regular
527// and thin LTO modules) compilation. Since the regular LTO module will be
528// linked first in the final native link, we want to make sure the linker
529// doesn't select any of these incomplete comdats that would be left
530// in the regular LTO module without this cleanup.
531static void
532handleNonPrevailingComdat(GlobalValue &GV,
533 std::set<const Comdat *> &NonPrevailingComdats) {
534 Comdat *C = GV.getComdat();
535 if (!C)
536 return;
537
538 if (!NonPrevailingComdats.count(C))
539 return;
540
541 // Additionally need to drop externally visible global values from the comdat
542 // to available_externally, so that there aren't multiply defined linker
543 // errors.
544 if (!GV.hasLocalLinkage())
545 GV.setLinkage(GlobalValue::AvailableExternallyLinkage);
546
547 if (auto GO = dyn_cast<GlobalObject>(&GV))
548 GO->setComdat(nullptr);
549}
550
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000551// Add a regular LTO object to the link.
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000552// The resulting module needs to be linked into the combined LTO module with
553// linkRegularLTO.
554Expected<LTO::RegularLTOState::AddedModule>
555LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
556 const SymbolResolution *&ResI,
557 const SymbolResolution *ResE) {
558 RegularLTOState::AddedModule Mod;
Peter Collingbournead903692016-12-13 19:43:49 +0000559 Expected<std::unique_ptr<Module>> MOrErr =
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000560 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true,
561 /*IsImporting*/ false);
Peter Collingbournead903692016-12-13 19:43:49 +0000562 if (!MOrErr)
563 return MOrErr.takeError();
Peter Collingbournead903692016-12-13 19:43:49 +0000564 Module &M = **MOrErr;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000565 Mod.M = std::move(*MOrErr);
566
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000567 if (Error Err = M.materializeMetadata())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000568 return std::move(Err);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000569 UpgradeDebugInfo(M);
570
Peter Collingbournead903692016-12-13 19:43:49 +0000571 ModuleSymbolTable SymTab;
572 SymTab.addModule(&M);
573
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000574 for (GlobalVariable &GV : M.globals())
575 if (GV.hasAppendingLinkage())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000576 Mod.Keep.push_back(&GV);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000577
Peter Collingbourne46136262017-02-02 05:22:42 +0000578 DenseSet<GlobalObject *> AliasedGlobals;
579 for (auto &GA : M.aliases())
580 if (GlobalObject *GO = GA.getBaseObject())
581 AliasedGlobals.insert(GO);
582
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000583 // In this function we need IR GlobalValues matching the symbols in Syms
584 // (which is not backed by a module), so we need to enumerate them in the same
585 // order. The symbol enumeration order of a ModuleSymbolTable intentionally
586 // matches the order of an irsymtab, but when we read the irsymtab in
587 // InputFile::create we omit some symbols that are irrelevant to LTO. The
588 // Skip() function skips the same symbols from the module as InputFile does
589 // from the symbol table.
590 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end();
591 auto Skip = [&]() {
592 while (MsymI != MsymE) {
593 auto Flags = SymTab.getSymbolFlags(*MsymI);
594 if ((Flags & object::BasicSymbolRef::SF_Global) &&
595 !(Flags & object::BasicSymbolRef::SF_FormatSpecific))
596 return;
597 ++MsymI;
598 }
599 };
600 Skip();
601
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000602 std::set<const Comdat *> NonPrevailingComdats;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000603 for (const InputFile::Symbol &Sym : Syms) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000604 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000605 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000606
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000607 assert(MsymI != MsymE);
608 ModuleSymbolTable::Symbol Msym = *MsymI++;
609 Skip();
610
611 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) {
Peter Collingbournec387e702017-02-02 05:12:15 +0000612 if (Res.Prevailing) {
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000613 if (Sym.isUndefined())
Peter Collingbournec387e702017-02-02 05:12:15 +0000614 continue;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000615 Mod.Keep.push_back(GV);
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000616 // For symbols re-defined with linker -wrap and -defsym options,
617 // set the linkage to weak to inhibit IPO. The linkage will be
618 // restored by the linker.
619 if (Res.LinkerRedefined)
620 GV->setLinkage(GlobalValue::WeakAnyLinkage);
621
Davide Italianod4db1162017-05-26 21:56:14 +0000622 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage();
623 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
624 GV->setLinkage(GlobalValue::getWeakLinkage(
625 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Peter Collingbourne46136262017-02-02 05:22:42 +0000626 } else if (isa<GlobalObject>(GV) &&
627 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() ||
628 GV->hasAvailableExternallyLinkage()) &&
629 !AliasedGlobals.count(cast<GlobalObject>(GV))) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000630 // Any of the above three types of linkage indicates that the
Peter Collingbourne46136262017-02-02 05:22:42 +0000631 // chosen prevailing symbol will have the same semantics as this copy of
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000632 // the symbol, so we may be able to link it with available_externally
633 // linkage. We will decide later whether to do that when we link this
634 // module (in linkRegularLTO), based on whether it is undefined.
635 Mod.Keep.push_back(GV);
636 GV->setLinkage(GlobalValue::AvailableExternallyLinkage);
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000637 if (GV->hasComdat())
638 NonPrevailingComdats.insert(GV->getComdat());
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000639 cast<GlobalObject>(GV)->setComdat(nullptr);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000640 }
Sean Fertile4595a912017-11-04 17:04:39 +0000641
642 // Set the 'local' flag based on the linker resolution for this symbol.
Rafael Espindola8a1ca672018-01-18 05:38:43 +0000643 if (Res.FinalDefinitionInLinkageUnit)
644 GV->setDSOLocal(Res.FinalDefinitionInLinkageUnit);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000645 }
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000646 // Common resolution: collect the maximum size/alignment over all commons.
647 // We also record if we see an instance of a common as prevailing, so that
648 // if none is prevailing we can ignore it later.
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000649 if (Sym.isCommon()) {
Peter Collingbournefb8c2a42016-12-01 02:51:12 +0000650 // FIXME: We should figure out what to do about commons defined by asm.
651 // For now they aren't reported correctly by ModuleSymbolTable.
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000652 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000653 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
654 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000655 CommonRes.Prevailing |= Res.Prevailing;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000656 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000657
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000658 }
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000659 if (!M.getComdatSymbolTable().empty())
660 for (GlobalValue &GV : M.global_values())
661 handleNonPrevailingComdat(GV, NonPrevailingComdats);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000662 assert(MsymI == MsymE);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000663 return std::move(Mod);
664}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000665
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000666Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
667 bool LivenessFromIndex) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000668 std::vector<GlobalValue *> Keep;
669 for (GlobalValue *GV : Mod.Keep) {
670 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
671 continue;
672
673 if (!GV->hasAvailableExternallyLinkage()) {
674 Keep.push_back(GV);
675 continue;
676 }
677
678 // Only link available_externally definitions if we don't already have a
679 // definition.
680 GlobalValue *CombinedGV =
681 RegularLTO.CombinedModule->getNamedValue(GV->getName());
682 if (CombinedGV && !CombinedGV->isDeclaration())
683 continue;
684
685 Keep.push_back(GV);
686 }
687
688 return RegularLTO.Mover->move(std::move(Mod.M), Keep,
Teresa Johnson4b9b3792016-10-12 18:39:29 +0000689 [](GlobalValue &, IRMover::ValueAdder) {},
Teresa Johnson040cc162016-12-12 16:09:30 +0000690 /* IsPerformingImport */ false);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000691}
692
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000693// Add a ThinLTO module to the link.
694Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000695 const SymbolResolution *&ResI,
696 const SymbolResolution *ResE) {
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000697 if (Error Err =
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000698 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
699 ThinLTO.ModuleMap.size()))
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000700 return Err;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000701
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000702 for (const InputFile::Symbol &Sym : Syms) {
703 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000704 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000705
Sean Fertile4595a912017-11-04 17:04:39 +0000706 if (!Sym.getIRName().empty()) {
707 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
708 Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
709 if (Res.Prevailing) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000710 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
Davide Italiano6a5fbe52017-07-06 19:58:26 +0000711
712 // For linker redefined symbols (via --wrap or --defsym) we want to
713 // switch the linkage to `weak` to prevent IPOs from happening.
714 // Find the summary in the module for this very GV and record the new
715 // linkage so that we can switch it when we import the GV.
716 if (Res.LinkerRedefined)
717 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
718 GUID, BM.getModuleIdentifier()))
719 S->setLinkage(GlobalValue::WeakAnyLinkage);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000720 }
Sean Fertile4595a912017-11-04 17:04:39 +0000721
722 // If the linker resolved the symbol to a local definition then mark it
723 // as local in the summary for the module we are adding.
724 if (Res.FinalDefinitionInLinkageUnit) {
725 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
726 GUID, BM.getModuleIdentifier())) {
727 S->setDSOLocal(true);
728 }
729 }
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000730 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000731 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000732
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000733 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second)
734 return make_error<StringError>(
735 "Expected at most one ThinLTO module per bitcode file",
736 inconvertibleErrorCode());
737
Mehdi Amini41af4302016-11-11 04:28:40 +0000738 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000739}
740
Teresa Johnsonfaa75062016-08-11 20:38:39 +0000741unsigned LTO::getMaxTasks() const {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000742 CalledGetMaxTasks = true;
743 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
744}
745
Peter Collingbourne80186a52016-09-23 21:33:43 +0000746Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000747 // Compute "dead" symbols, we don't want to import/export these!
748 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
749 for (auto &Res : GlobalResolutions) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000750 if (Res.second.VisibleOutsideSummary &&
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000751 // IRName will be defined if we have seen the prevailing copy of
752 // this value. If not, no need to preserve any ThinLTO copies.
753 !Res.second.IRName.empty())
754 GUIDPreservedSymbols.insert(GlobalValue::getGUID(
755 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
756 }
757
758 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols);
759
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000760 if (auto E = runRegularLTO(AddStream))
761 return E;
762 return runThinLTO(AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000763}
764
Peter Collingbourne80186a52016-09-23 21:33:43 +0000765Error LTO::runRegularLTO(AddStreamFn AddStream) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000766 for (auto &M : RegularLTO.ModsWithSummaries)
767 if (Error Err = linkRegularLTO(std::move(M),
768 /*LivenessFromIndex=*/true))
769 return Err;
770
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000771 // Make sure commons have the right size/alignment: we kept the largest from
772 // all the prevailing when adding the inputs, and we apply it here.
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000773 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000774 for (auto &I : RegularLTO.Commons) {
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000775 if (!I.second.Prevailing)
776 // Don't do anything if no instance of this common was prevailing.
777 continue;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000778 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000779 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000780 // Don't create a new global if the type is already correct, just make
781 // sure the alignment is correct.
782 OldGV->setAlignment(I.second.Align);
783 continue;
784 }
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000785 ArrayType *Ty =
786 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000787 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false,
788 GlobalValue::CommonLinkage,
789 ConstantAggregateZero::get(Ty), "");
790 GV->setAlignment(I.second.Align);
791 if (OldGV) {
792 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType()));
793 GV->takeName(OldGV);
794 OldGV->eraseFromParent();
795 } else {
796 GV->setName(I.first);
797 }
798 }
799
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000800 if (Conf.PreOptModuleHook &&
801 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000802 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000803
Mehdi Aminid310b472016-08-22 06:25:41 +0000804 if (!Conf.CodeGenOnly) {
805 for (const auto &R : GlobalResolutions) {
806 if (R.second.IRName.empty())
807 continue;
808 if (R.second.Partition != 0 &&
809 R.second.Partition != GlobalResolution::External)
810 continue;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000811
Mehdi Aminid310b472016-08-22 06:25:41 +0000812 GlobalValue *GV =
813 RegularLTO.CombinedModule->getNamedValue(R.second.IRName);
814 // Ignore symbols defined in other partitions.
815 if (!GV || GV->hasLocalLinkage())
816 continue;
817 GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global
818 : GlobalValue::UnnamedAddr::None);
819 if (R.second.Partition == 0)
820 GV->setLinkage(GlobalValue::InternalLinkage);
821 }
822
823 if (Conf.PostInternalizeModuleHook &&
824 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000825 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000826 }
Peter Collingbourne80186a52016-09-23 21:33:43 +0000827 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel,
Peter Collingbournee02b74e2017-01-20 22:18:52 +0000828 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000829}
830
831/// This class defines the interface to the ThinLTO backend.
832class lto::ThinBackendProc {
833protected:
834 Config &Conf;
835 ModuleSummaryIndex &CombinedIndex;
Mehdi Amini767e1452016-09-06 03:23:45 +0000836 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000837
838public:
839 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +0000840 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries)
Mehdi Amini18b91112016-08-19 06:10:03 +0000841 : Conf(Conf), CombinedIndex(CombinedIndex),
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000842 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {}
843
844 virtual ~ThinBackendProc() {}
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000845 virtual Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000846 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000847 const FunctionImporter::ImportMapTy &ImportList,
848 const FunctionImporter::ExportSetTy &ExportList,
849 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000850 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000851 virtual Error wait() = 0;
852};
853
Benjamin Kramerffd37152016-11-19 20:44:26 +0000854namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000855class InProcessThinBackend : public ThinBackendProc {
856 ThreadPool BackendThreadPool;
Peter Collingbourne80186a52016-09-23 21:33:43 +0000857 AddStreamFn AddStream;
858 NativeObjectCache Cache;
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000859 TypeIdSummariesByGuidTy TypeIdSummariesByGuid;
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000860 std::set<GlobalValue::GUID> CfiFunctionDefs;
861 std::set<GlobalValue::GUID> CfiFunctionDecls;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000862
863 Optional<Error> Err;
864 std::mutex ErrMu;
865
866public:
Mehdi Amini767e1452016-09-06 03:23:45 +0000867 InProcessThinBackend(
868 Config &Conf, ModuleSummaryIndex &CombinedIndex,
869 unsigned ThinLTOParallelismLevel,
870 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000871 AddStreamFn AddStream, NativeObjectCache Cache)
Mehdi Amini18b91112016-08-19 06:10:03 +0000872 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
873 BackendThreadPool(ThinLTOParallelismLevel),
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000874 AddStream(std::move(AddStream)), Cache(std::move(Cache)) {
875 // Create a mapping from type identifier GUIDs to type identifier summaries.
876 // This allows backends to use the type identifier GUIDs stored in the
877 // function summaries to determine which type identifier summaries affect
878 // each function without needing to compute GUIDs in each backend.
879 for (auto &TId : CombinedIndex.typeIds())
880 TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId);
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000881 for (auto &Name : CombinedIndex.cfiFunctionDefs())
882 CfiFunctionDefs.insert(
883 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
884 for (auto &Name : CombinedIndex.cfiFunctionDecls())
885 CfiFunctionDecls.insert(
886 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000887 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000888
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000889 Error runThinLTOBackendThread(
Peter Collingbourne80186a52016-09-23 21:33:43 +0000890 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000891 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000892 const FunctionImporter::ImportMapTy &ImportList,
893 const FunctionImporter::ExportSetTy &ExportList,
894 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
895 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000896 MapVector<StringRef, BitcodeModule> &ModuleMap,
897 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Peter Collingbourne80186a52016-09-23 21:33:43 +0000898 auto RunThinBackend = [&](AddStreamFn AddStream) {
899 LTOLLVMContext BackendContext(Conf);
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000900 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
Peter Collingbourned9445c42016-11-13 07:00:17 +0000901 if (!MOrErr)
902 return MOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000903
Peter Collingbourne80186a52016-09-23 21:33:43 +0000904 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
905 ImportList, DefinedGlobals, ModuleMap);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000906 };
Peter Collingbourne80186a52016-09-23 21:33:43 +0000907
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000908 auto ModuleID = BM.getModuleIdentifier();
Mehdi Aminif82bda02016-10-08 04:44:23 +0000909
910 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) ||
911 all_of(CombinedIndex.getModuleHash(ModuleID),
912 [](uint32_t V) { return V == 0; }))
913 // Cache disabled or no entry for this module in the combined index or
914 // no module hash.
Peter Collingbourne80186a52016-09-23 21:33:43 +0000915 return RunThinBackend(AddStream);
916
917 SmallString<40> Key;
918 // The module may be cached, this helps handling it.
Peter Collingbournef4257522016-12-08 05:28:30 +0000919 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000920 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid,
921 CfiFunctionDefs, CfiFunctionDecls);
Peter Collingbourne80186a52016-09-23 21:33:43 +0000922 if (AddStreamFn CacheAddStream = Cache(Task, Key))
923 return RunThinBackend(CacheAddStream);
924
Mehdi Amini41af4302016-11-11 04:28:40 +0000925 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000926 }
927
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000928 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000929 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000930 const FunctionImporter::ImportMapTy &ImportList,
931 const FunctionImporter::ExportSetTy &ExportList,
932 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000933 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
934 StringRef ModulePath = BM.getModuleIdentifier();
Mehdi Amini767e1452016-09-06 03:23:45 +0000935 assert(ModuleToDefinedGVSummaries.count(ModulePath));
936 const GVSummaryMapTy &DefinedGlobals =
937 ModuleToDefinedGVSummaries.find(ModulePath)->second;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000938 BackendThreadPool.async(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000939 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000940 const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000941 const FunctionImporter::ExportSetTy &ExportList,
942 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
943 &ResolvedODR,
Mehdi Amini767e1452016-09-06 03:23:45 +0000944 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000945 MapVector<StringRef, BitcodeModule> &ModuleMap,
946 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000947 Error E = runThinLTOBackendThread(
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000948 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
949 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000950 if (E) {
951 std::unique_lock<std::mutex> L(ErrMu);
952 if (Err)
953 Err = joinErrors(std::move(*Err), std::move(E));
954 else
955 Err = std::move(E);
956 }
957 },
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000958 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
959 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap),
960 std::ref(TypeIdSummariesByGuid));
Mehdi Amini41af4302016-11-11 04:28:40 +0000961 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000962 }
963
964 Error wait() override {
965 BackendThreadPool.wait();
966 if (Err)
967 return std::move(*Err);
968 else
Mehdi Amini41af4302016-11-11 04:28:40 +0000969 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000970 }
971};
Benjamin Kramerffd37152016-11-19 20:44:26 +0000972} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000973
974ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
975 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +0000976 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000977 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000978 return llvm::make_unique<InProcessThinBackend>(
979 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000980 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000981 };
982}
983
Teresa Johnson3f212b82016-09-21 19:12:05 +0000984// Given the original \p Path to an output file, replace any path
985// prefix matching \p OldPrefix with \p NewPrefix. Also, create the
986// resulting directory if it does not yet exist.
987std::string lto::getThinLTOOutputFile(const std::string &Path,
988 const std::string &OldPrefix,
989 const std::string &NewPrefix) {
990 if (OldPrefix.empty() && NewPrefix.empty())
991 return Path;
992 SmallString<128> NewPath(Path);
993 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix);
994 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str());
995 if (!ParentPath.empty()) {
996 // Make sure the new directory exists, creating it if necessary.
997 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath))
998 llvm::errs() << "warning: could not create directory '" << ParentPath
999 << "': " << EC.message() << '\n';
1000 }
1001 return NewPath.str();
1002}
1003
Benjamin Kramerffd37152016-11-19 20:44:26 +00001004namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001005class WriteIndexesThinBackend : public ThinBackendProc {
1006 std::string OldPrefix, NewPrefix;
1007 bool ShouldEmitImportsFiles;
1008
1009 std::string LinkedObjectsFileName;
1010 std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile;
1011
1012public:
Mehdi Amini767e1452016-09-06 03:23:45 +00001013 WriteIndexesThinBackend(
1014 Config &Conf, ModuleSummaryIndex &CombinedIndex,
1015 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1016 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
1017 std::string LinkedObjectsFileName)
Mehdi Amini18b91112016-08-19 06:10:03 +00001018 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001019 OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1020 ShouldEmitImportsFiles(ShouldEmitImportsFiles),
1021 LinkedObjectsFileName(LinkedObjectsFileName) {}
1022
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001023 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001024 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001025 const FunctionImporter::ImportMapTy &ImportList,
1026 const FunctionImporter::ExportSetTy &ExportList,
1027 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001028 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1029 StringRef ModulePath = BM.getModuleIdentifier();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001030 std::string NewModulePath =
1031 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1032
1033 std::error_code EC;
1034 if (!LinkedObjectsFileName.empty()) {
1035 if (!LinkedObjectsFile) {
1036 LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>(
1037 LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None);
1038 if (EC)
1039 return errorCodeToError(EC);
1040 }
1041 *LinkedObjectsFile << NewModulePath << '\n';
1042 }
1043
1044 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1045 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001046 ImportList, ModuleToSummariesForIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001047
1048 raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC,
1049 sys::fs::OpenFlags::F_None);
1050 if (EC)
1051 return errorCodeToError(EC);
1052 WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex);
1053
1054 if (ShouldEmitImportsFiles)
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001055 return errorCodeToError(
1056 EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList));
Mehdi Amini41af4302016-11-11 04:28:40 +00001057 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001058 }
1059
Mehdi Amini41af4302016-11-11 04:28:40 +00001060 Error wait() override { return Error::success(); }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001061};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001062} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001063
1064ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix,
1065 std::string NewPrefix,
1066 bool ShouldEmitImportsFiles,
1067 std::string LinkedObjectsFile) {
1068 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001069 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001070 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001071 return llvm::make_unique<WriteIndexesThinBackend>(
Mehdi Amini18b91112016-08-19 06:10:03 +00001072 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
1073 ShouldEmitImportsFiles, LinkedObjectsFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001074 };
1075}
1076
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001077Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001078 if (ThinLTO.ModuleMap.empty())
Mehdi Amini41af4302016-11-11 04:28:40 +00001079 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001080
1081 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
Mehdi Amini41af4302016-11-11 04:28:40 +00001082 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001083
1084 // Collect for each module the list of function it defines (GUID ->
1085 // Summary).
Dehao Chen5d96ee42017-07-10 20:12:54 +00001086 StringMap<GVSummaryMapTy>
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001087 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1088 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1089 ModuleToDefinedGVSummaries);
Teresa Johnson620c1402016-09-20 23:07:17 +00001090 // Create entries for any modules that didn't have any GV summaries
1091 // (either they didn't have any GVs to start with, or we suppressed
1092 // generation of the summaries because they e.g. had inline assembly
1093 // uses that couldn't be promoted/renamed on export). This is so
1094 // InProcessThinBackend::start can still launch a backend thread, which
1095 // is passed the map of summaries for the module, without any special
1096 // handling for this case.
1097 for (auto &Mod : ThinLTO.ModuleMap)
1098 if (!ModuleToDefinedGVSummaries.count(Mod.first))
1099 ModuleToDefinedGVSummaries.try_emplace(Mod.first);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001100
1101 StringMap<FunctionImporter::ImportMapTy> ImportLists(
1102 ThinLTO.ModuleMap.size());
1103 StringMap<FunctionImporter::ExportSetTy> ExportLists(
1104 ThinLTO.ModuleMap.size());
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001105 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001106
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001107 if (Conf.OptLevel > 0)
Teresa Johnson002af9b2016-10-31 22:12:21 +00001108 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +00001109 ImportLists, ExportLists);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001110
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001111 // Figure out which symbols need to be internalized. This also needs to happen
1112 // at -O0 because summary-based DCE is implemented using internalization, and
1113 // we must apply DCE consistently with the full LTO module in order to avoid
1114 // undefined references during the final link.
1115 std::set<GlobalValue::GUID> ExportedGUIDs;
1116 for (auto &Res : GlobalResolutions) {
1117 // First check if the symbol was flagged as having external references.
1118 if (Res.second.Partition != GlobalResolution::External)
1119 continue;
1120 // IRName will be defined if we have seen the prevailing copy of
1121 // this value. If not, no need to mark as exported from a ThinLTO
1122 // partition (and we can't get the GUID).
1123 if (Res.second.IRName.empty())
1124 continue;
1125 auto GUID = GlobalValue::getGUID(
1126 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
1127 // Mark exported unless index-based analysis determined it to be dead.
1128 if (ThinLTO.CombinedIndex.isGUIDLive(GUID))
1129 ExportedGUIDs.insert(GUID);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001130 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001131
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001132 // Any functions referenced by the jump table in the regular LTO object must
1133 // be exported.
1134 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs())
1135 ExportedGUIDs.insert(
1136 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def)));
1137
1138 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) {
1139 const auto &ExportList = ExportLists.find(ModuleIdentifier);
1140 return (ExportList != ExportLists.end() &&
1141 ExportList->second.count(GUID)) ||
1142 ExportedGUIDs.count(GUID);
1143 };
1144 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported);
1145
Peter Collingbournef87197a2017-05-25 23:40:11 +00001146 auto isPrevailing = [&](GlobalValue::GUID GUID,
1147 const GlobalValueSummary *S) {
1148 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath();
1149 };
1150 auto recordNewLinkage = [&](StringRef ModuleIdentifier,
1151 GlobalValue::GUID GUID,
1152 GlobalValue::LinkageTypes NewLinkage) {
1153 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage;
1154 };
1155 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing,
1156 recordNewLinkage);
1157
Peter Collingbourne80186a52016-09-23 21:33:43 +00001158 std::unique_ptr<ThinBackendProc> BackendProc =
1159 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1160 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001161
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001162 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined
1163 // module and parallel code generation partitions.
1164 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001165 for (auto &Mod : ThinLTO.ModuleMap) {
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001166 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001167 ExportLists[Mod.first],
1168 ResolvedODR[Mod.first], ThinLTO.ModuleMap))
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001169 return E;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001170 ++Task;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001171 }
1172
1173 return BackendProc->wait();
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001174}
Davide Italiano690ed9d2017-02-10 23:49:38 +00001175
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001176Expected<std::unique_ptr<ToolOutputFile>>
Davide Italiano690ed9d2017-02-10 23:49:38 +00001177lto::setupOptimizationRemarks(LLVMContext &Context,
1178 StringRef LTORemarksFilename,
1179 bool LTOPassRemarksWithHotness, int Count) {
1180 if (LTORemarksFilename.empty())
1181 return nullptr;
1182
1183 std::string Filename = LTORemarksFilename;
1184 if (Count != -1)
1185 Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1186
1187 std::error_code EC;
1188 auto DiagnosticFile =
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001189 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001190 if (EC)
1191 return errorCodeToError(EC);
1192 Context.setDiagnosticsOutputFile(
1193 llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
1194 if (LTOPassRemarksWithHotness)
Brian Gesiak44e5f6c2017-06-30 18:13:59 +00001195 Context.setDiagnosticsHotnessRequested(true);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001196 DiagnosticFile->keep();
1197 return std::move(DiagnosticFile);
1198}