blob: 34cca32e06e6a7d00e30251c8361952c18afb791 [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"
Florian Hahnd4332eb2018-04-20 10:18:36 +000015#include "llvm/ADT/Statistic.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000016#include "llvm/Analysis/TargetLibraryInfo.h"
17#include "llvm/Analysis/TargetTransformInfo.h"
Teresa Johnsonad176792016-11-11 05:34:58 +000018#include "llvm/Bitcode/BitcodeReader.h"
19#include "llvm/Bitcode/BitcodeWriter.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000020#include "llvm/CodeGen/Analysis.h"
Nico Weber432a3882018-04-30 14:59:11 +000021#include "llvm/Config/llvm-config.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000022#include "llvm/IR/AutoUpgrade.h"
23#include "llvm/IR/DiagnosticPrinter.h"
24#include "llvm/IR/LegacyPassManager.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000025#include "llvm/IR/Mangler.h"
26#include "llvm/IR/Metadata.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000027#include "llvm/LTO/LTOBackend.h"
28#include "llvm/Linker/IRMover.h"
Peter Collingbourne192d8522017-03-28 23:35:34 +000029#include "llvm/Object/IRObjectFile.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000030#include "llvm/Support/Error.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000031#include "llvm/Support/ManagedStatic.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000032#include "llvm/Support/MemoryBuffer.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000033#include "llvm/Support/Path.h"
Mehdi Aminiadc0e262016-08-23 21:30:12 +000034#include "llvm/Support/SHA1.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000035#include "llvm/Support/SourceMgr.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000036#include "llvm/Support/TargetRegistry.h"
37#include "llvm/Support/ThreadPool.h"
Teresa Johnsonec544c52016-10-19 17:35:01 +000038#include "llvm/Support/Threading.h"
Peter Collingbourne942fa562017-04-13 01:26:12 +000039#include "llvm/Support/VCSRevision.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000040#include "llvm/Support/raw_ostream.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000041#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"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000046
Teresa Johnson9ba95f92016-08-11 14:58:12 +000047#include <set>
48
49using namespace llvm;
50using namespace lto;
51using namespace object;
Teresa Johnsondf6edc52016-05-23 22:54:06 +000052
Mehdi Aminiadc0e262016-08-23 21:30:12 +000053#define DEBUG_TYPE "lto"
54
Charles Saternosb040fcc2018-02-19 15:14:50 +000055static 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"));
58
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000059// The values are (type identifier, summary) pairs.
60typedef DenseMap<
61 GlobalValue::GUID,
62 TinyPtrVector<const std::pair<const std::string, TypeIdSummary> *>>
63 TypeIdSummariesByGuidTy;
64
Mehdi Aminiadc0e262016-08-23 21:30:12 +000065// 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.
68static void computeCacheKey(
Peter Collingbournef4257522016-12-08 05:28:30 +000069 SmallString<40> &Key, const Config &Conf, const ModuleSummaryIndex &Index,
70 StringRef ModuleID, const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +000071 const FunctionImporter::ExportSetTy &ExportList,
72 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000073 const GVSummaryMapTy &DefinedGlobals,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +000074 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid,
75 const std::set<GlobalValue::GUID> &CfiFunctionDefs,
76 const std::set<GlobalValue::GUID> &CfiFunctionDecls) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +000077 // 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;
82
83 // Start with the compiler revision
84 Hasher.update(LLVM_VERSION_STRING);
Peter Collingbourne942fa562017-04-13 01:26:12 +000085#ifdef LLVM_REVISION
Mehdi Aminiadc0e262016-08-23 21:30:12 +000086 Hasher.update(LLVM_REVISION);
87#endif
88
Peter Collingbournef4257522016-12-08 05:28:30 +000089 // 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});
93 };
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});
101 };
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000102 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});
113 };
Peter Collingbournef4257522016-12-08 05:28:30 +0000114 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);
Evgeniy Stepanovb9f1b012017-05-22 21:11:35 +0000125 if (Conf.RelocModel)
126 AddUnsigned(*Conf.RelocModel);
127 else
128 AddUnsigned(-1);
Rafael Espindola79e238a2017-08-03 02:16:21 +0000129 if (Conf.CodeModel)
130 AddUnsigned(*Conf.CodeModel);
131 else
132 AddUnsigned(-1);
Peter Collingbournef4257522016-12-08 05:28:30 +0000133 AddUnsigned(Conf.CGOptLevel);
Tobias Edler von Kochf454b9e2017-02-15 20:36:36 +0000134 AddUnsigned(Conf.CGFileType);
Peter Collingbournef4257522016-12-08 05:28:30 +0000135 AddUnsigned(Conf.OptLevel);
Tim Shen4e912aa2017-06-01 23:13:44 +0000136 AddUnsigned(Conf.UseNewPM);
Peter Collingbournef4257522016-12-08 05:28:30 +0000137 AddString(Conf.OptPipeline);
138 AddString(Conf.AAPipeline);
139 AddString(Conf.OverrideTriple);
140 AddString(Conf.DefaultTriple);
Yunlian Jiangbd200b92018-04-13 05:03:28 +0000141 AddString(Conf.DwoDir);
Peter Collingbournef4257522016-12-08 05:28:30 +0000142
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000143 // 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)));
149
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000150 // 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.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000153 for (auto &Entry : ImportList) {
154 auto ModHash = Index.getModuleHash(Entry.first());
155 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000156
157 AddUint64(Entry.second.size());
158 for (auto &Fn : Entry.second)
159 AddUint64(Fn.first);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000160 }
161
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)));
168 }
169
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000170 // 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;
174
175 // Typeids used in this module.
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000176 std::set<GlobalValue::GUID> UsedTypeIds;
177
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000178 auto AddUsedCfiGlobal = [&](GlobalValue::GUID ValueGUID) {
179 if (CfiFunctionDefs.count(ValueGUID))
180 UsedCfiDefs.insert(ValueGUID);
181 if (CfiFunctionDecls.count(ValueGUID))
182 UsedCfiDecls.insert(ValueGUID);
183 };
184
185 auto AddUsedThings = [&](GlobalValueSummary *GS) {
186 if (!GS) return;
Peter Collingbourne7f1a5ba2018-02-09 05:58:55 +0000187 AddUnsigned(GS->isLive());
Peter Collingbourneb4edfb92018-02-05 17:17:51 +0000188 for (const ValueInfo &VI : GS->refs()) {
189 AddUnsigned(VI.isDSOLocal());
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000190 AddUsedCfiGlobal(VI.getGUID());
Peter Collingbourneb4edfb92018-02-05 17:17:51 +0000191 }
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000192 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);
Peter Collingbourne3fe815d2018-02-05 23:46:32 +0000203 for (auto &ET : FS->calls()) {
204 AddUnsigned(ET.first.isDSOLocal());
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000205 AddUsedCfiGlobal(ET.first.getGUID());
Peter Collingbourne3fe815d2018-02-05 23:46:32 +0000206 }
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000207 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000208 };
209
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000210 // Include the hash for the linkage type to reflect internalization and weak
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000211 // resolution, and collect any used type identifier resolutions.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000212 for (auto &GS : DefinedGlobals) {
213 GlobalValue::LinkageTypes Linkage = GS.second->linkage();
214 Hasher.update(
215 ArrayRef<uint8_t>((const uint8_t *)&Linkage, sizeof(Linkage)));
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000216 AddUsedCfiGlobal(GS.first);
217 AddUsedThings(GS.second);
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000218 }
219
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)
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000224 AddUsedThings(Index.findSummaryInModule(ImpF.first, ImpM.first()));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000225
226 auto AddTypeIdSummary = [&](StringRef TId, const TypeIdSummary &S) {
227 AddString(TId);
228
229 AddUnsigned(S.TTRes.TheKind);
230 AddUnsigned(S.TTRes.SizeM1BitWidth);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000231
Peter Collingbourneb9b60252017-09-11 22:49:10 +0000232 AddUint64(S.TTRes.AlignLog2);
233 AddUint64(S.TTRes.SizeM1);
234 AddUint64(S.TTRes.BitMask);
235 AddUint64(S.TTRes.InlineBits);
236
Peter Collingbourne711284b2017-03-10 21:37:10 +0000237 AddUint64(S.WPDRes.size());
238 for (auto &WPD : S.WPDRes) {
239 AddUnsigned(WPD.first);
240 AddUnsigned(WPD.second.TheKind);
241 AddString(WPD.second.SingleImplName);
242
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);
Peter Collingbourneb15a35e2017-09-11 22:34:42 +0000250 AddUnsigned(ByArg.second.Byte);
251 AddUnsigned(ByArg.second.Bit);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000252 }
253 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000254 };
255
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);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000262 }
263
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000264 AddUnsigned(UsedCfiDefs.size());
265 for (auto &V : UsedCfiDefs)
266 AddUint64(V);
267
268 AddUnsigned(UsedCfiDecls.size());
269 for (auto &V : UsedCfiDecls)
270 AddUint64(V);
271
Dehao Chen27978002016-12-16 16:48:46 +0000272 if (!Conf.SampleProfile.empty()) {
273 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile);
274 if (FileOrErr)
275 Hasher.update(FileOrErr.get()->getBuffer());
276 }
277
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000278 Key = toHex(Hasher.result());
279}
280
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000281static void thinLTOResolveWeakForLinkerGUID(
282 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
283 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000284 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000285 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000286 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000287 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000288 for (auto &S : GVSummaryList) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000289 GlobalValue::LinkageTypes OriginalLinkage = S->linkage();
290 if (!GlobalValue::isWeakForLinker(OriginalLinkage))
291 continue;
Peter Collingbourne73589f32016-07-07 18:31:51 +0000292 // We need to emit only one of these. The prevailing module will keep it,
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000293 // but turned into a weak, while the others will drop it when possible.
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000294 // 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.
Peter Collingbourne73589f32016-07-07 18:31:51 +0000300 if (isPrevailing(GUID, S.get())) {
Teresa Johnson28c03b52016-05-26 14:16:52 +0000301 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
302 S->setLinkage(GlobalValue::getWeakLinkage(
303 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000304 }
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000305 // Alias and aliasee can't be turned into available_externally.
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000306 else if (!isa<AliasSummary>(S.get()) &&
Teresa Johnson4566c6d2017-01-20 21:54:58 +0000307 !GlobalInvolvedWithAlias.count(S.get()))
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000308 S->setLinkage(GlobalValue::AvailableExternallyLinkage);
309 if (S->linkage() != OriginalLinkage)
310 recordNewLinkage(S->modulePath(), GUID, S->linkage());
311 }
312}
313
314// Resolve Weak and LinkOnce values in the \p Index.
315//
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.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000320void llvm::thinLTOResolveWeakForLinkerInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000321 ModuleSummaryIndex &Index,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000322 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000323 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000324 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000325 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000326 // 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)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000331 for (auto &S : I.second.SummaryList)
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000332 if (auto AS = dyn_cast<AliasSummary>(S.get()))
333 GlobalInvolvedWithAlias.insert(&AS->getAliasee());
334
335 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000336 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first,
337 GlobalInvolvedWithAlias, isPrevailing,
338 recordNewLinkage);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000339}
340
341static void thinLTOInternalizeAndPromoteGUID(
342 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000343 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000344 for (auto &S : GVSummaryList) {
Mehdi Amini1380edf2017-02-03 07:41:43 +0000345 if (isExported(S->modulePath(), GUID)) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000346 if (GlobalValue::isLocalLinkage(S->linkage()))
347 S->setLinkage(GlobalValue::ExternalLinkage);
348 } else if (!GlobalValue::isLocalLinkage(S->linkage()))
349 S->setLinkage(GlobalValue::InternalLinkage);
350 }
351}
352
353// Update the linkages in the given \p Index to mark exported values
354// as external and non-exported values as internal.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000355void llvm::thinLTOInternalizeAndPromoteInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000356 ModuleSummaryIndex &Index,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000357 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000358 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000359 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000360}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000361
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000362// Requires a destructor for std::vector<InputModule>.
363InputFile::~InputFile() = default;
364
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000365Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) {
366 std::unique_ptr<InputFile> File(new InputFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000367
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000368 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object);
369 if (!FOrErr)
370 return FOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000371
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000372 File->TargetTriple = FOrErr->TheReader.getTargetTriple();
373 File->SourceFileName = FOrErr->TheReader.getSourceFileName();
374 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts();
375 File->ComdatTable = FOrErr->TheReader.getComdatTable();
Peter Collingbournead903692016-12-13 19:43:49 +0000376
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000377 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000378 size_t Begin = File->Symbols.size();
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000379 for (const irsymtab::Reader::SymbolRef &Sym :
380 FOrErr->TheReader.module_symbols(I))
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000381 // 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()});
Rafael Espindola79121102016-10-25 12:02:03 +0000386 }
387
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000388 File->Mods = FOrErr->Mods;
389 File->Strtab = std::move(FOrErr->Strtab);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000390 return std::move(File);
391}
392
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000393StringRef InputFile::getName() const {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000394 return Mods[0].getModuleIdentifier();
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000395}
396
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000397LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel,
398 Config &Conf)
399 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel),
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000400 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)),
401 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000402
Eugene Leviant28d8a492018-01-22 13:35:40 +0000403LTO::ThinLTOState::ThinLTOState(ThinBackend Backend)
Teresa Johnson4ffc3e72018-06-06 22:22:01 +0000404 : Backend(Backend), CombinedIndex(/*HaveGVs*/ false) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000405 if (!Backend)
Teresa Johnsonec544c52016-10-19 17:35:01 +0000406 this->Backend =
407 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency());
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000408}
409
410LTO::LTO(Config Conf, ThinBackend Backend,
411 unsigned ParallelCodeGenParallelismLevel)
412 : Conf(std::move(Conf)),
413 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf),
Mehdi Amini026ddbb2016-08-19 05:56:37 +0000414 ThinLTO(std::move(Backend)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000415
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000416// Requires a destructor for MapVector<BitcodeModule>.
417LTO::~LTO() = default;
418
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000419// Add the symbols in the given module to the GlobalResolutions map, and resolve
420// their partitions.
421void 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();
Peter Collingbourne7e85b262017-06-15 17:41:32 +0000426 (void)ResE;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000427 for (const InputFile::Symbol &Sym : Syms) {
428 assert(ResI != ResE);
429 SymbolResolution Res = *ResI++;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000430
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000431 auto &GlobalRes = GlobalResolutions[Sym.getName()];
432 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr();
Eugene Leviant746f1522017-12-15 09:18:21 +0000433 if (Res.Prevailing) {
George Rimard3283652018-01-25 17:23:27 +0000434 assert(!GlobalRes.Prevailing &&
Eugene Leviantcb122492017-12-15 16:27:33 +0000435 "Multiple prevailing defs are not allowed");
George Rimard3283652018-01-25 17:23:27 +0000436 GlobalRes.Prevailing = true;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000437 GlobalRes.IRName = Sym.getIRName();
George Rimareaf51722018-01-29 08:03:30 +0000438 } 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();
Eugene Leviant746f1522017-12-15 09:18:21 +0000446 }
Teresa Johnson6c475a72017-01-05 21:34:18 +0000447
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000448 // 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;
459
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);
464 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000465}
466
Rafael Espindola7775c332016-08-26 20:19:35 +0000467static void writeToResolutionFile(raw_ostream &OS, InputFile *Input,
468 ArrayRef<SymbolResolution> Res) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000469 StringRef Path = Input->getName();
Rafael Espindola7775c332016-08-26 20:19:35 +0000470 OS << Path << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000471 auto ResI = Res.begin();
472 for (const InputFile::Symbol &Sym : Input->symbols()) {
473 assert(ResI != Res.end());
474 SymbolResolution Res = *ResI++;
475
Rafael Espindola7775c332016-08-26 20:19:35 +0000476 OS << "-r=" << Path << ',' << Sym.getName() << ',';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000477 if (Res.Prevailing)
Rafael Espindola7775c332016-08-26 20:19:35 +0000478 OS << 'p';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000479 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola7775c332016-08-26 20:19:35 +0000480 OS << 'l';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000481 if (Res.VisibleToRegularObj)
Rafael Espindola7775c332016-08-26 20:19:35 +0000482 OS << 'x';
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000483 if (Res.LinkerRedefined)
484 OS << 'r';
Rafael Espindola7775c332016-08-26 20:19:35 +0000485 OS << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000486 }
Peter Collingbourne58ffcfb2017-01-19 23:10:14 +0000487 OS.flush();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000488 assert(ResI == Res.end());
489}
490
491Error LTO::add(std::unique_ptr<InputFile> Input,
492 ArrayRef<SymbolResolution> Res) {
493 assert(!CalledGetMaxTasks);
494
495 if (Conf.ResolutionFile)
Rafael Espindola7775c332016-08-26 20:19:35 +0000496 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000497
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000498 if (RegularLTO.CombinedModule->getTargetTriple().empty())
499 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple());
500
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000501 const SymbolResolution *ResI = Res.begin();
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000502 for (unsigned I = 0; I != Input->Mods.size(); ++I)
503 if (Error Err = addModule(*Input, I, ResI, Res.end()))
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000504 return Err;
505
506 assert(ResI == Res.end());
507 return Error::success();
508}
509
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000510Error LTO::addModule(InputFile &Input, unsigned ModI,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000511 const SymbolResolution *&ResI,
512 const SymbolResolution *ResE) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000513 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo();
514 if (!LTOInfo)
515 return LTOInfo.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000516
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000517 BitcodeModule BM = Input.Mods[ModI];
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000518 auto ModSyms = Input.module_symbols(ModI);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000519 addModuleToGlobalRes(ModSyms, {ResI, ResE},
520 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0,
521 LTOInfo->HasSummary);
522
523 if (LTOInfo->IsThinLTO)
524 return addThinLTO(BM, ModSyms, ResI, ResE);
525
526 Expected<RegularLTOState::AddedModule> ModOrErr =
527 addRegularLTO(BM, ModSyms, ResI, ResE);
528 if (!ModOrErr)
529 return ModOrErr.takeError();
530
531 if (!LTOInfo->HasSummary)
532 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false);
533
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();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000540}
541
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000542// 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.
552static void
553handleNonPrevailingComdat(GlobalValue &GV,
554 std::set<const Comdat *> &NonPrevailingComdats) {
555 Comdat *C = GV.getComdat();
556 if (!C)
557 return;
558
559 if (!NonPrevailingComdats.count(C))
560 return;
561
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);
567
568 if (auto GO = dyn_cast<GlobalObject>(&GV))
569 GO->setComdat(nullptr);
570}
571
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000572// Add a regular LTO object to the link.
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000573// The resulting module needs to be linked into the combined LTO module with
574// linkRegularLTO.
575Expected<LTO::RegularLTOState::AddedModule>
576LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
577 const SymbolResolution *&ResI,
578 const SymbolResolution *ResE) {
579 RegularLTOState::AddedModule Mod;
Peter Collingbournead903692016-12-13 19:43:49 +0000580 Expected<std::unique_ptr<Module>> MOrErr =
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000581 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true,
582 /*IsImporting*/ false);
Peter Collingbournead903692016-12-13 19:43:49 +0000583 if (!MOrErr)
584 return MOrErr.takeError();
Peter Collingbournead903692016-12-13 19:43:49 +0000585 Module &M = **MOrErr;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000586 Mod.M = std::move(*MOrErr);
587
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000588 if (Error Err = M.materializeMetadata())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000589 return std::move(Err);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000590 UpgradeDebugInfo(M);
591
Peter Collingbournead903692016-12-13 19:43:49 +0000592 ModuleSymbolTable SymTab;
593 SymTab.addModule(&M);
594
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000595 for (GlobalVariable &GV : M.globals())
596 if (GV.hasAppendingLinkage())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000597 Mod.Keep.push_back(&GV);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000598
Peter Collingbourne46136262017-02-02 05:22:42 +0000599 DenseSet<GlobalObject *> AliasedGlobals;
600 for (auto &GA : M.aliases())
601 if (GlobalObject *GO = GA.getBaseObject())
602 AliasedGlobals.insert(GO);
603
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000604 // 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;
619 }
620 };
621 Skip();
622
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000623 std::set<const Comdat *> NonPrevailingComdats;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000624 for (const InputFile::Symbol &Sym : Syms) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000625 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000626 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000627
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000628 assert(MsymI != MsymE);
629 ModuleSymbolTable::Symbol Msym = *MsymI++;
630 Skip();
631
632 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) {
Peter Collingbournec387e702017-02-02 05:12:15 +0000633 if (Res.Prevailing) {
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000634 if (Sym.isUndefined())
Peter Collingbournec387e702017-02-02 05:12:15 +0000635 continue;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000636 Mod.Keep.push_back(GV);
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000637 // 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);
642
Davide Italianod4db1162017-05-26 21:56:14 +0000643 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage();
644 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
645 GV->setLinkage(GlobalValue::getWeakLinkage(
646 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Peter Collingbourne46136262017-02-02 05:22:42 +0000647 } else if (isa<GlobalObject>(GV) &&
648 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() ||
649 GV->hasAvailableExternallyLinkage()) &&
650 !AliasedGlobals.count(cast<GlobalObject>(GV))) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000651 // Any of the above three types of linkage indicates that the
Peter Collingbourne46136262017-02-02 05:22:42 +0000652 // chosen prevailing symbol will have the same semantics as this copy of
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000653 // 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);
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000658 if (GV->hasComdat())
659 NonPrevailingComdats.insert(GV->getComdat());
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000660 cast<GlobalObject>(GV)->setComdat(nullptr);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000661 }
Sean Fertile4595a912017-11-04 17:04:39 +0000662
663 // Set the 'local' flag based on the linker resolution for this symbol.
Rafael Espindola8a1ca672018-01-18 05:38:43 +0000664 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola349fe0a2018-01-24 19:11:24 +0000665 GV->setDSOLocal(true);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000666 }
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000667 // 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.
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000670 if (Sym.isCommon()) {
Peter Collingbournefb8c2a42016-12-01 02:51:12 +0000671 // FIXME: We should figure out what to do about commons defined by asm.
672 // For now they aren't reported correctly by ModuleSymbolTable.
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000673 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000674 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
675 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000676 CommonRes.Prevailing |= Res.Prevailing;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000677 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000678
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000679 }
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000680 if (!M.getComdatSymbolTable().empty())
681 for (GlobalValue &GV : M.global_values())
682 handleNonPrevailingComdat(GV, NonPrevailingComdats);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000683 assert(MsymI == MsymE);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000684 return std::move(Mod);
685}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000686
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000687Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
688 bool LivenessFromIndex) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000689 std::vector<GlobalValue *> Keep;
690 for (GlobalValue *GV : Mod.Keep) {
691 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
692 continue;
693
694 if (!GV->hasAvailableExternallyLinkage()) {
695 Keep.push_back(GV);
696 continue;
697 }
698
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;
705
706 Keep.push_back(GV);
707 }
708
709 return RegularLTO.Mover->move(std::move(Mod.M), Keep,
Teresa Johnson4b9b3792016-10-12 18:39:29 +0000710 [](GlobalValue &, IRMover::ValueAdder) {},
Teresa Johnson040cc162016-12-12 16:09:30 +0000711 /* IsPerformingImport */ false);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000712}
713
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000714// Add a ThinLTO module to the link.
715Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000716 const SymbolResolution *&ResI,
717 const SymbolResolution *ResE) {
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000718 if (Error Err =
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000719 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
720 ThinLTO.ModuleMap.size()))
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000721 return Err;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000722
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000723 for (const InputFile::Symbol &Sym : Syms) {
724 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000725 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000726
Sean Fertile4595a912017-11-04 17:04:39 +0000727 if (!Sym.getIRName().empty()) {
728 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
729 Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
730 if (Res.Prevailing) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000731 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
Davide Italiano6a5fbe52017-07-06 19:58:26 +0000732
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);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000741 }
Sean Fertile4595a912017-11-04 17:04:39 +0000742
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);
749 }
750 }
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000751 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000752 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000753
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000754 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());
758
Mehdi Amini41af4302016-11-11 04:28:40 +0000759 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000760}
761
Teresa Johnsonfaa75062016-08-11 20:38:39 +0000762unsigned LTO::getMaxTasks() const {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000763 CalledGetMaxTasks = true;
764 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
765}
766
Peter Collingbourne80186a52016-09-23 21:33:43 +0000767Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000768 // Compute "dead" symbols, we don't want to import/export these!
769 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
George Rimareaf51722018-01-29 08:03:30 +0000770 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;
776
777 GlobalValue::GUID GUID = GlobalValue::getGUID(
778 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
779
George Rimard3283652018-01-25 17:23:27 +0000780 if (Res.second.VisibleOutsideSummary && Res.second.Prevailing)
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000781 GUIDPreservedSymbols.insert(GlobalValue::getGUID(
782 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000783
George Rimareaf51722018-01-29 08:03:30 +0000784 GUIDPrevailingResolutions[GUID] =
785 Res.second.Prevailing ? PrevailingType::Yes : PrevailingType::No;
786 }
787
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;
793 };
794 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols, isPrevailing);
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000795
Florian Hahnd4332eb2018-04-20 10:18:36 +0000796 // 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();
806 }
807
808 Error Result = runRegularLTO(AddStream);
809 if (!Result)
810 Result = runThinLTO(AddStream, Cache);
811
812 if (StatsFile)
813 PrintStatisticsJSON(StatsFile->os());
814
815 return Result;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000816}
817
Peter Collingbourne80186a52016-09-23 21:33:43 +0000818Error LTO::runRegularLTO(AddStreamFn AddStream) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000819 for (auto &M : RegularLTO.ModsWithSummaries)
820 if (Error Err = linkRegularLTO(std::move(M),
821 /*LivenessFromIndex=*/true))
822 return Err;
823
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000824 // 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.
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000826 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000827 for (auto &I : RegularLTO.Commons) {
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000828 if (!I.second.Prevailing)
829 // Don't do anything if no instance of this common was prevailing.
830 continue;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000831 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000832 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000833 // 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;
837 }
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000838 ArrayType *Ty =
839 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000840 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);
850 }
851 }
852
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000853 if (Conf.PreOptModuleHook &&
854 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000855 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000856
Mehdi Aminid310b472016-08-22 06:25:41 +0000857 if (!Conf.CodeGenOnly) {
858 for (const auto &R : GlobalResolutions) {
George Rimareaf51722018-01-29 08:03:30 +0000859 if (!R.second.isPrevailingIRSymbol())
Mehdi Aminid310b472016-08-22 06:25:41 +0000860 continue;
861 if (R.second.Partition != 0 &&
862 R.second.Partition != GlobalResolution::External)
863 continue;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000864
Mehdi Aminid310b472016-08-22 06:25:41 +0000865 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);
874 }
875
876 if (Conf.PostInternalizeModuleHook &&
877 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000878 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000879 }
Peter Collingbourne80186a52016-09-23 21:33:43 +0000880 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel,
Peter Collingbournee02b74e2017-01-20 22:18:52 +0000881 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000882}
883
884/// This class defines the interface to the ThinLTO backend.
885class lto::ThinBackendProc {
886protected:
887 Config &Conf;
888 ModuleSummaryIndex &CombinedIndex;
Mehdi Amini767e1452016-09-06 03:23:45 +0000889 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000890
891public:
892 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +0000893 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries)
Mehdi Amini18b91112016-08-19 06:10:03 +0000894 : Conf(Conf), CombinedIndex(CombinedIndex),
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000895 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {}
896
897 virtual ~ThinBackendProc() {}
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000898 virtual Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000899 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000900 const FunctionImporter::ImportMapTy &ImportList,
901 const FunctionImporter::ExportSetTy &ExportList,
902 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000903 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000904 virtual Error wait() = 0;
905};
906
Benjamin Kramerffd37152016-11-19 20:44:26 +0000907namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000908class InProcessThinBackend : public ThinBackendProc {
909 ThreadPool BackendThreadPool;
Peter Collingbourne80186a52016-09-23 21:33:43 +0000910 AddStreamFn AddStream;
911 NativeObjectCache Cache;
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000912 TypeIdSummariesByGuidTy TypeIdSummariesByGuid;
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000913 std::set<GlobalValue::GUID> CfiFunctionDefs;
914 std::set<GlobalValue::GUID> CfiFunctionDecls;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000915
916 Optional<Error> Err;
917 std::mutex ErrMu;
918
919public:
Mehdi Amini767e1452016-09-06 03:23:45 +0000920 InProcessThinBackend(
921 Config &Conf, ModuleSummaryIndex &CombinedIndex,
922 unsigned ThinLTOParallelismLevel,
923 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000924 AddStreamFn AddStream, NativeObjectCache Cache)
Mehdi Amini18b91112016-08-19 06:10:03 +0000925 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
926 BackendThreadPool(ThinLTOParallelismLevel),
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000927 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);
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000934 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)));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000940 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000941
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000942 Error runThinLTOBackendThread(
Peter Collingbourne80186a52016-09-23 21:33:43 +0000943 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000944 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000945 const FunctionImporter::ImportMapTy &ImportList,
946 const FunctionImporter::ExportSetTy &ExportList,
947 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
948 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000949 MapVector<StringRef, BitcodeModule> &ModuleMap,
950 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Peter Collingbourne80186a52016-09-23 21:33:43 +0000951 auto RunThinBackend = [&](AddStreamFn AddStream) {
952 LTOLLVMContext BackendContext(Conf);
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000953 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
Peter Collingbourned9445c42016-11-13 07:00:17 +0000954 if (!MOrErr)
955 return MOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000956
Peter Collingbourne80186a52016-09-23 21:33:43 +0000957 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
958 ImportList, DefinedGlobals, ModuleMap);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000959 };
Peter Collingbourne80186a52016-09-23 21:33:43 +0000960
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000961 auto ModuleID = BM.getModuleIdentifier();
Mehdi Aminif82bda02016-10-08 04:44:23 +0000962
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.
Peter Collingbourne80186a52016-09-23 21:33:43 +0000968 return RunThinBackend(AddStream);
969
970 SmallString<40> Key;
971 // The module may be cached, this helps handling it.
Peter Collingbournef4257522016-12-08 05:28:30 +0000972 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000973 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid,
974 CfiFunctionDefs, CfiFunctionDecls);
Peter Collingbourne80186a52016-09-23 21:33:43 +0000975 if (AddStreamFn CacheAddStream = Cache(Task, Key))
976 return RunThinBackend(CacheAddStream);
977
Mehdi Amini41af4302016-11-11 04:28:40 +0000978 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000979 }
980
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000981 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000982 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000983 const FunctionImporter::ImportMapTy &ImportList,
984 const FunctionImporter::ExportSetTy &ExportList,
985 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000986 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
987 StringRef ModulePath = BM.getModuleIdentifier();
Mehdi Amini767e1452016-09-06 03:23:45 +0000988 assert(ModuleToDefinedGVSummaries.count(ModulePath));
989 const GVSummaryMapTy &DefinedGlobals =
990 ModuleToDefinedGVSummaries.find(ModulePath)->second;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000991 BackendThreadPool.async(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000992 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000993 const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000994 const FunctionImporter::ExportSetTy &ExportList,
995 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
996 &ResolvedODR,
Mehdi Amini767e1452016-09-06 03:23:45 +0000997 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000998 MapVector<StringRef, BitcodeModule> &ModuleMap,
999 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001000 Error E = runThinLTOBackendThread(
Peter Collingbourne780a4dd2017-03-10 21:35:17 +00001001 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
1002 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001003 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);
1009 }
1010 },
Peter Collingbourne780a4dd2017-03-10 21:35:17 +00001011 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
1012 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap),
1013 std::ref(TypeIdSummariesByGuid));
Mehdi Amini41af4302016-11-11 04:28:40 +00001014 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001015 }
1016
1017 Error wait() override {
1018 BackendThreadPool.wait();
1019 if (Err)
1020 return std::move(*Err);
1021 else
Mehdi Amini41af4302016-11-11 04:28:40 +00001022 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001023 }
1024};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001025} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001026
1027ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
1028 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001029 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001030 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001031 return llvm::make_unique<InProcessThinBackend>(
1032 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001033 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001034 };
1035}
1036
Teresa Johnson3f212b82016-09-21 19:12:05 +00001037// 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.
1040std::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';
1053 }
1054 return NewPath.str();
1055}
1056
Benjamin Kramerffd37152016-11-19 20:44:26 +00001057namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001058class WriteIndexesThinBackend : public ThinBackendProc {
1059 std::string OldPrefix, NewPrefix;
1060 bool ShouldEmitImportsFiles;
Vitaly Bukaa139b692018-02-22 19:06:15 +00001061 raw_fd_ostream *LinkedObjectsFile;
Vitaly Buka59baf732018-01-30 21:19:26 +00001062 lto::IndexWriteCallback OnWrite;
1063
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001064public:
Mehdi Amini767e1452016-09-06 03:23:45 +00001065 WriteIndexesThinBackend(
1066 Config &Conf, ModuleSummaryIndex &CombinedIndex,
1067 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1068 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
Vitaly Bukaa139b692018-02-22 19:06:15 +00001069 raw_fd_ostream *LinkedObjectsFile, lto::IndexWriteCallback OnWrite)
Mehdi Amini18b91112016-08-19 06:10:03 +00001070 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001071 OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1072 ShouldEmitImportsFiles(ShouldEmitImportsFiles),
Vitaly Bukaa139b692018-02-22 19:06:15 +00001073 LinkedObjectsFile(LinkedObjectsFile), OnWrite(OnWrite) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001074
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001075 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001076 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001077 const FunctionImporter::ImportMapTy &ImportList,
1078 const FunctionImporter::ExportSetTy &ExportList,
1079 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001080 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1081 StringRef ModulePath = BM.getModuleIdentifier();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001082 std::string NewModulePath =
1083 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1084
Vitaly Bukaa139b692018-02-22 19:06:15 +00001085 if (LinkedObjectsFile)
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001086 *LinkedObjectsFile << NewModulePath << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001087
1088 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1089 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001090 ImportList, ModuleToSummariesForIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001091
Vitaly Bukaa139b692018-02-22 19:06:15 +00001092 std::error_code EC;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001093 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);
1098
Vitaly Buka59baf732018-01-30 21:19:26 +00001099 if (ShouldEmitImportsFiles) {
Teresa Johnsonc0320ef2018-07-10 20:06:04 +00001100 EC = EmitImportsFiles(ModulePath, NewModulePath + ".imports",
1101 ModuleToSummariesForIndex);
Vitaly Buka59baf732018-01-30 21:19:26 +00001102 if (EC)
1103 return errorCodeToError(EC);
1104 }
1105
1106 if (OnWrite)
1107 OnWrite(ModulePath);
Mehdi Amini41af4302016-11-11 04:28:40 +00001108 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001109 }
1110
Mehdi Amini41af4302016-11-11 04:28:40 +00001111 Error wait() override { return Error::success(); }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001112};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001113} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001114
Vitaly Bukaa139b692018-02-22 19:06:15 +00001115ThinBackend lto::createWriteIndexesThinBackend(
1116 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
1117 raw_fd_ostream *LinkedObjectsFile, IndexWriteCallback OnWrite) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001118 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001119 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001120 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001121 return llvm::make_unique<WriteIndexesThinBackend>(
Mehdi Amini18b91112016-08-19 06:10:03 +00001122 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
Vitaly Buka59baf732018-01-30 21:19:26 +00001123 ShouldEmitImportsFiles, LinkedObjectsFile, OnWrite);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001124 };
1125}
1126
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001127Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001128 if (ThinLTO.ModuleMap.empty())
Mehdi Amini41af4302016-11-11 04:28:40 +00001129 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001130
1131 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
Mehdi Amini41af4302016-11-11 04:28:40 +00001132 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001133
1134 // Collect for each module the list of function it defines (GUID ->
1135 // Summary).
Dehao Chen5d96ee42017-07-10 20:12:54 +00001136 StringMap<GVSummaryMapTy>
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001137 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1138 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1139 ModuleToDefinedGVSummaries);
Teresa Johnson620c1402016-09-20 23:07:17 +00001140 // 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);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001150
1151 StringMap<FunctionImporter::ImportMapTy> ImportLists(
1152 ThinLTO.ModuleMap.size());
1153 StringMap<FunctionImporter::ExportSetTy> ExportLists(
1154 ThinLTO.ModuleMap.size());
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001155 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001156
Charles Saternosb040fcc2018-02-19 15:14:50 +00001157 if (DumpThinCGSCCs)
1158 ThinLTO.CombinedIndex.dumpSCCs(outs());
1159
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001160 if (Conf.OptLevel > 0)
Teresa Johnson002af9b2016-10-31 22:12:21 +00001161 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +00001162 ImportLists, ExportLists);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001163
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001164 // 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) {
George Rimard3283652018-01-25 17:23:27 +00001170 // 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 ||
George Rimareaf51722018-01-29 08:03:30 +00001173 !Res.second.isPrevailingIRSymbol())
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001174 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);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001180 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001181
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001182 // 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)));
1187
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);
1193 };
1194 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported);
1195
Peter Collingbournef87197a2017-05-25 23:40:11 +00001196 auto isPrevailing = [&](GlobalValue::GUID GUID,
1197 const GlobalValueSummary *S) {
1198 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath();
1199 };
1200 auto recordNewLinkage = [&](StringRef ModuleIdentifier,
1201 GlobalValue::GUID GUID,
1202 GlobalValue::LinkageTypes NewLinkage) {
1203 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage;
1204 };
1205 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing,
1206 recordNewLinkage);
1207
Peter Collingbourne80186a52016-09-23 21:33:43 +00001208 std::unique_ptr<ThinBackendProc> BackendProc =
1209 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1210 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001211
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001212 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined
1213 // module and parallel code generation partitions.
1214 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001215 for (auto &Mod : ThinLTO.ModuleMap) {
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001216 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001217 ExportLists[Mod.first],
1218 ResolvedODR[Mod.first], ThinLTO.ModuleMap))
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001219 return E;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001220 ++Task;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001221 }
1222
1223 return BackendProc->wait();
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001224}
Davide Italiano690ed9d2017-02-10 23:49:38 +00001225
Bob Haarmanfb2d3422018-03-08 01:13:10 +00001226Expected<std::unique_ptr<ToolOutputFile>>
1227lto::setupOptimizationRemarks(LLVMContext &Context,
1228 StringRef LTORemarksFilename,
1229 bool LTOPassRemarksWithHotness, int Count) {
Teresa Johnsonb77ab092018-05-04 23:59:34 +00001230 if (LTOPassRemarksWithHotness)
1231 Context.setDiagnosticsHotnessRequested(true);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001232 if (LTORemarksFilename.empty())
1233 return nullptr;
1234
1235 std::string Filename = LTORemarksFilename;
1236 if (Count != -1)
1237 Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1238
1239 std::error_code EC;
1240 auto DiagnosticFile =
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001241 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001242 if (EC)
1243 return errorCodeToError(EC);
1244 Context.setDiagnosticsOutputFile(
1245 llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
Davide Italiano690ed9d2017-02-10 23:49:38 +00001246 DiagnosticFile->keep();
1247 return std::move(DiagnosticFile);
1248}