blob: 50d0075a60813da90b2bd24b83df0d7d2416639d [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
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 std::set<GlobalValue::GUID> &CfiFunctionDefs,
69 const std::set<GlobalValue::GUID> &CfiFunctionDecls) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +000070 // Compute the unique hash for this entry.
71 // This is based on the current compiler version, the module itself, the
72 // export list, the hash for every single module in the import list, the
73 // list of ResolvedODR for the module, and the list of preserved symbols.
74 SHA1 Hasher;
75
76 // Start with the compiler revision
77 Hasher.update(LLVM_VERSION_STRING);
Peter Collingbourne942fa562017-04-13 01:26:12 +000078#ifdef LLVM_REVISION
Mehdi Aminiadc0e262016-08-23 21:30:12 +000079 Hasher.update(LLVM_REVISION);
80#endif
81
Peter Collingbournef4257522016-12-08 05:28:30 +000082 // Include the parts of the LTO configuration that affect code generation.
83 auto AddString = [&](StringRef Str) {
84 Hasher.update(Str);
85 Hasher.update(ArrayRef<uint8_t>{0});
86 };
87 auto AddUnsigned = [&](unsigned I) {
88 uint8_t Data[4];
89 Data[0] = I;
90 Data[1] = I >> 8;
91 Data[2] = I >> 16;
92 Data[3] = I >> 24;
93 Hasher.update(ArrayRef<uint8_t>{Data, 4});
94 };
Peter Collingbourne54a52b72017-03-03 20:25:30 +000095 auto AddUint64 = [&](uint64_t I) {
96 uint8_t Data[8];
97 Data[0] = I;
98 Data[1] = I >> 8;
99 Data[2] = I >> 16;
100 Data[3] = I >> 24;
101 Data[4] = I >> 32;
102 Data[5] = I >> 40;
103 Data[6] = I >> 48;
104 Data[7] = I >> 56;
105 Hasher.update(ArrayRef<uint8_t>{Data, 8});
106 };
Peter Collingbournef4257522016-12-08 05:28:30 +0000107 AddString(Conf.CPU);
108 // FIXME: Hash more of Options. For now all clients initialize Options from
109 // command-line flags (which is unsupported in production), but may set
110 // RelaxELFRelocations. The clang driver can also pass FunctionSections,
111 // DataSections and DebuggerTuning via command line flags.
112 AddUnsigned(Conf.Options.RelaxELFRelocations);
113 AddUnsigned(Conf.Options.FunctionSections);
114 AddUnsigned(Conf.Options.DataSections);
115 AddUnsigned((unsigned)Conf.Options.DebuggerTuning);
116 for (auto &A : Conf.MAttrs)
117 AddString(A);
Evgeniy Stepanovb9f1b012017-05-22 21:11:35 +0000118 if (Conf.RelocModel)
119 AddUnsigned(*Conf.RelocModel);
120 else
121 AddUnsigned(-1);
Rafael Espindola79e238a2017-08-03 02:16:21 +0000122 if (Conf.CodeModel)
123 AddUnsigned(*Conf.CodeModel);
124 else
125 AddUnsigned(-1);
Peter Collingbournef4257522016-12-08 05:28:30 +0000126 AddUnsigned(Conf.CGOptLevel);
Tobias Edler von Kochf454b9e2017-02-15 20:36:36 +0000127 AddUnsigned(Conf.CGFileType);
Peter Collingbournef4257522016-12-08 05:28:30 +0000128 AddUnsigned(Conf.OptLevel);
Tim Shen4e912aa2017-06-01 23:13:44 +0000129 AddUnsigned(Conf.UseNewPM);
Peter Collingbournef4257522016-12-08 05:28:30 +0000130 AddString(Conf.OptPipeline);
131 AddString(Conf.AAPipeline);
132 AddString(Conf.OverrideTriple);
133 AddString(Conf.DefaultTriple);
Yunlian Jiangbd200b92018-04-13 05:03:28 +0000134 AddString(Conf.DwoDir);
Peter Collingbournef4257522016-12-08 05:28:30 +0000135
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)
Teresa Johnsond68935c2018-07-16 15:30:27 +0000152 AddUint64(Fn);
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;
Peter Collingbourne7f1a5ba2018-02-09 05:58:55 +0000180 AddUnsigned(GS->isLive());
Peter Collingbourneb4edfb92018-02-05 17:17:51 +0000181 for (const ValueInfo &VI : GS->refs()) {
182 AddUnsigned(VI.isDSOLocal());
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000183 AddUsedCfiGlobal(VI.getGUID());
Peter Collingbourneb4edfb92018-02-05 17:17:51 +0000184 }
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000185 if (auto *FS = dyn_cast<FunctionSummary>(GS)) {
186 for (auto &TT : FS->type_tests())
187 UsedTypeIds.insert(TT);
188 for (auto &TT : FS->type_test_assume_vcalls())
189 UsedTypeIds.insert(TT.GUID);
190 for (auto &TT : FS->type_checked_load_vcalls())
191 UsedTypeIds.insert(TT.GUID);
192 for (auto &TT : FS->type_test_assume_const_vcalls())
193 UsedTypeIds.insert(TT.VFunc.GUID);
194 for (auto &TT : FS->type_checked_load_const_vcalls())
195 UsedTypeIds.insert(TT.VFunc.GUID);
Peter Collingbourne3fe815d2018-02-05 23:46:32 +0000196 for (auto &ET : FS->calls()) {
197 AddUnsigned(ET.first.isDSOLocal());
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000198 AddUsedCfiGlobal(ET.first.getGUID());
Peter Collingbourne3fe815d2018-02-05 23:46:32 +0000199 }
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000200 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000201 };
202
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000203 // Include the hash for the linkage type to reflect internalization and weak
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000204 // resolution, and collect any used type identifier resolutions.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000205 for (auto &GS : DefinedGlobals) {
206 GlobalValue::LinkageTypes Linkage = GS.second->linkage();
207 Hasher.update(
208 ArrayRef<uint8_t>((const uint8_t *)&Linkage, sizeof(Linkage)));
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000209 AddUsedCfiGlobal(GS.first);
210 AddUsedThings(GS.second);
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000211 }
212
213 // Imported functions may introduce new uses of type identifier resolutions,
214 // so we need to collect their used resolutions as well.
215 for (auto &ImpM : ImportList)
216 for (auto &ImpF : ImpM.second)
Teresa Johnsond68935c2018-07-16 15:30:27 +0000217 AddUsedThings(Index.findSummaryInModule(ImpF, ImpM.first()));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000218
219 auto AddTypeIdSummary = [&](StringRef TId, const TypeIdSummary &S) {
220 AddString(TId);
221
222 AddUnsigned(S.TTRes.TheKind);
223 AddUnsigned(S.TTRes.SizeM1BitWidth);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000224
Peter Collingbourneb9b60252017-09-11 22:49:10 +0000225 AddUint64(S.TTRes.AlignLog2);
226 AddUint64(S.TTRes.SizeM1);
227 AddUint64(S.TTRes.BitMask);
228 AddUint64(S.TTRes.InlineBits);
229
Peter Collingbourne711284b2017-03-10 21:37:10 +0000230 AddUint64(S.WPDRes.size());
231 for (auto &WPD : S.WPDRes) {
232 AddUnsigned(WPD.first);
233 AddUnsigned(WPD.second.TheKind);
234 AddString(WPD.second.SingleImplName);
235
236 AddUint64(WPD.second.ResByArg.size());
237 for (auto &ByArg : WPD.second.ResByArg) {
238 AddUint64(ByArg.first.size());
239 for (uint64_t Arg : ByArg.first)
240 AddUint64(Arg);
241 AddUnsigned(ByArg.second.TheKind);
242 AddUint64(ByArg.second.Info);
Peter Collingbourneb15a35e2017-09-11 22:34:42 +0000243 AddUnsigned(ByArg.second.Byte);
244 AddUnsigned(ByArg.second.Bit);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000245 }
246 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000247 };
248
249 // Include the hash for all type identifiers used by this module.
250 for (GlobalValue::GUID TId : UsedTypeIds) {
Teresa Johnson7fb39df2018-09-25 20:14:40 +0000251 auto TidIter = Index.typeIds().equal_range(TId);
252 for (auto It = TidIter.first; It != TidIter.second; ++It)
253 AddTypeIdSummary(It->second.first, It->second.second);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000254 }
255
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000256 AddUnsigned(UsedCfiDefs.size());
257 for (auto &V : UsedCfiDefs)
258 AddUint64(V);
259
260 AddUnsigned(UsedCfiDecls.size());
261 for (auto &V : UsedCfiDecls)
262 AddUint64(V);
263
Dehao Chen27978002016-12-16 16:48:46 +0000264 if (!Conf.SampleProfile.empty()) {
265 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile);
266 if (FileOrErr)
267 Hasher.update(FileOrErr.get()->getBuffer());
268 }
269
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000270 Key = toHex(Hasher.result());
271}
272
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000273static void thinLTOResolveWeakForLinkerGUID(
274 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
275 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000276 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000277 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000278 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000279 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000280 for (auto &S : GVSummaryList) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000281 GlobalValue::LinkageTypes OriginalLinkage = S->linkage();
282 if (!GlobalValue::isWeakForLinker(OriginalLinkage))
283 continue;
Peter Collingbourne73589f32016-07-07 18:31:51 +0000284 // We need to emit only one of these. The prevailing module will keep it,
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000285 // but turned into a weak, while the others will drop it when possible.
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000286 // This is both a compile-time optimization and a correctness
287 // transformation. This is necessary for correctness when we have exported
288 // a reference - we need to convert the linkonce to weak to
289 // ensure a copy is kept to satisfy the exported reference.
290 // FIXME: We may want to split the compile time and correctness
291 // aspects into separate routines.
Peter Collingbourne73589f32016-07-07 18:31:51 +0000292 if (isPrevailing(GUID, S.get())) {
Teresa Johnson28c03b52016-05-26 14:16:52 +0000293 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
294 S->setLinkage(GlobalValue::getWeakLinkage(
295 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000296 }
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000297 // Alias and aliasee can't be turned into available_externally.
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000298 else if (!isa<AliasSummary>(S.get()) &&
Teresa Johnson4566c6d2017-01-20 21:54:58 +0000299 !GlobalInvolvedWithAlias.count(S.get()))
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000300 S->setLinkage(GlobalValue::AvailableExternallyLinkage);
301 if (S->linkage() != OriginalLinkage)
302 recordNewLinkage(S->modulePath(), GUID, S->linkage());
303 }
304}
305
306// Resolve Weak and LinkOnce values in the \p Index.
307//
308// We'd like to drop these functions if they are no longer referenced in the
309// current module. However there is a chance that another module is still
310// referencing them because of the import. We make sure we always emit at least
311// one copy.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000312void llvm::thinLTOResolveWeakForLinkerInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000313 ModuleSummaryIndex &Index,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000314 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000315 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000316 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000317 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000318 // We won't optimize the globals that are referenced by an alias for now
319 // Ideally we should turn the alias into a global and duplicate the definition
320 // when needed.
321 DenseSet<GlobalValueSummary *> GlobalInvolvedWithAlias;
322 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000323 for (auto &S : I.second.SummaryList)
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000324 if (auto AS = dyn_cast<AliasSummary>(S.get()))
325 GlobalInvolvedWithAlias.insert(&AS->getAliasee());
326
327 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000328 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first,
329 GlobalInvolvedWithAlias, isPrevailing,
330 recordNewLinkage);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000331}
332
333static void thinLTOInternalizeAndPromoteGUID(
334 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000335 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000336 for (auto &S : GVSummaryList) {
Mehdi Amini1380edf2017-02-03 07:41:43 +0000337 if (isExported(S->modulePath(), GUID)) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000338 if (GlobalValue::isLocalLinkage(S->linkage()))
339 S->setLinkage(GlobalValue::ExternalLinkage);
340 } else if (!GlobalValue::isLocalLinkage(S->linkage()))
341 S->setLinkage(GlobalValue::InternalLinkage);
342 }
343}
344
345// Update the linkages in the given \p Index to mark exported values
346// as external and non-exported values as internal.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000347void llvm::thinLTOInternalizeAndPromoteInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000348 ModuleSummaryIndex &Index,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000349 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000350 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000351 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000352}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000353
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000354// Requires a destructor for std::vector<InputModule>.
355InputFile::~InputFile() = default;
356
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000357Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) {
358 std::unique_ptr<InputFile> File(new InputFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000359
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000360 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object);
361 if (!FOrErr)
362 return FOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000363
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000364 File->TargetTriple = FOrErr->TheReader.getTargetTriple();
365 File->SourceFileName = FOrErr->TheReader.getSourceFileName();
366 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts();
367 File->ComdatTable = FOrErr->TheReader.getComdatTable();
Peter Collingbournead903692016-12-13 19:43:49 +0000368
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000369 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000370 size_t Begin = File->Symbols.size();
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000371 for (const irsymtab::Reader::SymbolRef &Sym :
372 FOrErr->TheReader.module_symbols(I))
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000373 // Skip symbols that are irrelevant to LTO. Note that this condition needs
374 // to match the one in Skip() in LTO::addRegularLTO().
375 if (Sym.isGlobal() && !Sym.isFormatSpecific())
376 File->Symbols.push_back(Sym);
377 File->ModuleSymIndices.push_back({Begin, File->Symbols.size()});
Rafael Espindola79121102016-10-25 12:02:03 +0000378 }
379
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000380 File->Mods = FOrErr->Mods;
381 File->Strtab = std::move(FOrErr->Strtab);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000382 return std::move(File);
383}
384
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000385StringRef InputFile::getName() const {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000386 return Mods[0].getModuleIdentifier();
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000387}
388
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000389LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel,
390 Config &Conf)
391 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel),
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000392 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)),
393 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000394
Eugene Leviant28d8a492018-01-22 13:35:40 +0000395LTO::ThinLTOState::ThinLTOState(ThinBackend Backend)
Teresa Johnson4ffc3e72018-06-06 22:22:01 +0000396 : Backend(Backend), CombinedIndex(/*HaveGVs*/ false) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000397 if (!Backend)
Teresa Johnsonec544c52016-10-19 17:35:01 +0000398 this->Backend =
399 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency());
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000400}
401
402LTO::LTO(Config Conf, ThinBackend Backend,
403 unsigned ParallelCodeGenParallelismLevel)
404 : Conf(std::move(Conf)),
405 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf),
Mehdi Amini026ddbb2016-08-19 05:56:37 +0000406 ThinLTO(std::move(Backend)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000407
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000408// Requires a destructor for MapVector<BitcodeModule>.
409LTO::~LTO() = default;
410
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000411// Add the symbols in the given module to the GlobalResolutions map, and resolve
412// their partitions.
413void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms,
414 ArrayRef<SymbolResolution> Res,
415 unsigned Partition, bool InSummary) {
416 auto *ResI = Res.begin();
417 auto *ResE = Res.end();
Peter Collingbourne7e85b262017-06-15 17:41:32 +0000418 (void)ResE;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000419 for (const InputFile::Symbol &Sym : Syms) {
420 assert(ResI != ResE);
421 SymbolResolution Res = *ResI++;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000422
Teresa Johnsonb963c0b2018-07-23 22:33:57 +0000423 StringRef Name = Sym.getName();
424 Triple TT(RegularLTO.CombinedModule->getTargetTriple());
425 // Strip the __imp_ prefix from COFF dllimport symbols (similar to the
426 // way they are handled by lld), otherwise we can end up with two
427 // global resolutions (one with and one for a copy of the symbol without).
428 if (TT.isOSBinFormatCOFF() && Name.startswith("__imp_"))
429 Name = Name.substr(strlen("__imp_"));
430 auto &GlobalRes = GlobalResolutions[Name];
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000431 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr();
Eugene Leviant746f1522017-12-15 09:18:21 +0000432 if (Res.Prevailing) {
George Rimard3283652018-01-25 17:23:27 +0000433 assert(!GlobalRes.Prevailing &&
Eugene Leviantcb122492017-12-15 16:27:33 +0000434 "Multiple prevailing defs are not allowed");
George Rimard3283652018-01-25 17:23:27 +0000435 GlobalRes.Prevailing = true;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000436 GlobalRes.IRName = Sym.getIRName();
George Rimareaf51722018-01-29 08:03:30 +0000437 } else if (!GlobalRes.Prevailing && GlobalRes.IRName.empty()) {
438 // Sometimes it can be two copies of symbol in a module and prevailing
439 // symbol can have no IR name. That might happen if symbol is defined in
440 // module level inline asm block. In case we have multiple modules with
441 // the same symbol we want to use IR name of the prevailing symbol.
442 // Otherwise, if we haven't seen a prevailing symbol, set the name so that
443 // we can later use it to check if there is any prevailing copy in IR.
444 GlobalRes.IRName = Sym.getIRName();
Eugene Leviant746f1522017-12-15 09:18:21 +0000445 }
Teresa Johnson6c475a72017-01-05 21:34:18 +0000446
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000447 // Set the partition to external if we know it is re-defined by the linker
448 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a
449 // regular object, is referenced from llvm.compiler_used, or was already
450 // recorded as being referenced from a different partition.
451 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() ||
452 (GlobalRes.Partition != GlobalResolution::Unknown &&
453 GlobalRes.Partition != Partition)) {
454 GlobalRes.Partition = GlobalResolution::External;
455 } else
456 // First recorded reference, save the current partition.
457 GlobalRes.Partition = Partition;
458
459 // Flag as visible outside of summary if visible from a regular object or
460 // from a module that does not have a summary.
461 GlobalRes.VisibleOutsideSummary |=
462 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary);
463 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000464}
465
Rafael Espindola7775c332016-08-26 20:19:35 +0000466static void writeToResolutionFile(raw_ostream &OS, InputFile *Input,
467 ArrayRef<SymbolResolution> Res) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000468 StringRef Path = Input->getName();
Rafael Espindola7775c332016-08-26 20:19:35 +0000469 OS << Path << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000470 auto ResI = Res.begin();
471 for (const InputFile::Symbol &Sym : Input->symbols()) {
472 assert(ResI != Res.end());
473 SymbolResolution Res = *ResI++;
474
Rafael Espindola7775c332016-08-26 20:19:35 +0000475 OS << "-r=" << Path << ',' << Sym.getName() << ',';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000476 if (Res.Prevailing)
Rafael Espindola7775c332016-08-26 20:19:35 +0000477 OS << 'p';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000478 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola7775c332016-08-26 20:19:35 +0000479 OS << 'l';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000480 if (Res.VisibleToRegularObj)
Rafael Espindola7775c332016-08-26 20:19:35 +0000481 OS << 'x';
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000482 if (Res.LinkerRedefined)
483 OS << 'r';
Rafael Espindola7775c332016-08-26 20:19:35 +0000484 OS << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000485 }
Peter Collingbourne58ffcfb2017-01-19 23:10:14 +0000486 OS.flush();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000487 assert(ResI == Res.end());
488}
489
490Error LTO::add(std::unique_ptr<InputFile> Input,
491 ArrayRef<SymbolResolution> Res) {
492 assert(!CalledGetMaxTasks);
493
494 if (Conf.ResolutionFile)
Rafael Espindola7775c332016-08-26 20:19:35 +0000495 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000496
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000497 if (RegularLTO.CombinedModule->getTargetTriple().empty())
498 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple());
499
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000500 const SymbolResolution *ResI = Res.begin();
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000501 for (unsigned I = 0; I != Input->Mods.size(); ++I)
502 if (Error Err = addModule(*Input, I, ResI, Res.end()))
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000503 return Err;
504
505 assert(ResI == Res.end());
506 return Error::success();
507}
508
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000509Error LTO::addModule(InputFile &Input, unsigned ModI,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000510 const SymbolResolution *&ResI,
511 const SymbolResolution *ResE) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000512 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo();
513 if (!LTOInfo)
514 return LTOInfo.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000515
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000516 BitcodeModule BM = Input.Mods[ModI];
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000517 auto ModSyms = Input.module_symbols(ModI);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000518 addModuleToGlobalRes(ModSyms, {ResI, ResE},
519 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0,
520 LTOInfo->HasSummary);
521
522 if (LTOInfo->IsThinLTO)
523 return addThinLTO(BM, ModSyms, ResI, ResE);
524
525 Expected<RegularLTOState::AddedModule> ModOrErr =
526 addRegularLTO(BM, ModSyms, ResI, ResE);
527 if (!ModOrErr)
528 return ModOrErr.takeError();
529
530 if (!LTOInfo->HasSummary)
531 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false);
532
533 // Regular LTO module summaries are added to a dummy module that represents
534 // the combined regular LTO module.
535 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull))
536 return Err;
537 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr));
538 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000539}
540
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000541// Checks whether the given global value is in a non-prevailing comdat
542// (comdat containing values the linker indicated were not prevailing,
543// which we then dropped to available_externally), and if so, removes
544// it from the comdat. This is called for all global values to ensure the
545// comdat is empty rather than leaving an incomplete comdat. It is needed for
546// regular LTO modules, in case we are in a mixed-LTO mode (both regular
547// and thin LTO modules) compilation. Since the regular LTO module will be
548// linked first in the final native link, we want to make sure the linker
549// doesn't select any of these incomplete comdats that would be left
550// in the regular LTO module without this cleanup.
551static void
552handleNonPrevailingComdat(GlobalValue &GV,
553 std::set<const Comdat *> &NonPrevailingComdats) {
554 Comdat *C = GV.getComdat();
555 if (!C)
556 return;
557
558 if (!NonPrevailingComdats.count(C))
559 return;
560
561 // Additionally need to drop externally visible global values from the comdat
562 // to available_externally, so that there aren't multiply defined linker
563 // errors.
564 if (!GV.hasLocalLinkage())
565 GV.setLinkage(GlobalValue::AvailableExternallyLinkage);
566
567 if (auto GO = dyn_cast<GlobalObject>(&GV))
568 GO->setComdat(nullptr);
569}
570
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000571// Add a regular LTO object to the link.
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000572// The resulting module needs to be linked into the combined LTO module with
573// linkRegularLTO.
574Expected<LTO::RegularLTOState::AddedModule>
575LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
576 const SymbolResolution *&ResI,
577 const SymbolResolution *ResE) {
578 RegularLTOState::AddedModule Mod;
Peter Collingbournead903692016-12-13 19:43:49 +0000579 Expected<std::unique_ptr<Module>> MOrErr =
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000580 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true,
581 /*IsImporting*/ false);
Peter Collingbournead903692016-12-13 19:43:49 +0000582 if (!MOrErr)
583 return MOrErr.takeError();
Peter Collingbournead903692016-12-13 19:43:49 +0000584 Module &M = **MOrErr;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000585 Mod.M = std::move(*MOrErr);
586
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000587 if (Error Err = M.materializeMetadata())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000588 return std::move(Err);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000589 UpgradeDebugInfo(M);
590
Peter Collingbournead903692016-12-13 19:43:49 +0000591 ModuleSymbolTable SymTab;
592 SymTab.addModule(&M);
593
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000594 for (GlobalVariable &GV : M.globals())
595 if (GV.hasAppendingLinkage())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000596 Mod.Keep.push_back(&GV);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000597
Peter Collingbourne46136262017-02-02 05:22:42 +0000598 DenseSet<GlobalObject *> AliasedGlobals;
599 for (auto &GA : M.aliases())
600 if (GlobalObject *GO = GA.getBaseObject())
601 AliasedGlobals.insert(GO);
602
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000603 // In this function we need IR GlobalValues matching the symbols in Syms
604 // (which is not backed by a module), so we need to enumerate them in the same
605 // order. The symbol enumeration order of a ModuleSymbolTable intentionally
606 // matches the order of an irsymtab, but when we read the irsymtab in
607 // InputFile::create we omit some symbols that are irrelevant to LTO. The
608 // Skip() function skips the same symbols from the module as InputFile does
609 // from the symbol table.
610 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end();
611 auto Skip = [&]() {
612 while (MsymI != MsymE) {
613 auto Flags = SymTab.getSymbolFlags(*MsymI);
614 if ((Flags & object::BasicSymbolRef::SF_Global) &&
615 !(Flags & object::BasicSymbolRef::SF_FormatSpecific))
616 return;
617 ++MsymI;
618 }
619 };
620 Skip();
621
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000622 std::set<const Comdat *> NonPrevailingComdats;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000623 for (const InputFile::Symbol &Sym : Syms) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000624 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000625 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000626
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000627 assert(MsymI != MsymE);
628 ModuleSymbolTable::Symbol Msym = *MsymI++;
629 Skip();
630
631 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) {
Peter Collingbournec387e702017-02-02 05:12:15 +0000632 if (Res.Prevailing) {
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000633 if (Sym.isUndefined())
Peter Collingbournec387e702017-02-02 05:12:15 +0000634 continue;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000635 Mod.Keep.push_back(GV);
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000636 // For symbols re-defined with linker -wrap and -defsym options,
637 // set the linkage to weak to inhibit IPO. The linkage will be
638 // restored by the linker.
639 if (Res.LinkerRedefined)
640 GV->setLinkage(GlobalValue::WeakAnyLinkage);
641
Davide Italianod4db1162017-05-26 21:56:14 +0000642 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage();
643 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
644 GV->setLinkage(GlobalValue::getWeakLinkage(
645 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Peter Collingbourne46136262017-02-02 05:22:42 +0000646 } else if (isa<GlobalObject>(GV) &&
647 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() ||
648 GV->hasAvailableExternallyLinkage()) &&
649 !AliasedGlobals.count(cast<GlobalObject>(GV))) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000650 // Any of the above three types of linkage indicates that the
Peter Collingbourne46136262017-02-02 05:22:42 +0000651 // chosen prevailing symbol will have the same semantics as this copy of
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000652 // the symbol, so we may be able to link it with available_externally
653 // linkage. We will decide later whether to do that when we link this
654 // module (in linkRegularLTO), based on whether it is undefined.
655 Mod.Keep.push_back(GV);
656 GV->setLinkage(GlobalValue::AvailableExternallyLinkage);
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000657 if (GV->hasComdat())
658 NonPrevailingComdats.insert(GV->getComdat());
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000659 cast<GlobalObject>(GV)->setComdat(nullptr);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000660 }
Sean Fertile4595a912017-11-04 17:04:39 +0000661
662 // Set the 'local' flag based on the linker resolution for this symbol.
Rafael Espindola8a1ca672018-01-18 05:38:43 +0000663 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola349fe0a2018-01-24 19:11:24 +0000664 GV->setDSOLocal(true);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000665 }
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000666 // Common resolution: collect the maximum size/alignment over all commons.
667 // We also record if we see an instance of a common as prevailing, so that
668 // if none is prevailing we can ignore it later.
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000669 if (Sym.isCommon()) {
Peter Collingbournefb8c2a42016-12-01 02:51:12 +0000670 // FIXME: We should figure out what to do about commons defined by asm.
671 // For now they aren't reported correctly by ModuleSymbolTable.
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000672 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000673 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
674 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000675 CommonRes.Prevailing |= Res.Prevailing;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000676 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000677
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000678 }
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000679 if (!M.getComdatSymbolTable().empty())
680 for (GlobalValue &GV : M.global_values())
681 handleNonPrevailingComdat(GV, NonPrevailingComdats);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000682 assert(MsymI == MsymE);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000683 return std::move(Mod);
684}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000685
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000686Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
687 bool LivenessFromIndex) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000688 std::vector<GlobalValue *> Keep;
689 for (GlobalValue *GV : Mod.Keep) {
690 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
691 continue;
692
693 if (!GV->hasAvailableExternallyLinkage()) {
694 Keep.push_back(GV);
695 continue;
696 }
697
698 // Only link available_externally definitions if we don't already have a
699 // definition.
700 GlobalValue *CombinedGV =
701 RegularLTO.CombinedModule->getNamedValue(GV->getName());
702 if (CombinedGV && !CombinedGV->isDeclaration())
703 continue;
704
705 Keep.push_back(GV);
706 }
707
708 return RegularLTO.Mover->move(std::move(Mod.M), Keep,
Teresa Johnson4b9b3792016-10-12 18:39:29 +0000709 [](GlobalValue &, IRMover::ValueAdder) {},
Teresa Johnson040cc162016-12-12 16:09:30 +0000710 /* IsPerformingImport */ false);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000711}
712
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000713// Add a ThinLTO module to the link.
714Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000715 const SymbolResolution *&ResI,
716 const SymbolResolution *ResE) {
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000717 if (Error Err =
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000718 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
719 ThinLTO.ModuleMap.size()))
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000720 return Err;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000721
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000722 for (const InputFile::Symbol &Sym : Syms) {
723 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000724 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000725
Sean Fertile4595a912017-11-04 17:04:39 +0000726 if (!Sym.getIRName().empty()) {
727 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
728 Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
729 if (Res.Prevailing) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000730 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
Davide Italiano6a5fbe52017-07-06 19:58:26 +0000731
732 // For linker redefined symbols (via --wrap or --defsym) we want to
733 // switch the linkage to `weak` to prevent IPOs from happening.
734 // Find the summary in the module for this very GV and record the new
735 // linkage so that we can switch it when we import the GV.
736 if (Res.LinkerRedefined)
737 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
738 GUID, BM.getModuleIdentifier()))
739 S->setLinkage(GlobalValue::WeakAnyLinkage);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000740 }
Sean Fertile4595a912017-11-04 17:04:39 +0000741
742 // If the linker resolved the symbol to a local definition then mark it
743 // as local in the summary for the module we are adding.
744 if (Res.FinalDefinitionInLinkageUnit) {
745 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
746 GUID, BM.getModuleIdentifier())) {
747 S->setDSOLocal(true);
748 }
749 }
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000750 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000751 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000752
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000753 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second)
754 return make_error<StringError>(
755 "Expected at most one ThinLTO module per bitcode file",
756 inconvertibleErrorCode());
757
Mehdi Amini41af4302016-11-11 04:28:40 +0000758 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000759}
760
Teresa Johnsonfaa75062016-08-11 20:38:39 +0000761unsigned LTO::getMaxTasks() const {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000762 CalledGetMaxTasks = true;
763 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
764}
765
Peter Collingbourne80186a52016-09-23 21:33:43 +0000766Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000767 // Compute "dead" symbols, we don't want to import/export these!
768 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
George Rimareaf51722018-01-29 08:03:30 +0000769 DenseMap<GlobalValue::GUID, PrevailingType> GUIDPrevailingResolutions;
770 for (auto &Res : GlobalResolutions) {
771 // Normally resolution have IR name of symbol. We can do nothing here
772 // otherwise. See comments in GlobalResolution struct for more details.
773 if (Res.second.IRName.empty())
774 continue;
775
776 GlobalValue::GUID GUID = GlobalValue::getGUID(
777 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
778
George Rimard3283652018-01-25 17:23:27 +0000779 if (Res.second.VisibleOutsideSummary && Res.second.Prevailing)
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000780 GUIDPreservedSymbols.insert(GlobalValue::getGUID(
781 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000782
George Rimareaf51722018-01-29 08:03:30 +0000783 GUIDPrevailingResolutions[GUID] =
784 Res.second.Prevailing ? PrevailingType::Yes : PrevailingType::No;
785 }
786
787 auto isPrevailing = [&](GlobalValue::GUID G) {
788 auto It = GUIDPrevailingResolutions.find(G);
789 if (It == GUIDPrevailingResolutions.end())
790 return PrevailingType::Unknown;
791 return It->second;
792 };
793 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols, isPrevailing);
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000794
Florian Hahnd4332eb2018-04-20 10:18:36 +0000795 // Setup output file to emit statistics.
796 std::unique_ptr<ToolOutputFile> StatsFile = nullptr;
797 if (!Conf.StatsFile.empty()) {
798 EnableStatistics(false);
799 std::error_code EC;
800 StatsFile =
801 llvm::make_unique<ToolOutputFile>(Conf.StatsFile, EC, sys::fs::F_None);
802 if (EC)
803 return errorCodeToError(EC);
804 StatsFile->keep();
805 }
806
807 Error Result = runRegularLTO(AddStream);
808 if (!Result)
809 Result = runThinLTO(AddStream, Cache);
810
811 if (StatsFile)
812 PrintStatisticsJSON(StatsFile->os());
813
814 return Result;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000815}
816
Peter Collingbourne80186a52016-09-23 21:33:43 +0000817Error LTO::runRegularLTO(AddStreamFn AddStream) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000818 for (auto &M : RegularLTO.ModsWithSummaries)
819 if (Error Err = linkRegularLTO(std::move(M),
820 /*LivenessFromIndex=*/true))
821 return Err;
822
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000823 // Make sure commons have the right size/alignment: we kept the largest from
824 // all the prevailing when adding the inputs, and we apply it here.
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000825 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000826 for (auto &I : RegularLTO.Commons) {
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000827 if (!I.second.Prevailing)
828 // Don't do anything if no instance of this common was prevailing.
829 continue;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000830 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000831 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000832 // Don't create a new global if the type is already correct, just make
833 // sure the alignment is correct.
834 OldGV->setAlignment(I.second.Align);
835 continue;
836 }
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000837 ArrayType *Ty =
838 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000839 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false,
840 GlobalValue::CommonLinkage,
841 ConstantAggregateZero::get(Ty), "");
842 GV->setAlignment(I.second.Align);
843 if (OldGV) {
844 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType()));
845 GV->takeName(OldGV);
846 OldGV->eraseFromParent();
847 } else {
848 GV->setName(I.first);
849 }
850 }
851
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000852 if (Conf.PreOptModuleHook &&
853 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000854 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000855
Mehdi Aminid310b472016-08-22 06:25:41 +0000856 if (!Conf.CodeGenOnly) {
857 for (const auto &R : GlobalResolutions) {
George Rimareaf51722018-01-29 08:03:30 +0000858 if (!R.second.isPrevailingIRSymbol())
Mehdi Aminid310b472016-08-22 06:25:41 +0000859 continue;
860 if (R.second.Partition != 0 &&
861 R.second.Partition != GlobalResolution::External)
862 continue;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000863
Mehdi Aminid310b472016-08-22 06:25:41 +0000864 GlobalValue *GV =
865 RegularLTO.CombinedModule->getNamedValue(R.second.IRName);
866 // Ignore symbols defined in other partitions.
Bob Haarmaneae47422018-07-27 05:40:29 +0000867 // Also skip declarations, which are not allowed to have internal linkage.
868 if (!GV || GV->hasLocalLinkage() || GV->isDeclaration())
Mehdi Aminid310b472016-08-22 06:25:41 +0000869 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;
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000912 std::set<GlobalValue::GUID> CfiFunctionDefs;
913 std::set<GlobalValue::GUID> CfiFunctionDecls;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000914
915 Optional<Error> Err;
916 std::mutex ErrMu;
917
918public:
Mehdi Amini767e1452016-09-06 03:23:45 +0000919 InProcessThinBackend(
920 Config &Conf, ModuleSummaryIndex &CombinedIndex,
921 unsigned ThinLTOParallelismLevel,
922 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000923 AddStreamFn AddStream, NativeObjectCache Cache)
Mehdi Amini18b91112016-08-19 06:10:03 +0000924 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
925 BackendThreadPool(ThinLTOParallelismLevel),
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000926 AddStream(std::move(AddStream)), Cache(std::move(Cache)) {
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000927 for (auto &Name : CombinedIndex.cfiFunctionDefs())
928 CfiFunctionDefs.insert(
929 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
930 for (auto &Name : CombinedIndex.cfiFunctionDecls())
931 CfiFunctionDecls.insert(
932 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000933 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000934
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000935 Error runThinLTOBackendThread(
Peter Collingbourne80186a52016-09-23 21:33:43 +0000936 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000937 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000938 const FunctionImporter::ImportMapTy &ImportList,
939 const FunctionImporter::ExportSetTy &ExportList,
940 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
941 const GVSummaryMapTy &DefinedGlobals,
Teresa Johnson7fb39df2018-09-25 20:14:40 +0000942 MapVector<StringRef, BitcodeModule> &ModuleMap) {
Peter Collingbourne80186a52016-09-23 21:33:43 +0000943 auto RunThinBackend = [&](AddStreamFn AddStream) {
944 LTOLLVMContext BackendContext(Conf);
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000945 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
Peter Collingbourned9445c42016-11-13 07:00:17 +0000946 if (!MOrErr)
947 return MOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000948
Peter Collingbourne80186a52016-09-23 21:33:43 +0000949 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
950 ImportList, DefinedGlobals, ModuleMap);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000951 };
Peter Collingbourne80186a52016-09-23 21:33:43 +0000952
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000953 auto ModuleID = BM.getModuleIdentifier();
Mehdi Aminif82bda02016-10-08 04:44:23 +0000954
955 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) ||
956 all_of(CombinedIndex.getModuleHash(ModuleID),
957 [](uint32_t V) { return V == 0; }))
958 // Cache disabled or no entry for this module in the combined index or
959 // no module hash.
Peter Collingbourne80186a52016-09-23 21:33:43 +0000960 return RunThinBackend(AddStream);
961
962 SmallString<40> Key;
963 // The module may be cached, this helps handling it.
Peter Collingbournef4257522016-12-08 05:28:30 +0000964 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
Teresa Johnson7fb39df2018-09-25 20:14:40 +0000965 ResolvedODR, DefinedGlobals, CfiFunctionDefs,
966 CfiFunctionDecls);
Peter Collingbourne80186a52016-09-23 21:33:43 +0000967 if (AddStreamFn CacheAddStream = Cache(Task, Key))
968 return RunThinBackend(CacheAddStream);
969
Mehdi Amini41af4302016-11-11 04:28:40 +0000970 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000971 }
972
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000973 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000974 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000975 const FunctionImporter::ImportMapTy &ImportList,
976 const FunctionImporter::ExportSetTy &ExportList,
977 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000978 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
979 StringRef ModulePath = BM.getModuleIdentifier();
Mehdi Amini767e1452016-09-06 03:23:45 +0000980 assert(ModuleToDefinedGVSummaries.count(ModulePath));
981 const GVSummaryMapTy &DefinedGlobals =
982 ModuleToDefinedGVSummaries.find(ModulePath)->second;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000983 BackendThreadPool.async(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000984 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000985 const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000986 const FunctionImporter::ExportSetTy &ExportList,
987 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
988 &ResolvedODR,
Mehdi Amini767e1452016-09-06 03:23:45 +0000989 const GVSummaryMapTy &DefinedGlobals,
Teresa Johnson7fb39df2018-09-25 20:14:40 +0000990 MapVector<StringRef, BitcodeModule> &ModuleMap) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000991 Error E = runThinLTOBackendThread(
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000992 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
Teresa Johnson7fb39df2018-09-25 20:14:40 +0000993 ResolvedODR, DefinedGlobals, ModuleMap);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000994 if (E) {
995 std::unique_lock<std::mutex> L(ErrMu);
996 if (Err)
997 Err = joinErrors(std::move(*Err), std::move(E));
998 else
999 Err = std::move(E);
1000 }
1001 },
Peter Collingbourne780a4dd2017-03-10 21:35:17 +00001002 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
Teresa Johnson7fb39df2018-09-25 20:14:40 +00001003 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap));
Mehdi Amini41af4302016-11-11 04:28:40 +00001004 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001005 }
1006
1007 Error wait() override {
1008 BackendThreadPool.wait();
1009 if (Err)
1010 return std::move(*Err);
1011 else
Mehdi Amini41af4302016-11-11 04:28:40 +00001012 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001013 }
1014};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001015} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001016
1017ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
1018 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001019 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001020 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001021 return llvm::make_unique<InProcessThinBackend>(
1022 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001023 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001024 };
1025}
1026
Teresa Johnson3f212b82016-09-21 19:12:05 +00001027// Given the original \p Path to an output file, replace any path
1028// prefix matching \p OldPrefix with \p NewPrefix. Also, create the
1029// resulting directory if it does not yet exist.
1030std::string lto::getThinLTOOutputFile(const std::string &Path,
1031 const std::string &OldPrefix,
1032 const std::string &NewPrefix) {
1033 if (OldPrefix.empty() && NewPrefix.empty())
1034 return Path;
1035 SmallString<128> NewPath(Path);
1036 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix);
1037 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str());
1038 if (!ParentPath.empty()) {
1039 // Make sure the new directory exists, creating it if necessary.
1040 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath))
1041 llvm::errs() << "warning: could not create directory '" << ParentPath
1042 << "': " << EC.message() << '\n';
1043 }
1044 return NewPath.str();
1045}
1046
Benjamin Kramerffd37152016-11-19 20:44:26 +00001047namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001048class WriteIndexesThinBackend : public ThinBackendProc {
1049 std::string OldPrefix, NewPrefix;
1050 bool ShouldEmitImportsFiles;
Vitaly Bukaa139b692018-02-22 19:06:15 +00001051 raw_fd_ostream *LinkedObjectsFile;
Vitaly Buka59baf732018-01-30 21:19:26 +00001052 lto::IndexWriteCallback OnWrite;
1053
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001054public:
Mehdi Amini767e1452016-09-06 03:23:45 +00001055 WriteIndexesThinBackend(
1056 Config &Conf, ModuleSummaryIndex &CombinedIndex,
1057 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1058 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
Vitaly Bukaa139b692018-02-22 19:06:15 +00001059 raw_fd_ostream *LinkedObjectsFile, lto::IndexWriteCallback OnWrite)
Mehdi Amini18b91112016-08-19 06:10:03 +00001060 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001061 OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1062 ShouldEmitImportsFiles(ShouldEmitImportsFiles),
Vitaly Bukaa139b692018-02-22 19:06:15 +00001063 LinkedObjectsFile(LinkedObjectsFile), OnWrite(OnWrite) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001064
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001065 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001066 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001067 const FunctionImporter::ImportMapTy &ImportList,
1068 const FunctionImporter::ExportSetTy &ExportList,
1069 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001070 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1071 StringRef ModulePath = BM.getModuleIdentifier();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001072 std::string NewModulePath =
1073 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1074
Vitaly Bukaa139b692018-02-22 19:06:15 +00001075 if (LinkedObjectsFile)
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001076 *LinkedObjectsFile << NewModulePath << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001077
1078 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1079 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001080 ImportList, ModuleToSummariesForIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001081
Vitaly Bukaa139b692018-02-22 19:06:15 +00001082 std::error_code EC;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001083 raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC,
1084 sys::fs::OpenFlags::F_None);
1085 if (EC)
1086 return errorCodeToError(EC);
1087 WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex);
1088
Vitaly Buka59baf732018-01-30 21:19:26 +00001089 if (ShouldEmitImportsFiles) {
Teresa Johnsonc0320ef2018-07-10 20:06:04 +00001090 EC = EmitImportsFiles(ModulePath, NewModulePath + ".imports",
1091 ModuleToSummariesForIndex);
Vitaly Buka59baf732018-01-30 21:19:26 +00001092 if (EC)
1093 return errorCodeToError(EC);
1094 }
1095
1096 if (OnWrite)
1097 OnWrite(ModulePath);
Mehdi Amini41af4302016-11-11 04:28:40 +00001098 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001099 }
1100
Mehdi Amini41af4302016-11-11 04:28:40 +00001101 Error wait() override { return Error::success(); }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001102};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001103} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001104
Vitaly Bukaa139b692018-02-22 19:06:15 +00001105ThinBackend lto::createWriteIndexesThinBackend(
1106 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
1107 raw_fd_ostream *LinkedObjectsFile, IndexWriteCallback OnWrite) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001108 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001109 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001110 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001111 return llvm::make_unique<WriteIndexesThinBackend>(
Mehdi Amini18b91112016-08-19 06:10:03 +00001112 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
Vitaly Buka59baf732018-01-30 21:19:26 +00001113 ShouldEmitImportsFiles, LinkedObjectsFile, OnWrite);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001114 };
1115}
1116
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001117Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001118 if (ThinLTO.ModuleMap.empty())
Mehdi Amini41af4302016-11-11 04:28:40 +00001119 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001120
1121 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
Mehdi Amini41af4302016-11-11 04:28:40 +00001122 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001123
1124 // Collect for each module the list of function it defines (GUID ->
1125 // Summary).
Dehao Chen5d96ee42017-07-10 20:12:54 +00001126 StringMap<GVSummaryMapTy>
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001127 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1128 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1129 ModuleToDefinedGVSummaries);
Teresa Johnson620c1402016-09-20 23:07:17 +00001130 // Create entries for any modules that didn't have any GV summaries
1131 // (either they didn't have any GVs to start with, or we suppressed
1132 // generation of the summaries because they e.g. had inline assembly
1133 // uses that couldn't be promoted/renamed on export). This is so
1134 // InProcessThinBackend::start can still launch a backend thread, which
1135 // is passed the map of summaries for the module, without any special
1136 // handling for this case.
1137 for (auto &Mod : ThinLTO.ModuleMap)
1138 if (!ModuleToDefinedGVSummaries.count(Mod.first))
1139 ModuleToDefinedGVSummaries.try_emplace(Mod.first);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001140
1141 StringMap<FunctionImporter::ImportMapTy> ImportLists(
1142 ThinLTO.ModuleMap.size());
1143 StringMap<FunctionImporter::ExportSetTy> ExportLists(
1144 ThinLTO.ModuleMap.size());
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001145 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001146
Charles Saternosb040fcc2018-02-19 15:14:50 +00001147 if (DumpThinCGSCCs)
1148 ThinLTO.CombinedIndex.dumpSCCs(outs());
1149
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001150 if (Conf.OptLevel > 0)
Teresa Johnson002af9b2016-10-31 22:12:21 +00001151 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +00001152 ImportLists, ExportLists);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001153
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001154 // Figure out which symbols need to be internalized. This also needs to happen
1155 // at -O0 because summary-based DCE is implemented using internalization, and
1156 // we must apply DCE consistently with the full LTO module in order to avoid
1157 // undefined references during the final link.
1158 std::set<GlobalValue::GUID> ExportedGUIDs;
1159 for (auto &Res : GlobalResolutions) {
George Rimard3283652018-01-25 17:23:27 +00001160 // If the symbol does not have external references or it is not prevailing,
1161 // then not need to mark it as exported from a ThinLTO partition.
1162 if (Res.second.Partition != GlobalResolution::External ||
George Rimareaf51722018-01-29 08:03:30 +00001163 !Res.second.isPrevailingIRSymbol())
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001164 continue;
1165 auto GUID = GlobalValue::getGUID(
1166 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
1167 // Mark exported unless index-based analysis determined it to be dead.
1168 if (ThinLTO.CombinedIndex.isGUIDLive(GUID))
1169 ExportedGUIDs.insert(GUID);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001170 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001171
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001172 // Any functions referenced by the jump table in the regular LTO object must
1173 // be exported.
1174 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs())
1175 ExportedGUIDs.insert(
1176 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def)));
1177
1178 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) {
1179 const auto &ExportList = ExportLists.find(ModuleIdentifier);
1180 return (ExportList != ExportLists.end() &&
1181 ExportList->second.count(GUID)) ||
1182 ExportedGUIDs.count(GUID);
1183 };
1184 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported);
1185
Peter Collingbournef87197a2017-05-25 23:40:11 +00001186 auto isPrevailing = [&](GlobalValue::GUID GUID,
1187 const GlobalValueSummary *S) {
1188 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath();
1189 };
1190 auto recordNewLinkage = [&](StringRef ModuleIdentifier,
1191 GlobalValue::GUID GUID,
1192 GlobalValue::LinkageTypes NewLinkage) {
1193 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage;
1194 };
1195 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing,
1196 recordNewLinkage);
1197
Peter Collingbourne80186a52016-09-23 21:33:43 +00001198 std::unique_ptr<ThinBackendProc> BackendProc =
1199 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1200 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001201
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001202 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined
1203 // module and parallel code generation partitions.
1204 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001205 for (auto &Mod : ThinLTO.ModuleMap) {
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001206 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001207 ExportLists[Mod.first],
1208 ResolvedODR[Mod.first], ThinLTO.ModuleMap))
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001209 return E;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001210 ++Task;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001211 }
1212
1213 return BackendProc->wait();
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001214}
Davide Italiano690ed9d2017-02-10 23:49:38 +00001215
Bob Haarmanfb2d3422018-03-08 01:13:10 +00001216Expected<std::unique_ptr<ToolOutputFile>>
1217lto::setupOptimizationRemarks(LLVMContext &Context,
1218 StringRef LTORemarksFilename,
1219 bool LTOPassRemarksWithHotness, int Count) {
Teresa Johnsonb77ab092018-05-04 23:59:34 +00001220 if (LTOPassRemarksWithHotness)
1221 Context.setDiagnosticsHotnessRequested(true);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001222 if (LTORemarksFilename.empty())
1223 return nullptr;
1224
1225 std::string Filename = LTORemarksFilename;
1226 if (Count != -1)
1227 Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1228
1229 std::error_code EC;
1230 auto DiagnosticFile =
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001231 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001232 if (EC)
1233 return errorCodeToError(EC);
1234 Context.setDiagnosticsOutputFile(
1235 llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
Davide Italiano690ed9d2017-02-10 23:49:38 +00001236 DiagnosticFile->keep();
1237 return std::move(DiagnosticFile);
1238}