blob: 1047b8ddeb42a0539252ab5a62a4f15ddb21bed8 [file] [log] [blame]
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001//===-LTO.cpp - LLVM Link Time Optimizer ----------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements functions and classes used to support LTO.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/LTO/LTO.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000015#include "llvm/Analysis/TargetLibraryInfo.h"
16#include "llvm/Analysis/TargetTransformInfo.h"
Teresa Johnsonad176792016-11-11 05:34:58 +000017#include "llvm/Bitcode/BitcodeReader.h"
18#include "llvm/Bitcode/BitcodeWriter.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000019#include "llvm/CodeGen/Analysis.h"
20#include "llvm/IR/AutoUpgrade.h"
21#include "llvm/IR/DiagnosticPrinter.h"
22#include "llvm/IR/LegacyPassManager.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000023#include "llvm/IR/Mangler.h"
24#include "llvm/IR/Metadata.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000025#include "llvm/LTO/LTOBackend.h"
26#include "llvm/Linker/IRMover.h"
Peter Collingbourne192d8522017-03-28 23:35:34 +000027#include "llvm/Object/IRObjectFile.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000028#include "llvm/Support/Error.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000029#include "llvm/Support/ManagedStatic.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000030#include "llvm/Support/MemoryBuffer.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000031#include "llvm/Support/Path.h"
Mehdi Aminiadc0e262016-08-23 21:30:12 +000032#include "llvm/Support/SHA1.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000033#include "llvm/Support/SourceMgr.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000034#include "llvm/Support/TargetRegistry.h"
35#include "llvm/Support/ThreadPool.h"
Teresa Johnsonec544c52016-10-19 17:35:01 +000036#include "llvm/Support/Threading.h"
Peter Collingbourne942fa562017-04-13 01:26:12 +000037#include "llvm/Support/VCSRevision.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000038#include "llvm/Support/raw_ostream.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000039#include "llvm/Target/TargetMachine.h"
40#include "llvm/Target/TargetOptions.h"
41#include "llvm/Transforms/IPO.h"
42#include "llvm/Transforms/IPO/PassManagerBuilder.h"
43#include "llvm/Transforms/Utils/SplitModule.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000044
Teresa Johnson9ba95f92016-08-11 14:58:12 +000045#include <set>
46
47using namespace llvm;
48using namespace lto;
49using namespace object;
Teresa Johnsondf6edc52016-05-23 22:54:06 +000050
Mehdi Aminiadc0e262016-08-23 21:30:12 +000051#define DEBUG_TYPE "lto"
52
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000053// The values are (type identifier, summary) pairs.
54typedef DenseMap<
55 GlobalValue::GUID,
56 TinyPtrVector<const std::pair<const std::string, TypeIdSummary> *>>
57 TypeIdSummariesByGuidTy;
58
Mehdi Aminiadc0e262016-08-23 21:30:12 +000059// Returns a unique hash for the Module considering the current list of
60// export/import and other global analysis results.
61// The hash is produced in \p Key.
62static void computeCacheKey(
Peter Collingbournef4257522016-12-08 05:28:30 +000063 SmallString<40> &Key, const Config &Conf, const ModuleSummaryIndex &Index,
64 StringRef ModuleID, const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +000065 const FunctionImporter::ExportSetTy &ExportList,
66 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000067 const GVSummaryMapTy &DefinedGlobals,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +000068 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid,
69 const std::set<GlobalValue::GUID> &CfiFunctionDefs,
70 const std::set<GlobalValue::GUID> &CfiFunctionDecls) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +000071 // Compute the unique hash for this entry.
72 // This is based on the current compiler version, the module itself, the
73 // export list, the hash for every single module in the import list, the
74 // list of ResolvedODR for the module, and the list of preserved symbols.
75 SHA1 Hasher;
76
77 // Start with the compiler revision
78 Hasher.update(LLVM_VERSION_STRING);
Peter Collingbourne942fa562017-04-13 01:26:12 +000079#ifdef LLVM_REVISION
Mehdi Aminiadc0e262016-08-23 21:30:12 +000080 Hasher.update(LLVM_REVISION);
81#endif
82
Peter Collingbournef4257522016-12-08 05:28:30 +000083 // Include the parts of the LTO configuration that affect code generation.
84 auto AddString = [&](StringRef Str) {
85 Hasher.update(Str);
86 Hasher.update(ArrayRef<uint8_t>{0});
87 };
88 auto AddUnsigned = [&](unsigned I) {
89 uint8_t Data[4];
90 Data[0] = I;
91 Data[1] = I >> 8;
92 Data[2] = I >> 16;
93 Data[3] = I >> 24;
94 Hasher.update(ArrayRef<uint8_t>{Data, 4});
95 };
Peter Collingbourne54a52b72017-03-03 20:25:30 +000096 auto AddUint64 = [&](uint64_t I) {
97 uint8_t Data[8];
98 Data[0] = I;
99 Data[1] = I >> 8;
100 Data[2] = I >> 16;
101 Data[3] = I >> 24;
102 Data[4] = I >> 32;
103 Data[5] = I >> 40;
104 Data[6] = I >> 48;
105 Data[7] = I >> 56;
106 Hasher.update(ArrayRef<uint8_t>{Data, 8});
107 };
Peter Collingbournef4257522016-12-08 05:28:30 +0000108 AddString(Conf.CPU);
109 // FIXME: Hash more of Options. For now all clients initialize Options from
110 // command-line flags (which is unsupported in production), but may set
111 // RelaxELFRelocations. The clang driver can also pass FunctionSections,
112 // DataSections and DebuggerTuning via command line flags.
113 AddUnsigned(Conf.Options.RelaxELFRelocations);
114 AddUnsigned(Conf.Options.FunctionSections);
115 AddUnsigned(Conf.Options.DataSections);
116 AddUnsigned((unsigned)Conf.Options.DebuggerTuning);
117 for (auto &A : Conf.MAttrs)
118 AddString(A);
Evgeniy Stepanovb9f1b012017-05-22 21:11:35 +0000119 if (Conf.RelocModel)
120 AddUnsigned(*Conf.RelocModel);
121 else
122 AddUnsigned(-1);
Rafael Espindola79e238a2017-08-03 02:16:21 +0000123 if (Conf.CodeModel)
124 AddUnsigned(*Conf.CodeModel);
125 else
126 AddUnsigned(-1);
Peter Collingbournef4257522016-12-08 05:28:30 +0000127 AddUnsigned(Conf.CGOptLevel);
Tobias Edler von Kochf454b9e2017-02-15 20:36:36 +0000128 AddUnsigned(Conf.CGFileType);
Peter Collingbournef4257522016-12-08 05:28:30 +0000129 AddUnsigned(Conf.OptLevel);
Tim Shen4e912aa2017-06-01 23:13:44 +0000130 AddUnsigned(Conf.UseNewPM);
Peter Collingbournef4257522016-12-08 05:28:30 +0000131 AddString(Conf.OptPipeline);
132 AddString(Conf.AAPipeline);
133 AddString(Conf.OverrideTriple);
134 AddString(Conf.DefaultTriple);
135
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000136 // Include the hash for the current module
137 auto ModHash = Index.getModuleHash(ModuleID);
138 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
139 for (auto F : ExportList)
140 // The export list can impact the internalization, be conservative here
141 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&F, sizeof(F)));
142
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000143 // Include the hash for every module we import functions from. The set of
144 // imported symbols for each module may affect code generation and is
145 // sensitive to link order, so include that as well.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000146 for (auto &Entry : ImportList) {
147 auto ModHash = Index.getModuleHash(Entry.first());
148 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000149
150 AddUint64(Entry.second.size());
151 for (auto &Fn : Entry.second)
152 AddUint64(Fn.first);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000153 }
154
155 // Include the hash for the resolved ODR.
156 for (auto &Entry : ResolvedODR) {
157 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.first,
158 sizeof(GlobalValue::GUID)));
159 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.second,
160 sizeof(GlobalValue::LinkageTypes)));
161 }
162
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000163 // Members of CfiFunctionDefs and CfiFunctionDecls that are referenced or
164 // defined in this module.
165 std::set<GlobalValue::GUID> UsedCfiDefs;
166 std::set<GlobalValue::GUID> UsedCfiDecls;
167
168 // Typeids used in this module.
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000169 std::set<GlobalValue::GUID> UsedTypeIds;
170
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000171 auto AddUsedCfiGlobal = [&](GlobalValue::GUID ValueGUID) {
172 if (CfiFunctionDefs.count(ValueGUID))
173 UsedCfiDefs.insert(ValueGUID);
174 if (CfiFunctionDecls.count(ValueGUID))
175 UsedCfiDecls.insert(ValueGUID);
176 };
177
178 auto AddUsedThings = [&](GlobalValueSummary *GS) {
179 if (!GS) return;
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)
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000217 AddUsedThings(Index.findSummaryInModule(ImpF.first, 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) {
251 auto SummariesI = TypeIdSummariesByGuid.find(TId);
252 if (SummariesI != TypeIdSummariesByGuid.end())
253 for (auto *Summary : SummariesI->second)
254 AddTypeIdSummary(Summary->first, Summary->second);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000255 }
256
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000257 AddUnsigned(UsedCfiDefs.size());
258 for (auto &V : UsedCfiDefs)
259 AddUint64(V);
260
261 AddUnsigned(UsedCfiDecls.size());
262 for (auto &V : UsedCfiDecls)
263 AddUint64(V);
264
Dehao Chen27978002016-12-16 16:48:46 +0000265 if (!Conf.SampleProfile.empty()) {
266 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile);
267 if (FileOrErr)
268 Hasher.update(FileOrErr.get()->getBuffer());
269 }
270
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000271 Key = toHex(Hasher.result());
272}
273
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000274static void thinLTOResolveWeakForLinkerGUID(
275 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
276 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000277 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000278 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000279 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000280 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000281 for (auto &S : GVSummaryList) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000282 GlobalValue::LinkageTypes OriginalLinkage = S->linkage();
283 if (!GlobalValue::isWeakForLinker(OriginalLinkage))
284 continue;
Peter Collingbourne73589f32016-07-07 18:31:51 +0000285 // We need to emit only one of these. The prevailing module will keep it,
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000286 // but turned into a weak, while the others will drop it when possible.
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000287 // This is both a compile-time optimization and a correctness
288 // transformation. This is necessary for correctness when we have exported
289 // a reference - we need to convert the linkonce to weak to
290 // ensure a copy is kept to satisfy the exported reference.
291 // FIXME: We may want to split the compile time and correctness
292 // aspects into separate routines.
Peter Collingbourne73589f32016-07-07 18:31:51 +0000293 if (isPrevailing(GUID, S.get())) {
Teresa Johnson28c03b52016-05-26 14:16:52 +0000294 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
295 S->setLinkage(GlobalValue::getWeakLinkage(
296 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000297 }
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000298 // Alias and aliasee can't be turned into available_externally.
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000299 else if (!isa<AliasSummary>(S.get()) &&
Teresa Johnson4566c6d2017-01-20 21:54:58 +0000300 !GlobalInvolvedWithAlias.count(S.get()))
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000301 S->setLinkage(GlobalValue::AvailableExternallyLinkage);
302 if (S->linkage() != OriginalLinkage)
303 recordNewLinkage(S->modulePath(), GUID, S->linkage());
304 }
305}
306
307// Resolve Weak and LinkOnce values in the \p Index.
308//
309// We'd like to drop these functions if they are no longer referenced in the
310// current module. However there is a chance that another module is still
311// referencing them because of the import. We make sure we always emit at least
312// one copy.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000313void llvm::thinLTOResolveWeakForLinkerInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000314 ModuleSummaryIndex &Index,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000315 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000316 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000317 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000318 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000319 // We won't optimize the globals that are referenced by an alias for now
320 // Ideally we should turn the alias into a global and duplicate the definition
321 // when needed.
322 DenseSet<GlobalValueSummary *> GlobalInvolvedWithAlias;
323 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000324 for (auto &S : I.second.SummaryList)
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000325 if (auto AS = dyn_cast<AliasSummary>(S.get()))
326 GlobalInvolvedWithAlias.insert(&AS->getAliasee());
327
328 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000329 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first,
330 GlobalInvolvedWithAlias, isPrevailing,
331 recordNewLinkage);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000332}
333
334static void thinLTOInternalizeAndPromoteGUID(
335 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000336 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000337 for (auto &S : GVSummaryList) {
Mehdi Amini1380edf2017-02-03 07:41:43 +0000338 if (isExported(S->modulePath(), GUID)) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000339 if (GlobalValue::isLocalLinkage(S->linkage()))
340 S->setLinkage(GlobalValue::ExternalLinkage);
341 } else if (!GlobalValue::isLocalLinkage(S->linkage()))
342 S->setLinkage(GlobalValue::InternalLinkage);
343 }
344}
345
346// Update the linkages in the given \p Index to mark exported values
347// as external and non-exported values as internal.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000348void llvm::thinLTOInternalizeAndPromoteInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000349 ModuleSummaryIndex &Index,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000350 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000351 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000352 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000353}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000354
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000355// Requires a destructor for std::vector<InputModule>.
356InputFile::~InputFile() = default;
357
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000358Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) {
359 std::unique_ptr<InputFile> File(new InputFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000360
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000361 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object);
362 if (!FOrErr)
363 return FOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000364
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000365 File->TargetTriple = FOrErr->TheReader.getTargetTriple();
366 File->SourceFileName = FOrErr->TheReader.getSourceFileName();
367 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts();
368 File->ComdatTable = FOrErr->TheReader.getComdatTable();
Peter Collingbournead903692016-12-13 19:43:49 +0000369
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000370 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000371 size_t Begin = File->Symbols.size();
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000372 for (const irsymtab::Reader::SymbolRef &Sym :
373 FOrErr->TheReader.module_symbols(I))
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000374 // Skip symbols that are irrelevant to LTO. Note that this condition needs
375 // to match the one in Skip() in LTO::addRegularLTO().
376 if (Sym.isGlobal() && !Sym.isFormatSpecific())
377 File->Symbols.push_back(Sym);
378 File->ModuleSymIndices.push_back({Begin, File->Symbols.size()});
Rafael Espindola79121102016-10-25 12:02:03 +0000379 }
380
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000381 File->Mods = FOrErr->Mods;
382 File->Strtab = std::move(FOrErr->Strtab);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000383 return std::move(File);
384}
385
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000386StringRef InputFile::getName() const {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000387 return Mods[0].getModuleIdentifier();
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000388}
389
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000390LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel,
391 Config &Conf)
392 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel),
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000393 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)),
394 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000395
Eugene Leviant28d8a492018-01-22 13:35:40 +0000396LTO::ThinLTOState::ThinLTOState(ThinBackend Backend)
397 : Backend(Backend), CombinedIndex(/*IsPeformingAnalysis*/ false) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000398 if (!Backend)
Teresa Johnsonec544c52016-10-19 17:35:01 +0000399 this->Backend =
400 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency());
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000401}
402
403LTO::LTO(Config Conf, ThinBackend Backend,
404 unsigned ParallelCodeGenParallelismLevel)
405 : Conf(std::move(Conf)),
406 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf),
Mehdi Amini026ddbb2016-08-19 05:56:37 +0000407 ThinLTO(std::move(Backend)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000408
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000409// Requires a destructor for MapVector<BitcodeModule>.
410LTO::~LTO() = default;
411
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000412// Add the symbols in the given module to the GlobalResolutions map, and resolve
413// their partitions.
414void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms,
415 ArrayRef<SymbolResolution> Res,
416 unsigned Partition, bool InSummary) {
417 auto *ResI = Res.begin();
418 auto *ResE = Res.end();
Peter Collingbourne7e85b262017-06-15 17:41:32 +0000419 (void)ResE;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000420 for (const InputFile::Symbol &Sym : Syms) {
421 assert(ResI != ResE);
422 SymbolResolution Res = *ResI++;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000423
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000424 auto &GlobalRes = GlobalResolutions[Sym.getName()];
425 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr();
Eugene Leviant746f1522017-12-15 09:18:21 +0000426 if (Res.Prevailing) {
George Rimard3283652018-01-25 17:23:27 +0000427 assert(!GlobalRes.Prevailing &&
Eugene Leviantcb122492017-12-15 16:27:33 +0000428 "Multiple prevailing defs are not allowed");
George Rimard3283652018-01-25 17:23:27 +0000429 GlobalRes.Prevailing = true;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000430 GlobalRes.IRName = Sym.getIRName();
George Rimareaf51722018-01-29 08:03:30 +0000431 } else if (!GlobalRes.Prevailing && GlobalRes.IRName.empty()) {
432 // Sometimes it can be two copies of symbol in a module and prevailing
433 // symbol can have no IR name. That might happen if symbol is defined in
434 // module level inline asm block. In case we have multiple modules with
435 // the same symbol we want to use IR name of the prevailing symbol.
436 // Otherwise, if we haven't seen a prevailing symbol, set the name so that
437 // we can later use it to check if there is any prevailing copy in IR.
438 GlobalRes.IRName = Sym.getIRName();
Eugene Leviant746f1522017-12-15 09:18:21 +0000439 }
Teresa Johnson6c475a72017-01-05 21:34:18 +0000440
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000441 // Set the partition to external if we know it is re-defined by the linker
442 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a
443 // regular object, is referenced from llvm.compiler_used, or was already
444 // recorded as being referenced from a different partition.
445 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() ||
446 (GlobalRes.Partition != GlobalResolution::Unknown &&
447 GlobalRes.Partition != Partition)) {
448 GlobalRes.Partition = GlobalResolution::External;
449 } else
450 // First recorded reference, save the current partition.
451 GlobalRes.Partition = Partition;
452
453 // Flag as visible outside of summary if visible from a regular object or
454 // from a module that does not have a summary.
455 GlobalRes.VisibleOutsideSummary |=
456 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary);
457 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000458}
459
Rafael Espindola7775c332016-08-26 20:19:35 +0000460static void writeToResolutionFile(raw_ostream &OS, InputFile *Input,
461 ArrayRef<SymbolResolution> Res) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000462 StringRef Path = Input->getName();
Rafael Espindola7775c332016-08-26 20:19:35 +0000463 OS << Path << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000464 auto ResI = Res.begin();
465 for (const InputFile::Symbol &Sym : Input->symbols()) {
466 assert(ResI != Res.end());
467 SymbolResolution Res = *ResI++;
468
Rafael Espindola7775c332016-08-26 20:19:35 +0000469 OS << "-r=" << Path << ',' << Sym.getName() << ',';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000470 if (Res.Prevailing)
Rafael Espindola7775c332016-08-26 20:19:35 +0000471 OS << 'p';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000472 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola7775c332016-08-26 20:19:35 +0000473 OS << 'l';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000474 if (Res.VisibleToRegularObj)
Rafael Espindola7775c332016-08-26 20:19:35 +0000475 OS << 'x';
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000476 if (Res.LinkerRedefined)
477 OS << 'r';
Rafael Espindola7775c332016-08-26 20:19:35 +0000478 OS << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000479 }
Peter Collingbourne58ffcfb2017-01-19 23:10:14 +0000480 OS.flush();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000481 assert(ResI == Res.end());
482}
483
484Error LTO::add(std::unique_ptr<InputFile> Input,
485 ArrayRef<SymbolResolution> Res) {
486 assert(!CalledGetMaxTasks);
487
488 if (Conf.ResolutionFile)
Rafael Espindola7775c332016-08-26 20:19:35 +0000489 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000490
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000491 if (RegularLTO.CombinedModule->getTargetTriple().empty())
492 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple());
493
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000494 const SymbolResolution *ResI = Res.begin();
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000495 for (unsigned I = 0; I != Input->Mods.size(); ++I)
496 if (Error Err = addModule(*Input, I, ResI, Res.end()))
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000497 return Err;
498
499 assert(ResI == Res.end());
500 return Error::success();
501}
502
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000503Error LTO::addModule(InputFile &Input, unsigned ModI,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000504 const SymbolResolution *&ResI,
505 const SymbolResolution *ResE) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000506 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo();
507 if (!LTOInfo)
508 return LTOInfo.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000509
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000510 BitcodeModule BM = Input.Mods[ModI];
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000511 auto ModSyms = Input.module_symbols(ModI);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000512 addModuleToGlobalRes(ModSyms, {ResI, ResE},
513 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0,
514 LTOInfo->HasSummary);
515
516 if (LTOInfo->IsThinLTO)
517 return addThinLTO(BM, ModSyms, ResI, ResE);
518
519 Expected<RegularLTOState::AddedModule> ModOrErr =
520 addRegularLTO(BM, ModSyms, ResI, ResE);
521 if (!ModOrErr)
522 return ModOrErr.takeError();
523
524 if (!LTOInfo->HasSummary)
525 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false);
526
527 // Regular LTO module summaries are added to a dummy module that represents
528 // the combined regular LTO module.
529 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull))
530 return Err;
531 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr));
532 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000533}
534
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000535// Checks whether the given global value is in a non-prevailing comdat
536// (comdat containing values the linker indicated were not prevailing,
537// which we then dropped to available_externally), and if so, removes
538// it from the comdat. This is called for all global values to ensure the
539// comdat is empty rather than leaving an incomplete comdat. It is needed for
540// regular LTO modules, in case we are in a mixed-LTO mode (both regular
541// and thin LTO modules) compilation. Since the regular LTO module will be
542// linked first in the final native link, we want to make sure the linker
543// doesn't select any of these incomplete comdats that would be left
544// in the regular LTO module without this cleanup.
545static void
546handleNonPrevailingComdat(GlobalValue &GV,
547 std::set<const Comdat *> &NonPrevailingComdats) {
548 Comdat *C = GV.getComdat();
549 if (!C)
550 return;
551
552 if (!NonPrevailingComdats.count(C))
553 return;
554
555 // Additionally need to drop externally visible global values from the comdat
556 // to available_externally, so that there aren't multiply defined linker
557 // errors.
558 if (!GV.hasLocalLinkage())
559 GV.setLinkage(GlobalValue::AvailableExternallyLinkage);
560
561 if (auto GO = dyn_cast<GlobalObject>(&GV))
562 GO->setComdat(nullptr);
563}
564
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000565// Add a regular LTO object to the link.
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000566// The resulting module needs to be linked into the combined LTO module with
567// linkRegularLTO.
568Expected<LTO::RegularLTOState::AddedModule>
569LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
570 const SymbolResolution *&ResI,
571 const SymbolResolution *ResE) {
572 RegularLTOState::AddedModule Mod;
Peter Collingbournead903692016-12-13 19:43:49 +0000573 Expected<std::unique_ptr<Module>> MOrErr =
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000574 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true,
575 /*IsImporting*/ false);
Peter Collingbournead903692016-12-13 19:43:49 +0000576 if (!MOrErr)
577 return MOrErr.takeError();
Peter Collingbournead903692016-12-13 19:43:49 +0000578 Module &M = **MOrErr;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000579 Mod.M = std::move(*MOrErr);
580
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000581 if (Error Err = M.materializeMetadata())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000582 return std::move(Err);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000583 UpgradeDebugInfo(M);
584
Peter Collingbournead903692016-12-13 19:43:49 +0000585 ModuleSymbolTable SymTab;
586 SymTab.addModule(&M);
587
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000588 for (GlobalVariable &GV : M.globals())
589 if (GV.hasAppendingLinkage())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000590 Mod.Keep.push_back(&GV);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000591
Peter Collingbourne46136262017-02-02 05:22:42 +0000592 DenseSet<GlobalObject *> AliasedGlobals;
593 for (auto &GA : M.aliases())
594 if (GlobalObject *GO = GA.getBaseObject())
595 AliasedGlobals.insert(GO);
596
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000597 // In this function we need IR GlobalValues matching the symbols in Syms
598 // (which is not backed by a module), so we need to enumerate them in the same
599 // order. The symbol enumeration order of a ModuleSymbolTable intentionally
600 // matches the order of an irsymtab, but when we read the irsymtab in
601 // InputFile::create we omit some symbols that are irrelevant to LTO. The
602 // Skip() function skips the same symbols from the module as InputFile does
603 // from the symbol table.
604 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end();
605 auto Skip = [&]() {
606 while (MsymI != MsymE) {
607 auto Flags = SymTab.getSymbolFlags(*MsymI);
608 if ((Flags & object::BasicSymbolRef::SF_Global) &&
609 !(Flags & object::BasicSymbolRef::SF_FormatSpecific))
610 return;
611 ++MsymI;
612 }
613 };
614 Skip();
615
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000616 std::set<const Comdat *> NonPrevailingComdats;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000617 for (const InputFile::Symbol &Sym : Syms) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000618 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000619 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000620
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000621 assert(MsymI != MsymE);
622 ModuleSymbolTable::Symbol Msym = *MsymI++;
623 Skip();
624
625 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) {
Peter Collingbournec387e702017-02-02 05:12:15 +0000626 if (Res.Prevailing) {
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000627 if (Sym.isUndefined())
Peter Collingbournec387e702017-02-02 05:12:15 +0000628 continue;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000629 Mod.Keep.push_back(GV);
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000630 // For symbols re-defined with linker -wrap and -defsym options,
631 // set the linkage to weak to inhibit IPO. The linkage will be
632 // restored by the linker.
633 if (Res.LinkerRedefined)
634 GV->setLinkage(GlobalValue::WeakAnyLinkage);
635
Davide Italianod4db1162017-05-26 21:56:14 +0000636 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage();
637 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
638 GV->setLinkage(GlobalValue::getWeakLinkage(
639 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Peter Collingbourne46136262017-02-02 05:22:42 +0000640 } else if (isa<GlobalObject>(GV) &&
641 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() ||
642 GV->hasAvailableExternallyLinkage()) &&
643 !AliasedGlobals.count(cast<GlobalObject>(GV))) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000644 // Any of the above three types of linkage indicates that the
Peter Collingbourne46136262017-02-02 05:22:42 +0000645 // chosen prevailing symbol will have the same semantics as this copy of
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000646 // the symbol, so we may be able to link it with available_externally
647 // linkage. We will decide later whether to do that when we link this
648 // module (in linkRegularLTO), based on whether it is undefined.
649 Mod.Keep.push_back(GV);
650 GV->setLinkage(GlobalValue::AvailableExternallyLinkage);
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000651 if (GV->hasComdat())
652 NonPrevailingComdats.insert(GV->getComdat());
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000653 cast<GlobalObject>(GV)->setComdat(nullptr);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000654 }
Sean Fertile4595a912017-11-04 17:04:39 +0000655
656 // Set the 'local' flag based on the linker resolution for this symbol.
Rafael Espindola8a1ca672018-01-18 05:38:43 +0000657 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola349fe0a2018-01-24 19:11:24 +0000658 GV->setDSOLocal(true);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000659 }
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000660 // Common resolution: collect the maximum size/alignment over all commons.
661 // We also record if we see an instance of a common as prevailing, so that
662 // if none is prevailing we can ignore it later.
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000663 if (Sym.isCommon()) {
Peter Collingbournefb8c2a42016-12-01 02:51:12 +0000664 // FIXME: We should figure out what to do about commons defined by asm.
665 // For now they aren't reported correctly by ModuleSymbolTable.
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000666 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000667 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
668 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000669 CommonRes.Prevailing |= Res.Prevailing;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000670 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000671
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000672 }
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000673 if (!M.getComdatSymbolTable().empty())
674 for (GlobalValue &GV : M.global_values())
675 handleNonPrevailingComdat(GV, NonPrevailingComdats);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000676 assert(MsymI == MsymE);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000677 return std::move(Mod);
678}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000679
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000680Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
681 bool LivenessFromIndex) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000682 std::vector<GlobalValue *> Keep;
683 for (GlobalValue *GV : Mod.Keep) {
684 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
685 continue;
686
687 if (!GV->hasAvailableExternallyLinkage()) {
688 Keep.push_back(GV);
689 continue;
690 }
691
692 // Only link available_externally definitions if we don't already have a
693 // definition.
694 GlobalValue *CombinedGV =
695 RegularLTO.CombinedModule->getNamedValue(GV->getName());
696 if (CombinedGV && !CombinedGV->isDeclaration())
697 continue;
698
699 Keep.push_back(GV);
700 }
701
702 return RegularLTO.Mover->move(std::move(Mod.M), Keep,
Teresa Johnson4b9b3792016-10-12 18:39:29 +0000703 [](GlobalValue &, IRMover::ValueAdder) {},
Teresa Johnson040cc162016-12-12 16:09:30 +0000704 /* IsPerformingImport */ false);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000705}
706
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000707// Add a ThinLTO module to the link.
708Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000709 const SymbolResolution *&ResI,
710 const SymbolResolution *ResE) {
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000711 if (Error Err =
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000712 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
713 ThinLTO.ModuleMap.size()))
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000714 return Err;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000715
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000716 for (const InputFile::Symbol &Sym : Syms) {
717 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000718 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000719
Sean Fertile4595a912017-11-04 17:04:39 +0000720 if (!Sym.getIRName().empty()) {
721 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
722 Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
723 if (Res.Prevailing) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000724 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
Davide Italiano6a5fbe52017-07-06 19:58:26 +0000725
726 // For linker redefined symbols (via --wrap or --defsym) we want to
727 // switch the linkage to `weak` to prevent IPOs from happening.
728 // Find the summary in the module for this very GV and record the new
729 // linkage so that we can switch it when we import the GV.
730 if (Res.LinkerRedefined)
731 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
732 GUID, BM.getModuleIdentifier()))
733 S->setLinkage(GlobalValue::WeakAnyLinkage);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000734 }
Sean Fertile4595a912017-11-04 17:04:39 +0000735
736 // If the linker resolved the symbol to a local definition then mark it
737 // as local in the summary for the module we are adding.
738 if (Res.FinalDefinitionInLinkageUnit) {
739 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
740 GUID, BM.getModuleIdentifier())) {
741 S->setDSOLocal(true);
742 }
743 }
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000744 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000745 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000746
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000747 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second)
748 return make_error<StringError>(
749 "Expected at most one ThinLTO module per bitcode file",
750 inconvertibleErrorCode());
751
Mehdi Amini41af4302016-11-11 04:28:40 +0000752 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000753}
754
Teresa Johnsonfaa75062016-08-11 20:38:39 +0000755unsigned LTO::getMaxTasks() const {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000756 CalledGetMaxTasks = true;
757 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
758}
759
Peter Collingbourne80186a52016-09-23 21:33:43 +0000760Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000761 // Compute "dead" symbols, we don't want to import/export these!
762 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
George Rimareaf51722018-01-29 08:03:30 +0000763 DenseMap<GlobalValue::GUID, PrevailingType> GUIDPrevailingResolutions;
764 for (auto &Res : GlobalResolutions) {
765 // Normally resolution have IR name of symbol. We can do nothing here
766 // otherwise. See comments in GlobalResolution struct for more details.
767 if (Res.second.IRName.empty())
768 continue;
769
770 GlobalValue::GUID GUID = GlobalValue::getGUID(
771 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
772
George Rimard3283652018-01-25 17:23:27 +0000773 if (Res.second.VisibleOutsideSummary && Res.second.Prevailing)
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000774 GUIDPreservedSymbols.insert(GlobalValue::getGUID(
775 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000776
George Rimareaf51722018-01-29 08:03:30 +0000777 GUIDPrevailingResolutions[GUID] =
778 Res.second.Prevailing ? PrevailingType::Yes : PrevailingType::No;
779 }
780
781 auto isPrevailing = [&](GlobalValue::GUID G) {
782 auto It = GUIDPrevailingResolutions.find(G);
783 if (It == GUIDPrevailingResolutions.end())
784 return PrevailingType::Unknown;
785 return It->second;
786 };
787 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols, isPrevailing);
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000788
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000789 if (auto E = runRegularLTO(AddStream))
790 return E;
791 return runThinLTO(AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000792}
793
Peter Collingbourne80186a52016-09-23 21:33:43 +0000794Error LTO::runRegularLTO(AddStreamFn AddStream) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000795 for (auto &M : RegularLTO.ModsWithSummaries)
796 if (Error Err = linkRegularLTO(std::move(M),
797 /*LivenessFromIndex=*/true))
798 return Err;
799
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000800 // Make sure commons have the right size/alignment: we kept the largest from
801 // all the prevailing when adding the inputs, and we apply it here.
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000802 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000803 for (auto &I : RegularLTO.Commons) {
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000804 if (!I.second.Prevailing)
805 // Don't do anything if no instance of this common was prevailing.
806 continue;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000807 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000808 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000809 // Don't create a new global if the type is already correct, just make
810 // sure the alignment is correct.
811 OldGV->setAlignment(I.second.Align);
812 continue;
813 }
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000814 ArrayType *Ty =
815 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000816 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false,
817 GlobalValue::CommonLinkage,
818 ConstantAggregateZero::get(Ty), "");
819 GV->setAlignment(I.second.Align);
820 if (OldGV) {
821 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType()));
822 GV->takeName(OldGV);
823 OldGV->eraseFromParent();
824 } else {
825 GV->setName(I.first);
826 }
827 }
828
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000829 if (Conf.PreOptModuleHook &&
830 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000831 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000832
Mehdi Aminid310b472016-08-22 06:25:41 +0000833 if (!Conf.CodeGenOnly) {
834 for (const auto &R : GlobalResolutions) {
George Rimareaf51722018-01-29 08:03:30 +0000835 if (!R.second.isPrevailingIRSymbol())
Mehdi Aminid310b472016-08-22 06:25:41 +0000836 continue;
837 if (R.second.Partition != 0 &&
838 R.second.Partition != GlobalResolution::External)
839 continue;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000840
Mehdi Aminid310b472016-08-22 06:25:41 +0000841 GlobalValue *GV =
842 RegularLTO.CombinedModule->getNamedValue(R.second.IRName);
843 // Ignore symbols defined in other partitions.
844 if (!GV || GV->hasLocalLinkage())
845 continue;
846 GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global
847 : GlobalValue::UnnamedAddr::None);
848 if (R.second.Partition == 0)
849 GV->setLinkage(GlobalValue::InternalLinkage);
850 }
851
852 if (Conf.PostInternalizeModuleHook &&
853 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000854 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000855 }
Peter Collingbourne80186a52016-09-23 21:33:43 +0000856 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel,
Peter Collingbournee02b74e2017-01-20 22:18:52 +0000857 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000858}
859
860/// This class defines the interface to the ThinLTO backend.
861class lto::ThinBackendProc {
862protected:
863 Config &Conf;
864 ModuleSummaryIndex &CombinedIndex;
Mehdi Amini767e1452016-09-06 03:23:45 +0000865 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000866
867public:
868 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +0000869 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries)
Mehdi Amini18b91112016-08-19 06:10:03 +0000870 : Conf(Conf), CombinedIndex(CombinedIndex),
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000871 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {}
872
873 virtual ~ThinBackendProc() {}
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000874 virtual Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000875 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000876 const FunctionImporter::ImportMapTy &ImportList,
877 const FunctionImporter::ExportSetTy &ExportList,
878 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000879 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000880 virtual Error wait() = 0;
881};
882
Benjamin Kramerffd37152016-11-19 20:44:26 +0000883namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000884class InProcessThinBackend : public ThinBackendProc {
885 ThreadPool BackendThreadPool;
Peter Collingbourne80186a52016-09-23 21:33:43 +0000886 AddStreamFn AddStream;
887 NativeObjectCache Cache;
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000888 TypeIdSummariesByGuidTy TypeIdSummariesByGuid;
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000889 std::set<GlobalValue::GUID> CfiFunctionDefs;
890 std::set<GlobalValue::GUID> CfiFunctionDecls;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000891
892 Optional<Error> Err;
893 std::mutex ErrMu;
894
895public:
Mehdi Amini767e1452016-09-06 03:23:45 +0000896 InProcessThinBackend(
897 Config &Conf, ModuleSummaryIndex &CombinedIndex,
898 unsigned ThinLTOParallelismLevel,
899 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000900 AddStreamFn AddStream, NativeObjectCache Cache)
Mehdi Amini18b91112016-08-19 06:10:03 +0000901 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
902 BackendThreadPool(ThinLTOParallelismLevel),
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000903 AddStream(std::move(AddStream)), Cache(std::move(Cache)) {
904 // Create a mapping from type identifier GUIDs to type identifier summaries.
905 // This allows backends to use the type identifier GUIDs stored in the
906 // function summaries to determine which type identifier summaries affect
907 // each function without needing to compute GUIDs in each backend.
908 for (auto &TId : CombinedIndex.typeIds())
909 TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId);
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000910 for (auto &Name : CombinedIndex.cfiFunctionDefs())
911 CfiFunctionDefs.insert(
912 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
913 for (auto &Name : CombinedIndex.cfiFunctionDecls())
914 CfiFunctionDecls.insert(
915 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000916 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000917
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000918 Error runThinLTOBackendThread(
Peter Collingbourne80186a52016-09-23 21:33:43 +0000919 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000920 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000921 const FunctionImporter::ImportMapTy &ImportList,
922 const FunctionImporter::ExportSetTy &ExportList,
923 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
924 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000925 MapVector<StringRef, BitcodeModule> &ModuleMap,
926 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Peter Collingbourne80186a52016-09-23 21:33:43 +0000927 auto RunThinBackend = [&](AddStreamFn AddStream) {
928 LTOLLVMContext BackendContext(Conf);
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000929 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
Peter Collingbourned9445c42016-11-13 07:00:17 +0000930 if (!MOrErr)
931 return MOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000932
Peter Collingbourne80186a52016-09-23 21:33:43 +0000933 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
934 ImportList, DefinedGlobals, ModuleMap);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000935 };
Peter Collingbourne80186a52016-09-23 21:33:43 +0000936
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000937 auto ModuleID = BM.getModuleIdentifier();
Mehdi Aminif82bda02016-10-08 04:44:23 +0000938
939 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) ||
940 all_of(CombinedIndex.getModuleHash(ModuleID),
941 [](uint32_t V) { return V == 0; }))
942 // Cache disabled or no entry for this module in the combined index or
943 // no module hash.
Peter Collingbourne80186a52016-09-23 21:33:43 +0000944 return RunThinBackend(AddStream);
945
946 SmallString<40> Key;
947 // The module may be cached, this helps handling it.
Peter Collingbournef4257522016-12-08 05:28:30 +0000948 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000949 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid,
950 CfiFunctionDefs, CfiFunctionDecls);
Peter Collingbourne80186a52016-09-23 21:33:43 +0000951 if (AddStreamFn CacheAddStream = Cache(Task, Key))
952 return RunThinBackend(CacheAddStream);
953
Mehdi Amini41af4302016-11-11 04:28:40 +0000954 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000955 }
956
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000957 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000958 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000959 const FunctionImporter::ImportMapTy &ImportList,
960 const FunctionImporter::ExportSetTy &ExportList,
961 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000962 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
963 StringRef ModulePath = BM.getModuleIdentifier();
Mehdi Amini767e1452016-09-06 03:23:45 +0000964 assert(ModuleToDefinedGVSummaries.count(ModulePath));
965 const GVSummaryMapTy &DefinedGlobals =
966 ModuleToDefinedGVSummaries.find(ModulePath)->second;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000967 BackendThreadPool.async(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000968 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000969 const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000970 const FunctionImporter::ExportSetTy &ExportList,
971 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
972 &ResolvedODR,
Mehdi Amini767e1452016-09-06 03:23:45 +0000973 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000974 MapVector<StringRef, BitcodeModule> &ModuleMap,
975 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000976 Error E = runThinLTOBackendThread(
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000977 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
978 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000979 if (E) {
980 std::unique_lock<std::mutex> L(ErrMu);
981 if (Err)
982 Err = joinErrors(std::move(*Err), std::move(E));
983 else
984 Err = std::move(E);
985 }
986 },
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000987 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
988 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap),
989 std::ref(TypeIdSummariesByGuid));
Mehdi Amini41af4302016-11-11 04:28:40 +0000990 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000991 }
992
993 Error wait() override {
994 BackendThreadPool.wait();
995 if (Err)
996 return std::move(*Err);
997 else
Mehdi Amini41af4302016-11-11 04:28:40 +0000998 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000999 }
1000};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001001} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001002
1003ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
1004 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001005 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001006 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001007 return llvm::make_unique<InProcessThinBackend>(
1008 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001009 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001010 };
1011}
1012
Teresa Johnson3f212b82016-09-21 19:12:05 +00001013// Given the original \p Path to an output file, replace any path
1014// prefix matching \p OldPrefix with \p NewPrefix. Also, create the
1015// resulting directory if it does not yet exist.
1016std::string lto::getThinLTOOutputFile(const std::string &Path,
1017 const std::string &OldPrefix,
1018 const std::string &NewPrefix) {
1019 if (OldPrefix.empty() && NewPrefix.empty())
1020 return Path;
1021 SmallString<128> NewPath(Path);
1022 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix);
1023 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str());
1024 if (!ParentPath.empty()) {
1025 // Make sure the new directory exists, creating it if necessary.
1026 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath))
1027 llvm::errs() << "warning: could not create directory '" << ParentPath
1028 << "': " << EC.message() << '\n';
1029 }
1030 return NewPath.str();
1031}
1032
Benjamin Kramerffd37152016-11-19 20:44:26 +00001033namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001034class WriteIndexesThinBackend : public ThinBackendProc {
1035 std::string OldPrefix, NewPrefix;
1036 bool ShouldEmitImportsFiles;
1037
1038 std::string LinkedObjectsFileName;
1039 std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile;
1040
Vitaly Buka59baf732018-01-30 21:19:26 +00001041 lto::IndexWriteCallback OnWrite;
1042
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001043public:
Mehdi Amini767e1452016-09-06 03:23:45 +00001044 WriteIndexesThinBackend(
1045 Config &Conf, ModuleSummaryIndex &CombinedIndex,
1046 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1047 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
Vitaly Buka59baf732018-01-30 21:19:26 +00001048 std::string LinkedObjectsFileName, lto::IndexWriteCallback OnWrite)
Mehdi Amini18b91112016-08-19 06:10:03 +00001049 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001050 OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1051 ShouldEmitImportsFiles(ShouldEmitImportsFiles),
Vitaly Buka59baf732018-01-30 21:19:26 +00001052 LinkedObjectsFileName(LinkedObjectsFileName), OnWrite(OnWrite) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001053
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001054 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001055 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001056 const FunctionImporter::ImportMapTy &ImportList,
1057 const FunctionImporter::ExportSetTy &ExportList,
1058 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001059 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1060 StringRef ModulePath = BM.getModuleIdentifier();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001061 std::string NewModulePath =
1062 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1063
1064 std::error_code EC;
1065 if (!LinkedObjectsFileName.empty()) {
1066 if (!LinkedObjectsFile) {
1067 LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>(
1068 LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None);
1069 if (EC)
1070 return errorCodeToError(EC);
1071 }
1072 *LinkedObjectsFile << NewModulePath << '\n';
1073 }
1074
1075 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1076 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001077 ImportList, ModuleToSummariesForIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001078
1079 raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC,
1080 sys::fs::OpenFlags::F_None);
1081 if (EC)
1082 return errorCodeToError(EC);
1083 WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex);
1084
Vitaly Buka59baf732018-01-30 21:19:26 +00001085 if (ShouldEmitImportsFiles) {
1086 EC = EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList);
1087 if (EC)
1088 return errorCodeToError(EC);
1089 }
1090
1091 if (OnWrite)
1092 OnWrite(ModulePath);
Mehdi Amini41af4302016-11-11 04:28:40 +00001093 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001094 }
1095
Mehdi Amini41af4302016-11-11 04:28:40 +00001096 Error wait() override { return Error::success(); }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001097};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001098} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001099
1100ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix,
1101 std::string NewPrefix,
1102 bool ShouldEmitImportsFiles,
Vitaly Buka59baf732018-01-30 21:19:26 +00001103 std::string LinkedObjectsFile,
1104 IndexWriteCallback OnWrite) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001105 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001106 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001107 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001108 return llvm::make_unique<WriteIndexesThinBackend>(
Mehdi Amini18b91112016-08-19 06:10:03 +00001109 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
Vitaly Buka59baf732018-01-30 21:19:26 +00001110 ShouldEmitImportsFiles, LinkedObjectsFile, OnWrite);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001111 };
1112}
1113
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001114Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001115 if (ThinLTO.ModuleMap.empty())
Mehdi Amini41af4302016-11-11 04:28:40 +00001116 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001117
1118 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
Mehdi Amini41af4302016-11-11 04:28:40 +00001119 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001120
1121 // Collect for each module the list of function it defines (GUID ->
1122 // Summary).
Dehao Chen5d96ee42017-07-10 20:12:54 +00001123 StringMap<GVSummaryMapTy>
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001124 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1125 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1126 ModuleToDefinedGVSummaries);
Teresa Johnson620c1402016-09-20 23:07:17 +00001127 // Create entries for any modules that didn't have any GV summaries
1128 // (either they didn't have any GVs to start with, or we suppressed
1129 // generation of the summaries because they e.g. had inline assembly
1130 // uses that couldn't be promoted/renamed on export). This is so
1131 // InProcessThinBackend::start can still launch a backend thread, which
1132 // is passed the map of summaries for the module, without any special
1133 // handling for this case.
1134 for (auto &Mod : ThinLTO.ModuleMap)
1135 if (!ModuleToDefinedGVSummaries.count(Mod.first))
1136 ModuleToDefinedGVSummaries.try_emplace(Mod.first);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001137
1138 StringMap<FunctionImporter::ImportMapTy> ImportLists(
1139 ThinLTO.ModuleMap.size());
1140 StringMap<FunctionImporter::ExportSetTy> ExportLists(
1141 ThinLTO.ModuleMap.size());
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001142 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001143
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001144 if (Conf.OptLevel > 0)
Teresa Johnson002af9b2016-10-31 22:12:21 +00001145 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +00001146 ImportLists, ExportLists);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001147
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001148 // Figure out which symbols need to be internalized. This also needs to happen
1149 // at -O0 because summary-based DCE is implemented using internalization, and
1150 // we must apply DCE consistently with the full LTO module in order to avoid
1151 // undefined references during the final link.
1152 std::set<GlobalValue::GUID> ExportedGUIDs;
1153 for (auto &Res : GlobalResolutions) {
George Rimard3283652018-01-25 17:23:27 +00001154 // If the symbol does not have external references or it is not prevailing,
1155 // then not need to mark it as exported from a ThinLTO partition.
1156 if (Res.second.Partition != GlobalResolution::External ||
George Rimareaf51722018-01-29 08:03:30 +00001157 !Res.second.isPrevailingIRSymbol())
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001158 continue;
1159 auto GUID = GlobalValue::getGUID(
1160 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
1161 // Mark exported unless index-based analysis determined it to be dead.
1162 if (ThinLTO.CombinedIndex.isGUIDLive(GUID))
1163 ExportedGUIDs.insert(GUID);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001164 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001165
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001166 // Any functions referenced by the jump table in the regular LTO object must
1167 // be exported.
1168 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs())
1169 ExportedGUIDs.insert(
1170 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def)));
1171
1172 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) {
1173 const auto &ExportList = ExportLists.find(ModuleIdentifier);
1174 return (ExportList != ExportLists.end() &&
1175 ExportList->second.count(GUID)) ||
1176 ExportedGUIDs.count(GUID);
1177 };
1178 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported);
1179
Peter Collingbournef87197a2017-05-25 23:40:11 +00001180 auto isPrevailing = [&](GlobalValue::GUID GUID,
1181 const GlobalValueSummary *S) {
1182 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath();
1183 };
1184 auto recordNewLinkage = [&](StringRef ModuleIdentifier,
1185 GlobalValue::GUID GUID,
1186 GlobalValue::LinkageTypes NewLinkage) {
1187 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage;
1188 };
1189 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing,
1190 recordNewLinkage);
1191
Peter Collingbourne80186a52016-09-23 21:33:43 +00001192 std::unique_ptr<ThinBackendProc> BackendProc =
1193 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1194 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001195
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001196 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined
1197 // module and parallel code generation partitions.
1198 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001199 for (auto &Mod : ThinLTO.ModuleMap) {
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001200 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001201 ExportLists[Mod.first],
1202 ResolvedODR[Mod.first], ThinLTO.ModuleMap))
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001203 return E;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001204 ++Task;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001205 }
1206
1207 return BackendProc->wait();
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001208}
Davide Italiano690ed9d2017-02-10 23:49:38 +00001209
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001210Expected<std::unique_ptr<ToolOutputFile>>
Davide Italiano690ed9d2017-02-10 23:49:38 +00001211lto::setupOptimizationRemarks(LLVMContext &Context,
1212 StringRef LTORemarksFilename,
1213 bool LTOPassRemarksWithHotness, int Count) {
1214 if (LTORemarksFilename.empty())
1215 return nullptr;
1216
1217 std::string Filename = LTORemarksFilename;
1218 if (Count != -1)
1219 Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1220
1221 std::error_code EC;
1222 auto DiagnosticFile =
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001223 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001224 if (EC)
1225 return errorCodeToError(EC);
1226 Context.setDiagnosticsOutputFile(
1227 llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
1228 if (LTOPassRemarksWithHotness)
Brian Gesiak44e5f6c2017-06-30 18:13:59 +00001229 Context.setDiagnosticsHotnessRequested(true);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001230 DiagnosticFile->keep();
1231 return std::move(DiagnosticFile);
1232}